Releasing 2.0.3

SVN:2.0.3[3275]

addons/userrights/userrightsmatrix.class.inc.php

@@ -1,26 +1,26 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * UserRightsMatrix (User management Module)
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -274,7 +274,7 @@ class UserRightsMatrix extends UserRightsAddOnAPI
 		return true;
 	}
 
-	public function GetSelectFilter($oUser, $sClass)
+	public function GetSelectFilter($oUser, $sClass, $aSettings = array())
 	{
 		$oNullFilter  = new DBObjectSearch($sClass);
 		return $oNullFilter;

addons/userrights/userrightsnull.class.inc.php

@@ -1,27 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * UserRightsNull
  * User management Module - say Yeah! to everything
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 class UserRightsNull extends UserRightsAddOnAPI
@@ -47,7 +47,7 @@ class UserRightsNull extends UserRightsAddOnAPI
 		return true;
 	}
 
-	public function GetSelectFilter($oUser, $sClass)
+	public function GetSelectFilter($oUser, $sClass, $aSettings = array())
 	{
 		$oNullFilter  = new DBObjectSearch($sClass);
 		return $oNullFilter;

addons/userrights/userrightsprojection.class.inc.php

@@ -1,27 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * UserRightsProjection
  * User management Module, basing the right on profiles and a matrix (similar to UserRightsProfile, but enhanced with dimensions and projection of classes and profile over the dimensions) 
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 define('ADMIN_PROFILE_ID', 1);
@@ -734,7 +734,7 @@ exit;
 		return true;
 	}
 
-	public function GetSelectFilter($oUser, $sClass)
+	public function GetSelectFilter($oUser, $sClass, $aSettings = array())
 	{
 		$aConditions = array();
 		foreach ($this->m_aDimensions as $iDimension => $oDimension)

application/ajaxwebpage.class.inc.php

@@ -1,41 +1,40 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * Simple web page with no includes, header or fancy formatting, useful to
  * generate HTML fragments when called by an AJAX method
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT."/application/webpage.class.inc.php");
  
-class ajax_page extends WebPage
+class ajax_page extends WebPage implements iTabbedPage
 {
     /**
      * Jquery style ready script
      * @var Hash     
      */	  
 	protected $m_sReadyScript;
-	protected $m_sCurrentTab;
-	protected $m_sCurrentTabContainer;
-	protected $m_aTabs;
+	protected $m_oTabs;
+	private $m_sMenu; // If set, then the menu will be updated
 	
     /**
      * constructor for the web page
@@ -47,52 +46,84 @@ class ajax_page extends WebPage
         $this->m_sReadyScript = "";
 		//$this->add_header("Content-type: text/html; charset=utf-8");
 		$this->add_header("Cache-control: no-cache");
-		$this->m_sCurrentTabContainer = '';
-        $this->m_sCurrentTab = '';
-		$this->m_aTabs = array();
+		$this->m_oTabs = new TabManager();
 		$this->sContentType = 'text/html';
 		$this->sContentDisposition = 'inline';
+		$this->m_sMenu = "";
     }	
 
 	public function AddTabContainer($sTabContainer, $sPrefix = '')
 	{
-		$this->m_aTabs[$sTabContainer] = array('content' =>'', 'prefix' => $sPrefix);
-		$this->add("\$Tabs:$sTabContainer\$");
+		$this->add($this->m_oTabs->AddTabContainer($sTabContainer, $sPrefix));
 	}
-	
+
 	public function AddToTab($sTabContainer, $sTabLabel, $sHtml)
 	{
-		if (!isset($this->m_aTabs[$sTabContainer]['content'][$sTabLabel]))
-		{
-			// Set the content of the tab
-			$this->m_aTabs[$sTabContainer]['content'][$sTabLabel] = $sHtml;
-		}
-		else
-		{
-			// Append to the content of the tab
-			$this->m_aTabs[$sTabContainer]['content'][$sTabLabel] .= $sHtml;
-		}
+		$this->add($this->m_oTabs->AddToTab($sTabContainer, $sTabLabel, $sHtml));
 	}
 
 	public function SetCurrentTabContainer($sTabContainer = '')
 	{
-		$sPreviousTabContainer = $this->m_sCurrentTabContainer;
-		$this->m_sCurrentTabContainer = $sTabContainer;
-		return $sPreviousTabContainer;
+		return $this->m_oTabs->SetCurrentTabContainer($sTabContainer);
 	}
 
 	public function SetCurrentTab($sTabLabel = '')
 	{
-		$sPreviousTab = $this->m_sCurrentTab;
-		$this->m_sCurrentTab = $sTabLabel;
-		return $sPreviousTab;
+		return $this->m_oTabs->SetCurrentTab($sTabLabel);
+	}
+	
+	/**
+	 * Add a tab which content will be loaded asynchronously via the supplied URL
+	 * 
+	 * Limitations:
+	 * Cross site scripting is not not allowed for security reasons. Use a normal tab with an IFRAME if you want to pull content from another server.
+	 * Static content cannot be added inside such tabs.
+	 * 
+	 * @param string $sTabLabel The (localised) label of the tab
+	 * @param string $sUrl The URL to load (on the same server)
+	 * @param boolean $bCache Whether or not to cache the content of the tab once it has been loaded. flase will cause the tab to be reloaded upon each activation.
+	 * @since 2.0.3
+	 */
+	public function AddAjaxTab($sTabLabel, $sUrl, $bCache = true)
+	{
+		$this->add($this->m_oTabs->AddAjaxTab($sTabLabel, $sUrl, $bCache));
 	}
 	
 	public function GetCurrentTab()
 	{
-		return $this->m_sCurrentTab;
+		return $this->m_oTabs->GetCurrentTab();
+	}
+
+	public function RemoveTab($sTabLabel, $sTabContainer = null)
+	{
+		$this->m_oTabs->RemoveTab($sTabLabel, $sTabContainer);
+	}
+
+	/**
+	 * Finds the tab whose title matches a given pattern
+	 * @return mixed The name of the tab as a string or false if not found
+	 */
+	public function FindTab($sPattern, $sTabContainer = null)
+	{
+		return $this->m_oTabs->FindTab($sPattern, $sTabContainer);
+	}
+
+	/**
+	 * Make the given tab the active one, as if it were clicked
+	 * DOES NOT WORK: apparently in the *old* version of jquery
+	 * that we are using this is not supported... TO DO upgrade
+	 * the whole jquery bundle...
+	 */
+	public function SelectTab($sTabContainer, $sTabLabel)
+	{
+		$this->add_ready_script($this->m_oTabs->SelectTab($sTabContainer, $sTabLabel));
 	}
 	
+	public function AddToMenu($sHtml)
+	{
+		$this->m_sMenu .= $sHtml;
+	}
+
     /**
      * Echoes the content of the whole page
      * @return void
@@ -111,72 +142,89 @@ class ajax_page extends WebPage
         {
             header($s_header);
         }
-		if (count($this->m_aTabs) > 0)
+		if ($this->m_oTabs->TabsContainerCount() > 0)
 		{
-					$this->add_ready_script(
+			$this->add_ready_script(
 <<<EOF
 			// The "tab widgets" to handle.
 			var tabs = $('div[id^=tabbedContent]');
-			    
-			// This selector will be reused when selecting actual tab widget A elements.
-			var tab_a_selector = 'ul.ui-tabs-nav a';
 			  
-			// Enable tabs on all tab widgets. The `event` property must be overridden so
-			// that the tabs aren't changed on click, and any custom event name can be
-			// specified. Note that if you define a callback for the 'select' event, it
-			// will be executed for the selected tab whenever the hash changes.
-			tabs.tabs({ event: 'change' });
-			  
-			// Define our own click handler for the tabs, overriding the default.
-			tabs.find( tab_a_selector ).click(function()
+			// Ugly patch for a change in the behavior of jQuery UI:
+			// Before jQuery UI 1.9, tabs were always considered as "local" (opposed to Ajax)
+			// when their href was beginning by #. Starting with 1.9, a <base> tag in the page
+			// is taken into account and causes "local" tabs to be considered as Ajax
+			// unless their URL is equal to the URL of the page...
+			if ($('base').length > 0)
 			{
-				var state = {};
-						  
-				// Get the id of this tab widget.
-				var id = $(this).closest( 'div[id^=tabbedContent]' ).attr( 'id' );
+				$('div[id^=tabbedContent] > ul > li > a').each(function() {
+					var sHash = location.hash;
+					var sCleanLocation = location.href.toString().replace(sHash, '').replace(/#$/, '');
+		    		$(this).attr("href", sCleanLocation+$(this).attr("href"));
+				});
+			}
+			if ($.bbq)
+			{
+				// This selector will be reused when selecting actual tab widget A elements.
+				var tab_a_selector = 'ul.ui-tabs-nav a';
 				  
-				// Get the index of this tab.
-				var idx = $(this).parent().prevAll().length;
-				
-				// Set the state!
-				state[ id ] = idx;
-				$.bbq.pushState( state );
-			});
+				// Enable tabs on all tab widgets. The `event` property must be overridden so
+				// that the tabs aren't changed on click, and any custom event name can be
+				// specified. Note that if you define a callback for the 'select' event, it
+				// will be executed for the selected tab whenever the hash changes.
+				tabs.tabs({ event: 'change' });
+				  
+				// Define our own click handler for the tabs, overriding the default.
+				tabs.find( tab_a_selector ).click(function()
+				{
+					var state = {};
+							  
+					// Get the id of this tab widget.
+					var id = $(this).closest( 'div[id^=tabbedContent]' ).attr( 'id' );
+					  
+					// Get the index of this tab.
+					var idx = $(this).parent().prevAll().length;
+					
+					// Set the state!
+					state[ id ] = idx;
+					$.bbq.pushState( state );
+				});
+			}
+			else
+			{
+				tabs.tabs();
+			}
 EOF
 );
 		}
 		// Render the tabs in the page (if any)
-		foreach($this->m_aTabs as $sTabContainerName => $aTabContainer)
+		$this->s_content = $this->m_oTabs->RenderIntoContent($this->s_content);
+		
+		// Additional UI widgets to be activated inside the ajax fragment ??
+    	if (($this->sContentType == 'text/html') && (preg_match('/class="date-pick"/', $this->s_content) || preg_match('/class="datetime-pick"/', $this->s_content)) )
 		{
-			$sTabs = '';
-			$m_aTabs = $aTabContainer['content'];
-			$sPrefix = $aTabContainer['prefix'];
-			$container_index = 0;
-			if (count($m_aTabs) > 0)
-			{
-			  $sTabs = "<!-- tabs -->\n<div id=\"tabbedContent_{$sPrefix}{$container_index}\" class=\"light\">\n";
-			  $sTabs .= "<ul>\n";
-			  // Display the unordered list that will be rendered as the tabs
-	          $i = 0;
-			  foreach($m_aTabs as $sTabName => $sTabContent)
-			  {
-			      $sTabs .= "<li><a href=\"#tab_{$sPrefix}$i\" class=\"tab\"><span>".htmlentities($sTabName, ENT_QUOTES, 'UTF-8')."</span></a></li>\n";
-			      $i++;
-	          }
-			  $sTabs .= "</ul>\n";
-			  // Now add the content of the tabs themselves
-			  $i = 0;
-			  foreach($m_aTabs as $sTabName => $sTabContent)
-			  {
-			      $sTabs .= "<div id=\"tab_{$sPrefix}$i\">".$sTabContent."</div>\n";
-			      $i++;
-	          }
-			  $sTabs .= "</div>\n<!-- end of tabs-->\n";
-	        }
-			$this->s_content = str_replace("\$Tabs:$sTabContainerName\$", $sTabs, $this->s_content);
-			$container_index++;
-		}
-	
+			$this->add_ready_script(
+<<<EOF
+	$(".date-pick").datepicker({
+			showOn: 'button',
+			buttonImage: '../images/calendar.png',
+			buttonImageOnly: true,
+			dateFormat: 'yy-mm-dd',
+			constrainInput: false,
+			changeMonth: true,
+			changeYear: true
+		});
+	$(".datetime-pick").datepicker({
+			showOn: 'button',
+			buttonImage: '../images/calendar.png',
+			buttonImageOnly: true,
+			dateFormat: 'yy-mm-dd 00:00:00',
+			constrainInput: false,
+			changeMonth: true,
+			changeYear: true
+		});
+EOF
+			);
+		}	
         $s_captured_output = ob_get_contents();
         ob_end_clean();
         if (($this->sContentType == 'text/html') &&  ($this->sContentDisposition == 'inline'))
@@ -188,6 +236,24 @@ EOF
         {
         	echo $this->s_content;
         }
+        if (!empty($this->m_sMenu))
+        {
+           $uid = time();
+           echo "<div id=\"accordion_temp_$uid\">\n";
+           echo "<div id=\"accordion\">\n";
+           echo "<!-- Beginning of the accordion menu -->\n";
+           echo self::FilterXSS($this->m_sMenu);
+           echo "<!-- End of the accordion menu-->\n";
+           echo "</div>\n";
+           echo "</div>\n";
+
+	        echo "<script type=\"text/javascript\">\n";
+	        echo "$('#inner_menu').html($('#accordion_temp_$uid').html());\n";
+	        echo "$('#accordion_temp_$uid').remove();\n";
+	        echo "$('#accordion').accordion({ header: 'h3', navigation: true, autoHeight: false, collapsible: false, icons: false });\n";
+	        echo "\n</script>\n";
+        }
+
         //echo $this->s_deferred_content;
         if (count($this->a_scripts) > 0)
         {
@@ -207,10 +273,16 @@ EOF
 	        echo $this->m_sReadyScript; // Ready Scripts are output as simple scripts
 	        echo "\n</script>\n";
         }
+        
 		if (trim($s_captured_output) != "")
         {
         	echo self::FilterXSS($s_captured_output);
         }
+
+        if (class_exists('MetaModel'))
+        {
+            MetaModel::RecordQueryTrace();
+        }
     }
 
     /**
@@ -225,9 +297,9 @@ EOF
 
     public function add($sHtml)
     {
-        if (!empty($this->m_sCurrentTabContainer) && !empty($this->m_sCurrentTab))
+        if (($this->m_oTabs->GetCurrentTabContainer() != '') && ($this->m_oTabs->GetCurrentTab() != ''))
         {
-            $this->AddToTab($this->m_sCurrentTabContainer, $this->m_sCurrentTab, $sHtml);
+            $this->m_oTabs->AddToTab($this->m_oTabs->GetCurrentTabContainer(), $this->m_oTabs->GetCurrentTab(), $sHtml);
         }
         else
         {
@@ -241,15 +313,18 @@ EOF
 	 */    
     public function start_capture()
     {
-        if (!empty($this->m_sCurrentTabContainer) && !empty($this->m_sCurrentTab))
-        {
-        	$iOffset = isset($this->m_aTabs[$this->m_sCurrentTabContainer]['content'][$this->m_sCurrentTab]) ? strlen($this->m_aTabs[$this->m_sCurrentTabContainer]['content'][$this->m_sCurrentTab]): 0;
-            return array('tc' => $this->m_sCurrentTabContainer, 'tab' => $this->m_sCurrentTab, 'offset' => $iOffset);
-        }
-        else
-        {
-            return parent::start_capture();
-        }
+    	$sCurrentTabContainer = $this->m_oTabs->GetCurrentTabContainer();
+		$sCurrentTab = $this->m_oTabs->GetCurrentTab();
+		
+		if (!empty($sCurrentTabContainer) && !empty($sCurrentTab))
+		{
+			$iOffset = $this->m_oTabs->GetCurrentTabLength();
+			return array('tc' => $sCurrentTabContainer, 'tab' => $sCurrentTab, 'offset' => $iOffset);
+		}
+		else
+		{
+			return parent::start_capture();
+		}
     }
 
     /**
@@ -260,23 +335,22 @@ EOF
      */    
     public function end_capture($offset)
     {
-    	if (is_array($offset))
-    	{
-    		if (isset($this->m_aTabs[$offset['tc']]['content'][$offset['tab']]))
-    		{
-		    	$sCaptured = substr($this->m_aTabs[$offset['tc']]['content'][$offset['tab']], $offset['offset']);
-		    	$this->m_aTabs[$offset['tc']]['content'][$offset['tab']] = substr($this->m_aTabs[$offset['tc']]['content'][$offset['tab']], 0, $offset['offset']);
-    		}
-    		else
-    		{
-    			$sCaptured = '';
-    		}
-    	}
-    	else
-    	{
-    		$sCaptured = parent::end_capture($offset);
-    	}
-    	return $sCaptured;
+		if (is_array($offset))
+		{
+			if ($this->m_oTabs->TabExists($offset['tc'], $offset['tab']))
+			{
+				$sCaptured = $this->m_oTabs->TruncateTab($offset['tc'], $offset['tab'], $offset['offset']);
+			}
+			else
+			{
+				$sCaptured = '';
+			}
+		}
+		else
+		{
+			$sCaptured = parent::end_capture($offset);
+		}
+		return $sCaptured;
     }
 
 	/**
@@ -300,7 +374,7 @@ EOF
 	 */	 	 	
 	public function add_ready_script($sScript)
 	{
-		$this->m_sReadyScript .= $sScript;
+		$this->m_sReadyScript .= $sScript."\n";
 	}
 	
 	/**

application/application.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Includes all the classes to have the application up and running
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/applicationcontext.class.inc.php');
@@ -29,6 +30,8 @@ require_once(APPROOT.'/application/displayblock.class.inc.php');
 require_once(APPROOT.'/application/sqlblock.class.inc.php');
 require_once(APPROOT.'/application/audit.category.class.inc.php');
 require_once(APPROOT.'/application/audit.rule.class.inc.php');
+require_once(APPROOT.'/application/query.class.inc.php');
+require_once(APPROOT.'/setup/moduleinstallation.class.inc.php');
 //require_once(APPROOT.'/application/menunode.class.inc.php');
 require_once(APPROOT.'/application/utils.inc.php');
 

application/applicationcontext.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Class ApplicationContext
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT."/application/utils.inc.php");
@@ -77,12 +78,16 @@ class ApplicationContext
 	protected $aValues;
 	protected static $aDefaultValues; // Cache shared among all instances
 	
-	public function __construct()
+	public function __construct($bReadContext = true)
 	{
 		$this->aNames = array(
 			'org_id', 'menu'
 		);
-		$this->ReadContext();
+		if ($bReadContext)
+		{
+			$this->ReadContext();			
+		}
+
 	}
 	
 	/**
@@ -94,7 +99,7 @@ class ApplicationContext
 		if (!isset(self::$aDefaultValues))
 		{
 			self::$aDefaultValues = array();
-			$aContext = utils::ReadParam('c', array());
+			$aContext = utils::ReadParam('c', array(), false, 'context_param');
 			foreach($this->aNames as $sName)
 			{
 				$sValue = isset($aContext[$sName]) ? $aContext[$sName] : '';
@@ -111,6 +116,7 @@ class ApplicationContext
 					if (MetaModel::IsValidClass('Organization'))
 					{
 						$oSearchFilter = new DBObjectSearch('Organization');
+						$oSearchFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', true);
 						$oSet = new CMDBObjectSet($oSearchFilter);
 						$iCount = $oSet->Count();
 						if ($iCount == 1)
@@ -216,17 +222,17 @@ class ApplicationContext
 			if (is_callable($aCallSpec))
 			{
 				$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter					
-			}
 
-			if (MetaModel::IsValidAttCode($sClass, $sAttCode))
-			{
-				$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
-				if ($oAttDef->IsWritable())
+				if (MetaModel::IsValidAttCode($sClass, $sAttCode))
 				{
-					$value = $this->GetCurrentValue($key, null);
-					if (!is_null($value))
+					$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+					if ($oAttDef->IsWritable())
 					{
-						$oObj->Set($sAttCode, $value);
+						$value = $this->GetCurrentValue($key, null);
+						if (!is_null($value))
+						{
+							$oObj->Set($sAttCode, $value);
+						}
 					}
 				}
 			}
@@ -299,5 +305,58 @@ class ApplicationContext
 			return '';
 		}	
 	}
+
+	protected static $m_aPluginProperties = null;
+
+	/**
+	 * Load plugin properties for the current session
+	 * @return void
+	 */
+	protected static function LoadPluginProperties()
+	{
+		if (isset($_SESSION['PluginProperties']))
+		{
+			self::$m_aPluginProperties = $_SESSION['PluginProperties'];
+		}
+		else
+		{
+			self::$m_aPluginProperties = array();
+		}
+	}
+
+	/**
+	 * Set plugin properties
+	 * @param sPluginClass string Class implementing any plugin interface
+	 * @param sProperty string Name of the property
+	 * @param value scalar Value (numeric or string)
+	 * @return void
+	 */
+	public static function SetPluginProperty($sPluginClass, $sProperty, $value)
+	{
+		if (is_null(self::$m_aPluginProperties)) self::LoadPluginProperties();
+
+		self::$m_aPluginProperties[$sPluginClass][$sProperty] = $value;
+		$_SESSION['PluginProperties'][$sPluginClass][$sProperty] = $value;
+	}
+
+	/**
+	 * Get plugin properties
+	 * @param sPluginClass string Class implementing any plugin interface
+	 * @return array of sProperty=>value pairs
+	 */
+	public static function GetPluginProperties($sPluginClass)
+	{
+		if (is_null(self::$m_aPluginProperties)) self::LoadPluginProperties();
+
+		if (array_key_exists($sPluginClass, self::$m_aPluginProperties))
+		{
+			return self::$m_aPluginProperties[$sPluginClass];
+		}
+		else
+		{
+			return array();
+		}
+	}
+
 }
 ?>

application/audit.category.class.inc.php

@@ -1,28 +1,29 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * This class manages the audit "categories". Each category defines a set of objects
  * to check and is linked to a set of rules that determine the valid or invalid objects
  * inside the set 
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/cmdbabstract.class.inc.php');
@@ -46,7 +47,7 @@ class AuditCategory extends cmdbAbstractObject
 		MetaModel::Init_AddAttribute(new AttributeString("name", array("description"=>"Short name for this category", "allowed_values"=>null, "sql"=>"name", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
 		MetaModel::Init_AddAttribute(new AttributeString("description", array("allowed_values"=>null, "sql"=>"description", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
 		MetaModel::Init_AddAttribute(new AttributeOQL("definition_set", array("allowed_values"=>null, "sql"=>"definition_set", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeLinkedSet("rules_list", array("linked_class"=>"AuditRule", "ext_key_to_me"=>"category_id", "allowed_values"=>null, "count_min"=>0, "count_max"=>0, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeLinkedSet("rules_list", array("linked_class"=>"AuditRule", "ext_key_to_me"=>"category_id", "allowed_values"=>null, "count_min"=>0, "count_max"=>0, "depends_on"=>array(), "edit_mode" => LINKSET_EDITMODE_INPLACE)));
 
 		// Display lists
 		MetaModel::Init_SetZListItems('details', array('name', 'description', 'definition_set', 'rules_list')); // Attributes to be displayed for the complete details

application/audit.rule.class.inc.php

@@ -1,18 +1,21 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * This class manages the audit "rule" linked to a given audit category.
@@ -20,10 +23,8 @@
  * or the "bad" ones. The core audit engines computes the complement to the definition
  * set when needed to obtain either the valid objects, or the ones with an error
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/audit.category.class.inc.php');

application/clipage.class.inc.php

@@ -1,32 +1,33 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * CLI page 
  * The page adds the content-type text/XML and the encoding into the headers
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT."/application/webpage.class.inc.php");
 
-class CLIPage
+class CLIPage implements Page
 {
     function __construct($s_title)
     {
@@ -34,6 +35,14 @@ class CLIPage
 
     public function output()
     {
+        if (class_exists('MetaModel'))
+        {
+            MetaModel::RecordQueryTrace();
+        }
+        if (class_exists('ExecutionKPI'))
+        {
+            ExecutionKPI::ReportStats();
+        }
     }
 
 	public function add($sText)

application/csvpage.class.inc.php

@@ -1,27 +1,28 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Simple web page with no includes or fancy formatting, useful to generateXML documents
  * The page adds the content-type text/XML and the encoding into the headers
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT."/application/webpage.class.inc.php");
@@ -31,8 +32,9 @@ class CSVPage extends WebPage
     function __construct($s_title)
     {
         parent::__construct($s_title);
-		$this->add_header("Content-type: text/html; charset=utf-8");
+		$this->add_header("Content-type: text/plain; charset=utf-8");
 		$this->add_header("Cache-control: no-cache");
+		//$this->add_header("Content-Transfer-Encoding: binary");
     }	
 
     public function output()
@@ -43,6 +45,16 @@ class CSVPage extends WebPage
             header($s_header);
         }
         echo trim($this->s_content);
+        echo "\n";
+
+        if (class_exists('MetaModel'))
+        {
+            MetaModel::RecordQueryTrace();
+        }
+        if (class_exists('ExecutionKPI'))
+        {
+            ExecutionKPI::ReportStats();
+        }
     }
 
 	public function small_p($sText)

application/dashboard.class.inc.php

@@ -0,0 +1,871 @@
+<?php
+// Copyright (C) 2010-2013 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+require_once(APPROOT.'application/dashboardlayout.class.inc.php');
+require_once(APPROOT.'application/dashlet.class.inc.php');
+require_once(APPROOT.'core/modelreflection.class.inc.php');
+
+/**
+ * A user editable dashboard page
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+abstract class Dashboard
+{
+	protected $sTitle;
+	protected $bAutoReload;
+	protected $iAutoReloadSec;
+	protected $sLayoutClass;
+	protected $aWidgetsData;
+	protected $oDOMNode;
+	protected $sId;
+	protected $aCells;
+	protected $oMetaModel;
+	
+	public function __construct($sId)
+	{
+		$this->sTitle = '';
+		$this->sLayoutClass = 'DashboardLayoutOneCol';
+		$this->bAutoReload = false;
+		$this->iAutoReloadSec = MetaModel::GetConfig()->GetStandardReloadInterval();
+		$this->aCells = array();
+		$this->oDOMNode = null;
+		$this->sId = $sId;
+	}
+
+	public function FromXml($sXml)
+	{
+		$this->aCells = array(); // reset the content of the dashboard
+		set_error_handler(array('Dashboard', 'ErrorHandler'));
+		$oDoc = new DOMDocument();
+		$oDoc->loadXML($sXml);
+		restore_error_handler();
+		$this->FromDOMDocument($oDoc);
+	}
+	
+	public function FromDOMDocument(DOMDocument $oDoc)
+	{
+		$this->oDOMNode = $oDoc->getElementsByTagName('dashboard')->item(0);
+		
+		if ($oLayoutNode = $this->oDOMNode->getElementsByTagName('layout')->item(0))
+		{
+			$this->sLayoutClass = $oLayoutNode->textContent;
+		}
+		else
+		{
+			$this->sLayoutClass = 'DashboardLayoutOneCol';
+		}
+		
+		if ($oTitleNode = $this->oDOMNode->getElementsByTagName('title')->item(0))
+		{
+			$this->sTitle = $oTitleNode->textContent;
+		}
+		else
+		{
+			$this->sTitle = '';
+		}
+		
+		$this->bAutoReload = false;
+		$this->iAutoReloadSec = MetaModel::GetConfig()->GetStandardReloadInterval();
+		if ($oAutoReloadNode = $this->oDOMNode->getElementsByTagName('auto_reload')->item(0))
+		{
+			if ($oAutoReloadEnabled = $oAutoReloadNode->getElementsByTagName('enabled')->item(0))
+			{
+				$this->bAutoReload = ($oAutoReloadEnabled->textContent == 'true');
+			}
+			if ($oAutoReloadInterval = $oAutoReloadNode->getElementsByTagName('interval')->item(0))
+			{
+				$this->iAutoReloadSec = max(5, (int)$oAutoReloadInterval->textContent);
+			}
+		}
+
+		if ($oCellsNode = $this->oDOMNode->getElementsByTagName('cells')->item(0))
+		{
+			$oCellsList = $oCellsNode->getElementsByTagName('cell');
+			$aCellOrder = array();
+			$iCellRank = 0;
+			foreach($oCellsList as $oCellNode)
+			{
+				$aDashletList = array();
+				$oCellRank =  $oCellNode->getElementsByTagName('rank')->item(0);
+				if ($oCellRank)
+				{
+					$iCellRank = (float)$oCellRank->textContent;
+				}
+				$oDashletsNode = $oCellNode->getElementsByTagName('dashlets')->item(0);
+				{
+					$oDashletList = $oDashletsNode->getElementsByTagName('dashlet');
+					$iRank = 0;
+					$aDashletOrder = array();
+					foreach($oDashletList as $oDomNode)
+					{
+						$sDashletClass = $oDomNode->getAttribute('xsi:type');
+						$oRank =  $oDomNode->getElementsByTagName('rank')->item(0);
+						if ($oRank)
+						{
+							$iRank = (float)$oRank->textContent;
+						}
+						$sId = $oDomNode->getAttribute('id');
+						$oNewDashlet = new $sDashletClass($this->oMetaModel, $sId);
+						$oNewDashlet->FromDOMNode($oDomNode);
+						$aDashletOrder[] = array('rank' => $iRank, 'dashlet' => $oNewDashlet);
+					}
+					usort($aDashletOrder, array(get_class($this), 'SortOnRank'));
+					$aDashletList = array();
+					foreach($aDashletOrder as $aItem)
+					{
+						$aDashletList[] = $aItem['dashlet'];
+					}
+					$aCellOrder[] = array('rank' => $iCellRank, 'dashlets' => $aDashletList);
+				}
+			}
+			usort($aCellOrder, array(get_class($this), 'SortOnRank'));
+			foreach($aCellOrder as $aItem)
+			{
+				$this->aCells[] = $aItem['dashlets'];
+			}
+		}
+		else
+		{
+			$this->aCells = array();
+		}
+	}
+
+	static function SortOnRank($aItem1, $aItem2)
+	{
+		return ($aItem1['rank'] > $aItem2['rank']) ? +1 : -1;
+	}
+	/**
+	 * Error handler to turn XML loading warnings into exceptions
+	 */
+	public static function ErrorHandler($errno, $errstr, $errfile, $errline)
+	{
+		if ($errno == E_WARNING && (substr_count($errstr,"DOMDocument::loadXML()")>0))
+		{
+			throw new DOMException($errstr);
+		}
+		else
+		{
+			return false;
+		}
+	}
+
+	public function ToXml()
+	{
+		$oDoc = new DOMDocument();
+		$oDoc->formatOutput = true; // indent (must be loaded with option LIBXML_NOBLANKS)
+		$oDoc->preserveWhiteSpace = true; // otherwise the formatOutput option would have no effect
+
+		$oMainNode = $oDoc->createElement('dashboard');
+		$oMainNode->setAttribute('xmlns:xsi', "http://www.w3.org/2001/XMLSchema-instance");
+		$oDoc->appendChild($oMainNode);
+		
+		$this->ToDOMNode($oMainNode);
+
+		$sXml = $oDoc->saveXML();
+		return $sXml;
+	}
+
+	public function ToDOMNode($oDefinition)
+	{
+		$oDoc = $oDefinition->ownerDocument;
+
+		$oNode = $oDoc->createElement('layout', $this->sLayoutClass);
+		$oDefinition->appendChild($oNode);
+
+		$oNode = $oDoc->createElement('title', $this->sTitle);
+		$oDefinition->appendChild($oNode);
+
+		$oAutoReloadNode = $oDoc->createElement('auto_reload');
+		$oDefinition->appendChild($oAutoReloadNode);
+		$oNode = $oDoc->createElement('enabled', $this->bAutoReload ? 'true' : 'false');
+		$oAutoReloadNode->appendChild($oNode);
+		$oNode = $oDoc->createElement('interval', $this->iAutoReloadSec);
+		$oAutoReloadNode->appendChild($oNode);
+
+		$oCellsNode = $oDoc->createElement('cells');
+		$oDefinition->appendChild($oCellsNode);
+		
+		$iCellRank = 0;
+		foreach ($this->aCells as $aCell)
+		{
+			$oCellNode = $oDoc->createElement('cell');
+			$oCellNode->setAttribute('id', $iCellRank);
+			$oCellsNode->appendChild($oCellNode);
+			$oCellRank = $oDoc->createElement('rank', $iCellRank);
+			$oCellNode->appendChild($oCellRank);
+			$iCellRank++;
+						
+			$iDashletRank = 0;
+			$oDashletsNode = $oDoc->createElement('dashlets');
+			$oCellNode->appendChild($oDashletsNode);
+			foreach ($aCell as $oDashlet)
+			{
+				$oNode = $oDoc->createElement('dashlet');
+				$oDashletsNode->appendChild($oNode);
+				$oNode->setAttribute('id', $oDashlet->GetID());
+				$oNode->setAttribute('xsi:type', get_class($oDashlet));
+				$oDashletRank = $oDoc->createElement('rank', $iDashletRank);
+				$oNode->appendChild($oDashletRank);
+				$iDashletRank++;
+				$oDashlet->ToDOMNode($oNode);
+			}
+		}
+	}
+
+
+	public function FromParams($aParams)
+	{
+		$this->sLayoutClass = $aParams['layout_class'];
+		$this->sTitle = $aParams['title'];
+		$this->bAutoReload = $aParams['auto_reload'] == 'true';
+		$this->iAutoReloadSec = max(5, (int) $aParams['auto_reload_sec']);
+		
+		foreach($aParams['cells'] as $aCell)
+		{
+			$aCellDashlets = array();
+			foreach($aCell as $aDashletParams)
+			{
+				$sDashletClass = $aDashletParams['dashlet_class'];
+				$sId = $aDashletParams['dashlet_id'];
+				$oNewDashlet = new $sDashletClass($this->oMetaModel, $sId);
+				
+				$oForm = $oNewDashlet->GetForm();
+				$oForm->SetParamsContainer($sId);
+				$oForm->SetPrefix('');
+				$aValues = $oForm->ReadParams();
+				$oNewDashlet->FromParams($aValues);
+				$aCellDashlets[] = $oNewDashlet;
+			}
+			$this->aCells[] = $aCellDashlets;
+		}
+		
+	}
+
+	public function Save()
+	{
+		
+	}
+	
+	public function GetLayout()
+	{
+		return $this->sLayoutClass;
+	}
+	
+	public function SetLayout($sLayoutClass)
+	{
+		$this->sLayoutClass = $sLayoutClass;
+	}
+	
+	public function GetTitle()
+	{
+		return $this->sTitle;
+	}
+
+	public function SetTitle($sTitle)
+	{
+		$this->sTitle = $sTitle;
+	}
+
+	public function GetAutoReload()
+	{
+		return $this->bAutoReload;
+	}
+
+	public function SetAutoReload($bAutoReload)
+	{
+		$this->bAutoReload = $bAutoReload;
+	}
+
+	public function GetAutoReloadInterval()
+	{
+		return $this->iAutoReloadSec;
+	}
+
+	public function SetAutoReloadInterval($iAutoReloadSec)
+	{
+		$this->iAutoReloadSec = max(5, (int)$iAutoReloadSec);
+	}
+
+	public function AddDashlet($oDashlet)
+	{
+		$sId = $this->GetNewDashletId();
+		$oDashlet->SetId($sId);
+		$this->aCells[] = array($oDashlet);
+	}
+	
+	public function Render($oPage, $bEditMode = false, $aExtraParams = array())
+	{
+		$oPage->add('<h1>'.Dict::S($this->sTitle).'</h1>');
+		$oLayout = new $this->sLayoutClass;
+		$oLayout->Render($oPage, $this->aCells, $bEditMode, $aExtraParams);
+		if (!$bEditMode)
+		{
+			$oPage->add_linked_script('../js/dashlet.js');
+			$oPage->add_linked_script('../js/dashboard.js');
+		}
+	}
+	
+	public function RenderProperties($oPage)
+	{
+		// menu to pick a layout and edit other properties of the dashboard
+		$oPage->add('<div class="ui-widget-content ui-corner-all"><div class="ui-widget-header ui-corner-all" style="text-align:center; padding: 2px;">'.Dict::S('UI:DashboardEdit:Properties').'</div>');
+		$sUrl = utils::GetAbsoluteUrlAppRoot();
+		
+		$oPage->add('<div style="text-align:center">'.Dict::S('UI:DashboardEdit:Layout').'</div>');
+		$oPage->add('<div id="select_layout" style="text-align:center">');
+		foreach( get_declared_classes() as $sLayoutClass)
+		{
+			if (is_subclass_of($sLayoutClass, 'DashboardLayout'))
+			{
+				$oReflection = new ReflectionClass($sLayoutClass);
+				if (!$oReflection->isAbstract())
+				{
+					$aCallSpec = array($sLayoutClass, 'GetInfo');
+					$aInfo = call_user_func($aCallSpec);
+					$sChecked = ($this->sLayoutClass == $sLayoutClass) ? 'checked' : '';
+					$oPage->add('<input type="radio" name="layout_class" '.$sChecked.' value="'.$sLayoutClass.'" id="layout_'.$sLayoutClass.'"><label for="layout_'.$sLayoutClass.'"><img src="'.$sUrl.$aInfo['icon'].'" /></label>'); // title="" on either the img or the label does nothing !
+				}
+			}
+		}
+		$oPage->add('</div>');
+		
+		$oForm = new DesignerForm();
+
+		$oField = new DesignerHiddenField('dashboard_id', '', $this->sId);
+		$oForm->AddField($oField);
+
+		$oField = new DesignerLongTextField('dashboard_title', Dict::S('UI:DashboardEdit:DashboardTitle'), $this->sTitle);
+		$oForm->AddField($oField);
+
+		$oField = new DesignerBooleanField('auto_reload', Dict::S('UI:DashboardEdit:AutoReload'), $this->bAutoReload);
+		$oForm->AddField($oField);
+
+		$oField = new DesignerTextField('auto_reload_sec', Dict::S('UI:DashboardEdit:AutoReloadSec'), $this->iAutoReloadSec);
+		$oField->SetValidationPattern('^$|^0*([5-9]|[1-9][0-9]+)$'); // Can be empty, or a number > 4
+		$oForm->AddField($oField);
+
+		$this->SetFormParams($oForm);
+		$oForm->RenderAsPropertySheet($oPage, false, '.itop-dashboard');	
+
+		$oPage->add('</div>');
+
+		$sRateTitle = addslashes(Dict::S('UI:DashboardEdit:AutoReloadSec+'));
+		$oPage->add_ready_script(
+<<<EOF
+	// Note: the title gets deleted by the validation mechanism
+	$("#attr_auto_reload_sec").tooltip({items: 'input', content: '$sRateTitle'});
+	$("#attr_auto_reload_sec").prop('disabled', !$('#attr_auto_reload').is(':checked'));
+	
+	$('#attr_auto_reload').change( function(ev) {
+		$("#attr_auto_reload_sec").prop('disabled', !$(this).is(':checked'));
+	} );
+
+	$('#select_layout').buttonset();
+	$('#select_dashlet').droppable({
+		accept: '.dashlet',
+		drop: function(event, ui) {
+			$( this ).find( ".placeholder" ).remove();
+			var oDashlet = ui.draggable.data('itopDashlet');
+			oDashlet._remove_dashlet();
+		},
+	});
+
+	$('#event_bus').bind('dashlet-selected', function(event, data){
+		var sDashletId = data.dashlet_id;
+		var sPropId = 'dashlet_properties_'+sDashletId;
+		$('.dashlet_properties').each(function() {
+			var sId = $(this).attr('id');
+			var bShow = (sId == sPropId);
+			if (bShow)
+			{
+				$(this).show();
+			}
+			else
+			{
+				$(this).hide();
+			}
+		});
+	});
+EOF
+		);
+	}
+	
+	public function RenderDashletsSelection($oPage)
+	{
+		// Toolbox/palette to drag and drop dashlets
+		$oPage->add('<div class="ui-widget-content ui-corner-all"><div class="ui-widget-header ui-corner-all" style="text-align:center; padding: 2px;">'.Dict::S('UI:DashboardEdit:Dashlets').'</div>');
+		$sUrl = utils::GetAbsoluteUrlAppRoot();
+
+		$oPage->add('<div id="select_dashlet" style="text-align:center">');
+		foreach( get_declared_classes() as $sDashletClass)
+		{
+			if (is_subclass_of($sDashletClass, 'Dashlet'))
+			{
+				$oReflection = new ReflectionClass($sDashletClass);
+				if (!$oReflection->isAbstract())
+				{
+					$aCallSpec = array($sDashletClass, 'IsVisible');
+					$bVisible = call_user_func($aCallSpec);
+					if ($bVisible)
+					{
+						$aCallSpec = array($sDashletClass, 'GetInfo');
+						$aInfo = call_user_func($aCallSpec);
+						$oPage->add('<span dashlet_class="'.$sDashletClass.'" class="dashlet_icon ui-widget-content ui-corner-all" id="dashlet_'.$sDashletClass.'" title="'.$aInfo['label'].'" style="width:34px; height:34px; display:inline-block; margin:2px;"><img src="'.$sUrl.$aInfo['icon'].'" /></span>');
+					}
+				}
+			}
+		}
+		$oPage->add('</div>');
+
+		$oPage->add('</div>');
+		$oPage->add_ready_script("$('.dashlet_icon').draggable({helper: 'clone', appendTo: 'body', zIndex: 10000, revert:'invalid'});");
+	}
+	
+	public function RenderDashletsProperties($oPage)
+	{
+		// Toolbox/palette to edit the properties of each dashlet
+		$oPage->add('<div class="ui-widget-content ui-corner-all"><div class="ui-widget-header ui-corner-all" style="text-align:center; padding: 2px;">'.Dict::S('UI:DashboardEdit:DashletProperties').'</div>');
+
+		$oPage->add('<div id="dashlet_properties" style="text-align:center">');
+		foreach($this->aCells as $aCell)
+		{
+			foreach($aCell as $oDashlet)
+			{
+				$sId = $oDashlet->GetID();
+				$sClass = get_class($oDashlet);
+				if ($oDashlet->IsVisible())
+				{
+					$oPage->add('<div class="dashlet_properties" id="dashlet_properties_'.$sId.'" style="display:none">');
+					$oForm = $oDashlet->GetForm();
+					$this->SetFormParams($oForm);
+					$oForm->RenderAsPropertySheet($oPage, false, '.itop-dashboard');		
+					$oPage->add('</div>');
+				}
+			}
+		}
+		$oPage->add('</div>');
+
+		$oPage->add('</div>');
+	}
+	
+	protected function GetNewDashletId()
+	{
+		$iNewId = 0;
+		foreach($this->aCells as $aDashlets)
+		{
+			foreach($aDashlets as $oDashlet)
+			{
+				$iNewId = max($iNewId, (int)$oDashlet->GetID());
+			}
+		}
+		return $iNewId + 1;
+	}
+	
+	abstract protected function SetFormParams($oForm);
+}
+
+class RuntimeDashboard extends Dashboard
+{
+	protected $bCustomized;
+
+	public function __construct($sId)
+	{
+		parent::__construct($sId);
+		$this->bCustomized = false;
+		$this->oMetaModel = new ModelReflectionRuntime();
+	}
+		
+	public function SetCustomFlag($bCustomized)
+	{
+		$this->bCustomized = $bCustomized;
+	}
+	
+	protected function SetFormParams($oForm)
+	{
+		$oForm->SetSubmitParams(utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php', array('operation' => 'update_dashlet_property'));		
+	}
+	
+	public function Save()
+	{
+		$sXml = $this->ToXml();
+		$oUDSearch = new DBObjectSearch('UserDashboard');
+		$oUDSearch->AddCondition('user_id', UserRights::GetUserId(), '=');
+		$oUDSearch->AddCondition('menu_code', $this->sId, '=');
+		$oUDSet = new DBObjectSet($oUDSearch);
+		if ($oUDSet->Count() > 0)
+		{
+			// Assuming there is at most one couple {user, menu}!
+			$oUserDashboard = $oUDSet->Fetch();
+			$oUserDashboard->Set('contents', $sXml);
+			
+			$oUserDashboard->DBUpdate();
+		}
+		else
+		{
+			// No such customized dasboard for the current user, let's create a new record
+			$oUserDashboard = new UserDashboard();
+			$oUserDashboard->Set('user_id', UserRights::GetUserId());
+			$oUserDashboard->Set('menu_code', $this->sId);
+			$oUserDashboard->Set('contents', $sXml);
+			
+			$oUserDashboard->DBInsert();
+		}		
+	}
+	
+	public function Revert()
+	{
+		$oUDSearch = new DBObjectSearch('UserDashboard');
+		$oUDSearch->AddCondition('user_id', UserRights::GetUserId(), '=');
+		$oUDSearch->AddCondition('menu_code', $this->sId, '=');
+		$oUDSet = new DBObjectSet($oUDSearch);
+		if ($oUDSet->Count() > 0)
+		{
+			// Assuming there is at most one couple {user, menu}!
+			$oUserDashboard = $oUDSet->Fetch();
+			$oUserDashboard->DBDelete();
+		}
+	}
+	
+	public function RenderEditionTools($oPage)
+	{
+		$sEditMenu = "<td><span id=\"DashboardMenu\"><ul><li><img src=\"../images/edit.png\"><ul>";
+	
+		$aActions = array();
+		$oEdit = new JSPopupMenuItem('UI:Dashboard:Edit', Dict::S('UI:Dashboard:Edit'), "return EditDashboard('{$this->sId}')");
+		$aActions[$oEdit->GetUID()] = $oEdit->GetMenuItem();
+
+		if ($this->bCustomized)
+		{
+			$oRevert = new JSPopupMenuItem('UI:Dashboard:RevertConfirm', Dict::S('UI:Dashboard:Revert'),
+											"if (confirm('".addslashes(Dict::S('UI:Dashboard:RevertConfirm'))."')) return RevertDashboard('{$this->sId}'); else return false");
+			$aActions[$oRevert->GetUID()] = $oRevert->GetMenuItem();
+		}
+		utils::GetPopupMenuItems($oPage, iPopupMenuExtension::MENU_DASHBOARD_ACTIONS, $this, $aActions);
+		$sEditMenu .= $oPage->RenderPopupMenuItems($aActions);
+				
+
+		$sEditMenu = addslashes($sEditMenu);
+		//$sEditBtn = addslashes('<div style="display: inline-block; height: 55px; width:200px;vertical-align:center;line-height:60px;text-align:left;"><button onclick="EditDashboard(\''.$this->sId.'\');">Edit This Page</button></div>');
+		$oPage->add_ready_script(
+<<<EOF
+	$('#logOffBtn').parent().before('$sEditMenu');
+	$('#DashboardMenu>ul').popupmenu();
+	
+EOF
+		);
+		$oPage->add_script(
+<<<EOF
+function EditDashboard(sId)
+{
+	$.post(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', {operation: 'dashboard_editor', id: sId},
+		function(data)
+		{
+			$('body').append(data);
+		}
+	);
+	return false;
+}
+function RevertDashboard(sId)
+{
+	$.post(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', {operation: 'revert_dashboard', dashboard_id: sId},
+		function(data)
+		{
+			$('body').append(data);
+		}
+	);
+	return false;
+}
+EOF
+		);
+	}
+
+	public function RenderProperties($oPage)
+	{
+		parent::RenderProperties($oPage);
+
+		$oPage->add_ready_script(
+<<<EOF
+	$('#select_layout input').click( function() {
+		var sLayoutClass = $(this).val();
+		$('.itop-dashboard').runtimedashboard('option', {layout_class: sLayoutClass});
+	} );
+	$('#row_attr_dashboard_title').property_field('option', {parent_selector: '.itop-dashboard', auto_apply: false, 'do_apply': function() {
+			var sTitle = $('#attr_dashboard_title').val();
+			$('.itop-dashboard').runtimedashboard('option', {title: sTitle});
+			return true;
+		}
+	});
+	$('#row_attr_auto_reload').property_field('option', {parent_selector: '.itop-dashboard', auto_apply: true, 'do_apply': function() {
+			var bAutoReload = $('#attr_auto_reload').is(':checked');
+			$('.itop-dashboard').runtimedashboard('option', {auto_reload: bAutoReload});
+			return true;
+		}
+	});
+	$('#row_attr_auto_reload_sec').property_field('option', {parent_selector: '.itop-dashboard', auto_apply: true, 'do_apply': function() {
+			var iAutoReloadSec = $('#attr_auto_reload_sec').val();
+			$('.itop-dashboard').runtimedashboard('option', {auto_reload_sec: iAutoReloadSec});
+			return true;
+		}
+	});
+EOF
+		);
+	}
+
+
+	public function RenderEditor($oPage)
+	{
+		$oPage->add('<div id="dashboard_editor">');
+		$oPage->add('<div class="ui-layout-center">');
+		$this->Render($oPage, true);
+		$oPage->add('</div>');
+		$oPage->add('<div class="ui-layout-east">');
+		$this->RenderProperties($oPage);
+		$this->RenderDashletsSelection($oPage);
+		$this->RenderDashletsProperties($oPage);
+		$oPage->add('</div>');
+		$oPage->add('<div id="event_bus"/>'); // For exchanging messages between the panes, same as in the designer
+		$oPage->add('</div>');
+		
+		$sDialogTitle = Dict::S('UI:DashboardEdit:Title');
+		$sOkButtonLabel = Dict::S('UI:Button:Save');
+		$sCancelButtonLabel = Dict::S('UI:Button:Cancel');
+		
+		$sId = addslashes($this->sId);
+		$sLayoutClass = addslashes($this->sLayoutClass);
+		$sAutoReload = $this->bAutoReload ? 'true' : 'false';
+		$sAutoReloadSec = (string) $this->iAutoReloadSec;
+		$sTitle = addslashes($this->sTitle);
+		$sUrl = utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php';
+
+		$sExitConfirmationMessage = addslashes(Dict::S('UI:NavigateAwayConfirmationMessage'));
+		$sCancelConfirmationMessage = addslashes(Dict::S('UI:CancelConfirmationMessage'));
+		$sAutoApplyConfirmationMessage = addslashes(Dict::S('UI:AutoApplyConfirmationMessage'));
+		
+		$oPage->add_ready_script(
+<<<EOF
+window.bLeavingOnUserAction = false;
+
+$('#dashboard_editor').dialog({
+	height: $('body').height() - 50,
+	width: $('body').width() - 50,
+	modal: true,
+	title: '$sDialogTitle',
+	buttons: [
+	{ text: "$sOkButtonLabel", click: function() {
+		var oDashboard = $('.itop-dashboard').data('itopRuntimedashboard');
+		if (oDashboard.is_dirty())
+		{
+			if (!confirm('$sAutoApplyConfirmationMessage'))
+			{
+				return;
+			}
+			else
+			{
+				oDashboard.apply_changes();
+			}
+		}
+		window.bLeavingOnUserAction = true;
+		oDashboard.save();
+	} },
+	{ text: "$sCancelButtonLabel", click: function() {
+		var oDashboard = $('.itop-dashboard').data('itopRuntimedashboard');
+		if (oDashboard.is_modified())
+		{
+			if (!confirm('$sCancelConfirmationMessage'))
+			{
+				return;
+			}
+		}
+		window.bLeavingOnUserAction = true;
+		$(this).dialog( "close" );
+		$(this).remove();
+	} },
+	],
+	close: function() { $(this).remove(); }
+});
+
+$('#dashboard_editor .ui-layout-center').runtimedashboard({
+	dashboard_id: '$sId', layout_class: '$sLayoutClass', title: '$sTitle',
+	auto_reload: $sAutoReload, auto_reload_sec: $sAutoReloadSec,
+	submit_to: '$sUrl', submit_parameters: {operation: 'save_dashboard'},
+	render_to: '$sUrl', render_parameters: {operation: 'render_dashboard'},
+	new_dashlet_parameters: {operation: 'new_dashlet'}
+});
+
+dashboard_prop_size = GetUserPreference('dashboard_prop_size', 350);
+$('#dashboard_editor').layout({
+	east: {
+		minSize: 200,
+		size: dashboard_prop_size,
+		togglerLength_open: 0,
+		togglerLength_closed: 0, 
+		onresize_end: function(name, elt, state, options, layout)
+		{
+			if (state.isSliding == false)
+			{
+				SetUserPreference('dashboard_prop_size', state.size, true);
+			}
+		},
+	}
+});
+
+window.onbeforeunload = function() {
+	if (!window.bLeavingOnUserAction)
+	{
+		var oDashboard = $('.itop-dashboard').data('itopRuntimedashboard');
+		if (oDashboard)
+		{
+			if (oDashboard.is_dirty())
+			{
+				return '$sExitConfirmationMessage';
+			}	
+			if (oDashboard.is_modified())
+			{
+				return '$sExitConfirmationMessage';
+			}
+		}	
+	}
+	// return nothing ! safer for IE
+};
+EOF
+		);
+		$oPage->add_ready_script("");
+	}
+	
+	public static function GetDashletCreationForm($sOQL = null)
+	{
+		$oForm = new DesignerForm();
+	
+		// Get the list of all 'dashboard' menus in which we can insert a dashlet
+		$aAllMenus = ApplicationMenu::ReflectionMenuNodes();
+		$aAllowedDashboards = array();
+		foreach($aAllMenus as $idx => $aMenu)
+		{
+			$oMenu = $aMenu['node'];
+			$sParentId = $aMenu['parent'];
+			if ($oMenu instanceof DashboardMenuNode)
+			{
+				$sMenuLabel = $oMenu->GetTitle();
+				$sParentLabel = Dict::S('Menu:'.$sParentId);
+				if ($sParentLabel != $sMenuLabel)
+				{
+					$aAllowedDashboards[$oMenu->GetMenuId()] = $sParentLabel.' - '.$sMenuLabel;
+				}
+				else
+				{
+					$aAllowedDashboards[$oMenu->GetMenuId()] = $sMenuLabel;
+				}
+			}
+		}
+		asort($aAllowedDashboards);
+		
+		$aKeys = array_keys($aAllowedDashboards); // Select the first one by default
+		$sDefaultDashboard = $aKeys[0];
+		$oField = new DesignerComboField('menu_id', Dict::S('UI:DashletCreation:Dashboard'), $sDefaultDashboard);
+		$oField->SetAllowedValues($aAllowedDashboards);
+		$oField->SetMandatory(true);
+		$oForm->AddField($oField);
+				
+		// Get the list of possible dashlets that support a creation from
+		// an OQL
+		$aDashlets = array();
+		foreach(get_declared_classes() as $sDashletClass)
+		{
+			if (is_subclass_of($sDashletClass, 'Dashlet'))
+			{
+				$oReflection = new ReflectionClass($sDashletClass);
+				if (!$oReflection->isAbstract())
+				{
+					$aCallSpec = array($sDashletClass, 'CanCreateFromOQL');
+					$bShorcutMode = call_user_func($aCallSpec);
+					if ($bShorcutMode)
+					{
+						$aCallSpec = array($sDashletClass, 'GetInfo');
+						$aInfo = call_user_func($aCallSpec);
+						$aDashlets[$sDashletClass] = array('label' => $aInfo['label'], 'class' => $sDashletClass, 'icon' => $aInfo['icon']);
+					}
+				}
+			}
+		}
+		
+		$oSelectorField = new DesignerFormSelectorField('dashlet_class', Dict::S('UI:DashletCreation:DashletType'), '');
+		$oForm->AddField($oSelectorField);
+		foreach($aDashlets as $sDashletClass => $aDashletInfo)
+		{
+			$oSubForm = new DesignerForm();
+			$oMetaModel = new ModelReflectionRuntime();
+			$oDashlet = new $sDashletClass($oMetaModel, 0);
+			$oDashlet->GetPropertiesFieldsFromOQL($oSubForm, $sOQL);
+			
+			$oSelectorField->AddSubForm($oSubForm, $aDashletInfo['label'], $aDashletInfo['class']);
+		}
+		$oField = new DesignerBooleanField('open_editor', Dict::S('UI:DashletCreation:EditNow'), true);
+		$oForm->AddField($oField);
+		
+		return $oForm;
+	}
+	
+	public static function GetDashletCreationDlgFromOQL($oPage, $sOQL)
+	{
+		$oPage->add('<div id="dashlet_creation_dlg">');
+
+		$oForm = self::GetDashletCreationForm($sOQL);
+
+		$oForm->Render($oPage);
+		$oPage->add('</div>');
+		
+		$sDialogTitle = Dict::S('UI:DashletCreation:Title');
+		$sOkButtonLabel = Dict::S('UI:Button:Ok');
+		$sCancelButtonLabel = Dict::S('UI:Button:Cancel');
+		
+		$oPage->add_ready_script(
+<<<EOF
+$('#dashlet_creation_dlg').dialog({
+	width: 400,
+	modal: true,
+	title: '$sDialogTitle',
+	buttons: [
+	{ text: "$sOkButtonLabel", click: function() {
+		var oForm = $(this).find('form');
+		var sFormId = oForm.attr('id');
+		var oParams = null;
+		var aErrors = ValidateForm(sFormId, false);
+		if (aErrors.length == 0)
+		{
+			oParams = ReadFormParams(sFormId);
+		}
+		oParams.operation = 'add_dashlet';
+		var me = $(this);
+		$.post(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', oParams, function(data) {
+			me.dialog( "close" );
+			me.remove();
+			$('body').append(data);
+		});
+	} },
+	{ text: "$sCancelButtonLabel", click: function() {
+		$(this).dialog( "close" ); $(this).remove();
+	} },
+	],
+	close: function() { $(this).remove(); }
+});
+EOF
+		);
+	}
+}

application/dashboardlayout.class.inc.php

@@ -0,0 +1,212 @@
+<?php
+// Copyright (C) 2010-2012 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+/**
+ * Dashboard presentation
+ * 
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */ 
+
+
+abstract class DashboardLayout
+{
+	public function __construct()
+	{
+		
+	}
+	
+	abstract public function Render($oPage, $aDashlets, $bEditMode = false);
+	
+	static public function GetInfo()
+	{
+		return array(
+			'label' => '',
+			'icon' => '',
+			'description' => '',
+		);
+	}
+}
+
+abstract class DashboardLayoutMultiCol extends DashboardLayout
+{
+	protected $iNbCols;
+	
+	public function __construct()
+	{
+		$this->iNbCols = 1;
+	}
+	
+	protected function TrimCell($aDashlets)
+	{
+		$aKeys = array_reverse(array_keys($aDashlets));
+		$idx = 0;
+		$bNoVisibleFound = true;
+		while($idx < count($aKeys) && $bNoVisibleFound)
+		{
+			$oDashlet = $aDashlets[$aKeys[$idx]];
+			if ($oDashlet->IsVisible())
+			{
+				$bNoVisibleFound = false;
+			}
+			else
+			{
+				unset($aDashlets[$aKeys[$idx]]);
+			}
+			$idx++;
+		}
+		return $aDashlets;
+	}
+	
+	protected function TrimCellsArray($aCells)
+	{
+		foreach($aCells as $key => $aDashlets)
+		{
+			$aCells[$key] = $this->TrimCell($aDashlets);
+		}
+		$aKeys = array_reverse(array_keys($aCells));
+		$idx = 0;
+		$bNoVisibleFound = true;
+		while($idx < count($aKeys) && $bNoVisibleFound)
+		{
+			$aDashlets = $aCells[$aKeys[$idx]];
+			if (count($aDashlets) > 0)
+			{
+				$bNoVisibleFound = false;
+			}
+			else
+			{
+				unset($aCells[$aKeys[$idx]]);
+			}
+			$idx++;
+		}
+		return $aCells;		
+		
+	}
+	
+	public function Render($oPage, $aCells, $bEditMode = false, $aExtraParams = array())
+	{
+		// Trim the list of cells to remove the invisible/empty ones at the end of the array
+		$aCells = $this->TrimCellsArray($aCells);
+		
+		$oPage->add('<table style="width:100%"><tbody>');
+		$iCellIdx = 0;
+		$fColSize = 100 / $this->iNbCols;
+		$sStyle = $bEditMode ? 'border: 1px #ccc dashed; width:'.$fColSize.'%;' : 'width: '.$fColSize.'%;';
+		$sClass = $bEditMode ? 'layout_cell edit_mode' : 'dashboard';
+		$iNbRows = ceil(count($aCells) / $this->iNbCols);
+		for($iRows = 0; $iRows < $iNbRows; $iRows++)
+		{
+			$oPage->add('<tr>');
+			for($iCols = 0; $iCols < $this->iNbCols; $iCols++)
+			{
+				$sCellClass = ($iRows == $iNbRows-1) ? $sClass.' layout_last_used_rank' : $sClass;
+				$oPage->add("<td style=\"$sStyle\" class=\"$sCellClass\" data-dashboard-cell-index=\"$iCellIdx\">");
+				if (array_key_exists($iCellIdx, $aCells))
+				{
+					$aDashlets = $aCells[$iCellIdx];
+					if (count($aDashlets) > 0)
+					{
+						foreach($aDashlets as $oDashlet)
+						{
+							if ($oDashlet->IsVisible())
+							{
+								$oDashlet->DoRender($oPage, $bEditMode, true /* bEnclosingDiv */, $aExtraParams);
+							}
+						}
+					}
+					else
+					{
+						$oPage->add('&nbsp;');
+					}
+				}
+				else
+				{
+					$oPage->add('&nbsp;');
+				}
+				$oPage->add('</td>');
+				$iCellIdx++;
+			}
+			$oPage->add('</tr>');
+		}
+		if ($bEditMode) // Add one row for extensibility
+		{
+			$sStyle = 'style="border: 1px #ccc dashed; width:'.$fColSize.'%;" class="layout_cell edit_mode layout_extension" data-dashboard-cell-index="'.$iCellIdx.'"';
+			$oPage->add('<tr>');
+			for($iCols = 0; $iCols < $this->iNbCols; $iCols++)
+			{
+				$oPage->add("<td $sStyle>");
+				$oPage->add('&nbsp;');
+				$oPage->add('</td>');
+			}
+			$oPage->add('</tr>');
+		}
+		$oPage->add('</tbody></table>');
+	}
+}
+
+class DashboardLayoutOneCol extends DashboardLayoutMultiCol
+{
+	public function __construct()
+	{
+		parent::__construct();
+		$this->iNbCols = 1;
+	}
+	static public function GetInfo()
+	{
+		return array(
+			'label' => 'One Column',
+			'icon' => 'images/layout_1col.png',
+			'description' => '',
+		);
+	}
+}
+
+class DashboardLayoutTwoCols extends DashboardLayoutMultiCol
+{
+	public function __construct()
+	{
+		parent::__construct();
+		$this->iNbCols = 2;
+	}
+	static public function GetInfo()
+	{
+		return array(
+			'label' => 'Two Columns',
+			'icon' =>  'images/layout_2col.png',
+			'description' => '',
+		);
+	}
+}
+
+class DashboardLayoutThreeCols extends DashboardLayoutMultiCol
+{
+	public function __construct()
+	{
+		parent::__construct();
+		$this->iNbCols = 3;
+	}
+	static public function GetInfo()
+	{
+		return array(
+			'label' => 'Two Columns',
+			'icon' =>  'images/layout_3col.png',
+			'description' => '',
+		);
+	}
+}

application/datatable.class.inc.php

@@ -0,0 +1,907 @@
+<?php
+// Copyright (C) 2010-2013 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+/**
+ * Data Table to display a set of objects in a tabular manner in HTML
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+class DataTable
+{
+	protected $iListId;		// Unique ID inside the web page
+	protected $sTableId;	// identifier for saving the settings (combined with the class aliases)
+	protected $oSet;		// The set of objects to display
+	protected $aClassAliases;	// The aliases (alias => class) inside the set
+	protected $iNbObjects;		// Total number of objects inthe set
+	protected $bUseCustomSettings;	// Whether or not the current display uses custom settings
+	protected $oDefaultSettings;	// the default settings for displaying such a list
+		
+	/**
+	 * @param $iListId mixed Unique ID for this div/table in the page
+	 * @param $oSet DBObjectSet The set of data to display
+	 * @param $aClassAliases Hash The list of classes/aliases to be displayed in this set $sAlias => $sClassName
+	 * @param $sTableId mixed A string (or null) identifying this table in order to persist its settings
+	 */
+	public function __construct($iListId, $oSet, $aClassAliases, $sTableId = null)
+	{
+		$this->iListId = utils::GetSafeId($iListId); // Make a "safe" ID for jQuery
+		$this->oSet = $oSet;
+		$this->aClassAliases = $aClassAliases;
+		$this->sTableId = $sTableId;
+		$this->iNbObjects = $oSet->Count();
+		$this->bUseCustomSettings = false;
+		$this->oDefaultSettings = null;
+	}
+	
+	public function Display(WebPage $oPage, DataTableSettings $oSettings, $bActionsMenu, $sSelectMode, $bViewLink, $aExtraParams)
+	{
+		$this->oDefaultSettings = $oSettings;
+
+		// Identified tables can have their own specific settings
+		$oCustomSettings = DataTableSettings::GetTableSettings($this->aClassAliases, $this->sTableId);
+		
+		if ($oCustomSettings != null)
+		{
+			// Custom settings overload the default ones
+			$this->bUseCustomSettings = true;
+			if ($this->oDefaultSettings->iDefaultPageSize == 0)
+			{
+				$oCustomSettings->iDefaultPageSize = 0;
+			}
+		}
+		else
+		{
+			$oCustomSettings = $oSettings;
+		}
+
+		if ($oCustomSettings->iDefaultPageSize > 0)
+		{
+			$this->oSet->SetLimit($oCustomSettings->iDefaultPageSize);
+		}
+		$this->oSet->SetOrderBy($oCustomSettings->GetSortOrder());
+
+		// Load only the requested columns
+		$aColumnsToLoad = array();
+		foreach($oCustomSettings->aColumns as $sAlias => $aColumnsInfo)
+		{
+			foreach($aColumnsInfo as $sAttCode => $aData)
+			{
+				if ($sAttCode != '_key_')
+				{
+					if ($aData['checked'])
+					{
+						$aColumnsToLoad[$sAlias][] = $sAttCode;
+					}
+					else
+					{
+						// See if this column is a must to load			
+						$sClass = $this->aClassAliases[$sAlias];
+						$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+						if ($oAttDef->alwaysLoadInTables())
+						{
+							$aColumnsToLoad[$sAlias][] = $sAttCode;
+						}
+					}
+				}
+			}
+		}
+		$this->oSet->OptimizeColumnLoad($aColumnsToLoad);
+
+
+		$bToolkitMenu = true;
+		if (isset($aExtraParams['toolkit_menu']))
+		{
+			$bToolkitMenu = (bool) $aExtraParams['toolkit_menu'];
+		}
+		if (UserRights::IsPortalUser())
+		{
+			// Portal users have a limited access to data, for now they can only see what's configured for them
+			$bToolkitMenu = false;
+		}
+		
+		return $this->GetAsHTML($oPage, $oCustomSettings->iDefaultPageSize, $oCustomSettings->iDefaultPageSize, 0, $oCustomSettings->aColumns, $bActionsMenu, $bToolkitMenu, $sSelectMode, $bViewLink, $aExtraParams);
+	}
+	
+	public function GetAsHTML(WebPage $oPage, $iPageSize, $iDefaultPageSize, $iPageIndex, $aColumns, $bActionsMenu, $bToolkitMenu, $sSelectMode, $bViewLink, $aExtraParams)
+	{
+		$sObjectsCount = $this->GetObjectCount($oPage, $sSelectMode);
+		$sPager = $this->GetPager($oPage, $iPageSize, $iDefaultPageSize, $iPageIndex);
+		$sActionsMenu = '';
+		$sToolkitMenu = '';
+		if ($bActionsMenu)
+		{
+			$sActionsMenu = $this->GetActionsMenu($oPage, $aExtraParams);
+		}
+		if ($bToolkitMenu)
+		{
+			$sToolkitMenu = $this->GetToolkitMenu($oPage, $aExtraParams);
+		}
+		$sDataTable = $this->GetHTMLTable($oPage, $aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams);
+		$sConfigDlg = $this->GetTableConfigDlg($oPage, $aColumns, $bViewLink, $iDefaultPageSize);
+		
+		$sHtml = "<table id=\"datatable_{$this->iListId}\" class=\"datatable\">";
+		$sHtml .= "<tr><td>";
+		$sHtml .= "<table style=\"width:100%;\">";
+		$sHtml .= "<tr><td class=\"pagination_container\">$sObjectsCount</td><td class=\"menucontainer\">$sToolkitMenu $sActionsMenu</td></tr>";
+		$sHtml .= "<tr>$sPager</tr>";
+		$sHtml .= "</table>";
+		$sHtml .= "</td></tr>";
+		$sHtml .= "<tr><td class=\"datacontents\">$sDataTable</td></tr>";
+		$sHtml .= "</table>\n";
+		$oPage->add_at_the_end($sConfigDlg);
+		
+		$aOptions = array(
+			'sPersistentId' => '',
+			'sFilter' => $this->oSet->GetFilter()->serialize(),
+			'oColumns' => $aColumns,
+			'sSelectMode' => $sSelectMode,
+			'sViewLink' => ($bViewLink ? 'true' : 'false'),
+			'iNbObjects' => $this->iNbObjects,
+			'iDefaultPageSize' => $iDefaultPageSize,
+			'iPageSize' =>  $iPageSize,
+			'iPageIndex' =>  $iPageIndex,
+			'oClassAliases' => $this->aClassAliases,
+			'sTableId' => $this->sTableId,
+			'oExtraParams' => $aExtraParams,
+			'sRenderUrl' => utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php',
+			'oRenderParameters' => array('str' => ''), // Forces JSON to encode this as a object...
+			'oDefaultSettings' => array('str' => ''), // Forces JSON to encode this as a object...
+			'oLabels' => array('moveup' => Dict::S('UI:Button:MoveUp'), 'movedown' => Dict::S('UI:Button:MoveDown')),
+		);
+		if($this->oDefaultSettings != null)
+		{
+			$aOptions['oDefaultSettings'] = $this->GetAsHash($this->oDefaultSettings);
+		}
+		$sJSOptions = json_encode($aOptions);
+		$oPage->add_ready_script("$('#datatable_{$this->iListId}').datatable($sJSOptions);");
+		return $sHtml;
+	}
+	
+	/**
+	 * When refreshing the body of a paginated table, get the rows of the table (inside the TBODY)
+	 * return string The HTML rows to insert inside the <tbody> node
+	 */
+	public function GetAsHTMLTableRows(WebPage $oPage, $iPageSize, $aColumns, $sSelectMode, $bViewLink, $aExtraParams)
+	{
+		$aAttribs = $this->GetHTMLTableConfig($aColumns, $sSelectMode, $bViewLink);
+		$aValues = $this->GetHTMLTableValues($aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams);
+		
+		$sHtml = '';
+		foreach($aValues as $aRow)
+		{
+			$sHtml .= $oPage->GetTableRow($aRow, $aAttribs);
+		}
+		return $sHtml;
+	}
+	
+	protected function GetObjectCount(WebPage $oPage, $sSelectMode)
+	{
+		if (($sSelectMode == 'single') || ($sSelectMode == 'multiple'))
+		{
+			$sHtml = '<div class="pagination_objcount">'.Dict::Format('UI:Pagination:HeaderSelection', '<span id="total">'.$this->iNbObjects.'</span>', '<span class="selectedCount">0</span>').'</div>';
+		}
+		else
+		{
+			$sHtml = '<div class="pagination_objcount">'.Dict::Format('UI:Pagination:HeaderNoSelection', '<span id="total">'.$this->iNbObjects.'</span>').'</div>';
+		}
+		return $sHtml;		
+	}
+	protected function GetPager(WebPage $oPage, $iPageSize, $iDefaultPageSize, $iPageIndex)
+	{
+		$sHtml = '';
+		if ($iPageSize < 1) // Display all
+		{
+			$sPagerStyle = 'style="display:none"'; // no limit: display the full table, so hide the "pager" UI
+												   // WARNING: mPDF does not take the "display" style into account
+												   // when applied to a <td> or a <table> tag, so make sure you apply this to a div
+		}
+		else
+		{
+			$sPagerStyle = '';
+		}
+		
+		$sCombo = '<select class="pagesize">';
+		for($iPage = 1; $iPage < 5; $iPage++)
+		{
+			$iNbItems = $iPage * $iDefaultPageSize;
+			$sSelected = ($iNbItems == $iPageSize) ? 'selected="selected"' : '';
+			$sCombo .= "<option  $sSelected value=\"$iNbItems\">$iNbItems</option>";
+		}
+		$sSelected = ($iPageSize < 1) ? 'selected="selected"' : '';
+		$sCombo .= "<option  $sSelected value=\"-1\">".Dict::S('UI:Pagination:All')."</option>";
+		$sCombo .= '</select>';
+		
+		$sPages = Dict::S('UI:Pagination:PagesLabel');
+		$sPageSizeCombo = Dict::Format('UI:Pagination:PageSize', $sCombo);
+		
+		$iNbPages = ($iPageSize < 1) ? 1 : ceil($this->iNbObjects / $iPageSize);
+		if ($iNbPages == 1)
+		{
+			// No need to display the pager
+			$sPagerStyle = 'style="display:none"';
+		}
+		$aPagesToDisplay = array();
+		for($idx = 0; $idx <= min(4, $iNbPages-1); $idx++)
+		{
+			if ($idx == 0)
+			{
+				$aPagesToDisplay[$idx] = '<span page="0" class="curr_page">1</span>';
+			}
+			else
+			{
+				$aPagesToDisplay[$idx] = "<span id=\"gotopage_$idx\" class=\"gotopage\" page=\"$idx\">".(1+$idx)."</span>";
+			}
+		}
+		$iLastPageIdx = $iNbPages - 1;
+		if (!isset($aPagesToDisplay[$iLastPageIdx]))
+		{
+			unset($aPagesToDisplay[$idx - 1]); // remove the last page added to make room for the very last page
+			$aPagesToDisplay[$iLastPageIdx] = "<span id=\"gotopage_$iLastPageIdx\" class=\"gotopage\" page=\"$iLastPageIdx\">... $iNbPages</span>";
+		}
+		$sPagesLinks = implode('', $aPagesToDisplay);
+		$sPagesList = '['.implode(',', array_keys($aPagesToDisplay)).']';
+
+		$sSelectionMode = ($iNbPages == 1) ? '' : 'positive';
+		$sHtml =
+<<<EOF
+		<td colspan="2">
+		<div $sPagerStyle>
+		<table id="pager{$this->iListId}" class="pager"><tr>
+		<td>$sPages</td>
+		<td><img src="../images/first.png" class="first"/></td>
+		<td><img src="../images/prev.png" class="prev"/></td>
+		<td><span id="index">$sPagesLinks</span></td>
+		<td><img src="../images/next.png" class="next"/></td>
+		<td><img src="../images/last.png" class="last"/></td>
+		<td>$sPageSizeCombo</td>
+		<td><span id="loading">&nbsp;</span><input type="hidden" name="selectionMode" value="$sSelectionMode"></input>
+		</td>
+		</tr>
+		</table>
+		</div>
+		</td>
+EOF;
+		return $sHtml;
+	}
+	
+	protected function GetActionsMenu(WebPage $oPage, $aExtraParams)
+	{
+		$oMenuBlock = new MenuBlock($this->oSet->GetFilter(), 'list');
+		
+		$sHtml = $oMenuBlock->GetRenderContent($oPage, $aExtraParams, $this->iListId);
+		return $sHtml;
+	}
+	
+	protected function GetToolkitMenu(WebPage $oPage, $aExtraParams)
+	{
+		$sMenuTitle = Dict::S('UI:ConfigureThisList');
+		$sHtml = '<div class="itop_popup toolkit_menu" id="tk_'.$this->iListId.'"><ul><li><img src="../images/toolkit_menu.png"><ul>';
+
+		$oMenuItem1 = new JSPopupMenuItem('iTop::ConfigureList', $sMenuTitle, "$('#datatable_dlg_".$this->iListId."').dialog('open');");
+		$aActions = array(
+			$oMenuItem1->GetUID() => $oMenuItem1->GetMenuItem(),
+		);
+		$this->oSet->Rewind();
+		utils::GetPopupMenuItems($oPage, iPopupMenuExtension::MENU_OBJLIST_TOOLKIT, $this->oSet, $aActions, $this->sTableId, $this->iListId);
+		$this->oSet->Rewind();
+		$sHtml .= $oPage->RenderPopupMenuItems($aActions);
+		return $sHtml;
+	}
+	
+	protected function GetTableConfigDlg(WebPage $oPage, $aColumns, $bViewLink, $iDefaultPageSize)
+	{
+		$sHtml = "<div id=\"datatable_dlg_{$this->iListId}\" style=\"display: none;\">";
+		$sHtml .= "<form onsubmit=\"return false\">";
+		$sChecked = ($this->bUseCustomSettings) ? '' : 'checked';
+		$sHtml .= "<p><input id=\"dtbl_dlg_settings_{$this->iListId}\" type=\"radio\" name=\"settings\" $sChecked value=\"defaults\"><label for=\"dtbl_dlg_settings_{$this->iListId}\">&nbsp;".Dict::S('UI:UseDefaultSettings').'</label></p>';
+		$sHtml .= "<fieldset>";
+		$sChecked = ($this->bUseCustomSettings) ? 'checked':  '';
+		$sHtml .= "<legend class=\"transparent\"><input id=\"dtbl_dlg_specific_{$this->iListId}\" type=\"radio\" class=\"specific_settings\" name=\"settings\" $sChecked value=\"specific\"><label for=\"dtbl_dlg_specific_{$this->iListId}\">&nbsp;".Dict::S('UI:UseSpecificSettings')."</label></legend>";
+		$sHtml .= Dict::S('UI:ColumnsAndSortOrder').'<br/><ul class="sortable_field_list" id="sfl_'.$this->iListId.'"></ul>';
+		
+		$sHtml .= '<p>'.Dict::Format('UI:Display_X_ItemsPerPage', '<input type="text" size="4" name="page_size" value="'.$iDefaultPageSize.'">').'</p>';
+		$sHtml .= "</fieldset>";
+		$sHtml .= "<fieldset>";
+		$sSaveChecked = ($this->sTableId != null) ? 'checked' : '';
+		$sCustomDisabled = ($this->sTableId == null) ? 'disabled="disabled" stay-disabled="true" ' : '';
+		$sCustomChecked = ($this->sTableId != null) ? 'checked' : '';
+		$sGenericChecked = ($this->sTableId == null) ? 'checked' : '';
+		$sHtml .= "<legend class=\"transparent\"><input id=\"dtbl_dlg_save_{$this->iListId}\" type=\"checkbox\" $sSaveChecked name=\"save_settings\"><label for=\"dtbl_dlg_save_{$this->iListId}\">&nbsp;".Dict::S('UI:UseSavetheSettings')."</label></legend>";
+		$sHtml .= "<p><input id=\"dtbl_dlg_this_list_{$this->iListId}\" type=\"radio\" name=\"scope\" $sCustomChecked $sCustomDisabled value=\"this_list\"><label for=\"dtbl_dlg_this_list_{$this->iListId}\">&nbsp;".Dict::S('UI:OnlyForThisList').'</label>&nbsp;&nbsp;&nbsp;&nbsp;';
+		$sHtml .= "<input id=\"dtbl_dlg_all_{$this->iListId}\" type=\"radio\" name=\"scope\" $sGenericChecked value=\"defaults\"><label for=\"dtbl_dlg_all_{$this->iListId}\">&nbsp;".Dict::S('UI:ForAllLists').'</label></p>';
+		$sHtml .= "</fieldset>";
+		$sHtml .= '<table style="width:100%"><tr><td style="text-align:center;">';
+		$sHtml .= '<button type="button" onclick="$(\'#datatable_'.$this->iListId.'\').datatable(\'onDlgCancel\'); $(\'#datatable_dlg_'.$this->iListId.'\').dialog(\'close\')">'.Dict::S('UI:Button:Cancel').'</button>';
+		$sHtml .= '</td><td style="text-align:center;">';
+		$sHtml .= '<button type="submit" onclick="$(\'#datatable_'.$this->iListId.'\').datatable(\'onDlgOk\');$(\'#datatable_dlg_'.$this->iListId.'\').dialog(\'close\');">'.Dict::S('UI:Button:Ok').'</button>';
+		$sHtml .= '</td></tr></table>';
+		$sHtml .= "</form>";
+		$sHtml .= "</div>";
+		
+		$sDlgTitle = addslashes(Dict::S('UI:ListConfigurationTitle'));
+		$oPage->add_ready_script("$('#datatable_dlg_{$this->iListId}').dialog({autoOpen: false, title: '$sDlgTitle', width: 500, close: function() { $('#datatable_{$this->iListId}').datatable('onDlgCancel'); } });");
+
+		return $sHtml;
+	}
+	
+	public function GetAsHash($oSetting)
+	{
+		$aSettings = array('iDefaultPageSize' => $oSetting->iDefaultPageSize, 'oColumns' => $oSetting->aColumns);
+		return $aSettings;
+	}
+	
+	protected function GetHTMLTableConfig($aColumns, $sSelectMode, $bViewLink)
+	{
+		$aAttribs = array();
+		if ($sSelectMode == 'multiple')
+		{
+			$aAttribs['form::select'] = array('label' => "<input type=\"checkbox\" onClick=\"CheckAll('.selectList{$this->iListId}:not(:disabled)', this.checked);\" class=\"checkAll\"></input>", 'description' => Dict::S('UI:SelectAllToggle+'));
+		}
+		else if ($sSelectMode == 'single')
+		{
+			$aAttribs['form::select'] = array('label' => "", 'description' => '');
+		}
+
+		foreach($this->aClassAliases as $sAlias => $sClassName)
+		{
+			foreach($aColumns[$sAlias] as $sAttCode => $aData)
+			{
+				if ($aData['checked'])
+				{
+					if ($sAttCode == '_key_')
+					{
+						$aAttribs['key_'.$sAlias] = array('label' => MetaModel::GetName($sClassName), 'description' => '');
+					}
+					else
+					{
+						$oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
+						$aAttribs[$sAttCode.'_'.$sAlias] = array('label' => MetaModel::GetLabel($sClassName, $sAttCode), 'description' => $oAttDef->GetOrderByHint());
+					}
+				}
+			}
+		}
+		return $aAttribs;
+	}
+	
+	protected function GetHTMLTableValues($aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams)
+	{
+		$bLocalize = true;
+		if (isset($aExtraParams['localize_values']))
+		{
+			$bLocalize = (bool) $aExtraParams['localize_values'];
+		}
+
+		$aValues = array();
+		$this->oSet->Seek(0);
+		$iMaxObjects = $iPageSize;
+		while (($aObjects = $this->oSet->FetchAssoc()) && ($iMaxObjects != 0))
+		{
+			$bFirstObject = true;
+			$aRow = array();
+			foreach($this->aClassAliases as $sAlias => $sClassName)
+			{
+				if (is_object($aObjects[$sAlias]))
+				{
+					$sHilightClass = $aObjects[$sAlias]->GetHilightClass();
+					if ($sHilightClass != '')
+					{
+						$aRow['@class'] = $sHilightClass;	
+					}
+					if ((($sSelectMode == 'single') || ($sSelectMode == 'multiple')) && $bFirstObject)
+					{
+						if (array_key_exists('selection_enabled', $aExtraParams) && isset($aExtraParams['selection_enabled'][$aObjects[$sAlias]->GetKey()]))
+						{
+							$sDisabled = ($aExtraParams['selection_enabled'][$aObjects[$sAlias]->GetKey()]) ? '' : ' disabled="disabled"';
+						}
+						else
+						{
+							$sDisabled = '';
+						}
+						if ($sSelectMode == 'single')
+						{
+							$aRow['form::select'] = "<input type=\"radio\" $sDisabled class=\"selectList{$this->iListId}\" name=\"selectObject\" value=\"".$aObjects[$sAlias]->GetKey()."\"></input>";
+						}
+						else
+						{
+							$aRow['form::select'] = "<input type=\"checkBox\" $sDisabled class=\"selectList{$this->iListId}\" name=\"selectObject[]\" value=\"".$aObjects[$sAlias]->GetKey()."\"></input>";
+						}
+					}
+					foreach($aColumns[$sAlias] as $sAttCode => $aData)
+					{
+						if ($aData['checked'])
+						{
+							if ($sAttCode == '_key_')
+							{
+								$aRow['key_'.$sAlias] = $aObjects[$sAlias]->GetHyperLink();
+							}
+							else
+							{
+								$aRow[$sAttCode.'_'.$sAlias] = $aObjects[$sAlias]->GetAsHTML($sAttCode, $bLocalize);
+							}
+						}
+					}
+				}
+				else
+				{
+					foreach($aColumns[$sAlias] as $sAttCode => $aData)
+					{
+						if ($aData['checked'])
+						{
+							if ($sAttCode == '_key_')
+							{
+								$aRow['key_'.$sAlias] = '';
+							}
+							else
+							{
+								$aRow[$sAttCode.'_'.$sAlias] = '';
+							}
+						}
+					}
+				}
+				$bFirstObject = false;
+			}
+			$aValues[] = $aRow;
+			$iMaxObjects--;
+		}
+		return $aValues;
+	}
+	
+	public function GetHTMLTable(WebPage $oPage, $aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams)
+	{
+		$iNbPages = ($iPageSize < 1) ? 1 : ceil($this->iNbObjects / $iPageSize);
+		if ($iPageSize < 1)
+		{
+			$iPageSize = -1; // convention: no pagination
+		}
+		$aAttribs = $this->GetHTMLTableConfig($aColumns, $sSelectMode, $bViewLink);
+
+		$aValues = $this->GetHTMLTableValues($aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams);
+
+		$sHtml = '<table class="listContainer">';
+
+		foreach($this->oSet->GetFilter()->GetInternalParams() as $sName => $sValue)
+		{
+			$aExtraParams['query_params'][$sName] = $sValue;
+		}
+
+		$sHtml .= "<tr><td>";
+		$sHtml .= $oPage->GetTable($aAttribs, $aValues);
+		$sHtml .= '</td></tr>';
+		$sHtml .= '</table>';
+		$iCount = $this->iNbObjects;
+
+		$aArgs = $this->oSet->GetArgs();
+		$sExtraParams = addslashes(str_replace('"', "'", json_encode(array_merge($aExtraParams, $aArgs)))); // JSON encode, change the style of the quotes and escape them
+		$sSelectModeJS = '';
+		$sHeaders = '';
+		if (($sSelectMode == 'single') || ($sSelectMode == 'multiple'))
+		{
+			$sSelectModeJS = $sSelectMode;
+			$sHeaders = 'headers: { 0: {sorter: false}},';
+		}
+		$sDisplayKey = ($bViewLink) ? 'true' : 'false';
+		// Protect against duplicate elements in the Zlist
+		$aUniqueOrderedList = array();
+		foreach($this->aClassAliases as $sAlias => $sClassName)
+		{
+			foreach($aColumns[$sAlias] as $sAttCode => $aData)
+			{
+				if ($aData['checked'])
+				{
+					$aUniqueOrderedList[$sAttCode] = true;
+				}
+			}
+		}
+		$aUniqueOrderedList = array_keys($aUniqueOrderedList);
+		$sJSColumns = json_encode($aColumns);
+		$sJSClassAliases = json_encode($this->aClassAliases);
+		$sCssCount = isset($aExtraParams['cssCount']) ? ", cssCount: '{$aExtraParams['cssCount']}'" : '';
+		$this->oSet->ApplyParameters();
+		// Display the actual sort order of the table
+		$aRealSortOrder = $this->oSet->GetRealSortOrder();
+		$aDefaultSort = array();
+		$iColOffset = 0;
+		if (($sSelectMode == 'single') || ($sSelectMode == 'multiple'))
+		{
+			$iColOffset += 1;
+		}
+		if ($bViewLink)
+		{
+//			$iColOffset += 1;
+		}
+		foreach($aRealSortOrder as $sColCode => $bAscending)
+		{
+			$iPos = array_search($sColCode, $aUniqueOrderedList);
+			if ($iPos !== false)
+			{
+				$aDefaultSort[] = "[".($iColOffset+$iPos).",".($bAscending ? '0' : '1')."]";
+			}
+			else if (($iPos = array_search(preg_replace('/_friendlyname$/', '', $sColCode), $aUniqueOrderedList)) !== false)
+			{
+				// if sorted on the friendly name of an external key, then consider it sorted on the column that shows the links
+				$aDefaultSort[] = "[".($iColOffset+$iPos).",".($bAscending ? '0' : '1')."]";
+			}
+			else if($sColCode == 'friendlyname' && $bViewLink)
+			{
+				$aDefaultSort[] = "[".($iColOffset).",".($bAscending ? '0' : '1')."]";
+			}
+		}
+		$sFakeSortList = '';
+		if (count($aDefaultSort) > 0)
+		{
+			$sFakeSortList = '['.implode(',', $aDefaultSort).']';
+		}
+		$sOQL = addslashes($this->oSet->GetFilter()->serialize());
+		$oPage->add_ready_script(
+<<<EOF
+var oTable = $('#{$this->iListId} table.listResults');
+oTable.tablesorter( { $sHeaders widgets: ['myZebra', 'truncatedList']} ).tablesorterPager({container: $('#pager{$this->iListId}'), totalRows:$iCount, size: $iPageSize, filter: '$sOQL', extra_params: '$sExtraParams', select_mode: '$sSelectModeJS', displayKey: $sDisplayKey, columns: $sJSColumns, class_aliases: $sJSClassAliases $sCssCount});
+EOF
+		);
+		if ($sFakeSortList != '')
+		{
+			$oPage->add_ready_script("oTable.trigger(\"fakesorton\", [$sFakeSortList]);");
+		}
+		//if ($iNbPages == 1)
+		if (false)
+		{
+			if (isset($aExtraParams['cssCount']))
+			{
+				$sCssCount = $aExtraParams['cssCount'];
+				if ($sSelectMode == 'single')
+				{
+					$sSelectSelector = ":radio[name^=selectObj]";
+				}
+				else if ($sSelectMode == 'multiple')
+				{
+					$sSelectSelector = ":checkbox[name^=selectObj]";
+				}
+				$oPage->add_ready_script(
+<<<EOF
+	$('#{$this->iListId} table.listResults $sSelectSelector').change(function() {
+		var c = $('{$sCssCount}');							
+		var v = $('#{$this->iListId} table.listResults $sSelectSelector:checked').length;
+		c.val(v);
+		$('#{$this->iListId} .selectedCount').text(v);
+		c.trigger('change');	
+	});
+EOF
+				);
+			}
+		}
+		return $sHtml;
+	}
+	
+	public function UpdatePager(WebPage $oPage, $iDefaultPageSize, $iStart)
+	{
+		$iPageSize = ($iDefaultPageSize < 1) ? 1 : $iDefaultPageSize;
+		$iPageIndex = 1 + floor($iStart / $iPageSize);
+		$sHtml = $this->GetPager($oPage, $iPageSize, $iDefaultPageSize, $iPageIndex);
+		$oPage->add_ready_script("$('#pager{$this->iListId}').html('".str_replace("\n", ' ', addslashes($sHtml))."');");
+		if ($iDefaultPageSize < 1)
+		{
+			$oPage->add_ready_script("$('#pager{$this->iListId}').parent().hide()");
+		}
+		else
+		{
+			$oPage->add_ready_script("$('#pager{$this->iListId}').parent().show()");
+		}
+	}
+}
+
+class DataTableSettings implements Serializable
+{
+	public $aClassAliases;
+	public $sTableId;
+	public $iDefaultPageSize;
+	public $aColumns;
+
+	
+	public function __construct($aClassAliases, $sTableId = null)
+	{
+		$this->aClassAliases = $aClassAliases;
+		$this->sTableId = $sTableId;
+		$this->iDefaultPageSize = 10;
+		$this->aColumns = array();
+	}
+	
+	protected function Init($iDefaultPageSize, $aSortOrder, $aColumns)
+	{
+		$this->iDefaultPageSize = $iDefaultPageSize;
+		$this->aColumns = $aColumns;
+		$this->FixVisibleColumns();
+	}
+	
+	public function serialize()
+	{
+		// Save only the 'visible' columns
+		$aColumns = array();
+		foreach($this->aClassAliases as $sAlias => $sClass)
+		{
+			$aColumns[$sAlias] = array();
+			foreach($this->aColumns[$sAlias] as $sAttCode => $aData)
+			{
+				unset($aData['label']); // Don't save the display name
+				unset($aData['alias']); // Don't save the alias (redundant)
+				unset($aData['code']); // Don't save the code (redundant)
+				if ($aData['checked'])
+				{
+					$aColumns[$sAlias][$sAttCode] = $aData;
+				}
+			}
+		}
+		return serialize(
+			array(
+				'iDefaultPageSize' => $this->iDefaultPageSize,
+				'aColumns' => $aColumns,		
+			)
+		);
+	}
+	
+	public function unserialize($sData)
+	{
+		$aData = unserialize($sData);
+		$this->iDefaultPageSize = $aData['iDefaultPageSize'];
+		$this->aColumns = $aData['aColumns'];
+		foreach($this->aClassAliases as $sAlias => $sClass)
+		{
+			foreach($this->aColumns[$sAlias] as $sAttCode => $aData)
+			{
+				$aFieldData = false;
+				if ($sAttCode == '_key_')
+				{
+					$aFieldData = $this->GetFieldData($sAlias, $sAttCode, null, true /* bChecked */, $aData['sort']);
+				}
+				else if (MetaModel::isValidAttCode($sClass, $sAttCode))
+				{
+					$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+					$aFieldData = $this->GetFieldData($sAlias, $sAttCode, $oAttDef, true /* bChecked */, $aData['sort']);
+				}
+
+				if ($aFieldData)
+				{
+					$this->aColumns[$sAlias][$sAttCode] = $aFieldData;
+				}
+				else
+				{
+					unset($this->aColumns[$sAlias][$sAttCode]);
+				}
+			}
+		}
+		$this->FixVisibleColumns();		
+	}
+	
+	static public function GetDataModelSettings($aClassAliases, $bViewLink, $aDefaultLists)
+	{
+		$oSettings = new DataTableSettings($aClassAliases);
+		// Retrieve the class specific settings for each class/alias based on the 'list' ZList
+		//TODO let the caller pass some other default settings (another Zlist, extre fields...)
+		$aColumns = array();
+		foreach($aClassAliases as $sAlias => $sClass)
+		{
+			if ($aDefaultLists == null)
+			{
+				$aList = cmdbAbstract::FlattenZList(MetaModel::GetZListItems($sClass, 'list'));
+			}
+			else
+			{
+				$aList = $aDefaultLists[$sAlias];
+			}
+			
+			$aSortOrder = MetaModel::GetOrderByDefault($sClass);
+			if ($bViewLink)
+			{
+				$sSort = 'none';
+				if(array_key_exists('friendlyname', $aSortOrder))
+				{
+					$sSort = $aSortOrder['friendlyname'] ? 'asc' : 'desc';
+				}
+				$aColumns[$sAlias]['_key_'] = $oSettings->GetFieldData($sAlias, '_key_', null, true /* bChecked */, $sSort);
+			}
+			foreach($aList as $sAttCode)
+			{
+				$sSort = 'none';
+				if(array_key_exists($sAttCode, $aSortOrder))
+				{
+					$sSort = $aSortOrder[$sAttCode] ? 'asc' : 'desc';
+				}
+				$oAttDef = Metamodel::GetAttributeDef($sClass, $sAttCode);
+				$aFieldData = $oSettings->GetFieldData($sAlias, $sAttCode, $oAttDef, true /* bChecked */, $sSort);
+				if ($aFieldData) $aColumns[$sAlias][$sAttCode] = $aFieldData;
+			}
+		}
+		$iDefaultPageSize = appUserPreferences::GetPref('default_page_size', MetaModel::GetConfig()->GetMinDisplayLimit());
+		$oSettings->Init($iDefaultPageSize, $aSortOrder, $aColumns);
+		return $oSettings;
+	}
+	
+	protected function FixVisibleColumns()
+	{
+		foreach($this->aClassAliases as $sAlias => $sClass)
+		{
+			foreach($this->aColumns[$sAlias] as $sAttCode => $aData)
+			{
+				// Remove non-existent columns
+				// TODO: check if the existing ones are still valid (in case their type changed)
+				if (($sAttCode != '_key_') && (!MetaModel::IsValidAttCode($sClass, $sAttCode)))
+				{
+					unset($this->aColumns[$sAlias][$sAttCode]);
+				}
+			}
+			$aList = MetaModel::ListAttributeDefs($sClass);
+			
+			// Add the other (non visible ones), sorted in alphabetical order
+			$aTempData = array();
+			foreach($aList as $sAttCode => $oAttDef)
+			{
+				if ( (!array_key_exists($sAttCode, $this->aColumns[$sAlias])) && (!$oAttDef instanceof AttributeLinkSet))
+				{
+					$aFieldData = $this->GetFieldData($sAlias, $sAttCode, $oAttDef, false /* bChecked */, 'none');
+					if ($aFieldData) $aTempData[$aFieldData['label']] = $aFieldData;
+				}
+			}
+			ksort($aTempData);
+			foreach($aTempData as $sLabel => $aFieldData)
+			{
+				$this->aColumns[$sAlias][$aFieldData['code']] = $aFieldData;
+			}
+		}		
+	}
+	
+	static public function GetTableSettings($aClassAliases, $sTableId = null, $bOnlyOnTable = false)
+	{
+		$pref = null;
+		$oSettings = new DataTableSettings($aClassAliases, $sTableId);
+
+		if ($sTableId != null)
+		{
+			// An identified table, let's fetch its own settings (if any)
+			$pref = appUserPreferences::GetPref($oSettings->GetPrefsKey($sTableId), null);
+		}
+		
+		if ($pref == null)
+		{
+			if (!$bOnlyOnTable)
+			{
+				// Try the global preferred values for this class / set of classes
+				$pref = appUserPreferences::GetPref($oSettings->GetPrefsKey(null), null);
+			}
+			if ($pref == null)
+			{
+				// no such settings, use the default values provided by the data model
+				return null;
+			}
+		}
+		$oSettings->unserialize($pref);
+		
+		return $oSettings;
+	}
+	
+	public function GetSortOrder()
+	{
+		$aSortOrder = array();
+		foreach($this->aColumns as $sAlias => $aColumns)
+		{
+			foreach($aColumns as $aColumn)
+			{
+				if ($aColumn['sort'] != 'none')
+				{
+					$sCode = ($aColumn['code'] == '_key_') ? 'friendlyname' : $aColumn['code'];
+					$aSortOrder[$sCode] = ($aColumn['sort']=='asc'); // true for ascending, false for descending
+				}
+			}
+			break; // TODO: For now the Set object supports only sorting on the first class of the set
+		}
+		return $aSortOrder;
+	}
+	
+	public function Save($sTargetTableId = null)
+	{
+		$sSaveId = is_null($sTargetTableId) ? $this->sTableId : $sTargetTableId;
+		if ($sSaveId == null) return false; // Cannot save, the table is not identified, use SaveAsDefault instead
+		
+		$sSettings = $this->serialize();
+		appUserPreferences::SetPref($this->GetPrefsKey($sSaveId), $sSettings);
+		return true;
+	}
+
+	public function SaveAsDefault()
+	{
+		$sSettings = $this->serialize();
+		appUserPreferences::SetPref($this->GetPrefsKey(null), $sSettings);
+		return true;
+	}
+	
+
+	/**
+	 * Clear the preferences for this particular table
+	 * @param $bResetAll boolean If true,the settings for all tables of the same class(es)/alias(es) are reset
+	 */
+	public function ResetToDefault($bResetAll)
+	{
+		if (($this->sTableId == null) && (!$bResetAll)) return false; // Cannot reset, the table is not identified, use force $bResetAll instead
+		if ($bResetAll)
+		{
+			// Turn the key into a suitable PCRE pattern
+			$sKey = $this->GetPrefsKey(null);
+			$sPattern = str_replace(array('|'), array('\\|'), $sKey); // escape the | character
+			$sPattern = '#^'.str_replace(array('*'), array('.*'), $sPattern).'$#'; // Don't use slash as the delimiter since it's used in our key to delimit aliases
+			appUserPreferences::UnsetPref($sPattern, true);
+		}
+		else
+		{
+			appUserPreferences::UnsetPref($this->GetPrefsKey($this->sTableId), false);
+		}
+		return true;
+	}
+	
+	protected function GetPrefsKey($sTableId = null)
+	{
+		if ($sTableId == null) $sTableId = '*';
+		$aKeys = array();
+		foreach($this->aClassAliases as $sAlias => $sClass)
+		{
+			$aKeys[] = $sAlias.'-'.$sClass;
+		}
+		return implode('/', $aKeys).'|'.$sTableId;
+	}
+	
+	protected function GetFieldData($sAlias, $sAttCode, $oAttDef, $bChecked, $sSort)
+	{
+		$ret = false;
+		if ($sAttCode == '_key_')
+		{
+			$sLabel = Dict::Format('UI:ExtKey_AsLink', MetaModel::GetName($this->aClassAliases[$sAlias]));
+			$ret = array(
+				'label' => $sLabel,
+				'checked' => true,
+				'disabled' => true,
+				'alias' => $sAlias,
+				'code' => $sAttCode,
+				'sort' => $sSort,
+			);
+		}
+		else if (!$oAttDef->IsLinkSet())
+		{
+			$sLabel = $oAttDef->GetLabel();
+			if ($oAttDef->IsExternalKey())
+			{
+				$sLabel = Dict::Format('UI:ExtKey_AsLink', $oAttDef->GetLabel());
+			}
+			else if ($oAttDef->IsExternalField())
+			{
+				$oExtAttDef = $oAttDef->GetExtAttDef();
+				$sLabel = Dict::Format('UI:ExtField_AsRemoteField', $oAttDef->GetLabel(), $oExtAttDef->GetLabel());
+			}
+			elseif ($oAttDef instanceof AttributeFriendlyName)
+			{
+				$sLabel = Dict::Format('UI:ExtKey_AsFriendlyName', $oAttDef->GetLabel());
+			}
+			$ret = array(
+				'label' => $sLabel,
+				'checked' => $bChecked,
+				'disabled' => false,
+				'alias' => $sAlias,
+				'code' => $sAttCode,
+				'sort' => $sSort,
+			);
+		}
+		return $ret;		
+	}
+}

application/iotask.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Persistent class InputOutputTask
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/cmdbabstract.class.inc.php');

application/itopwizardwebpage.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Class iTopWizardWebPage
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once('itopwebpage.class.inc.php');

application/menunode.class.inc.php

@@ -1,30 +1,32 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2013 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Construction and display of the application's main menu
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/utils.inc.php');
 require_once(APPROOT.'/application/template.class.inc.php');
+require_once(APPROOT."/application/user.dashboard.class.inc.php");
 
 
 /**
@@ -59,10 +61,38 @@ require_once(APPROOT.'/application/template.class.inc.php');
  
 class ApplicationMenu
 {
+	static $bAdditionalMenusLoaded = false;
 	static $aRootMenus = array();
 	static $aMenusIndex = array();
 	static $sFavoriteSiloQuery = 'SELECT Organization';
 	
+	static public function LoadAdditionalMenus()
+	{
+		if (!self::$bAdditionalMenusLoaded)
+		{
+			// Build menus from module handlers
+			//
+			foreach(get_declared_classes() as $sPHPClass)
+			{
+				if (is_subclass_of($sPHPClass, 'ModuleHandlerAPI'))
+				{
+					$aCallSpec = array($sPHPClass, 'OnMenuCreation');
+					call_user_func($aCallSpec);
+				}
+			}
+
+			// Build menus from the menus themselves (e.g. the ShortcutContainerMenuNode will do that)
+			//
+			foreach(self::$aRootMenus as $aMenu)
+			{
+				$oMenuNode = self::GetMenuNode($aMenu['index']);
+				$oMenuNode->PopulateChildMenus();
+			}
+
+			self::$bAdditionalMenusLoaded = true;
+		}
+	}
+
 	/**
 	 * Set the query used to limit the list of displayed organizations in the drop-down menu
 	 * @param $sOQL string The OQL query returning a list of Organization objects
@@ -87,35 +117,59 @@ class ApplicationMenu
 	 * Main function to add a menu entry into the application, can be called during the definition
 	 * of the data model objects
 	 */
-	static public function InsertMenu(MenuNode $oMenuNode, $iParentIndex = -1, $fRank)
+	static public function InsertMenu(MenuNode $oMenuNode, $iParentIndex, $fRank)
 	{
 		$index = self::GetMenuIndexById($oMenuNode->GetMenuId());
 		if ($index == -1)
 		{
 			// The menu does not already exist, insert it
 			$index = count(self::$aMenusIndex);
-			self::$aMenusIndex[$index] = array( 'node' => $oMenuNode, 'children' => array());
+
 			if ($iParentIndex == -1)
 			{
+				$sParentId = '';
 				self::$aRootMenus[] = array ('rank' => $fRank, 'index' => $index);
 			}
 			else
 			{
+				$sParentId = self::$aMenusIndex[$iParentIndex]['node']->GetMenuId();
 				self::$aMenusIndex[$iParentIndex]['children'][] = array ('rank' => $fRank, 'index' => $index);
 			}
+
+			// Note: At the time when 'parent', 'rank' and 'source_file' have been added for the reflection API,
+			//       they were not used to display the menus (redundant or unused)
+			//
+			$aBacktrace = debug_backtrace();
+			$sFile = isset($aBacktrace[2]["file"]) ? $aBacktrace[2]["file"] : $aBacktrace[1]["file"];
+			self::$aMenusIndex[$index] = array('node' => $oMenuNode, 'children' => array(), 'parent' => $sParentId, 'rank' => $fRank, 'source_file' => $sFile);
+		}
+		else
+		{
+			// the menu already exists, let's combine the conditions that make it visible
+			self::$aMenusIndex[$index]['node']->AddCondition($oMenuNode);
 		}
 		return $index;
 	}
+
+	/**
+	 * Reflection API - Get menu entries
+	 */
+	static public function ReflectionMenuNodes()
+	{
+		self::LoadAdditionalMenus();
+		return self::$aMenusIndex;
+	}
 	
 	/**
 	 * Entry point to display the whole menu into the web page, used by iTopWebPage
 	 */
-	static public function DisplayMenu(iTopWebPage $oPage, $aExtraParams)
+	static public function DisplayMenu($oPage, $aExtraParams)
 	{
+		self::LoadAdditionalMenus();
 		// Sort the root menu based on the rank
 		usort(self::$aRootMenus, array('ApplicationMenu', 'CompareOnRank'));
 		$iAccordion = 0;
-		$iActiveMenu = ApplicationMenu::GetActiveNodeId();
+		$iActiveMenu = self::GetMenuIndexById(self::GetActiveNodeId());
 		foreach(self::$aRootMenus as $aMenu)
 		{
 			$oMenuNode = self::GetMenuNode($aMenu['index']);
@@ -130,8 +184,9 @@ class ApplicationMenu
 				$oPage->AddToMenu('</ul>');
 				if ($bActive)
 				{
-					$oPage->add_ready_script("$('#accordion').accordion('activate', $iAccordion);");
-					$oPage->add_ready_script("$('#accordion').accordion('option', {collapsible: true});"); // Make it auto-collapsible once it has been opened properly
+					//$oPage->add_ready_script("$('#accordion').accordion('activate', $iAccordion);");
+					// $oPage->add_ready_script("$('#accordion').accordion('option', {collapsible: true});"); // Make it auto-collapsible once it has been opened properly
+					$oPage->add_ready_script("$('#accordion').accordion('option', {collapsible: true, active: $iAccordion});"); // Make it auto-collapsible once it has been opened properly
 				}
 			}
 			$oPage->AddToMenu('</div>');
@@ -208,11 +263,11 @@ class ApplicationMenu
 	/**
 	 * Helper function to get the list of child(ren) of a menu
 	 */
-	static protected function GetChildren($index)
+	static public function GetChildren($index)
 	{
 		return self::$aMenusIndex[$index]['children'];
 	}
-	
+
 	/**
 	 * Helper function to get the ID of a menu based on its name
 	 * @param string $sTitle Title of the menu (as passed when creating the menu)
@@ -234,22 +289,23 @@ class ApplicationMenu
 	
 	/**
 	 * Retrieves the currently active menu (if any, otherwise the first menu is the default)
-	 * @return MenuNode or null if there is no menu at all !
+	 * @return string The Id of the currently active menu
 	 */
 	static public function GetActiveNodeId()
 	{
 		$oAppContext = new ApplicationContext();
-		$iMenuIndex = $oAppContext->GetCurrentValue('menu', -1);
-		
-		if ($iMenuIndex  == -1)
+		$sMenuId = $oAppContext->GetCurrentValue('menu', null);		
+		if ($sMenuId  === null)
 		{
 			// Make sure the root menu is sorted on 'rank'
 			usort(self::$aRootMenus, array('ApplicationMenu', 'CompareOnRank'));
 			$oFirstGroup = self::GetMenuNode(self::$aRootMenus[0]['index']);
-			$oMenuNode = self::GetMenuNode(self::$aMenusIndex[$oFirstGroup->GetIndex()]['children'][0]['index']);
-			$iMenuIndex = $oMenuNode->GetIndex();
+			$aChildren = self::$aMenusIndex[$oFirstGroup->GetIndex()]['children'];
+			usort($aChildren, array('ApplicationMenu', 'CompareOnRank'));
+			$oMenuNode = self::GetMenuNode($aChildren[0]['index']);
+			$sMenuId = $oMenuNode->GetMenuId();
 		}
-		return $iMenuIndex;
+		return $sMenuId;
 	}	
 }
 
@@ -284,25 +340,30 @@ abstract class MenuNode
 	protected $sMenuId;
 	protected $index;
 
+	/**
+	 * Properties reflecting how the node has been declared
+	 */
+	protected $aReflectionProperties;
+
 	/**
 	 * Class of objects to check if the menu is enabled, null if none
 	 */
-	protected $m_sEnableClass;
+	protected $m_aEnableClasses;
 
 	/**
 	 * User Rights Action code to check if the menu is enabled, null if none
 	 */
-	protected $m_iEnableAction;
+	protected $m_aEnableActions;
 
 	/**
 	 * User Rights allowed results (actually a bitmask) to check if the menu is enabled, null if none
 	 */
-	protected $m_iEnableActionResults;
+	protected $m_aEnableActionResults;
 
 	/**
 	 * Stimulus to check: if the user can 'apply' this stimulus, then she/he can see this menu
 	 */	
-	protected $m_sEnableStimulus;
+	protected $m_aEnableStimuli;
 	
 	/**
 	 * Create a menu item, sets the condition to have it displayed and inserts it into the application's main menu
@@ -318,12 +379,25 @@ abstract class MenuNode
 	public function __construct($sMenuId, $iParentIndex = -1, $fRank = 0, $sEnableClass = null, $iActionCode = null, $iAllowedResults = UR_ALLOWED_YES, $sEnableStimulus = null)
 	{
 		$this->sMenuId = $sMenuId;
-		$this->m_sEnableClass = $sEnableClass;
-		$this->m_iEnableAction = $iActionCode;
-		$this->m_iEnableActionResults = $iAllowedResults;
-		$this->m_sEnableStimulus = $sEnableStimulus;
+		$this->aReflectionProperties = array();
+		if (strlen($sEnableClass) > 0)
+		{
+			$this->aReflectionProperties['enable_class'] = $sEnableClass;
+			$this->aReflectionProperties['enable_action'] = $iActionCode;
+			$this->aReflectionProperties['enable_permission'] = $iAllowedResults;
+			$this->aReflectionProperties['enable_stimulus'] = $sEnableStimulus;
+		}
+		$this->m_aEnableClasses = array($sEnableClass);
+		$this->m_aEnableActions = array($iActionCode);
+		$this->m_aEnableActionResults = array($iAllowedResults);
+		$this->m_aEnableStimuli = array($sEnableStimulus);
 		$this->index = ApplicationMenu::InsertMenu($this, $iParentIndex, $fRank);
 	}
+
+	public function ReflectionProperties()
+	{
+		return $this->aReflectionProperties;
+	}
 	
 	public function GetMenuId()
 	{
@@ -332,12 +406,12 @@ abstract class MenuNode
 	
 	public function GetTitle()
 	{
-		return Dict::S("Menu:$this->sMenuId");
+		return Dict::S("Menu:$this->sMenuId", str_replace('_', ' ', $this->sMenuId));
 	}
 	
 	public function GetLabel()
 	{
-		return Dict::S("Menu:$this->sMenuId+");
+		return Dict::S("Menu:$this->sMenuId+", "");
 	}
 	
 	public function GetIndex()
@@ -345,44 +419,70 @@ abstract class MenuNode
 		return $this->index;
 	}
 	
+	public function PopulateChildMenus()
+	{
+		foreach (ApplicationMenu::GetChildren($this->GetIndex()) as $aMenu)
+		{
+			$index = $aMenu['index'];
+			$oMenu = ApplicationMenu::GetMenuNode($index);
+			$oMenu->PopulateChildMenus();
+		}
+	}
+
 	public function GetHyperlink($aExtraParams)
 	{
-		$aExtraParams['c[menu]'] = $this->GetIndex();
+		$aExtraParams['c[menu]'] = $this->GetMenuId();
 		return $this->AddParams(utils::GetAbsoluteUrlAppRoot().'pages/UI.php', $aExtraParams);
 	}
 	
+	/**
+	 * Add a limiting display condition for the same menu node. The conditions will be combined with a AND
+	 * @param $oMenuNode MenuNode Another definition of the same menu node, with potentially different access restriction
+	 * @return void
+	 */
+	public function AddCondition(MenuNode $oMenuNode)
+	{
+		foreach($oMenuNode->m_aEnableClasses as $index => $sClass )
+		{
+			$this->m_aEnableClasses[] = $sClass;
+			$this->m_aEnableActions[] = $oMenuNode->m_aEnableActions[$index];
+			$this->m_aEnableActionResults[] = $oMenuNode->m_aEnableActionResults[$index];
+			$this->m_aEnableStimuli[] = $oMenuNode->m_aEnableStimuli[$index];
+		}
+	}
 	/**
 	 * Tells whether the menu is enabled (i.e. displayed) for the current user
 	 * @return bool True if enabled, false otherwise
 	 */
 	public function IsEnabled()
 	{
-		if ($this->m_sEnableClass != null)
+		foreach($this->m_aEnableClasses as $index => $sClass)
 		{
-			if (MetaModel::IsValidClass($this->m_sEnableClass))
+			if ($sClass != null)
 			{
-				if ($this->m_sEnableStimulus != null)
+				if (MetaModel::IsValidClass($sClass))
 				{
-					if (!UserRights::IsStimulusAllowed($this->m_sEnableClass, $this->m_sEnableStimulus))
+					if ($this->m_aEnableStimuli[$index] != null)
 					{
-						return false;
+						if (!UserRights::IsStimulusAllowed($sClass, $this->m_aEnableStimuli[$index]))
+						{
+							return false;
+						}
+					}
+					if ($this->m_aEnableActions[$index] != null)
+					{
+						$iResult = UserRights::IsActionAllowed($sClass, $this->m_aEnableActions[$index]);
+						if (!($iResult & $this->m_aEnableActionResults[$index]))
+						{
+							return false;
+						}
 					}
 				}
-				if ($this->m_iEnableAction != null)
+				else
 				{
-					$iResult = UserRights::IsActionAllowed($this->m_sEnableClass, $this->m_iEnableAction);
-					if (($iResult & $this->m_iEnableActionResults))
-					{
-						return true;
-					}
-					else
-					{
-						return false;
-					}
+					return false;
 				}
-				return true;
 			}
-			return false;
 		}
 		return true;
 	}
@@ -458,6 +558,7 @@ class TemplateMenuNode extends MenuNode
 	{
 		parent::__construct($sMenuId, $iParentIndex, $fRank, $sEnableClass, $iActionCode, $iAllowedResults, $sEnableStimulus);
 		$this->sTemplateFile = $sTemplateFile;
+		$this->aReflectionProperties['template_file'] = $sTemplateFile;
 	}
 	
 	public function GetHyperlink($aExtraParams)
@@ -471,6 +572,7 @@ class TemplateMenuNode extends MenuNode
 		$sTemplate = @file_get_contents($this->sTemplateFile);
 		if ($sTemplate !== false)
 		{
+			$aExtraParams['table_id'] = 'Menu_'.$this->GetMenuId();
 			$oTemplate = new DisplayTemplate($sTemplate);
 			$oTemplate->Render($oPage, $aExtraParams);
 		}
@@ -516,6 +618,8 @@ class OQLMenuNode extends MenuNode
 		$this->sOQL = $sOQL;
 		$this->bSearch = $bSearch;
 		$this->m_aParams = array();
+		$this->aReflectionProperties['oql'] = $sOQL;
+		$this->aReflectionProperties['do_search'] = $bSearch;
 		// Enhancement: we could set as the "enable" condition that the user has enough rights to "read" the objects
 		// of the class specified by the OQL...
 	}
@@ -527,47 +631,47 @@ class OQLMenuNode extends MenuNode
 	public function SetParameters($aParams)
 	{
 		$this->m_aParams = $aParams;
+		foreach($aParams as $sKey => $value)
+		{
+			$this->aReflectionProperties[$sKey] = $value;
+		}
 	}
 	
 	public function RenderContent(WebPage $oPage, $aExtraParams = array())
 	{
-		$aExtraParams = array_merge($aExtraParams, $this->m_aParams);
-		try
-		{
-			$oSearch = DBObjectSearch::FromOQL($this->sOQL);
-			$sIcon = MetaModel::GetClassIcon($oSearch->GetClass());
-		}
-		catch(Exception $e)
-		{
-			$sIcon = '';
-		}
-		// The standard template used for all such pages: a (closed) search form at the top and a list of results at the bottom
-		$sTemplate = '';
+		OQLMenuNode::RenderOQLSearch
+		(
+			$this->sOQL,
+			Dict::S($this->sPageTitle),
+			'Menu_'.$this->GetMenuId(),
+			$this->bSearch, // Search pane
+			true, // Search open
+			$oPage, 
+			array_merge($this->m_aParams, $aExtraParams)
+		);
+	}
 
-		if ($this->bSearch)
+	public static function RenderOQLSearch($sOql, $sTitle, $sUsageId, $bSearchPane, $bSearchOpen, WebPage $oPage, $aExtraParams = array())
+	{
+		$sUsageId = utils::GetSafeId($sUsageId);
+		$oSearch = DBObjectSearch::FromOQL($sOql);
+		$sIcon = MetaModel::GetClassIcon($oSearch->GetClass());
+
+		if ($bSearchPane)
 		{
-			$sTemplate .= <<<EOF
-<itopblock BlockClass="DisplayBlock" type="search" asynchronous="false" encoding="text/oql">$this->sOQL</itopblock>
-EOF;
+			$aParams = array_merge(array('open' => $bSearchOpen, 'table_id' => $sUsageId), $aExtraParams);
+			$oBlock = new DisplayBlock($oSearch, 'search', false /* Asynchronous */, $aParams);
+			$oBlock->Display($oPage, 0);
 		}
-		$sParams = '';
-		if (!empty($this->m_aParams))
-		{
-			$sParams = 'parameters="';
-			foreach($this->m_aParams as $sName => $sValue)
-			{
-				$sParams .= $sName.':'.$sValue.';';
-			}
-			$sParams .= '"';
-		}
-		$sTemplate .= <<<EOF
-<p class="page-header">$sIcon<itopstring>$this->sPageTitle</itopstring></p>
-<itopblock BlockClass="DisplayBlock" type="list" asynchronous="false" encoding="text/oql" $sParams>$this->sOQL</itopblock>
-EOF;
-		$oTemplate = new DisplayTemplate($sTemplate);
-		$oTemplate->Render($oPage, $aExtraParams);
+		
+		$oPage->add("<p class=\"page-header\">$sIcon ".Dict::S($sTitle)."</p>");
+		
+		$aParams = array_merge(array('table_id' => $sUsageId), $aExtraParams);
+		$oBlock = new DisplayBlock($oSearch, 'list', false /* Asynchronous */, $aParams);
+		$oBlock->Display($oPage, $sUsageId);
 	}
 }
+
 /**
  * This class defines a menu item that displays a search form for the given class of objects
  */
@@ -593,16 +697,15 @@ class SearchMenuNode extends MenuNode
 		parent::__construct($sMenuId, $iParentIndex, $fRank, $sEnableClass, $iActionCode, $iAllowedResults, $sEnableStimulus);
 		$this->sPageTitle = "Menu:$sMenuId+";
 		$this->sClass = $sClass;
+		$this->aReflectionProperties['class'] = $sClass;
 	}
 	
 	public function RenderContent(WebPage $oPage, $aExtraParams = array())
 	{
-		// The standard template used for all such pages: an open search form at the top
-		$sTemplate = <<<EOF
-<itopblock BlockClass="DisplayBlock" type="search" asynchronous="false" encoding="text/oql" parameters="open:true">SELECT $this->sClass</itopblock>
-EOF;
-		$oTemplate = new DisplayTemplate($sTemplate);
-		$oTemplate->Render($oPage, $aExtraParams);
+		$oSearch = new DBObjectSearch($this->sClass);
+		$aParams = array_merge(array('open' => true, 'table_id' => 'Menu_'.utils::GetSafeId($this->GetMenuId())), $aExtraParams);
+		$oBlock = new DisplayBlock($oSearch, 'search', false /* Asynchronous */, $aParams);
+		$oBlock->Display($oPage, 0);
 	}
 }
 
@@ -632,11 +735,12 @@ class WebPageMenuNode extends MenuNode
 	{
 		parent::__construct($sMenuId, $iParentIndex, $fRank, $sEnableClass, $iActionCode, $iAllowedResults, $sEnableStimulus);
 		$this->sHyperlink = $sHyperlink;
+		$this->aReflectionProperties['url'] = $sHyperlink;
 	}
 
 	public function GetHyperlink($aExtraParams)
 	{
-		$aExtraParams['c[menu]'] = $this->GetIndex();
+		$aExtraParams['c[menu]'] = $this->GetMenuId();
 		return $this->AddParams( $this->sHyperlink, $aExtraParams);
 	}
 	
@@ -669,12 +773,13 @@ class NewObjectMenuNode extends MenuNode
 	{
 		parent::__construct($sMenuId, $iParentIndex, $fRank);
 		$this->sClass = $sClass;
+		$this->aReflectionProperties['class'] = $sClass;
 	}
 
 	public function GetHyperlink($aExtraParams)
 	{
 		$sHyperlink = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=new&class='.$this->sClass;
-		$aExtraParams['c[menu]'] = $this->GetIndex();
+		$aExtraParams['c[menu]'] = $this->GetMenuId();
 		return $this->AddParams($sHyperlink, $aExtraParams);
 	}
 
@@ -705,4 +810,241 @@ class NewObjectMenuNode extends MenuNode
 		assert(false); // Shall never be called, the external web page will handle the display by itself
 	}
 }
-?>
+
+require_once(APPROOT.'application/dashboard.class.inc.php');
+/**
+ * This class defines a menu item which content is based on XML dashboard.
+ */
+class DashboardMenuNode extends MenuNode
+{
+	protected $sDashboardFile;
+	
+	/**
+	 * Create a menu item based on a custom template and inserts it into the application's main menu
+	 * @param string $sMenuId Unique identifier of the menu (used to identify the menu for bookmarking, and for getting the labels from the dictionary)
+	 * @param string $sTemplateFile Path (or URL) to the file that will be used as a template for displaying the page's content
+	 * @param integer $iParentIndex ID of the parent menu
+	 * @param float $fRank Number used to order the list, any number will do, but for a given level (i.e same parent) all menus are sorted based on this value
+	 * @param string $sEnableClass Name of class of object
+	 * @param integer $iActionCode Either UR_ACTION_READ, UR_ACTION_MODIFY, UR_ACTION_DELETE, UR_ACTION_BULKREAD, UR_ACTION_BULKMODIFY or UR_ACTION_BULKDELETE
+	 * @param integer $iAllowedResults Expected "rights" for the action: either UR_ALLOWED_YES, UR_ALLOWED_NO, UR_ALLOWED_DEPENDS or a mix of them...
+	 * @return MenuNode
+	 */
+	public function __construct($sMenuId, $sDashboardFile, $iParentIndex, $fRank = 0, $sEnableClass = null, $iActionCode = null, $iAllowedResults = UR_ALLOWED_YES, $sEnableStimulus = null)
+	{
+		parent::__construct($sMenuId, $iParentIndex, $fRank, $sEnableClass, $iActionCode, $iAllowedResults, $sEnableStimulus);
+		$this->sDashboardFile = $sDashboardFile;
+		$this->aReflectionProperties['definition_file'] = $sDashboardFile;
+	}
+	
+	public function GetHyperlink($aExtraParams)
+	{
+		if ($this->sDashboardFile == '') return '';
+		return parent::GetHyperlink($aExtraParams);
+	}
+
+	public function GetDashboard()
+	{
+		$sDashboardDefinition = @file_get_contents($this->sDashboardFile);		
+		if ($sDashboardDefinition !== false)
+		{
+			$bCustomized = false;
+			
+			// Search for an eventual user defined dashboard, overloading the existing one
+			$oUDSearch = new DBObjectSearch('UserDashboard');
+			$oUDSearch->AddCondition('user_id', UserRights::GetUserId(), '=');
+			$oUDSearch->AddCondition('menu_code', $this->sMenuId, '=');
+			$oUDSet = new DBObjectSet($oUDSearch);
+			if ($oUDSet->Count() > 0)
+			{
+				// Assuming there is at most one couple {user, menu}!
+				$oUserDashboard = $oUDSet->Fetch();
+				$sDashboardDefinition = $oUserDashboard->Get('contents');
+				$bCustomized = true;
+				
+			}
+			$oDashboard = new RuntimeDashboard($this->sMenuId);
+			$oDashboard->FromXml($sDashboardDefinition);
+			$oDashboard->SetCustomFlag($bCustomized);
+		}
+		else
+		{
+			$oDashboard = null;
+		}
+		return $oDashboard;
+	}
+
+	public function RenderContent(WebPage $oPage, $aExtraParams = array())
+	{
+		$oDashboard = $this->GetDashboard();
+		if ($oDashboard != null)
+		{
+			$sDivId = preg_replace('/[^a-zA-Z0-9_]/', '', $this->sMenuId);
+			$oPage->add('<div class="dashboard_contents" id="'.$sDivId.'">');
+			$oDashboard->Render($oPage, false, $aExtraParams);
+			$oPage->add('</div>');
+			$oDashboard->RenderEditionTools($oPage);
+
+			if ($oDashboard->GetAutoReload())
+			{
+				$sId = $this->sMenuId;
+				$sExtraParams = json_encode($aExtraParams);
+				$iReloadInterval = 1000 * $oDashboard->GetAutoReloadInterval();
+				$oPage->add_script(
+<<<EOF
+					setInterval("ReloadDashboard('$sDivId');", $iReloadInterval);
+
+					function ReloadDashboard(sDivId)
+					{
+						var oExtraParams = $sExtraParams;
+						// Do not reload when a dialog box is active
+						if (!($('.ui-dialog:visible').length > 0))
+						{
+							$('.dashboard_contents#'+sDivId).block();
+							$.post(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php',
+							   { operation: 'reload_dashboard', dashboard_id: '$sId', extra_params: oExtraParams},
+							   function(data){
+								 $('.dashboard_contents#'+sDivId).html(data);
+								 $('.dashboard_contents#'+sDivId).unblock();
+								}
+							 );
+						}
+					}
+EOF
+				);
+			}
+
+			$bEdit = utils::ReadParam('edit', false);
+			if ($bEdit)
+			{
+				$sId = addslashes($this->sMenuId);
+				$oPage->add_ready_script("EditDashboard('$sId');");
+			}
+		}
+		else
+		{
+			$oPage->p("Error: failed to load dashboard file: '{$this->sDashboardFile}'");
+		}
+	}
+	
+	public function RenderEditor(WebPage $oPage)
+	{
+		$oDashboard = $this->GetDashboard();
+		if ($oDashboard != null)
+		{
+			$oDashboard->RenderEditor($oPage);
+		}
+		else
+		{
+			$oPage->p("Error: failed to load dashboard file: '{$this->sDashboardFile}'");
+		}
+	}
+	
+	public function AddDashlet($oDashlet)
+	{
+		$oDashboard = $this->GetDashboard();
+		if ($oDashboard != null)
+		{
+			$oDashboard->AddDashlet($oDashlet);
+			$oDashboard->Save();
+		}
+		else
+		{
+			$oPage->p("Error: failed to load dashboard file: '{$this->sDashboardFile}'");
+		}
+	}
+	
+}
+
+/**
+ * A shortcut container is the preferred destination of newly created shortcuts
+ */
+class ShortcutContainerMenuNode extends MenuNode
+{
+	public function GetHyperlink($aExtraParams)
+	{
+		return '';
+	}
+
+	public function RenderContent(WebPage $oPage, $aExtraParams = array())
+	{
+	}
+
+	public function PopulateChildMenus()
+	{
+		// Load user shortcuts in DB
+		//
+		$oBMSearch = new DBObjectSearch('Shortcut');
+		$oBMSearch->AddCondition('user_id', UserRights::GetUserId(), '=');
+		$oBMSet = new DBObjectSet($oBMSearch, array('friendlyname' => true)); // ascending on friendlyname
+		$fRank = 1;
+		while ($oShortcut = $oBMSet->Fetch())
+		{
+			$sName = $this->GetMenuId().'_'.$oShortcut->GetKey();
+			$oShortcutMenu = new ShortcutMenuNode($sName, $oShortcut, $this->GetIndex(), $fRank++);
+		}
+	
+		// Complete the tree
+		//
+		parent::PopulateChildMenus();
+	}
+}
+
+
+require_once(APPROOT.'application/shortcut.class.inc.php');
+/**
+ * This class defines a menu item which content is a shortcut.
+ */
+class ShortcutMenuNode extends MenuNode
+{
+	protected $oShortcut;
+	
+	/**
+	 * Create a menu item based on a custom template and inserts it into the application's main menu
+	 * @param string $sMenuId Unique identifier of the menu (used to identify the menu for bookmarking, and for getting the labels from the dictionary)
+	 * @param object $oShortcut Shortcut object
+	 * @param integer $iParentIndex ID of the parent menu
+	 * @param float $fRank Number used to order the list, any number will do, but for a given level (i.e same parent) all menus are sorted based on this value
+	 * @param string $sEnableClass Name of class of object
+	 * @param integer $iActionCode Either UR_ACTION_READ, UR_ACTION_MODIFY, UR_ACTION_DELETE, UR_ACTION_BULKREAD, UR_ACTION_BULKMODIFY or UR_ACTION_BULKDELETE
+	 * @param integer $iAllowedResults Expected "rights" for the action: either UR_ALLOWED_YES, UR_ALLOWED_NO, UR_ALLOWED_DEPENDS or a mix of them...
+	 * @return MenuNode
+	 */
+	public function __construct($sMenuId, $oShortcut, $iParentIndex, $fRank = 0, $sEnableClass = null, $iActionCode = null, $iAllowedResults = UR_ALLOWED_YES, $sEnableStimulus = null)
+	{
+		parent::__construct($sMenuId, $iParentIndex, $fRank, $sEnableClass, $iActionCode, $iAllowedResults, $sEnableStimulus);
+		$this->oShortcut = $oShortcut;
+		$this->aReflectionProperties['shortcut'] = $oShortcut->GetKey();
+	}
+	
+	public function GetHyperlink($aExtraParams)
+	{
+		$sContext = $this->oShortcut->Get('context');
+		$aContext = unserialize($sContext);
+		if (isset($aContext['menu']))
+		{
+			unset($aContext['menu']);
+		}
+		foreach ($aContext as $sArgName => $sArgValue)
+		{
+			$aExtraParams[$sArgName] = $sArgValue;
+		}
+		return parent::GetHyperlink($aExtraParams);
+	}
+
+	public function RenderContent(WebPage $oPage, $aExtraParams = array())
+	{
+		$this->oShortcut->RenderContent($oPage, $aExtraParams);
+	}
+
+	public function GetTitle()
+	{
+		return $this->oShortcut->Get('name');
+	}
+	
+	public function GetLabel()
+	{
+		return $this->oShortcut->Get('name');
+	}
+}
+

application/nicewebpage.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Class NiceWebPage
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT."/application/webpage.class.inc.php");
@@ -30,30 +31,148 @@ require_once(APPROOT."/application/webpage.class.inc.php");
 class NiceWebPage extends WebPage
 {
 	var $m_aReadyScripts;
+	var $m_sRootUrl;
 	
     public function __construct($s_title)
     {
         parent::__construct($s_title);
 		$this->m_aReadyScripts = array();
-		$this->add_linked_script("../js/jquery-1.4.2.min.js");
-		//$this->add_linked_script("../js/jquery.history_remote.pack.js");
-		$this->add_linked_stylesheet('../css/ui-lightness/jquery-ui-1.8.2.custom.css');
-		$this->add_linked_script('../js/jquery-ui-1.8.2.custom.min.js');
-		//$this->add_linked_script("../js/ui.resizable.js");
-//		$this->add_linked_script("../js/ui.tabs.js");
+		$this->add_linked_script("../js/jquery-1.10.0.min.js");
+		$this->add_linked_script("../js/jquery-migrate-1.2.1.min.js"); // Needed since many other plugins still rely on oldies like $.browser
+		$this->add_linked_stylesheet('../css/ui-lightness/jquery-ui-1.10.3.custom.min.css');
+		$this->add_linked_script('../js/jquery-ui-1.10.3.custom.min.js');
 		$this->add_linked_script("../js/hovertip.js");
-//		$this->add_linked_script("../js/jqModal.js");
-		$this->add_linked_stylesheet("../css/light-grey.css");
-//		$this->add_linked_stylesheet("../js/themes/light/light.tabs.css");
-		//$this->add_linked_stylesheet("../css/jquery.tabs-ie.css", "lte IE 7");
-//		$this->add_linked_stylesheet("../css/jqModal.css");
-		$this->add_ready_script('    window.setTimeout(hovertipInit, 1);');
-    }
+		// table sorting
+		$this->add_linked_script("../js/jquery.tablesorter.js");
+		$this->add_linked_script("../js/jquery.tablesorter.pager.js");
+		$this->add_linked_script("../js/jquery.tablehover.js");
+		$this->add_linked_script('../js/field_sorter.js');
+		$this->add_linked_script('../js/datatable.js');
+		$this->add_linked_script("../js/jquery.positionBy.js");
+		$this->add_linked_script("../js/jquery.popupmenu.js");
+		$this->add_ready_script(
+<<< EOF
+	//add new widget called TruncatedList to properly display truncated lists when they are sorted
+	$.tablesorter.addWidget({ 
+		// give the widget a id 
+		id: "truncatedList", 
+		// format is called when the on init and when a sorting has finished 
+		format: function(table)
+		{ 
+			// Check if there is a "truncated" line
+			this.truncatedList = false;  
+			if ($("tr td.truncated",table).length > 0)
+			{
+				this.truncatedList = true;
+			}
+			if (this.truncatedList)
+			{
+				$("tr td",table).removeClass('truncated');
+				$("tr:last td",table).addClass('truncated');
+			}
+		} 
+	});
 	
+	$.tablesorter.addWidget({ 
+		// give the widget a id 
+		id: "myZebra", 
+		// format is called when the on init and when a sorting has finished 
+		format: function(table)
+		{
+			// Replace the 'red even' lines by 'red_even' since most browser do not support 2 classes selector in CSS, etc..
+			$("tbody tr:even",table).addClass('even');
+			$("tbody tr.red:even",table).removeClass('red').removeClass('even').addClass('red_even');
+			$("tbody tr.orange:even",table).removeClass('orange').removeClass('even').addClass('orange_even');
+			$("tbody tr.green:even",table).removeClass('green').removeClass('even').addClass('green_even');
+			// In case we sort again the table, we need to remove the added 'even' classes on odd rows
+			$("tbody tr:odd",table).removeClass('even');
+			$("tbody tr.red_even:odd",table).removeClass('even').removeClass('red_even').addClass('red');
+			$("tbody tr.orange_even:odd",table).removeClass('even').removeClass('orange_even').addClass('orange');
+			$("tbody tr.green_even:odd",table).removeClass('even').removeClass('green_even').addClass('green');
+		} 
+	});
+	$("table.listResults").tableHover(); // hover tables
+EOF
+		);
+		$this->add_linked_stylesheet("../css/light-grey.css");
+
+		$this->m_sRootUrl = $this->GetAbsoluteUrlAppRoot();
+     	$sAbsURLAppRoot = addslashes($this->m_sRootUrl);
+    	$sAbsURLModulesRoot = addslashes($this->GetAbsoluteUrlModulesRoot());
+    	$sEnvironment = addslashes(utils::GetCurrentEnvironment());
+
+		$sAppContext = addslashes($this->GetApplicationContext());
+
+		$this->add_script(
+<<<EOF
+function GetAbsoluteUrlAppRoot()
+{
+	return '$sAbsURLAppRoot';
+}
+
+function GetAbsoluteUrlModulesRoot()
+{
+	return '$sAbsURLModulesRoot';
+}
+
+function GetAbsoluteUrlModulePage(sModule, sPage, aArguments)
+{
+	// aArguments is optional, it default to an empty hash
+	aArguments = typeof aArguments !== 'undefined' ? aArguments : {};
+
+	var sUrl = '$sAbsURLAppRoot'+'pages/exec.php?exec_module='+sModule+'&exec_page='+sPage+'&exec_env='+'$sEnvironment';
+	for (var sArgName in aArguments)
+	{
+		if (aArguments.hasOwnProperty(sArgName))
+		{
+			sUrl = sUrl + '&'+sArgName+'='+aArguments[sArgname];
+		}
+	}
+	return sUrl;
+}
+
+function AddAppContext(sURL)
+{
+	var sContext = '$sAppContext';
+	if (sContext.length > 0)
+	{
+		if (sURL.indexOf('?') == -1)
+		{
+			return sURL+'?'+sContext;
+		}				
+		return sURL+'&'+sContext;
+	}
+	return sURL;
+}
+EOF
+		);
+	}
+	
+    public function SetRootUrl($sRootUrl)
+    {
+    	$this->m_sRootUrl = $sRootUrl;
+    }
+    
 	public function small_p($sText)
 	{
 		$this->add("<p style=\"font-size:smaller\">$sText</p>\n");
-	}	
+	}
+
+	public function GetAbsoluteUrlAppRoot()
+	{
+		return utils::GetAbsoluteUrlAppRoot();
+	}
+
+	public function GetAbsoluteUrlModulesRoot()
+	{
+		return utils::GetAbsoluteUrlModulesRoot();
+	}
+
+	function GetApplicationContext()
+	{
+		$oAppContext = new ApplicationContext();
+		return $oAppContext->GetForLink();
+	}
 
 	// By Rom, used by CSVImport and Advanced search
 	public function MakeClassesSelect($sName, $sDefaultValue, $iWidthPx, $iActionCode = null)
@@ -100,6 +219,7 @@ class NiceWebPage extends WebPage
 	 */
     public function output()
     {
+		//$this->set_base($this->m_sRootUrl.'pages/');
         if (count($this->m_aReadyScripts)>0)
         {
 			$this->add_script("\$(document).ready(function() {\n".implode("\n", $this->m_aReadyScripts)."\n});");

application/portalwebpage.class.inc.php

@@ -1,26 +1,26 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2013 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * Class PortalWebPage
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2013 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT."/application/nicewebpage.class.inc.php");
@@ -59,9 +59,12 @@ class PortalWebPage extends NiceWebPage
 		$this->add_header("Cache-control: no-cache");
 		$this->add_linked_stylesheet("../css/jquery.treeview.css");
 		$this->add_linked_stylesheet("../css/jquery.autocomplete.css");
+		$this->add_linked_stylesheet("../css/jquery.multiselect.css");
 		$sAbsURLAppRoot = addslashes(utils::GetAbsoluteUrlAppRoot()); // Pass it to Javascript scripts
+		$sAbsURLModulesRoot = addslashes(utils::GetAbsoluteUrlModulesRoot()); // Pass it to Javascript scripts
 		$oAppContext = new ApplicationContext();
 		$sAppContext = addslashes($oAppContext->GetForLink());
+		$this->add_dict_entry('UI:FillAllMandatoryFields');
 		if ($sAlternateStyleSheet != '')
 		{
 			$this->add_linked_stylesheet("../portal/$sAlternateStyleSheet/portal.css");
@@ -85,6 +88,8 @@ class PortalWebPage extends NiceWebPage
 		$this->add_linked_script("../js/forms-json-utils.js");
 		$this->add_linked_script("../js/swfobject.js");
 		$this->add_linked_script("../js/jquery.qtip-1.0.min.js");
+		$this->add_linked_script('../js/jquery.multiselect.min.js');
+		$this->add_linked_script("../js/ajaxfileupload.js");
 		$this->add_ready_script(
 <<<EOF
 try
@@ -134,6 +139,17 @@ try
 			changeMonth: true,
 			changeYear: true
 		});
+
+	$(".datetime-pick").datepicker({
+		showOn: 'button',
+		buttonImage: '../images/calendar.png',
+		buttonImageOnly: true,
+		dateFormat: 'yy-mm-dd 00:00:00',
+		constrainInput: false,
+		changeMonth: true,
+		changeYear: true
+		});
+
 	//$('.resizable').resizable(); // Make resizable everything that claims to be resizable !
 	$('.caselog_header').click( function () { $(this).toggleClass('open').next('.caselog_entry').toggle(); });
 }
@@ -172,6 +188,11 @@ EOF
 		return '$sAbsURLAppRoot';
 	}
 	
+	function GetAbsoluteUrlModulesRoot()
+	{
+		return '$sAbsURLModulesRoot';
+	}
+
 	function AddAppContext(sURL)
 	{
 		var sContext = '$sAppContext';
@@ -212,8 +233,21 @@ EOF
 	}
 EOF
 );
-		
-	}
+
+		// For Wizard helper to process the ajax replies
+		$this->add('<div id="ajax_content"></div>');
+
+		// Customize the logo (unless a customer CSS has been defined)
+		if ($sAlternateStyleSheet == '')
+		{
+			if (file_exists(MODULESROOT.'branding/portal-logo.png'))
+			{
+				$sDisplayIcon = utils::GetAbsoluteUrlModulesRoot().'branding/portal-logo.png';
+				$this->add_style("div#portal #logo {background: url(\"$sDisplayIcon\") no-repeat scroll 0 0 transparent;}");
+			}
+		}
+
+}
 
 	public function SetCurrentTab($sTabLabel = '')
 	{
@@ -244,6 +278,21 @@ EOF
 	
 	public function output()
 	{
+		$sApplicationBanner = '';
+		if (!MetaModel::DBHasAccess(ACCESS_USER_WRITE))
+		{
+			$sReadOnly = Dict::S('UI:AccessRO-Users');
+			$sAdminMessage = trim(MetaModel::GetConfig()->Get('access_message'));
+			$sApplicationBanner .= '<div id="admin-banner">';
+			$sApplicationBanner .= '<img src="../images/locked.png" style="vertical-align:middle;">';
+			$sApplicationBanner .= '&nbsp;<b>'.$sReadOnly.'</b>';
+			if (strlen($sAdminMessage) > 0)
+			{
+				$sApplicationBanner .= '&nbsp;: '.$sAdminMessage.'';
+			}
+			$sApplicationBanner .= '</div>';
+		}
+
 		$sMenu = '';
 		if ($this->m_bEnableDisconnectButton)
 		{
@@ -253,7 +302,7 @@ EOF
 		{
 			$sMenu .= "<a class=\"button\" id=\"{$aMenuItem['id']}\" href=\"{$aMenuItem['hyperlink']}\"><span>".Dict::S($aMenuItem['label'])."</span></a>";
 		}
-		$this->s_content = '<div id="portal"><div id="welcome">'.$this->m_sWelcomeMsg.'</div><div id="banner"><div id="logo"></div><div id="menu">'.$sMenu.'</div></div><div id="content">'.$this->s_content.'</div></div>';
+		$this->s_content = '<div id="portal"><div id="welcome">'.$this->m_sWelcomeMsg.'</div><div id="banner"><div id="logo"></div><div id="menu">'.$sMenu.'</div></div>'.$sApplicationBanner.'<div id="content">'.$this->s_content.'</div></div>';
 		parent::output();
 	}
 
@@ -273,13 +322,9 @@ EOF
 			{
 				// Home-made and very limited display of an object set
 
-				//
-				//$oSet->Seek(0);// juste pour que le warning soit moins crado
-				//$oSet->Fetch();// juste pour que le warning soit moins crado
-				//
-
-				$this->add("<div id=\"listOf$sClass\">\n");
-				cmdbAbstractObject::DisplaySet($this, $oSet, array('currentId' => "listOf$sClass", 'menu' => false, 'zlist' => false, 'extra_fields' => implode(',', $aZList)));
+				$sUniqueId = $sClass.$this->GetUniqueId();
+				$this->add("<div id=\"$sUniqueId\">\n"); // The id here MUST be the same as currentId, otherwise the pagination will be broken
+				cmdbAbstractObject::DisplaySet($this, $oSet, array('currentId' => $sUniqueId, 'menu' => false, 'toolkit_menu' => false, 'zlist' => false, 'extra_fields' => implode(',', $aZList)));
 				$this->add("</div>\n");
 			}
 			else
@@ -375,7 +420,7 @@ EOF
 			}
 			$oObjSearch->AddCondition_ReferencedBy($oLinkSet->GetFilter(), $sRemoteAttCode);
 
-			$aExtraParams = array('menu' => false, 'zlist' => false, 'extra_fields' => implode(',', $aZList));
+			$aExtraParams = array('menu' => false, 'toolkit_menu' => false, 'zlist' => false, 'extra_fields' => implode(',', $aZList));
 			$oBlock = new DisplayBlock($oObjSearch, 'list', false);
 			$oBlock->Display($this, 1, $aExtraParams);
 		}
@@ -385,8 +430,7 @@ EOF
 		}
 	}
 
-
-	protected function DisplaySearchField($sClass, $sAttSpec, $aExtraParams, $sPrefix, $sFieldName = null)
+	protected function DisplaySearchField($sClass, $sAttSpec, $aExtraParams, $sPrefix, $sFieldName = null, $aFilterParams = array())
 	{
 		if (is_null($sFieldName))
 		{
@@ -417,7 +461,7 @@ EOF
 			{
 				throw new Exception("Attribute specification '$sAttSpec', '$sAttCode' should be either a link set or an external key");
 			}
-			$this->DisplaySearchField($sTargetClass, $sSubSpec, $aExtraParams, $sPrefix, $sFieldName);
+			$this->DisplaySearchField($sTargetClass, $sSubSpec, $aExtraParams, $sPrefix, $sFieldName, $aFilterParams);
 		}
 		else
 		{
@@ -431,7 +475,24 @@ EOF
 			if ($oAttDef->IsExternalKey())
 			{
 				$sTargetClass = $oAttDef->GetTargetClass();
-				$oAllowedValues = new DBObjectSet(new DBObjectSearch($sTargetClass));
+				$sFilterDefName = 'PORTAL_TICKETS_SEARCH_FILTER_'.$sAttSpec;
+				if (defined($sFilterDefName))
+				{
+					try
+					{
+						$oFitlerWithParams = DBObjectSearch::FromOQL(constant($sFilterDefName));
+						$sFilterOQL = $oFitlerWithParams->ToOQL(true, $aFilterParams);
+						$oAllowedValues = new DBObjectSet(DBObjectSearch::FromOQL($sFilterOQL), array(), $aFilterParams);
+					}
+					catch(OQLException $e)
+					{
+						throw new Exception("Incorrect filter '$sFilterDefName' for attribute '$sAttcode': ".$e->getMessage());
+					}
+				}
+				else
+				{
+					$oAllowedValues = new DBObjectSet(new DBObjectSearch($sTargetClass));
+				}
 		
 				$iFieldSize = $oAttDef->GetMaxSize();
 				$iMaxComboLength = $oAttDef->GetMaximumComboLength();
@@ -451,7 +512,8 @@ EOF
 				if (is_null($aAllowedValues))
 				{
 					// Any value is possible, display an input box
-					$this->add("<label>".MetaModel::GetFilterLabel($sClass, $sAttSpec).":</label>&nbsp;<input class=\"textSearch\" name=\"$sPrefix$sFieldName\" value=\"$sFilterValue\"/>\n");
+					$sSanitizedValue = htmlentities($sFilterValue, ENT_QUOTES, 'UTF-8');
+					$this->add("<label>".MetaModel::GetFilterLabel($sClass, $sAttSpec).":</label>&nbsp;<input class=\"textSearch\" name=\"$sPrefix$sFieldName\" value=\"$sSanitizedValue\"/>\n");
 				}
 				else
 				{
@@ -488,9 +550,30 @@ EOF
 		}
 	}
 	
+	/**
+	 * Get The organization of the current user (i.e. the organization of its contact)
+	 * @throws Exception
+	 */
+	function GetUserOrg()
+	{
+		$oOrg = null;
+		$iContactId = UserRights::GetContactId();
+		$oContact = MetaModel::GetObject('Contact', $iContactId, false); // false => Can fail
+		if (is_object($oContact))
+		{
+			$oOrg = MetaModel::GetObject('Organization', $oContact->Get('org_id'), false); // false => can fail
+		}
+		else
+		{
+			throw new Exception(Dict::S('Portal:ErrorNoContactForThisUser'));
+		}
+		return $oOrg;
+	}
 	
 	public function DisplaySearchForm($sClass, $aAttList, $aExtraParams, $sPrefix, $bClosed = true)
 	{
+		$oUserOrg = $this->GetUserOrg();
+		$aFilterParams = array('org_id' => $oUserOrg->GetKey(), 'contact_id' => UserRights::GetContactId());
 		$sCSSClass = ($bClosed) ? 'DrawerClosed' : '';
 		$this->add("<div id=\"ds_$sPrefix\" class=\"SearchDrawer $sCSSClass\">\n");
 		$this->add_ready_script(
@@ -507,13 +590,17 @@ EOF
 		foreach($aAttList as $sAttSpec)
 		{
 			//$oAppContext->Reset($sAttSpec); // Make sure the same parameter will not be passed twice
-			$this->DisplaySearchField($sClass, $sAttSpec, $aExtraParams, $sPrefix);
+			$this->DisplaySearchField($sClass, $sAttSpec, $aExtraParams, $sPrefix, null, $aFilterParams);
 		}
 		$this->add("</p>\n");
 		$this->add("<p align=\"right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Search')."\"></p>\n");
 		foreach($aExtraParams as $sName => $sValue)
 		{
-			$this->add("<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n");
+			// Note: use DumpHiddenParams() to transmit arrays as hidden params
+			if (is_scalar($sValue))
+			{
+				$this->add("<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n");
+			}
 		}
 	//	$this->add($oAppContext->GetForForm());
 		$this->add("</form>\n");
@@ -592,7 +679,7 @@ EOF
 		{
 			$sFieldName = str_replace('->', PARAM_ARROW_SEP, $sAttSpec);
 			$value = utils::ReadPostedParam($sPrefix.$sFieldName, null, 'raw_data');
-			if (!is_null($value) && strlen($value) > 0)
+			if (!is_null($value) && (is_array($value) ? count($value)>0 : strlen($value)>0))
 			{
 				$oFilter->AddConditionAdvanced($sAttSpec, $value);
 				$iCountParams++;
@@ -650,26 +737,24 @@ EOF
 			}
 		}
 		
-		// Record the change
-		//
-		$oMyChange = MetaModel::NewObject("CMDBChange");
-		$oMyChange->Set("date", time());
-		$sUserString = CMDBChange::GetCurrentUserName();
-		$oMyChange->Set("userinfo", $sUserString);
-		$iChangeId = $oMyChange->DBInsert();
-		$oObj->DBUpdateTracked($oMyChange);
-		
-		// Trigger ?
-		//
-		$aClasses = MetaModel::EnumParentClasses($sClass, ENUM_PARENT_CLASSES_ALL);
-		$sClassList = implode(", ", CMDBSource::Quote($aClasses));
-		$oSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT TriggerOnPortalUpdate AS t WHERE t.target_class IN ($sClassList)"));
-		while ($oTrigger = $oSet->Fetch())
+		if ($oObj->IsModified())
 		{
-			$oTrigger->DoActivate($oObj->ToArgs('this'));
+			// Record the change
+			//
+			$oObj->DBUpdate();
+			
+			// Trigger ?
+			//
+			$aClasses = MetaModel::EnumParentClasses($sClass, ENUM_PARENT_CLASSES_ALL);
+			$sClassList = implode(", ", CMDBSource::Quote($aClasses));
+			$oSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT TriggerOnPortalUpdate AS t WHERE t.target_class IN ($sClassList)"));
+			while ($oTrigger = $oSet->Fetch())
+			{
+				$oTrigger->DoActivate($oObj->ToArgs('this'));
+			}
+	
+			$this->p("<h1>".Dict::Format('UI:Class_Object_Updated', MetaModel::GetName(get_class($oObj)), $oObj->GetName())."</h1>\n");
 		}
-
-		$this->p("<h1>".Dict::Format('UI:Class_Object_Updated', MetaModel::GetName(get_class($oObj)), $oObj->GetName())."</h1>\n");
 	}
 
 	/**
@@ -711,7 +796,7 @@ EOF
 			}
 		}
 
-		$oObj = MetaModel::GetObject($sClass, $iId, false);
+		$oObj = MetaModel::GetObject($sClass, $iId, false);		
 		if (!is_object($oObj))
 		{
 			throw new Exception("Could not find the object $sClass/$iId");
@@ -726,7 +811,7 @@ EOF
 		$this->m_sWizardId = $sId;
 
 		// multipart... needed for file upload
-		$this->add("<form id=\"{$this->m_sWizardId}\" method=\"$sMethod\" enctype=\"multipart/form-data\">\n");
+		$this->add("<form id=\"{$this->m_sWizardId}\" method=\"$sMethod\" enctype=\"multipart/form-data\" onsubmit=\"window.bInSubmit = true;\">\n");
 
 		$aPreviousSteps = $this->GetWizardStepHistory();
 		if (utils::ReadParam('step_back', 0) == 1)
@@ -764,7 +849,10 @@ EOF
 		}
 		if ($iButtonFlags & BUTTON_BACK)
 		{
-			$aButtons[] = "<input id=\"btn_back\" type=\"submit\" value=\"".Dict::S('UI:Button:Back')."\"  onClick=\"GoBack('{$this->m_sWizardId}');\">";
+			if (utils::ReadParam('step_back', 1) != 1)
+			{
+				$aButtons[] = "<input id=\"btn_back\" type=\"submit\" value=\"".Dict::S('UI:Button:Back')."\"  onClick=\"GoBack('{$this->m_sWizardId}');\">";
+			}
 		}
 		if ($iButtonFlags & BUTTON_NEXT)
 		{

application/query.class.inc.php

@@ -0,0 +1,130 @@
+<?php
+// Copyright (C) 2010-2012 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+
+/**
+ * Persistent class Event and derived
+ * Application internal events
+ * There is also a file log 
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+abstract class Query extends cmdbAbstractObject
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "core/cmdb,view_in_gui,application",
+			"key_type" => "autoincrement",
+			"name_attcode" => "name",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_query",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "realclass",
+			"display_template" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		//MetaModel::Init_InheritAttributes();
+		MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values"=>null, "sql"=>"name", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeText("description", array("allowed_values"=>null, "sql"=>"description", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+
+		MetaModel::Init_AddAttribute(new AttributeText("fields", array("allowed_values"=>null, "sql"=>"fields", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
+
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('name', 'description', 'fields')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('description')); // Attributes to be displayed for a list
+		// Search criteria
+		MetaModel::Init_SetZListItems('standard_search', array('name', 'description', 'fields')); // Criteria of the std search form
+//		MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
+	}
+}
+
+class QueryOQL extends Query
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "core/cmdb,view_in_gui,application",
+			"key_type" => "autoincrement",
+			"name_attcode" => "name",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_query_oql",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+			"display_template" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_InheritAttributes();
+		MetaModel::Init_AddAttribute(new AttributeOQL("oql", array("allowed_values"=>null, "sql"=>"oql", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('name', 'description', 'oql', 'fields')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('description')); // Attributes to be displayed for a list
+		// Search criteria
+		MetaModel::Init_SetZListItems('standard_search', array('name', 'description', 'fields', 'oql')); // Criteria of the std search form
+//		MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
+	}
+
+	function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = array())
+	{
+		$aFieldsMap = parent::DisplayBareProperties($oPage, $bEditMode, $sPrefix, $aExtraParams);
+		
+		if (!$bEditMode)
+		{
+			$sUrl = utils::GetAbsoluteUrlAppRoot().'webservices/export.php?format=spreadsheet&login_mode=basic&query='.$this->GetKey();
+			$sOql = $this->Get('oql');
+			$sMessage = null;
+			try
+			{
+				$oSearch = DBObjectSearch::FromOQL($sOql);
+				$aParameters = $oSearch->GetQueryParams();
+				foreach($aParameters as $sParam => $val)
+				{
+					$sUrl .= '&arg_'.$sParam.'=["'.$sParam.'"]';
+				}
+
+				$oPage->p(Dict::S('UI:Query:UrlForExcel').':<br/><textarea cols="80" rows="3" READONLY>'.$sUrl.'</textarea>');
+
+				if (count($aParameters) == 0)
+				{
+					$oBlock = new DisplayBlock($oSearch, 'list');
+					$aExtraParams = array(
+						//'menu' => $sShowMenu,
+						'table_id' => 'query_preview_'.$this->getKey(),
+					);
+					$sBlockId = 'block_query_preview_'.$this->GetKey(); // make a unique id (edition occuring in the same DOM)
+					$oBlock->Display($oPage, $sBlockId, $aExtraParams);
+				}
+			}
+			catch (OQLException $e)
+			{
+				$sMessage = '<div class="message message_error" style="padding-left: 30px;"><div style="padding: 10px;">'.Dict::Format('UI:RunQuery:Error', $e->getHtmlDesc()).'</div></div>';
+				$oPage->p($sMessage);
+			}
+		}
+		return $aFieldsMap;
+	}
+}
+
+?>

application/shortcut.class.inc.php

@@ -0,0 +1,338 @@
+<?php
+// Copyright (C) 2010-2013 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+
+/**
+ * Persistent class Shortcut and derived
+ * Shortcuts of any kind
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+abstract class Shortcut extends DBObject implements iDisplay
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "gui,view_in_gui",
+			"key_type" => "autoincrement",
+			"name_attcode" => "name",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_shortcut",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "realclass",
+			"display_template" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		//MetaModel::Init_InheritAttributes();
+		MetaModel::Init_AddAttribute(new AttributeExternalKey("user_id", array("targetclass"=>"User", "allowed_values"=>null, "sql"=>"user_id", "is_null_allowed"=>true, "on_target_delete"=>DEL_AUTO, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values"=>null, "sql"=>"name", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeText("context", array("allowed_values"=>null, "sql"=>"context", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('name', 'context')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('name')); // Attributes to be displayed for a list
+		// Search criteria
+//		MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form
+//		MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
+	}
+
+	abstract public function RenderContent(WebPage $oPage, $aExtraParams = array());
+
+	protected function OnInsert()
+	{
+		$this->Set('user_id', UserRights::GetUserId());
+	}
+
+	public function StartRenameDialog($oPage)
+	{
+		$oPage->add('<div id="shortcut_rename_dlg">');
+
+		$oForm = new DesignerForm();
+		$sDefault = $this->Get('name');
+		$oField = new DesignerTextField('name', Dict::S('Class:Shortcut/Attribute:name'), $sDefault);
+		$oField->SetMandatory(true);
+		$oForm->AddField($oField);
+		$oForm->Render($oPage);
+		$oPage->add('</div>');
+		
+		$sDialogTitle = Dict::S('UI:ShortcutRenameDlg:Title');
+		$sOkButtonLabel = Dict::S('UI:Button:Ok');
+		$sCancelButtonLabel = Dict::S('UI:Button:Cancel');
+		$iShortcut = $this->GetKey();
+		
+		$oPage->add_ready_script(
+<<<EOF
+function ShortcutRenameOK() 
+{
+	var oForm = $(this).find('form');
+	var sFormId = oForm.attr('id');
+	var oParams = null;
+	var aErrors = ValidateForm(sFormId, false);
+	if (aErrors.length == 0)
+	{
+		oParams = ReadFormParams(sFormId);
+	}
+	oParams.operation = 'shortcut_rename_go';
+	oParams.id = $iShortcut;
+	var me = $(this);
+	$.post(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', oParams, function(data) {
+		me.dialog( "close" );
+		me.remove();
+		$('body').append(data);
+	});
+}
+
+$('#shortcut_rename_dlg form').bind('submit', function() { return false; });
+
+$('#shortcut_rename_dlg').dialog({
+	width: 400,
+	modal: true,
+	title: '$sDialogTitle',
+	buttons: [
+	{ text: "$sOkButtonLabel", click: ShortcutRenameOK},
+	{ text: "$sCancelButtonLabel", click: function() {
+		$(this).dialog( "close" ); $(this).remove();
+	} },
+	],
+	close: function() { $(this).remove(); }
+});
+EOF
+		);
+	}
+
+	// Minimual implementation of iDisplay: to make the shortcut be listable
+	//
+	public static function MapContextParam($sContextParam)
+	{
+		return (($sContextParam == 'menu') ? null : $sContextParam);
+	}
+
+	public function GetHilightClass()
+	{
+		return HILIGHT_CLASS_NONE;
+	}
+
+	public static function GetUIPage()
+	{
+		return '';
+	}
+
+	function DisplayDetails(WebPage $oPage, $bEditMode = false)
+	{
+	}
+
+	function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = array())
+	{
+		return array();
+	}
+	// End of the minimal implementation of iDisplay
+}
+
+class ShortcutOQL extends Shortcut
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "gui,view_in_gui",
+			"key_type" => "autoincrement",
+			"name_attcode" => "name",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_shortcut_oql",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+			"display_template" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_InheritAttributes();
+		MetaModel::Init_AddAttribute(new AttributeOQL("oql", array("allowed_values"=>null, "sql"=>"oql", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeEnum("auto_reload", array("allowed_values"=>new ValueSetEnum('none,custom'), "sql"=>"auto_reload", "default_value"=>"none", "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeInteger("auto_reload_sec", array("allowed_values"=>null, "sql"=>"auto_reload_sec", "default_value"=>60, "is_null_allowed"=>false, "depends_on"=>array())));
+
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('name', 'context', 'oql')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('name')); // Attributes to be displayed for a list
+		// Search criteria
+//		MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form
+//		MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
+	}
+
+	public function RenderContent(WebPage $oPage, $aExtraParams = array())
+	{
+		$oPage->set_title($this->Get('name'));
+
+		switch($this->Get('auto_reload'))
+		{
+		case 'custom':
+			$iRate = (int)$this->Get('auto_reload_sec');
+			if ($iRate > 0)
+			{
+				// Must a string otherwise it can be evaluated to 'true' and defaults to "standard" refresh rate!
+				$aExtraParams['auto_reload'] = (string)$iRate;
+			}
+			break;
+
+		default:
+		case 'none':
+		}
+
+		$bSearchPane = true;
+		$bSearchOpen = false;
+		try
+		{
+			OQLMenuNode::RenderOQLSearch($this->Get('oql'), $this->Get('name'), 'shortcut_'.$this->GetKey(), $bSearchPane, $bSearchOpen, $oPage, $aExtraParams);
+		}
+		catch (Exception $e)
+		{
+			throw new Exception("The OQL shortcut '".$this->Get('name')."' (id: ".$this->GetKey().") could not be displayed: ".$e->getMessage());
+		}
+			
+	}
+
+	public function CloneTableSettings($sTableSettings)
+	{
+		$aTableSettings = json_decode($sTableSettings, true);
+
+		$oFilter = DBObjectSearch::FromOQL($this->Get('oql'));
+		$oCustomSettings = new DataTableSettings($oFilter->GetSelectedClasses());
+		$oCustomSettings->iDefaultPageSize = $aTableSettings['iPageSize'];
+		$oCustomSettings->aColumns = $aTableSettings['oColumns'];
+		$oCustomSettings->Save('shortcut_'.$this->GetKey());
+	}
+
+	public static function GetCreationForm($sOQL = null, $sTableSettings = null)
+	{
+		$oForm = new DesignerForm();
+
+		// Find a unique default name
+		// -> The class of the query + an index if necessary
+		if ($sOQL == null)
+		{
+			$sDefault = '';
+		}
+		else
+		{
+			$oBMSearch = new DBObjectSearch('Shortcut');
+			$oBMSearch->AddCondition('user_id', UserRights::GetUserId(), '=');
+			$oBMSet = new DBObjectSet($oBMSearch);
+			$aNames = $oBMSet->GetColumnAsArray('name');
+	 		$oSearch = DBObjectSearch::FromOQL($sOQL);
+			$sDefault = utils::MakeUniqueName($oSearch->GetClass(), $aNames);
+		}
+
+		$oField = new DesignerTextField('name', Dict::S('Class:Shortcut/Attribute:name'), $sDefault);
+		$oField->SetMandatory(true);
+		$oForm->AddField($oField);
+
+		/*
+		$oField = new DesignerComboField('auto_reload', Dict::S('Class:ShortcutOQL/Attribute:auto_reload'), 'none');
+		$oAttDef = MetaModel::GetAttributeDef(__class__, 'auto_reload');
+		$oField->SetAllowedValues($oAttDef->GetAllowedValues());
+		$oField->SetMandatory(true);
+		$oForm->AddField($oField);
+		*/
+		$oField = new DesignerBooleanField('auto_reload', Dict::S('Class:ShortcutOQL/Attribute:auto_reload'), false);
+		$oForm->AddField($oField);
+
+		$oField = new DesignerTextField('auto_reload_sec', Dict::S('Class:ShortcutOQL/Attribute:auto_reload_sec'), MetaModel::GetConfig()->GetStandardReloadInterval());
+		$oField->SetValidationPattern('^$|^0*([5-9]|[1-9][0-9]+)$'); // Can be empty, or a number > 4
+		$oField->SetMandatory(false);
+		$oForm->AddField($oField);
+
+		$oField = new DesignerHiddenField('oql', '', $sOQL);
+		$oForm->AddField($oField);
+
+		$oField = new DesignerHiddenField('table_settings', '', $sTableSettings);
+		$oForm->AddField($oField);
+
+		return $oForm;
+	}
+
+	public static function GetCreationDlgFromOQL($oPage, $sOQL, $sTableSettings)
+	{
+		$oPage->add('<div id="shortcut_creation_dlg">');
+
+		$oForm = self::GetCreationForm($sOQL, $sTableSettings);
+
+		$oForm->Render($oPage);
+		$oPage->add('</div>');
+		
+		$sDialogTitle = Dict::S('UI:ShortcutListDlg:Title');
+		$sOkButtonLabel = Dict::S('UI:Button:Ok');
+		$sCancelButtonLabel = Dict::S('UI:Button:Cancel');
+		
+		$oAppContext = new ApplicationContext();
+		$sContext = $oAppContext->GetForLink();
+
+		$sRateTitle = addslashes(Dict::S('Class:ShortcutOQL/Attribute:auto_reload_sec+'));
+
+		$oPage->add_ready_script(
+<<<EOF
+
+// Note: the title gets deleted by the validation mechanism
+$("#attr_auto_reload_sec").tooltip({items: 'input', content: '$sRateTitle'});
+$("#attr_auto_reload_sec").prop('disabled', !$('#attr_auto_reload').is(':checked'));
+
+$('#attr_auto_reload').change( function(ev) {
+	$("#attr_auto_reload_sec").prop('disabled', !$(this).is(':checked'));
+} );
+
+function ShortcutCreationOK() 
+{
+	var oForm = $('#shortcut_creation_dlg form');
+	var sFormId = oForm.attr('id');
+	var oParams = null;
+	var aErrors = ValidateForm(sFormId, false);
+	if (aErrors.length == 0)
+	{
+		oParams = ReadFormParams(sFormId);
+	}
+	oParams.operation = 'shortcut_list_create';
+	var me = $('#shortcut_creation_dlg');
+	$.post(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php?$sContext', oParams, function(data) {
+		me.dialog( "close" );
+		me.remove();
+		$('body').append(data);
+	});
+}
+
+$('#shortcut_creation_dlg form').bind('submit', function() { ShortcutCreationOK(); return false; });
+
+$('#shortcut_creation_dlg').dialog({
+	width: 400,
+	modal: true,
+	title: '$sDialogTitle',
+	buttons: [
+	{ text: "$sOkButtonLabel", click: ShortcutCreationOK },
+	{ text: "$sCancelButtonLabel", click: function() {
+		$(this).dialog( "close" ); $(this).remove();
+	} },
+	],
+	close: function() { $(this).remove(); }
+});
+EOF
+		);
+	}
+}
+
+?>

application/sqlblock.class.inc.php

@@ -1,27 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * SqlBlock - display tables or charts, given an SQL query - use cautiously!
  *  
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -40,13 +40,15 @@ class SqlBlock
 	protected $m_aColumns;
 	protected $m_sTitle;
 	protected $m_sType;
+	protected $m_aParams;
 	                            
-	public function __construct($sQuery, $aColumns, $sTitle, $sType)
+	public function __construct($sQuery, $aColumns, $sTitle, $sType, $aParams = array())
 	{
 		$this->m_sQuery = $sQuery;
 		$this->m_aColumns = $aColumns;
 		$this->m_sTitle = $sTitle;
 		$this->m_sType = $sType;
+		$this->m_aParams = $aParams;
 	}
 	
 	/**
@@ -54,9 +56,14 @@ class SqlBlock
 	/*
 	 *
 	 *		<sqlblock>
-	 *			<sql>SELECT date_format(start_date, '%d') AS Date, count(*) AS Count FROM ticket WHERE DATE_SUB(NOW(), INTERVAL 15 DAY) &lt; start_date AND finalclass = 'UserIssue' GROUP BY date_format(start_date, '%d')</sql>
+	 *			<sql>SELECT date_format(start_date, '%d') AS Date, count(*) AS Count FROM ticket WHERE DATE_SUB(NOW(), INTERVAL 15 DAY) &lt; start_date AND finalclass = 'UserIssue' GROUP BY date_format(start_date, '%d') AND $CONDITION(param1, ticket.org_id)$</sql>
 	 *			<type>table</type>
 	 *			<title>UserRequest:Overview-Title</title>
+	 *			<parameter>
+	 * 				<name>param1</name>
+	 * 				<type>context</type>
+	 * 				<mapping>org_id</mapping>
+	 * 			</parameter>
 	 *			<column>
 	 *				<name>Date</name>
 	 *				<label>UserRequest:Overview-Date</label>
@@ -73,6 +80,11 @@ class SqlBlock
 	 * - sql: a (My)SQL query. Do not forget to use html entities (e.g. &lt; for <)
 	 * - type: table (default), bars or pie. If bars or pie is selected only the two first columns are taken into account.
 	 * - title: optional title, typed in clear or given as a dictionnary entry
+	 * - parameter: specifies how to map the context parameters (namely org_id) to a given named parameter in the query.
+	 *   The expression $CONDITION(<param_name>, <sql_column_name>) will be automatically replaced by:
+	 *   either the string "1" if there is no restriction on the organisation in iTop
+	 *   or the string "(<sql_column_name>=<value_of_org_id>)" if there is a limitation to one organizations in iTop
+	 *   or the string "(<sql_column_name> IN (<values_of_org_id>))" if there is a limitation to a given set of organizations in iTop
 	 * - column: specification of a column (not displayed if omitted)
 	 * - column / name: name of the column in the SQL query (use aliases)
 	 * - column / label: label, typed in clear or given as a dictionnary entry
@@ -144,8 +156,96 @@ class SqlBlock
 				}
 			}
 		}
-
-		return new SqlBlock($sQuery, $aColumns, $sTitle, $sType);		
+		$aParams = array();
+		if (isset($oXml->parameter))
+		{
+			foreach ($oXml->parameter AS $oParamData)
+			{
+				if (!isset($oParamData->name))
+				{
+					throw new Exception("Missing tag 'name' for parameter in sqlblock/column");
+				}
+				$sName = (string) $oParamData->name;
+				if (strlen($sName) == 0)
+				{
+					throw new Exception("Empty tag 'name' for parameter in sqlblock/column");
+				}
+				if (!isset($oParamData->mapping))
+				{
+					throw new Exception("Missing tag 'mapping' for parameter in sqlblock/column");
+				}
+				$sMapping = (string) $oParamData->mapping;
+				if (strlen($sMapping) == 0)
+				{
+					throw new Exception("Empty tag 'mapping' for parameter in sqlblock/column");
+				}
+				
+				if (isset($oParamData->type))
+				{
+					$sParamType = $oParamData->type;
+				}
+				else
+				{
+					$sParamType = 'context';
+				}
+				$aParams[$sName] = array('mapping' => $sMapping, 'type' => $sParamType);
+			}
+		}
+		
+		return new SqlBlock($sQuery, $aColumns, $sTitle, $sType, $aParams);		
+	}
+	
+	/**
+	 * Applies the defined parameters into the SQL query
+	 * @return string the SQL query to execute
+	 */
+	public function BuildQuery()
+	{
+		$oAppContext = new ApplicationContext();
+		$sQuery = $this->m_sQuery;
+		$sQuery = str_replace('$DB_PREFIX$', MetaModel::GetConfig()->GetDBSubname(), $sQuery); // put the tables DB prefix (if any)
+		foreach($this->m_aParams as $sName => $aParam)
+		{
+			if ($aParam['type'] == 'context')
+			{
+				$sSearchPattern = '/\$CONDITION\('.$sName.',([^\)]+)\)\$/';
+				$value = $oAppContext->GetCurrentValue($aParam['mapping']);
+				if (empty($value))
+				{
+					$sSQLExpr = '(1)';
+				}
+				else
+				{
+					// Special case for managing the hierarchy of organizations
+					if (($aParam['mapping'] == 'org_id') && ( MetaModel::IsValidClass('Organization')))
+					{
+						$sHierarchicalKeyCode = MetaModel::IsHierarchicalClass('Organization');
+						if ($sHierarchicalKeyCode != false)
+						{
+							// organizations are in hierarchy... gather all the orgs below the given one...
+							$sOQL = "SELECT Organization AS node JOIN Organization AS root ON node.$sHierarchicalKeyCode BELOW root.id WHERE root.id = :value";
+							$oSet = new DBObjectSet(DBObjectSearch::FromOQL($sOQL), array(), array('value' => $value));
+							$aOrgIds = array();
+							while($oOrg = $oSet->Fetch())
+							{
+								$aOrgIds[]= $oOrg->GetKey();
+							}
+							$sSQLExpr = '($1 IN('.implode(',', $aOrgIds).'))';
+						}
+						else
+						{
+							$sSQLExpr = '($1 = '.CMDBSource::Quote($value).')';
+						}
+					}
+					else
+					{
+						$sSQLExpr = '($1 = '.CMDBSource::Quote($value).')';
+					}
+				}
+				$sQuery = preg_replace($sSearchPattern, $sSQLExpr, $sQuery);
+			}
+		}
+		return $sQuery;
 	}
 	
 	public function RenderContent(WebPage $oPage, $aExtraParams = array())
@@ -160,7 +260,8 @@ class SqlBlock
 		}
 //		$oPage->add($this->GetRenderContent($oPage, $aExtraParams, $sId));
 
-		$res = CMDBSource::Query($this->m_sQuery);
+		$sQuery = $this->BuildQuery();
+		$res = CMDBSource::Query($sQuery);
 		$aQueryCols = CMDBSource::GetColumns($res);
 
 		// Prepare column definitions (check + give default values)

application/startup.inc.php

@@ -1,31 +1,49 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * File to include to initialize the datamodel in memory
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/core/cmdbobject.class.inc.php');
 require_once(APPROOT.'/application/utils.inc.php');
-
-MetaModel::Startup(ITOP_CONFIG_FILE);
+session_name('itop-'.md5(APPROOT));
+session_start();
+if (isset($_REQUEST['switch_env']))
+{
+	$sEnv = $_REQUEST['switch_env'];
+	$_SESSION['itop_env'] = $sEnv;
+	// TODO: reset the credentials as well ??
+}
+else if (isset($_SESSION['itop_env']))
+{
+	$sEnv = $_SESSION['itop_env'];
+}
+else
+{
+	$sEnv = ITOP_DEFAULT_ENV;
+	$_SESSION['itop_env'] = ITOP_DEFAULT_ENV;
+}
+$sConfigFile = APPCONF.$sEnv.'/'.ITOP_CONFIG_FILE;
+MetaModel::Startup($sConfigFile);
 
 ?>

application/template.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Class DisplayTemplate
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/displayblock.class.inc.php');
@@ -282,9 +283,29 @@ class ObjectDetailsTemplate extends DisplayTemplate
 		$sStateAttCode = MetaModel :: GetStateAttributeCode(get_class($this->m_oObj));
 		$aTemplateFields = array();
 		preg_match_all('/\\$this->([a-z0-9_]+)\\$/', $this->m_sTemplate, $aMatches);
-		$aTemplateFields = $aMatches[1];
+		foreach ($aMatches[1] as $sAttCode)
+		{
+			if (MetaModel::IsValidAttCode(get_class($this->m_oObj), $sAttCode))
+			{
+				$aTemplateFields[] = $sAttCode;
+			}
+			else
+			{
+				$aParams['this->'.$sAttCode] = "<!--Unknown attribute: $sAttCode-->";					
+			}
+		}
 		preg_match_all('/\\$this->field\\(([a-z0-9_]+)\\)\\$/', $this->m_sTemplate, $aMatches);
-		$aTemplateFields = array_merge($aTemplateFields, $aMatches[1]);
+		foreach ($aMatches[1] as $sAttCode)
+		{
+			if (MetaModel::IsValidAttCode(get_class($this->m_oObj), $sAttCode))
+			{
+				$aTemplateFields[] = $sAttCode;
+			}
+			else
+			{
+				$aParams['this->field('.$sAttCode.')'] = "<!--Unknown attribute: $sAttCode-->";
+			}
+		}
 		$aFieldsComments = (isset($aParams['fieldsComments'])) ? $aParams['fieldsComments'] : array();
 		$aFieldsMap = array();
 

application/templates/notifications_menu.html

@@ -1,20 +0,0 @@
-<div class="page_header" style="padding:0.5em;">
-<h1><itopstring>UI:NotificationsMenu:Title</itopstring></h1>
-</div>
-<itoptoggle name="UI:NotificationsMenu:Help" open="true">
-<div style="padding: 1em; font-size:10pt;background:#E8F3CF;margin-top: 0.25em;">
-<img src="../images/bell.png" style="margin-top: -60px; margin-right: 10px; float: right;">
-<itopstring>UI:NotificationsMenu:HelpContent</itopstring>
-</div>
-</itoptoggle>
-<p>&nbsp;</p>
-<itoptabs>
-	<itoptab name="UI:NotificationsMenu:Triggers">
-		<h2><itopstring>UI:NotificationsMenu:AvailableTriggers</itopstring></h2>
-		<itopblock BlockClass="DisplayBlock" type="list" asynchronous="false" encoding="text/oql">SELECT Trigger</itopblock>
-	</itoptab>
-	<itoptab name="UI:NotificationsMenu:Actions">
-		<h2><itopstring>UI:NotificationsMenu:AvailableActions</itopstring></h2>
-		<itopblock BlockClass="DisplayBlock" type="list" asynchronous="false" encoding="text/oql">SELECT ActionEmail</itopblock>
-	</itoptab>
-</itoptabs>

application/templates/welcome_popup.html

@@ -1,15 +1,6 @@
 <div style="width:100%;background: #fff url(../images/welcome.jpg) top left no-repeat;">
 <style>
-.dashboard {
-vertical-align:top;
-width:50%;
-border:0px solid #000;
-background-color:#F9F9F1;
-padding:10px;
-text-align:left;
-font-size:10pt;
-}
-.dashboard2 {
+.welcome_popup_cell {
 vertical-align:top;
 width:50%;
 border:0px solid #000;
@@ -17,15 +8,7 @@ border:0px solid #000;
 padding:5px;
 text-align:left;
 }
-
-td.dashboard li {
-margin-top: 5px;
-display: list-item;
-}
-td div.display_block {
-padding:0;
-}
-tr td.dashboard2,  tr td.dashboard2 ul {
+tr td.welcome_popup_cell,  tr td.welcome_popup_cell ul {
 font-size:10pt;
 }
 </style>
@@ -35,10 +18,10 @@ font-size:10pt;
 <p></p>
 <table border="0" style="padding:10px;border-spacing: 10px;width:100%">
 <tr>
-<td class="dashboard2">
+<td class="welcome_popup_cell">
 <itopstring>UI:WelcomeMenu:LeftBlock</itopstring>
 </td>
-<td class="dashboard2">
+<td class="welcome_popup_cell">
 <itopstring>UI:WelcomeMenu:RightBlock</itopstring>
 </td>
 </tr>

application/transaction.class.inc.php

@@ -1,24 +1,29 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * This class records the pending "transactions" corresponding to forms that have not been
  * submitted yet, in order to prevent double submissions. When created a transaction remains valid
  * until the user's session expires
+ *  
  * @package     iTop
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 

application/ui.extkeywidget.class.inc.php

@@ -1,18 +1,20 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 /**
  * Class UIExtKeyWidget
  * UI wdiget for displaying and editing external keys when
@@ -52,10 +54,8 @@
  * | |   +--------+    +-----+                    | |
  * | +--------------------------------------------+ |
  * +------------------------------------------------+
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/webpage.class.inc.php');
@@ -65,6 +65,8 @@ class UIExtKeyWidget
 {
 	protected $iId;
 	protected $sTargetClass;
+	protected $sAttCode;
+	protected $bSearchMode;
 	
 	//public function __construct($sAttCode, $sClass, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sNameSuffix = '', $sFieldPrefix = '', $sFormPrefix = '')
 	static public function DisplayFromAttCode($oPage, $sAttCode, $sClass, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName = '', $sFormPrefix = '', $aArgs, $bSearchMode = false)
@@ -81,44 +83,59 @@ class UIExtKeyWidget
 		{
 			$sDisplayStyle = 'select'; // In search mode, always use a drop-down list
 		}
-		$oWidget = new UIExtKeyWidget($sTargetClass, $iInputId);
-		return $oWidget->Display($oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName, $sFormPrefix, $aArgs, $bSearchMode, $sDisplayStyle);
+		$oWidget = new UIExtKeyWidget($sTargetClass, $iInputId, $sAttCode, $bSearchMode);
+		return $oWidget->Display($oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName, $sFormPrefix, $aArgs, null, $sDisplayStyle);
 	}
 
-	public function __construct($sTargetClass, $iInputId)
+	public function __construct($sTargetClass, $iInputId, $sAttCode = '', $bSearchMode = false)
 	{
 		$this->sTargetClass = $sTargetClass;
 		$this->iId = $iInputId;
+		$this->sAttCode = $sAttCode;
+		$this->bSearchMode = $bSearchMode;
 	}
 	
 	/**
-	 * Get the HTML fragment corresponding to the linkset editing widget
+	 * Get the HTML fragment corresponding to the ext key editing widget
 	 * @param WebPage $oP The web page used for all the output
 	 * @param Hash $aArgs Extra context arguments
 	 * @return string The HTML fragment to be inserted into the page
 	 */
-	public function Display(WebPage $oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName, $sFormPrefix = '', $aArgs = array(), $bSearchMode = false, $sDisplayStyle = 'select')
+	public function Display(WebPage $oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName, $sFormPrefix = '', $aArgs = array(), $bSearchMode = null, $sDisplayStyle = 'select', $bSearchMultiple = true)
 	{
+		if (!is_null($bSearchMode))
+		{
+			$this->bSearchMode = $bSearchMode;
+		}
 		$sTitle = addslashes($sTitle);	
 		$oPage->add_linked_script('../js/extkeywidget.js');
 		$oPage->add_linked_script('../js/forms-json-utils.js');
 		
-		$bCreate = (!$bSearchMode) && (!MetaModel::IsAbstract($this->sTargetClass)) && (UserRights::IsActionAllowed($this->sTargetClass, UR_ACTION_BULK_MODIFY) && $bAllowTargetCreation);
+		$bCreate = (!$this->bSearchMode) && (!MetaModel::IsAbstract($this->sTargetClass)) && (UserRights::IsActionAllowed($this->sTargetClass, UR_ACTION_BULK_MODIFY) && $bAllowTargetCreation);
 		$bExtensions = true;
 		$sMessage = Dict::S('UI:Message:EmptyList:UseSearchForm');
-		$sAttrFieldPrefix = ($bSearchMode) ? '' : 'attr_';
+		$sAttrFieldPrefix = ($this->bSearchMode) ? '' : 'attr_';
 
 		$sHTMLValue = "<span style=\"white-space:nowrap\">"; // no wrap
 		$sFilter = addslashes($oAllowedValues->GetFilter()->ToOQL());
-		if($bSearchMode)
+		if($this->bSearchMode)
 		{
 			$sWizHelper = 'null';
 			$sWizHelperJSON = "''";
+			$sJSSearchMode = 'true';
 		} 
 		else
 		{
-			$sWizHelper = 'oWizardHelper'.$sFormPrefix;
-			$sWizHelperJSON = $sWizHelper.'.ToJSON()';
+			if (isset($aArgs['wizHelper']))
+			{
+				$sWizHelper = $aArgs['wizHelper'];
+			}
+			else
+			{
+				$sWizHelper = 'oWizardHelper'.$sFormPrefix;
+			}
+			$sWizHelperJSON = $sWizHelper.'.UpdateWizardToJSON()';
+			$sJSSearchMode = 'false';
 		}
 		if (is_null($oAllowedValues))
 		{
@@ -152,14 +169,22 @@ class UIExtKeyWidget
 				
 				$sHelpText = ''; //$this->oAttDef->GetHelpOnEdition();
 				
-				$sHTMLValue = "<select title=\"$sHelpText\" name=\"{$sAttrFieldPrefix}{$sFieldName}\" id=\"$this->iId\">\n";
-				if ($bSearchMode)
+				if ($this->bSearchMode)
 				{
-					$sDisplayValue = isset($aArgs['sDefaultValue']) ? $aArgs['sDefaultValue'] : Dict::S('UI:SearchValue:Any');
-					$sHTMLValue .= "<option value=\"\">$sDisplayValue</option>\n";			
+					if ($bSearchMultiple)
+					{
+						$sHTMLValue = "<select class=\"multiselect\" multiple title=\"$sHelpText\" name=\"{$sAttrFieldPrefix}{$sFieldName}[]\" id=\"$this->iId\">\n";
+					}
+					else
+					{
+						$sHTMLValue = "<select title=\"$sHelpText\" name=\"{$sAttrFieldPrefix}{$sFieldName}\" id=\"$this->iId\">\n";
+						$sDisplayValue = isset($aArgs['sDefaultValue']) ? $aArgs['sDefaultValue'] : Dict::S('UI:SearchValue:Any');
+						$sHTMLValue .= "<option value=\"\">$sDisplayValue</option>\n";
+					}
 				}
 				else
 				{
+					$sHTMLValue = "<select title=\"$sHelpText\" name=\"{$sAttrFieldPrefix}{$sFieldName}\" id=\"$this->iId\">\n";
 					$sHTMLValue .= "<option value=\"\">".Dict::S('UI:SelectOne')."</option>\n";
 				}
 				$oAllowedValues->Rewind();
@@ -175,14 +200,27 @@ class UIExtKeyWidget
 					}
 					else
 					{
-						$sSelected = ($value == $key) ? ' selected' : '';
+						$sSelected = (is_array($value) && in_array($key, $value)) || ($value == $key) ? ' selected' : '';
 					}
 					$sHTMLValue .= "<option value=\"$key\"$sSelected>$display_value</option>\n";
 				}
 				$sHTMLValue .= "</select>\n";
+				if (($this->bSearchMode) && $bSearchMultiple)
+				{
+					$aOptions = array(
+						'header' => true,
+						'checkAllText' => Dict::S('UI:SearchValue:CheckAll'),
+						'uncheckAllText' => Dict::S('UI:SearchValue:UncheckAll'),
+						'noneSelectedText' => Dict::S('UI:SearchValue:Any'),
+						'selectedText' => Dict::S('UI:SearchValue:NbSelected'),
+						'selectedList' => 1,
+					);
+					$sJSOptions = json_encode($aOptions);
+					$oPage->add_ready_script("$('.multiselect').multiselect($sJSOptions);");
+				}
 				$oPage->add_ready_script(
 <<<EOF
-		oACWidget_{$this->iId} = new ExtKeyWidget('{$this->iId}', '{$this->sTargetClass}', '$sFilter', '$sTitle', true, $sWizHelper);
+		oACWidget_{$this->iId} = new ExtKeyWidget('{$this->iId}', '{$this->sTargetClass}', '$sFilter', '$sTitle', true, $sWizHelper, '{$this->sAttCode}', $sJSSearchMode);
 		oACWidget_{$this->iId}.emptyHtml = "<div style=\"background: #fff; border:0; text-align:center; vertical-align:middle;\"><p>$sMessage</p></div>";
 		$('#$this->iId').bind('update', function() { oACWidget_{$this->iId}.Update(); } );
 		$('#$this->iId').bind('change', function() { $(this).trigger('extkeychange') } );
@@ -196,6 +234,15 @@ EOF
 			// Too many choices, use an autocomplete
 			$sSelectMode = 'false';
 		
+			// Check that the given value is allowed
+			$oSearch = $oAllowedValues->GetFilter();
+			$oSearch->AddCondition('id', $value);
+			$oSet = new DBObjectSet($oSearch);
+			if ($oSet->Count() == 0)
+			{
+				$value = null;
+			}
+
 			if (is_null($value) || ($value == 0)) // Null values are displayed as ''
 			{
 				$sDisplayValue = isset($aArgs['sDefaultValue']) ? $aArgs['sDefaultValue'] : '';
@@ -213,13 +260,14 @@ EOF
 	
 			// another hidden input to store & pass the object's Id
 			$sHTMLValue .= "<input type=\"hidden\" id=\"$this->iId\" name=\"{$sAttrFieldPrefix}{$sFieldName}\" value=\"$value\" />\n";
-	
+
+			$JSSearchMode = $this->bSearchMode ? 'true' : 'false';	
 			// Scripts to start the autocomplete and bind some events to it
 			$oPage->add_ready_script(
 <<<EOF
-		oACWidget_{$this->iId} = new ExtKeyWidget('{$this->iId}', '{$this->sTargetClass}', '$sFilter', '$sTitle', false, $sWizHelper);
+		oACWidget_{$this->iId} = new ExtKeyWidget('{$this->iId}', '{$this->sTargetClass}', '$sFilter', '$sTitle', false, $sWizHelper, '{$this->sAttCode}', $sJSSearchMode);
 		oACWidget_{$this->iId}.emptyHtml = "<div style=\"background: #fff; border:0; text-align:center; vertical-align:middle;\"><p>$sMessage</p></div>";
-		$('#label_$this->iId').autocomplete(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', { scroll:true, minChars:{$iMinChars}, autoFill:false, matchContains:true, mustMatch: true, keyHolder:'#{$this->iId}', extraParams:{operation:'ac_extkey', sTargetClass:'{$this->sTargetClass}',sFilter:'$sFilter', json: function() { return $sWizHelperJSON; } }});
+		$('#label_$this->iId').autocomplete(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', { scroll:true, minChars:{$iMinChars}, autoFill:false, matchContains:true, mustMatch: true, keyHolder:'#{$this->iId}', extraParams:{operation:'ac_extkey', sTargetClass:'{$this->sTargetClass}',sFilter:'$sFilter',bSearchMode:$JSSearchMode, json: function() { return $sWizHelperJSON; } }});
 		$('#label_$this->iId').keyup(function() { if ($(this).val() == '') { $('#$this->iId').val(''); } } ); // Useful for search forms: empty value in the "label", means no value, immediatly !
 		$('#label_$this->iId').result( function(event, data, formatted) { OnAutoComplete('{$this->iId}', event, data, formatted); } );
 		$('#$this->iId').bind('update', function() { oACWidget_{$this->iId}.Update(); } );
@@ -262,13 +310,25 @@ EOF
 		return $sHTMLValue;
 	}
 	
-	public function GetSearchDialog(WebPage $oPage, $sTitle)
+	public function GetSearchDialog(WebPage $oPage, $sTitle, $oCurrObject = null)
 	{
 		$sHTML = '<div class="wizContainer" style="vertical-align:top;"><div id="dc_'.$this->iId.'">';
 
-		$oFilter = new DBObjectSearch($this->sTargetClass);
-		$oSet = new CMDBObjectSet($oFilter);
-		$oBlock = new DisplayBlock($oFilter, 'search', false);
+		if ( ($oCurrObject != null) && ($this->sAttCode != ''))
+		{
+			$oAttDef = MetaModel::GetAttributeDef(get_class($oCurrObject), $this->sAttCode);
+			$aArgs = array('this' => $oCurrObject);
+			$aParams = array('query_params' => $aArgs);
+			$oSet = $oAttDef->GetAllowedValuesAsObjectSet($aArgs);
+			$oFilter = $oSet->GetFilter();
+		}
+		else
+		{
+			$aParams = array();
+			$oFilter = new DBObjectSearch($this->sTargetClass);
+		}
+		$oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
+		$oBlock = new DisplayBlock($oFilter, 'search', false, $aParams);
 		$sHTML .= $oBlock->GetDisplay($oPage, $this->iId, array('open' => true, 'currentId' => $this->iId));
 		$sHTML .= "<form id=\"fr_{$this->iId}\" OnSubmit=\"return oACWidget_{$this->iId}.DoOk();\">\n";
 		$sHTML .= "<div id=\"dr_{$this->iId}\" style=\"vertical-align:top;background: #fff;height:100%;overflow:auto;padding:0;border:0;\">\n";
@@ -303,21 +363,15 @@ EOF
 		{
 			throw new Exception('Implementation: null value for allowed values definition');
 		}
-		try
+		
+		$oFilter = DBObjectSearch::FromOQL($sFilter);
+		if (strlen($sRemoteClass) > 0)
 		{
-			$oFilter = DBObjectSearch::FromOQL($sFilter);
-			$oBlock = new DisplayBlock($oFilter, 'list', false);
-			$oBlock->Display($oP, $this->iId.'_results', array('this' => $oObj, 'cssCount'=> '#count_'.$this->iId, 'menu' => false, 'selection_mode' => true, 'selection_type' => 'single')); // Don't display the 'Actions' menu on the results
-		}
-		catch(MissingQueryArgument $e)
-		{
-			// When used in a search form the $this parameter may be missing, in this case return all possible values...
-			// TODO check if we can improve this behavior...
-			$sOQL = 'SELECT '.$sRemoteClass;
-			$oFilter = DBObjectSearch::FromOQL($sOQL);
-			$oBlock = new DisplayBlock($oFilter, 'list', false);
-			$oBlock->Display($oP, $this->iId.'_results', array('cssCount'=> '#count_'.$this->iId, 'menu' => false, 'selection_mode' => true, 'selection_type' => 'single')); // Don't display the 'Actions' menu on the results
+			$oFilter->ChangeClass($sRemoteClass);
 		}
+		$oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
+		$oBlock = new DisplayBlock($oFilter, 'list', false, array('query_params' => array('this' => $oObj)));
+		$oBlock->Display($oP, $this->iId.'_results', array('this' => $oObj, 'cssCount'=> '#count_'.$this->iId, 'menu' => false, 'selection_mode' => true, 'selection_type' => 'single', 'table_id' => 'select_'.$this->sAttCode)); // Don't display the 'Actions' menu on the results
 	}
 	
 	/**
@@ -334,6 +388,7 @@ EOF
 			throw new Exception('Implementation: null value for allowed values definition');
 		}
 		$oValuesSet = new ValueSetObjects($sFilter, 'friendlyname'); // Bypass GetName() to avoid the encoding by htmlentities
+		$oValuesSet->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
 		$aValues = $oValuesSet->GetValues(array('this' => $oObj), $sContains);
 		foreach($aValues as $sKey => $sFriendlyName)
 		{
@@ -346,14 +401,24 @@ EOF
 	 */
 	public function GetObjectName($iObjId)
 	{
-		$oObj = MetaModel::GetObject($this->sTargetClass, $iObjId);
-		return $oObj->GetName();
+		$aModifierProps = array();
+		$aModifierProps['UserRightsGetSelectFilter']['bSearchMode'] = $this->bSearchMode;
+
+		$oObj = MetaModel::GetObject($this->sTargetClass, $iObjId, false, false, $aModifierProps);
+		if ($oObj)
+		{
+			return $oObj->GetName();
+		}
+		else
+		{
+			return '';
+		}
 	}
 	
 	/**
 	 * Get the form to create a new object of the 'target' class
 	 */
-	public function GetObjectCreationForm(WebPage $oPage)
+	public function GetObjectCreationForm(WebPage $oPage, $oCurrObject)
 	{
 		// Set all the default values in an object and clone this "default" object
 		$oNewObj = MetaModel::NewObject($this->sTargetClass);
@@ -362,16 +427,33 @@ EOF
 		$oAppContext = new ApplicationContext();
 		$oAppContext->InitObjectFromContext($oNewObj);
 
-		// 2nd - set values from the page argument 'default'
+		// 2nd set the default values from the constraint on the external key... if any
+		if ( ($oCurrObject != null) && ($this->sAttCode != ''))
+		{
+			$oAttDef = MetaModel::GetAttributeDef(get_class($oCurrObject), $this->sAttCode);
+			$aParams = array('this' => $oCurrObject);
+			$oSet = $oAttDef->GetAllowedValuesAsObjectSet($aParams);
+			$aConsts = $oSet->ListConstantFields();
+			$sClassAlias = $oSet->GetFilter()->GetClassAlias();
+			if (isset($aConsts[$sClassAlias]))
+			{
+				foreach($aConsts[$sClassAlias] as $sAttCode => $value)
+				{
+					$oNewObj->Set($sAttCode, $value);
+				}
+			}
+		}
+		
+		// 3rd - set values from the page argument 'default'
 		$oNewObj->UpdateObjectFromArg('default');
 
-		$sDialogTitle = addslashes($this->sTitle);
+		$sDialogTitle = '';
 		$oPage->add('<div id="ac_create_'.$this->iId.'"><div class="wizContainer" style="vertical-align:top;"><div id="dcr_'.$this->iId.'">');
 		$oPage->add("<h1>".MetaModel::GetClassIcon($this->sTargetClass)."&nbsp;".Dict::Format('UI:CreationTitle_Class', MetaModel::GetName($this->sTargetClass))."</h1>\n");
 	 	cmdbAbstractObject::DisplayCreationForm($oPage, $this->sTargetClass, $oNewObj, array(), array('formPrefix' => $this->iId, 'noRelations' => true));	
 		$oPage->add('</div></div></div>');
 //		$oPage->add_ready_script("\$('#ac_create_$this->iId').dialog({ width: $(window).width()*0.8, height: 'auto', autoOpen: false, modal: true, title: '$sDialogTitle'});\n");
-		$oPage->add_ready_script("\$('#ac_create_$this->iId').dialog({ width: 'auto', height: 'auto', autoOpen: false, modal: true, title: '$sDialogTitle'});\n");
+		$oPage->add_ready_script("\$('#ac_create_$this->iId').dialog({ width: 'auto', height: 'auto', maxHeight: $(window).height() - 50, autoOpen: false, modal: true, title: '$sDialogTitle'});\n");
 		$oPage->add_ready_script("$('#dcr_{$this->iId} form').removeAttr('onsubmit');");
 		$oPage->add_ready_script("$('#dcr_{$this->iId} form').bind('submit.uilinksWizard', oACWidget_{$this->iId}.DoCreateObject);");
 	}
@@ -391,6 +473,7 @@ EOF
 		try
 		{
 			$oFilter = DBObjectSearch::FromOQL($sFilter);
+			$oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
 			$oSet = new DBObjectSet($oFilter, array(), array('this' => $oObj));
 		}
 		catch(MissingQueryArgument $e)
@@ -399,6 +482,7 @@ EOF
 			// TODO check if we can improve this behavior...
 			$sOQL = 'SELECT '.$this->m_sTargetClass;
 			$oFilter = DBObjectSearch::FromOQL($sOQL);
+			$oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
 			$oSet = new DBObjectSet($oFilter);
 		}
 
@@ -424,12 +508,7 @@ EOF
 		$aErrors = $oObj->UpdateObjectFromPostedForm($this->iId);
 		if (count($aErrors) == 0)
 		{
-			$oMyChange = MetaModel::NewObject("CMDBChange");
-			$oMyChange->Set("date", time());
-			$sUserString = CMDBChange::GetCurrentUserName();
-			$oMyChange->Set("userinfo", $sUserString);
-			$iChangeId = $oMyChange->DBInsert();
-			$oObj->DBInsertTracked($oMyChange);
+			$oObj->DBInsert();
 			return array('name' => $oObj->GetName(), 'id' => $oObj->GetKey());
 		}
 		else
@@ -478,6 +557,7 @@ EOF
 			$aSortedRoots = $aTree[$iRootId];
 			asort($aSortedRoots);
 			$oP->add("<ul>\n");
+			$fUniqueId = microtime(true);
 			foreach($aSortedRoots as $id => $sName)
 			{
 				if ($bSelect)
@@ -485,14 +565,14 @@ EOF
 					$sChecked = ($aNodes[$id]->GetKey() == $currValue) ? 'checked' : '';
 					if ($bMultiple)
 					{
-						$sSelect = '<input type="checkbox" value="'.$aNodes[$id]->GetKey().'" name="selectObject[]" '.$sChecked.'>&nbsp;';
+						$sSelect = '<input id="input_'.$fUniqueId.'_'.$aNodes[$id]->GetKey().'" type="checkbox" value="'.$aNodes[$id]->GetKey().'" name="selectObject[]" '.$sChecked.'>&nbsp;';
 					}
 					else
 					{
-						$sSelect = '<input type="radio" value="'.$aNodes[$id]->GetKey().'" name="selectObject" '.$sChecked.'>&nbsp;';
+						$sSelect = '<input id="input_'.$fUniqueId.'_'.$aNodes[$id]->GetKey().'" type="radio" value="'.$aNodes[$id]->GetKey().'" name="selectObject" '.$sChecked.'>&nbsp;';
 					}
 				}
-				$oP->add('<li>'.$sSelect.$aNodes[$id]->GetHyperlink());
+				$oP->add('<li>'.$sSelect.'<label for="input_'.$fUniqueId.'_'.$aNodes[$id]->GetKey().'">'.$aNodes[$id]->GetName().'</label>');
 				$this->DumpNodes($oP, $id, $aTree, $aNodes, $currValue);
 				$oP->add("</li>\n");
 			}

application/ui.htmleditorwidget.class.inc.php

@@ -1,27 +1,28 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * Class UIHTMLEditorWidget
  * UI wdiget for displaying and editing one-way encrypted passwords
  *
  * @author      Phil Eddies
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 class UIHTMLEditorWidget 

application/ui.linksdirectwidget.class.inc.php

@@ -0,0 +1,423 @@
+<?php
+// Copyright (C) 2010-2012 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+/**
+ * Class UILinksWidgetDirect
+ *  
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */ 
+
+class UILinksWidgetDirect
+{
+	protected $sClass;
+	protected $sAttCode;
+	protected $sInputid;
+	protected $sNameSuffix;
+	protected $sLinkedClass;
+	
+	public function __construct($sClass, $sAttCode, $sInputId, $sNameSuffix = '')
+	{
+		$this->sClass = $sClass;
+		$this->sAttCode = $sAttCode;
+		$this->sInputid = $sInputId;
+		$this->sNameSuffix = $sNameSuffix;
+		$this->aZlist = array();
+		$this->sLinkedClass = '';
+		
+		// Compute the list of attributes visible from the given objet:
+		// All the attributes from the "list" Zlist of the Link class except
+		// the ExternalKey that points to the current object and its related external fields
+		$oLinksetDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+		$this->sLinkedClass = $oLinksetDef->GetLinkedClass();
+		$sExtKeyToMe = $oLinksetDef->GetExtKeyToMe();
+		switch($oLinksetDef->GetEditMode())
+		{
+			case LINKSET_EDITMODE_INPLACE: // The whole linkset can be edited 'in-place'
+			$aZList = MetaModel::FlattenZList(MetaModel::GetZListItems($this->sLinkedClass, 'details'));
+			break;
+			
+			default:
+			$aZList = MetaModel::FlattenZList(MetaModel::GetZListItems($this->sLinkedClass, 'list'));
+			array_unshift($aZList, 'friendlyname');
+		}
+		foreach($aZList as $sLinkedAttCode)
+		{
+			if ($sLinkedAttCode != $sExtKeyToMe)
+			{
+				$oAttDef = MetaModel::GetAttributeDef($this->sLinkedClass, $sLinkedAttCode);
+				
+				if ((!$oAttDef->IsExternalField() || ($oAttDef->GetKeyAttCode() != $sExtKeyToMe)) &&
+					(!$oAttDef->IsLinkSet()) )
+				{
+					$this->aZlist[] = $sLinkedAttCode;
+				}
+			}
+		}
+		
+	}
+	
+	public function Display(WebPage $oPage, DBObjectSet $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj)
+	{
+		$oLinksetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
+		switch($oLinksetDef->GetEditMode())
+		{
+			case LINKSET_EDITMODE_NONE: // The linkset is read-only
+			$this->DisplayAsBlock($oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj, false /* bDisplayMenu*/);
+			break;
+			
+			case LINKSET_EDITMODE_ADDONLY: // The only possible action is to open (in a new window) the form to create a new object
+			if ($oCurrentObj && !$oCurrentObj->IsNew())
+			{
+				$sTargetClass = $oLinksetDef->GetLinkedClass();
+				$sExtKeyToMe = $oLinksetDef->GetExtKeyToMe();
+				$sDefault = "default[$sExtKeyToMe]=".$oCurrentObj->GetKey();
+				$oAppContext = new ApplicationContext();
+				$sParams = $oAppContext->GetForLink();
+				$oPage->p("<a target=\"_blank\" href=\"".utils::GetAbsoluteUrlAppRoot()."pages/UI.php?operation=new&class=$sTargetClass&$sParams{$sDefault}\">".Dict::Format('UI:ClickToCreateNew', Metamodel::GetName($sTargetClass))."</a>\n");
+			}
+			$this->DisplayAsBlock($oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj, false /* bDisplayMenu*/);
+			break;
+			
+			case LINKSET_EDITMODE_INPLACE: // The whole linkset can be edited 'in-place'
+			$this->DisplayEditInPlace($oPage, $oValue, $aArgs, $sFormPrefix, $oCurrentObj);
+			break;
+			
+			case LINKSET_EDITMODE_ADDREMOVE: // The whole linkset can be edited 'in-place'
+			$sTargetClass = $oLinksetDef->GetLinkedClass();
+			$sExtKeyToMe = $oLinksetDef->GetExtKeyToMe();
+			$oExtKeyDef = MetaModel::GetAttributeDef($sTargetClass, $sExtKeyToMe);
+			$aButtons = array('add');
+			if ($oExtKeyDef->IsNullAllowed())
+			{
+				$aButtons = array('add', 'remove');
+			}
+			$this->DisplayEditInPlace($oPage, $oValue, $aArgs, $sFormPrefix, $oCurrentObj, $aButtons);
+			break;
+			
+			case LINKSET_EDITMODE_ACTIONS:
+			default:
+			$this->DisplayAsBlock($oPage, $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj, true /* bDisplayMenu*/);
+		}
+	}
+	
+	protected function DisplayAsBlock(WebPage $oPage, DBObjectSet $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj, $bDisplayMenu)
+	{
+		$oLinksetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
+		$sTargetClass = $oLinksetDef->GetLinkedClass();
+		if ($oCurrentObj && $oCurrentObj->IsNew() && $bDisplayMenu)
+		{
+			$oPage->p(Dict::Format('UI:BeforeAdding_Class_ObjectsSaveThisObject', MetaModel::GetName($sTargetClass)));
+		}
+		else
+		{
+			$oFilter = new DBObjectSearch($sTargetClass);
+			$oFilter->AddCondition($oLinksetDef->GetExtKeyToMe(), $oCurrentObj->GetKey(),'=');
+
+			$aDefaults = array($oLinksetDef->GetExtKeyToMe() => $oCurrentObj->GetKey());
+			$oAppContext = new ApplicationContext();
+			foreach($oAppContext->GetNames() as $sKey)
+			{
+				// The linked object inherits the parent's value for the context
+				if (MetaModel::IsValidAttCode($this->sClass, $sKey) && $oCurrentObj)
+				{
+					$aDefaults[$sKey] = $oCurrentObj->Get($sKey);
+				}
+			}
+			$aParams = array(
+				'target_attr' => $oLinksetDef->GetExtKeyToMe(),
+				'object_id' => $oCurrentObj ? $oCurrentObj->GetKey() : null,
+				'menu' => $bDisplayMenu,
+				'default' => $aDefaults,
+				'table_id' => $this->sClass.'_'.$this->sAttCode,
+			);
+
+			$oBlock = new DisplayBlock($oFilter, 'list', false);
+			$oBlock->Display($oPage, $this->sInputid, $aParams);
+		}	
+	}
+	
+	protected function DisplayEditInPlace(WebPage $oPage, DBObjectSet $oValue, $aArgs = array(), $sFormPrefix, $oCurrentObj, $aButtons = array('create', 'delete'))
+	{
+		$aAttribs = $this->GetTableConfig();
+		
+		$oValue->Rewind();
+		$oPage->add('<table class="listContainer" id="'.$this->sInputid.'"><tr><td>');
+
+		$aData = array();
+		while($oLinkObj = $oValue->Fetch())
+		{
+			$aRow = array();
+			$aRow['form::select'] = '<input type="checkbox" class="selectList'.$this->sInputid.'" value="'.$oLinkObj->GetKey().'"/>';
+			foreach($this->aZlist as $sLinkedAttCode)
+			{
+				$aRow[$sLinkedAttCode] = $oLinkObj->GetAsHTML($sLinkedAttCode);
+			}
+			$aData[] = $aRow;
+		}
+		$oPage->table($aAttribs, $aData);
+		$oPage->add('</td></tr></table>'); //listcontainer
+		$sInputName = $sFormPrefix.'attr_'.$this->sAttCode;
+		$aLabels = array(
+			'delete' => Dict::S('UI:Button:Delete'),
+			// 'modify' => 'Modify...' , 
+			'creation_title' => Dict::Format('UI:CreationTitle_Class', MetaModel::GetName($this->sLinkedClass)),
+			'create' => Dict::Format('UI:ClickToCreateNew', MetaModel::GetName($this->sLinkedClass)),
+			'remove' => Dict::S('UI:Button:Remove'),
+			'add' => Dict::Format('UI:AddAnExisting_Class', MetaModel::GetName($this->sLinkedClass)),
+			'selection_title' => Dict::Format('UI:SelectionOf_Class', MetaModel::GetName($this->sLinkedClass)),
+		);
+		$oContext = new ApplicationContext();
+		$sSubmitUrl = utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php?'.$oContext->GetForLink();
+		$sJSONLabels = json_encode($aLabels);
+		$sJSONButtons = json_encode($aButtons);
+		$sWizHelper = 'oWizardHelper'.$sFormPrefix;
+		$oPage->add_ready_script("$('#{$this->sInputid}').directlinks({class_name: '$this->sClass', att_code: '$this->sAttCode', input_name:'$sInputName', labels: $sJSONLabels, submit_to: '$sSubmitUrl', buttons: $sJSONButtons, oWizardHelper: $sWizHelper });");
+	}
+	
+	public function GetObjectCreationDlg(WebPage $oPage, $sProposedRealClass = '')
+	{
+		// For security reasons: check that the "proposed" class is actually a subclass of the linked class
+		// and that the current user is allowed to create objects of this class
+		$sRealClass = '';
+		$oPage->add('<div class="wizContainer" style="vertical-align:top;"><div>');
+		$aSubClasses = MetaModel::EnumChildClasses($this->sLinkedClass, ENUM_CHILD_CLASSES_ALL); // Including the specified class itself
+		$aPossibleClasses = array();
+		foreach($aSubClasses as $sCandidateClass)
+		{
+			if (!MetaModel::IsAbstract($sCandidateClass) && (UserRights::IsActionAllowed($sCandidateClass, UR_ACTION_MODIFY) == UR_ALLOWED_YES))
+			{
+				if ($sCandidateClass == $sProposedRealClass)
+				{
+					$sRealClass = $sProposedRealClass;
+				}
+				$aPossibleClasses[$sCandidateClass] = MetaModel::GetName($sCandidateClass);
+			}
+		}
+		// Only one of the subclasses can be instantiated...
+		if (count($aPossibleClasses) == 1)
+		{
+			$aKeys = array_keys($aPossibleClasses);
+			$sRealClass = $aKeys[0];
+		}
+		
+		if ($sRealClass != '')
+		{
+			$oPage->add("<h1>".MetaModel::GetClassIcon($sRealClass)."&nbsp;".Dict::Format('UI:CreationTitle_Class', MetaModel::GetName($sRealClass))."</h1>\n");
+			$oLinksetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
+			$sExtKeyToMe = $oLinksetDef->GetExtKeyToMe();
+			$aFieldFlags = array( $sExtKeyToMe => OPT_ATT_HIDDEN);
+		 	cmdbAbstractObject::DisplayCreationForm($oPage, $sRealClass, null, array(), array('formPrefix' => $this->sInputid, 'noRelations' => true, 'fieldsFlags' => $aFieldFlags));	
+		}
+		else
+		{
+			$sClassLabel = MetaModel::GetName($this->sLinkedClass);
+			$oPage->add('<p>'.Dict::Format('UI:SelectTheTypeOf_Class_ToCreate', $sClassLabel));
+			$oPage->add('<nobr><select name="class">');
+			asort($aPossibleClasses);
+			foreach($aPossibleClasses as $sClassName => $sClassLabel)
+			{
+				$oPage->add("<option value=\"$sClassName\">$sClassLabel</option>");
+			}
+			$oPage->add('</select>');
+			$oPage->add('&nbsp; <button type="button" onclick="$(\'#'.$this->sInputid.'\').directlinks(\'subclassSelected\');">'.Dict::S('UI:Button:Apply').'</button><span class="indicator" style="display:inline-block;width:16px"></span></nobr></p>');
+		}
+		$oPage->add('</div></div>');
+	}
+	
+	public function GetObjectsSelectionDlg($oPage, $oCurrentObj)
+	{
+		$sHtml = "<div class=\"wizContainer\" style=\"vertical-align:top;\">\n";
+		
+		$oLinksetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
+		$valuesDef = $oLinksetDef->GetValuesDef();				
+		if ($valuesDef === null)
+		{
+			$oFilter = new DBObjectSearch($this->sLinkedClass);
+		}
+		else
+		{
+			if (!$valuesDef instanceof ValueSetObjects)
+			{
+				throw new Exception('Error: only ValueSetObjects are supported for "allowed_values" in AttributeLinkedSet ('.$this->sClass.'/'.$this->sAttCode.').');
+			}
+			$oFilter = DBObjectSearch::FromOQL($valuesDef->GetFilterExpression());
+		}
+		if ($oCurrentObj != null)
+		{
+			$this->SetSearchDefaultFromContext($oCurrentObj, $oFilter);
+		}
+		$oBlock = new DisplayBlock($oFilter, 'search', false);
+		$sHtml .= $oBlock->GetDisplay($oPage, "SearchFormToAdd_{$this->sInputid}", array('open' => true));
+		$sHtml .= "<form id=\"ObjectsAddForm_{$this->sInputid}\">\n";
+		$sHtml .= "<div id=\"SearchResultsToAdd_{$this->sInputid}\" style=\"vertical-align:top;background: #fff;height:100%;overflow:auto;padding:0;border:0;\">\n";
+		$sHtml .= "<div style=\"background: #fff; border:0; text-align:center; vertical-align:middle;\"><p>".Dict::S('UI:Message:EmptyList:UseSearchForm')."</p></div>\n";
+		$sHtml .= "</div>\n";
+		$sHtml .= "<input type=\"hidden\" id=\"count_{$this->sInputid}\" value=\"0\"/>";
+		$sHtml .= "<button type=\"button\" class=\"cancel\">".Dict::S('UI:Button:Cancel')."</button>&nbsp;&nbsp;<button type=\"button\" class=\"ok\" disabled=\"disabled\">".Dict::S('UI:Button:Add')."</button>";
+		$sHtml .= "</div>\n";
+		$sHtml .= "</form>\n";
+		$oPage->add($sHtml);
+		//$oPage->add_ready_script("$('#SearchFormToAdd_{$this->sAttCode}{$this->sNameSuffix} form').bind('submit.uilinksWizard', oWidget{$this->sInputId}.SearchObjectsToAdd);");
+		//$oPage->add_ready_script("$('#SearchFormToAdd_{$this->sAttCode}{$this->sNameSuffix}').resize(oWidget{$this->siInputId}.UpdateSizes);");
+	}
+	
+	/**
+	 * Search for objects to be linked to the current object (i.e "remote" objects)
+	 * @param WebPage $oP The page used for the output (usually an AjaxWebPage)
+	 * @param string $sRemoteClass Name of the "remote" class to perform the search on, must be a derived class of $this->sLinkedClass
+	 * @param array $aAlreadyLinked Array of indentifiers of objects which are already linke to the current object (or about to be linked)
+	 * @param DBObject $oCurrentObj The object currently being edited... if known...
+	 */
+	public function SearchObjectsToAdd(WebPage $oP, $sRemoteClass = '', $aAlreadyLinked = array(), $oCurrentObj = null)
+	{
+		if ($sRemoteClass == '')
+		{
+			$sRemoteClass = $this->sLinkedClass;
+		}
+		$oLinksetDef = MetaModel::GetAttributeDef($this->sClass, $this->sAttCode);
+		$valuesDef = $oLinksetDef->GetValuesDef();				
+		if ($valuesDef === null)
+		{
+			$oFilter = new DBObjectSearch($this->sLinkedClass);
+		}
+		else
+		{
+			if (!$valuesDef instanceof ValueSetObjects)
+			{
+				throw new Exception('Error: only ValueSetObjects are supported for "allowed_values" in AttributeLinkedSet ('.$this->sClass.'/'.$this->sAttCode.').');
+			}
+			$oFilter = DBObjectSearch::FromOQL($valuesDef->GetFilterExpression());
+		}
+		
+		if (($oCurrentObj != null) && MetaModel::IsSameFamilyBranch($sRemoteClass, $this->sClass))
+		{
+			// Prevent linking to self if the linked object is of the same family
+			// and laready present in the database
+			if (!$oCurrentObj->IsNew())
+			{
+				$oFilter->AddCondition('id', $oCurrentObj->GetKey(), '!=');
+			}
+		}
+		if (count($aAlreadyLinked) > 0)
+		{
+			$oFilter->AddCondition('id', $aAlreadyLinked, 'NOTIN');
+		}
+		if ($oCurrentObj != null)
+		{
+			$aArgs = array_merge($oCurrentObj->ToArgs('this'), $oFilter->GetInternalParams());
+			$oFilter->SetInternalParams($aArgs);
+		}
+		$oBlock = new DisplayBlock($oFilter, 'list', false);
+		$oBlock->Display($oP, "ResultsToAdd_{$this->sInputid}", array('menu' => false, 'cssCount'=> '#count_'.$this->sInputid , 'selection_mode' => true, 'table_id' => 'add_'.$this->sInputid)); // Don't display the 'Actions' menu on the results
+	}
+
+	public function DoAddObjects(WebPage $oP, $oFullSetFilter)
+	{
+		$aLinkedObjectIds = utils::ReadMultipleSelection($oFullSetFilter);
+		foreach($aLinkedObjectIds as $iObjectId)
+		{
+			$oLinkObj = MetaModel::GetObject($this->sLinkedClass, $iObjectId);
+			$oP->add($this->GetObjectRow($oP, $oLinkObj, $oLinkObj->GetKey()));
+		}
+	}
+	
+	public function GetObjectModificationDlg()
+	{
+		
+	}
+	
+	protected function GetTableConfig()
+	{
+		$aAttribs = array();
+		$aAttribs['form::select'] = array('label' => "<input type=\"checkbox\" onClick=\"CheckAll('.selectList{$this->sInputid}:not(:disabled)', this.checked);\" class=\"checkAll\"></input>", 'description' => Dict::S('UI:SelectAllToggle+'));
+
+		foreach($this->aZlist as $sLinkedAttCode)
+		{
+			$oAttDef = MetaModel::GetAttributeDef($this->sLinkedClass, $sLinkedAttCode);
+			$aAttribs[$sLinkedAttCode] = array('label' => MetaModel::GetLabel($this->sLinkedClass, $sLinkedAttCode), 'description' => $oAttDef->GetOrderByHint());
+		}
+		return $aAttribs;	
+	}
+	
+	public function GetRow($oPage, $sRealClass, $aValues, $iTempId)
+	{
+		if ($sRealClass == '')
+		{
+			$sRealClass = $this->sLinkedClass;
+		}
+		$oLinkObj = new $sRealClass();
+		$oLinkObj->UpdateObjectFromPostedForm($this->sInputid);
+		
+		return $this->GetObjectRow($oPage, $oLinkObj, $iTempId);
+	}
+	
+	protected function GetObjectRow($oPage, $oLinkObj, $iTempId)
+	{
+		$aAttribs = $this->GetTableConfig();
+		$aRow = array();
+		$aRow['form::select'] = '<input type="checkbox" class="selectList'.$this->sInputid.'" value="'.($iTempId).'"/>';
+		foreach($this->aZlist as $sLinkedAttCode)
+		{
+			$aRow[$sLinkedAttCode] = $oLinkObj->GetAsHTML($sLinkedAttCode);
+		}
+		return $oPage->GetTableRow($aRow, $aAttribs);		
+	}
+	
+	/**
+	 * Initializes the default search parameters based on 1) a 'current' object and 2) the silos defined by the context
+	 * @param DBObject $oSourceObj
+	 * @param DBObjectSearch $oSearch
+	 */
+	protected function SetSearchDefaultFromContext($oSourceObj, &$oSearch)
+	{
+		$oAppContext = new ApplicationContext();
+		$sSrcClass = get_class($oSourceObj);
+		$sDestClass = $oSearch->GetClass();
+		foreach($oAppContext->GetNames() as $key)
+		{
+			// Find the value of the object corresponding to each 'context' parameter
+			$aCallSpec = array($sSrcClass, 'MapContextParam');
+			$sAttCode = '';
+			if (is_callable($aCallSpec))
+			{
+				$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter					
+			}
+
+			if (MetaModel::IsValidAttCode($sSrcClass, $sAttCode))
+			{
+				$oAttDef = MetaModel::GetAttributeDef($sSrcClass, $sAttCode);
+				$defaultValue = $oSourceObj->Get($sAttCode);
+
+				// Find the attcode for the same 'context' parameter in the destination class
+				// and sets its value as the default value for the search condition
+				$aCallSpec = array($sDestClass, 'MapContextParam');
+				$sAttCode = '';
+				if (is_callable($aCallSpec))
+				{
+					$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter					
+				}
+	
+				if (MetaModel::IsValidAttCode($sDestClass, $sAttCode) && !empty($defaultValue))
+				{
+					$oSearch->AddCondition($sAttCode, $defaultValue);
+				}
+			}
+		}
+	}
+}

application/ui.linkswidget.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Class UILinksWidget
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/webpage.class.inc.php');
@@ -62,8 +63,9 @@ class UILinksWidget
 		$this->m_aTableConfig = array();
 		$this->m_aTableConfig['form::checkbox'] = array( 'label' => "<input class=\"select_all\" type=\"checkbox\" value=\"1\" onClick=\"CheckAll('#linkedset_{$this->m_sAttCode}{$this->m_sNameSuffix} .selection', this.checked); oWidget".$this->m_iInputId.".OnSelectChange();\">", 'description' => Dict::S('UI:SelectAllToggle+'));
 
-		foreach(MetaModel::ListAttributeDefs($this->m_sLinkedClass) as $sAttCode=>$oAttDef)
+		foreach(MetaModel::FlattenZList(MetaModel::GetZListItems($this->m_sLinkedClass, 'list')) as $sAttCode)
 		{
+			$oAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $sAttCode);
 			if ($sStateAttCode == $sAttCode)
 			{
 				// State attribute is always hidden from the UI
@@ -103,45 +105,106 @@ class UILinksWidget
 	{
 		$sPrefix = "$this->m_sAttCode{$this->m_sNameSuffix}";
 		$aRow = array();
-		if(is_object($linkObjOrId))
+		$aFieldsMap = array();
+		if(is_object($linkObjOrId) && (!$linkObjOrId->IsNew()))
 		{
 			$key = $linkObjOrId->GetKey();
+			$iRemoteObjKey =  $linkObjOrId->Get($this->m_sExtKeyToRemote);
 			$sPrefix .= "[$key][";
 			$sNameSuffix = "]"; // To make a tabular form
 			$aArgs['prefix'] = $sPrefix;
+			$aArgs['wizHelper'] = "oWizardHelper{$this->m_iInputId}{$key}";
 			$aArgs['this'] = $linkObjOrId;
 			$aRow['form::checkbox'] = "<input class=\"selection\" type=\"checkbox\" onClick=\"oWidget".$this->m_iInputId.".OnSelectChange();\" value=\"$key\">";
 			$aRow['form::checkbox'] .= "<input type=\"hidden\" name=\"attr_{$sPrefix}id{$sNameSuffix}\" value=\"$key\">";
 			foreach($this->m_aEditableFields as $sFieldCode)
 			{
 				$sFieldId = $this->m_iInputId.'_'.$sFieldCode.'['.$linkObjOrId->GetKey().']';
-				$sSafeId = str_replace(array('[',']','-'), '_', $sFieldId);
+				$sSafeId = utils::GetSafeId($sFieldId);
 				$oAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $sFieldCode);
 				$aRow[$sFieldCode] = cmdbAbstractObject::GetFormElementForField($oP, $this->m_sLinkedClass, $sFieldCode, $oAttDef, $linkObjOrId->Get($sFieldCode), '' /* DisplayValue */, $sSafeId, $sNameSuffix, 0, $aArgs);
+				$aFieldsMap[$sFieldCode] = $sSafeId;
 			}
+			$sState = $linkObjOrId->GetState();
 		}
 		else
 		{
 			// form for creating a new record
+			if (is_object($linkObjOrId))
+			{
+				// New link existing only in memory
+				$oNewLinkObj = $linkObjOrId;
+				$iRemoteObjKey = $oNewLinkObj->Get($this->m_sExtKeyToRemote);
+				$oRemoteObj = MetaModel::GetObject($this->m_sRemoteClass, $iRemoteObjKey);
+				$oNewLinkObj->Set($this->m_sExtKeyToMe, $oCurrentObj); // Setting the extkey with the object also fills the related external fields
+				$linkObjOrId = -$iRemoteObjKey;
+			}
+			else
+			{
+				$iRemoteObjKey = -$linkObjOrId;
+				$oNewLinkObj = MetaModel::NewObject($this->m_sLinkedClass);
+				$oRemoteObj = MetaModel::GetObject($this->m_sRemoteClass, -$linkObjOrId);
+				$oNewLinkObj->Set($this->m_sExtKeyToRemote, $oRemoteObj); // Setting the extkey with the object alsoo fills the related external fields
+				$oNewLinkObj->Set($this->m_sExtKeyToMe, $oCurrentObj); // Setting the extkey with the object also fills the related external fields
+			}
 			$sPrefix .= "[$linkObjOrId][";
-			$oNewLinkObj = MetaModel::NewObject($this->m_sLinkedClass);
-			$oRemoteObj = MetaModel::GetObject($this->m_sRemoteClass, -$linkObjOrId);
-			$oNewLinkObj->Set($this->m_sExtKeyToRemote, $oRemoteObj); // Setting the extkey with the object alsoo fills the related external fields
-			$oNewLinkObj->Set($this->m_sExtKeyToMe, $oCurrentObj); // Setting the extkey with the object alsoo fills the related external fields
 			$sNameSuffix = "]"; // To make a tabular form
 			$aArgs['prefix'] = $sPrefix;
+			$aArgs['wizHelper'] = "oWizardHelper{$this->m_iInputId}_".(-$linkObjOrId);
 			$aArgs['this'] = $oNewLinkObj;
 			$aRow['form::checkbox'] = "<input class=\"selection\" type=\"checkbox\" onClick=\"oWidget".$this->m_iInputId.".OnSelectChange();\" value=\"$linkObjOrId\">";
 			$aRow['form::checkbox'] .= "<input type=\"hidden\" name=\"attr_{$sPrefix}id{$sNameSuffix}\" value=\"\">";
 			foreach($this->m_aEditableFields as $sFieldCode)
 			{
 				$sFieldId = $this->m_iInputId.'_'.$sFieldCode.'['.$linkObjOrId.']';
-				$sSafeId = str_replace(array('[',']','-'), '_', $sFieldId);
+				$sSafeId = utils::GetSafeId($sFieldId);
 				$oAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $sFieldCode);
-				$aRow[$sFieldCode] = cmdbAbstractObject::GetFormElementForField($oP, $this->m_sLinkedClass, $sFieldCode, $oAttDef, '' /* TO DO/ call GetDefaultValue($oObject->ToArgs()) */, '' /* DisplayValue */, $sSafeId /* id */, $sNameSuffix, 0, $aArgs);
+				$aRow[$sFieldCode] = cmdbAbstractObject::GetFormElementForField($oP, $this->m_sLinkedClass, $sFieldCode, $oAttDef, $oNewLinkObj->Get($sFieldCode) /* TO DO/ call GetDefaultValue($oObject->ToArgs()) */, '' /* DisplayValue */, $sSafeId /* id */, $sNameSuffix, 0, $aArgs);
+				$aFieldsMap[$sFieldCode] = $sSafeId;
 			}
+			$sState = '';
+			$oP->add_script(
+<<<EOF
+$(".date-pick").datepicker({
+		showOn: 'button',
+		buttonImage: '../images/calendar.png',
+		buttonImageOnly: true,
+		dateFormat: 'yy-mm-dd',
+		constrainInput: false,
+		changeMonth: true,
+		changeYear: true
+	});
+$(".datetime-pick").datepicker({
+		showOn: 'button',
+		buttonImage: '../images/calendar.png',
+		buttonImageOnly: true,
+		dateFormat: 'yy-mm-dd 00:00:00',
+		constrainInput: false,
+		changeMonth: true,
+		changeYear: true
+});
+EOF
+			);
 		}
+		
+		$sExtKeyToMeId = utils::GetSafeId($sPrefix.$this->m_sExtKeyToMe);
+		$aFieldsMap[$this->m_sExtKeyToMe] = $sExtKeyToMeId;
+		$aRow['form::checkbox'] .= "<input type=\"hidden\" id=\"$sExtKeyToMeId\" value=\"".$oCurrentObj->GetKey()."\">";
 
+		$sExtKeyToRemoteId = utils::GetSafeId($sPrefix.$this->m_sExtKeyToRemote);
+		$aFieldsMap[$this->m_sExtKeyToRemote] = $sExtKeyToRemoteId;
+		$aRow['form::checkbox'] .= "<input type=\"hidden\" id=\"$sExtKeyToRemoteId\" value=\"$iRemoteObjKey\">";
+		
+		$iFieldsCount = count($aFieldsMap);
+		$sJsonFieldsMap = json_encode($aFieldsMap);
+		
+		$oP->add_script(
+<<<EOF
+var {$aArgs['wizHelper']} = new WizardHelper('{$this->m_sLinkedClass}', '', '$sState');
+{$aArgs['wizHelper']}.SetFieldsMap($sJsonFieldsMap);
+{$aArgs['wizHelper']}.SetFieldsCount($iFieldsCount);
+EOF
+		);
 		$aRow['static::key'] = $oLinkedObj->GetHyperLink();
 		foreach(MetaModel::GetZListItems($this->m_sRemoteClass, 'list') as $sFieldCode)
 		{
@@ -224,6 +287,7 @@ class UILinksWidget
 		$sHtmlValue = '';
 		$sTargetClass = self::GetTargetClass($this->m_sClass, $this->m_sAttCode);
 		$sHtmlValue .= "<div id=\"linkedset_{$this->m_sAttCode}{$this->m_sNameSuffix}\">\n";
+		$sHtmlValue .= "<input type=\"hidden\" id=\"{$sFormPrefix}{$this->m_iInputId}\">\n";
 		$oValue->Rewind();
 		$aForm = array();
 		while($oCurrentLink = $oValue->Fetch())
@@ -233,7 +297,7 @@ class UILinksWidget
 			if ($oCurrentLink->IsNew())
 			{
 				$key = -$oLinkedObj->GetKey();
-				$aForm[$key] = $this->GetFormRow($oPage, $oLinkedObj, $key, $aArgs, $oCurrentObj);
+				$aForm[$key] = $this->GetFormRow($oPage, $oLinkedObj, $oCurrentLink, $aArgs, $oCurrentObj);
 			}
 			else
 			{
@@ -246,15 +310,16 @@ class UILinksWidget
 		$sDuplicates = ($this->m_bDuplicatesAllowed) ? 'true' : 'false';
 		$sWizHelper = 'oWizardHelper'.$sFormPrefix;
 		$oPage->add_ready_script(<<<EOF
-		oWidget{$this->m_iInputId} = new LinksWidget('{$this->m_sAttCode}{$this->m_sNameSuffix}', '{$this->m_sClass}', '{$this->m_sAttCode}', '{$this->m_iInputId}', '{$this->m_sNameSuffix}', $sDuplicates, $sWizHelper);
+		oWidget{$this->m_iInputId} = new LinksWidget('{$this->m_sAttCode}{$this->m_sNameSuffix}', '{$this->m_sClass}', '{$this->m_sAttCode}', '{$this->m_iInputId}', '{$this->m_sNameSuffix}', $sDuplicates, $sWizHelper, '{$this->m_sExtKeyToRemote}');
 		oWidget{$this->m_iInputId}.Init();
+		$('#{$this->m_iInputId}').bind('update_value', function() { $(this).val(oWidget{$this->m_iInputId}.GetUpdatedValue()); })
 EOF
 );
 		$sHtmlValue .= "<span style=\"float:left;\">&nbsp;&nbsp;&nbsp;<img src=\"../images/tv-item-last.gif\">&nbsp;&nbsp;<input id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_btnRemove\" type=\"button\" value=\"".Dict::S('UI:RemoveLinkedObjectsOf_Class')."\" onClick=\"oWidget{$this->m_iInputId}.RemoveSelected();\" >";
-		$sHtmlValue .= "&nbsp;&nbsp;&nbsp;<input id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_btnAdd\" type=\"button\" value=\"".Dict::Format('UI:AddLinkedObjectsOf_Class', MetaModel::GetName($this->m_sRemoteClass))."\" onClick=\"oWidget{$this->m_iInputId}.AddObjects();\"></span>\n";
+		$sHtmlValue .= "&nbsp;&nbsp;&nbsp;<input id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_btnAdd\" type=\"button\" value=\"".Dict::Format('UI:AddLinkedObjectsOf_Class', MetaModel::GetName($this->m_sRemoteClass))."\" onClick=\"oWidget{$this->m_iInputId}.AddObjects();\"><span id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_indicatorAdd\"></span></span>\n";
 		$sHtmlValue .= "<span style=\"clear:both;\"><p>&nbsp;</p></span>\n";
 		$sHtmlValue .= "</div>\n";
-		$oPage->add_at_the_end($this->GetObjectPickerDialog($oPage), "dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}"); // To prevent adding forms inside the main form
+		$oPage->add_at_the_end("<div id=\"dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}\"></div>"); // To prevent adding forms inside the main form
 		return $sHtmlValue;
 	}
 	         
@@ -277,12 +342,11 @@ EOF
 		return $sTargetClass;
 	}
 	
-	protected function GetObjectPickerDialog($oPage)
+	public function GetObjectPickerDialog($oPage, $oCurrentObj)
 	{
-		$sHtml = "<div id=\"dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}\">";
-		$sHtml .= "<div class=\"wizContainer\" style=\"vertical-align:top;\">\n";
+		$sHtml = "<div class=\"wizContainer\" style=\"vertical-align:top;\">\n";
 		$oFilter = new DBObjectSearch($this->m_sRemoteClass);
-		$oSet = new CMDBObjectSet($oFilter);
+		$this->SetSearchDefaultFromContext($oCurrentObj, $oFilter);
 		$oBlock = new DisplayBlock($oFilter, 'search', false);
 		$sHtml .= $oBlock->GetDisplay($oPage, "SearchFormToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix}", array('open' => true));
 		$sHtml .= "<form id=\"ObjectsAddForm_{$this->m_sAttCode}{$this->m_sNameSuffix}\" OnSubmit=\"return oWidget{$this->m_iInputId}.DoAddObjects(this.id);\">\n";
@@ -293,12 +357,11 @@ EOF
 		$sHtml .= "<input type=\"button\" value=\"".Dict::S('UI:Button:Cancel')."\" onClick=\"$('#dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}').dialog('close');\">&nbsp;&nbsp;<input id=\"btn_ok_{$this->m_sAttCode}{$this->m_sNameSuffix}\" disabled=\"disabled\" type=\"submit\" value=\"".Dict::S('UI:Button:Add')."\">";
 		$sHtml .= "</div>\n";
 		$sHtml .= "</form>\n";
-		$sHtml .= "</div>\n";
+		$oPage->add($sHtml);
 		$oPage->add_ready_script("$('#dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}').dialog({ width: $(window).width()*0.8, height: $(window).height()*0.8, autoOpen: false, modal: true, resizeStop: oWidget{$this->m_iInputId}.UpdateSizes });");
 		$oPage->add_ready_script("$('#dlg_{$this->m_sAttCode}{$this->m_sNameSuffix}').dialog('option', {title:'".addslashes(Dict::Format('UI:AddObjectsOf_Class_LinkedWith_Class', MetaModel::GetName($this->m_sLinkedClass), MetaModel::GetName($this->m_sClass)))."'});");
 		$oPage->add_ready_script("$('#SearchFormToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix} form').bind('submit.uilinksWizard', oWidget{$this->m_iInputId}.SearchObjectsToAdd);");
 		$oPage->add_ready_script("$('#SearchFormToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix}').resize(oWidget{$this->m_iInputId}.UpdateSizes);");
-		return $sHtml;
 	}
 
 	/**
@@ -352,7 +415,7 @@ EOF
 		}
 		$oSet = new CMDBObjectSet($oFilter);
 		$oBlock = new DisplayBlock($oFilter, 'list', false);
-		$oBlock->Display($oP, "ResultsToAdd_{$this->m_sAttCode}", array('menu' => false, 'cssCount'=> '#count_'.$this->m_sAttCode.$this->m_sNameSuffix , 'selection_mode' => true)); // Don't display the 'Actions' menu on the results
+		$oBlock->Display($oP, "ResultsToAdd_{$this->m_sAttCode}", array('menu' => false, 'cssCount'=> '#count_'.$this->m_sAttCode.$this->m_sNameSuffix , 'selection_mode' => true, 'table_id' => 'add_'.$this->m_sAttCode)); // Don't display the 'Actions' menu on the results
 	}
 	
 	public function DoAddObjects(WebPage $oP, $oFullSetFilter, $oCurrentObj)
@@ -373,5 +436,47 @@ EOF
 			}
 		}
 	}
+	
+	/**
+	 * Initializes the default search parameters based on 1) a 'current' object and 2) the silos defined by the context
+	 * @param DBObject $oSourceObj
+	 * @param DBObjectSearch $oSearch
+	 */
+	protected function SetSearchDefaultFromContext($oSourceObj, &$oSearch)
+	{
+		$oAppContext = new ApplicationContext();
+		$sSrcClass = get_class($oSourceObj);
+		$sDestClass = $oSearch->GetClass();
+		foreach($oAppContext->GetNames() as $key)
+		{
+			// Find the value of the object corresponding to each 'context' parameter
+			$aCallSpec = array($sSrcClass, 'MapContextParam');
+			$sAttCode = '';
+			if (is_callable($aCallSpec))
+			{
+				$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter					
+			}
+
+			if (MetaModel::IsValidAttCode($sSrcClass, $sAttCode))
+			{
+				$oAttDef = MetaModel::GetAttributeDef($sSrcClass, $sAttCode);
+				$defaultValue = $oSourceObj->Get($sAttCode);
+
+				// Find the attcode for the same 'context' parameter in the destination class
+				// and sets its value as the default value for the search condition
+				$aCallSpec = array($sDestClass, 'MapContextParam');
+				$sAttCode = '';
+				if (is_callable($aCallSpec))
+				{
+					$sAttCode = call_user_func($aCallSpec, $key); // Returns null when there is no mapping for this parameter					
+				}
+	
+				if (MetaModel::IsValidAttCode($sDestClass, $sAttCode) && !empty($defaultValue))
+				{
+					$oSearch->AddCondition($sAttCode, $defaultValue);
+				}
+			}
+		}
+	}
 }
 ?>

application/ui.passwordwidget.class.inc.php

@@ -1,27 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * Class UIPasswordWidget
  * UI wdiget for displaying and editing one-way encrypted passwords
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/webpage.class.inc.php');
@@ -52,8 +52,10 @@ class UIPasswordWidget
 	{
 		$sCode = $this->sAttCode.$this->sNameSuffix;
 		$iWidgetIndex = self::$iWidgetIndex;
-		$sPasswordValue = utils::ReadPostedParam("attr_{$sCode}[value]", '*****', 'raw_data');
-		$sConfirmPasswordValue = utils::ReadPostedParam("attr_{$sCode}[confirm]", '*****', 'raw_data');
+
+		$aPasswordValues = utils::ReadPostedParam("attr_{$sCode}", null, 'raw_data');
+		$sPasswordValue = $aPasswordValues ? $aPasswordValues['value'] : '*****';
+		$sConfirmPasswordValue = $aPasswordValues ? $aPasswordValues['confirm'] : '*****';
 		$sChangedValue = (($sPasswordValue != '*****') || ($sConfirmPasswordValue != '*****')) ? 1 : 0;
 		$sHtmlValue = '';
 		$sHtmlValue = '<input type="password" maxlength="255" name="attr_'.$sCode.'[value]" id="'.$this->iId.'" value="'.htmlentities($sPasswordValue, ENT_QUOTES, 'UTF-8').'"/>&nbsp;<span class="form_validation" id="v_'.$this->iId.'"></span><br/>';

application/uilinkswizard.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Class UILinksWizard
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 class UILinksWizard
@@ -104,7 +105,7 @@ class UILinksWizard
 			var nbChecked = $('.selection:checked').length;
 			if (nbChecked > 0)
 			{
-				$('#btnRemove').attr('disabled','');
+				$('#btnRemove').removeAttr('disabled');
 			}
 			else
 			{

application/uiwizard.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Class UIWizard
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 class UIWizard

application/user.dashboard.class.inc.php

@@ -0,0 +1,61 @@
+<?php
+// Copyright (C) 2010-2012 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+/**
+ * Store and retrieve user custom dashboards
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+require_once(APPROOT.'/core/dbobject.class.php');
+
+/**
+ * This class is used to store, in a persistent manner, a dashboard edited by a user
+ */
+class UserDashboard extends DBObject
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "gui",
+			"key_type" => "autoincrement",
+			"name_attcode" => "user_id",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_app_dashboards",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+		);
+		
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_AddAttribute(new AttributeExternalKey("user_id", array("targetclass"=>"User", "allowed_values"=>null, "sql"=>"user_id", "is_null_allowed"=>false, "on_target_delete"=>DEL_AUTO, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeString("menu_code", array("allowed_values"=>null, "sql"=>"menu_code", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeText("contents", array("allowed_values"=>null, "sql"=>"contents", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+	}
+
+	/**
+	* Overloading this function here to secure a fix done right before the release
+	* The real fix should be to implement this verb in DBObject	
+	*/
+	public function DBDeleteTracked(CMDBChange $oChange, $bSkipStrongSecurity = null, &$oDeletionPlan = null)
+	{
+		$this->DBDelete($oDeletionPlan);
+	}
+}
+?>

application/user.preferences.class.inc.php

@@ -1,26 +1,26 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * Store and retrieve user's preferences (i.e persistent per user settings)
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 require_once(APPROOT.'/core/dbobject.class.php');
 require_once(APPROOT.'/core/userrights.class.inc.php');
@@ -77,6 +77,42 @@ class appUserPreferences extends DBObject
 		self::Save();
 	}
 	
+	/**
+	 * Clears the value for a given preference (or list of preferences that matches a pattern), and updates the database
+	 * @param string $sPattern Code/Pattern of the properties/preferences to reset
+	 * @param boolean $bPattern Whether or not the supplied code is a PCRE pattern
+	 */
+	static function UnsetPref($sCodeOrPattern, $bPattern = false)
+	{
+		if (self::$oUserPrefs == null)
+		{
+			self::Load();
+		}
+		$aPrefs = self::$oUserPrefs->Get('preferences');
+		if ($bPattern)
+		{
+			// the supplied code is a pattern, clear all preferences that match
+			foreach($aPrefs as $sKey => $void)
+			{
+				if (preg_match($sCodeOrPattern, $sKey))
+				{
+					unset($aPrefs[$sKey]);
+				}
+			}
+			self::$oUserPrefs->Set('preferences', $aPrefs);
+		}
+		else
+		{
+			unset($aPrefs[$sCodeOrPattern]);
+			self::$oUserPrefs->Set('preferences', $aPrefs);
+		}
+		// Save only if needed
+		if (self::$oUserPrefs->IsModified())
+		{
+			self::Save();
+		}
+	}
+	
 	/**
 	 * Call this function to get all the preferences for the user, packed as a JSON object
 	 * @return string JSON representation of the preferences

application/utils.inc.php

@@ -1,32 +1,35 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2013 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Static class utils
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/core/config.class.inc.php');
 require_once(APPROOT.'/application/transaction.class.inc.php');
 
-define('ITOP_CONFIG_FILE', APPROOT.'/config-itop.php');
+define('ITOP_CONFIG_FILE', 'config-itop.php');
+define('ITOP_DEFAULT_CONFIG_FILE', APPCONF.ITOP_DEFAULT_ENV.'/'.ITOP_CONFIG_FILE);
+
 define('SERVER_NAME_PLACEHOLDER', '$SERVER_NAME$');
 
 class FileUploadException extends Exception
@@ -40,12 +43,12 @@ class FileUploadException extends Exception
  */
 class utils
 {
-	private static $m_sConfigFile = ITOP_CONFIG_FILE;
-	private static $m_oConfig = null;
+	private static $oConfig = null;
 	private static $m_bCASClient = false;
 
 	// Parameters loaded from a file, parameters of the page/command line still have precedence
 	private static $m_aParamsFromFile = null;
+	private static $m_aParamSource = array();
 
 	protected static function LoadParamFile($sParamFile)
 	{
@@ -82,6 +85,7 @@ class utils
 				$sParam = $aMatches[1];
 				$value = trim($aMatches[2]);
 				self::$m_aParamsFromFile[$sParam] = $value;
+				self::$m_aParamSource[$sParam] = $sParamFile;
 			}
 		}
 	}
@@ -99,6 +103,25 @@ class utils
 		}
 	}
 
+	/**
+	 * Return the source file from which the parameter has been found,
+	 * usefull when it comes to pass user credential to a process executed
+	 * in the background	 
+	 * @param $sName Parameter name
+	 * @return The file name if any, or null
+	 */
+	public static function GetParamSourceFile($sName)
+	{
+		if (array_key_exists($sName, self::$m_aParamSource))
+		{
+			return self::$m_aParamSource[$sName];
+		}
+		else
+		{
+			return null;
+		}
+	}
+
 	public static function IsModeCLI()
 	{
 		$sSAPIName = php_sapi_name();
@@ -152,10 +175,18 @@ class utils
 	
 	public static function Sanitize($value, $defaultValue, $sSanitizationFilter)
 	{
-		$retValue = self::Sanitize_Internal($value, $sSanitizationFilter);
-		if ($retValue === false)
+		if ($value === $defaultValue)
 		{
-			$retValue = $defaultValue;
+			// Preserve the real default value (can be used to detect missing mandatory parameters)
+			$retValue = $value;
+		}
+		else
+		{
+			$retValue = self::Sanitize_Internal($value, $sSanitizationFilter);
+			if ($retValue === false)
+			{
+				$retValue = $defaultValue;
+			}
 		}
 		return $retValue;		
 	}
@@ -180,6 +211,7 @@ class utils
 			$retValue = filter_var($value, FILTER_SANITIZE_SPECIAL_CHARS);
 			break;
 			
+			case 'context_param':
 			case 'parameter':
 			case 'field_name':
 			if (is_array($value))
@@ -206,12 +238,15 @@ class utils
 					case 'field_name':
 					$retValue = filter_var($value, FILTER_VALIDATE_REGEXP, array("options"=>array("regexp"=>'/^[A-Za-z0-9_]+(->[A-Za-z0-9_]+)*$/'))); // att_code or att_code->name or AttCode->Name or AttCode->Key2->Name
 					break;
+					
+					case 'context_param':
+					$retValue = filter_var($value, FILTER_VALIDATE_REGEXP, array("options"=>array("regexp"=>'/^[ A-Za-z0-9_=%:+-]*$/')));
+					break;
+						
 				}
 			}
 			break;
-			
-			break;
-			
+						
 			default:
 			case 'raw_data':
 			$retValue = $value;
@@ -429,15 +464,30 @@ class utils
 	   // http://www.spaweditor.com/scripts/regex/index.php
 	}
 
+	static public function GetConfig()
+	{
+		if (self::$oConfig == null)
+		{
+			$sConfigFile = self::GetConfigFilePath();
+			if (file_exists($sConfigFile))
+			{
+				self::$oConfig = new Config($sConfigFile);
+			}
+			else
+			{
+				// When executing the setup, the config file may be still missing
+				self::$oConfig = new Config();
+			}
+		}
+		return self::$oConfig;
+	}
     /**
-     * Returns the absolute URL to the server's root path
-     * @param $sCurrentRelativePath string NO MORE USED, kept for backward compatibility only !
-     * @param $bForceHTTPS bool True to force HTTPS, false otherwise
-     * @return string The absolute URL to the server's root, without the first slash
+     * Returns the absolute URL to the application root path
+     * @return string The absolute URL to the application root, without the first slash
      */                   
 	static public function GetAbsoluteUrlAppRoot()
 	{
-		$sUrl = MetaModel::GetConfig()->Get('app_root_url');
+		$sUrl = self::GetConfig()->Get('app_root_url');
 		if (strpos($sUrl, SERVER_NAME_PLACEHOLDER) > -1)
 		{
 			if (isset($_SERVER['SERVER_NAME']))
@@ -458,7 +508,7 @@ class utils
 	{
 		// Build an absolute URL to this page on this server/port
 		$sServerName = isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : '';
-		$sProtocol = (isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS']!="off")) ? 'https' : 'http';
+		$sProtocol = self::IsConnectionSecure() ? 'https' : 'http';
 		$iPort = isset($_SERVER['SERVER_PORT']) ? $_SERVER['SERVER_PORT'] : 80;
 		if ($sProtocol == 'http')
 		{
@@ -521,6 +571,25 @@ class utils
 		return $sAppRootUrl;
 	}
 
+	/**
+	 * Helper to handle the variety of HTTP servers
+	 * See #286 (fixed in [896]), and #634 (this fix)
+	 * 	 
+	 * Though the official specs says 'a non empty string', some servers like IIS do set it to 'off' !
+	 * nginx set it to an empty string
+	 * Others might leave it unset (no array entry)	 
+	 */	 	
+	static public function IsConnectionSecure()
+	{
+		$bSecured = false;
+
+		if (!empty($_SERVER['HTTPS']) && (strtolower($_SERVER['HTTPS']) != 'off'))
+		{
+			$bSecured = true;
+		}
+		return $bSecured;
+	}
+
 	/**
 	 * Tells whether or not log off operation is supported.
 	 * Actually in only one case:
@@ -557,25 +626,25 @@ class utils
 	 */
 	 static function InitCASClient()
 	 {
-		$sCASIncludePath =  MetaModel::GetConfig()->Get('cas_include_path');
+		$sCASIncludePath =  self::GetConfig()->Get('cas_include_path');
 		include_once($sCASIncludePath.'/CAS.php');
 		
-		$bCASDebug = MetaModel::GetConfig()->Get('cas_debug');
+		$bCASDebug = self::GetConfig()->Get('cas_debug');
 		if ($bCASDebug)
 		{
-			phpCAS::setDebug(APPROOT.'/error.log');
+			phpCAS::setDebug(APPROOT.'log/error.log');
 		}
 		
 		if (!self::$m_bCASClient)
 		{
 			// Initialize phpCAS
-			$sCASVersion = MetaModel::GetConfig()->Get('cas_version');
-			$sCASHost = MetaModel::GetConfig()->Get('cas_host');
-			$iCASPort = MetaModel::GetConfig()->Get('cas_port');
-			$sCASContext = MetaModel::GetConfig()->Get('cas_context');
+			$sCASVersion = self::GetConfig()->Get('cas_version');
+			$sCASHost = self::GetConfig()->Get('cas_host');
+			$iCASPort = self::GetConfig()->Get('cas_port');
+			$sCASContext = self::GetConfig()->Get('cas_context');
 			phpCAS::client($sCASVersion, $sCASHost, $iCASPort, $sCASContext, false /* session already started */);
 			self::$m_bCASClient = true;
-			$sCASCACertPath = MetaModel::GetConfig()->Get('cas_server_ca_cert_path');
+			$sCASCACertPath = self::GetConfig()->Get('cas_server_ca_cert_path');
 			if (empty($sCASCACertPath))
 			{
 				// If no certificate authority is provided, do not attempt to validate
@@ -601,5 +670,400 @@ class utils
 		}
 		echo "<p><pre>".print_r($aLightTrace, true)."</pre></p>\n";
 	 }
+
+	/**
+	 * Execute the given iTop PHP script, passing it the current credentials
+	 * Only CLI mode is supported, because of the need to hand the credentials over to the next process
+	 * Throws an exception if the execution fails or could not be attempted (config issue)
+	 * @param string $sScript Name and relative path to the file (relative to the iTop root dir)
+	 * @param hash $aArguments Associative array of 'arg' => 'value'
+	 * @return array(iCode, array(output lines))
+	 */	 	  
+	/**
+	 */
+	static function ExecITopScript($sScriptName, $aArguments)
+	{
+		$aDisabled = explode(', ', ini_get('disable_functions'));
+		if (in_array('exec', $aDisabled))
+		{
+			throw new Exception("The PHP exec() function has been disabled on this server");
+		}
+
+		$sPHPExec = trim(self::GetConfig()->Get('php_path'));
+		if (strlen($sPHPExec) == 0)
+		{
+			throw new Exception("The path to php must not be empty. Please set a value for 'php_path' in your configuration file.");
+		}
+
+		$sAuthUser = self::ReadParam('auth_user', '', 'raw_data');
+		$sAuthPwd = self::ReadParam('auth_pwd', '', 'raw_data');
+		$sParamFile = self::GetParamSourceFile('auth_user');
+		if (is_null($sParamFile))
+		{
+			$aArguments['auth_user'] = $sAuthUser;
+			$aArguments['auth_pwd'] = $sAuthPwd;
+		}
+		else
+		{
+			$aArguments['param_file'] = $sParamFile;
+		}
+		
+		$aArgs = array();
+		foreach($aArguments as $sName => $value)
+		{
+			// Note: See comment from the 23-Apr-2004 03:30 in the PHP documentation
+			//    It suggests to rely on pctnl_* function instead of using escapeshellargs
+			$aArgs[] = "--$sName=".escapeshellarg($value);
+		}
+		$sArgs = implode(' ', $aArgs);
+		
+		$sScript = realpath(APPROOT.$sScriptName);
+		if (!file_exists($sScript))
+		{
+			throw new Exception("Could not find the script file '$sScriptName' from the directory '".APPROOT."'");
+		}
+
+		$sCommand = '"'.$sPHPExec.'" '.escapeshellarg($sScript).' -- '.$sArgs;
+
+		if (version_compare(phpversion(), '5.3.0', '<'))
+		{
+			if (substr(PHP_OS,0,3) == 'WIN')
+			{
+				// Under Windows, and for PHP 5.2.x, the whole command has to be quoted
+				// Cf PHP doc: http://php.net/manual/fr/function.exec.php, comment from the 27-Dec-2010
+				$sCommand = '"'.$sCommand.'"';
+			}
+		}
+
+		$sLastLine = exec($sCommand, $aOutput, $iRes);
+		if ($iRes == 1)
+		{
+			throw new Exception(Dict::S('Core:ExecProcess:Code1')." - ".$sCommand);
+		}
+		elseif ($iRes == 255)
+		{
+			$sErrors = implode("\n", $aOutput);
+			throw new Exception(Dict::S('Core:ExecProcess:Code255')." - ".$sCommand.":\n".$sErrors);
+		}
+
+		//$aOutput[] = $sCommand;
+		return array($iRes, $aOutput);
+	}
+
+	/**
+	 * Get the current environment
+	 */
+	public static function GetCurrentEnvironment()
+	{
+		if (isset($_SESSION['itop_env']))
+		{
+			return $_SESSION['itop_env'];
+		}
+		else
+		{
+			return ITOP_DEFAULT_ENV;
+		}
+	}
+	
+	/**
+	 * Merge standard menu items with plugin provided menus items
+	 */
+	public static function GetPopupMenuItems($oPage, $iMenuId, $param, &$aActions, $sTableId = null, $sDataTableId = null)
+	{
+		// 1st - add standard built-in menu items
+		// 
+		switch($iMenuId)
+		{
+			case iPopupMenuExtension::MENU_OBJLIST_TOOLKIT:
+			// $param is a DBObjectSet
+			$oAppContext = new ApplicationContext();
+			$sContext = $oAppContext->GetForLink();
+			$sDataTableId = is_null($sDataTableId) ? '' : $sDataTableId;
+			$sUIPage = cmdbAbstractObject::ComputeStandardUIPage($param->GetFilter()->GetClass());
+			$sOQL = addslashes($param->GetFilter()->ToOQL(true));
+			$sFilter = urlencode($param->GetFilter()->serialize());
+			$sUrl = utils::GetAbsoluteUrlAppRoot()."pages/$sUIPage?operation=search&filter=".$sFilter."&{$sContext}";
+			$aResult = array(
+				new SeparatorPopupMenuItem(),
+				// Static menus: Email this page, CSV Export & Add to Dashboard
+				new URLPopupMenuItem('UI:Menu:EMail', Dict::S('UI:Menu:EMail'), "mailto:?body=".urlencode($sUrl).' '), // Add an extra space to make it work in Outlook
+				new URLPopupMenuItem('UI:Menu:CSVExport', Dict::S('UI:Menu:CSVExport'), $sUrl."&format=csv"),
+				new JSPopupMenuItem('UI:Menu:AddToDashboard', Dict::S('UI:Menu:AddToDashboard'), "DashletCreationDlg('$sOQL')"),
+				new JSPopupMenuItem('UI:Menu:ShortcutList', Dict::S('UI:Menu:ShortcutList'), "ShortcutListDlg('$sOQL', '$sDataTableId', '$sContext')"),
+			);
+			break;
+
+			case iPopupMenuExtension::MENU_OBJDETAILS_ACTIONS:
+			// $param is a DBObject
+			$oObj = $param;
+			$oFilter = DBobjectSearch::FromOQL("SELECT ".get_class($oObj)." WHERE id=".$oObj->GetKey());
+			$sFilter = $oFilter->serialize();
+			$sUrl = ApplicationContext::MakeObjectUrl(get_class($oObj), $oObj->GetKey());
+			$sUIPage = cmdbAbstractObject::ComputeStandardUIPage(get_class($oObj));
+			$oAppContext = new ApplicationContext();
+			$sContext = $oAppContext->GetForLink();
+			$aResult = array(
+				new SeparatorPopupMenuItem(),
+				// Static menus: Email this page & CSV Export
+				new URLPopupMenuItem('UI:Menu:EMail', Dict::S('UI:Menu:EMail'), "mailto:?subject=".urlencode($oObj->GetRawName())."&body=".urlencode($sUrl).' '), // Add an extra space to make it work in Outlook
+				new URLPopupMenuItem('UI:Menu:CSVExport', Dict::S('UI:Menu:CSVExport'), utils::GetAbsoluteUrlAppRoot()."pages/$sUIPage?operation=search&filter=".urlencode($sFilter)."&format=csv&{$sContext}"),
+			);
+			break;
+
+			case iPopupMenuExtension::MENU_DASHBOARD_ACTIONS:
+			// $param is a Dashboard
+			$oAppContext = new ApplicationContext();
+			$aParams = $oAppContext->GetAsHash();
+			$sMenuId = ApplicationMenu::GetActiveNodeId();
+			$sDlgTitle = addslashes(Dict::S('UI:ImportDashboardTitle'));
+			$sDlgText = addslashes(Dict::S('UI:ImportDashboardText'));
+			$sCloseBtn = addslashes(Dict::S('UI:Button:Cancel'));
+			$aResult = array(
+				new SeparatorPopupMenuItem(),
+				new URLPopupMenuItem('UI:ExportDashboard', Dict::S('UI:ExportDashBoard'), utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php?operation=export_dashboard&id='.$sMenuId),
+				new JSPopupMenuItem('UI:ImportDashboard', Dict::S('UI:ImportDashBoard'), "UploadDashboard({dashboard_id: '$sMenuId', title: '$sDlgTitle', text: '$sDlgText', close_btn: '$sCloseBtn' })"),
+			);
+			break;
+
+			default:
+			// Unknown type of menu, do nothing
+			$aResult = array();
+		}
+		foreach($aResult as $oMenuItem)
+		{
+			$aActions[$oMenuItem->GetUID()] = $oMenuItem->GetMenuItem();
+		}
+
+		// Invoke the plugins
+		//
+		foreach (MetaModel::EnumPlugins('iPopupMenuExtension') as $oExtensionInstance)
+		{
+			if (is_object($param) && !($param instanceof DBObject))
+			{
+				$tmpParam = clone $param; // In case the parameter is an DBObjectSet, clone it to prevent alterations
+			}
+			else
+			{
+				$tmpParam = $param;
+			}
+			foreach($oExtensionInstance->EnumItems($iMenuId, $tmpParam) as $oMenuItem)
+			{
+				if (is_object($oMenuItem))
+				{
+					$aActions[$oMenuItem->GetUID()] = $oMenuItem->GetMenuItem();
+					
+					foreach($oMenuItem->GetLinkedScripts() as $sLinkedScript)
+					{
+						$oPage->add_linked_script($sLinkedScript);
+					}
+				}
+			}
+		}
+	}
+	/**
+	 * Get target configuration file name (including full path)
+	 */
+	public static function GetConfigFilePath($sEnvironment = null)
+	{
+		if (is_null($sEnvironment))
+		{
+			$sEnvironment = self::GetCurrentEnvironment();
+		}
+		return APPCONF.$sEnvironment.'/'.ITOP_CONFIG_FILE;
+	}
+
+    /**
+     * Returns the absolute URL to the modules root path
+     * @return string ...
+     */                   
+	static public function GetAbsoluteUrlModulesRoot()
+	{
+		$sUrl = self::GetAbsoluteUrlAppRoot().'env-'.self::GetCurrentEnvironment().'/';
+		return $sUrl;
+	}
+
+    /**
+     * Returns the URL to a page that will execute the requested module page
+     *      
+     * To be compatible with this mechanism, the called page must include approot
+     * with an absolute path OR not include it at all (losing the direct access to the page)
+     * if (!defined('__DIR__')) define('__DIR__', dirname(__FILE__));
+     * require_once(__DIR__.'/../../approot.inc.php');
+     *      
+     * @return string ...
+     */                   
+	static public function GetAbsoluteUrlModulePage($sModule, $sPage, $aArguments = array(), $sEnvironment = null)
+	{
+		$sEnvironment = is_null($sEnvironment) ? self::GetCurrentEnvironment() : $sEnvironment;
+		$aArgs = array();
+		$aArgs[] = 'exec_module='.$sModule;
+		$aArgs[] = 'exec_page='.$sPage;
+		$aArgs[] = 'exec_env='.$sEnvironment;
+		foreach($aArguments as $sName => $sValue)
+		{
+			if (($sName == 'exec_module')||($sName == 'exec_page')||($sName == 'exec_env'))
+			{
+				throw new Exception("Module page: $sName is a reserved page argument name");
+			}
+			$aArgs[] = $sName.'='.urlencode($sValue);
+		}
+		$sArgs = implode('&', $aArgs);
+		return self::GetAbsoluteUrlAppRoot().'pages/exec.php?'.$sArgs;
+	}
+
+	/**
+	 * Returns a name unique amongst the given list
+	 * @param string $sProposed The default value
+	 * @param array  $aExisting An array of existing values (strings)	 	 
+	 */
+	static public function MakeUniqueName($sProposed, $aExisting)
+	{
+		if (in_array($sProposed, $aExisting))
+		{
+			$i = 1;
+			while (in_array($sProposed.$i, $aExisting) && ($i < 50))
+			{
+				$i++;
+			}
+			return $sProposed.$i;
+		}
+		else
+		{
+			return $sProposed;
+		}
+	}
+	
+	/**
+	 * Some characters cause troubles with jQuery when used inside DOM IDs, so let's replace them by the safe _ (underscore)
+	 * @param string $sId The ID to sanitize
+	 * @return string The sanitized ID
+	 */
+	static public function GetSafeId($sId)
+	{
+		return str_replace(array(':', '[', ']', '+', '-'), '_', $sId);
+	}
+	
+	/**
+	 * Helper to execute an HTTP POST request
+	 * Source: http://netevil.org/blog/2006/nov/http-post-from-php-without-curl
+	 *         originaly named after do_post_request
+	 * Does not require cUrl but requires openssl for performing https POSTs.
+	 * 
+	 * @param string $sUrl The URL to POST the data to
+	 * @param hash $aData The data to POST as an array('param_name' => value)
+	 * @param string $sOptionnalHeaders Additional HTTP headers as a string with newlines between headers
+	 * @param hash	$aResponseHeaders An array to be filled with reponse headers: WARNING: the actual content of the array depends on the library used: cURL or fopen, test with both !! See: http://fr.php.net/manual/en/function.curl-getinfo.php
+	 * @return string The result of the POST request
+	 * @throws Exception
+	 */ 
+	static public function DoPostRequest($sUrl, $aData, $sOptionnalHeaders = null, &$aResponseHeaders = null)
+	{
+		// $sOptionnalHeaders is a string containing additional HTTP headers that you would like to send in your request.
+	
+		if (function_exists('curl_init'))
+		{
+			// If cURL is available, let's use it, since it provides a greater control over the various HTTP/SSL options
+			// For instance fopen does not allow to work around the bug: http://stackoverflow.com/questions/18191672/php-curl-ssl-routinesssl23-get-server-helloreason1112
+			// by setting the SSLVERSION to 3 as done below.
+			$aHeaders = explode("\n", $sOptionnalHeaders);
+			$aHTTPHeaders = array();
+			foreach($aHeaders as $sHeaderString)
+			{
+				if(preg_match('/^([^:]): (.+)$/', $sHeaderString, $aMatches))
+				{
+					$aHTTPHeaders[$aMatches[1]] = $aMatches[2];
+				}
+			}
+			$aOptions = array(
+				CURLOPT_RETURNTRANSFER	=> true,     // return the content of the request
+				CURLOPT_HEADER			=> false,    // don't return the headers in the output
+				CURLOPT_FOLLOWLOCATION	=> true,     // follow redirects
+				CURLOPT_ENCODING		=> "",       // handle all encodings
+				CURLOPT_USERAGENT		=> "spider", // who am i
+				CURLOPT_AUTOREFERER		=> true,     // set referer on redirect
+				CURLOPT_CONNECTTIMEOUT	=> 120,      // timeout on connect
+				CURLOPT_TIMEOUT			=> 120,      // timeout on response
+				CURLOPT_MAXREDIRS		=> 10,       // stop after 10 redirects
+				CURLOPT_SSL_VERIFYPEER	=> false,    // Disabled SSL Cert checks
+				CURLOPT_SSLVERSION		=> 3,		 // MUST to prevent a strange SSL error: http://stackoverflow.com/questions/18191672/php-curl-ssl-routinesssl23-get-server-helloreason1112
+				CURLOPT_POST			=> count($aData),
+				CURLOPT_POSTFIELDS		=> http_build_query($aData),
+				CURLOPT_HTTPHEADER		=> $aHTTPHeaders,
+			);
+			
+			$ch = curl_init($sUrl);
+			curl_setopt_array($ch, $aOptions);
+			$response = curl_exec($ch);
+			$iErr = curl_errno($ch);
+			$sErrMsg = curl_error( $ch );
+			$aHeaders = curl_getinfo( $ch );
+			if ($iErr !== 0)
+			{
+				throw new Exception("Problem opening URL: $sUrl, $sErrMsg");
+			}
+			if (is_array($aResponseHeaders))
+			{
+				$aHeaders = curl_getinfo($ch);
+				foreach($aHeaders as $sCode => $sValue)
+				{
+					$sName = str_replace(' ' , '-', ucwords(str_replace('_', ' ', $sCode))); // Transform "content_type" into "Content-Type"
+					$aResponseHeaders[$sName] = $sValue;
+				}
+			}
+			curl_close( $ch );
+		}
+		else
+		{
+			// cURL is not available let's try with streams and fopen...
+			
+			$sData = http_build_query($aData);
+			$aParams = array('http' => array(
+									'method' => 'POST',
+									'content' => $sData,
+									'header'=> "Content-type: application/x-www-form-urlencoded\r\nContent-Length: ".strlen($sData)."\r\n",
+									));
+			if ($sOptionnalHeaders !== null)
+			{
+				$aParams['http']['header'] .= $sOptionnalHeaders;
+			}
+			$ctx = stream_context_create($aParams);
+		
+			$fp = @fopen($sUrl, 'rb', false, $ctx);
+			if (!$fp)
+			{
+				global $php_errormsg;
+				if (isset($php_errormsg))
+				{
+					throw new Exception("Wrong URL: $sUrl, $php_errormsg");
+				}
+				elseif ((strtolower(substr($sUrl, 0, 5)) == 'https') && !extension_loaded('openssl'))
+				{
+					throw new Exception("Cannot connect to $sUrl: missing module 'openssl'");
+				}
+				else
+				{
+					throw new Exception("Wrong URL: $sUrl");
+				}
+			}
+			$response = @stream_get_contents($fp);
+			if ($response === false)
+			{
+				throw new Exception("Problem reading data from $sUrl, $php_errormsg");
+			}
+			if (is_array($aResponseHeaders))
+			{
+				$aMeta = stream_get_meta_data($fp);
+				$aHeaders = $aMeta['wrapper_data'];
+				foreach($aHeaders as $sHeaderString)
+				{
+					if(preg_match('/^([^:]+): (.+)$/', $sHeaderString, $aMatches))
+					{
+						$aResponseHeaders[$aMatches[1]] = trim($aMatches[2]);
+					}
+				}
+			}
+		}
+		return $response;
+	}
 }
 ?>

application/webpage.class.inc.php

@@ -1,28 +1,45 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2013 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Class WebPage
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
+
+/**
+ * Generic interface common to CLI and Web pages
+ */
+Interface Page
+{
+	public function output();
+	public function add($sText);
+	public function p($sText);
+	public function pre($sText);
+	public function add_comment($sText);
+	public function table($aConfig, $aData, $aParams = array());
+}
+ 
+
+
 /**
  * Simple helper class to ease the production of HTML pages
  *
@@ -34,12 +51,13 @@
  *	$oPage->p("Hello World !");
  *	$oPage->output();
  */
-class WebPage
+class WebPage implements Page
 {
     protected $s_title;
     protected $s_content;
     protected $s_deferred_content;
     protected $a_scripts;
+    protected $a_dict_entries;
     protected $a_styles;
     protected $a_include_scripts;
     protected $a_include_stylesheets;
@@ -50,6 +68,8 @@ class WebPage
 	protected $sContentType;
 	protected $sContentDisposition;
 	protected $sContentFileName;
+	protected $s_sOutputFormat;
+	protected $a_OutputOptions;
 	    
     public function __construct($s_title)
     {
@@ -57,6 +77,7 @@ class WebPage
         $this->s_content = "";
         $this->s_deferred_content = '';
         $this->a_scripts = array();
+        $this->a_dict_entries = array();
         $this->a_styles = array();
         $this->a_linked_scripts = array();
         $this->a_linked_stylesheets = array();
@@ -67,6 +88,8 @@ class WebPage
         $this->sContentType = '';
         $this->sContentDisposition = '';
         $this->sContentFileName = '';
+		$this->s_OutputFormat = utils::ReadParam('output_format', 'html');
+		$this->a_OutputOptions = array();
         ob_start(); // Start capturing the output
     }
 	
@@ -121,6 +144,13 @@ class WebPage
         $this->add('<pre>'.$s_html.'</pre>');
     }
     
+	/**
+	 * Add a comment
+	 */
+    public function add_comment($sText)
+    {
+        $this->add('<!--'.$sText.'-->');
+    }
 	/**
 	 * Add a paragraph to the body of the page
 	 */
@@ -203,6 +233,16 @@ class WebPage
     {
         // Do nothing silently... this is not supported by this type of page...
     }
+
+	/**
+	 * Add a dictionary entry for the Javascript side
+	 */
+    public function add_dict_entry($s_entryId)
+    {
+        $this->a_dict_entries[$s_entryId] = Dict::S($s_entryId);
+    }
+    
+
 	/**
 	 * Add some CSS definitions to the header of the page
 	 */
@@ -351,6 +391,25 @@ class WebPage
 		return $sHTMLValue;
 	}
 	
+	/**
+	 * Discard unexpected output data
+	 * This is a MUST when the Page output is DATA (download of a document, download CSV export, download ...)
+	 */	
+	public function TrashUnexpectedOutput()
+	{
+		// This protection is redundant with a protection implemented in MetaModel::IncludeModule
+		// which detects such issues while loading module files
+		// Here, the purpose is to detect and discard characters produced by the code execution (echo)
+		$sPreviousContent = ob_get_clean();
+		if (trim($sPreviousContent) != '')
+		{
+			if (Utils::GetConfig() && Utils::GetConfig()->Get('debug_report_spurious_chars'))
+			{
+				IssueLog::Error("Output already started before downloading file:\nContent was:'$sPreviousContent'\n");
+			}
+		}
+	}
+
 	/**
 	 * Outputs (via some echo) the complete HTML page by assembling all its elements
 	 */
@@ -391,6 +450,7 @@ class WebPage
             }
             echo "</script>\n";
         }
+        $this->output_dict_entries();
         foreach($this->a_linked_stylesheets as $a_stylesheet)
         {
 			if ($a_stylesheet['condition'] != "")
@@ -427,18 +487,30 @@ class WebPage
         echo '<div id="at_the_end">'.self::FilterXSS($this->s_deferred_content).'</div>';
         echo "</body>\n";
         echo "</html>\n";
+
+        if (class_exists('MetaModel'))
+        {
+            MetaModel::RecordQueryTrace();
+        }
+        if (class_exists('ExecutionKPI'))
+        {
+            ExecutionKPI::ReportStats();
+        }
     }
 
 	/**
 	 * Build a series of hidden field[s] from an array
 	 */
-	 // By Rom - je verrais bien une serie d'outils pour gerer des parametres que l'on retransmet entre pages d'un wizard...
-	 //          ptet deriver webpage en webwizard
 	public function add_input_hidden($sLabel, $aData)
 	{
-		foreach($aData as $sKey=>$sValue)
+		foreach($aData as $sKey => $sValue)
 		{
-			$this->add("<input type=\"hidden\" name=\"".$sLabel."[$sKey]\" value=\"$sValue\">");
+			// Note: protection added to protect against the Notice 'array to string conversion' that appeared with PHP 5.4
+			// (this function seems unused though!)
+			if (is_scalar($sValue))
+			{
+				$this->add("<input type=\"hidden\" name=\"".$sLabel."[$sKey]\" value=\"$sValue\">");
+			}
 		}
 	}
 
@@ -515,5 +587,422 @@ class WebPage
 	{
 		return str_ireplace('<script', '&lt;script', $sHTML);
 	}
+	
+	/**
+	 * What is the currently selected output format
+	 * @return string The selected output format: html, pdf...
+	 */
+	public function GetOutputFormat()
+	{
+		return $this->s_OutputFormat;
+	}
+
+	/**
+	 * Check whether the desired output format is possible or not
+	 * @param string $sOutputFormat The desired output format: html, pdf...
+	 * @return bool True if the format is Ok, false otherwise
+	 */
+	function IsOutputFormatAvailable($sOutputFormat)
+	{
+		$bResult = false;
+		switch($sOutputFormat)
+		{
+			case 'html':
+			$bResult = true; // Always supported
+			break;
+			
+			case 'pdf':
+			$bResult = @is_readable(APPROOT.'lib/MPDF/mpdf.php');
+			break;
+		}
+		return $bResult;
+	}
+	
+	/** 
+	 * Retrieves the value of a named output option for the given format
+	 * @param string $sFormat The format: html or pdf
+	 * @param string $sOptionName The name of the option
+	 * @return mixed false if the option was never set or the options's value
+	 */
+	public function GetOutputOption($sFormat, $sOptionName)
+	{
+		if (isset($this->a_OutputOptions[$sFormat][$sOptionName]))
+		{
+			return $this->a_OutputOptions[$sFormat][$sOptionName];
+		}
+		return false;
+	}
+	/**
+	 * Sets a named output option for the given format
+	 * @param string $sFormat The format for which to set the option: html or pdf
+	 * @param string $sOptionName the name of the option
+	 * @param mixed $sValue The value of the option
+	 */
+	public function SetOutputOption($sFormat, $sOptionName, $sValue)
+	{
+		if (!isset($this->a_OutputOptions[$sFormat]))
+		{
+			$this->a_OutputOptions[$sFormat] = array($sOptionName => $sValue);
+		}
+		else
+		{
+			$this->a_OutputOptions[$sFormat][$sOptionName] = $sValue;
+		}
+	}
+	
+	public function RenderPopupMenuItems($aActions, $aFavoriteActions = array())
+	{
+		$sPrevUrl = '';
+		$sHtml = '';
+		foreach ($aActions as $aAction)
+		{
+			$sClass = isset($aAction['class']) ? " class=\"{$aAction['class']}\"" : "";
+			$sOnClick = isset($aAction['onclick']) ? ' onclick="'.htmlspecialchars($aAction['onclick'], ENT_QUOTES, "UTF-8").'"' : '';
+			$sTarget = isset($aAction['target']) ? " target=\"{$aAction['target']}\"" : "";
+			if (empty($aAction['url']))
+			{
+				if ($sPrevUrl != '') // Don't output consecutively two separators...
+				{
+					$sHtml .= "<li>{$aAction['label']}</li>";			
+				}
+				$sPrevUrl = '';
+			}
+			else
+			{
+				$sHtml .= "<li><a $sTarget href=\"{$aAction['url']}\"$sClass $sOnClick>{$aAction['label']}</a></li>";
+				$sPrevUrl = $aAction['url'];
+			}
+		}
+		$sHtml .= "</ul></li></ul></div>";
+		foreach(array_reverse($aFavoriteActions) as $aAction)
+		{
+			$sTarget = isset($aAction['target']) ? " target=\"{$aAction['target']}\"" : "";
+			$sHtml .= "<div class=\"actions_button\"><a $sTarget href='{$aAction['url']}'>{$aAction['label']}</a></div>";			
+		}
+		
+		return $sHtml;
+	}
+
+	protected function output_dict_entries($bReturnOutput = false)
+	{
+		$sHtml = '';
+		if (count($this->a_dict_entries)>0)
+		{
+			$sHtml .= "<script type=\"text/javascript\">\n";
+			$sHtml .= "var Dict = {};\n";
+			$sHtml .= "Dict._entries = {};\n";
+			$sHtml .= "Dict.S = function(sEntry) {\n";
+			$sHtml .= "   if (sEntry in Dict._entries)\n";
+			$sHtml .= "   {\n";
+			$sHtml .= "      return Dict._entries[sEntry];\n";
+			$sHtml .= "   }\n";
+			$sHtml .= "   else\n";
+			$sHtml .= "   {\n";
+			$sHtml .= "      return sEntry;\n";
+			$sHtml .= "   }\n";
+			$sHtml .= "};\n";
+			foreach($this->a_dict_entries as $s_entry => $s_value)
+			{
+				$sHtml .= "Dict._entries['$s_entry'] = '".addslashes($s_value)."';\n";
+			}
+			$sHtml .= "</script>\n";
+		}
+		
+		if ($bReturnOutput)
+		{
+			return $sHtml;
+		}
+		else
+		{
+			echo $sHtml;
+		}
+	}
 }
-?>
+
+
+interface iTabbedPage
+{
+	public function AddTabContainer($sTabContainer, $sPrefix = '');
+
+	public function AddToTab($sTabContainer, $sTabLabel, $sHtml);
+
+	public function SetCurrentTabContainer($sTabContainer = '');
+
+	public function SetCurrentTab($sTabLabel = '');
+	
+	/**
+	 * Add a tab which content will be loaded asynchronously via the supplied URL
+	 * 
+	 * Limitations:
+	 * Cross site scripting is not not allowed for security reasons. Use a normal tab with an IFRAME if you want to pull content from another server.
+	 * Static content cannot be added inside such tabs.
+	 * 
+	 * @param string $sTabLabel The (localised) label of the tab
+	 * @param string $sUrl The URL to load (on the same server)
+	 * @param boolean $bCache Whether or not to cache the content of the tab once it has been loaded. flase will cause the tab to be reloaded upon each activation.
+	 * @since 2.0.3
+	 */
+	public function AddAjaxTab($sTabLabel, $sUrl, $bCache = true);
+	
+	public function GetCurrentTab();
+
+	public function RemoveTab($sTabLabel, $sTabContainer = null);
+
+	/**
+	 * Finds the tab whose title matches a given pattern
+	 * @return mixed The name of the tab as a string or false if not found
+	 */
+	public function FindTab($sPattern, $sTabContainer = null);
+}
+
+/**
+ * Helper class to implement JQueryUI tabs inside a page
+ */
+class TabManager
+{
+	protected $m_aTabs;
+	protected $m_sCurrentTabContainer;
+	protected $m_sCurrentTab;
+	
+	public function __construct()
+	{
+		$this->m_aTabs = array();
+		$this->m_sCurrentTabContainer = '';
+		$this->m_sCurrentTab = '';
+	}
+	
+	public function AddTabContainer($sTabContainer, $sPrefix = '')
+	{
+		$this->m_aTabs[$sTabContainer] = array('prefix' => $sPrefix, 'tabs' => array());
+		return "\$Tabs:$sTabContainer\$";
+	}
+
+	public function AddToCurrentTab($sHtml)
+	{
+		$this->AddToTab($this->m_sCurrentTabContainer, $this->m_sCurrentTab, $sHtml);
+	}
+	
+	public function GetCurrentTabLength($sHtml)
+	{
+		$iLength = isset($this->m_aTabs[$this->m_sCurrentTabContainer]['tabs'][$this->m_sCurrentTab]['html']) ? strlen($this->m_aTabs[$this->m_sCurrentTabContainer]['tabs'][$this->m_sCurrentTab]['html']): 0;
+		return $iLength;
+	}
+	
+	/**
+	 * Truncates the given tab to the specifed length and returns the truncated part
+	 * @param string $sTabContainer The tab container in which to truncate the tab
+	 * @param string $sTab The name/identifier of the tab to truncate
+	 * @param integer $iLength The length/offset at which to truncate the tab
+	 * @return string The truncated part
+	 */
+	public function TruncateTab($sTabContainer, $sTab, $iLength)
+	{
+		$sResult = substr($this->m_aTabs[$this->m_sCurrentTabContainer]['tabs'][$this->m_sCurrentTab]['html'], $iLength);
+		$this->m_aTabs[$this->m_sCurrentTabContainer]['tabs'][$this->m_sCurrentTab]['html'] = substr($this->m_aTabs[$this->m_sCurrentTabContainer]['tabs'][$this->m_sCurrentTab]['html'], 0, $iLength);
+		return $sResult;	
+	}
+	
+	public function TabExists($sTabContainer, $sTab)
+	{
+		return isset($this->m_aTabs[$sTabContainer]['tabs'][$sTab]);
+	}
+	
+	public function TabsContainerCount()
+	{
+		return count($this->m_aTabs);
+	}
+	
+	public function AddToTab($sTabContainer, $sTabLabel, $sHtml)
+	{
+		if (!isset($this->m_aTabs[$sTabContainer]['tabs'][$sTabLabel]))
+		{
+			// Set the content of the tab
+			$this->m_aTabs[$sTabContainer]['tabs'][$sTabLabel] = array(
+				'type' => 'html',
+				'html' => $sHtml,
+			);
+		}
+		else
+		{
+			if ($this->m_aTabs[$sTabContainer]['tabs'][$sTabLabel]['type'] != 'html')
+			{
+				throw new Exception("Cannot add HTML content to the tab '$sTabLabel' of type '{$this->m_aTabs[$sTabContainer]['tabs'][$sTabLabel]['type']}'");
+			}
+			// Append to the content of the tab
+			$this->m_aTabs[$sTabContainer]['tabs'][$sTabLabel]['html'] .= $sHtml;
+		}
+		return ''; // Nothing to add to the page for now
+	}
+
+	public function SetCurrentTabContainer($sTabContainer = '')
+	{
+		$sPreviousTabContainer = $this->m_sCurrentTabContainer;
+		$this->m_sCurrentTabContainer = $sTabContainer;
+		return $sPreviousTabContainer;
+	}
+
+	public function SetCurrentTab($sTabLabel = '')
+	{
+		$sPreviousTab = $this->m_sCurrentTab;
+		$this->m_sCurrentTab = $sTabLabel;
+		return $sPreviousTab;
+	}
+	
+	/**
+	 * Add a tab which content will be loaded asynchronously via the supplied URL
+	 * 
+	 * Limitations:
+	 * Cross site scripting is not not allowed for security reasons. Use a normal tab with an IFRAME if you want to pull content from another server.
+	 * Static content cannot be added inside such tabs.
+	 * 
+	 * @param string $sTabLabel The (localised) label of the tab
+	 * @param string $sUrl The URL to load (on the same server)
+	 * @param boolean $bCache Whether or not to cache the content of the tab once it has been loaded. flase will cause the tab to be reloaded upon each activation.
+	 * @since 2.0.3
+	 */
+	public function AddAjaxTab($sTabLabel, $sUrl, $bCache = true)
+	{
+		// Set the content of the tab
+		$this->m_aTabs[$this->m_sCurrentTabContainer]['tabs'][$sTabLabel] = array(
+			'type' => 'ajax',
+			'url' => $sUrl,
+			'cache' => $bCache,
+		);
+		return ''; // Nothing to add to the page for now
+	}
+	
+	
+	public function GetCurrentTabContainer()
+	{
+		return $this->m_sCurrentTabContainer;
+	}
+	
+	public function GetCurrentTab()
+	{
+		return $this->m_sCurrentTab;
+	}
+
+	public function RemoveTab($sTabLabel, $sTabContainer = null)
+	{
+		if ($sTabContainer == null)
+		{
+			$sTabContainer = $this->m_sCurrentTabContainer;
+		}
+		if (isset($this->m_aTabs[$sTabContainer]['tabs'][$sTabLabel]))
+		{
+			// Delete the content of the tab
+			unset($this->m_aTabs[$sTabContainer]['tabs'][$sTabLabel]);
+				
+			// If we just removed the active tab, let's reset the active tab
+			if (($this->m_sCurrentTabContainer == $sTabContainer) &&  ($this->m_sCurrentTab == $sTabLabel))
+			{
+				$this->m_sCurrentTab = '';
+			}
+		}
+	}
+
+	/**
+	 * Finds the tab whose title matches a given pattern
+	 * @return mixed The name of the tab as a string or false if not found
+	 */
+	public function FindTab($sPattern, $sTabContainer = null)
+	{
+		$return = false;
+		if ($sTabContainer == null)
+		{
+			$sTabContainer = $this->m_sCurrentTabContainer;
+		}
+		foreach($this->m_aTabs[$sTabContainer]['tabs'] as $sTabLabel => $void)
+		{
+			if (preg_match($sPattern, $sTabLabel))
+			{
+				$result = $sTabLabel;
+				break;
+			}
+		}
+		return $result;
+	}
+
+	/**
+	 * Make the given tab the active one, as if it were clicked
+	 * DOES NOT WORK: apparently in the *old* version of jquery
+	 * that we are using this is not supported... TO DO upgrade
+	 * the whole jquery bundle...
+	 */
+	public function SelectTab($sTabContainer, $sTabLabel)
+	{
+		$container_index = 0;
+		$tab_index = 0;
+		foreach($this->m_aTabs as $sCurrentTabContainerName => $aTabs)
+		{
+			if ($sTabContainer == $sCurrentTabContainerName)
+			{
+				foreach($aTabs['tabs'] as $sCurrentTabLabel => $void)
+				{
+					if ($sCurrentTabLabel == $sTabLabel)
+					{
+						break;
+					}
+					$tab_index++;
+				}
+				break;
+			}
+			$container_index++;
+		}
+		$sSelector = '#tabbedContent_'.$container_index.' > ul';
+		return "window.setTimeout(\"$('$sSelector').tabs('select', $tab_index);\", 100);"; // Let the time to the tabs widget to initialize
+	}
+	
+	public function RenderIntoContent($sContent)
+	{
+		// Render the tabs in the page (if any)
+		foreach($this->m_aTabs as $sTabContainerName => $aTabs)
+		{
+			$sTabs = '';
+			$sPrefix = $aTabs['prefix'];
+			$container_index = 0;
+			if (count($aTabs['tabs']) > 0)
+			{
+				$sTabs = "<!-- tabs -->\n<div id=\"tabbedContent_{$sPrefix}{$container_index}\" class=\"light\">\n";
+				$sTabs .= "<ul>\n";
+				// Display the unordered list that will be rendered as the tabs
+				$i = 0;
+				foreach($aTabs['tabs'] as $sTabName => $aTabData)
+				{
+					switch($aTabData['type'])
+					{
+						case 'ajax':
+						$sTabs .= "<li data-cache=\"".($aTabData['cache'] ? 'true' : 'false')."\"><a href=\"{$aTabData['url']}\" class=\"tab\"><span>".htmlentities($sTabName, ENT_QUOTES, 'UTF-8')."</span></a></li>\n";
+						break;
+						
+						case 'html':
+						default:
+						$sTabs .= "<li><a href=\"#tab_{$sPrefix}{$container_index}$i\" class=\"tab\"><span>".htmlentities($sTabName, ENT_QUOTES, 'UTF-8')."</span></a></li>\n";	
+					}
+					$i++;
+				}
+				$sTabs .= "</ul>\n";
+				// Now add the content of the tabs themselves
+				$i = 0;
+				foreach($aTabs['tabs'] as $sTabName => $aTabData)
+				{
+					switch($aTabData['type'])
+					{
+						case 'ajax':
+						// Nothing to add
+						break;
+						
+						case 'html':
+						default:
+						$sTabs .= "<div id=\"tab_{$sPrefix}{$container_index}$i\">".$aTabData['html']."</div>\n";	
+					}
+					$i++;
+				}
+				$sTabs .= "</div>\n<!-- end of tabs-->\n";
+			}
+			$sContent = str_replace("\$Tabs:$sTabContainerName\$", $sTabs, $sContent);
+			$container_index++;
+		}
+		return $sContent;
+	}
+}

application/wizardhelper.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Class WizardHelper
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/uiwizard.class.inc.php');
@@ -76,7 +77,7 @@ class WizardHelper
 							if ( isset($aLinkedObject[$sLinkedAttCode]) && ($aLinkedObject[$sLinkedAttCode] !== null) )
 							{
 								$sLinkedAttDef = MetaModel::GetAttributeDef($sLinkedClass, $sLinkedAttCode);
-								if (($sLinkedAttDef->IsExternalKey()) && ($aLinkedObject[$sLinkedAttCode] != '') && ($aLinkedObject[$sLinkedAttCode] != 0) )
+								if (($sLinkedAttDef->IsExternalKey()) && ($aLinkedObject[$sLinkedAttCode] != '') && ($aLinkedObject[$sLinkedAttCode] > 0) )
 								{
 									// For external keys: load the target object so that external fields
 									// get filled too
@@ -108,7 +109,7 @@ class WizardHelper
 						$oObj->Set($sAttCode, $oDocument);
 					}
 				}
-				else if (($oAttDef->IsExternalKey()) && (!empty($value)) )
+				else if (($oAttDef->IsExternalKey()) && (!empty($value)) && ($value > 0) )
 				{
 					// For external keys: load the target object so that external fields
 					// get filled too
@@ -260,7 +261,7 @@ class WizardHelper
 			foreach($aLinkObj as $sAttCode => $value)
 			{
 				$oAttDef = MetaModel::GetAttributeDef($sLinkClass, $sAttCode);
-				if (($oAttDef->IsExternalKey()) && ($value != '') )
+				if (($oAttDef->IsExternalKey()) && ($value != '')  && ($value > 0))
 				{
 					// For external keys: load the target object so that external fields
 					// get filled too

application/xmlpage.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2013 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Class XMLPage
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT."/application/webpage.class.inc.php");
@@ -36,65 +37,77 @@ class XMLPage extends WebPage
 	var $m_bPassThrough;
 	var $m_bHeaderSent;
 	
-    function __construct($s_title, $bPassThrough = false)
-    {
-        parent::__construct($s_title);
-        $this->m_bPassThrough = $bPassThrough;
-        $this->m_bHeaderSent = false;
-        $this->add_header("Content-type: text/xml; charset=utf-8");
+	function __construct($s_title, $bPassThrough = false)
+	{
+		parent::__construct($s_title);
+		$this->m_bPassThrough = $bPassThrough;
+		$this->m_bHeaderSent = false;
+		$this->add_header("Content-type: text/xml; charset=utf-8");
 		$this->add_header("Cache-control: no-cache");
 		$this->add_header("Content-location: export.xml");
-    }	
+	}	
 
-    public function output()
-    {
-    	if (!$this->m_bPassThrough)
-    	{
-			$this->add("<?xml version=\"1.0\" encoding=\"UTF-8\"?".">\n");
-			$this->add_header("Content-Length: ".strlen(trim($this->s_content)));
-	        foreach($this->a_headers as $s_header)
-	        {
-	            header($s_header);
-	        }
-	        echo trim($this->s_content);
-    	}
-    }
-    
-    public function add($sText)
-    {
-    	if (!$this->m_bPassThrough)
-    	{
-    		parent::add($sText);
-    	}
-    	else
-    	{
-    		if ($this->m_bHeaderSent)
-    		{
-		   		echo $sText;
-    		}
-    		else
-    		{
-		        $s_captured_output = ob_get_contents();
-		        ob_end_clean();
-		        foreach($this->a_headers as $s_header)
-		        {
-		            header($s_header);
-		        }
-				echo "<?xml version=\"1.0\" encoding=\"UTF-8\"?".">\n";
-		        echo trim($s_captured_output);
-		        echo trim($this->s_content);
-		        echo $sText;
-		        $this->m_bHeaderSent = true;
-    		}
-     	}
-    }
-
-    public function small_p($sText)
-    {
+	public function output()
+	{
+		if (!$this->m_bPassThrough)
+		{
+			$this->s_content = "<?xml version=\"1.0\" encoding=\"UTF-8\"?".">\n".trim($this->s_content);
+			$this->add_header("Content-Length: ".strlen($this->s_content));
+			foreach($this->a_headers as $s_header)
+			{
+				header($s_header);
+			}
+			echo $this->s_content;
+		}
+		if (class_exists('MetaModel'))
+		{
+			MetaModel::RecordQueryTrace();
+		}
 	}
-	
+
+	public function add($sText)
+	{
+		if (!$this->m_bPassThrough)
+		{
+			parent::add($sText);
+		}
+		else
+		{
+			if ($this->m_bHeaderSent)
+			{
+				echo $sText;
+			}
+			else
+			{
+				$s_captured_output = ob_get_contents();
+				ob_end_clean();
+				foreach($this->a_headers as $s_header)
+				{
+					header($s_header);
+				}
+				echo "<?xml version=\"1.0\" encoding=\"UTF-8\"?".">\n";
+				echo trim($s_captured_output);
+				echo trim($this->s_content);
+				echo $sText;
+				$this->m_bHeaderSent = true;
+			}
+		}
+	}
+
+	public function small_p($sText)
+	{
+	}
+
 	public function table($aConfig, $aData, $aParams = array())
 	{
 	}
+
+	public function TrashUnexpectedOutput()
+	{
+		if (!$this->m_bPassThrough)
+		{
+			parent::TrashUnexpectedOutput();
+		}
+	}
 }
 ?>

approot.inc.php

@@ -1,5 +1,9 @@
 <?php
+
 define('APPROOT', dirname(__FILE__).'/');
+define('APPCONF', APPROOT.'conf/');
+define('ITOP_DEFAULT_ENV', 'production');
+
 if (function_exists('microtime'))
 {
 	$fItopStarted = microtime(true); 

core/MyHelpers.class.inc.php

@@ -1,27 +1,28 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Various dev/debug helpers
  * TODO: cleanup or at least re-organize
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -218,7 +219,7 @@ class MyHelpers
 		}
 	}
 
-	public static function get_callstack_html($iLevelsToIgnore = 0, $aCallStack = null)
+	public static function get_callstack($iLevelsToIgnore = 0, $aCallStack = null)
 	{
 		if ($aCallStack == null) $aCallStack = debug_backtrace();
 		
@@ -230,6 +231,16 @@ class MyHelpers
 		{
 			$sLine = empty($aCallInfo['line']) ? "" : $aCallInfo['line'];
 			$sFile = empty($aCallInfo['file']) ? "" : $aCallInfo['file'];
+			if ($sFile != '')
+			{
+				$sFile = str_replace('\\', '/', $sFile);
+				$sAppRoot = str_replace('\\', '/', APPROOT);
+				$iPos = strpos($sFile, $sAppRoot);
+				if ($iPos !== false)
+				{
+					$sFile = substr($sFile, strlen($sAppRoot));
+				}
+			}
 			$sClass = empty($aCallInfo['class']) ? "" : $aCallInfo['class'];
 			$sType = empty($aCallInfo['type']) ? "" : $aCallInfo['type'];
 			$sFunction = empty($aCallInfo['function']) ? "" : $aCallInfo['function'];
@@ -258,11 +269,11 @@ class MyHelpers
 						$args .= $a;
 					break;
 						case 'string':
-						$a = Str::pure2html(self::beautifulstr($a, 1024, true, true));
+						$a = Str::pure2html(self::beautifulstr($a, 64, true, false));
 						$args .= "\"$a\"";
 						break;
 					case 'array':
-						$args .= 'Array('.count($a).')';
+						$args .= 'array('.count($a).')';
 						break;
 					case 'object':
 						$args .= 'Object('.get_class($a).')';
@@ -271,19 +282,25 @@ class MyHelpers
 						$args .= 'Resource('.strstr($a, '#').')';
 						break;
 					case 'boolean':
-						$args .= $a ? 'True' : 'False';
+						$args .= $a ? 'true' : 'false';
 						break;
 					case 'NULL':
-						$args .= 'Null';
+						$args .= 'null';
 						break;
 					default:
 						$args .= 'Unknown';
 					}
 				}
-				$sFunctionInfo = "$sClass $sType $sFunction($args)";
+				$sFunctionInfo = "$sClass$sType$sFunction($args)";
 			}
 			$aDigestCallStack[] = array('File'=>$sFile, 'Line'=>$sLine, 'Function'=>$sFunctionInfo);
 		}
+		return $aDigestCallStack;
+	}
+
+	public static function get_callstack_html($iLevelsToIgnore = 0, $aCallStack = null)
+	{
+		$aDigestCallStack = self::get_callstack($iLevelsToIgnore, $aCallStack);
 		return self::make_table_from_assoc_array($aDigestCallStack);
 	}
 
@@ -292,6 +309,17 @@ class MyHelpers
 		return self::get_callstack_html($iLevelsToIgnore, $aCallStack);
 	}
 
+	public static function get_callstack_text($iLevelsToIgnore = 0, $aCallStack = null)
+	{
+		$aDigestCallStack = self::get_callstack($iLevelsToIgnore, $aCallStack);
+		$aRes = array();
+		foreach ($aDigestCallStack as $aCall)
+		{
+			$aRes[] = $aCall['File'].' at '.$aCall['Line'].', '.$aCall['Function'];
+		}
+		return implode("\n", $aRes);
+	}
+
 	///////////////////////////////////////////////////////////////////////////////
 	// Source: New
 	// Last modif: 2004/12/20 RQU

core/action.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Persistent classes (internal): user defined actions
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -42,7 +43,7 @@ abstract class Action extends cmdbAbstractObject
 			"key_type" => "autoincrement",
 			"name_attcode" => "name",
 			"state_attcode" => "",
-			"reconc_keys" => array(),
+			"reconc_keys" => array('name'),
 			"db_table" => "priv_action",
 			"db_key_field" => "id",
 			"db_finalclass_field" => "realclass",
@@ -106,7 +107,7 @@ abstract class ActionNotification extends Action
 			"key_type" => "autoincrement",
 			"name_attcode" => "name",
 			"state_attcode" => "",
-			"reconc_keys" => array(),
+			"reconc_keys" => array('name'),
 			"db_table" => "priv_action_notification",
 			"db_key_field" => "id",
 			"db_finalclass_field" => "",
@@ -139,7 +140,7 @@ class ActionEmail extends ActionNotification
 			"key_type" => "autoincrement",
 			"name_attcode" => "name",
 			"state_attcode" => "",
-			"reconc_keys" => array(),
+			"reconc_keys" => array('name'),
 			"db_table" => "priv_action_email",
 			"db_key_field" => "id",
 			"db_finalclass_field" => "",
@@ -212,8 +213,12 @@ class ActionEmail extends ActionNotification
 		$aRecipients = array();
 		while ($oObj = $oSet->Fetch())
 		{
-			$aRecipients[] = $oObj->Get($sEmailAttCode);
-			$this->m_iRecipients++;
+			$sAddress = trim($oObj->Get($sEmailAttCode));
+			if (strlen($sAddress) > 0)
+			{
+				$aRecipients[] = $sAddress;
+				$this->m_iRecipients++;
+			}
 		}
 		return implode(', ', $aRecipients);
 	}
@@ -276,7 +281,6 @@ class ActionEmail extends ActionNotification
 	protected function _DoExecute($oTrigger, $aContextArgs, &$oLog)
 	{
 		$sPreviousUrlMaker = ApplicationContext::SetUrlMakerClass();
-		$aHeaders = array();
 		try
 		{
 			$this->m_iRecipients = 0;
@@ -289,23 +293,23 @@ class ActionEmail extends ActionNotification
 			$sCC = $this->FindRecipients('cc', $aContextArgs);
 			$sBCC = $this->FindRecipients('bcc', $aContextArgs);
 	
-			$sFrom = $this->Get('from');
-			$sReplyTo = $this->Get('reply_to');
+			$sFrom = MetaModel::ApplyParams($this->Get('from'), $aContextArgs);
+			$sReplyTo = MetaModel::ApplyParams($this->Get('reply_to'), $aContextArgs);
 	
 			$sSubject = MetaModel::ApplyParams($this->Get('subject'), $aContextArgs);
 			$sBody = MetaModel::ApplyParams($this->Get('body'), $aContextArgs);
 			
 			$oObj = $aContextArgs['this->object()'];
-			$sMessageId = sprintf('<iTop_%s_%d_%f@%s.openitop.org>', get_class($oObj), $oObj->GetKey(), microtime(true /* get as float*/), MetaModel::GetConfig()->Get('session_name'));
-			$sReference = $sMessageId;
-			$aHeaders['Message-ID'] = $sMessageId;
+			$sMessageId = sprintf('iTop_%s_%d_%f@%s.openitop.org', get_class($oObj), $oObj->GetKey(), microtime(true /* get as float*/), MetaModel::GetEnvironmentId());
+			$sReference = '<'.$sMessageId.'>';
 		}
 		catch(Exception $e)
 		{
   			ApplicationContext::SetUrlMakerClass($sPreviousUrlMaker);
   			throw $e;
   		}
-
+		ApplicationContext::SetUrlMakerClass($sPreviousUrlMaker);
+		
 		if (!is_null($oLog))
 		{
 			// Note: we have to secure this because those values are calculated
@@ -319,7 +323,7 @@ class ActionEmail extends ActionNotification
 			if (isset($sBody))     $oLog->Set('body', $sBody);
 		}
 
-		$oEmail = new EMail('', '', '', $aHeaders);
+		$oEmail = new EMail();
 
 		if ($this->IsBeingTested())
 		{
@@ -342,6 +346,7 @@ class ActionEmail extends ActionNotification
 			$oEmail->SetRecipientTO($this->Get('test_recipient'));
 			$oEmail->SetRecipientFrom($this->Get('test_recipient'));
 			$oEmail->SetReferences($sReference);
+			$oEmail->SetMessageId($sMessageId);
 		}
 		else
 		{
@@ -353,6 +358,18 @@ class ActionEmail extends ActionNotification
 			$oEmail->SetRecipientFrom($sFrom);
 			$oEmail->SetRecipientReplyTo($sReplyTo);
 			$oEmail->SetReferences($sReference);
+			$oEmail->SetMessageId($sMessageId);
+		}
+
+		if (isset($aContextArgs['attachments']))
+		{
+			$aAttachmentReport = array();
+			foreach($aContextArgs['attachments'] as $oDocument)
+			{
+				$oEmail->AddAttachment($oDocument->GetData(), $oDocument->GetFileName(), $oDocument->GetMimeType());
+				$aAttachmentReport[] = array($oDocument->GetFileName(), $oDocument->GetMimeType(), strlen($oDocument->GetData()));
+			}
+			$oLog->Set('attachments', $aAttachmentReport);
 		}
 
 		if (empty($this->m_aMailErrors))
@@ -391,4 +408,4 @@ class ActionEmail extends ActionNotification
 		}
 	}
 }
-?>
+?>

core/archive.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Utility to import/export the DB from/to a ZIP file
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 

core/asynctask.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Persistent classes (internal): user defined actions
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -33,27 +34,27 @@ class ExecAsyncTask implements iBackgroundProcess
 
 	public function Process($iTimeLimit)
 	{
-		$sOQL = "SELECT AsyncTask WHERE ISNULL(started) AND (ISNULL(planned) OR (planned < NOW()))";
-		$oSet = new CMDBObjectSet(DBObjectSearch::FromOQL($sOQL), array('created' => true) /* order by*/, array());
+		$sNow = date('Y-m-d H:i:s');
+		// Criteria: planned, and expected to occur... ASAP or in the past
+		$sOQL = "SELECT AsyncTask WHERE (status = 'planned') AND (ISNULL(planned) OR (planned < '$sNow'))";
 		$iProcessed = 0;
-		while ((time() < $iTimeLimit) && ($oTask = $oSet->Fetch()))
+		while (time() < $iTimeLimit)
 		{
-			$oTask->Set('started', time());
-			$oTask->DBUpdate();
-
-			$oTask->Process();
+			// Next one ?
+			$oSet = new CMDBObjectSet(DBObjectSearch::FromOQL($sOQL), array('created' => true) /* order by*/, array(), null, 1 /* limit count */);
+			$oTask = $oSet->Fetch();
+			if (is_null($oTask))
+			{
+				// Nothing to be done
+				break;
+			}
 			$iProcessed++;
-
-			$oTask->DBDelete();
-		}
-		if ($iProcessed == $oSet->Count())
-		{
-			return "processed $iProcessed tasks";
-		}
-		else
-		{
-			return "processed $iProcessed tasks (remaining: ".($oSet->Count() - $iProcessed).")";
+			if ($oTask->Process())
+			{
+				$oTask->DBDelete();
+			}
 		}
+		return "processed $iProcessed tasks";
 	}
 }
 
@@ -79,36 +80,141 @@ abstract class AsyncTask extends DBObject
 			"display_template" => "",
 		);
 		MetaModel::Init_Params($aParams);
-		//MetaModel::Init_InheritAttributes();
-//		MetaModel::Init_AddAttribute(new AttributeString("name", array("allowed_values"=>null, "sql"=>"name", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+
+		// Null is allowed to ease the migration from iTop 2.0.2 and earlier, when the status did not exist, and because the default value is not taken into account in the SQL definition
+		// The value is set from null to planned in the setup program
+		MetaModel::Init_AddAttribute(new AttributeEnum("status", array("allowed_values"=>new ValueSetEnum('planned,running,idle,error'), "sql"=>"status", "default_value"=>"planned", "is_null_allowed"=>true, "depends_on"=>array())));
+
 		MetaModel::Init_AddAttribute(new AttributeDateTime("created", array("allowed_values"=>null, "sql"=>"created", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
 		MetaModel::Init_AddAttribute(new AttributeDateTime("started", array("allowed_values"=>null, "sql"=>"started", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
-		// planned... still not used - reserved for timer management
 		MetaModel::Init_AddAttribute(new AttributeDateTime("planned", array("allowed_values"=>null, "sql"=>"planned", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
 		MetaModel::Init_AddAttribute(new AttributeExternalKey("event_id", array("targetclass"=>"Event", "jointype"=> "", "allowed_values"=>null, "sql"=>"event_id", "is_null_allowed"=>true, "on_target_delete"=>DEL_SILENT, "depends_on"=>array())));
 
-		// Display lists
-//		MetaModel::Init_SetZListItems('details', array()); // Attributes to be displayed for the complete details
-//		MetaModel::Init_SetZListItems('list', array()); // Attributes to be displayed for a list
-		// Search criteria
-//		MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form
-//		MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
+		MetaModel::Init_AddAttribute(new AttributeInteger("remaining_retries", array("allowed_values"=>null, "sql"=>"remaining_retries", "default_value"=>0, "is_null_allowed"=>true, "depends_on"=>array())));
+	}
+
+	/**
+	 * Every is fine
+	 */
+	const OK = 0;
+	/**
+	 * The task no longer exists
+	 */
+	const DELETED = 1;
+	/**
+	 * The task is already being executed
+	 */
+	const ALREADY_RUNNING = 2;
+
+	/**
+	 *	The current process requests the ownership on the task.
+	 *	In case the task can be accessed concurrently, this function can be overloaded to add a critical section.
+	 *	The function must not block the caller if another process is already owning the task	 
+	 *		 
+	 *	@return integer A code among OK/DELETED/ALREADY_RUNNING.	  	 
+	 */	
+	public function MarkAsRunning()
+	{
+		try
+		{
+			$this->Set('status', 'running');
+			$this->Set('started', time());
+			$this->DBUpdate();
+			return self::OK;
+		}
+		catch(Exception $e)
+		{
+			// Corrupted task !! (for example: "Failed to reload object")
+			IssueLog::Error('Failed to process async task #'.$this->GetKey().' - reason: '.$e->getMessage().' - fatal error, deleting the task.');
+		   	if ($this->Get('event_id') != 0)
+		   	{
+		   		$oEventLog = MetaModel::GetObject('Event', $this->Get('event_id'));
+		   		$oEventLog->Set('message', 'Failed, corrupted data: '.$e->getMessage());
+		   		$oEventLog->DBUpdate();
+			}
+			$this->DBDelete();
+			return self::DELETED;
+		}
+	}
+
+	public function GetRetryDelay()
+	{
+		$iRetryDelay = 600;
+		$aRetries = MetaModel::GetConfig()->Get('async_task_retries', array());
+		if (is_array($aRetries) && array_key_exists(get_class($this), $aRetries))
+		{
+			$aConfig = $aRetries[get_class($this)];
+			$iRetryDelay = $aConfig['retry_delay'];
+		}
+		return $iRetryDelay;
+	}
+
+	public function GetMaxRetries()
+	{
+		$iMaxRetries = 0;
+		$aRetries = MetaModel::GetConfig()->Get('async_task_retries', array());
+		if (is_array($aRetries) && array_key_exists(get_class($this), $aRetries))
+		{
+			$aConfig = $aRetries[get_class($this)];
+			$iMaxRetries = $aConfig['max_retries'];
+		}
 	}
 
   	protected function OnInsert()
 	{
 		$this->Set('created', time());
+		$this->Set('remaining_retries', $this->GetMaxRetries());
 	}
 
-   public function Process()
+   /**
+    * @return boolean True if the task record can be deleted
+    */
+	public function Process()
    {
-   	$sStatus = $this->DoProcess();
-   	if ($this->Get('event_id') != 0)
-   	{
-   		$oEventLog = MetaModel::GetObject('Event', $this->Get('event_id'));
-   		$oEventLog->Set('message', $sStatus);
-   		$oEventLog->DBUpdate();
+		// By default: consider that the task is not completed
+		$bRet = false;
+
+		// Attempt to take the ownership
+		$iStatus = $this->MarkAsRunning();
+		if ($iStatus == self::OK)
+		{
+			try
+			{
+		   	$sStatus = $this->DoProcess();
+		   	if ($this->Get('event_id') != 0)
+		   	{
+		   		$oEventLog = MetaModel::GetObject('Event', $this->Get('event_id'));
+		   		$oEventLog->Set('message', $sStatus);
+		   		$oEventLog->DBUpdate();
+				}
+				$bRet = true;
+			}
+			catch(Exception $e)
+			{
+				$iRemaining = $this->Get('remaining_retries');
+				if ($iRemaining > 0)
+				{
+					$iRetryDelay = $this->GetRetryDelay();
+					IssueLog::Info('Failed to process async task #'.$this->GetKey().' - reason: '.$e->getMessage().' - remaining retries: '.$iRemaining.' - next retry in '.$iRetryDelay.'s');
+	
+					$this->Set('remaining_retries', $iRemaining - 1);
+					$this->Set('status', 'planned');
+					$this->Set('started', null);
+					$this->Set('planned', time() + $iRetryDelay);
+					$this->DBUpdate();
+				}
+				else
+				{
+					IssueLog::Error('Failed to process async task #'.$this->GetKey().' - reason: '.$e->getMessage());
+				}
+			}
 		}
+		else
+		{
+			// Already done or being handled by another process... skip...
+			$bRet = false;
+		}
+		return $bRet;
 	}
 
 	abstract public function DoProcess();
@@ -138,10 +244,10 @@ class AsyncSendEmail extends AsyncTask
 		MetaModel::Init_Params($aParams);
 		MetaModel::Init_InheritAttributes();
 
-		MetaModel::Init_AddAttribute(new AttributeText("to", array("allowed_values"=>null, "sql"=>"to", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeInteger("version", array("allowed_values"=>null, "sql"=>"version", "default_value"=>Email::ORIGINAL_FORMAT, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeText("to", array("allowed_values"=>null, "sql"=>"to", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
 		MetaModel::Init_AddAttribute(new AttributeText("subject", array("allowed_values"=>null, "sql"=>"subject", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeText("body", array("allowed_values"=>null, "sql"=>"body", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeText("header", array("allowed_values"=>null, "sql"=>"header", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeLongText("message", array("allowed_values"=>null, "sql"=>"message", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
 
 		// Display lists
 //		MetaModel::Init_SetZListItems('details', array('name', 'description', 'status', 'test_recipient', 'from', 'reply_to', 'to', 'cc', 'bcc', 'subject', 'body', 'importance', 'trigger_list')); // Attributes to be displayed for the complete details
@@ -151,31 +257,42 @@ class AsyncSendEmail extends AsyncTask
 //		MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
 	}
 
-	static public function AddToQueue($sTo, $sSubject, $sBody, $aHeaders, $oLog)
+	static public function AddToQueue(EMail $oEMail, $oLog)
 	{
 		$oNew = MetaModel::NewObject(__class__);
 		if ($oLog)
 		{
 			$oNew->Set('event_id', $oLog->GetKey());
 		}
-		$oNew->Set('to', $sTo);
-		$oNew->Set('subject', $sSubject);
-		$oNew->Set('body', $sBody);
-		$sHeaders = serialize($aHeaders);
-		$oNew->Set('header', $sHeaders);
+		$oNew->Set('to', $oEMail->GetRecipientTO(true /* string */));
+		$oNew->Set('subject', $oEMail->GetSubject());
+
+//		$oNew->Set('version', 1);
+//		$sMessage = serialize($oEMail);
+		$oNew->Set('version', 2);
+		$sMessage = $oEMail->SerializeV2();
+		$oNew->Set('message', $sMessage);
 		$oNew->DBInsert();
 	}
 
 	public function DoProcess()
 	{
-		$sTo = $this->Get('to');
-		$sSubject = $this->Get('subject');
-		$sBody = $this->Get('body');
-		$sHeaders = $this->Get('header');
-		$aHeaders = unserialize($sHeaders);
-
-		$oEmail = new EMail($sTo, $sSubject, $sBody, $aHeaders);
-		$iRes = $oEmail->Send($aIssues, true /* force synchro !!!!! */);
+		$sMessage = $this->Get('message');
+		$iVersion = (int) $this->Get('version');
+		switch($iVersion)
+		{
+			case Email::FORMAT_V2:
+			$oEMail = Email::UnSerializeV2($sMessage);				
+			break;
+			
+			case Email::ORIGINAL_FORMAT:
+			$oEMail = unserialize($sMessage);				
+			break;
+			
+			default:
+			return 'Unknown version of the serialization format: '.$iVersion;				
+		}
+		$iRes = $oEMail->Send($aIssues, true /* force synchro !!!!! */);
 		switch ($iRes)
 		{
 		case EMAIL_SEND_OK:
@@ -189,4 +306,4 @@ class AsyncSendEmail extends AsyncTask
 		}
 	}
 }
-?>
+?>

core/backgroundprocess.inc.php

@@ -1,33 +1,67 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2013 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
- * Class BackgroundProcess
- * Any extension that must be called regularly to be executed in the background 
+ * interface iProcess
+ * Something that can be executed 
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
-interface iBackgroundProcess
+interface iProcess
 {
-	public function GetPeriodicity();
 	public function Process($iUnixTimeLimit);
 }
 
+/**
+ * interface iBackgroundProcess
+ * Any extension that must be called regularly to be executed in the background 
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+interface iBackgroundProcess extends iProcess
+{
+	/*
+		Gives the repetition rate in seconds
+		@returns integer
+	*/
+	public function GetPeriodicity();
+}
+
+/**
+ * interface iScheduledProcess
+ * A variant of process that must be called at specific times
+ *
+ * @copyright   Copyright (C) 2013 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+interface iScheduledProcess extends iProcess
+{
+	/*
+		Gives the exact time at which the process must be run next time
+		@returns DateTime
+	*/
+	public function GetNextOccurrence();
+}
+
 ?>

core/backgroundtask.class.inc.php

@@ -0,0 +1,76 @@
+<?php
+// Copyright (C) 2013 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+
+/**
+ * Class BackgroundTask
+ * A class to record information about the execution of background processes 
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+class BackgroundTask extends DBObject
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "core/cmdb",
+			"key_type" => "autoincrement",
+			"name_attcode" => "class_name",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_backgroundtask",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+			"display_template" => "",
+		);
+		MetaModel::Init_Params($aParams);
+
+		MetaModel::Init_AddAttribute(new AttributeString("class_name", array("allowed_values"=>null, "sql"=>"class_name", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeDateTime("first_run_date", array("allowed_values"=>null, "sql"=>"first_run_date", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeDateTime("latest_run_date", array("allowed_values"=>null, "sql"=>"latest_run_date", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeDateTime("next_run_date", array("allowed_values"=>null, "sql"=>"next_run_date", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
+		
+		MetaModel::Init_AddAttribute(new AttributeInteger("total_exec_count", array("allowed_values"=>null, "sql"=>"total_exec_count", "default_value"=>"0", "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeDecimal("latest_run_duration", array("allowed_values"=>null, "sql"=>"latest_run_duration", "digits"=> 8, "decimals"=> 3, "default_value"=>"0", "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeDecimal("min_run_duration", array("allowed_values"=>null, "sql"=>"min_run_duration", "digits"=> 8, "decimals"=> 3, "default_value"=>"0", "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeDecimal("max_run_duration", array("allowed_values"=>null, "sql"=>"max_run_duration", "digits"=> 8, "decimals"=> 3, "default_value"=>"0", "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeDecimal("average_run_duration", array("allowed_values"=>null, "sql"=>"average_run_duration", "digits"=> 8, "decimals"=> 3, "default_value"=>"0", "is_null_allowed"=>true, "depends_on"=>array())));
+
+		MetaModel::Init_AddAttribute(new AttributeBoolean("running", array("allowed_values"=>null, "sql"=>"running", "default_value"=>false, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeEnum("status", array("allowed_values"=>new ValueSetEnum('active,paused'), "sql"=>"status", "default_value"=>'active', "is_null_allowed"=>false, "depends_on"=>array())));
+	}
+	
+	public function ComputeDurations($fLatestDuration)
+	{
+		$iTotalRun = $this->Get('total_exec_count');
+		$fAverageDuration = ($this->Get('average_run_duration') * $iTotalRun + $fLatestDuration) / (1+$iTotalRun);
+		$this->Set('average_run_duration', sprintf('%.3f',$fAverageDuration));
+		$this->Set('total_exec_count', 1+$iTotalRun);
+		if ($fLatestDuration < $this->Get('min_run_duration'))
+		{
+			$this->Set('min_run_duration', sprintf('%.3f',$fLatestDuration));
+		}
+		if ($fLatestDuration > $this->Get('max_run_duration'))
+		{
+			$this->Set('max_run_duration', sprintf('%.3f',$fLatestDuration));
+		}
+		$this->Set('latest_run_duration', sprintf('%.3f',$fLatestDuration));
+	}
+}

core/bulkchange.class.inc.php

@@ -1,29 +1,34 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2013 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Bulk change facility (common to interactive and batch usages)
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
+// The BOM is added at the head of exported UTF-8 CSV data, and removed (if present) from input UTF-8 data.
+// This helps MS-Excel (Version > 2007, Windows only) in changing its interpretation of a CSV file (by default Excel reads data as ISO-8859-1 -not 100% sure!)
+define('UTF8_BOM', chr(239).chr(187).chr(191)); // 0xEF, 0xBB, 0xBF
+
 /**
  * BulkChange
  * Interpret a given data set and update the DB accordingly (fake mode avail.) 
@@ -84,15 +89,16 @@ class CellStatus_Modify extends CellChangeSpec
 {
 	protected $m_previousValue;
 
-	public function __construct($proposedValue, $previousValue)
+	public function __construct($proposedValue, $previousValue = null)
 	{
-		$this->m_previousValue = $previousValue;
+		// Unused (could be costly to know -see the case of reconciliation on ext keys)
+		//$this->m_previousValue = $previousValue;
 		parent::__construct($proposedValue);
 	}
 
 	public function GetDescription()
 	{
-		return 'Modified';
+		return Dict::S('UI:CSVReport-Value-Modified');
 	}
 
 	//public function GetPreviousValue()
@@ -115,9 +121,9 @@ class CellStatus_Issue extends CellStatus_Modify
 	{
 		if (is_null($this->m_proposedValue))
 		{
-			return 'Could not be changed - reason: '.$this->m_sReason;
+			return Dict::Format('UI:CSVReport-Value-SetIssue', $this->m_sReason);
 		}
-		return 'Could not be changed to '.$this->m_proposedValue.' - reason: '.$this->m_sReason;
+		return Dict::Format('UI:CSVReport-Value-ChangeIssue', $this->m_proposedValue, $this->m_sReason);
 	}
 }
 
@@ -130,7 +136,7 @@ class CellStatus_SearchIssue extends CellStatus_Issue
 
 	public function GetDescription()
 	{
-		return 'No match';
+		return Dict::S('UI:CSVReport-Value-NoMatch');
 	}
 }
 
@@ -143,7 +149,7 @@ class CellStatus_NullIssue extends CellStatus_Issue
 
 	public function GetDescription()
 	{
-		return 'Missing mandatory value';
+		return Dict::S('UI:CSVReport-Value-Missing');
 	}
 }
 
@@ -162,7 +168,7 @@ class CellStatus_Ambiguous extends CellStatus_Issue
 	public function GetDescription()
 	{
 		$sCount = $this->m_iCount;
-		return "Ambiguous: found $sCount objects";
+		return Dict::Format('UI:CSVReport-Value-Ambiguous', $sCount);
 	}
 }
 
@@ -186,7 +192,7 @@ class RowStatus_NoChange extends RowStatus
 {
 	public function GetDescription()
 	{
-		return "unchanged";
+		return Dict::S('UI:CSVReport-Row-Unchanged');
 	}
 }
 
@@ -194,7 +200,7 @@ class RowStatus_NewObj extends RowStatus
 {
 	public function GetDescription()
 	{
-		return "created";
+		return Dict::S('UI:CSVReport-Row-Created');
 	}
 }
 
@@ -209,7 +215,7 @@ class RowStatus_Modify extends RowStatus
 
 	public function GetDescription()
 	{
-		return "updated ".$this->m_iChanged." cols";
+		return Dict::Format('UI:CSVReport-Row-Updated', $this->m_iChanged);
 	}
 }
 
@@ -217,7 +223,7 @@ class RowStatus_Disappeared extends RowStatus_Modify
 {
 	public function GetDescription()
 	{
-		return "disappeared, changed ".$this->m_iChanged." cols";
+		return Dict::Format('UI:CSVReport-Row-Disappeared', $this->m_iChanged);
 	}
 }
 
@@ -232,7 +238,7 @@ class RowStatus_Issue extends RowStatus
 
 	public function GetDescription()
 	{
-		return 'Issue: '.$this->m_sReason;
+		return Dict::Format('UI:CSVReport-Row-Issue', $this->m_sReason);
 	}
 }
 
@@ -253,8 +259,10 @@ class BulkChange
 	protected $m_sSynchroScope; // OQL - if specified, then the missing items will be reported
 	protected $m_aOnDisappear; // array of attcode => value, values to be set when an object gets out of scope (ignored if no scope has been defined)
 	protected $m_sDateFormat; // Date format specification, see utils::StringToTime()
+	protected $m_bLocalizedValues; // Values in the data set are localized (see AttributeEnum)
+	protected $m_aExtKeysMappingCache; // Cache for resolving external keys based on the given search criterias
 
-	public function __construct($sClass, $aData, $aAttList, $aExtKeys, $aReconcilKeys, $sSynchroScope = null, $aOnDisappear = null, $sDateFormat = null)
+	public function __construct($sClass, $aData, $aAttList, $aExtKeys, $aReconcilKeys, $sSynchroScope = null, $aOnDisappear = null, $sDateFormat = null, $bLocalize = false)
 	{
 		$this->m_sClass = $sClass;
 		$this->m_aData = $aData;
@@ -264,6 +272,8 @@ class BulkChange
 		$this->m_sSynchroScope = $sSynchroScope;
 		$this->m_aOnDisappear = $aOnDisappear;
 		$this->m_sDateFormat = $sDateFormat;
+		$this->m_bLocalizedValues = $bLocalize;
+		$this->m_aExtKeysMappingCache = array();
 	}
 
 	protected $m_bReportHtml = false;
@@ -288,8 +298,17 @@ class BulkChange
 		$oReconFilter = new CMDBSearchFilter($oExtKey->GetTargetClass());
 		foreach ($this->m_aExtKeys[$sAttCode] as $sForeignAttCode => $iCol)
 		{
-			// The foreign attribute is one of our reconciliation key
-			$oReconFilter->AddCondition($sForeignAttCode, $aRowData[$iCol], '=');
+			if ($sForeignAttCode == 'id')
+			{
+				$value = (int) $aRowData[$iCol];
+			}
+			else
+			{
+				// The foreign attribute is one of our reconciliation key
+				$oForeignAtt = MetaModel::GetAttributeDef($oExtKey->GetTargetClass(), $sForeignAttCode);
+				$value = $oForeignAtt->MakeValueFromString($aRowData[$iCol], $this->m_bLocalizedValues);
+			}
+			$oReconFilter->AddCondition($sForeignAttCode, $value, '=');
 			$aResults[$iCol] = new CellStatus_Void($aRowData[$iCol]);
 		}
 
@@ -331,6 +350,7 @@ class BulkChange
 			{
 				foreach ($aKeyConfig as $sForeignAttCode => $iCol)
 				{
+					// Default reporting
 					$aResults[$iCol] = new CellStatus_Void($aRowData[$iCol]);
 				}
 				if ($oExtKey->IsNullAllowed())
@@ -340,34 +360,80 @@ class BulkChange
 				}
 				else
 				{
-					$aErrors[$sAttCode] = "Null not allowed";
-					$aResults[$sAttCode]= new CellStatus_Issue(null, $oTargetObj->Get($sAttCode), 'Null not allowed');
+					$aErrors[$sAttCode] = Dict::S('UI:CSVReport-Value-Issue-Null');
+					$aResults[$sAttCode]= new CellStatus_Issue(null, $oTargetObj->Get($sAttCode), Dict::S('UI:CSVReport-Value-Issue-Null'));
 				}
 			}
 			else
 			{
 				$oReconFilter = new CMDBSearchFilter($oExtKey->GetTargetClass());
+				$aCacheKeys = array();
 				foreach ($aKeyConfig as $sForeignAttCode => $iCol)
 				{
 					// The foreign attribute is one of our reconciliation key
-					$oReconFilter->AddCondition($sForeignAttCode, $aRowData[$iCol], '=');
+					if ($sForeignAttCode == 'id')
+					{
+						$value = $aRowData[$iCol];
+					}
+					else
+					{
+						$oForeignAtt = MetaModel::GetAttributeDef($oExtKey->GetTargetClass(), $sForeignAttCode);
+						$value = $oForeignAtt->MakeValueFromString($aRowData[$iCol], $this->m_bLocalizedValues);
+					}
+					$aCacheKeys[] = $value;
+					$oReconFilter->AddCondition($sForeignAttCode, $value, '=');
 					$aResults[$iCol] = new CellStatus_Void($aRowData[$iCol]);
 				}
-				$oExtObjects = new CMDBObjectSet($oReconFilter);
-				switch($oExtObjects->Count())
+				$sCacheKey = implode('_|_', $aCacheKeys); // Unique key for this query...
+				$iCount = 0;
+				$iForeignKey = null;
+				$sOQL = '';
+				// TODO: check if *too long* keys can lead to collisions... and skip the cache in such a case...
+				if (!array_key_exists($sAttCode, $this->m_aExtKeysMappingCache))
 				{
-				case 0:
-					$aErrors[$sAttCode] = "Object not found";
+					$this->m_aExtKeysMappingCache[$sAttCode] = array();
+				}
+				if (array_key_exists($sCacheKey, $this->m_aExtKeysMappingCache[$sAttCode]))
+				{
+					// Cache hit
+					$iCount = $this->m_aExtKeysMappingCache[$sAttCode][$sCacheKey]['c'];
+					$iForeignKey = $this->m_aExtKeysMappingCache[$sAttCode][$sCacheKey]['k'];
+					$sOQL = $this->m_aExtKeysMappingCache[$sAttCode][$sCacheKey]['oql'];
+					// Record the hit
+					$this->m_aExtKeysMappingCache[$sAttCode][$sCacheKey]['h']++;
+				}
+				else
+				{
+					// Cache miss, let's initialize it
+					$oExtObjects = new CMDBObjectSet($oReconFilter);
+					$iCount = $oExtObjects->Count();
+					if ($iCount == 1)
+					{
+						$oForeignObj = $oExtObjects->Fetch();
+						$iForeignKey = $oForeignObj->GetKey();
+					}
+					$this->m_aExtKeysMappingCache[$sAttCode][$sCacheKey] = array(
+						'c' => $iCount,
+						'k' => $iForeignKey,
+						'oql' => $oReconFilter->ToOql(),
+						'h' => 0, // number of hits on this cache entry
+					);
+				}
+				switch($iCount)
+				{
+					case 0:
+					$aErrors[$sAttCode] = Dict::S('UI:CSVReport-Value-Issue-NotFound');
 					$aResults[$sAttCode]= new CellStatus_SearchIssue();
 					break;
-				case 1:
+					
+					case 1:
 					// Do change the external key attribute
-					$oForeignObj = $oExtObjects->Fetch();
-					$oTargetObj->Set($sAttCode, $oForeignObj->GetKey());
+					$oTargetObj->Set($sAttCode, $iForeignKey);
 					break;
-				default:
-					$aErrors[$sAttCode] = "Found ".$oExtObjects->Count()." matches";
-					$aResults[$sAttCode]= new CellStatus_Ambiguous($oTargetObj->Get($sAttCode), $oExtObjects->Count(), $oReconFilter->ToOql());
+					
+					default:
+					$aErrors[$sAttCode] = Dict::Format('UI:CSVReport-Value-Issue-FoundMany', $oExtObjects->Count());
+					$aResults[$sAttCode]= new CellStatus_Ambiguous($oTargetObj->Get($sAttCode), $iCount, $sOQL);
 				}
 			}
 
@@ -384,6 +450,11 @@ class BulkChange
 					else
 					{
 						$aResults[$sAttCode]= new CellStatus_Modify($iForeignObj, $oTargetObj->GetOriginal($sAttCode));
+						foreach ($aKeyConfig as $sForeignAttCode => $iCol)
+						{
+							// Report the change on reconciliation values as well
+							$aResults[$iCol] = new CellStatus_Modify($aRowData[$iCol]);
+						}
 					}
 				}
 				else
@@ -401,29 +472,43 @@ class BulkChange
 			if ($sAttCode == 'id') continue;
 
 			$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
-			if ($oAttDef->IsLinkSet() && $oAttDef->IsIndirect())
+			$aReasons = array();
+			$iFlags = $oTargetObj->GetAttributeFlags($sAttCode, $aReasons);
+			if ( (($iFlags & OPT_ATT_READONLY) == OPT_ATT_READONLY) && ( $oTargetObj->Get($sAttCode) != $aRowData[$iCol]) )
+			{
+					$aErrors[$sAttCode] = Dict::Format('UI:CSVReport-Value-Issue-Readonly', $sAttCode, $oTargetObj->Get($sAttCode), $aRowData[$iCol]);
+			}
+			else if ($oAttDef->IsLinkSet() && $oAttDef->IsIndirect())
 			{
 				try
 				{
-					$oSet = $oAttDef->MakeValueFromString($aRowData[$iCol]);
+					$oSet = $oAttDef->MakeValueFromString($aRowData[$iCol], $this->m_bLocalizedValues);
 					$oTargetObj->Set($sAttCode, $oSet);
 				}
 				catch(CoreException $e)
 				{
-					$aErrors[$sAttCode] = "Failed to process input: ".$e->getMessage();
+					$aErrors[$sAttCode] = Dict::Format('UI:CSVReport-Value-Issue-Format', $e->getMessage());
 				}
 			}
 			else
 			{
-				$res = $oTargetObj->CheckValue($sAttCode, $aRowData[$iCol]);
-				if ($res === true)
+				$value = $oAttDef->MakeValueFromString($aRowData[$iCol], $this->m_bLocalizedValues);
+				if (is_null($value) && (strlen($aRowData[$iCol]) > 0))
 				{
-					$oTargetObj->Set($sAttCode, $aRowData[$iCol]);
+					$aErrors[$sAttCode] = Dict::Format('UI:CSVReport-Value-Issue-NoMatch', $sAttCode);
 				}
 				else
 				{
-					// $res is a string with the error description
-					$aErrors[$sAttCode] = "Unexpected value for attribute '$sAttCode': $res";
+					$res = $oTargetObj->CheckValue($sAttCode, $value);
+					if ($res === true)
+					{
+						$oTargetObj->Set($sAttCode, $value);
+					}
+					else
+					{
+						// $res is a string with the error description
+						$aErrors[$sAttCode] = Dict::Format('UI:CSVReport-Value-Issue-Unknown', $sAttCode, $res);
+					}
 				}
 			}
 		}
@@ -441,17 +526,19 @@ class BulkChange
 			{
 				if ($this->m_bReportHtml)
 				{
-					$sCurValue = $oTargetObj->GetAsHTML($sAttCode);
-					$sOrigValue = $oTargetObj->GetOriginalAsHTML($sAttCode);
+					$sCurValue = $oTargetObj->GetAsHTML($sAttCode, $this->m_bLocalizedValues);
+					$sOrigValue = $oTargetObj->GetOriginalAsHTML($sAttCode, $this->m_bLocalizedValues);
+					$sInput = htmlentities($aRowData[$iCol], ENT_QUOTES, 'UTF-8');
 				}
 				else
 				{
-					$sCurValue = $oTargetObj->GetAsCSV($sAttCode, $this->m_sReportCsvSep, $this->m_sReportCsvDelimiter);
-					$sOrigValue = $oTargetObj->GetOriginalAsCSV($sAttCode, $this->m_sReportCsvSep, $this->m_sReportCsvDelimiter);
+					$sCurValue = $oTargetObj->GetAsCSV($sAttCode, $this->m_sReportCsvSep, $this->m_sReportCsvDelimiter, $this->m_bLocalizedValues);
+					$sOrigValue = $oTargetObj->GetOriginalAsCSV($sAttCode, $this->m_sReportCsvSep, $this->m_sReportCsvDelimiter, $this->m_bLocalizedValues);
+					$sInput = $aRowData[$iCol];
 				}
 				if (isset($aErrors[$sAttCode]))
 				{
-					$aResults[$iCol]= new CellStatus_Issue($sCurValue, $sOrigValue, $aErrors[$sAttCode]);
+					$aResults[$iCol]= new CellStatus_Issue($aRowData[$iCol], $sOrigValue, $aErrors[$sAttCode]);
 				}
 				elseif (array_key_exists($sAttCode, $aChangedFields))
 				{
@@ -478,7 +565,7 @@ class BulkChange
 		if ($res !== true)
 		{
 			// $res contains the error description
-			$aErrors["GLOBAL"] = "Attributes not consistent with each others: $res";
+			$aErrors["GLOBAL"] = Dict::Format('UI:CSVReport-Row-Issue-Inconsistent', $res);
 		}
 		return $aResults;
 	}
@@ -542,7 +629,7 @@ class BulkChange
 		if ($res !== true)
 		{
 			// $res contains the error description
-			$aErrors["GLOBAL"] = "Attributes not consistent with each others: $res";
+			$aErrors["GLOBAL"] = Dict::Format('UI:CSVReport-Row-Issue-Inconsistent', $res);
 		}
 		return $aResults;
 	}
@@ -556,7 +643,7 @@ class BulkChange
 		if (count($aErrors) > 0)
 		{
 			$sErrors = implode(', ', $aErrors);
-			$aResult[$iRow]["__STATUS__"] = new RowStatus_Issue("Unexpected attribute value(s)");
+			$aResult[$iRow]["__STATUS__"] = new RowStatus_Issue(Dict::S('UI:CSVReport-Row-Issue-Attribute'));
 			return $oTargetObj;
 		}
 	
@@ -575,7 +662,7 @@ class BulkChange
 		if (count($aMissingKeys) > 0)
 		{
 			$sMissingKeys = implode(', ', $aMissingKeys);
-			$aResult[$iRow]["__STATUS__"] = new RowStatus_Issue("Could not be created, due to missing external key(s): $sMissingKeys");
+			$aResult[$iRow]["__STATUS__"] = new RowStatus_Issue(Dict::Format('UI:CSVReport-Row-Issue-MissingExtKey', $sMissingKeys));
 			return $oTargetObj;
 		}
 	
@@ -609,7 +696,7 @@ class BulkChange
 		if (count($aErrors) > 0)
 		{
 			$sErrors = implode(', ', $aErrors);
-			$aResult[$iRow]["__STATUS__"] = new RowStatus_Issue("Unexpected attribute value(s)");
+			$aResult[$iRow]["__STATUS__"] = new RowStatus_Issue(Dict::S('UI:CSVReport-Row-Issue-Attribute'));
 			return;
 		}
 	
@@ -650,7 +737,7 @@ class BulkChange
 		if (count($aErrors) > 0)
 		{
 			$sErrors = implode(', ', $aErrors);
-			$aResult[$iRow]["__STATUS__"] = new RowStatus_Issue("Unexpected attribute value(s)");
+			$aResult[$iRow]["__STATUS__"] = new RowStatus_Issue(Dict::S('UI:CSVReport-Row-Issue-Attribute'));
 			return;
 		}
 	
@@ -726,8 +813,8 @@ class BulkChange
 						else
 						{
 							// Leave the cell unchanged
-							$aResult[$iRow]["__STATUS__"]= new RowStatus_Issue("wrong date format");
-							$aResult[$iRow][$sAttCode] = new CellStatus_Issue(null, $this->m_aData[$iRow][$iCol], 'Wrong date format');
+							$aResult[$iRow]["__STATUS__"]= new RowStatus_Issue(Dict::S('UI:CSVReport-Row-Issue-DateFormat'));
+							$aResult[$iRow][$sAttCode] = new CellStatus_Issue(null, $this->m_aData[$iRow][$iCol], Dict::S('UI:CSVReport-Row-Issue-DateFormat'));
 						}
 					}
 				}
@@ -740,98 +827,116 @@ class BulkChange
 		{
 			$aVisited = array();
 		}
+		$iPreviousTimeLimit = ini_get('max_execution_time');
+		$iLoopTimeLimit = MetaModel::GetConfig()->Get('max_execution_time_per_loop');
 		foreach($this->m_aData as $iRow => $aRowData)
 		{
+			set_time_limit($iLoopTimeLimit);
 			if (isset($aResult[$iRow]["__STATUS__"]))
 			{
 				// An issue at the earlier steps - skip the rest
 				continue;
 			}
-			$oReconciliationFilter = new CMDBSearchFilter($this->m_sClass);
-			$bSkipQuery = false;
-			foreach($this->m_aReconcilKeys as $sAttCode)
+			try
 			{
-				$valuecondition = null;
-				if (array_key_exists($sAttCode, $this->m_aExtKeys))
+				$oReconciliationFilter = new CMDBSearchFilter($this->m_sClass);
+				$bSkipQuery = false;
+				foreach($this->m_aReconcilKeys as $sAttCode)
 				{
-					if ($this->IsNullExternalKeySpec($aRowData, $sAttCode))
+					$valuecondition = null;
+					if (array_key_exists($sAttCode, $this->m_aExtKeys))
 					{
-						$oExtKey = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
-						if ($oExtKey->IsNullAllowed())
+						if ($this->IsNullExternalKeySpec($aRowData, $sAttCode))
 						{
-							$valuecondition = $oExtKey->GetNullValue();
-							$aResult[$iRow][$sAttCode] = new CellStatus_Void($oExtKey->GetNullValue());
+							$oExtKey = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
+							if ($oExtKey->IsNullAllowed())
+							{
+								$valuecondition = $oExtKey->GetNullValue();
+								$aResult[$iRow][$sAttCode] = new CellStatus_Void($oExtKey->GetNullValue());
+							}
+							else
+							{
+								$aResult[$iRow][$sAttCode] = new CellStatus_NullIssue();
+							}
 						}
 						else
 						{
-							$aResult[$iRow][$sAttCode] = new CellStatus_NullIssue();
-						}
+							// The value has to be found or verified
+							list($sQuery, $aMatches) = $this->ResolveExternalKey($aRowData, $sAttCode, $aResult[$iRow]);
+		
+							if (count($aMatches) == 1)
+							{
+								$oRemoteObj = reset($aMatches); // first item
+								$valuecondition = $oRemoteObj->GetKey();
+								$aResult[$iRow][$sAttCode] = new CellStatus_Void($oRemoteObj->GetKey());
+							} 					
+							elseif (count($aMatches) == 0)
+							{
+								$aResult[$iRow][$sAttCode] = new CellStatus_SearchIssue();
+							} 					
+							else
+							{
+								$aResult[$iRow][$sAttCode] = new CellStatus_Ambiguous(null, count($aMatches), $sQuery);
+							}
+						} 					
 					}
 					else
 					{
-						// The value has to be found or verified
-						list($sQuery, $aMatches) = $this->ResolveExternalKey($aRowData, $sAttCode, $aResult[$iRow]);
-	
-						if (count($aMatches) == 1)
+						// The value is given in the data row
+						$iCol = $this->m_aAttList[$sAttCode];
+						if ($sAttCode == 'id')
 						{
-							$oRemoteObj = reset($aMatches); // first item
-							$valuecondition = $oRemoteObj->GetKey();
-							$aResult[$iRow][$sAttCode] = new CellStatus_Void($oRemoteObj->GetKey());
-						} 					
-						elseif (count($aMatches) == 0)
-						{
-							$aResult[$iRow][$sAttCode] = new CellStatus_SearchIssue();
-						} 					
+							$valuecondition = $aRowData[$iCol];
+						}
 						else
 						{
-							$aResult[$iRow][$sAttCode] = new CellStatus_Ambiguous(null, count($aMatches), $sQuery);
+							$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
+							$valuecondition = $oAttDef->MakeValueFromString($aRowData[$iCol], $this->m_bLocalizedValues);
 						}
-					} 					
-				}
-				else
-				{
-					// The value is given in the data row
-					$iCol = $this->m_aAttList[$sAttCode];
-					$valuecondition = $aRowData[$iCol];
-				}
-				if (is_null($valuecondition))
-				{
-					$bSkipQuery = true;
-				}
-				else
-				{
-					$oReconciliationFilter->AddCondition($sAttCode, $valuecondition, '=');
-				}
-			}
-			if ($bSkipQuery)
-			{
-				$aResult[$iRow]["__STATUS__"]= new RowStatus_Issue("failed to reconcile");
-			}
-			else
-			{
-				$oReconciliationSet = new CMDBObjectSet($oReconciliationFilter);
-				switch($oReconciliationSet->Count())
-				{
-				case 0:
-					$oTargetObj = $this->CreateObject($aResult, $iRow, $aRowData, $oChange);
-					// $aResult[$iRow]["__STATUS__"]=> set in CreateObject
-					$aVisited[] = $oTargetObj->GetKey();
-					break;
-				case 1:
-					$oTargetObj = $oReconciliationSet->Fetch();
-					$this->UpdateObject($aResult, $iRow, $oTargetObj, $aRowData, $oChange);
-					// $aResult[$iRow]["__STATUS__"]=> set in UpdateObject
-					if (!is_null($this->m_sSynchroScope))
-					{
-						$aVisited[] = $oTargetObj->GetKey();
 					}
-					break;
-				default:
-					// Found several matches, ambiguous
-					$aResult[$iRow]["__STATUS__"]= new RowStatus_Issue("ambiguous reconciliation");
-					$aResult[$iRow]["id"]= new CellStatus_Ambiguous(0, $oReconciliationSet->Count(), $oReconciliationFilter->ToOql());
-					$aResult[$iRow]["finalclass"]= 'n/a';
+					if (is_null($valuecondition))
+					{
+						$bSkipQuery = true;
+					}
+					else
+					{
+						$oReconciliationFilter->AddCondition($sAttCode, $valuecondition, '=');
+					}
 				}
+				if ($bSkipQuery)
+				{
+					$aResult[$iRow]["__STATUS__"]= new RowStatus_Issue(Dict::S('UI:CSVReport-Row-Issue-Reconciliation'));
+				}
+				else
+				{
+					$oReconciliationSet = new CMDBObjectSet($oReconciliationFilter);
+					switch($oReconciliationSet->Count())
+					{
+					case 0:
+						$oTargetObj = $this->CreateObject($aResult, $iRow, $aRowData, $oChange);
+						// $aResult[$iRow]["__STATUS__"]=> set in CreateObject
+						$aVisited[] = $oTargetObj->GetKey();
+						break;
+					case 1:
+						$oTargetObj = $oReconciliationSet->Fetch();
+						$this->UpdateObject($aResult, $iRow, $oTargetObj, $aRowData, $oChange);
+						// $aResult[$iRow]["__STATUS__"]=> set in UpdateObject
+						if (!is_null($this->m_sSynchroScope))
+						{
+							$aVisited[] = $oTargetObj->GetKey();
+						}
+						break;
+					default:
+						// Found several matches, ambiguous
+						$aResult[$iRow]["__STATUS__"]= new RowStatus_Issue(Dict::S('UI:CSVReport-Row-Issue-Ambiguous'));
+						$aResult[$iRow]["id"]= new CellStatus_Ambiguous(0, $oReconciliationSet->Count(), $oReconciliationFilter->ToOql());
+						$aResult[$iRow]["finalclass"]= 'n/a';
+					}
+				}
+			}
+			catch (Exception $e)
+			{
+				$aResult[$iRow]["__STATUS__"]= new RowStatus_Issue(Dict::Format('UI:CSVReport-Row-Issue-Internal', get_class($e), $e->getMessage()));
 			}
 		}
 
@@ -845,11 +950,13 @@ class BulkChange
 				$iObj = $oObj->GetKey();
 				if (!in_array($iObj, $aVisited))
 				{
+					set_time_limit($iLoopTimeLimit);
 					$iRow++;
 					$this->UpdateMissingObject($aResult, $iRow, $oObj, $oChange);
 				}
 			}
 		}
+		set_time_limit($iPreviousTimeLimit);
 
 		// Fill in the blanks - the result matrix is expected to be 100% complete
 		//
@@ -893,22 +1000,22 @@ class BulkChange
 			$oPage->add('<div id="'.$sAjaxDivId.'">');
 		}
 
-		$oPage->p(Dict::S('UI:History:BulkImports+'));
+		$oPage->p(Dict::S('UI:History:BulkImports+').' <span id="csv_history_reload"></span>');
 
-		$oBulkChangeSearch = DBObjectSearch::FromOQL("SELECT CMDBChange WHERE userinfo LIKE '%(CSV)'");
+		$oBulkChangeSearch = DBObjectSearch::FromOQL("SELECT CMDBChange WHERE origin IN ('csv-interactive', 'csv-import.php')");
 
-		$iQueryLimit = $bShowAll ? 0 : MetaModel::GetConfig()->GetMaxDisplayLimit() + 1;
+		$iQueryLimit = $bShowAll ? 0 : appUserPreferences::GetPref('default_page_size', MetaModel::GetConfig()->GetMinDisplayLimit());
 		$oBulkChanges = new DBObjectSet($oBulkChangeSearch, array('date' => false), array(), null, $iQueryLimit);
 
 		$oAppContext = new ApplicationContext();
 
 		$bLimitExceeded = false;
-		if ($oBulkChanges->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit())
+		if ($oBulkChanges->Count() > (appUserPreferences::GetPref('default_page_size', MetaModel::GetConfig()->GetMinDisplayLimit())))
 		{
 			$bLimitExceeded = true;
 			if (!$bShowAll)
 			{
-				$iMaxObjects = MetaModel::GetConfig()->GetMinDisplayLimit();
+				$iMaxObjects = appUserPreferences::GetPref('default_page_size', MetaModel::GetConfig()->GetMinDisplayLimit());
 				$oBulkChanges->SetLimit($iMaxObjects);
 			}
 		}
@@ -917,7 +1024,7 @@ class BulkChange
 		$aDetails = array();
 		while ($oChange = $oBulkChanges->Fetch())
 		{
-			$sDate = '<a href="?step=10&changeid='.$oChange->GetKey().'&'.$oAppContext->GetForLink().'">'.$oChange->Get('date').'</a>';
+			$sDate = '<a href="csvimport.php?step=10&changeid='.$oChange->GetKey().'&'.$oAppContext->GetForLink().'">'.$oChange->Get('date').'</a>';
 			$sUser = $oChange->GetUserName();
 			if (preg_match('/^(.*)\\(CSV\\)$/i', $oChange->Get('userinfo'), $aMatches))
 			{
@@ -961,7 +1068,6 @@ class BulkChange
 			{
 				$aDetails[] = array('date' => $sDate, 'user' => $sUser, 'class' => $sClass, 'created' => $iCreated, 'modified' => $iModified);
 			}
-
 		}
 
 		$aConfig = array( 'date' => array('label' => Dict::S('UI:History:Date'), 'description' => Dict::S('UI:History:Date+')),
@@ -981,7 +1087,7 @@ class BulkChange
 			else
 			{
 				// Truncated list
-				$iMinDisplayLimit = MetaModel::GetConfig()->GetMinDisplayLimit();
+				$iMinDisplayLimit = appUserPreferences::GetPref('default_page_size', MetaModel::GetConfig()->GetMinDisplayLimit());
 				$sCollapsedLabel = Dict::Format('UI:TruncatedResults', $iMinDisplayLimit, $oBulkChanges->Count());
 				$sLinkLabel = Dict::S('UI:DisplayAll');
 				$oPage->add('<p>'.$sCollapsedLabel.'&nbsp;&nbsp;<a class="truncated" onclick="OnTruncatedHistoryToggle(true);">'.$sLinkLabel.'</p>');
@@ -999,6 +1105,7 @@ EOF
 <<<EOF
 	function OnTruncatedHistoryToggle(bShowAll)
 	{
+		$('#csv_history_reload').html('<img src="../images/indicator.gif"/>');
 		$.get(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php?{$sAppContext}', {operation: 'displayCSVHistory', showall: bShowAll}, function(data)
 			{
 				$('#$sAjaxDivId').html(data);
@@ -1160,49 +1267,6 @@ EOF
 		}
 		$oPage->table($aConfig, $aDetails);
 	}	
-
-	/**
-	 * Get the user friendly name for an 'extended' attribute code i.e 'name', becomes 'Name' and 'org_id->name' becomes 'Organization->Name'
-	 * @param string $sClassName The name of the class
-	 * @param string $sAttCodeEx Either an attribute code or ext_key_name->att_code
-	 * @return string A user friendly format of the string: AttributeName or AttributeName->ExtAttributeName
-	 */
-	public static function GetFriendlyAttCodeName($sClassName, $sAttCodeEx)
-	{
-		$sFriendlyName = '';
-		if (preg_match('/(.+)->(.+)/', $sAttCodeEx, $aMatches) > 0)
-		{
-			$sAttribute = $aMatches[1];
-			$sField = $aMatches[2];
-			$oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttribute);
-			if ($oAttDef->IsExternalKey())
-			{
-				$sTargetClass = $oAttDef->GetTargetClass();
-				$oTargetAttDef = MetaModel::GetAttributeDef($sTargetClass, $sField);
-				$sFriendlyName = $oAttDef->GetLabel().'->'.$oTargetAttDef->GetLabel();
-			}
-			else
-			{
-				 // hum, hum... should never happen, we'd better raise an exception
-				 throw(new Exception(Dict::Format('UI:CSVImport:ErrorExtendedAttCode', $sAttCodeEx, $sAttribute, $sClassName)));
-			}
-	
-		}
-		else
-		{
-			if ($sAttCodeEx == 'id')
-			{
-				$sFriendlyName = Dict::S('UI:CSVImport:idField');
-			}
-			else
-			{
-				$oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCodeEx);
-				$sFriendlyName = $oAttDef->GetLabel();
-			}
-		}
-		return $sFriendlyName;
-	}
-	
 }
 
 

core/cmdbchange.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Persistent class (internal) cmdbChange
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -43,11 +44,15 @@ class CMDBChange extends DBObject
 			"db_table" => "priv_change",
 			"db_key_field" => "id",
 			"db_finalclass_field" => "",
+			'indexes' => array(
+				array('origin'),
+			)
 		);
 		MetaModel::Init_Params($aParams);
 		//MetaModel::Init_InheritAttributes();
 		MetaModel::Init_AddAttribute(new AttributeDateTime("date", array("allowed_values"=>null, "sql"=>"date", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
 		MetaModel::Init_AddAttribute(new AttributeString("userinfo", array("allowed_values"=>null, "sql"=>"userinfo", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeEnum("origin", array("allowed_values"=>new ValueSetEnum('interactive,csv-interactive,csv-import.php,webservice-soap,webservice-rest,synchro-data-source,email-processing,custom-extension'), "sql"=>"origin", "default_value"=>"interactive", "is_null_allowed"=>true, "depends_on"=>array())));
 	}
 
 	// Helper to keep track of the author of a given change,

core/cmdbchangeop.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2013 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Persistent classes (internal) : cmdbChangeOp and derived
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -44,6 +45,9 @@ class CMDBChangeOp extends DBObject
 			"db_table" => "priv_changeop",
 			"db_key_field" => "id",
 			"db_finalclass_field" => "optype",
+			'indexes' => array(
+				array('objclass', 'objkey'),
+			)
 		);
 		MetaModel::Init_Params($aParams);
 		//MetaModel::Init_InheritAttributes();
@@ -64,6 +68,19 @@ class CMDBChangeOp extends DBObject
 	{
 		return '';
 	}
+
+	/**
+	 * Safety net: in case the change is not given, let's guarantee that it will
+	 * be set to the current ongoing change (or create a new one)	
+	 */	
+	protected function OnInsert()
+	{
+		if ($this->Get('change') <= 0)
+		{
+			$this->Set('change', CMDBObject::GetCurrentChange());
+		}
+		parent::OnInsert();
+	}
 }
 
 
@@ -124,6 +141,11 @@ class CMDBChangeOpDelete extends CMDBChangeOp
 		);
 		MetaModel::Init_Params($aParams);
 		MetaModel::Init_InheritAttributes();
+
+		// Final class of the object (objclass must be set to the root class for efficiency purposes)
+		MetaModel::Init_AddAttribute(new AttributeString("fclass", array("allowed_values"=>null, "sql"=>"fclass", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
+		// Last friendly name of the object
+		MetaModel::Init_AddAttribute(new AttributeString("fname", array("allowed_values"=>null, "sql"=>"fname", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
 	}
 	/**
 	 * Describe (as a text string) the modifications corresponding to this change
@@ -200,9 +222,6 @@ class CMDBChangeOpSetAttributeScalar extends CMDBChangeOpSetAttribute
 	 */	 
 	public function GetDescription()
 	{
-		// Temporary, until we change the options of GetDescription() -needs a more global revision
-		$bIsHtml = true;
-		
 		$sResult = '';
 		$oTargetObjectClass = $this->Get('objclass');
 		$oTargetObjectKey = $this->Get('objkey');
@@ -218,76 +237,7 @@ class CMDBChangeOpSetAttributeScalar extends CMDBChangeOpSetAttribute
 			$sAttName = $oAttDef->GetLabel();
 			$sNewValue = $this->Get('newvalue');
 			$sOldValue = $this->Get('oldvalue');
-			if ($oAttDef instanceof AttributeEnum)
-			{
-				// translate the enum values
-				$sOldValue = $oAttDef->GetAsHTML($sOldValue);
-				$sNewValue = $oAttDef->GetAsHTML($sNewValue);
-				if (strlen($sOldValue) == 0)
-				{
-					$sResult = Dict::Format('Change:AttName_SetTo', $sAttName, $sNewValue);
-				}
-				else
-				{
-					$sResult = Dict::Format('Change:AttName_SetTo_NewValue_PreviousValue_OldValue', $sAttName, $sNewValue, $sOldValue);
-				}				
-			}
-			elseif ( (($oAttDef->GetType() == 'String') || ($oAttDef->GetType() == 'Text')) &&
-				 (strlen($sNewValue) > strlen($sOldValue)) )
-			{
-				// Check if some text was not appended to the field
-				if (substr($sNewValue,0, strlen($sOldValue)) == $sOldValue) // Text added at the end
-				{
-					$sDelta = substr($sNewValue, strlen($sOldValue));
-					$sResult = Dict::Format('Change:Text_AppendedTo_AttName', $sDelta, $sAttName);
-				}
-				else if (substr($sNewValue, -strlen($sOldValue)) == $sOldValue)   // Text added at the beginning
-				{
-					$sDelta = substr($sNewValue, 0, strlen($sNewValue) - strlen($sOldValue));
-					$sResult = Dict::Format('Change:Text_AppendedTo_AttName', $sDelta, $sAttName);
-				}
-				else
-				{
-					if (strlen($sOldValue) == 0)
-					{
-						$sResult = Dict::Format('Change:AttName_SetTo', $sAttName, $sNewValue);
-					}
-					else
-					{
-						$sResult = Dict::Format('Change:AttName_SetTo_NewValue_PreviousValue_OldValue', $sAttName, $sNewValue, $sOldValue);
-					}
-				}
-			}
-			elseif($bIsHtml && $oAttDef->IsExternalKey())
-			{
-				$sTargetClass = $oAttDef->GetTargetClass();
-				$sFrom = MetaModel::GetHyperLink($sTargetClass, $sOldValue);
-				$sTo = MetaModel::GetHyperLink($sTargetClass, $sNewValue);
-				$sResult = "$sAttName set to $sTo (previous: $sFrom)";
-				if (strlen($sFrom) == 0)
-				{
-					$sResult = Dict::Format('Change:AttName_SetTo', $sAttName, $sTo);
-				}
-				else
-				{
-					$sResult = Dict::Format('Change:AttName_SetTo_NewValue_PreviousValue_OldValue', $sAttName, $sTo, $sFrom);
-				}
-			}
-			elseif ($oAttDef instanceOf AttributeBlob)
-			{
-				$sResult = "#@# Issue... found an attribute for which other type of tracking should be made";
-			}
-			else
-			{
-				if (strlen($sOldValue) == 0)
-				{
-					$sResult = Dict::Format('Change:AttName_SetTo', $sAttName, $sNewValue);
-				}
-				else
-				{
-					$sResult = Dict::Format('Change:AttName_SetTo_NewValue_PreviousValue_OldValue', $sAttName, $sNewValue, $sOldValue);
-				}
-			}
+			$sResult = $oAttDef->GetAsHTMLForHistory($sOldValue, $sNewValue);
 		}
 		return $sResult;
 	}
@@ -339,8 +289,16 @@ class CMDBChangeOpSetAttributeBlob extends CMDBChangeOpSetAttribute
 		$oMonoObjectSet = new DBObjectSet($oTargetSearch);
 		if (UserRights::IsActionAllowedOnAttribute($this->Get('objclass'), $this->Get('attcode'), UR_ACTION_READ, $oMonoObjectSet) == UR_ALLOWED_YES)
 		{
-			$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
-			$sAttName = $oAttDef->GetLabel();
+			if (MetaModel::IsValidAttCode($this->Get('objclass'), $this->Get('attcode')))
+			{
+				$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
+				$sAttName = $oAttDef->GetLabel();
+			}
+			else
+			{
+				// The attribute was renamed or removed from the object ?
+				$sAttName = $this->Get('attcode');
+			}
 			$oPrevDoc = $this->Get('prevdata');
 			$sDocView = $oPrevDoc->GetAsHtml();
 			$sDocView .= "<br/>".Dict::Format('UI:OpenDocumentInNewWindow_',$oPrevDoc->GetDisplayLink(get_class($this), $this->GetKey(), 'prevdata')).", \n";
@@ -395,8 +353,16 @@ class CMDBChangeOpSetAttributeOneWayPassword extends CMDBChangeOpSetAttribute
 		$oMonoObjectSet = new DBObjectSet($oTargetSearch);
 		if (UserRights::IsActionAllowedOnAttribute($this->Get('objclass'), $this->Get('attcode'), UR_ACTION_READ, $oMonoObjectSet) == UR_ALLOWED_YES)
 		{
-			$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
-			$sAttName = $oAttDef->GetLabel();
+			if (MetaModel::IsValidAttCode($this->Get('objclass'), $this->Get('attcode')))
+			{
+				$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
+				$sAttName = $oAttDef->GetLabel();
+			}
+			else
+			{
+				// The attribute was renamed or removed from the object ?
+				$sAttName = $this->Get('attcode');
+			}
 			$sResult = Dict::Format('Change:AttName_Changed', $sAttName);
 		}
 		return $sResult;
@@ -447,8 +413,16 @@ class CMDBChangeOpSetAttributeEncrypted extends CMDBChangeOpSetAttribute
 		$oMonoObjectSet = new DBObjectSet($oTargetSearch);
 		if (UserRights::IsActionAllowedOnAttribute($this->Get('objclass'), $this->Get('attcode'), UR_ACTION_READ, $oMonoObjectSet) == UR_ALLOWED_YES)
 		{
-			$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
-			$sAttName = $oAttDef->GetLabel();
+			if (MetaModel::IsValidAttCode($this->Get('objclass'), $this->Get('attcode')))
+			{
+				$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
+				$sAttName = $oAttDef->GetLabel();
+			}
+			else
+			{
+				// The attribute was renamed or removed from the object ?
+				$sAttName = $this->Get('attcode');
+			}
 			$sPrevString = $this->Get('prevstring');
 			$sResult = Dict::Format('Change:AttName_Changed_PreviousValue_OldValue', $sAttName, $sPrevString);
 		}
@@ -502,8 +476,81 @@ class CMDBChangeOpSetAttributeText extends CMDBChangeOpSetAttribute
 		$oMonoObjectSet = new DBObjectSet($oTargetSearch);
 		if (UserRights::IsActionAllowedOnAttribute($this->Get('objclass'), $this->Get('attcode'), UR_ACTION_READ, $oMonoObjectSet) == UR_ALLOWED_YES)
 		{
-			$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
-			$sAttName = $oAttDef->GetLabel();
+			if (MetaModel::IsValidAttCode($this->Get('objclass'), $this->Get('attcode')))
+			{
+				$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
+				$sAttName = $oAttDef->GetLabel();
+			}
+			else
+			{
+				// The attribute was renamed or removed from the object ?
+				$sAttName = $this->Get('attcode');
+			}
+			$sTextView = '<div>'.$this->GetAsHtml('prevdata').'</div>';
+
+			//$sDocView = $oPrevDoc->GetDisplayInline(get_class($this), $this->GetKey(), 'prevdata');
+			$sResult = Dict::Format('Change:AttName_Changed_PreviousValue_OldValue', $sAttName, $sTextView);
+		}
+		return $sResult;
+	}
+}
+
+/**
+ * Record the modification of a multiline string (text)
+ *
+ * @package     iTopORM
+ */
+class CMDBChangeOpSetAttributeLongText extends CMDBChangeOpSetAttribute
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "core/cmdb",
+			"key_type" => "",
+			"name_attcode" => "change",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_changeop_setatt_longtext",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_InheritAttributes();
+		MetaModel::Init_AddAttribute(new AttributeLongText("prevdata", array("allowed_values"=>null, "sql"=>"prevdata", "default_value"=>"", "is_null_allowed"=>true, "depends_on"=>array())));
+
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('date', 'userinfo', 'attcode')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('date', 'userinfo', 'attcode')); // Attributes to be displayed for a list
+	}
+	
+	/**
+	 * Describe (as a text string) the modifications corresponding to this change
+	 */	 
+	public function GetDescription()
+	{
+		// Temporary, until we change the options of GetDescription() -needs a more global revision
+		$bIsHtml = true;
+		
+		$sResult = '';
+		$oTargetObjectClass = $this->Get('objclass');
+		$oTargetObjectKey = $this->Get('objkey');
+		$oTargetSearch = new DBObjectSearch($oTargetObjectClass);
+		$oTargetSearch->AddCondition('id', $oTargetObjectKey, '=');
+
+		$oMonoObjectSet = new DBObjectSet($oTargetSearch);
+		if (UserRights::IsActionAllowedOnAttribute($this->Get('objclass'), $this->Get('attcode'), UR_ACTION_READ, $oMonoObjectSet) == UR_ALLOWED_YES)
+		{
+			if (MetaModel::IsValidAttCode($this->Get('objclass'), $this->Get('attcode')))
+			{
+				$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
+				$sAttName = $oAttDef->GetLabel();
+			}
+			else
+			{
+				// The attribute was renamed or removed from the object ?
+				$sAttName = $this->Get('attcode');
+			}
 			$sTextView = '<div>'.$this->GetAsHtml('prevdata').'</div>';
 
 			//$sDocView = $oPrevDoc->GetDisplayInline(get_class($this), $this->GetKey(), 'prevdata');
@@ -562,8 +609,16 @@ class CMDBChangeOpSetAttributeCaseLog extends CMDBChangeOpSetAttribute
 		$oMonoObjectSet = new DBObjectSet($oTargetSearch);
 		if (UserRights::IsActionAllowedOnAttribute($this->Get('objclass'), $this->Get('attcode'), UR_ACTION_READ, $oMonoObjectSet) == UR_ALLOWED_YES)
 		{
-			$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
-			$sAttName = $oAttDef->GetLabel();
+			if (MetaModel::IsValidAttCode($this->Get('objclass'), $this->Get('attcode')))
+			{
+				$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
+				$sAttName = $oAttDef->GetLabel();
+			}
+			else
+			{
+				// The attribute was renamed or removed from the object ?
+				$sAttName = $this->Get('attcode');
+			}
 			$sResult = Dict::Format('Change:AttName_EntryAdded', $sAttName);
 		}
 		return $sResult;
@@ -607,4 +662,185 @@ class CMDBChangeOpPlugin extends CMDBChangeOp
 		return $this->Get('description');
 	}
 }
+
+/**
+ * Record added/removed objects from within a link set 
+ *
+ * @package     iTopORM
+ */
+abstract class CMDBChangeOpSetAttributeLinks extends CMDBChangeOpSetAttribute
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "core/cmdb",
+			"key_type" => "",
+			"name_attcode" => "change",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_changeop_links",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_InheritAttributes();
+
+		// Note: item class/id points to the link class itself in case of a direct link set (e.g. Server::interface_list => Interface)
+		//       item class/id points to the remote class in case of a indirect link set (e.g. Server::contract_list => Contract)
+		MetaModel::Init_AddAttribute(new AttributeString("item_class", array("allowed_values"=>null, "sql"=>"item_class", "default_value"=>'', "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeInteger("item_id", array("allowed_values"=>null, "sql"=>"item_id", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
+	}
+}
+
+/**
+ * Record added/removed objects from within a link set 
+ *
+ * @package     iTopORM
+ */
+class CMDBChangeOpSetAttributeLinksAddRemove extends CMDBChangeOpSetAttributeLinks
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "core/cmdb",
+			"key_type" => "",
+			"name_attcode" => "change",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_changeop_links_addremove",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_InheritAttributes();
+
+		MetaModel::Init_AddAttribute(new AttributeEnum("type", array("allowed_values"=>new ValueSetEnum('added,removed'), "sql"=>"type", "default_value"=>"added", "is_null_allowed"=>false, "depends_on"=>array())));
+	}
+
+	/**
+	 * Describe (as a text string) the modifications corresponding to this change
+	 */	 
+	public function GetDescription()
+	{
+		$sResult = '';
+		$oTargetObjectClass = $this->Get('objclass');
+		$oTargetObjectKey = $this->Get('objkey');
+		$oTargetSearch = new DBObjectSearch($oTargetObjectClass);
+		$oTargetSearch->AddCondition('id', $oTargetObjectKey, '=');
+
+		$oMonoObjectSet = new DBObjectSet($oTargetSearch);
+		if (UserRights::IsActionAllowedOnAttribute($this->Get('objclass'), $this->Get('attcode'), UR_ACTION_READ, $oMonoObjectSet) == UR_ALLOWED_YES)
+		{
+			if (!MetaModel::IsValidAttCode($this->Get('objclass'), $this->Get('attcode'))) return ''; // Protects against renamed attributes...
+
+			$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
+			$sAttName = $oAttDef->GetLabel();
+
+			$sItemDesc = MetaModel::GetHyperLink($this->Get('item_class'), $this->Get('item_id'));
+
+			$sResult = $sAttName.' - ';
+			switch ($this->Get('type'))
+			{
+			case 'added':
+				$sResult .= Dict::Format('Change:LinkSet:Added', $sItemDesc);
+				break;
+
+			case 'removed':
+				$sResult .= Dict::Format('Change:LinkSet:Removed', $sItemDesc);
+				break;
+			}
+		}
+		return $sResult;
+	}
+}
+
+/**
+ * Record attribute changes from within a link set
+ * A single record redirects to the modifications made within the same change  
+ *
+ * @package     iTopORM
+ */
+class CMDBChangeOpSetAttributeLinksTune extends CMDBChangeOpSetAttributeLinks
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "core/cmdb",
+			"key_type" => "",
+			"name_attcode" => "change",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_changeop_links_tune",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_InheritAttributes();
+
+		MetaModel::Init_AddAttribute(new AttributeInteger("link_id", array("allowed_values"=>null, "sql"=>"link_id", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
+	}
+
+	/**
+	 * Describe (as a text string) the modifications corresponding to this change
+	 */	 
+	public function GetDescription()
+	{
+		$sResult = '';
+		$oTargetObjectClass = $this->Get('objclass');
+		$oTargetObjectKey = $this->Get('objkey');
+		$oTargetSearch = new DBObjectSearch($oTargetObjectClass);
+		$oTargetSearch->AddCondition('id', $oTargetObjectKey, '=');
+
+		$oMonoObjectSet = new DBObjectSet($oTargetSearch);
+		if (UserRights::IsActionAllowedOnAttribute($this->Get('objclass'), $this->Get('attcode'), UR_ACTION_READ, $oMonoObjectSet) == UR_ALLOWED_YES)
+		{
+			if (!MetaModel::IsValidAttCode($this->Get('objclass'), $this->Get('attcode'))) return ''; // Protects against renamed attributes...
+
+			$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
+			$sAttName = $oAttDef->GetLabel();
+
+			$sLinkClass = $oAttDef->GetLinkedClass();
+			$aLinkClasses = MetaModel::EnumChildClasses($sLinkClass, ENUM_CHILD_CLASSES_ALL);
+
+			// Search for changes on the corresponding link
+			//
+			$oSearch = new DBObjectSearch('CMDBChangeOpSetAttribute');
+			$oSearch->AddCondition('change', $this->Get('change'), '=');
+			$oSearch->AddCondition('objkey', $this->Get('link_id'), '=');
+			if (count($aLinkClasses) == 1)
+			{
+				// Faster than the whole building of the expression below for just one value ??
+				$oSearch->AddCondition('objclass', $sLinkClass, '=');
+			}
+			else
+			{
+				$oField = new FieldExpression('objclass',  $oSearch->GetClassAlias());
+				$sListExpr = '('.implode(', ', CMDBSource::Quote($aLinkClasses)).')';
+				$sOQLCondition = $oField->Render()." IN $sListExpr";
+				$oNewCondition = Expression::FromOQL($sOQLCondition);
+				$oSearch->AddConditionExpression($oNewCondition);
+			}
+			$oSet = new DBObjectSet($oSearch);
+			$aChanges = array();
+			while ($oChangeOp = $oSet->Fetch())
+			{
+				$aChanges[] = $oChangeOp->GetDescription();
+			}
+			if (count($aChanges) == 0)
+			{
+				return '';
+			}
+
+			$sItemDesc = MetaModel::GetHyperLink($this->Get('item_class'), $this->Get('item_id'));
+
+			$sResult = $sAttName.' - ';
+			$sResult .= Dict::Format('Change:LinkSet:Modified', $sItemDesc);
+			$sResult .= ' : '.implode(', ', $aChanges);
+		}
+		return $sResult;
+	}
+}
 ?>

core/cmdbobject.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Class cmdbObject
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -91,47 +92,174 @@ abstract class CMDBObject extends DBObject
 	protected $m_datUpdated;
 	// Note: this value is static, but that could be changed because it is sometimes a real issue (see update of interfaces / connected_to
 	protected static $m_oCurrChange = null;
-
-
-	private function RecordObjCreation(CMDBChange $oChange)
+	protected static $m_sInfo = null; // null => the information is built in a standard way
+	protected static $m_sOrigin = null; // null => the origin is 'interactive'
+	
+	/**
+	 * Specify another change (this is mainly for backward compatibility)
+	 */
+	public static function SetCurrentChange(CMDBChange $oChange)
 	{
+		self::$m_oCurrChange = $oChange;
+	}
+
+	//
+	// Todo: simplify the APIs and do not pass the current change as an argument anymore
+	//       SetTrackInfo to be invoked in very few cases (UI.php, CSV import, Data synchro)
+	//       SetCurrentChange is an alternative to SetTrackInfo (csv ?)
+	//			GetCurrentChange to be called ONCE (!) by CMDBChangeOp::OnInsert ($this->Set('change', ..GetCurrentChange())
+	//			GetCurrentChange to create a default change if not already done in the current context
+	//
+	/**
+	 * Get a change record (create it if not existing)	 
+	 */
+	public static function GetCurrentChange($bAutoCreate = true)
+	{
+		if ($bAutoCreate && is_null(self::$m_oCurrChange))
+		{
+			self::CreateChange();
+		}
+		return self::$m_oCurrChange;
+	}
+
+	/**
+	 * Override the additional information (defaulting to user name)
+	 * A call to this verb should replace every occurence of
+	 *    $oMyChange = MetaModel::NewObject("CMDBChange");	  	 
+	 *    $oMyChange->Set("date", time());
+	 *    $oMyChange->Set("userinfo", 'this is done by ... for ...');
+	 *    $iChangeId = $oMyChange->DBInsert();
+	 */	 	
+	public static function SetTrackInfo($sInfo)
+	{
+		self::$m_sInfo = $sInfo;
+	}
+
+	/**
+	 * Provides information about the origin of the change
+	 * @param $sOrigin String: one of: interactive, csv-interactive, csv-import.php, webservice-soap, webservice-rest, syncho-data-source, email-processing, custom-extension
+	 */	 	
+	public static function SetTrackOrigin($sOrigin)
+	{
+		self::$m_sOrigin = $sOrigin;
+	}
+	
+	/**
+	 * Get the additional information (defaulting to user name)
+	 */	 	
+	protected static function GetTrackInfo()
+	{
+		if (is_null(self::$m_sInfo))
+		{
+			return CMDBChange::GetCurrentUserName();
+		}
+		else
+		{
+			return self::$m_sInfo;
+		}
+	}
+	
+	/**
+	 * Get the 'origin' information (defaulting to 'interactive')
+	 */	 	
+	protected static function GetTrackOrigin()
+	{
+		if (is_null(self::$m_sOrigin))
+		{
+			return 'interactive';
+		}
+		else
+		{
+			return self::$m_sOrigin;
+		}
+	}
+	
+	/**
+	 * Create a standard change record (done here 99% of the time, and nearly once per page)
+	 */	 	
+	protected static function CreateChange()
+	{
+		self::$m_oCurrChange = MetaModel::NewObject("CMDBChange");
+		self::$m_oCurrChange->Set("date", time());
+		self::$m_oCurrChange->Set("userinfo", self::GetTrackInfo());
+		self::$m_oCurrChange->Set("origin", self::GetTrackOrigin());
+		self::$m_oCurrChange->DBInsert();
+	}
+
+	protected function RecordObjCreation()
+	{
+		// Delete any existing change tracking about the current object (IDs can be reused due to InnoDb bug; see TRAC #886)
+		//
+		// 1 - remove the deletion record(s)
+		// Note that objclass contain the ROOT class
+		$oFilter = new DBObjectSearch('CMDBChangeOpDelete');
+		$oFilter->AddCondition('objclass', MetaModel::GetRootClass(get_class($this)), '=');
+		$oFilter->AddCondition('objkey', $this->GetKey(), '=');
+		MetaModel::PurgeData($oFilter);
+		// 2 - any other change tracking information left prior to 2.0.3 (when the purge of the history has been implemented in RecordObjDeletion
+		// In that case, objclass is the final class of the object
+		$oFilter = new DBObjectSearch('CMDBChangeOp');
+		$oFilter->AddCondition('objclass', get_class($this), '=');
+		$oFilter->AddCondition('objkey', $this->GetKey(), '=');
+		MetaModel::PurgeData($oFilter);
+
+		parent::RecordObjCreation();
 		$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpCreate");
-		$oMyChangeOp->Set("change", $oChange->GetKey());
 		$oMyChangeOp->Set("objclass", get_class($this));
 		$oMyChangeOp->Set("objkey", $this->GetKey());
 		$iId = $oMyChangeOp->DBInsertNoReload();
 	}
-	private function RecordObjDeletion(CMDBChange $oChange, $objkey)
+
+	protected function RecordObjDeletion($objkey)
 	{
+		$sRootClass = MetaModel::GetRootClass(get_class($this));
+
+		// Delete any existing change tracking about the current object
+		$oFilter = new DBObjectSearch('CMDBChangeOp');
+		$oFilter->AddCondition('objclass', get_class($this), '=');
+		$oFilter->AddCondition('objkey', $objkey, '=');
+		MetaModel::PurgeData($oFilter);
+
+		parent::RecordObjDeletion($objkey);
 		$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpDelete");
-		$oMyChangeOp->Set("change", $oChange->GetKey());
-		$oMyChangeOp->Set("objclass", get_class($this));
+		$oMyChangeOp->Set("objclass", MetaModel::GetRootClass(get_class($this)));
 		$oMyChangeOp->Set("objkey", $objkey);
+		$oMyChangeOp->Set("fclass", get_class($this));
+		$oMyChangeOp->Set("fname", substr($this->GetRawName(), 0, 255)); // Protect against very long friendly names
 		$iId = $oMyChangeOp->DBInsertNoReload();
 	}
-	private function RecordAttChanges(CMDBChange $oChange, array $aValues, array $aOrigValues)
+
+	protected function RecordAttChanges(array $aValues, array $aOrigValues)
 	{
+		parent::RecordAttChanges($aValues, $aOrigValues);
+
 		// $aValues is an array of $sAttCode => $value
 		//
 		foreach ($aValues as $sAttCode=> $value)
 		{
 			$oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
-			if ($oAttDef->IsLinkSet()) continue; // #@# temporary
+			if ($oAttDef->IsExternalField()) continue;
+			if ($oAttDef->IsLinkSet()) continue;
+			if ($oAttDef->GetTrackingLevel() == ATTRIBUTE_TRACKING_NONE) continue;
+
+			if (array_key_exists($sAttCode, $aOrigValues))
+			{
+				$original = $aOrigValues[$sAttCode];
+			}
+			else
+			{
+				$original = null;
+			}
 
 			if ($oAttDef instanceOf AttributeOneWayPassword)
 			{
 				// One Way encrypted passwords' history is stored -one way- encrypted
 				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeOneWayPassword");
-				$oMyChangeOp->Set("change", $oChange->GetKey());
 				$oMyChangeOp->Set("objclass", get_class($this));
 				$oMyChangeOp->Set("objkey", $this->GetKey());
 				$oMyChangeOp->Set("attcode", $sAttCode);
 
-				if (array_key_exists($sAttCode, $aOrigValues))
-				{
-					$original = $aOrigValues[$sAttCode];
-				}
-				else
+				if (is_null($original))
 				{
 					$original = '';
 				}
@@ -142,16 +270,11 @@ abstract class CMDBObject extends DBObject
 			{
 				// Encrypted string history is stored encrypted
 				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeEncrypted");
-				$oMyChangeOp->Set("change", $oChange->GetKey());
 				$oMyChangeOp->Set("objclass", get_class($this));
 				$oMyChangeOp->Set("objkey", $this->GetKey());
 				$oMyChangeOp->Set("attcode", $sAttCode);
 
-				if (array_key_exists($sAttCode, $aOrigValues))
-				{
-					$original = $aOrigValues[$sAttCode];
-				}
-				else
+				if (is_null($original))
 				{
 					$original = '';
 				}
@@ -162,26 +285,46 @@ abstract class CMDBObject extends DBObject
 			{
 				// Data blobs
 				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeBlob");
-				$oMyChangeOp->Set("change", $oChange->GetKey());
 				$oMyChangeOp->Set("objclass", get_class($this));
 				$oMyChangeOp->Set("objkey", $this->GetKey());
 				$oMyChangeOp->Set("attcode", $sAttCode);
 
-				if (array_key_exists($sAttCode, $aOrigValues))
-				{
-					$original = $aOrigValues[$sAttCode];
-				}
-				else
+				if (is_null($original))
 				{
 					$original = new ormDocument();
 				}
 				$oMyChangeOp->Set("prevdata", $original);
 				$iId = $oMyChangeOp->DBInsertNoReload();
 			}
+			elseif ($oAttDef instanceOf AttributeStopWatch)
+			{
+				// Stop watches - record changes for sub items only (they are visible, the rest is not visible)
+				//
+				if (is_null($original))
+				{
+					$original = new OrmStopWatch();
+				}
+				foreach ($oAttDef->ListSubItems() as $sSubItemAttCode => $oSubItemAttDef)
+				{
+					$item_value = $oSubItemAttDef->GetValue($value);
+					$item_original = $oSubItemAttDef->GetValue($original);
+
+					if ($item_value != $item_original)
+					{
+						$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeScalar");
+						$oMyChangeOp->Set("objclass", get_class($this));
+						$oMyChangeOp->Set("objkey", $this->GetKey());
+						$oMyChangeOp->Set("attcode", $sSubItemAttCode);
+		
+						$oMyChangeOp->Set("oldvalue", $item_original);
+						$oMyChangeOp->Set("newvalue", $item_value);
+						$iId = $oMyChangeOp->DBInsertNoReload();
+					}
+				}
+			}
 			elseif ($oAttDef instanceOf AttributeCaseLog)
 			{
 				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeCaseLog");
-				$oMyChangeOp->Set("change", $oChange->GetKey());
 				$oMyChangeOp->Set("objclass", get_class($this));
 				$oMyChangeOp->Set("objkey", $this->GetKey());
 				$oMyChangeOp->Set("attcode", $sAttCode);
@@ -189,49 +332,67 @@ abstract class CMDBObject extends DBObject
 				$oMyChangeOp->Set("lastentry", $value->GetLatestEntryIndex());
 				$iId = $oMyChangeOp->DBInsertNoReload();
 			}
-			elseif ($oAttDef instanceOf AttributeText)
+			elseif ($oAttDef instanceOf AttributeLongText)
 			{
 				// Data blobs
-				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeText");
-				$oMyChangeOp->Set("change", $oChange->GetKey());
+				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeLongText");
 				$oMyChangeOp->Set("objclass", get_class($this));
 				$oMyChangeOp->Set("objkey", $this->GetKey());
 				$oMyChangeOp->Set("attcode", $sAttCode);
 
-				if (array_key_exists($sAttCode, $aOrigValues))
+				if (!is_null($original) && ($original instanceof ormCaseLog))
 				{
-					$original = $aOrigValues[$sAttCode];
-					if ($original instanceof ormCaseLog)
-					{
-						$original = $original->GetText();
-					}
-				}
-				else
-				{
-					$original = null;
+					$original = $original->GetText();
 				}
 				$oMyChangeOp->Set("prevdata", $original);
 				$iId = $oMyChangeOp->DBInsertNoReload();
 			}
+			elseif ($oAttDef instanceOf AttributeText)
+			{
+				// Data blobs
+				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeText");
+				$oMyChangeOp->Set("objclass", get_class($this));
+				$oMyChangeOp->Set("objkey", $this->GetKey());
+				$oMyChangeOp->Set("attcode", $sAttCode);
+
+				if (!is_null($original) && ($original instanceof ormCaseLog))
+				{
+					$original = $original->GetText();
+				}
+				$oMyChangeOp->Set("prevdata", $original);
+				$iId = $oMyChangeOp->DBInsertNoReload();
+			}
+			elseif ($oAttDef instanceOf AttributeBoolean)
+			{
+				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeScalar");
+				$oMyChangeOp->Set("objclass", get_class($this));
+				$oMyChangeOp->Set("objkey", $this->GetKey());
+				$oMyChangeOp->Set("attcode", $sAttCode);
+				$oMyChangeOp->Set("oldvalue", $original ? 1 : 0);
+				$oMyChangeOp->Set("newvalue", $value ? 1 : 0);
+				$iId = $oMyChangeOp->DBInsertNoReload();
+			}
+			elseif ($oAttDef instanceOf AttributeHierarchicalKey)
+			{
+				// Hierarchical keys
+				//
+				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeScalar");
+				$oMyChangeOp->Set("objclass", get_class($this));
+				$oMyChangeOp->Set("objkey", $this->GetKey());
+				$oMyChangeOp->Set("attcode", $sAttCode);
+				$oMyChangeOp->Set("oldvalue", $original);
+				$oMyChangeOp->Set("newvalue", $value[$sAttCode]);
+				$iId = $oMyChangeOp->DBInsertNoReload();
+			}
 			else
 			{
 				// Scalars
 				//
 				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeScalar");
-				$oMyChangeOp->Set("change", $oChange->GetKey());
 				$oMyChangeOp->Set("objclass", get_class($this));
 				$oMyChangeOp->Set("objkey", $this->GetKey());
 				$oMyChangeOp->Set("attcode", $sAttCode);
-
-				if (array_key_exists($sAttCode, $aOrigValues))
-				{
-					$sOriginalValue = $aOrigValues[$sAttCode];
-				}
-				else
-				{
-					$sOriginalValue = 'undefined';
-				}
-				$oMyChangeOp->Set("oldvalue", $sOriginalValue);
+				$oMyChangeOp->Set("oldvalue", $original);
 				$oMyChangeOp->Set("newvalue", $value);
 				$iId = $oMyChangeOp->DBInsertNoReload();
 			}
@@ -269,32 +430,24 @@ abstract class CMDBObject extends DBObject
 
 	public function DBInsert()
 	{
-		if(!is_object(self::$m_oCurrChange))
-		{
-			throw new CoreException("DBInsert() could not be used here, please use DBInsertTracked() instead");
-		}
 		return $this->DBInsertTracked_Internal();
 	}
 
 	public function DBInsertTracked(CMDBChange $oChange, $bSkipStrongSecurity = null)
 	{
+		self::SetCurrentChange($oChange);
 		$this->CheckUserRights($bSkipStrongSecurity, UR_ACTION_MODIFY);
 
-		$oPreviousChange = self::$m_oCurrChange;
-		self::$m_oCurrChange = $oChange;
 		$ret = $this->DBInsertTracked_Internal();
-		self::$m_oCurrChange = $oPreviousChange;
 		return $ret;
 	}
 
 	public function DBInsertTrackedNoReload(CMDBChange $oChange, $bSkipStrongSecurity = null)
 	{
+		self::SetCurrentChange($oChange);
 		$this->CheckUserRights($bSkipStrongSecurity, UR_ACTION_MODIFY);
 
-		$oPreviousChange = self::$m_oCurrChange;
-		self::$m_oCurrChange = $oChange;
 		$ret = $this->DBInsertTracked_Internal(true);
-		self::$m_oCurrChange = $oPreviousChange;
 		return $ret;
 	}
 
@@ -308,25 +461,18 @@ abstract class CMDBObject extends DBObject
 		{
 			$ret = parent::DBInsert();
 		}
-		$this->RecordObjCreation(self::$m_oCurrChange);
 		return $ret;
 	}
 
 	public function DBClone($newKey = null)
 	{
-		if(!self::$m_oCurrChange)
-		{
-			throw new CoreException("DBClone() could not be used here, please use DBCloneTracked() instead");
-		}
 		return $this->DBCloneTracked_Internal();
 	}
 
 	public function DBCloneTracked(CMDBChange $oChange, $newKey = null)
 	{
-		$oPreviousChange = self::$m_oCurrChange;
-		self::$m_oCurrChange = $oChange;
+		self::SetCurrentChange($oChange);
 		$this->DBCloneTracked_Internal($newKey);
-		self::$m_oCurrChange = $oPreviousChange;
 	}
 
 	protected function DBCloneTracked_Internal($newKey = null)
@@ -334,128 +480,57 @@ abstract class CMDBObject extends DBObject
 		$newKey = parent::DBClone($newKey);
 		$oClone = MetaModel::GetObject(get_class($this), $newKey); 
 
-		$oClone->RecordObjCreation(self::$m_oCurrChange);
 		return $newKey;
 	}
 
 	public function DBUpdate()
-	{
-		if(!self::$m_oCurrChange)
-		{
-			throw new CoreException("DBUpdate() could not be used here, please use DBUpdateTracked() instead");
-		}
-		return $this->DBUpdateTracked_internal();
-	}
-
-	public function DBUpdateTracked(CMDBChange $oChange, $bSkipStrongSecurity = null)
-	{
-		$this->CheckUserRights($bSkipStrongSecurity, UR_ACTION_MODIFY);
-
-		$oPreviousChange = self::$m_oCurrChange;
-		self::$m_oCurrChange = $oChange;
-		$this->DBUpdateTracked_Internal();
-		self::$m_oCurrChange = $oPreviousChange;
-	}
-
-	protected function DBUpdateTracked_Internal()
 	{
 		// Copy the changes list before the update (the list should be reset afterwards)
 		$aChanges = $this->ListChanges();
 		if (count($aChanges) == 0)
 		{
-			//throw new CoreWarning("Attempting to update an unchanged object");
 			return;
 		}
 		
-		// Save the original values (will be reset to the new values when the object get written to the DB)
-		$aOriginalValues = $this->m_aOrigValues;
 		$ret = parent::DBUpdate();
-		$this->RecordAttChanges(self::$m_oCurrChange, $aChanges, $aOriginalValues);
 		return $ret;
 	}
 
+	public function DBUpdateTracked(CMDBChange $oChange, $bSkipStrongSecurity = null)
+	{
+		self::SetCurrentChange($oChange);
+		$this->CheckUserRights($bSkipStrongSecurity, UR_ACTION_MODIFY);
+		$this->DBUpdate();
+	}
+
 	public function DBDelete(&$oDeletionPlan = null)
 	{
-		if(!self::$m_oCurrChange)
-		{
-			throw new CoreException("DBDelete() could not be used here, please use DBDeleteTracked() instead");
-		}
 		return $this->DBDeleteTracked_Internal($oDeletionPlan);
 	}
 
 	public function DBDeleteTracked(CMDBChange $oChange, $bSkipStrongSecurity = null, &$oDeletionPlan = null)
 	{
+		self::SetCurrentChange($oChange);
 		$this->CheckUserRights($bSkipStrongSecurity, UR_ACTION_DELETE);
-
-		$oPreviousChange = self::$m_oCurrChange;
-		self::$m_oCurrChange = $oChange;
 		$this->DBDeleteTracked_Internal($oDeletionPlan);
-		self::$m_oCurrChange = $oPreviousChange;
 	}
 
 	protected function DBDeleteTracked_Internal(&$oDeletionPlan = null)
 	{
 		$prevkey = $this->GetKey();
 		$ret = parent::DBDelete($oDeletionPlan);
-		$this->RecordObjDeletion(self::$m_oCurrChange, $prevkey);
-		return $ret;
-	}
-
-	public static function BulkDelete(DBObjectSearch $oFilter)
-	{
-		if(!self::$m_oCurrChange)
-		{
-			throw new CoreException("BulkDelete() could not be used here, please use BulkDeleteTracked() instead");
-		}
-		return $this->BulkDeleteTracked_Internal($oFilter);
-	}
-
-	public static function BulkDeleteTracked(CMDBChange $oChange, DBObjectSearch $oFilter)
-	{
-		$oPreviousChange = self::$m_oCurrChange;
-		self::$m_oCurrChange = $oChange;
-		$this->BulkDeleteTracked_Internal($oFilter);
-		self::$m_oCurrChange = $oPreviousChange;
-	}
-
-	protected static function BulkDeleteTracked_Internal(DBObjectSearch $oFilter)
-	{
-		throw new CoreWarning("Change tracking not tested for bulk operations");
-
-		// Get the list of objects to delete (and record data before deleting the DB records)
-		$oObjSet = new CMDBObjectSet($oFilter);
-		$aObjAndKeys = array(); // array of id=>object
-		while ($oItem = $oObjSet->Fetch())
-		{
-			$aObjAndKeys[$oItem->GetKey()] = $oItem;
-		}
-		$oObjSet->FreeResult();
-
-		// Delete in one single efficient query
-		$ret = parent::BulkDelete($oFilter);
-		// Record... in many queries !!!
-		foreach($aObjAndKeys as $prevkey=>$oItem)
-		{
-			$oItem->RecordObjDeletion(self::$m_oCurrChange, $prevkey);
-		}
 		return $ret;
 	}
 
 	public static function BulkUpdate(DBObjectSearch $oFilter, array $aValues)
 	{
-		if(!self::$m_oCurrChange)
-		{
-			throw new CoreException("BulkUpdate() could not be used here, please use BulkUpdateTracked() instead");
-		}
 		return $this->BulkUpdateTracked_Internal($oFilter, $aValues);
 	}
 
 	public static function BulkUpdateTracked(CMDBChange $oChange, DBObjectSearch $oFilter, array $aValues)
 	{
-		$oPreviousChange = self::$m_oCurrChange;
-		self::$m_oCurrChange = $oChange;
+		self::SetCurrentChange($oChange);
 		$this->BulkUpdateTracked_Internal($oFilter, $aValues);
-		self::$m_oCurrChange = $oPreviousChange;
 	}
 
 	protected static function BulkUpdateTracked_Internal(DBObjectSearch $oFilter, array $aValues)
@@ -482,7 +557,7 @@ abstract class CMDBObject extends DBObject
 		while ($oItem = $oObjSet->Fetch())
 		{
 			$aChangedValues = $oItem->ListChangedValues($aValues);
-			$oItem->RecordAttChanges(self::$m_oCurrChange, $aChangedValues, $aOriginalValues[$oItem->GetKey()]);
+			$oItem->RecordAttChanges($aChangedValues, $aOriginalValues[$oItem->GetKey()]);
 		}
 		return $ret;
 	}

core/cmdbsource.class.inc.php

@@ -1,36 +1,46 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2014 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * DB Server abstraction
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once('MyHelpers.class.inc.php');
+require_once(APPROOT.'core/kpi.class.inc.php');
 
 class MySQLException extends CoreException
 {
-	public function __construct($sIssue, $aContext)
+	public function __construct($sIssue, $aContext, $oException = null)
 	{
-		$aContext['mysql_error'] = mysql_error();
-		$aContext['mysql_errno'] = mysql_errno();
+		if ($oException != null)
+		{
+			$aContext['mysql_error'] = $oException->getCode();
+			$aContext['mysql_errno'] = $oException->getMessage();
+		}
+		else
+		{
+			$aContext['mysql_error'] = CMDBSource::GetError();
+			$aContext['mysql_errno'] = CMDBSource::GetErrNo();
+		}
 		parent::__construct($sIssue, $aContext);
 	}
 }
@@ -48,7 +58,7 @@ class CMDBSource
 	protected static $m_sDBUser;
 	protected static $m_sDBPwd;
 	protected static $m_sDBName;
-	protected static $m_resDBLink;
+	protected static $m_oMysqli;
 
 	public static function Init($sServer, $sUser, $sPwd, $sSource = '')
 	{
@@ -56,15 +66,41 @@ class CMDBSource
 		self::$m_sDBUser = $sUser;
 		self::$m_sDBPwd = $sPwd;
 		self::$m_sDBName = $sSource;
-		if (!self::$m_resDBLink = mysql_connect($sServer, $sUser, $sPwd))
+		self::$m_oMysqli = null;
+
+		mysqli_report(MYSQLI_REPORT_STRICT); // *some* errors (like connection errors) will throw mysqli_sql_exception instead
+											 // of generating warnings printed to the output but some other errors will still
+											 // cause the query() method to return false !!!
+		try
 		{
-			throw new MySQLException('Could not connect to the DB server', array('host'=>$sServer, 'user'=>$sUser));
+			$aConnectInfo = explode(':', self::$m_sDBHost);
+			if (count($aConnectInfo) > 1)
+			{
+				// Override the default port
+				$sServer = $aConnectInfo[0];
+				$iPort = (int)$aConnectInfo[1];
+				self::$m_oMysqli = new mysqli(self::$m_sDBHost, self::$m_sDBUser, self::$m_sDBPwd, '', $iPort);
+			}
+			else
+			{
+				self::$m_oMysqli = new mysqli(self::$m_sDBHost, self::$m_sDBUser, self::$m_sDBPwd);
+			}
 		}
+		catch(mysqli_sql_exception $e)
+		{
+			throw new MySQLException('Could not connect to the DB server', array('host'=>self::$m_sDBHost, 'user'=>self::$m_sDBUser), $e);	
+		}
+
 		if (!empty($sSource))
 		{
-			if (!mysql_select_db($sSource, self::$m_resDBLink))
+			try
 			{
-				throw new MySQLException('Could not select DB', array('host'=>$sServer, 'user'=>$sUser, 'db_name'=>$sSource));
+				mysqli_report(MYSQLI_REPORT_STRICT); // Errors, in the next query, will throw mysqli_sql_exception
+				self::$m_oMysqli->query("USE `$sSource`");
+			}
+			catch(mysqli_sql_exception $e)
+			{
+				throw new MySQLException('Could not select DB', array('host'=>self::$m_sDBHost, 'user'=>self::$m_sDBUser, 'db_name'=>self::$m_sDBName), $e);
 			}
 		}
 	}
@@ -118,7 +154,7 @@ class CMDBSource
 		{
 			// In case we don't have rights to enumerate the databases
 			// Let's try to connect directly
-			return @mysql_select_db($sSource, self::$m_resDBLink);
+			return @((bool)self::$m_oMysqli->query("USE `$sSource`"));
 		}
 
 	}
@@ -131,7 +167,7 @@ class CMDBSource
 	
 	public static function SelectDB($sSource)
 	{
-		if (!mysql_select_db($sSource, self::$m_resDBLink))
+		if (!((bool)self::$m_oMysqli->query("USE `$sSource`")))
 		{
 			throw new MySQLException('Could not select DB', array('db_name'=>$sSource));
 		}
@@ -171,6 +207,30 @@ class CMDBSource
 		return $res;
 	}
 
+	public static function GetErrNo()
+	{
+		if (self::$m_oMysqli->errno != 0)
+		{
+			return self::$m_oMysqli->errno;
+		}
+		else
+		{
+			return self::$m_oMysqli->connect_errno;
+		}
+	}
+
+	public static function GetError()
+	{
+		if (self::$m_oMysqli->error != '')
+		{
+			return self::$m_oMysqli->error;
+		}
+		else
+		{
+			return self::$m_oMysqli->connect_error;
+		}
+	}
+
 	public static function DBHost() {return self::$m_sDBHost;}
 	public static function DBUser() {return self::$m_sDBUser;}
 	public static function DBPwd() {return self::$m_sDBPwd;}
@@ -208,43 +268,50 @@ class CMDBSource
 		// Quote if not a number or a numeric string
 		if ($bAlways || is_string($value))
 		{
-			$value = $cQuoteStyle . mysql_real_escape_string($value, self::$m_resDBLink) . $cQuoteStyle;
+			$value = $cQuoteStyle . self::$m_oMysqli->real_escape_string($value) . $cQuoteStyle;
 		}
 		return $value;
 	}
 
 	public static function Query($sSQLQuery)
 	{
-		// Add info into the query as a comment, for easier error tracking
-	  	// disabled until we need it really!
-		//
-		//$aTraceInf['file'] = __FILE__;
-		// $sSQLQuery .= MyHelpers::MakeSQLComment($aTraceInf);
-	  
 		$oKPI = new ExecutionKPI();
-		$result = mysql_query($sSQLQuery, self::$m_resDBLink);
-		if (!$result) 
+		try
+		{
+			$oResult = self::$m_oMysqli->query($sSQLQuery);
+		}
+		catch(mysqli_sql_exception $e)
+		{
+			throw new MySQLException('Failed to issue SQL query', array('query' => $sSQLQuery, $e));
+		}
+		$oKPI->ComputeStats('Query exec (mySQL)', $sSQLQuery);
+		if ($oResult === false)
 		{
 			throw new MySQLException('Failed to issue SQL query', array('query' => $sSQLQuery));
 		}
-		$oKPI->ComputeStats('Query exec (mySQL)', $sSQLQuery);
 	
-		return $result;
+		return $oResult;
 	}
 
 	public static function GetNextInsertId($sTable)
 	{
 		$sSQL = "SHOW TABLE STATUS LIKE '$sTable'";
-		$result = self::Query($sSQL);
-		$aRow = mysql_fetch_assoc($result);
+		$oResult = self::Query($sSQL);
+		$aRow = $oResult->fetch_assoc();
 		$iNextInsertId = $aRow['Auto_increment'];
 		return $iNextInsertId;
 	}
 
 	public static function GetInsertId()
 	{
-		return mysql_insert_id(self::$m_resDBLink);
+		$iRes = self::$m_oMysqli->insert_id;
+		if (is_null($iRes))
+		{
+			return 0;
+		}
+		return $iRes;
 	}
+
 	public static function InsertInto($sSQLQuery)
 	{
 		if (self::Query($sSQLQuery))
@@ -261,37 +328,59 @@ class CMDBSource
 
 	public static function QueryToScalar($sSql)
 	{
-		$result = mysql_query($sSql, self::$m_resDBLink);
-		if (!$result)
+		$oKPI = new ExecutionKPI();
+		try
+		{
+			$oResult = self::$m_oMysqli->query($sSql);
+		}
+		catch(mysqli_sql_exception $e)
+		{
+			$oKPI->ComputeStats('Query exec (mySQL)', $sSql);
+			MySQLException('Failed to issue SQL query', array('query' => $sSql, $e));
+		}
+		$oKPI->ComputeStats('Query exec (mySQL)', $sSql);
+		if ($oResult === false)
 		{
 			throw new MySQLException('Failed to issue SQL query', array('query' => $sSql));
 		}
-		if ($aRow = mysql_fetch_array($result, MYSQL_BOTH))
+		
+		if ($aRow = $oResult->fetch_array(MYSQLI_BOTH))
 		{
 			$res = $aRow[0];
 		}
 		else
 		{
-			mysql_free_result($result);
+			$oResult->free();
 			throw new MySQLException('Found no result for query', array('query' => $sSql));
 		}
-		mysql_free_result($result);
+		$oResult->free();
 		return $res;
 	}
 
 	public static function QueryToArray($sSql)
 	{
 		$aData = array();
-		$result = mysql_query($sSql, self::$m_resDBLink);
-		if (!$result)
+		$oKPI = new ExecutionKPI();
+		try
+		{
+			$oResult = self::$m_oMysqli->query($sSql);
+		}
+		catch(mysqli_sql_exception $e)
+		{
+			$oKPI->ComputeStats('Query exec (mySQL)', $sSql);
+			MySQLException('Failed to issue SQL query', array('query' => $sSql, $e));
+		}
+		$oKPI->ComputeStats('Query exec (mySQL)', $sSql);
+		if ($oResult === false)
 		{
 			throw new MySQLException('Failed to issue SQL query', array('query' => $sSql));
 		}
-		while ($aRow = mysql_fetch_array($result, MYSQL_BOTH))
+				
+		while ($aRow = $oResult->fetch_array(MYSQLI_BOTH))
 		{
 			$aData[] = $aRow;
 		}
-		mysql_free_result($result);
+		$oResult->free();
 		return $aData;
 	}
 
@@ -309,71 +398,94 @@ class CMDBSource
 	public static function ExplainQuery($sSql)
 	{
 		$aData = array();
-		$result = mysql_query("EXPLAIN $sSql", self::$m_resDBLink);
-		if (!$result)
+		try
+		{
+			$oResult = self::$m_oMysqli->query($sSql);
+		}
+		catch(mysqli_sql_exception $e)
+		{
+			MySQLException('Failed to issue SQL query', array('query' => $sSql, $e));
+		}
+		if ($oResult === false)
 		{
 			throw new MySQLException('Failed to issue SQL query', array('query' => $sSql));
 		}
-
-		$aNames = self::GetColumns($result);
+		
+		$aNames = self::GetColumns($oResult);
 
 		$aData[] = $aNames;
-		while ($aRow = mysql_fetch_array($result, MYSQL_ASSOC))
+		while ($aRow = $oResult->fetch_array(MYSQLI_ASSOC))
 		{
 			$aData[] = $aRow;
 		}
-		mysql_free_result($result);
+		$oResult->free();
 		return $aData;
 	}
 
 	public static function TestQuery($sSql)
 	{
-		$result = mysql_query("EXPLAIN $sSql", self::$m_resDBLink);
-		if (!$result)
+		try
 		{
-			return mysql_error();
+			$oResult = self::$m_oMysqli->query($sSql);
+		}
+		catch(mysqli_sql_exception $e)
+		{
+			MySQLException('Failed to issue SQL query', array('query' => $sSql, $e));
+		}
+		if ($oResult === false)
+		{
+			throw new MySQLException('Failed to issue SQL query', array('query' => $sSql));
 		}
 
-		mysql_free_result($result);
+		if (is_object($oResult))
+		{
+			$oResult->free();
+		}
 		return '';
 	}
 
-	public static function NbRows($result)
+	public static function NbRows($oResult)
 	{
-		return mysql_num_rows($result);
+		return $oResult->num_rows;
 	}
 
-	public static function FetchArray($result)
+	public static function AffectedRows()
 	{
-		return mysql_fetch_array($result, MYSQL_ASSOC);
+		return self::$m_oMysqli->affected_rows;
 	}
 
-	public static function GetColumns($result)
+	public static function FetchArray($oResult)
+	{
+		return $oResult->fetch_array(MYSQLI_ASSOC);
+	}
+
+	public static function GetColumns($oResult)
 	{
 		$aNames = array();
-		for ($i = 0; $i < mysql_num_fields($result) ; $i++)
+		for ($i = 0; $i < (($___mysqli_tmp = $oResult->field_count) ? $___mysqli_tmp : 0) ; $i++)
 		{
-		   $meta = mysql_fetch_field($result, $i);
-		   if (!$meta)
-		   {
+			$meta = $oResult->fetch_field_direct($i);
+			if (!$meta)
+			{
 				throw new MySQLException('mysql_fetch_field: No information available', array('query'=>$sSql, 'i'=>$i));
-		   }
-		   else
-		   {
-	   		$aNames[] = $meta->name;
-		   }
+			}
+			else
+			{
+				$aNames[] = $meta->name;
+			}
 		}
 		return $aNames;
 	}
 
-	public static function Seek($result, $iRow)
+	public static function Seek($oResult, $iRow)
 	{
-		return mysql_data_seek($result, $iRow);
+		return $oResult->data_seek($iRow);
 	}
 
-	public static function FreeResult($result)
+	public static function FreeResult($oResult)
 	{
-		return mysql_free_result($result);
+		$oResult->free(); /* returns void */
+		return true;
 	}
 
 	public static function IsTable($sTable)
@@ -429,14 +541,23 @@ class CMDBSource
 		return ($aFieldData["Type"]);
 	}
 
-	public static function HasIndex($sTable, $sField)
+	public static function HasIndex($sTable, $sIndexId, $aFields = null)
 	{
 		$aTableInfo = self::GetTableInfo($sTable);
 		if (empty($aTableInfo)) return false;
-		if (!array_key_exists($sField, $aTableInfo["Fields"])) return false;
-		$aFieldData = $aTableInfo["Fields"][$sField];
-		// $aFieldData could be 'PRI' for the primary key, or 'MUL', or ?
-		return (strlen($aFieldData["Key"]) > 0);
+		if (!array_key_exists($sIndexId, $aTableInfo['Indexes'])) return false;
+
+		if ($aFields == null)
+		{
+			// Just searching for the name
+			return true;
+		}
+
+		// Compare the columns
+		$sSearchedIndex = implode(',', $aFields);
+		$sExistingIndex = implode(',', $aTableInfo['Indexes'][$sIndexId]);
+
+		return ($sSearchedIndex == $sExistingIndex);
 	}
 
 	// Returns an array of (fieldname => array of field info)
@@ -486,6 +607,17 @@ class CMDBSource
 			// Table does not exist
 			self::$m_aTablesInfo[strtolower($sTableName)] = null;
 		}
+
+		if (!is_null(self::$m_aTablesInfo[strtolower($sTableName)]))
+		{
+			$aIndexes = self::QueryToArray("SHOW INDEXES FROM `$sTableName`");
+			$aMyIndexes = array();
+			foreach ($aIndexes as $aIndexColumn)
+			{
+				$aMyIndexes[$aIndexColumn['Key_name']][$aIndexColumn['Seq_in_index']-1] = $aIndexColumn['Column_name'];
+			}
+			self::$m_aTablesInfo[strtolower($sTableName)]["Indexes"] = $aMyIndexes;
+		}
 	}
 	//public static function EnumTables()
 	//{
@@ -511,18 +643,25 @@ class CMDBSource
 	public static function DumpTable($sTable)
 	{
 		$sSql = "SELECT * FROM `$sTable`";
-		$result = mysql_query($sSql, self::$m_resDBLink);
-		if (!$result)
+		try
+		{
+			$oResult = self::$m_oMysqli->query($sSql);
+		}
+		catch(mysqli_sql_exception $e)
+		{
+			throw new MySQLException('Failed to issue SQL query', array('query' => $sSql), $e);
+		}
+		if ($oResult === false)
 		{
 			throw new MySQLException('Failed to issue SQL query', array('query' => $sSql));
 		}
-
+		
 		$aRows = array();
-		while ($aRow = mysql_fetch_array($result, MYSQL_ASSOC))
+		while ($aRow = $oResult->fetch_array(MYSQLI_ASSOC))
 		{
 			$aRows[] = $aRow;
 		}
-		mysql_free_result($result);
+		$oResult->free();
 		return $aRows;
 	}
 	
@@ -552,7 +691,7 @@ class CMDBSource
 	{
 		try
 		{
-			$result = self::Query('SHOW GRANTS'); // [ FOR CURRENT_USER()]
+			$oResult = self::Query('SHOW GRANTS'); // [ FOR CURRENT_USER()]
 		}
 		catch(MySQLException $e)
 		{
@@ -560,12 +699,12 @@ class CMDBSource
 		}
 
 		$aRes = array();
-		while ($aRow = mysql_fetch_array($result, MYSQL_NUM))
+		while ($aRow = $oResult->fetch_array(MYSQLI_NUM))
 		{
 			// so far, only one column...
 			$aRes[] = implode('/', $aRow);
 		}
-		mysql_free_result($result);
+		$oResult->free();
 		// so far, only one line...
 		return implode(', ', $aRes);
 	}
@@ -578,21 +717,21 @@ class CMDBSource
 	{
 		try
 		{
-			$result = self::Query('SHOW SLAVE STATUS');
+			$oResult = self::Query('SHOW SLAVE STATUS');
 		}
 		catch(MySQLException $e)
 		{
 			throw new CoreException("Current user not allowed to check the status", array('mysql_error' => $e->getMessage()));
 		}
 
-		if (mysql_num_rows($result) == 0)
+		if ($oResult->num_rows == 0)
 		{
 			return false;
 		}
 
 		// Returns one single row anytime
-		$aRow = mysql_fetch_array($result, MYSQL_ASSOC);
-		mysql_free_result($result);
+		$aRow = $oResult->fetch_array(MYSQLI_ASSOC);
+		$oResult->free();
 
 		if (!isset($aRow['Slave_IO_Running']))
 		{
@@ -614,7 +753,4 @@ class CMDBSource
 		}
 		return false;
 	}
-}
-
-
-?>
+}

core/computing.inc.php

@@ -0,0 +1,122 @@
+<?php
+// Copyright (C) 2010-2012 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+
+/**
+ * Any extension to compute things like a stop watch deadline or working hours 
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+/**
+ * Metric computing for stop watches
+ */ 
+interface iMetricComputer
+{
+	public static function GetDescription();
+	public function ComputeMetric($oObject);
+}
+
+/**
+ * Working time computing for stop watches
+ */ 
+interface iWorkingTimeComputer
+{
+	public static function GetDescription();
+
+	/**
+	 * Get the date/time corresponding to a given delay in the future from the present
+	 * considering only the valid (open) hours for a specified object
+	 * @param $oObject DBObject The object for which to compute the deadline
+	 * @param $iDuration integer The duration (in seconds) in the future
+	 * @param $oStartDate DateTime The starting point for the computation
+	 * @return DateTime The date/time for the deadline
+	 */
+	public function GetDeadline($oObject, $iDuration, DateTime $oStartDate);
+	
+	/**
+	 * Get duration (considering only open hours) elapsed bewteen two given DateTimes
+	 * @param $oObject DBObject The object for which to compute the duration
+	 * @param $oStartDate DateTime The starting point for the computation (default = now)
+	 * @param $oEndDate DateTime The ending point for the computation (default = now)
+	 * @return integer The duration (number of seconds) of open hours elapsed between the two dates
+	 */
+	public function GetOpenDuration($oObject, DateTime $oStartDate, DateTime $oEndDate);
+}
+
+/**
+ * Default implementation oof deadline computing: NO deadline
+ */
+class DefaultMetricComputer implements iMetricComputer
+{
+	public static function GetDescription()
+	{
+		return "Null";
+	}
+
+	public function ComputeMetric($oObject)
+	{
+		return null;
+	}
+}
+
+/**
+ * Default implementation of working time computing
+ */ 
+class DefaultWorkingTimeComputer implements iWorkingTimeComputer
+{
+	public static function GetDescription()
+	{
+		return "24x7, no holidays";
+	}
+
+	/**
+	 * Get the date/time corresponding to a given delay in the future from the present
+	 * considering only the valid (open) hours for a specified object
+	 * @param $oObject DBObject The object for which to compute the deadline
+	 * @param $iDuration integer The duration (in seconds) in the future
+	 * @param $oStartDate DateTime The starting point for the computation
+	 * @return DateTime The date/time for the deadline
+	 */
+	public function GetDeadline($oObject, $iDuration, DateTime $oStartDate)
+	{
+		//echo "GetDeadline - default: ".$oStartDate->format('Y-m-d H:i:s')." + $iDuration<br/>\n";
+		// Default implementation: 24x7, no holidays: to compute the deadline, just add
+		// the specified duration to the given date/time
+		$oResult = clone $oStartDate;
+		$oResult->modify('+'.$iDuration.' seconds');
+		return $oResult;
+	}
+	
+	/**
+	 * Get duration (considering only open hours) elapsed bewteen two given DateTimes
+	 * @param $oObject DBObject The object for which to compute the duration
+	 * @param $oStartDate DateTime The starting point for the computation (default = now)
+	 * @param $oEndDate DateTime The ending point for the computation (default = now)
+	 * @return integer The duration (number of seconds) of open hours elapsed between the two dates
+	 */
+	public function GetOpenDuration($oObject, DateTime $oStartDate, DateTime $oEndDate)
+	{
+		//echo "GetOpenDuration - default: ".$oStartDate->format('Y-m-d H:i:s')." to ".$oEndDate->format('Y-m-d H:i:s')."<br/>\n";
+		return abs($oEndDate->format('U') - $oStartDate->format('U'));
+	}
+}
+
+
+?>

core/config.class.inc.php

@@ -1,18 +1,21 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2013 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 define('ITOP_APPLICATION', 'iTop');
 define('ITOP_VERSION', '$ITOP_VERSION$');
@@ -27,13 +30,12 @@ define('ACCESS_READONLY', 0);
 /**
  * Configuration read/write
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once('coreexception.class.inc.php');
+require_once('attributedef.class.inc.php'); // For the defines
 
 class ConfigException extends CoreException
 {
@@ -46,9 +48,7 @@ define ('DEFAULT_LOG_GLOBAL', true);
 define ('DEFAULT_LOG_NOTIFICATION', true);
 define ('DEFAULT_LOG_ISSUE', true);
 define ('DEFAULT_LOG_WEB_SERVICE', true);
-define ('DEFAULT_LOG_KPI_DURATION', false);
-define ('DEFAULT_LOG_KPI_MEMORY', false);
-define ('DEFAULT_DEBUG_QUERIES', false);
+define ('DEFAULT_LOG_QUERIES', false);
 
 define ('DEFAULT_QUERY_CACHE_ENABLED', true);
 
@@ -84,6 +84,14 @@ class Config
 	// New way to store the settings !
 	//
 	protected $m_aSettings = array(
+		'app_env_label' => array(
+			'type' => 'string',
+			'description' => 'Label displayed to describe the current application environnment, defaults to the environment name (e.g. "production")',
+			'default' => '',
+			'value' => '',
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
 		'app_root_url' => array(
 			'type' => 'string',
 			'description' => 'Root URL used for navigating within the application, or from an email to the application (you can put $SERVER_NAME$ as a placeholder for the server\'s name)',
@@ -92,6 +100,14 @@ class Config
 			'source_of_value' => '',
 			'show_in_conf_sample' => true,
 		),
+		'app_icon_url' => array(
+			'type' => 'string',
+			'description' => 'Hyperlink to redirect the user when clicking on the application icon (in the main window, or login/logoff pages)',
+			'default' => 'http://www.combodo.com/itop',
+			'value' => '',
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
 		'skip_check_to_write' => array(
 			'type' => 'bool',
 			'description' => 'Disable data format and integrity checks to boost up data load (insert or update)',
@@ -116,6 +132,30 @@ class Config
 			'source_of_value' => '',
 			'show_in_conf_sample' => false,
 		),
+		'query_optimization_enabled' => array(
+			'type' => 'bool',
+			'description' => 'The queries are optimized based on the assumption that the DB integrity has been preserved. By disabling the optimization one can ensure that the fetched data is clean... but this can be really slower or not usable at all (some queries will exceed the allowed number of joins in MySQL: 61!)',
+			'default' => true,
+			'value' => true,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'query_indentation_enabled' => array(
+			'type' => 'bool',
+			'description' => 'For developpers: format the SQL queries for human analysis',
+			'default' => false,
+			'value' => false,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'disable_mandatory_ext_keys' => array(
+			'type' => 'bool',
+			'description' => 'For developpers: allow every external keys to be undefined',
+			'default' => false,
+			'value' => false,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
 		'graphviz_path' => array(
 			'type' => 'string',
 			'description' => 'Path to the Graphviz "dot" executable for graphing objects lifecycle',
@@ -124,6 +164,14 @@ class Config
 			'source_of_value' => '',
 			'show_in_conf_sample' => false,
 		),
+		'php_path' => array(
+			'type' => 'string',
+			'description' => 'Path to the php executable in CLI mode',
+			'default' => 'php',
+			'value' => 'php',
+			'source_of_value' => '',
+			'show_in_conf_sample' => true,
+		),
 		'session_name' => array(
 			'type' => 'string',
 			'description' => 'The name of the cookie used to store the PHP session id',
@@ -189,6 +237,14 @@ class Config
 			'source_of_value' => '',
 			'show_in_conf_sample' => false,
 		),
+		'csv_import_history_display' => array(
+			'type' => 'bool',
+			'description' => 'Display the history tab in the import wizard',
+			'default' => false,
+			'value' => false,
+			'source_of_value' => '',
+			'show_in_conf_sample' => true,
+		),
 		'access_mode' => array(
 			'type' => 'integer',
 			'description' => 'Combination of flags (ACCESS_USER_WRITE | ACCESS_ADMIN_WRITE, or ACCESS_FULL)',
@@ -277,6 +333,14 @@ class Config
 			'source_of_value' => '',
 			'show_in_conf_sample' => false,
 		),
+		'async_task_retries' => array(
+			'type' => 'array',
+			'description' => 'Automatic retries of asynchronous tasks in case of failure (per class)',
+			'default' => array('AsyncSendEmail' => array('max_retries' => 0, 'retry_delay' => 600)),
+			'value' => false,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
 		'email_asynchronous' => array(
 			'type' => 'bool',
 			'description' => 'If set, the emails are sent off line, which requires cron.php to be activated. Exception: some features like the email test utility will force the serialized mode',
@@ -285,6 +349,54 @@ class Config
 			'source_of_value' => '',
 			'show_in_conf_sample' => true,
 		),
+		'email_transport' => array(
+			'type' => 'string',
+			'description' => 'Mean to send emails: PHPMail (uses the function mail()) or SMTP (implements the client protocole)',
+			'default' => "PHPMail",
+			'value' => "PHPMail",
+			'source_of_value' => '',
+			'show_in_conf_sample' => true,
+		),
+		'email_transport_smtp.host' => array(
+			'type' => 'string',
+			'description' => 'host name or IP address (optional)',
+			'default' => "localhost",
+			'value' => "localhost",
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'email_transport_smtp.port' => array(
+			'type' => 'integer',
+			'description' => 'port number (optional)',
+			'default' => 25,
+			'value' => 25,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'email_transport_smtp.encryption' => array(
+			'type' => 'string',
+			'description' => 'tls or ssl (optional)',
+			'default' => "",
+			'value' => "",
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'email_transport_smtp.username' => array(
+			'type' => 'string',
+			'description' => 'Authentication user (optional)',
+			'default' => "",
+			'value' => "",
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'email_transport_smtp.password' => array(
+			'type' => 'string',
+			'description' => 'Authentication password (optional)',
+			'default' => "",
+			'value' => "",
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
 		'apc_cache.enabled' => array(
 			'type' => 'bool',
 			'description' => 'If set, the APC cache is allowed (the PHP extension must also be active)',
@@ -327,7 +439,7 @@ class Config
 			'default' => '2.0',
 			'value' => '',
 			'source_of_value' => '',
-			'show_in_conf_sample' => true,
+			'show_in_conf_sample' => false,
 		),
 		'cas_host' => array(
 			'type' => 'string',
@@ -336,7 +448,7 @@ class Config
 			'default' => '',
 			'value' => '',
 			'source_of_value' => '',
-			'show_in_conf_sample' => true,
+			'show_in_conf_sample' => false,
 		),
 		'cas_port' => array(
 			'type' => 'integer',
@@ -345,7 +457,7 @@ class Config
 			'default' => 443,
 			'value' => 443,
 			'source_of_value' => '',
-			'show_in_conf_sample' => true,
+			'show_in_conf_sample' => false,
 		),
 		'cas_context' => array(
 			'type' => 'string',
@@ -354,7 +466,7 @@ class Config
 			'default' => '',
 			'value' => '',
 			'source_of_value' => '',
-			'show_in_conf_sample' => true,
+			'show_in_conf_sample' => false,
 		),
 		'cas_server_ca_cert_path' => array(
 			'type' => 'string',
@@ -363,7 +475,7 @@ class Config
 			'default' => '',
 			'value' => '',
 			'source_of_value' => '',
-			'show_in_conf_sample' => true,
+			'show_in_conf_sample' => false,
 		),
 		'cas_logout_redirect_service' => array(
 			'type' => 'string',
@@ -372,7 +484,7 @@ class Config
 			'default' => '',
 			'value' => '',
 			'source_of_value' => '',
-			'show_in_conf_sample' => true,
+			'show_in_conf_sample' => false,
 		),
 		'cas_memberof' => array(
 			'type' => 'string',
@@ -381,7 +493,7 @@ class Config
 			'default' => '',
 			'value' => '',
 			'source_of_value' => '',
-			'show_in_conf_sample' => true,
+			'show_in_conf_sample' => false,
 		),
 		'cas_user_synchro' => array(
 			'type' => 'bool',
@@ -390,7 +502,16 @@ class Config
 			'default' => 0,
 			'value' => 0,
 			'source_of_value' => '',
-			'show_in_conf_sample' => true,
+			'show_in_conf_sample' => false,
+		),
+		'cas_update_profiles' => array(
+			'type' => 'bool',
+			'description' => 'Whether or not to update the profiles of an existing user from the CAS information',
+			// examples... not used (nor 'description')
+			'default' => 0,
+			'value' => 0,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
 		),
 		'cas_profile_pattern' => array(
 			'type' => 'string',
@@ -399,7 +520,16 @@ class Config
 			'default' => '/^cn=([^,]+),/',
 			'value' => '/^cn=([^,]+),/',
 			'source_of_value' => '',
-			'show_in_conf_sample' => true,
+			'show_in_conf_sample' => false,
+		),
+		'cas_default_profiles' => array(
+			'type' => 'string',
+			'description' => 'A semi-colon separated list of iTop Profiles to use when creating a new user if no profile is retrieved from CAS',
+			// examples... not used (nor 'description')
+			'default' => 'Portal user',
+			'value' => 'Portal user',
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
 		),
 		'cas_debug' => array(
 			'type' => 'bool',
@@ -408,7 +538,25 @@ class Config
 			'default' => false,
 			'value' => false,
 			'source_of_value' => '',
-			'show_in_conf_sample' => true,
+			'show_in_conf_sample' => false,
+		),
+		'forgot_password' => array(
+			'type' => 'bool',
+			'description' => 'Enable the "Forgot password" feature',
+			// examples... not used (nor 'description')
+			'default' => true,
+			'value' => true,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'forgot_password_from' => array(
+			'type' => 'string',
+			'description' => 'Sender email address for the "forgot password" feature. If empty, defaults to the recipient\'s  email address.',
+			// examples... not used (nor 'description')
+			'default' => '',
+			'value' => '',
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
 		),
 		'deadline_format' => array(
 			'type' => 'string',
@@ -437,6 +585,190 @@ class Config
 			'source_of_value' => '',
 			'show_in_conf_sample' => true,
 		),
+		'complex_actions_limit' => array(
+			'type' => 'integer',
+			'description' => 'Display the "actions" menu items that require long computation only if the list of objects is contains less objects than this number (0 means no limit)',
+			// examples... not used
+			'default' => 50,
+			'value' => 50,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'synchro_prevent_delete_all' => array(
+			'type' => 'bool',
+			'description' => 'Stop the synchro if all the replicas of a data source become obsolete at the same time.',
+			// examples... not used
+			'default' => true,
+			'value' => true,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'source_dir' => array(
+			'type' => 'string',
+			'description' => 'Source directory for the datamodel files. (which gets compiled to env-production).',
+			// examples... not used
+			'default' => '',
+			'value' => '',
+			'source_of_value' => '',
+			'show_in_conf_sample' => true,
+		),
+		'csv_file_default_charset' => array(
+			'type' => 'string',
+			'description' => 'Character set used by default for downloading and uploading data as a CSV file. Warning: it is case sensitive (uppercase is preferable).',
+			// examples... not used
+			'default' => 'ISO-8859-1',
+			'value' => '',
+			'source_of_value' => '',
+			'show_in_conf_sample' => true,
+		),
+		'debug_report_spurious_chars' => array(
+			'type' => 'bool',
+			'description' => 'Report, in the error log, the characters found in the output buffer, echoed by mistake in the loaded modules, and potentially corrupting the output',
+			// examples... not used
+			'default' => false,
+			'value' => '',
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'impact_analysis_first_tab' => array(
+			'type' => 'string',
+			'description' => 'Which tab to display first in the impact analysis view: list or graphics. Graphics are nicer but slower to display when there are many objects',
+			// examples... not used
+			'default' => 'graphics',
+			'value' => '',
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'url_validation_pattern' => array(
+			'type' => 'string',
+			'description' => 'Regular expression to validate/detect the format of an URL (URL attributes and Wiki formatting for Text attributes)',
+			'default' => '(https?|ftp)\://([a-zA-Z0-9+!*(),;?&=\$_.-]+(\:[a-zA-Z0-9+!*(),;?&=\$_.-]+)?@)?([a-zA-Z0-9-.]{3,})(\:[0-9]{2,5})?(/([a-zA-Z0-9%+\$_-]\.?)+)*/?(\?[a-zA-Z+&\$_.-][a-zA-Z0-9;:[\]@&%=+/\$_.-]*)?(#[a-zA-Z_.-][a-zA-Z0-9+\$_.-]*)?',
+			//            SHEME.......... USER....................... PASSWORD.......................... HOST/IP........... PORT.......... PATH........................ GET............................................ ANCHOR............................
+			// Example: http://User:passWord@127.0.0.1:8888/patH/Page.php?arrayArgument[2]=something:blah20#myAnchor
+			// Origin of this regexp: http://www.php.net/manual/fr/function.preg-match.php#93824
+			'value' => '',
+			'source_of_value' => '',
+			'show_in_conf_sample' => true,
+		),
+		'email_validation_pattern' => array(
+			'type' => 'string',
+			'description' => 'Regular expression to validate/detect the format of an eMail address',
+			'default' => "[a-zA-Z0-9._&'-]+@[a-zA-Z0-9.-]+\.[a-zA-Z0-9-]{2,}",
+			'value' => '',
+			'source_of_value' => '',
+			'show_in_conf_sample' => true,
+		),
+		'log_kpi_duration' => array(
+			'type' => 'integer',
+			'description' => 'Level of logging for troubleshooting performance issues (1 to enable, 2 +blame callers)',
+			// examples... not used
+			'default' => 0,
+			'value' => 0,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'log_kpi_memory' => array(
+			'type' => 'integer',
+			'description' => 'Level of logging for troubleshooting memory limit issues',
+			// examples... not used
+			'default' => 0,
+			'value' => 0,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'log_kpi_user_id' => array(
+			'type' => 'string',
+			'description' => 'Limit the scope of users to the given user id (* means no limit)',
+			// examples... not used
+			'default' => '*',
+			'value' => '*',
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'max_linkset_output' => array(
+			'type' => 'integer',
+			'description' => 'Maximum number of items shown when getting a list of related items in an email, using the form $this->some_list$. 0 means no limit.',
+			'default' => 100,
+			'value' => 100,
+			'source_of_value' => '',
+			'show_in_conf_sample' => true,
+		),
+		'demo_mode' => array(
+			'type' => 'bool',
+			'description' => 'Set to true to prevent users from changing passwords/languages',
+			'default' => false,
+			'value' => '',
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'portal_tickets' => array(
+			'type' => 'string',
+			'description' => 'CSV list of classes supported in the portal',
+			// examples... not used
+			'default' => 'UserRequest',
+			'value' => 'UserRequest',
+			'source_of_value' => '',
+			'show_in_conf_sample' => true,
+		),
+		'max_execution_time_per_loop' => array(
+			'type' => 'integer',
+			'description' => 'Maximum execution time requested, per loop, during bulk operations. Zero means no limit.',
+			// examples... not used
+			'default' => 30,
+			'value' => 30,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'max_history_length' => array(
+			'type' => 'integer',
+			'description' => 'Maximum length of the history table (in the "History" tab on each object) before it gets truncated. Latest modifications are displayed first.',
+			// examples... not used
+			'default' => 50,
+			'value' => 50,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'full_text_chunk_duration' => array(
+			'type' => 'integer',
+			'description' => 'Delay after which the results are displayed.',
+			// examples... not used
+			'default' => 2,
+			'value' => 2,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'full_text_accelerators' => array(
+			'type' => 'array',
+			'description' => 'Specifies classes to be searched at first (and the subset of data) when running the full text search.',
+			'default' => array(),
+			'value' => false,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'full_text_needle_min' => array(
+			'type' => 'integer',
+			'description' => 'Minimum size of the full text needle.',
+			'default' => 3,
+			'value' => 3,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'tracking_level_linked_set_default' => array(
+			'type' => 'integer',
+			'description' => 'Default tracking level if not explicitely set at the attribute level, for AttributeLinkedSet (defaults to NONE in case of a fresh install, LIST otherwise - this to preserve backward compatibility while upgrading from a version older than 2.0.3 - see TRAC #936)',
+			'default' => LINKSET_TRACKING_LIST,
+			'value' => LINKSET_TRACKING_LIST,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false,
+		),
+		'tracking_level_linked_set_indirect_default' => array(
+			'type' => 'integer',
+			'description' => 'Default tracking level if not explicitely set at the attribute level, for AttributeLinkedSetIndirect',
+			'default' => LINKSET_TRACKING_ALL,
+			'value' => LINKSET_TRACKING_ALL,
+			'source_of_value' => '',
+			'show_in_conf_sample' => false, 
+		),
 	);
 
 	public function IsProperty($sPropCode)
@@ -465,6 +797,8 @@ class Config
 		case 'float':
 			$value = (float) $value;
 			break;
+		case 'array':
+			break;
 		default:
 			throw new CoreException('Unknown type for setting', array('property' => $sPropCode, 'type' => $sType));
 		}
@@ -495,9 +829,7 @@ class Config
 	protected $m_bLogNotification;
 	protected $m_bLogIssue;
 	protected $m_bLogWebService;
-	protected $m_bLogKpiDuration; // private setting
-	protected $m_bLogKpiMemory; // private setting
-	protected $m_bDebugQueries; // private setting
+	protected $m_bLogQueries; // private setting
 	protected $m_bQueryCacheEnabled; // private setting
 
 	/**
@@ -553,15 +885,22 @@ class Config
 	 */
 	 protected $m_aCharsets;
 
-	public function __construct($sConfigFile, $bLoadConfig = true)
+	public function __construct($sConfigFile = null, $bLoadConfig = true)
 	{
 		$this->m_sFile = $sConfigFile;
+		if (is_null($sConfigFile))
+		{
+			$bLoadConfig = false;
+		}
+
 		$this->m_aAppModules = array(
 			// Some default modules, always present can be move to an official iTop Module later if needed
 			'application/transaction.class.inc.php',
 			'application/menunode.class.inc.php',
 			'application/user.preferences.class.inc.php',
+			'application/user.dashboard.class.inc.php',
 			'application/audit.rule.class.inc.php',
+			'application/query.class.inc.php',
 // Romain - That's dirty, because those classes are in fact part of the core
 //          but I needed those classes to be derived from cmdbAbstractObject
 //          (to be managed via the GUI) and this class in not really known from
@@ -571,6 +910,7 @@ class Config
 			'core/action.class.inc.php',
 			'core/trigger.class.inc.php',
 			'synchro/synchrodatasource.class.inc.php',
+			'core/backgroundtask.class.inc.php',
 		);
 		$this->m_aDataModels = array();
 		$this->m_aWebServiceCategories = array(
@@ -598,8 +938,6 @@ class Config
 		$this->m_bLogNotification = DEFAULT_LOG_NOTIFICATION;
 		$this->m_bLogIssue = DEFAULT_LOG_ISSUE;
 		$this->m_bLogWebService = DEFAULT_LOG_WEB_SERVICE;
-		$this->m_bLogKPIDuration = DEFAULT_LOG_KPI_DURATION;
-		$this->m_bLogKPIDuration = DEFAULT_LOG_KPI_DURATION;
 		$this->m_iMinDisplayLimit = DEFAULT_MIN_DISPLAY_LIMIT;
 		$this->m_iMaxDisplayLimit = DEFAULT_MAX_DISPLAY_LIMIT;
 		$this->m_iStandardReloadInterval = DEFAULT_STANDARD_RELOAD_INTERVAL;
@@ -619,10 +957,12 @@ class Config
 			$this->Verify();
 		}
 
-      // Application root url: set a default value, then normalize it
-      $sAppRootUrl = trim($this->Get('app_root_url'));
+      	// Application root url: set a default value, then normalize it
+/*
+ * Does not work in CLI/unattended mode
+		$sAppRootUrl = trim($this->Get('app_root_url'));
 		if (strlen($sAppRootUrl) == 0)
-      {
+		{
 			$sAppRootUrl = utils::GetDefaultUrlAppRoot();
 		}
 		if (substr($sAppRootUrl, -1, 1) != '/')
@@ -630,6 +970,7 @@ class Config
 			$sAppRootUrl .= '/';
 		}
 		$this->Set('app_root_url', $sAppRootUrl);
+ */
 	}
 
 	protected function CheckFile($sPurpose, $sFileName)
@@ -714,7 +1055,14 @@ class Config
 		{
 			if ($this->IsProperty($sPropCode))
 			{
-				$value = trim($rawvalue);
+				if (is_string($rawvalue))
+				{
+					$value = trim($rawvalue);
+				}
+				else
+				{
+					$value = $rawvalue;
+				}
 				$this->Set($sPropCode, $value, $sConfigFile);
 			}
 		}
@@ -732,9 +1080,7 @@ class Config
 		$this->m_bLogNotification = isset($MySettings['log_notification']) ? (bool) trim($MySettings['log_notification']) : DEFAULT_LOG_NOTIFICATION;
 		$this->m_bLogIssue = isset($MySettings['log_issue']) ? (bool) trim($MySettings['log_issue']) : DEFAULT_LOG_ISSUE;
 		$this->m_bLogWebService = isset($MySettings['log_web_service']) ? (bool) trim($MySettings['log_web_service']) : DEFAULT_LOG_WEB_SERVICE;
-		$this->m_bLogKPIDuration = isset($MySettings['log_kpi_duration']) ? (bool) trim($MySettings['log_kpi_duration']) : DEFAULT_LOG_KPI_DURATION;
-		$this->m_bLogKPIMemory = isset($MySettings['log_kpi_memory']) ? (bool) trim($MySettings['log_kpi_memory']) : DEFAULT_LOG_KPI_MEMORY;
-		$this->m_bDebugQueries = isset($MySettings['debug_queries']) ? (bool) trim($MySettings['debug_queries']) : DEFAULT_DEBUG_QUERIES;
+		$this->m_bLogQueries = isset($MySettings['log_queries']) ? (bool) trim($MySettings['log_queries']) : DEFAULT_LOG_QUERIES;
 		$this->m_bQueryCacheEnabled = isset($MySettings['query_cache_enabled']) ? (bool) trim($MySettings['query_cache_enabled']) : DEFAULT_QUERY_CACHE_ENABLED;
 
 		$this->m_iMinDisplayLimit = isset($MySettings['min_display_limit']) ? trim($MySettings['min_display_limit']) : DEFAULT_MIN_DISPLAY_LIMIT;
@@ -872,19 +1218,9 @@ class Config
 		return $this->m_bLogWebService;
 	}
 
-	public function GetLogKPIDuration()
+	public function GetLogQueries()
 	{
-		return $this->m_bLogKPIDuration;
-	}
-
-	public function GetLogKPIMemory()
-	{
-		return $this->m_bLogKPIMemory;
-	}
-
-	public function GetDebugQueries()
-	{
-		return $this->m_bDebugQueries;
+		return $this->m_bLogQueries;
 	}
 
 	public function GetQueryCacheEnabled()
@@ -1051,13 +1387,17 @@ class Config
 	{
 		$this->m_aCharsets[$sIconvCode] = $sDisplayName;
 	}	
-	public function FileIsWritable()
-	{
-		return is_writable($this->m_sFile);
-	}
+
 	public function GetLoadedFile()
 	{
-		return $this->m_sFile;
+		if (is_null($this->m_sFile))
+		{
+			return '';
+		}
+		else
+		{
+			return $this->m_sFile;
+		}
 	}
 	
 	/**
@@ -1140,64 +1480,115 @@ class Config
 			fwrite($hFile, "<?php\n");
 			fwrite($hFile, "\n/**\n");
 			fwrite($hFile, " *\n");
-			fwrite($hFile, " * phpMyORM configuration file, generated by the iTop configuration wizard\n");
+			fwrite($hFile, " * Configuration file, generated by the ".ITOP_APPLICATION." configuration wizard\n");
 			fwrite($hFile, " *\n");
 			fwrite($hFile, " * The file is used in MetaModel::LoadConfig() which does all the necessary initialization job\n");
 			fwrite($hFile, " *\n");
 			fwrite($hFile, " */\n");
-			fwrite($hFile, "\n");
 			
-			fwrite($hFile, "\$MySettings = array(\n");
-			foreach($this->m_aSettings as $sPropCode => $aSettingInfo)
+			$aConfigSettings = $this->m_aSettings;
+			
+			// Old fashioned boolean settings
+			$aBoolValues = array(
+				'log_global' => $this->m_bLogGlobal,
+				'log_notification' => $this->m_bLogNotification,
+				'log_issue' => $this->m_bLogIssue,
+				'log_web_service' => $this->m_bLogWebService,
+				'secure_connection_required' => $this->m_bSecureConnectionRequired,
+			);
+			foreach($aBoolValues as $sKey => $bValue)
 			{
-				if ($aSettingInfo['show_in_conf_sample'])
+				$aConfigSettings[$sKey] = array(
+					'show_in_conf_sample' => true,
+					'type' => 'bool',
+					'value' => $bValue,
+				);
+			}
+	
+			// Old fashioned integer settings
+			$aIntValues = array(
+				'fast_reload_interval' => $this->m_iFastReloadInterval,
+				'max_display_limit' => $this->m_iMaxDisplayLimit,
+				'min_display_limit' => $this->m_iMinDisplayLimit,
+				'standard_reload_interval' => $this->m_iStandardReloadInterval,
+			);
+			foreach($aIntValues as $sKey => $iValue)
+			{
+				$aConfigSettings[$sKey] = array(
+					'show_in_conf_sample' => true,
+					'type' => 'integer',
+					'value' => $iValue,
+				);
+			}
+
+			// Old fashioned remaining values
+			$aOtherValues = array(
+				'db_host' => $this->m_sDBHost,
+				'db_user' => $this->m_sDBUser,
+				'db_pwd' => $this->m_sDBPwd,
+				'db_name' => $this->m_sDBName,
+				'db_subname' => $this->m_sDBSubname,
+				'db_character_set' => $this->m_sDBCharacterSet,
+				'db_collation' => $this->m_sDBCollation,
+				'default_language' => $this->m_sDefaultLanguage,
+				'allowed_login_types' => $this->m_sAllowedLoginTypes,
+				'encryption_key' => $this->m_sEncryptionKey,
+				'csv_import_charsets' => $this->m_aCharsets,
+			);
+			foreach($aOtherValues as $sKey => $value)
+			{
+				$aConfigSettings[$sKey] = array(
+					'show_in_conf_sample' => true,
+					'type' => is_string($value) ? 'string' : 'mixed',
+					'value' => $value,
+				);
+			}
+			
+			ksort($aConfigSettings);
+			fwrite($hFile, "\$MySettings = array(\n");
+			foreach($aConfigSettings as $sPropCode => $aSettingInfo)
+			{
+				// Write all values that are either always visible or present in the cloned config file
+				if ($aSettingInfo['show_in_conf_sample'] || (!empty($aSettingInfo['source_of_value']) && ($aSettingInfo['source_of_value'] != 'unknown')) )
 				{
-					$sType = $this->m_aSettings[$sPropCode]['type'];
+					$sType = $aSettingInfo['type'];
 					switch($sType)
 					{
 					case 'bool':
-						$sSeenAs = $aSettingInfo['value'] ? '1' : '0';
+						$sSeenAs = $aSettingInfo['value'] ? 'true' : 'false';
 						break;
 					default:
-						$sSeenAs = "'".addslashes($aSettingInfo['value'])."'";
+						$sSeenAs = self::PrettyVarExport($aSettingInfo['value'], "\t");
+					}
+					fwrite($hFile, "\n");
+					if (isset($aSettingInfo['description']))
+					{
+						fwrite($hFile, "\t// $sPropCode: {$aSettingInfo['description']}\n");
+					}
+					if (isset($aSettingInfo['default']))
+					{
+						$default = $aSettingInfo['default'];
+						if ($aSettingInfo['type'] == 'bool')
+						{
+							$default = $default ? 'true' : 'false';
+						}
+						fwrite($hFile, "\t//\tdefault: ".self::PrettyVarExport($aSettingInfo['default'],"\t//\t\t", true)."\n");
 					}
 					fwrite($hFile, "\t'$sPropCode' => $sSeenAs,\n");
 				}
 			}
-			fwrite($hFile, "\t'db_host' => '{$this->m_sDBHost}',\n");
-			fwrite($hFile, "\t'db_user' => '{$this->m_sDBUser}',\n");
-			fwrite($hFile, "\t'db_pwd' => '".addslashes($this->m_sDBPwd)."',\n");
-			fwrite($hFile, "\t'db_name' => '{$this->m_sDBName}',\n");
-			fwrite($hFile, "\t'db_subname' => '{$this->m_sDBSubname}',\n");
-			fwrite($hFile, "\t'db_character_set' => '{$this->m_sDBCharacterSet}',\n");
-			fwrite($hFile, "\t'db_collation' => '{$this->m_sDBCollation}',\n");
-			fwrite($hFile, "\n");
-			fwrite($hFile, "\t'log_global' => {$this->m_bLogGlobal},\n");
-			fwrite($hFile, "\t'log_notification' => {$this->m_bLogNotification},\n");
-			fwrite($hFile, "\t'log_issue' => {$this->m_bLogIssue},\n");
-			fwrite($hFile, "\t'log_web_service' => {$this->m_bLogWebService},\n");
-			fwrite($hFile, "\t'min_display_limit' => {$this->m_iMinDisplayLimit},\n");
-			fwrite($hFile, "\t'max_display_limit' => {$this->m_iMaxDisplayLimit},\n");
-			fwrite($hFile, "\t'standard_reload_interval' => {$this->m_iStandardReloadInterval},\n");
-			fwrite($hFile, "\t'fast_reload_interval' => {$this->m_iFastReloadInterval},\n");
-			fwrite($hFile, "\t'secure_connection_required' => ".($this->m_bSecureConnectionRequired ? 'true' : 'false').",\n");
-			fwrite($hFile, "\t'default_language' => '{$this->m_sDefaultLanguage}',\n");
-			fwrite($hFile, "\t'allowed_login_types' => '{$this->m_sAllowedLoginTypes}',\n");
-			fwrite($hFile, "\t'encryption_key' => '{$this->m_sEncryptionKey}',\n");
-			$sExport = var_export($this->m_aCharsets, true);
-			fwrite($hFile, "\t'csv_import_charsets' => $sExport,\n");
-
 			fwrite($hFile, ");\n");
-
+			
 			fwrite($hFile, "\n");
+			fwrite($hFile, "/**\n *\n * Modules specific settings\n *\n */\n");
 			fwrite($hFile, "\$MyModuleSettings = array(\n");
 			foreach ($this->m_aModuleSettings as $sModule => $aProperties)
 			{
 				fwrite($hFile, "\t'$sModule' => array (\n");
 				foreach ($aProperties as $sProperty => $value)
 				{
-					$sExport = var_export($value, true);
-					fwrite($hFile, "\t\t'$sProperty' => $sExport,\n");
+					$sNiceExport = self::PrettyVarExport($value, "\t\t");
+					fwrite($hFile, "\t\t'$sProperty' => $sNiceExport,\n");
 				}
 				fwrite($hFile, "\t),\n");
 			}
@@ -1268,5 +1659,172 @@ class Config
 		}
 		return $aResult;
 	}
+
+	/**
+	 * Helper function to initialize a configuration from the page arguments
+	 */
+	public function UpdateFromParams($aParamValues, $sModulesDir = null, $bPreserveModuleSettings = false)
+	{
+		if (isset($aParamValues['application_path']))
+		{
+			$this->Set('app_root_url', $aParamValues['application_path']);
+		}
+		if (isset($aParamValues['mode']) && isset($aParamValues['language']))
+		{
+			if (($aParamValues['mode'] == 'install') ||  $this->GetDefaultLanguage() == '')
+			{
+				$this->SetDefaultLanguage($aParamValues['language']);
+			}
+		}
+		if (isset($aParamValues['db_server']))
+		{
+			$this->SetDBHost($aParamValues['db_server']);
+			$this->SetDBUser($aParamValues['db_user']);
+			$this->SetDBPwd($aParamValues['db_pwd']);
+			$sDBName = $aParamValues['db_name'];
+			if ($sDBName == '')
+			{
+				// Todo - obsolete after the transition to the new setup (2.0) is complete (WARNING: used by the designer)
+				$sDBName = $aParamValues['new_db_name'];
+			}
+			$this->SetDBName($sDBName);
+			$this->SetDBSubname($aParamValues['db_prefix']);
+		}
+	
+		if (!is_null($sModulesDir))
+		{
+			if (isset($aParamValues['selected_modules']))
+			{
+				$aSelectedModules = explode(',', $aParamValues['selected_modules']);
+			}
+			else
+			{
+				$aSelectedModules = null;
+			}
+	
+			// Initialize the arrays below with default values for the application...
+			$oEmptyConfig = new Config('dummy_file', false); // Do NOT load any config file, just set the default values
+			$aAddOns = $oEmptyConfig->GetAddOns();
+			$aAppModules = $oEmptyConfig->GetAppModules();
+			$aDataModels = $oEmptyConfig->GetDataModels();
+			$aWebServiceCategories = $oEmptyConfig->GetWebServiceCategories();
+			$aDictionaries = $oEmptyConfig->GetDictionaries();
+			// Merge the values with the ones provided by the modules
+			// Make sure when don't load the same file twice...
+	
+			$aModules = ModuleDiscovery::GetAvailableModules(array(APPROOT.$sModulesDir));
+			foreach($aModules as $sModuleId => $aModuleInfo)
+			{
+				list($sModuleName, $sModuleVersion) = ModuleDiscovery::GetModuleName($sModuleId);
+				if (is_null($aSelectedModules) || in_array($sModuleName, $aSelectedModules))
+				{
+					if (isset($aModuleInfo['datamodel']))
+					{
+						$aDataModels = array_unique(array_merge($aDataModels, $aModuleInfo['datamodel']));
+					}
+					if (isset($aModuleInfo['webservice']))
+					{
+						$aWebServiceCategories = array_unique(array_merge($aWebServiceCategories, $aModuleInfo['webservice']));
+					}
+					if (isset($aModuleInfo['settings']))
+					{
+						list($sName, $sVersion) = ModuleDiscovery::GetModuleName($sModuleId);
+						foreach($aModuleInfo['settings'] as $sProperty => $value)
+						{
+							if ($bPreserveModuleSettings && isset($this->m_aModuleSettings[$sName][$sProperty]))
+							{
+								// Do nothing keep the original value
+							}
+							else
+							{
+								$this->SetModuleSetting($sName, $sProperty, $value);
+							}
+						}
+					}
+					if (isset($aModuleInfo['installer']))
+					{
+						$sModuleInstallerClass = $aModuleInfo['installer'];
+						if (!class_exists($sModuleInstallerClass))
+						{
+							throw new Exception("Wrong installer class: '$sModuleInstallerClass' is not a PHP class - Module: ".$aModuleInfo['label']);
+						}
+						if (!is_subclass_of($sModuleInstallerClass, 'ModuleInstallerAPI'))
+						{
+							throw new Exception("Wrong installer class: '$sModuleInstallerClass' is not derived from 'ModuleInstallerAPI' - Module: ".$aModuleInfo['label']);
+						}
+						$aCallSpec = array($sModuleInstallerClass, 'BeforeWritingConfig');
+						call_user_func_array($aCallSpec, array($this));
+					}
+				}
+			}
+			$this->SetAddOns($aAddOns);
+			$this->SetAppModules($aAppModules);
+			$this->SetDataModels($aDataModels);
+			$this->SetWebServiceCategories($aWebServiceCategories);
+
+			// Scan dictionaries
+			//
+			if (!is_null($sModulesDir))
+			{
+				foreach(glob(APPROOT.$sModulesDir.'/dictionaries/*.dict.php') as $sFilePath)
+				{
+					$sFile = basename($sFilePath);
+					$aDictionaries[] = $sModulesDir.'/dictionaries/'.$sFile;
+				}
+			}
+			$this->SetDictionaries($aDictionaries);
+		}
+	}
+
+	/**
+	 * Helper: for an array of string, change the prefix when found
+	 */
+	 protected static function ChangePrefix(&$aStrings, $sSearchPrefix, $sNewPrefix)
+	 {	 	
+		foreach ($aStrings as &$sFile)
+		{
+			if (substr($sFile, 0, strlen($sSearchPrefix)) == $sSearchPrefix)
+			{
+				$sFile = $sNewPrefix.substr($sFile, strlen($sSearchPrefix));
+			}
+		}
+	}
+
+	/**
+	 * Quick an dirty way to clone a config file into another environment	
+	 */	
+	public function ChangeModulesPath($sSourceEnv, $sTargetEnv)
+	{
+		$sSearchPrefix = 'env-'.$sSourceEnv.'/';
+		$sNewPrefix = 'env-'.$sTargetEnv.'/';
+		self::ChangePrefix($this->m_aDataModels, $sSearchPrefix, $sNewPrefix);
+		self::ChangePrefix($this->m_aWebServiceCategories, $sSearchPrefix, $sNewPrefix);
+		self::ChangePrefix($this->m_aDictionaries, $sSearchPrefix, $sNewPrefix);
+	}
+	
+	/**
+	 * Pretty format a var_export'ed value so that (if possible) the identation is preserved on every line
+	 * @param mixed $value The value to export
+	 * @param string $sIndentation The string to use to indent the text
+	 * @param bool $bForceIndentation Forces the identation (enven if it breaks/changes an eval, for example to ouput a value inside a comment)
+	 * @return string The indented export string
+	 */
+	protected static function PrettyVarExport($value, $sIndentation, $bForceIndentation = false)
+	{
+		$sExport = var_export($value, true);
+		$sNiceExport = str_replace(array("\r\n", "\n", "\r"), "\n".$sIndentation, trim($sExport));
+		if (!$bForceIndentation)
+		{
+			eval('$aImported='.$sNiceExport.';');
+			// Check if adding the identations at the beginning of each line
+			// did not modify the values (in case of a string containing a line break)
+			if($aImported != $value)
+			{
+				$sNiceExport = $sExport;
+			}
+		}
+		return $sNiceExport;	
+	}
+
 }
 ?>

core/coreexception.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Exception management
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 

core/csvparser.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * CSV parser
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 

core/data.generator.class.inc.php

@@ -1,27 +1,28 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * data generator
  * helps the consultants in creating dummy data sets, for various test purposes (validation, usability, scalability) 
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 /**

core/dbobjectsearch.class.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Define filters for a given class of objects (formerly named "filter") 
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
  
 define('TREE_OPERATOR_EQUALS', 0);
@@ -66,6 +67,16 @@ class DBObjectSearch
 		$this->m_aRelatedTo = array();
 		$this->m_bDataFiltered = false;
 		$this->m_aParentConditions = array();
+
+		$this->m_aModifierProperties = array();
+	}
+
+	/**
+	 * Perform a deep clone (as opposed to "clone" which does copy a reference to the underlying objects)
+	 **/	 	
+	public function DeepClone()
+	{
+		return unserialize(serialize($this)); // Beware this serializes/unserializes the search and its parameters as well
 	}
 
 	public function AllowAllData() {$this->m_bAllowAllData = true;}
@@ -73,7 +84,18 @@ class DBObjectSearch
 	public function IsDataFiltered() {return $this->m_bDataFiltered; }
 	public function SetDataFiltered() {$this->m_bDataFiltered = true;}
 
-	public function GetClassName($sAlias) {return $this->m_aClasses[$sAlias];}
+	public function GetClassName($sAlias)
+	{
+		if (array_key_exists($sAlias, $this->m_aClasses))
+		{
+			return $this->m_aClasses[$sAlias];
+		}
+		else
+		{
+			throw new CoreException("Invalid class alias '$sAlias'");
+		}
+	}
+
 	public function GetJoinedClasses() {return $this->m_aClasses;}
 
 	public function GetClass()
@@ -96,6 +118,60 @@ class DBObjectSearch
 		return key($this->m_aClasses);
 	}
 
+	/**
+	 * Change the class (only subclasses are supported as of now, because the conditions must fit the new class)
+	 * Defaults to the first selected class (most of the time it is also the first joined class	 
+	 */	 	
+	public function ChangeClass($sNewClass, $sAlias = null)
+	{
+		if (is_null($sAlias))
+		{
+			$sAlias = $this->GetClassAlias();
+		}
+		else
+		{
+			if (!array_key_exists($sAlias, $this->m_aClasses))
+			{
+				// discard silently - necessary when recursing on the related nodes (see code below)
+				return;
+			}
+		}
+		$sCurrClass = $this->GetClassName($sAlias);
+		if (!MetaModel::IsParentClass($sCurrClass, $sNewClass))
+		{
+			throw new Exception("Could not change the search class from '$sCurrClass' to '$sNewClass'. Only child classes are permitted.");
+		}
+
+		// Change for this node
+		//
+		$this->m_aSelectedClasses[$sAlias] = $sNewClass;
+		$this->m_aClasses[$sAlias] = $sNewClass;
+
+		// Change for all the related node (yes, this was necessary with some queries - strange effects otherwise)
+		//
+		foreach($this->m_aRelatedTo as $aRelatedTo)
+		{
+			$aRelatedTo['flt']->ChangeClass($sNewClass, $sAlias);
+		}
+		foreach($this->m_aPointingTo as $sExtKeyAttCode=>$aPointingTo)
+		{
+			foreach($aPointingTo as $iOperatorCode => $aFilter)
+			{
+				foreach($aFilter as $oExtFilter)
+				{
+					$oExtFilter->ChangeClass($sNewClass, $sAlias);
+				}
+			}
+		}
+		foreach($this->m_aReferencedBy as $sForeignClass => $aReferences)
+		{
+			foreach($aReferences as $sForeignExtKeyAttCode => $oForeignFilter)
+			{
+				$oForeignFilter->ChangeClass($sNewClass, $sAlias);
+			}
+		}
+	}
+
 	public function SetSelectedClasses($aNewSet)
 	{
 		$this->m_aSelectedClasses = array();
@@ -115,6 +191,23 @@ class DBObjectSearch
 	}
 
 
+	public function SetModifierProperty($sPluginClass, $sProperty, $value)
+	{
+		$this->m_aModifierProperties[$sPluginClass][$sProperty] = $value;
+	}
+
+	public function GetModifierProperties($sPluginClass)
+	{
+		if (array_key_exists($sPluginClass, $this->m_aModifierProperties))
+		{
+			return $this->m_aModifierProperties[$sPluginClass];
+		}
+		else
+		{
+			return array();
+		}
+	}
+
 	public function IsAny()
 	{
 		// #@# todo - if (!$this->m_oSearchCondition->IsTrue()) return false;
@@ -309,7 +402,7 @@ class DBObjectSearch
 		{
 			foreach($aPointingTo as $iOperatorCode => $aFilter)
 			{
-				foreach($aFilter as $sAlias => $oExtFilter)
+				foreach($aFilter as $oExtFilter)
 				{
 					$oExtFilter->RenameParam($sOldName, $sNewName);
 				}
@@ -444,7 +537,7 @@ class DBObjectSearch
 	 * Specify a condition on external keys or link sets
 	 * @param sAttSpec Can be either an attribute code or extkey->[sAttSpec] or linkset->[sAttSpec] and so on, recursively
 	 *                 Example: infra_list->ci_id->location_id->country	 
-	 * @param value The value to match
+	 * @param value The value to match (can be an array => IN(val1, val2...)
 	 * @return void
 	 */
 	public function AddConditionAdvanced($sAttSpec, $value)
@@ -491,7 +584,18 @@ class DBObjectSearch
 		{
 			// $sAttSpec is an attribute code
 			//
-			$this->AddCondition($sAttSpec, $value);
+			if (is_array($value))
+			{
+				$oField = new FieldExpression($sAttSpec, $this->GetClass());
+				$oListExpr = ListExpression::FromScalars($value);
+				$oInValues = new BinaryExpression($oField, 'IN', $oListExpr);
+
+				$this->AddConditionExpression($oInValues);
+			}
+			else
+			{
+				$this->AddCondition($sAttSpec, $value);
+			}
 		}
 	}
 
@@ -518,31 +622,45 @@ class DBObjectSearch
 	{
 		if ($bTranslateMainAlias)
 		{
-			$sOrigAlias = $this->GetClassAlias();
+			$sOrigAlias = $this->GetFirstJoinedClassAlias();
 			if (array_key_exists($sOrigAlias, $aClassAliases))
 			{
-				$sNewAlias = MetaModel::GenerateUniqueAlias($aClassAliases, $sOrigAlias, $this->GetClass());
-//echo "<p>Generating a new alias for $sOrigAlias (already used). It is now: $sNewAlias</p>\n";
-				$this->m_aSelectedClasses[$sNewAlias] = $this->GetClass();
-				unset($this->m_aSelectedClasses[$sOrigAlias]);
-	
-				$this->m_aClasses[$sNewAlias] = $this->GetClass();
-				unset($this->m_aClasses[$sOrigAlias]);
+				$sNewAlias = MetaModel::GenerateUniqueAlias($aClassAliases, $sOrigAlias, $this->GetFirstJoinedClass());
+				if (isset($this->m_aSelectedClasses[$sOrigAlias]))
+				{
+					$this->m_aSelectedClasses[$sNewAlias] = $this->GetFirstJoinedClass();
+					unset($this->m_aSelectedClasses[$sOrigAlias]);
+				}
+
+				// TEMPORARY ALGORITHM (m_aClasses is not correctly updated, it is not possible to add a subtree onto a subnode)
+				// Replace the element at the same position (unset + set is not enough because the hash array is ordered)
+				$aPrevList = $this->m_aClasses;
+				$this->m_aClasses = array();
+				foreach ($aPrevList as $sSomeAlias => $sSomeClass)
+				{
+					if ($sSomeAlias == $sOrigAlias)
+					{
+						$this->m_aClasses[$sNewAlias] = $sSomeClass; // note: GetFirstJoinedClass now returns '' !!!
+					}
+					else
+					{
+						$this->m_aClasses[$sSomeAlias] = $sSomeClass;
+					}
+				}
 	
 				// Translate the condition expression with the new alias
 				$aAliasTranslation[$sOrigAlias]['*'] = $sNewAlias;
 			}
 	
-//echo "<p>Adding the alias ".$this->GetClass()." as ".$this->GetClassAlias()."</p>\n";
 			// add the alias into the filter aliases list
-			$aClassAliases[$this->GetClassAlias()] = $this->GetClass();
+			$aClassAliases[$this->GetFirstJoinedClassAlias()] = $this->GetFirstJoinedClass();
 		}
 		
 		foreach($this->m_aPointingTo as $sExtKeyAttCode=>$aPointingTo)
 		{
 			foreach($aPointingTo as $iOperatorCode => $aFilter)
 			{
-				foreach($aFilter as $sAlias => $oFilter)
+				foreach($aFilter as $oFilter)
 				{
 					$oFilter->AddToNameSpace($aClassAliases, $aAliasTranslation);
 				}
@@ -558,20 +676,53 @@ class DBObjectSearch
 		}
 	}
 
-	public function AddCondition_PointingTo(DBObjectSearch $oFilter, $sExtKeyAttCode, $iOperatorCode = TREE_OPERATOR_EQUALS)
+
+	// Browse the tree nodes recursively
+	//
+	protected function GetNode($sAlias)
 	{
-		$aAliasTranslation = array();
-		$res = $this->AddCondition_PointingTo_InNameSpace($oFilter, $sExtKeyAttCode, $this->m_aClasses, $aAliasTranslation, $iOperatorCode);
-		$this->TransferConditionExpression($oFilter, $aAliasTranslation);
-		return $res;
+		if ($this->GetFirstJoinedClassAlias() == $sAlias)
+		{
+			return $this;
+		}
+		else
+		{
+			foreach($this->m_aPointingTo as $sExtKeyAttCode=>$aPointingTo)
+			{
+				foreach($aPointingTo as $iOperatorCode => $aFilter)
+				{
+					foreach($aFilter as $oFilter)
+					{
+						$ret = $oFilter->GetNode($sAlias);
+						if (is_object($ret))
+						{
+							return $ret;
+						}
+					}
+				}
+			}
+			foreach($this->m_aReferencedBy as $sForeignClass=>$aReferences)
+			{
+				foreach($aReferences as $sForeignExtKeyAttCode=>$oForeignFilter)
+				{
+					$ret = $oForeignFilter->GetNode($sAlias);
+					if (is_object($ret))
+					{
+						return $ret;
+					}
+				}
+			}
+		}
+		// Not found
+		return null;
 	}
 
-	protected function AddCondition_PointingTo_InNameSpace(DBObjectSearch $oFilter, $sExtKeyAttCode, &$aClassAliases, &$aAliasTranslation, $iOperatorCode)
+
+	public function AddCondition_PointingTo(DBObjectSearch $oFilter, $sExtKeyAttCode, $iOperatorCode = TREE_OPERATOR_EQUALS)
 	{
-//echo "<p style=\"color:green\">Calling: AddCondition_PointingTo_InNameSpace([<pre>".print_r($aClassAliases, true)."</pre></br>], [<pre>".print_r($aAliasTranslation, true)."</pre>]);</p>";
 		if (!MetaModel::IsValidKeyAttCode($this->GetClass(), $sExtKeyAttCode))
 		{
-			throw new CoreWarning("The attribute code '$sExtKeyAttCode' is not an external key of the class '{$this->GetClass()}' - the condition will be ignored");
+			throw new CoreWarning("The attribute code '$sExtKeyAttCode' is not an external key of the class '{$this->GetClass()}'");
 		}
 		$oAttExtKey = MetaModel::GetAttributeDef($this->GetClass(), $sExtKeyAttCode);
 		if(!MetaModel::IsSameFamilyBranch($oFilter->GetClass(), $oAttExtKey->GetTargetClass()))
@@ -580,44 +731,48 @@ class DBObjectSearch
 		}
 		if(($iOperatorCode != TREE_OPERATOR_EQUALS) && !($oAttExtKey instanceof AttributeHierarchicalKey))
 		{
-			throw new CoreException("The specified tree operator $isOperatorCode is not applicable to the key '{$this->GetClass()}::$sExtKeyAttCode', which is not a HierarchicalKey");
+			throw new CoreException("The specified tree operator $iOperatorCode is not applicable to the key '{$this->GetClass()}::$sExtKeyAttCode', which is not a HierarchicalKey");
 		}
+		// Note: though it seems to be a good practice to clone the given source filter
+		//       (as it was done and fixed an issue in MergeWith())
+		//       this was not implemented here because it was causing a regression (login as admin, select an org, click on any badge)
+		//       root cause: FromOQL relies on the fact that the passed filter can be modified later 
+		// NO: $oFilter = $oFilter->DeepClone();
+		// See also: Trac #639, and self::AddCondition_ReferencedBy()
+		$aAliasTranslation = array();
+		$res = $this->AddCondition_PointingTo_InNameSpace($oFilter, $sExtKeyAttCode, $this->m_aClasses, $aAliasTranslation, $iOperatorCode);
+		$this->TransferConditionExpression($oFilter, $aAliasTranslation);
+		return $res;
+	}
 
-		$bSamePointingTo = false;
-		if (array_key_exists($sExtKeyAttCode, $this->m_aPointingTo))
-		{
-			if (array_key_exists($iOperatorCode, $this->m_aPointingTo[$sExtKeyAttCode]))
-			{
-				if (array_key_exists($oFilter->GetClassAlias(), $this->m_aPointingTo[$sExtKeyAttCode][$iOperatorCode]))
-				{
-//echo "<p style=\"color:red\">[".__LINE__."]this->m_aPointingTo[$sExtKeyAttCode][$iOperatorCode][".$oFilter->GetFirstJoinedClassAlias()."]:<pre>\n".print_r($this->m_aPointingTo[$sExtKeyAttCode][$iOperatorCode], true)."</pre>;</p>";
-					$bSamePointingTo = true;
-				}
-			}
-		}
+	protected function AddCondition_PointingTo_InNameSpace(DBObjectSearch $oFilter, $sExtKeyAttCode, &$aClassAliases, &$aAliasTranslation, $iOperatorCode)
+	{
+		// Find the node on which the new tree must be attached (most of the time it is "this")
+		$oReceivingFilter = $this->GetNode($this->GetClassAlias());
 
-//echo "<p style=\"color:red\">[".__LINE__."]Calling: AddToNameSpace([".implode(',', $aClassAliases)."], [".implode(',', $aAliasTranslation)."]);</p>";
-		if ($bSamePointingTo)
-		{
-//echo "<p style=\"color:red\">[".__LINE__."]AddPointingTo: Merging filters for [$sExtKeyAttCode][$iOperatorCode][".$oFilter->GetClassAlias()."]</p>";
-			// Same ext key, alias and same operator, merge the filters together
-//			$sAlias = $oFilter->GetClassAlias();
-//echo "<p style=\"color:red\">[".__LINE__."]before: AddToNameSpace(aClassAliases[<pre>\n".print_r($aClassAliases, true)."</pre>], aAliasTranslation[<pre>\n".print_r($aAliasTranslation, true)."</pre>]);</p>";
-			$oFilter->AddToNamespace($aClassAliases, $aAliasTranslation, true /* Don't translate the main alias */);
-//echo "<p style=\"color:blue\">[".__LINE__."]after: AddToNameSpace(aClassAliases[<pre>\n".print_r($aClassAliases, true)."</pre>], aAliasTranslation[<pre>\n".print_r($aAliasTranslation, true)."</pre>]);</p>";
-//			$this->m_aPointingTo[$sExtKeyAttCode][$iOperatorCode][$sAlias]->MergeWith($oFilter, $aClassAliases, $aAliasTranslation);
-			$this->m_aPointingTo[$sExtKeyAttCode][$iOperatorCode][$oFilter->GetClassAlias()] = $oFilter;
-		}
-		else
-		{
-//echo "<p style=\"color:red\">[".__LINE__."]AddPointingTo: Adding a new PointingTo filter for [$sExtKeyAttCode][$iOperatorCode][".$oFilter->GetClassAlias()."]</p>";
-			$oFilter->AddToNamespace($aClassAliases, $aAliasTranslation);
-			$this->m_aPointingTo[$sExtKeyAttCode][$iOperatorCode][$oFilter->GetClassAlias()] = $oFilter;
-		}
+		$oFilter->AddToNamespace($aClassAliases, $aAliasTranslation);
+		$oReceivingFilter->m_aPointingTo[$sExtKeyAttCode][$iOperatorCode][] = $oFilter;
 	}
 
 	public function AddCondition_ReferencedBy(DBObjectSearch $oFilter, $sForeignExtKeyAttCode)
 	{
+		$sForeignClass = $oFilter->GetClass();
+		if (!MetaModel::IsValidKeyAttCode($sForeignClass, $sForeignExtKeyAttCode))
+		{
+			throw new CoreException("The attribute code '$sForeignExtKeyAttCode' is not an external key of the class '{$sForeignClass}'");
+		}
+		$oAttExtKey = MetaModel::GetAttributeDef($sForeignClass, $sForeignExtKeyAttCode);
+		if(!MetaModel::IsSameFamilyBranch($this->GetClass(), $oAttExtKey->GetTargetClass()))
+		{
+			// à refaire en spécifique dans FromOQL
+			throw new CoreException("The specified filter (objects referencing an object of class {$this->GetClass()}) is not compatible with the key '{$sForeignClass}::$sForeignExtKeyAttCode', which is pointing to {$oAttExtKey->GetTargetClass()}");
+		}
+		// Note: though it seems to be a good practice to clone the given source filter
+		//       (as it was done and fixed an issue in MergeWith())
+		//       this was not implemented here because it was causing a regression (login as admin, select an org, click on any badge)
+		//       root cause: FromOQL relies on the fact that the passed filter can be modified later 
+		// NO: $oFilter = $oFilter->DeepClone();
+		// See also: Trac #639, and self::AddCondition_PointingTo()
 		$aAliasTranslation = array();
 		$res = $this->AddCondition_ReferencedBy_InNameSpace($oFilter, $sForeignExtKeyAttCode, $this->m_aClasses, $aAliasTranslation);
 		$this->TransferConditionExpression($oFilter, $aAliasTranslation);
@@ -627,41 +782,26 @@ class DBObjectSearch
 	protected function AddCondition_ReferencedBy_InNameSpace(DBObjectSearch $oFilter, $sForeignExtKeyAttCode, &$aClassAliases, &$aAliasTranslation)
 	{
 		$sForeignClass = $oFilter->GetClass();
-		$sForeignClassAlias = $oFilter->GetClassAlias();
-		if (!MetaModel::IsValidKeyAttCode($sForeignClass, $sForeignExtKeyAttCode))
-		{
-			throw new CoreException("The attribute code '$sForeignExtKeyAttCode' is not an external key of the class '{$sForeignClass}' - the condition will be ignored");
-		}
-		$oAttExtKey = MetaModel::GetAttributeDef($sForeignClass, $sForeignExtKeyAttCode);
-		if(!MetaModel::IsSameFamilyBranch($this->GetClass(), $oAttExtKey->GetTargetClass()))
-		{
-			throw new CoreException("The specified filter (objects referencing an object of class {$this->GetClass()}) is not compatible with the key '{$sForeignClass}::$sForeignExtKeyAttCode', which is pointing to {$oAttExtKey->GetTargetClass()}");
-		}
+
+		// Find the node on which the new tree must be attached (most of the time it is "this")
+		$oReceivingFilter = $this->GetNode($this->GetClassAlias());
+
 		if (array_key_exists($sForeignClass, $this->m_aReferencedBy) && array_key_exists($sForeignExtKeyAttCode, $this->m_aReferencedBy[$sForeignClass]))
 		{
-			$this->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode]->MergeWith_InNamespace($oFilter, $aClassAliases, $aAliasTranslation);
+			$oReceivingFilter->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode]->MergeWith_InNamespace($oFilter, $aClassAliases, $aAliasTranslation);
 		}
 		else
 		{
 			$oFilter->AddToNamespace($aClassAliases, $aAliasTranslation);
 
 			// #@# The condition expression found in that filter should not be used - could be another kind of structure like a join spec tree !!!!
-			//$oNewFilter = clone $oFilter;
+			//$oNewFilter = $oFilter->DeepClone();
 			//$oNewFilter->ResetCondition();
 
-			$this->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode]= $oFilter;
+			$oReceivingFilter->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode]= $oFilter;
 		}
 	}
 
-	public function AddCondition_LinkedTo(DBObjectSearch $oLinkFilter, $sExtKeyAttCodeToMe, $sExtKeyAttCodeTarget, DBObjectSearch $oFilterTarget)
-	{
-		$oLinkFilterFinal = clone $oLinkFilter;
-		// todo : new function prototype
-		$oLinkFilterFinal->AddCondition_PointingTo($sExtKeyAttCodeToMe);
-
-		$this->AddCondition_ReferencedBy($oLinkFilterFinal, $sExtKeyAttCodeToMe);
-	}
-
 	public function AddCondition_RelatedTo(DBObjectSearch $oFilter, $sRelCode, $iMaxDepth)
 	{
 		MyHelpers::CheckValueInArray('relation code', $sRelCode, MetaModel::EnumRelations());
@@ -670,6 +810,7 @@ class DBObjectSearch
 
 	public function MergeWith($oFilter)
 	{
+		$oFilter = $oFilter->DeepClone();
 		$aAliasTranslation = array();
 		$res = $this->MergeWith_InNamespace($oFilter, $this->m_aClasses, $aAliasTranslation);
 		$this->TransferConditionExpression($oFilter, $aAliasTranslation);
@@ -693,7 +834,7 @@ class DBObjectSearch
 		{
 			foreach($aPointingTo as $iOperatorCode => $aFilter)
 			{
-				foreach($aFilter as $sAlias => $oExtFilter)
+				foreach($aFilter as $oExtFilter)
 				{
 					$this->AddCondition_PointingTo_InNamespace($oExtFilter, $sExtKeyAttCode, $aClassAliases, $aAliasTranslation, $iOperatorCode);
 				}
@@ -737,20 +878,47 @@ class DBObjectSearch
 	{
 		return $this->m_aRelatedTo;
 	}
+
+	public function SetInternalParams($aParams)
+	{
+		return $this->m_aParams = $aParams;
+	}
+
 	public function GetInternalParams()
 	{
 		return $this->m_aParams;
 	}
 
+	public function GetQueryParams()
+	{
+		$aParams = array();
+		$this->m_oSearchCondition->Render($aParams, true);
+		return $aParams;
+	}
+
+	public function ListConstantFields()
+	{
+		return $this->m_oSearchCondition->ListConstantFields();
+	}
+	
 	public function RenderCondition()
 	{
 		return $this->m_oSearchCondition->Render($this->m_aParams, false);
 	}
 
+	/**
+	 * Turn the parameters (:xxx) into scalar values in order to easily
+	 * serialize a search
+	 */
+	public function ApplyParameters($aArgs)
+	{
+		return $this->m_oSearchCondition->ApplyParameters(array_merge($this->m_aParams, $aArgs));
+	}
+	
 	public function serialize($bDevelopParams = false, $aContextParams = null)
 	{
 		$sOql = $this->ToOql($bDevelopParams, $aContextParams);
-		return base64_encode(serialize(array($sOql, $this->m_aParams)));
+		return base64_encode(serialize(array($sOql, $this->m_aParams, $this->m_aModifierProperties)));
 	}
 	
 	static public function unserialize($sValue)
@@ -761,7 +929,9 @@ class DBObjectSearch
 		// We've tried to use gzcompress/gzuncompress, but for some specific queries
 		// it was not working at all (See Trac #193)
 		// gzuncompress was issuing a warning "data error" and the return object was null
-		return self::FromOQL($sOql, $aParams);
+		$oRetFilter = self::FromOQL($sOql, $aParams);
+		$oRetFilter->m_aModifierProperties = $aData[2];
+		return $oRetFilter;
 	}
 
 	// SImple BUt Structured Query Languag - SubuSQL
@@ -857,6 +1027,7 @@ class DBObjectSearch
 			{
 				$aParams = array_merge($aContextParams, $this->m_aParams);
 			}
+			$aParams = MetaModel::PrepareQueryArguments($aParams);
 		}
 		else
 		{
@@ -867,7 +1038,7 @@ class DBObjectSearch
 		$sSelectedClasses = implode(', ', array_keys($this->m_aSelectedClasses));
 		$sRes = 'SELECT '.$sSelectedClasses.' FROM';
 
-		$sRes .= ' '.$this->GetClass().' AS '.$this->GetClassAlias();
+		$sRes .= ' '.$this->GetFirstJoinedClass().' AS '.$this->GetFirstJoinedClassAlias();
 		$sRes .= $this->ToOQL_Joins();
 		$sRes .= " WHERE ".$this->m_oSearchCondition->Render($aParams, $bRetrofitParams);
 
@@ -886,7 +1057,7 @@ class DBObjectSearch
 		{
 			foreach($aPointingTo as $iOperatorCode => $aFilter)
 			{
-				foreach($aFilter as $sAlias => $oFilter)
+				foreach($aFilter as $oFilter)
 				{
 					switch($iOperatorCode)
 					{
@@ -927,7 +1098,7 @@ class DBObjectSearch
 						break;
 						
 					}
-					$sRes .= ' JOIN '.$oFilter->GetClass().' AS '.$oFilter->GetClassAlias().' ON '.$this->GetClassAlias().'.'.$sExtKey.$sOperator.$oFilter->GetClassAlias().'.id';
+					$sRes .= ' JOIN '.$oFilter->GetFirstJoinedClass().' AS '.$oFilter->GetFirstJoinedClassAlias().' ON '.$this->GetFirstJoinedClassAlias().'.'.$sExtKey.$sOperator.$oFilter->GetFirstJoinedClassAlias().'.id';
 					$sRes .= $oFilter->ToOQL_Joins();				
 				}
 			}
@@ -936,7 +1107,7 @@ class DBObjectSearch
 		{
 			foreach($aReferences as $sForeignExtKeyAttCode=>$oForeignFilter)
 			{
-				$sRes .= ' JOIN '.$oForeignFilter->GetClass().' AS '.$oForeignFilter->GetClassAlias().' ON '.$oForeignFilter->GetClassAlias().'.'.$sForeignExtKeyAttCode.' = '.$this->GetClassAlias().'.id';
+				$sRes .= ' JOIN '.$oForeignFilter->GetFirstJoinedClass().' AS '.$oForeignFilter->GetFirstJoinedClassAlias().' ON '.$oForeignFilter->GetFirstJoinedClassAlias().'.'.$sForeignExtKeyAttCode.' = '.$this->GetFirstJoinedClassAlias().'.id';
 				$sRes .= $oForeignFilter->ToOQL_Joins();
 			}
 		}
@@ -958,7 +1129,7 @@ class DBObjectSearch
 			$sFltCode = $oExpression->GetName();
 			if (empty($sClassAlias))
 			{
-				// Try to find an alias
+				// Need to find the right alias
 				// Build an array of field => array of aliases
 				$aFieldClasses = array();
 				foreach($aClassAliases as $sAlias => $sReal)
@@ -968,29 +1139,8 @@ class DBObjectSearch
 						$aFieldClasses[$sAnFltCode][] = $sAlias;
 					}
 				}
-				if (!array_key_exists($sFltCode, $aFieldClasses))
-				{
-					throw new OqlNormalizeException('Unknown filter code', $sQuery, $oExpression->GetNameDetails(), array_keys($aFieldClasses));
-				}
-				if (count($aFieldClasses[$sFltCode]) > 1)
-				{
-					throw new OqlNormalizeException('Ambiguous filter code', $sQuery, $oExpression->GetNameDetails());
-				}
 				$sClassAlias = $aFieldClasses[$sFltCode][0];
 			}
-			else
-			{
-				if (!array_key_exists($sClassAlias, $aClassAliases))
-				{
-					throw new OqlNormalizeException('Unknown class [alias]', $sQuery, $oExpression->GetParentDetails(), array_keys($aClassAliases));
-				}
-				$sClass = $aClassAliases[$sClassAlias];
-				if (!MetaModel::IsValidFilterCode($sClass, $sFltCode))
-				{
-					throw new OqlNormalizeException('Unknown filter code', $sQuery, $oExpression->GetNameDetails(), MetaModel::GetFiltersList($sClass));
-				}
-			}
-
 			return new FieldExpression($sFltCode, $sClassAlias);
 		}
 		elseif ($oExpression instanceof VariableOqlExpression)
@@ -1061,20 +1211,23 @@ class DBObjectSearch
 		if ($bOQLCacheEnabled && array_key_exists($sQuery, self::$m_aOQLQueries))
 		{
 			// hit!
-			return clone self::$m_aOQLQueries[$sQuery];
+			$oClone = self::$m_aOQLQueries[$sQuery]->DeepClone();
+			if (!is_null($aParams))
+			{
+				$oClone->m_aParams = $aParams;
+			}
+			return $oClone;
 		}
 
 		$oOql = new OqlInterpreter($sQuery);
 		$oOqlQuery = $oOql->ParseObjectQuery();
-		
+
+		$oMetaModel = new ModelReflectionRuntime();
+		$oOqlQuery->Check($oMetaModel, $sQuery); // Exceptions thrown in case of issue
+
 		$sClass = $oOqlQuery->GetClass();
 		$sClassAlias = $oOqlQuery->GetClassAlias();
 
-		if (!MetaModel::IsValidClass($sClass))
-		{
-			throw new OqlNormalizeException('Unknown class', $sQuery, $oOqlQuery->GetClassDetails(), MetaModel::GetClasses());
-		}
-
 		$oResultFilter = new DBObjectSearch($sClass, $sClassAlias);
 		$aAliases = array($sClassAlias => $sClass);
 
@@ -1090,21 +1243,6 @@ class DBObjectSearch
 			{
 				$sJoinClass = $oJoinSpec->GetClass();
 				$sJoinClassAlias = $oJoinSpec->GetClassAlias();
-				if (!MetaModel::IsValidClass($sJoinClass))
-				{
-					throw new OqlNormalizeException('Unknown class', $sQuery, $oJoinSpec->GetClassDetails(), MetaModel::GetClasses());
-				}
-				if (array_key_exists($sJoinClassAlias, $aAliases))
-				{
-					if ($sJoinClassAlias != $sJoinClass)
-					{
-						throw new OqlNormalizeException('Duplicate class alias', $sQuery, $oJoinSpec->GetClassAliasDetails());
-					}
-					else
-					{
-						throw new OqlNormalizeException('Duplicate class name', $sQuery, $oJoinSpec->GetClassDetails());
-					}
-				} 
 
 				// Assumption: ext key on the left only !!!
 				// normalization should take care of this
@@ -1114,32 +1252,17 @@ class DBObjectSearch
 
 				$oRightField = $oJoinSpec->GetRightField();
 				$sToClass = $oRightField->GetParent();
-				$sPKeyDescriptor = $oRightField->GetName();
-				if ($sPKeyDescriptor != 'id')
-				{
-					throw new OqlNormalizeException('Wrong format for Join clause (right hand), expecting an id', $sQuery, $oRightField->GetNameDetails(), array('id'));
-				}
 
 				$aAliases[$sJoinClassAlias] = $sJoinClass;
 				$aJoinItems[$sJoinClassAlias] = new DBObjectSearch($sJoinClass, $sJoinClassAlias);
 
-				if (!array_key_exists($sFromClass, $aJoinItems))
-				{
-					throw new OqlNormalizeException('Unknown class in join condition (left expression)', $sQuery, $oLeftField->GetParentDetails(), array_keys($aJoinItems));
-				}
-				if (!array_key_exists($sToClass, $aJoinItems))
-				{
-					throw new OqlNormalizeException('Unknown class in join condition (right expression)', $sQuery, $oRightField->GetParentDetails(), array_keys($aJoinItems));
-				}
-				$aExtKeys = array_keys(MetaModel::GetExternalKeys($aAliases[$sFromClass]));
-				if (!in_array($sExtKeyAttCode, $aExtKeys))
-				{
-					throw new OqlNormalizeException('Unknown external key in join condition (left expression)', $sQuery, $oLeftField->GetNameDetails(), $aExtKeys);
-				}
-
 				if ($sFromClass == $sJoinClassAlias)
 				{
-					$aJoinItems[$sToClass]->AddCondition_ReferencedBy($aJoinItems[$sFromClass], $sExtKeyAttCode);
+					$oReceiver = $aJoinItems[$sToClass];
+					$oNewComer = $aJoinItems[$sFromClass];
+
+					$aAliasTranslation = array();
+					$oReceiver->AddCondition_ReferencedBy_InNameSpace($oNewComer, $sExtKeyAttCode, $oReceiver->m_aClasses, $aAliasTranslation);
 				}
 				else
 				{
@@ -1174,7 +1297,11 @@ class DBObjectSearch
 						$iOperatorCode = TREE_OPERATOR_NOT_ABOVE_STRICT;
 						break;
 					}
-					$aJoinItems[$sFromClass]->AddCondition_PointingTo($aJoinItems[$sToClass], $sExtKeyAttCode, $iOperatorCode);
+					$oReceiver = $aJoinItems[$sFromClass];
+					$oNewComer = $aJoinItems[$sToClass];
+
+					$aAliasTranslation = array();
+					$oReceiver->AddCondition_PointingTo_InNameSpace($oNewComer, $sExtKeyAttCode, $oReceiver->m_aClasses, $aAliasTranslation, $iOperatorCode);
 				}
 			}
 		}
@@ -1184,10 +1311,6 @@ class DBObjectSearch
 		foreach ($oOqlQuery->GetSelectedClasses() as $oClassDetails)
 		{
 			$sClassToSelect = $oClassDetails->GetValue();
-			if (!array_key_exists($sClassToSelect, $aAliases))
-			{
-				throw new OqlNormalizeException('Unknown class [alias]', $sQuery, $oClassDetails, array_keys($aAliases));
-			}
 			$aSelected[$sClassToSelect] = $aAliases[$sClassToSelect];
 		}
 		$oResultFilter->m_aClasses = $aAliases;
@@ -1206,7 +1329,7 @@ class DBObjectSearch
 
 		if ($bOQLCacheEnabled)
 		{
-			self::$m_aOQLQueries[$sQuery] = clone $oResultFilter;
+			self::$m_aOQLQueries[$sQuery] = $oResultFilter->DeepClone();
 		}
 
 		return $oResultFilter;

core/dbproperty.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Database properties - manage database instances in a complex installation
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 

core/deletionplan.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2013 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
- * Class dbObject: the root of persistent classes
+ * Algorithm to delete object(s) and maintain data integrity
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2013 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 class DeleteException extends CoreException
@@ -81,6 +82,9 @@ class DeletionPlan
 
 	public function ComputeResults()
 	{
+		$this->m_iToDelete = 0;
+		$this->m_iToUpdate = 0;
+
 		foreach($this->m_aToDelete as $sClass => $aToDelete)
 		{
 			foreach($aToDelete as $iId => $aData)
@@ -103,10 +107,15 @@ class DeletionPlan
 			}
 		}
 
+		// Getting and setting time limit are not symetric:
+		// www.php.net/manual/fr/function.set-time-limit.php#72305
+		$iPreviousTimeLimit = ini_get('max_execution_time');
+		$iLoopTimeLimit = MetaModel::GetConfig()->Get('max_execution_time_per_loop');
 		foreach($this->m_aToUpdate as $sClass => $aToUpdate)
 		{
 			foreach($aToUpdate as $iId => $aData)
 			{
+				set_time_limit($iLoopTimeLimit);
 				$this->m_iToUpdate++;
 
 				$oObject = $aData['to_reset'];
@@ -130,9 +139,9 @@ class DeletionPlan
 						$this->m_bFoundSecurityIssue = true;
 					}
 				}
-
 			}
 		}
+		set_time_limit($iPreviousTimeLimit);
 	}
 
 	public function GetIssues()

core/dict.class.inc.php

@@ -1,27 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * Class Dict
  * Management of localizable strings 
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 class DictException extends CoreException
@@ -120,7 +120,7 @@ class Dict
 	}
 
 
-	public static function S($sStringCode, $sDefault = null)
+	public static function S($sStringCode, $sDefault = null, $bUserLanguageOnly = false)
 	{
 		// Attempt to find the string in the user language
 		//
@@ -134,19 +134,22 @@ class Dict
 		{
 			return $aCurrentDictionary[$sStringCode];
 		}
-		// Attempt to find the string in the default language
-		//
-		$aDefaultDictionary = self::$m_aData[self::$m_sDefaultLanguage];
-		if (array_key_exists($sStringCode, $aDefaultDictionary))
+		if (!$bUserLanguageOnly)
 		{
-			return $aDefaultDictionary[$sStringCode];
-		}
-		// Attempt to find the string in english
-		//
-		$aDefaultDictionary = self::$m_aData['EN US'];
-		if (array_key_exists($sStringCode, $aDefaultDictionary))
-		{
-			return $aDefaultDictionary[$sStringCode];
+			// Attempt to find the string in the default language
+			//
+			$aDefaultDictionary = self::$m_aData[self::$m_sDefaultLanguage];
+			if (array_key_exists($sStringCode, $aDefaultDictionary))
+			{
+				return $aDefaultDictionary[$sStringCode];
+			}
+			// Attempt to find the string in english
+			//
+			$aDefaultDictionary = self::$m_aData['EN US'];
+			if (array_key_exists($sStringCode, $aDefaultDictionary))
+			{
+				return $aDefaultDictionary[$sStringCode];
+			}
 		}
 		// Could not find the string...
 		//
@@ -220,6 +223,20 @@ class Dict
 		}
 	}
 
+	/**
+	 * Clone a string in every language (if it exists in that language)
+	 */	 	
+	public static function CloneString($sSourceCode, $sDestCode)
+	{
+		foreach(self::$m_aLanguages as $sLanguageCode => $foo)
+		{
+			if (isset(self::$m_aData[$sLanguageCode][$sSourceCode]))
+			{
+				self::$m_aData[$sLanguageCode][$sDestCode] = self::$m_aData[$sLanguageCode][$sSourceCode];
+			}
+		}
+	}
+
 	public static function MakeStats($sLanguageCode, $sLanguageRef = 'EN US')
 	{
 		$aMissing = array(); // Strings missing for the target language

core/email.class.inc.php

@@ -1,66 +1,150 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
- * Send an mail (for notification, testing,... purposes)
- * #@# TODO - replace by a more sophisticated mean (and update the prototype) 
+ * Send an email (abstraction for synchronous/asynchronous modes)
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
+require_once(APPROOT.'/lib/swiftmailer/lib/swift_required.php');
+
+Swift_Preferences::getInstance()->setCharset('UTF-8');
+
+
 define ('EMAIL_SEND_OK', 0);
 define ('EMAIL_SEND_PENDING', 1);
 define ('EMAIL_SEND_ERROR', 2);
 
-
 class EMail
 {
-	protected $m_sBody;
-	protected $m_sSubject;
-	protected $m_sTo;
-	protected $m_aHeaders; // array of key=>value
-	protected $m_aAttachments;
+	// Serialization formats
+	const ORIGINAL_FORMAT = 1; // Original format, consisting in serializing the whole object, inculding the Swift Mailer's object.
+							   // Did not work with attachements since their binary representation cannot be stored as a valid UTF-8 string
+	const FORMAT_V2 = 2; // New format, only the raw data are serialized (base64 encoded if needed)
+	
+	protected static $m_oConfig = null;
+	protected $m_aData; // For storing data to serialize
 
-	public function __construct($sTo = '', $sSubject = '', $sBody = '', $aHeaders = array())
+	public function LoadConfig($sConfigFile = ITOP_DEFAULT_CONFIG_FILE)
 	{
-		$this->m_sTo = $sTo;
-		$this->m_sSubject = $sSubject;
-		$this->m_sBody = $sBody;
-		$this->m_aHeaders = $aHeaders;
-		$this->m_aAttachments = array();
+		if (is_null(self::$m_oConfig))
+		{
+			self::$m_oConfig = new Config($sConfigFile);
+		}
 	}
 
-	// Errors management : not that simple because we need that function to be
-	// executed in the background, while making sure that any issue would be reported clearly
-	protected $m_aMailErrors; //array of strings explaining the issues
+	protected $m_oMessage;
 
-	public function mail_error_handler($errno, $errstr, $errfile, $errline)
+	public function __construct()
 	{
-		$sCleanMessage= str_replace("mail() [<a href='function.mail'>function.mail</a>]: ", "", $errstr);
-		$this->m_aMailErrors[] = $sCleanMessage;
+		$this->m_aData = array();
+		$this->m_oMessage = Swift_Message::newInstance();
+
+		$oEncoder = new Swift_Mime_ContentEncoder_PlainContentEncoder('8bit');
+		$this->m_oMessage->setEncoder($oEncoder);
 	}
 
+	/**
+	 * Custom serialization method
+	 * No longer use the brute force "serialize" method since
+	 * 1) It does not work with binary attachments (since they cannot be stored in a UTF-8 text field)
+	 * 2) The size tends to be quite big (sometimes ten times the size of the email)
+	 */
+	public function SerializeV2()
+	{
+		return serialize($this->m_aData);
+	}
+	
+	/**
+	 * Custom de-serialization method
+	 * @param string $sSerializedMessage The serialized representation of the message
+	 */
+	static public function UnSerializeV2($sSerializedMessage)
+	{
+		$aData = unserialize($sSerializedMessage);
+		$oMessage = new Email();
+		
+		if (array_key_exists('body', $aData))
+		{
+			$oMessage->SetBody($aData['body']['body'], $aData['body']['mimeType']);
+		}
+		if (array_key_exists('message_id', $aData))
+		{
+			$oMessage->SetMessageId($aData['message_id']);
+		}
+		if (array_key_exists('bcc', $aData))
+		{
+			$oMessage->SetRecipientBCC($aData['bcc']);
+		}
+		if (array_key_exists('cc', $aData))
+		{
+			$oMessage->SetRecipientCC($aData['cc']);
+		}
+		if (array_key_exists('from', $aData))
+		{
+			$oMessage->SetRecipientFrom($aData['from']['address'], $aData['from']['label']);
+		}
+		if (array_key_exists('reply_to', $aData))
+		{
+			$oMessage->SetRecipientReplyTo($aData['reply_to']);
+		}
+		if (array_key_exists('to', $aData))
+		{
+			$oMessage->SetRecipientTO($aData['to']);
+		}
+		if (array_key_exists('subject', $aData))
+		{
+			$oMessage->SetSubject($aData['subject']);
+		}
+		
+		
+		if (array_key_exists('headers', $aData))
+		{
+			foreach($aData['headers'] as $sKey => $sValue)
+			{
+				$oMessage->AddToHeader($sKey, $sValue);
+			}
+		}
+		if (array_key_exists('parts', $aData))
+		{
+			foreach($aData['parts'] as $aPart)
+			{
+				$oMessage->AddPart($aPart['text'], $aPart['mimeType']);
+			}
+		}
+		if (array_key_exists('attachments', $aData))
+		{
+			foreach($aData['attachments'] as $aAttachment)
+			{
+				$oMessage->AddAttachment(base64_decode($aAttachment['data']), $aAttachment['filename'], $aAttachment['mimeType']);
+			}
+		}
+		return $oMessage;
+	}
+	
   	protected function SendAsynchronous(&$aIssues, $oLog = null)
 	{
 		try
 		{
-			AsyncSendEmail::AddToQueue($this->m_sTo, $this->m_sSubject, $this->m_sBody, $this->m_aHeaders, $oLog);
+			AsyncSendEmail::AddToQueue($this, $oLog);
 		}
 		catch(Exception $e)
 		{
@@ -73,40 +157,40 @@ class EMail
 
 	protected function SendSynchronous(&$aIssues, $oLog = null)
 	{
-		$sHeaders  = 'MIME-Version: 1.0' . "\r\n";
-		// ! the case is important for MS-Outlook
-		if (!array_key_exists('Content-Type', $this->m_aHeaders))
+		$this->LoadConfig();
+
+		$sTransport = self::$m_oConfig->Get('email_transport');
+		switch ($sTransport)
 		{
-			$sHeaders .= 'Content-Type: text/html; charset=UTF-8' . "\r\n";
-		}
-		if (!array_key_exists('Content-Transfer-Encoding', $this->m_aHeaders))
-		{
-			$sHeaders .= 'Content-Transfer-Encoding: 8bit' . "\r\n";
-		}
-		foreach ($this->m_aHeaders as $sKey => $sValue)
-		{
-			$sHeaders .= "$sKey: $sValue\r\n";
+		case 'SMTP':
+			$sHost = self::$m_oConfig->Get('email_transport_smtp.host');
+			$sPort = self::$m_oConfig->Get('email_transport_smtp.port');
+			$sEncryption = self::$m_oConfig->Get('email_transport_smtp.encryption');
+			$sUserName = self::$m_oConfig->Get('email_transport_smtp.username');
+			$sPassword = self::$m_oConfig->Get('email_transport_smtp.password');
+
+			$oTransport = Swift_SmtpTransport::newInstance($sHost, $sPort, $sEncryption);
+			if (strlen($sUserName) > 0)
+			{
+				$oTransport->setUsername($sUserName);
+				$oTransport->setPassword($sPassword);
+			}
+			break;
+
+		case 'PHPMail':
+		default:
+			$oTransport = Swift_MailTransport::newInstance();
 		}
 
-		// Under Windows (not yet proven for Linux/PHP) mail may issue a warning
-		// that I could not mask (tried error_reporting(), etc.)
-		$this->m_aMailErrors = array();
-		set_error_handler(array($this, 'mail_error_handler'));
-		$bRes = mail
-		(
-			str_replace(array("\n", "\r"), ' ', $this->m_sTo), // Prevent header injection
-			str_replace(array("\n", "\r"), ' ', $this->m_sSubject), // Prevent header injection
-			$this->m_sBody,
-			$sHeaders
-		);
-		restore_error_handler();
-		if (!$bRes && empty($this->m_aMailErrors))
+		$oMailer = Swift_Mailer::newInstance($oTransport);
+
+		$aFailedRecipients = array();
+		$iSent = $oMailer->send($this->m_oMessage, $aFailedRecipients);
+		if ($iSent === 0)
 		{
-			$this->m_aMailErrors[] = 'Unknown reason';
-		}
-		if (count($this->m_aMailErrors) > 0)
-		{
-			$aIssues = $this->m_aMailErrors;
+			// Beware: it seems that $aFailedRecipients sometimes contains the recipients that actually received the message !!!
+			IssueLog::Warning('Email sending failed: Some recipients were invalid, aFailedRecipients contains: '.implode(', ', $aFailedRecipients));
+			$aIssues = array('Some recipients were invalid.');
 			return EMAIL_SEND_ERROR;
 		}
 		else
@@ -118,7 +202,6 @@ class EMail
 
 	public function Send(&$aIssues, $bForceSynchronous = false, $oLog = null)
 	{	
-		$this->BuildMessage(); // assemble the attachments into the header/body structure
 		if ($bForceSynchronous)
 		{
 			return $this->SendSynchronous($aIssues, $oLog);
@@ -137,89 +220,180 @@ class EMail
 		}
 	}
 
-	protected function AddToHeader($sKey, $sValue)
+	public function AddToHeader($sKey, $sValue)
 	{
+		if (!array_key_exists('headers', $this->m_aData))
+		{
+			$this->m_aData['headers'] = array();
+		}
+		$this->m_aData['headers'][$sKey] = $sValue;
+		
 		if (strlen($sValue) > 0)
 		{
-			$this->m_aHeaders[$sKey] = $sValue;
+			$oHeaders = $this->m_oMessage->getHeaders();
+			switch(strtolower($sKey))
+			{
+				default:
+				$oHeaders->addTextHeader($sKey, $sValue);
+			}
 		}
 	}
+
+	public function SetMessageId($sId)
+	{
+		$this->m_aData['message_id'] = $sId;
+		
+		// Note: Swift will add the angle brackets for you
+		// so let's remove the angle brackets if present, for historical reasons
+		$sId = str_replace(array('<', '>'), '', $sId);
+		
+		$oMsgId = $this->m_oMessage->getHeaders()->get('Message-ID');
+		$oMsgId->SetId($sId);
+	}
 	
 	public function SetReferences($sReferences)
 	{
 		$this->AddToHeader('References', $sReferences);
 	}
 
-	public function SetBody($sBody)
+	public function SetBody($sBody, $sMimeType = 'text/html')
 	{
-		$this->m_sBody = $sBody;
+		$this->m_aData['body'] = array('body' => $sBody, 'mimeType' => $sMimeType);
+		$this->m_oMessage->setBody($sBody, $sMimeType);
 	}
 
-	public function SetSubject($aSubject)
+	public function AddPart($sText, $sMimeType = 'text/html')
 	{
-		$this->m_sSubject = $aSubject;
-	}
-
-	public function SetRecipientTO($sAddress)
-	{
-		$this->m_sTo = $sAddress;
-	}
-
-	public function SetRecipientCC($sAddress)
-	{
-		$this->AddToHeader('Cc', $sAddress);
-	}
-
-	public function SetRecipientBCC($sAddress)
-	{
-		$this->AddToHeader('Bcc', $sAddress);
-	}
-
-	public function SetRecipientFrom($sAddress)
-	{
-		$this->AddToHeader('From', $sAddress);
-
-		// This is required on Windows because otherwise I would get the error
-		// "sendmail_from" not set in php.ini" even if it is correctly working
-		// (apparently, once it worked the SMTP server won't claim anymore for it)
-		ini_set("sendmail_from", $sAddress);
-	}
-
-	public function SetRecipientReplyTo($sAddress)
-	{
-		$this->AddToHeader('Reply-To', $sAddress);
+		if (!array_key_exists('parts', $this->m_aData))
+		{
+			$this->m_aData['parts'] = array();
+		}
+		$this->m_aData['parts'][] = array('text' => $sText, 'mimeType' => $sMimeType);
+		$this->m_oMessage->addPart($sText, $sMimeType);
 	}
 
 	public function AddAttachment($data, $sFileName, $sMimeType)
 	{
-		$this->m_aAttachments[] = array('data' => $data, 'filename' => $sFileName, 'mimeType' => $sMimeType);
+		if (!array_key_exists('attachments', $this->m_aData))
+		{
+			$this->m_aData['attachments'] = array();
+		}
+		$this->m_aData['attachments'][] = array('data' => base64_encode($data), 'filename' => $sFileName, 'mimeType' => $sMimeType);
+		$this->m_oMessage->attach(Swift_Attachment::newInstance($data, $sFileName, $sMimeType));
+	}
+
+	public function SetSubject($sSubject)
+	{
+		$this->m_aData['subject'] = $sSubject;
+		$this->m_oMessage->setSubject($sSubject);
+	}
+
+	public function GetSubject()
+	{
+		return $this->m_oMessage->getSubject();
+	}
+
+	/**
+	 * Helper to transform and sanitize addresses
+	 * - get rid of empty addresses	 
+	 */	 	
+	protected function AddressStringToArray($sAddressCSVList)
+	{
+		$aAddresses = array();
+		foreach(explode(',', $sAddressCSVList) as $sAddress)
+		{
+			$sAddress = trim($sAddress);
+			if (strlen($sAddress) > 0)
+			{
+				$aAddresses[] = $sAddress;
+			}
+		}
+		return $aAddresses;
 	}
 	
-	/**
-	 * Takes care of the attachments (if any) to build the header/body of the message before storing or sending it
-	 */
-	protected function BuildMessage()
+	public function SetRecipientTO($sAddress)
 	{
-		if (count($this->m_aAttachments) == 0) return; // Nothing to do if there are no attachments
-
-		$sDelimiter = '== iTopEmailPart---'.md5(date('r', time()))." ==";
- 		$sContentType = isset($this->m_aHeaders['Content-Type']) ? $this->m_aHeaders['Content-Type'] : 'text/html';
- 		$sContentHeader = "Content-Type: $sContentType\r\n";
- 		$this->m_aHeaders['Content-Type'] = "multipart/mixed; boundary=\"{$sDelimiter}\"";
-
-		$aAttachments = array();
- 		foreach($this->m_aAttachments as $aAttach)
- 		{
-	 		$sAttachmentHeader = "Content-Type: {$aAttach['mimeType']};\r\n Name=\"{$aAttach['filename']}\"\r\n";
-	  		$sAttachmentHeader .= "Content-Transfer-Encoding: base64\r\nContent-Disposition: attachment;\r\n filename=\"{$aAttach['filename']}\"\r\n";
-	  		$sAttachmentHeader .= "\r\n";
-			$sAttachment = chunk_split(base64_encode($aAttach['data']));
-			$aAttachments[] = $sAttachmentHeader.$sAttachment."\r\n";
- 		}
-	  	$this->m_sBody = "This is a multi-part message in MIME format.\r\n--".$sDelimiter."\r\n".$sContentHeader."\r\n".$this->m_sBody."\r\n--".$sDelimiter."\r\n";
-	  	$this->m_sBody .= implode("--".$sDelimiter."\r\n", $aAttachments);
-	  	$this->m_sBody .= "--".$sDelimiter."--";
+		$this->m_aData['to'] = $sAddress;
+		if (!empty($sAddress))
+		{
+			$aAddresses = $this->AddressStringToArray($sAddress);
+			$this->m_oMessage->setTo($aAddresses);
+		}
 	}
+
+	public function GetRecipientTO($bAsString = false)
+	{
+		$aRes = $this->m_oMessage->getTo();
+		if ($aRes === null)
+		{
+			// There is no "To" header field
+			$aRes = array();
+		}
+		if ($bAsString)
+		{
+			$aStrings = array();
+			foreach ($aRes as $sEmail => $sName)
+			{
+				if (is_null($sName))
+				{
+					$aStrings[] = $sEmail;
+				}
+				else
+				{
+					$sName = str_replace(array('<', '>'), '', $sName);
+					$aStrings[] = "$sName <$sEmail>";
+				}
+			}
+			return implode(', ', $aStrings);
+		}
+		else
+		{
+			return $aRes;
+		}
+	}
+
+	public function SetRecipientCC($sAddress)
+	{
+		$this->m_aData['cc'] = $sAddress;
+		if (!empty($sAddress))
+		{
+			$aAddresses = $this->AddressStringToArray($sAddress);
+			$this->m_oMessage->setCc($aAddresses);
+		}
+	}
+
+	public function SetRecipientBCC($sAddress)
+	{
+		$this->m_aData['bcc'] = $sAddress;
+		if (!empty($sAddress))
+		{
+			$aAddresses = $this->AddressStringToArray($sAddress);
+			$this->m_oMessage->setBcc($aAddresses);
+		}
+	}
+
+	public function SetRecipientFrom($sAddress, $sLabel = '')
+	{
+		$this->m_aData['from'] = array('address' => $sAddress, 'label' => $sLabel);
+		if ($sLabel != '')
+		{
+			$this->m_oMessage->setFrom(array($sAddress => $sLabel));		
+		}
+		else if (!empty($sAddress))
+		{
+			$this->m_oMessage->setFrom($sAddress);
+		}
+	}
+
+	public function SetRecipientReplyTo($sAddress)
+	{
+		$this->m_aData['reply_to'] = $sAddress;
+		if (!empty($sAddress))
+		{
+			$this->m_oMessage->setReplyTo($sAddress);
+		}
+	}
+
 }
 
 ?>

core/event.class.inc.php

@@ -1,28 +1,29 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2013 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Persistent class Event and derived
  * Application internal events
  * There is also a file log 
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 class Event extends DBObject implements iDisplay
@@ -40,6 +41,7 @@ class Event extends DBObject implements iDisplay
 			"db_key_field" => "id",
 			"db_finalclass_field" => "realclass",
 			"display_template" => "",
+			"order_by_default" => array('date' => false)
 		);
 		MetaModel::Init_Params($aParams);
 		//MetaModel::Init_InheritAttributes();
@@ -103,9 +105,9 @@ class Event extends DBObject implements iDisplay
 		$this->DisplayBareProperties($oPage, $bEditMode);
 	}
 	
-	function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $aExtraParams = array())
+	function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = array())
 	{
-		if ($bEditMode) return; // Not editable
+		if ($bEditMode) return array(); // Not editable
 		
 		$aDetails = array();
 		$sClass = get_class($this);
@@ -116,6 +118,7 @@ class Event extends DBObject implements iDisplay
 			$aDetails[] = array('label' => '<span title="'.MetaModel::GetDescription($sClass, $sAttCode).'">'.MetaModel::GetLabel($sClass, $sAttCode).'</span>', 'value' => $sDisplayValue);
 		}
 		$oPage->Details($aDetails);
+		return array();
 	}
 }
 
@@ -134,6 +137,10 @@ class EventNotification extends Event
 			"db_key_field" => "id",
 			"db_finalclass_field" => "",
 			"display_template" => "",
+			"order_by_default" => array('date' => false),
+			'indexes' => array(
+				array('object_id'),
+			)
 		);
 		MetaModel::Init_Params($aParams);
 		MetaModel::Init_InheritAttributes();
@@ -166,6 +173,7 @@ class EventNotificationEmail extends EventNotification
 			"db_key_field" => "id",
 			"db_finalclass_field" => "",
 			"display_template" => "",
+			"order_by_default" => array('date' => false)
 		);
 		MetaModel::Init_Params($aParams);
 		MetaModel::Init_InheritAttributes();
@@ -174,11 +182,12 @@ class EventNotificationEmail extends EventNotification
 		MetaModel::Init_AddAttribute(new AttributeText("bcc", array("allowed_values"=>null, "sql"=>"bcc", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
 		MetaModel::Init_AddAttribute(new AttributeText("from", array("allowed_values"=>null, "sql"=>"from", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
 		MetaModel::Init_AddAttribute(new AttributeText("subject", array("allowed_values"=>null, "sql"=>"subject", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeText("body", array("allowed_values"=>null, "sql"=>"body", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeHTML("body", array("allowed_values"=>null, "sql"=>"body", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeTable("attachments", array("allowed_values"=>null, "sql"=>"attachments", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
 
 		// Display lists
-		MetaModel::Init_SetZListItems('details', array('date', 'userinfo', 'message', 'trigger_id', 'action_id', 'object_id', 'to', 'cc', 'bcc', 'from', 'subject', 'body')); // Attributes to be displayed for the complete details
-		MetaModel::Init_SetZListItems('list', array('date', 'message', 'to', 'subject')); // Attributes to be displayed for a list
+		MetaModel::Init_SetZListItems('details', array('date', 'userinfo', 'message', 'trigger_id', 'action_id', 'object_id', 'to', 'cc', 'bcc', 'from', 'subject', 'body', 'attachments')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('date', 'message', 'to', 'subject', 'attachments')); // Attributes to be displayed for a list
 
 		// Search criteria
 //		MetaModel::Init_SetZListItems('standard_search', array('name')); // Criteria of the std search form
@@ -202,6 +211,7 @@ class EventIssue extends Event
 			"db_key_field" => "id",
 			"db_finalclass_field" => "",
 			"display_template" => "",
+			"order_by_default" => array('date' => false)
 		);
 		MetaModel::Init_Params($aParams);
 		MetaModel::Init_InheritAttributes();
@@ -301,6 +311,7 @@ class EventWebService extends Event
 			"db_key_field" => "id",
 			"db_finalclass_field" => "",
 			"display_template" => "",
+			"order_by_default" => array('date' => false)
 		);
 		MetaModel::Init_Params($aParams);
 		MetaModel::Init_InheritAttributes();
@@ -335,19 +346,28 @@ class EventLoginUsage extends Event
 			"db_table" => "priv_event_loginusage",
 			"db_key_field" => "id",
 			"db_finalclass_field" => "",
+			"order_by_default" => array('date' => false)
 		);
 		MetaModel::Init_Params($aParams);
 		MetaModel::Init_InheritAttributes();
 
 		MetaModel::Init_AddAttribute(new AttributeExternalKey("user_id", array("targetclass"=>"User", "jointype"=> "", "allowed_values"=>null, "sql"=>"user_id", "is_null_allowed"=>false, "on_target_delete"=>DEL_MANUAL, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeExternalField("contact_name", array("allowed_values"=>null, "extkey_attcode"=>"user_id", "target_attcode"=>"contactid", "is_null_allowed"=>true, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeExternalField("contact_email", array("allowed_values"=>null, "extkey_attcode"=>"user_id", "target_attcode"=>"email", "is_null_allowed"=>true, "depends_on"=>array())));
-
+		$aZList = array('date', 'user_id');
+		if (MetaModel::IsValidAttCode('Contact', 'name'))
+		{
+			MetaModel::Init_AddAttribute(new AttributeExternalField("contact_name", array("allowed_values"=>null, "extkey_attcode"=>"user_id", "target_attcode"=>"contactid", "is_null_allowed"=>true, "depends_on"=>array())));
+			$aZList[] = 'contact_name';
+		}
+		if (MetaModel::IsValidAttCode('Contact', 'email'))
+		{
+			MetaModel::Init_AddAttribute(new AttributeExternalField("contact_email", array("allowed_values"=>null, "extkey_attcode"=>"user_id", "target_attcode"=>"email", "is_null_allowed"=>true, "depends_on"=>array())));
+			$aZList[] = 'contact_email';
+		}
 		// Display lists
-		MetaModel::Init_SetZListItems('details', array('date', 'user_id', 'contact_name', 'contact_email', 'userinfo', 'message')); // Attributes to be displayed for the complete details
-		MetaModel::Init_SetZListItems('list', array('date', 'user_id', 'contact_name', 'contact_email', 'userinfo')); // Attributes to be displayed for a list
+		MetaModel::Init_SetZListItems('details', array_merge($aZList, array('userinfo', 'message'))); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array_merge($aZList, array('userinfo'))); // Attributes to be displayed for a list
 		// Search criteria
-		MetaModel::Init_SetZListItems('standard_search', array('date', 'user_id', 'contact_name', 'contact_email')); // Criteria of the std search form
+		MetaModel::Init_SetZListItems('standard_search', $aZList); // Criteria of the std search form
 //		MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
 	}
 }

core/expression.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * General definition of an expression tree (could be OQL, SQL or whatever) 
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 class MissingQueryArgument extends CoreException
@@ -36,11 +37,19 @@ abstract class Expression
 	// recursive rendering (aArgs used as input by default, or used as output if bRetrofitParams set to True
 	abstract public function Render(&$aArgs = null, $bRetrofitParams = false);
 
+	abstract public function ApplyParameters($aArgs);
+	
 	// recursively builds an array of class => fieldname
 	abstract public function ListRequiredFields();
 
-	abstract public function IsTrue();
+	// recursively list field parents ($aTable = array of sParent => dummy)
+	abstract public function CollectUsedParents(&$aTable);
 
+	abstract public function IsTrue();
+	
+	// recursively builds an array of [classAlias][fieldName] => value
+	abstract public function ListConstantFields();
+	
 	public function RequiresField($sClass, $sFieldName)
 	{
 		// #@# todo - optimize : this is called quite often when building a single query !
@@ -86,6 +95,19 @@ abstract class Expression
 	}
 	
 	abstract public function RenameParam($sOldName, $sNewName);
+
+	/**
+	 * Make the most relevant label, given the value of the expression
+	 * 	 
+	 * @param DBObjectSearch oFilter The context in which this expression has been used	 	
+	 * @param string sValue The value returned by the query, for this expression	 	
+	 * @param string sDefault The default value if no relevant label could be computed	 	
+	 * @return The label
+	 */	
+	public function MakeValueLabel($oFilter, $sValue, $sDefault)
+	{
+		return $sDefault;
+	}
 }
 
 class SQLExpression extends Expression
@@ -108,6 +130,10 @@ class SQLExpression extends Expression
 		return $this->m_sSQL;
 	}
 
+	public function ApplyParameters($aArgs)
+	{
+	}
+	
 	public function GetUnresolvedFields($sAlias, &$aUnresolved)
 	{
 	}
@@ -121,6 +147,15 @@ class SQLExpression extends Expression
 	{
 		return array();
 	}
+
+	public function CollectUsedParents(&$aTable)
+	{
+	}
+	
+	public function ListConstantFields()
+	{
+		return array();
+	}
 	
 	public function RenameParam($sOldName, $sNewName)
 	{
@@ -164,11 +199,11 @@ class BinaryExpression extends Expression
 		// return true if we are certain that it will be true
 		if ($this->m_sOperator == 'AND')
 		{
-			if ($this->m_oLeftExpr->IsTrue() && $this->m_oLeftExpr->IsTrue()) return true;
+			if ($this->m_oLeftExpr->IsTrue() && $this->m_oRightExpr->IsTrue()) return true;
 		}
 		return false;
 	}
-
+	
 	public function GetLeftExpr()
 	{
 		return $this->m_oLeftExpr;
@@ -192,7 +227,27 @@ class BinaryExpression extends Expression
 		$sRight = $this->GetRightExpr()->Render($aArgs, $bRetrofitParams);
 		return "($sLeft $sOperator $sRight)";
 	}
-
+	
+	public function ApplyParameters($aArgs)
+	{
+		if ($this->m_oLeftExpr instanceof VariableExpression)
+		{
+			$this->m_oLeftExpr = $this->m_oLeftExpr->GetAsScalar($aArgs);
+		}
+		else //if ($this->m_oLeftExpr instanceof Expression)
+		{
+			$this->m_oLeftExpr->ApplyParameters($aArgs);
+		}
+		if ($this->m_oRightExpr instanceof VariableExpression)
+		{
+			$this->m_oRightExpr = $this->m_oRightExpr->GetAsScalar($aArgs);
+		}
+		else //if ($this->m_oRightExpr instanceof Expression)
+		{
+			$this->m_oRightExpr->ApplyParameters($aArgs);
+		}
+	}
+	
 	public function GetUnresolvedFields($sAlias, &$aUnresolved)
 	{
 		$this->GetLeftExpr()->GetUnresolvedFields($sAlias, $aUnresolved);
@@ -212,6 +267,49 @@ class BinaryExpression extends Expression
 		$aRight = $this->GetRightExpr()->ListRequiredFields();
 		return array_merge($aLeft, $aRight);
 	}
+
+	public function CollectUsedParents(&$aTable)
+	{
+		$this->GetLeftExpr()->CollectUsedParents($aTable);
+		$this->GetRightExpr()->CollectUsedParents($aTable);
+	}
+	
+	/**
+	 * List all constant expression of the form <field> = <scalar> or <field> = :<variable>
+	 * Could be extended to support <field> = <function><constant_expression>
+	 */
+	public function ListConstantFields()
+	{
+		$aResult = array();
+		if ($this->m_sOperator == '=')
+		{
+			if (($this->m_oLeftExpr instanceof FieldExpression) && ($this->m_oRightExpr instanceof ScalarExpression))
+			{
+				$aResult[$this->m_oLeftExpr->GetParent()][$this->m_oLeftExpr->GetName()] = $this->m_oRightExpr;
+			}
+			else if (($this->m_oRightExpr instanceof FieldExpression) && ($this->m_oLeftExpr instanceof ScalarExpression))
+			{
+				$aResult[$this->m_oRightExpr->GetParent()][$this->m_oRightExpr->GetName()] = $this->m_oLeftExpr;
+			}
+			else if (($this->m_oLeftExpr instanceof FieldExpression) && ($this->m_oRightExpr instanceof VariableExpression))
+			{
+				$aResult[$this->m_oLeftExpr->GetParent()][$this->m_oLeftExpr->GetName()] = $this->m_oRightExpr;
+			}
+			else if (($this->m_oRightExpr instanceof FieldExpression) && ($this->m_oLeftExpr instanceof VariableExpression))
+			{
+				$aResult[$this->m_oRightExpr->GetParent()][$this->m_oRightExpr->GetName()] = $this->m_oLeftExpr;
+			}
+			else
+			{
+				$aResult = array_merge($this->m_oRightExpr->ListConstantFields(), $this->m_oLeftExpr->ListConstantFields()) ;
+			}
+		}
+		else
+		{
+			$aResult = array_merge($this->m_oRightExpr->ListConstantFields(), $this->m_oLeftExpr->ListConstantFields()) ;
+		}
+		return $aResult;
+	}
 	
 	public function RenameParam($sOldName, $sNewName)
 	{
@@ -244,18 +342,13 @@ class UnaryExpression extends Expression
 	// recursive rendering
 	public function Render(&$aArgs = null, $bRetrofitParams = false)
 	{
-		if ($bRetrofitParams)
-		{
-			$iParamIndex = count($aArgs) + 1; // 1-based indexation
-			$aArgs['param'.$iParamIndex] = $this->m_value;
-			return ':param'.$iParamIndex;
-		}
-		else
-		{
-			return CMDBSource::Quote($this->m_value);
-		}
+		return CMDBSource::Quote($this->m_value);
 	}
 
+	public function ApplyParameters($aArgs)
+	{
+	}
+	
 	public function GetUnresolvedFields($sAlias, &$aUnresolved)
 	{
 	}
@@ -269,6 +362,15 @@ class UnaryExpression extends Expression
 	{
 		return array();
 	}
+
+	public function CollectUsedParents(&$aTable)
+	{
+	}
+
+	public function ListConstantFields()
+	{
+		return array();
+	}
 	
 	public function RenameParam($sOldName, $sNewName)
 	{
@@ -281,12 +383,31 @@ class ScalarExpression extends UnaryExpression
 {
 	public function __construct($value)
 	{
-		if (!is_scalar($value))
+		if (!is_scalar($value) && !is_null($value) && (!$value instanceof OqlHexValue))
 		{
 			throw new CoreException('Attempt to create a scalar expression from a non scalar', array('var_type'=>gettype($value)));
 		}
 		parent::__construct($value);
 	}
+
+	// recursive rendering
+	public function Render(&$aArgs = null, $bRetrofitParams = false)
+	{
+		if (is_null($this->m_value))
+		{
+			$sRet = 'NULL';
+		}
+		else
+		{
+			$sRet = CMDBSource::Quote($this->m_value);
+		}
+		return $sRet;
+	}
+
+	public function GetAsScalar($aArgs)
+	{
+		return clone $this;
+	}
 }
 
 class TrueExpression extends ScalarExpression
@@ -352,6 +473,11 @@ class FieldExpression extends UnaryExpression
 		return array($this->m_sParent.'.'.$this->m_sName);
 	}
 
+	public function CollectUsedParents(&$aTable)
+	{
+		$aTable[$this->m_sParent] = true;
+	}
+
 	public function GetUnresolvedFields($sAlias, &$aUnresolved)
 	{
 		if ($this->m_sParent == $sAlias)
@@ -359,6 +485,12 @@ class FieldExpression extends UnaryExpression
 			// Add a reference to the field
 			$aUnresolved[$this->m_sName] = $this;
 		}
+		elseif ($sAlias == '')
+		{
+			// An empty alias means "any alias"
+			// In such a case, the results are indexed differently
+			$aUnresolved[$this->m_sParent][$this->m_sName] = $this;
+		}
 	}
 
 	public function Translate($aTranslationData, $bMatchAll = true, $bMarkFieldsAsResolved = true)
@@ -393,6 +525,52 @@ class FieldExpression extends UnaryExpression
 		}
 		return $oRet;
 	}
+
+	/**
+	 * Make the most relevant label, given the value of the expression
+	 * 	 
+	 * @param DBObjectSearch oFilter The context in which this expression has been used	 	
+	 * @param string sValue The value returned by the query, for this expression	 	
+	 * @param string sDefault The default value if no relevant label could be computed	 	
+	 * @return The label
+	 */	
+	public function MakeValueLabel($oFilter, $sValue, $sDefault)
+	{
+		$sAttCode = $this->GetName();
+		$sParentAlias = $this->GetParent();
+
+		$aSelectedClasses = $oFilter->GetSelectedClasses();
+		$sClass = $aSelectedClasses[$sParentAlias];
+
+		$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+		// Set a default value for the general case
+		$sRes = $oAttDef->GetAsHtml($sValue);
+
+		// Exceptions...
+		if ($oAttDef->IsExternalKey())
+		{
+			$sObjClass = $oAttDef->GetTargetClass();
+			$iObjKey = (int)$sValue;
+			if ($iObjKey > 0)
+			{
+				$oObject = MetaModel::GetObject($sObjClass, $iObjKey);
+				$sRes = $oObject->GetHyperlink();
+			}
+			else
+			{
+				// Undefined
+				$sRes = DBObject::MakeHyperLink($sObjClass, 0);
+			}
+		}
+		elseif ($oAttDef->IsExternalField())
+		{
+			if (is_null($sValue))
+			{
+				$sRes = Dict::S('UI:UndefinedObject');
+			}
+		}
+		return $sRes;
+	}
 }
 
 // Has been resolved into an SQL expression
@@ -438,14 +616,29 @@ class VariableExpression extends UnaryExpression
 		{
 			return CMDBSource::Quote($aArgs[$this->m_sName]);
 		}
-		elseif ($bRetrofitParams)
+		elseif (($iPos = strpos($this->m_sName, '->')) !== false)
 		{
-			//$aArgs[$this->m_sName] = null;
+			$sParamName = substr($this->m_sName, 0, $iPos);
+			if (array_key_exists($sParamName.'->object()', $aArgs))
+			{
+				$sAttCode = substr($this->m_sName, $iPos + 2);
+				$oObj = $aArgs[$sParamName.'->object()'];
+				if ($sAttCode == 'id')
+				{
+					return CMDBSource::Quote($oObj->GetKey());
+				}
+				return CMDBSource::Quote($oObj->Get($sAttCode));
+			}
+		}
+
+		if ($bRetrofitParams)
+		{
+			$aArgs[$this->m_sName] = null;
 			return ':'.$this->m_sName;
 		}
 		else
 		{
-			throw new MissingQueryArgument('Missing query argument', array('expecting'=>$this->m_sName, 'available'=>$aArgs));
+			throw new MissingQueryArgument('Missing query argument', array('expecting'=>$this->m_sName, 'available'=>array_keys($aArgs)));
 		}
 	}
 	
@@ -456,6 +649,37 @@ class VariableExpression extends UnaryExpression
 			$this->m_sName = $sNewName;
 		}
 	}
+	
+	public function GetAsScalar($aArgs)
+	{
+		$value = null;
+		if (array_key_exists($this->m_sName, $aArgs))
+		{
+			$value = $aArgs[$this->m_sName];
+		}
+		elseif (($iPos = strpos($this->m_sName, '->')) !== false)
+		{
+			$sParamName = substr($this->m_sName, 0, $iPos);
+			if (array_key_exists($sParamName.'->object()', $aArgs))
+			{
+				$sAttCode = substr($this->m_sName, $iPos + 2);
+				$oObj = $aArgs[$sParamName.'->object()'];
+				if ($sAttCode == 'id')
+				{
+					$value = $oObj->GetKey();
+				}
+				else
+				{
+					$value = $oObj->Get($sAttCode);
+				}
+			}
+		}
+		if (is_null($value))
+		{
+			throw new MissingQueryArgument('Missing query argument', array('expecting'=>$this->m_sName, 'available'=>array_keys($aArgs)));
+		}
+		return new ScalarExpression($value);
+	}
 }
 
 // Temporary, until we implement functions and expression casting!
@@ -501,6 +725,22 @@ class ListExpression extends Expression
 		return '('.implode(', ', $aRes).')';
 	}
 
+	public function ApplyParameters($aArgs)
+	{
+		$aRes = array();
+		foreach ($this->m_aExpressions as $idx => $oExpr)
+		{
+			if ($oExpr instanceof VariableExpression)
+			{
+				$this->m_aExpressions[$idx] = $oExpr->GetAsScalar();
+			}
+			else
+			{
+				$oExpr->ApplyParameters($aArgs);
+			}
+		}
+	}
+	
 	public function GetUnresolvedFields($sAlias, &$aUnresolved)
 	{
 		foreach ($this->m_aExpressions as $oExpr)
@@ -529,6 +769,24 @@ class ListExpression extends Expression
 		return $aRes;
 	}
 	
+	public function CollectUsedParents(&$aTable)
+	{
+		foreach ($this->m_aExpressions as $oExpr)
+		{
+			$oExpr->CollectUsedParents($aTable);
+		}
+	}
+
+	public function ListConstantFields()
+	{
+		$aRes = array();
+		foreach ($this->m_aExpressions as $oExpr)
+		{
+			$aRes = array_merge($aRes, $oExpr->ListConstantFields());
+		}
+		return $aRes;
+	}
+	
 	public function RenameParam($sOldName, $sNewName)
 	{
 		$aRes = array();
@@ -578,6 +836,22 @@ class FunctionExpression extends Expression
 		return $this->m_sVerb.'('.implode(', ', $aRes).')';
 	}
 
+	public function ApplyParameters($aArgs)
+	{
+		$aRes = array();
+		foreach ($this->m_aArgs as $idx => $oExpr)
+		{
+			if ($oExpr instanceof VariableExpression)
+			{
+				$this->m_aArgs[$idx] = $oExpr->GetAsScalar($aArgs);
+			}
+			else
+			{
+				$oExpr->ApplyParameters($aArgs);
+			}
+		}
+	}
+
 	public function GetUnresolvedFields($sAlias, &$aUnresolved)
 	{
 		foreach ($this->m_aArgs as $oExpr)
@@ -606,13 +880,102 @@ class FunctionExpression extends Expression
 		return $aRes;
 	}
 	
+	public function CollectUsedParents(&$aTable)
+	{
+		foreach ($this->m_aArgs as $oExpr)
+		{
+			$oExpr->CollectUsedParents($aTable);
+		}
+	}
+
+	public function ListConstantFields()
+	{
+		$aRes = array();
+		foreach ($this->m_aArgs as $oExpr)
+		{
+			$aRes = array_merge($aRes, $oExpr->ListConstantFields());
+		}
+		return $aRes;
+	}
+	
 	public function RenameParam($sOldName, $sNewName)
 	{
 		foreach ($this->m_aArgs as $key => $oExpr)
 		{
 			$this->m_aArgs[$key] = $oExpr->RenameParam($sOldName, $sNewName);
 		}
-	}	
+	}
+
+	/**
+	 * Make the most relevant label, given the value of the expression
+	 * 	 
+	 * @param DBObjectSearch oFilter The context in which this expression has been used	 	
+	 * @param string sValue The value returned by the query, for this expression	 	
+	 * @param string sDefault The default value if no relevant label could be computed	 	
+	 * @return The label
+	 */	
+	public function MakeValueLabel($oFilter, $sValue, $sDefault)
+	{
+		static $aWeekDayToString = null;
+		if (is_null($aWeekDayToString))
+		{
+			// Init the correspondance table
+			$aWeekDayToString = array(
+				0 => Dict::S('DayOfWeek-Sunday'),
+				1 => Dict::S('DayOfWeek-Monday'),
+				2 => Dict::S('DayOfWeek-Tuesday'),
+				3 => Dict::S('DayOfWeek-Wednesday'),
+				4 => Dict::S('DayOfWeek-Thursday'),
+				5 => Dict::S('DayOfWeek-Friday'),
+				6 => Dict::S('DayOfWeek-Saturday')
+			);
+		}
+		static $aMonthToString = null;
+		if (is_null($aMonthToString))
+		{
+			// Init the correspondance table
+			$aMonthToString = array(
+				1 => Dict::S('Month-01'),
+				2 => Dict::S('Month-02'),
+				3 => Dict::S('Month-03'),
+				4 => Dict::S('Month-04'),
+				5 => Dict::S('Month-05'),
+				6 => Dict::S('Month-06'),
+				7 => Dict::S('Month-07'),
+				8 => Dict::S('Month-08'),
+				9 => Dict::S('Month-09'),
+				10 => Dict::S('Month-10'),
+				11 => Dict::S('Month-11'),
+				12 => Dict::S('Month-12'),
+			);
+		}
+
+		$sRes = $sDefault;
+		if (strtolower($this->m_sVerb) == 'date_format')
+		{
+			$oFormatExpr = $this->m_aArgs[1];
+			if ($oFormatExpr->Render() == "'%w'")
+			{
+				if (isset($aWeekDayToString[(int)$sValue]))
+				{
+					$sRes = $aWeekDayToString[(int)$sValue];
+				}
+			}
+			elseif ($oFormatExpr->Render() == "'%Y-%m'")
+			{
+				// yyyy-mm => "yyyy month"
+				$iMonth = (int) substr($sValue, -2); // the two last chars
+				$sRes = substr($sValue, 0, 4).' '.$aMonthToString[$iMonth];
+			}
+			elseif ($oFormatExpr->Render() == "'%Y-%m-%d'")
+			{
+				// yyyy-mm-dd => "month d"
+				$iMonth = (int) substr($sValue, 5, 2);
+				$sRes = $aMonthToString[$iMonth].' '.(int)substr($sValue, -2);
+			}
+		}
+		return $sRes;
+	}
 }
 
 class IntervalExpression extends Expression
@@ -648,6 +1011,18 @@ class IntervalExpression extends Expression
 		return 'INTERVAL '.$this->m_oValue->Render($aArgs, $bRetrofitParams).' '.$this->m_sUnit;
 	}
 
+	public function ApplyParameters($aArgs)
+	{
+		if ($this->m_oValue instanceof VariableExpression)
+		{
+			$this->m_oValue = $this->m_oValue->GetAsScalar($aArgs);
+		}
+		else
+		{
+			$this->m_oValue->ApplyParameters($aArgs);
+		}
+	}
+		
 	public function GetUnresolvedFields($sAlias, &$aUnresolved)
 	{
 		$this->m_oValue->GetUnresolvedFields($sAlias, $aUnresolved);
@@ -662,6 +1037,15 @@ class IntervalExpression extends Expression
 	{
 		return array();
 	}
+
+	public function CollectUsedParents(&$aTable)
+	{
+	}
+
+	public function ListConstantFields()
+	{
+		return array();
+	}
 	
 	public function RenameParam($sOldName, $sNewName)
 	{
@@ -702,6 +1086,22 @@ class CharConcatExpression extends Expression
 		return "CAST(CONCAT(".implode(', ', $aRes).") AS CHAR)";
 	}
 
+	public function ApplyParameters($aArgs)
+	{
+		$aRes = array();
+		foreach ($this->m_aExpressions as $idx => $oExpr)
+		{
+			if ($oExpr instanceof VariableExpression)
+			{
+				$this->m_aExpressions[$idx] = $oExpr->GetAsScalar();
+			}
+			else
+			{
+				$this->m_aExpressions->ApplyParameters($aArgs);
+			}
+		}
+	}
+
 	public function GetUnresolvedFields($sAlias, &$aUnresolved)
 	{
 		foreach ($this->m_aExpressions as $oExpr)
@@ -730,6 +1130,24 @@ class CharConcatExpression extends Expression
 		return $aRes;
 	}
 
+	public function CollectUsedParents(&$aTable)
+	{
+		foreach ($this->m_aExpressions as $oExpr)
+		{
+			$oExpr->CollectUsedParents($aTable);
+		}
+	}
+
+	public function ListConstantFields()
+	{
+		$aRes = array();
+		foreach ($this->m_aExpressions as $oExpr)
+		{
+			$aRes = array_merge($aRes, $oExpr->ListConstantFields());
+		}
+		return $aRes;
+	}
+
 	public function RenameParam($sOldName, $sNewName)
 	{
 		foreach ($this->m_aExpressions as $key => $oExpr)
@@ -763,6 +1181,16 @@ class CharConcatWSExpression extends CharConcatExpression
 		$sSep = CMDBSource::Quote($this->m_separator);
 		return "CAST(CONCAT_WS($sSep, ".implode(', ', $aRes).") AS CHAR)";
 	}
+
+	public function Translate($aTranslationData, $bMatchAll = true, $bMarkFieldsAsResolved = true)
+	{
+		$aRes = array();
+		foreach ($this->m_aExpressions as $oExpr)
+		{
+			$aRes[] = $oExpr->Translate($aTranslationData, $bMatchAll, $bMarkFieldsAsResolved);
+		}
+		return new CharConcatWSExpression($this->m_separator, $aRes);
+	}
 }
 
 
@@ -770,13 +1198,22 @@ class QueryBuilderExpressions
 {
 	protected $m_oConditionExpr;
 	protected $m_aSelectExpr;
+	protected $m_aGroupByExpr;
 	protected $m_aJoinFields;
+	protected $m_aClassIds;
 
-	public function __construct($aSelect, $oCondition)
+	public function __construct($oSearch, $aGroupByExpr = null)
 	{
-		$this->m_oConditionExpr = $oCondition;
-		$this->m_aSelectExpr = $aSelect;
+		$this->m_oConditionExpr = $oSearch->GetCriteria();
+		$this->m_aSelectExpr = array();
+		$this->m_aGroupByExpr = $aGroupByExpr;
 		$this->m_aJoinFields = array();
+
+		$this->m_aClassIds = array();
+		foreach($oSearch->GetJoinedClasses() as $sClassAlias => $sClass)
+		{
+			$this->m_aClassIds[$sClassAlias] = new FieldExpression('id', $sClassAlias);
+		}
 	}
 
 	public function GetSelect()
@@ -784,6 +1221,11 @@ class QueryBuilderExpressions
 		return $this->m_aSelectExpr;
 	}
 
+	public function GetGroupBy()
+	{
+		return $this->m_aGroupByExpr;
+	}
+
 	public function GetCondition()
 	{
 		return $this->m_oConditionExpr;
@@ -810,6 +1252,20 @@ class QueryBuilderExpressions
 		array_push($this->m_aJoinFields, $oExpression);
 	}
 
+	/**
+	 * Get tables representing the queried objects
+	 * Could be further optimized: when the first join is an outer join, then the rest can be omitted	 
+	 */	 	
+	public function GetMandatoryTables(&$aTables = null)
+	{
+		if (is_null($aTables)) $aTables = array();
+
+		foreach($this->m_aClassIds as $sClass => $oExpression)
+		{
+			$oExpression->CollectUsedParents($aTables);
+		}
+	}
+
 	public function GetUnresolvedFields($sAlias, &$aUnresolved)
 	{
 		$this->m_oConditionExpr->GetUnresolvedFields($sAlias, $aUnresolved);
@@ -817,6 +1273,13 @@ class QueryBuilderExpressions
 		{
 			$oExpr->GetUnresolvedFields($sAlias, $aUnresolved);
 		}
+		if ($this->m_aGroupByExpr)
+		{
+			foreach($this->m_aGroupByExpr as $sColAlias => $oExpr)
+			{
+				$oExpr->GetUnresolvedFields($sAlias, $aUnresolved);
+			}
+		}
 		foreach($this->m_aJoinFields as $oExpression)
 		{
 			$oExpression->GetUnresolvedFields($sAlias, $aUnresolved);
@@ -830,10 +1293,22 @@ class QueryBuilderExpressions
 		{
 			$this->m_aSelectExpr[$sColAlias] = $oExpr->Translate($aTranslationData, $bMatchAll, $bMarkFieldsAsResolved);
 		}
+		if ($this->m_aGroupByExpr)
+		{
+			foreach($this->m_aGroupByExpr as $sColAlias => $oExpr)
+			{
+				$this->m_aGroupByExpr[$sColAlias] = $oExpr->Translate($aTranslationData, $bMatchAll, $bMarkFieldsAsResolved);
+			}
+		}
 		foreach($this->m_aJoinFields as $index => $oExpression)
 		{
 			$this->m_aJoinFields[$index] = $oExpression->Translate($aTranslationData, $bMatchAll, $bMarkFieldsAsResolved);
 		}
+
+		foreach($this->m_aClassIds as $sClass => $oExpression)
+		{
+			$this->m_aClassIds[$sClass] = $oExpression->Translate($aTranslationData, $bMatchAll, $bMarkFieldsAsResolved);
+		}
 	}
 
 	public function RenameParam($sOldName, $sNewName)
@@ -843,6 +1318,13 @@ class QueryBuilderExpressions
 		{
 			$this->m_aSelectExpr[$sColAlias] = $oExpr->RenameParam($sOldName, $sNewName);
 		}
+		if ($this->m_aGroupByExpr)
+		{
+			foreach($this->m_aGroupByExpr as $sColAlias => $oExpr)
+			{
+				$this->m_aGroupByExpr[$sColAlias] = $oExpr->RenameParam($sOldName, $sNewName);
+			}
+		}
 		foreach($this->m_aJoinFields as $index => $oExpression)
 		{
 			$this->m_aJoinFields[$index] = $oExpression->RenameParam($sOldName, $sNewName);

core/filterdef.class.inc.php

@@ -1,27 +1,28 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Definition of a filter
  * Most of the time, a filter corresponds to an attribute, but we could imagine other search criteria
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -50,21 +51,6 @@ abstract class FilterDefinition
 		$this->ConsistencyCheck();
 	}
 
-	public function OverloadParams($aParams)
-	{
-		foreach ($aParams as $sParam => $value)
-		{
-			if (!array_key_exists($sParam, $this->m_aParams))
-			{
-				throw new CoreException("Unknown attribute definition parameter '$sParam', please select a value in {".implode(", ", $this->m_aParams)."}");
-			}
-			else
-			{
-				$this->m_aParams[$sParam] = $value;
-			}
-		}
-	}
-
 	// to be overloaded
 	static protected function ListExpectedParams()
 	{
@@ -170,12 +156,13 @@ class FilterFromAttribute extends FilterDefinition
 		return array_merge(parent::ListExpectedParams(), array("refattribute"));
 	}
 
-	public function __construct($oRefAttribute, $aParam = array())
+	public function __construct($oRefAttribute, $sSuffix = '')
 	{
 		// In this very specific case, the code is the one of the attribute
 		 // (this to get a very very simple syntax upon declaration)
+		$aParam = array();
 		$aParam["refattribute"] = $oRefAttribute;
-		parent::__construct($oRefAttribute->GetCode(), $aParam);
+		parent::__construct($oRefAttribute->GetCode().$sSuffix, $aParam);
 	}
 
 	public function GetType() {return "Basic";}

core/kpi.class.inc.php

@@ -1,96 +1,256 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Measures operations duration, memory usage, etc. (and some other KPIs)
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 class ExecutionKPI
 {
 	static protected $m_bEnabled_Duration = false;
 	static protected $m_bEnabled_Memory = false;
+	static protected $m_bBlameCaller = false;
+	static protected $m_sAllowedUser = '*';
 
-	static protected $m_aStats = array();
+	static protected $m_aStats = array(); // Recurrent operations
+	static protected $m_aExecData = array(); // One shot operations
 
 	protected $m_fStarted = null;
 	protected $m_iInitialMemory = null;
 
-	static public function EnableDuration()
+	static public function EnableDuration($iLevel)
 	{
-		self::$m_bEnabled_Duration = true;
+		if ($iLevel > 0)
+		{
+			self::$m_bEnabled_Duration = true;
+			if ($iLevel > 1)
+			{
+				self::$m_bBlameCaller = true;
+			}
+		}
 	}
 
-	static public function EnableMemory()
+	static public function EnableMemory($iLevel)
 	{
-		self::$m_bEnabled_Memory = true;
+		if ($iLevel > 0)
+		{
+			self::$m_bEnabled_Memory = true;
+		}
+	}
+
+	/**
+	 * @param string sUser A user login or * for all users	
+	 */	
+	static public function SetAllowedUser($sUser)
+	{
+		self::$m_sAllowedUser = $sUser;
+	}
+
+	static public function IsEnabled()
+	{
+		if (self::$m_bEnabled_Duration || self::$m_bEnabled_Memory)
+		{
+			if ((self::$m_sAllowedUser == '*') || (UserRights::GetUser() == trim(self::$m_sAllowedUser)))
+			{
+				return true;
+			}
+		}
+		return false;
+	}
+
+	static public function GetDescription()
+	{
+		$aFeatures = array();
+		if (self::$m_bEnabled_Duration) $aFeatures[] = 'Duration'; 
+		if (self::$m_bEnabled_Memory)   $aFeatures[] = 'Memory usage';
+		$sFeatures = implode(', ', $aFeatures);
+		$sFor = self::$m_sAllowedUser == '*' ? 'EVERYBODY' : "'".trim(self::$m_sAllowedUser)."'";
+		return "KPI logging is active for $sFor. Measures: $sFeatures";
 	}
 
 	static public function ReportStats()
 	{
+		if (!self::IsEnabled()) return;
+
+		global $fItopStarted;
+		$sExecId = microtime(); // id to differentiate the hrefs!
+
+		$aBeginTimes = array();
+		foreach (self::$m_aExecData as $aOpStats)
+		{
+			$aBeginTimes[] = $aOpStats['time_begin'];
+		}
+		array_multisort($aBeginTimes, self::$m_aExecData);
+
+		$sTableStyle = 'background-color: #ccc; margin: 10px;';
+
+		self::Report("<hr/>");
+		self::Report("<div style=\"background-color: grey; padding: 10px;\">");
+		self::Report("<h3><a name=\"".md5($sExecId)."\">KPIs</a> - ".$_SERVER['REQUEST_URI']." (".$_SERVER['REQUEST_METHOD'].")</h3>");
+		self::Report("<p>".date('Y-m-d H:i:s', $fItopStarted)."</p>");
+		self::Report("<p>log_kpi_user_id: ".MetaModel::GetConfig()->Get('log_kpi_user_id')."</p>");
+		self::Report("<div>");
+		self::Report("<table border=\"1\" style=\"$sTableStyle\">");
+		self::Report("<thead>");
+		self::Report("   <th>Operation</th><th>Begin</th><th>End</th><th>Duration</th><th>Memory start</th><th>Memory end</th><th>Memory peak</th>");
+		self::Report("</thead>");
+		foreach (self::$m_aExecData as $aOpStats)
+		{
+			$sOperation = $aOpStats['op'];
+			$sBegin = $sEnd = $sDuration = $sMemBegin = $sMemEnd = $sMemPeak = '?';
+		
+			$sBegin = round($aOpStats['time_begin'], 3);
+			$sEnd = round($aOpStats['time_end'], 3);
+			$fDuration = $aOpStats['time_end'] - $aOpStats['time_begin'];
+			$sDuration = round($fDuration, 3);
+
+			if (isset($aOpStats['mem_begin']))
+			{
+				$sMemBegin = self::MemStr($aOpStats['mem_begin']);
+				$sMemEnd = self::MemStr($aOpStats['mem_end']);
+				if (isset($aOpStats['mem_peak']))
+				{
+					$sMemPeak = self::MemStr($aOpStats['mem_peak']);
+				}
+			}
+
+			self::Report("<tr>");
+			self::Report("   <td>$sOperation</td><td>$sBegin</td><td>$sEnd</td><td>$sDuration</td><td>$sMemBegin</td><td>$sMemEnd</td><td>$sMemPeak</td>");
+			self::Report("</tr>");
+		}
+		self::Report("</table>");
+		self::Report("</div>");
+
+		$aConsolidatedStats = array();
 		foreach (self::$m_aStats as $sOperation => $aOpStats)
 		{
-			echo "<h2>KPIs for $sOperation</h2>\n";
 			$fTotalOp = 0;
 			$iTotalOp = 0;
 			$fMinOp = null;
 			$fMaxOp = 0;
-			echo "<ul>\n";
+			$sMaxOpArguments = null;
 			foreach ($aOpStats as $sArguments => $aEvents)
 			{
+				foreach ($aEvents as $aEventData)
+				{
+					$fDuration = $aEventData['time'];
+					$fTotalOp += $fDuration;
+					$iTotalOp++;
+
+					$fMinOp = is_null($fMinOp) ? $fDuration : min($fMinOp, $fDuration);
+					if ($fDuration > $fMaxOp)
+					{
+						$sMaxOpArguments = $sArguments;
+						$fMaxOp = $fDuration;
+					}
+				}
+			}
+			$aConsolidatedStats[$sOperation] = array(
+				'count' => $iTotalOp,
+				'duration' => $fTotalOp,
+				'min' => $fMinOp,
+				'max' => $fMaxOp,
+				'avg' => $fTotalOp / $iTotalOp,
+				'max_args' => $sMaxOpArguments
+			);
+		}
+
+		self::Report("<div>");
+		self::Report("<table border=\"1\" style=\"$sTableStyle\">");
+		self::Report("<thead>");
+		self::Report("   <th>Operation</th><th>Count</th><th>Duration</th><th>Min</th><th>Max</th><th>Avg</th>");
+		self::Report("</thead>");
+		foreach ($aConsolidatedStats as $sOperation => $aOpStats)
+		{
+			$sOperation = '<a href="#'.md5($sExecId.$sOperation).'">'.$sOperation.'</a>';
+			$sCount = $aOpStats['count'];
+			$sDuration = round($aOpStats['duration'], 3);
+			$sMin = round($aOpStats['min'], 3);
+			$sMax = '<a href="#'.md5($sExecId.$aOpStats['max_args']).'">'.round($aOpStats['max'], 3).'</a>';
+			$sAvg = round($aOpStats['avg'], 3);
+
+			self::Report("<tr>");
+			self::Report("   <td>$sOperation</td><td>$sCount</td><td>$sDuration</td><td>$sMin</td><td>$sMax</td><td>$sAvg</td>");
+			self::Report("</tr>");
+		}
+		self::Report("</table>");
+		self::Report("</div>");
+
+		self::Report("</div>");
+
+		// Report operation details
+		foreach (self::$m_aStats as $sOperation => $aOpStats)
+		{
+			$sOperationHtml = '<a name="'.md5($sExecId.$sOperation).'">'.$sOperation.'</a>';
+			self::Report("<h4>$sOperationHtml</h4>");
+			self::Report("<p><a href=\"#".md5($sExecId)."\">Back to page stats</a></p>");
+			self::Report("<table border=\"1\" style=\"$sTableStyle\">");
+			self::Report("<thead>");
+			self::Report("   <th>Operation details (+ blame caller if log_kpi_duration = 2)</th><th>Count</th><th>Duration</th><th>Min</th><th>Max</th>");
+			self::Report("</thead>");
+			foreach ($aOpStats as $sArguments => $aEvents)
+			{
+				$sHtmlArguments = '<a name="'.md5($sExecId.$sArguments).'"><div style="white-space: pre-wrap;">'.$sArguments.'</div></a>';
+				if ($aConsolidatedStats[$sOperation]['max_args'] == $sArguments)
+				{
+					$sHtmlArguments = '<span style="color: red;">'.$sHtmlArguments.'</span>';
+				}
+				if (isset($aEvents[0]['callers']))
+				{
+					$sHtmlArguments .= '<div style="padding: 10px;">';
+					$sHtmlArguments .= '<table border="1" bgcolor="#cfc">';
+					$sHtmlArguments .= '<tr><td colspan="2" bgcolor="#e9b96">Call stack for the <b>FIRST</b> caller</td></tr>';
+
+					foreach ($aEvents[0]['callers'] as $aCall)
+					{
+						$sHtmlArguments .= '<tr>';
+						$sHtmlArguments .= '<td>'.$aCall['Function'].'</td>';
+						$sHtmlArguments .= '<td>'.$aCall['File'].':'.$aCall['Line'].'</td>';
+						$sHtmlArguments .= '</tr>';
+					}
+					$sHtmlArguments .= '</table>';
+					$sHtmlArguments .= '</div>';
+				}
+
 				$fTotalInter = 0;
 				$fMinInter = null;
 				$fMaxInter = 0;
-				foreach ($aEvents as $fDuration)
+				foreach ($aEvents as $aEventData)
 				{
+					$fDuration = $aEventData['time'];
 					$fTotalInter += $fDuration;
 					$fMinInter = is_null($fMinInter) ? $fDuration : min($fMinInter, $fDuration);
 					$fMaxInter = max($fMaxInter, $fDuration);
-
-					$fMinOp = is_null($fMinOp) ? $fDuration : min($fMinOp, $fDuration);
-					$fMaxOp = max($fMaxOp, $fDuration);
 				}
-				$fTotalOp += $fTotalInter;
-				$iTotalOp++;
 
 				$iCountInter = count($aEvents);
-				$sTotalInter = round($fTotalInter, 3)."s";
-				if ($iCountInter > 1)
-				{
-					$sMinInter = round($fMinInter, 3)."s";
-					$sMaxInter = round($fMaxInter, 3)."s";
-					$sTimeDesc = "$sTotalInter (from $sMinInter to $sMaxInter) in $iCountInter times";
-				}
-				else
-				{
-					$sTimeDesc = "$sTotalInter";
-				}
-				echo "<li>Spent $sTimeDesc, on: <span style=\"font-size:60%\">$sArguments</span></li>\n";
+				$sTotalInter = round($fTotalInter, 3);
+				$sMinInter = round($fMinInter, 3);
+				$sMaxInter = round($fMaxInter, 3);
+				self::Report("<tr>");
+				self::Report("   <td>$sHtmlArguments</td><td>$iCountInter</td><td>$sTotalInter</td><td>$sMinInter</td><td>$sMaxInter</td>");
+				self::Report("</tr>");
 			}
-			echo "</ul>\n";
-			echo "<ul>Sumary for $sOperation\n";
-			echo "<li>Total: $iTotalOp (".round($fTotalOp, 3).")</li>\n";
-			echo "<li>Min: ".round($fMinOp, 3)."</li>\n";
-			echo "<li>Max: ".round($fMaxOp, 3)."</li>\n";
-			echo "<li>Avg: ".round($fTotalOp / $iTotalOp, 3)."</li>\n";
-			echo "</ul>\n";
+			self::Report("</table>");
 		}
 	}
 
@@ -104,25 +264,43 @@ class ExecutionKPI
 	//
 	public function ComputeAndReport($sOperationDesc)
 	{
+		global $fItopStarted;
+
+		$aNewEntry = null;
+
 		if (self::$m_bEnabled_Duration)
 		{
 			$fStopped = MyHelpers::getmicrotime();
-			$fDuration = $fStopped - $this->m_fStarted;
-			$this->Report($sOperationDesc.' / duration: '.round($fDuration, 3));
+			$aNewEntry = array(
+				'op' => $sOperationDesc,
+				'time_begin' => $this->m_fStarted - $fItopStarted,
+				'time_end' => $fStopped - $fItopStarted,
+			);
+			// Reset for the next operation (if the object is recycled)
+			$this->m_fStarted = $fStopped;
 		}
 
 		if (self::$m_bEnabled_Memory)
 		{
-			$iMemory = self::memory_get_usage();
-			$iMemoryUsed = $iMemory - $this->m_iInitialMemory;
-			$this->Report($sOperationDesc.' / memory: '.self::MemStr($iMemoryUsed).' (Total: '.self::MemStr($iMemory).')');
+			$iCurrentMemory = self::memory_get_usage();
+			if (is_null($aNewEntry))
+			{
+				$aNewEntry = array('op' => $sOperationDesc);
+			}
+			$aNewEntry['mem_begin'] = $this->m_iInitialMemory;
+			$aNewEntry['mem_end'] = $iCurrentMemory;
 			if (function_exists('memory_get_peak_usage'))
 			{
-				$iMemoryPeak = memory_get_peak_usage();
-				$this->Report($sOperationDesc.' / memory peak: '.self::MemStr($iMemoryPeak));
+				$aNewEntry['mem_peak'] = memory_get_peak_usage();
 			}
+			// Reset for the next operation (if the object is recycled)
+			$this->m_iInitialMemory = $iCurrentMemory;
 		}
 
+		if (!is_null($aNewEntry))
+		{
+			self::$m_aExecData[] = $aNewEntry;
+		}
 		$this->ResetCounters();
 	}
 
@@ -132,7 +310,19 @@ class ExecutionKPI
 		{
 			$fStopped = MyHelpers::getmicrotime();
 			$fDuration = $fStopped - $this->m_fStarted;
-			self::$m_aStats[$sOperation][$sArguments][] = $fDuration;
+			if (self::$m_bBlameCaller)
+			{
+				self::$m_aStats[$sOperation][$sArguments][] = array(
+					'time' => $fDuration,
+					'callers' => MyHelpers::get_callstack(1),
+				);
+			}
+			else
+			{
+				self::$m_aStats[$sOperation][$sArguments][] = array(
+					'time' => $fDuration
+				);
+			}
 		}
 	}
 
@@ -149,9 +339,11 @@ class ExecutionKPI
 		}
 	}
 
-	protected function Report($sText)
+	const HtmlReportFile = 'log/kpi.html';
+
+	static protected function Report($sText)
 	{
-		echo "$sText<br/>\n";
+		file_put_contents(APPROOT.self::HtmlReportFile, "$sText\n", FILE_APPEND | LOCK_EX);
 	}
 
 	static protected function MemStr($iMemory)
@@ -191,15 +383,15 @@ class ExecutionKPI
 			return $output[1] * 1024;
 		}
 	}
+
+	static public function memory_get_peak_usage($bRealUsage = false)
+	{
+		if (function_exists('memory_get_peak_usage'))
+		{
+			return memory_get_peak_usage($bRealUsage);
+		}
+		// PHP > 5.2.1 - this verb depends on a compilation option
+		return 0;
+	}
 }
 
-class ApplicationStartupKPI extends ExecutionKPI
-{
-	public function __construct()
-	{
-		global $fItopStarted;
-		$this->m_fStarted	= $fItopStarted;
-	}
-} 
-
-?>

core/log.class.inc.php

@@ -1,26 +1,26 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * File logging
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 class FileLog

core/metamodelmodifier.inc.php

@@ -0,0 +1,32 @@
+<?php
+// Copyright (C) 2010-2012 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+
+/**
+ * Any extension to hook the initialization of the metamodel 
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+interface iOnClassInitialization
+{
+	public function OnAfterClassInitialization($sClass);
+}
+
+?>

core/modelreflection.class.inc.php

@@ -0,0 +1,261 @@
+<?php
+// Copyright (C) 2013 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+
+/**
+ * Reflection API for the MetaModel (partial) 
+ *
+ * @copyright   Copyright (C) 2013 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+ 
+abstract class ModelReflection
+{
+	abstract public function GetClassIcon($sClass, $bImgTag = true); 
+	abstract public function IsValidAttCode($sClass, $sAttCode);
+	abstract public function GetName($sClass);
+	abstract public function GetLabel($sClass, $sAttCodeEx);
+	abstract public function GetValueLabel($sClass, $sAttCode, $sValue);
+	abstract public function ListAttributes($sClass, $sScope = null);
+	abstract public function GetAttributeProperty($sClass, $sAttCode, $sPropName, $default = null);
+	abstract public function GetAllowedValues_att($sClass, $sAttCode);
+	abstract public function HasChildrenClasses($sClass);
+	abstract public function GetClasses($sCategories = '', $bExcludeLinks = false);
+	abstract public function IsValidClass($sClass);
+	abstract public function IsSameFamilyBranch($sClassA, $sClassB);
+	abstract public function GetParentClass($sClass);
+	abstract public function GetFiltersList($sClass);
+	abstract public function IsValidFilterCode($sClass, $sFilterCode);
+
+	abstract public function GetQuery($sOQL);
+
+	abstract public function DictString($sStringCode, $sDefault = null, $bUserLanguageOnly = false);
+
+	public function DictFormat($sFormatCode /*, ... arguments ....*/)
+	{
+		$sLocalizedFormat = $this->DictString($sFormatCode);
+		$aArguments = func_get_args();
+		array_shift($aArguments);
+		
+		if ($sLocalizedFormat == $sFormatCode)
+		{
+			// Make sure the information will be displayed (ex: an error occuring before the dictionary gets loaded)
+			return $sFormatCode.' - '.implode(', ', $aArguments);
+		}
+
+		return vsprintf($sLocalizedFormat, $aArguments);
+	}
+
+	abstract public function GetIconSelectionField($sCode, $sLabel = '', $defaultValue = '');
+}
+
+abstract class QueryReflection
+{
+	/**
+	 * Throws an exception in case of an invalid syntax
+	 */
+	abstract public function __construct($sOQL);
+
+	abstract public function GetClass();
+	abstract public function GetClassAlias();
+}
+
+
+class ModelReflectionRuntime extends ModelReflection
+{
+	public function __construct()
+	{
+	}
+
+	public function GetClassIcon($sClass, $bImgTag = true)
+	{
+		return MetaModel::GetClassIcon($sClass, $bImgTag);
+	}
+ 
+	public function IsValidAttCode($sClass, $sAttCode)
+	{
+		return MetaModel::IsValidAttCode($sClass, $sAttCode);
+	}
+ 
+	public function GetName($sClass)
+	{
+		return MetaModel::GetName($sClass);
+	}
+ 
+	public function GetLabel($sClass, $sAttCodeEx)
+	{
+		return MetaModel::GetLabel($sClass, $sAttCodeEx);
+	}
+ 
+	public function GetValueLabel($sClass, $sAttCode, $sValue)
+	{
+		$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+		return $oAttDef->GetValueLabel($sValue);
+	}
+
+	public function ListAttributes($sClass, $sScope = null)
+	{
+		$aScope = null;
+		if ($sScope != null)
+		{
+			$aScope = array();
+			foreach (explode(',', $sScope) as $sScopeClass)
+			{
+				$aScope[] = trim($sScopeClass);
+			}
+		}
+		$aAttributes = array();
+		foreach (MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef)
+		{
+			$sAttributeClass = get_class($oAttDef);
+			if ($aScope != null)
+			{
+				foreach ($aScope as $sScopeClass)
+				{
+					if (($sAttributeClass == $sScopeClass) || is_subclass_of($sAttributeClass, $sScopeClass))
+					{
+						$aAttributes[$sAttCode] = $sAttributeClass;
+						break;
+					}
+				}
+			}
+			else
+			{
+				$aAttributes[$sAttCode] = $sAttributeClass;
+			}
+		}
+		return $aAttributes;
+	}
+ 
+	public function GetAttributeProperty($sClass, $sAttCode, $sPropName, $default = null)
+	{
+		$ret = $default;
+
+		$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+		$aParams = $oAttDef->GetParams();
+		if (array_key_exists($sPropName, $aParams))
+		{
+			$ret = $aParams[$sPropName];
+		}
+
+		if ($oAttDef instanceof AttributeHierarchicalKey)
+		{
+			if ($sPropName == 'targetclass')
+			{
+				$ret = $sClass;
+			}
+		}
+		return $ret;
+	}
+
+	public function GetAllowedValues_att($sClass, $sAttCode)
+	{
+		return MetaModel::GetAllowedValues_att($sClass, $sAttCode);
+	}
+ 
+	public function HasChildrenClasses($sClass)
+	{
+		return MetaModel::HasChildrenClasses($sClass);
+	}
+ 
+	public function GetClasses($sCategories = '', $bExcludeLinks = false)
+	{
+		$aClasses = MetaModel::GetClasses($sCategories);
+		if ($bExcludeLinks)
+		{
+			$aExcluded = MetaModel::GetLinkClasses();
+			$aRes = array();
+			foreach ($aClasses as $sClass)
+			{
+				if (!array_key_exists($sClass, $aExcluded))
+				{
+					$aRes[] = $sClass;
+				}
+			}
+		}
+		else
+		{
+			$aRes = $aClasses;
+		}
+		return $aRes;
+	}
+
+	public function IsValidClass($sClass)
+	{
+		return MetaModel::IsValidClass($sClass);
+	}
+
+	public function IsSameFamilyBranch($sClassA, $sClassB)
+	{
+		return MetaModel::IsSameFamilyBranch($sClassA, $sClassB);
+	}
+
+	public function GetParentClass($sClass)
+	{
+		return MetaModel::GetParentClass($sClass);
+	}
+
+	public function GetFiltersList($sClass)
+	{
+		return MetaModel::GetFiltersList($sClass);
+	}
+
+	public function IsValidFilterCode($sClass, $sFilterCode)
+	{
+		return MetaModel::IsValidFilterCode($sClass, $sFilterCode);
+	}
+
+	public function GetQuery($sOQL)
+	{
+		return new QueryReflectionRuntime($sOQL);
+	}
+
+	public function DictString($sStringCode, $sDefault = null, $bUserLanguageOnly = false)
+	{
+		return Dict::S($sStringCode, $sDefault, $bUserLanguageOnly);
+	}
+
+	public function GetIconSelectionField($sCode, $sLabel = '', $defaultValue = '')
+	{
+		return new RunTimeIconSelectionField($sCode, $sLabel, $defaultValue);
+	}
+}
+
+
+class QueryReflectionRuntime extends QueryReflection
+{
+	protected $oFilter;
+
+	/**
+	 *	throws an exception in case of a wrong syntax
+	 */
+	public function __construct($sOQL)
+	{
+		$this->oFilter = DBObjectSearch::FromOQL($sOQL);
+	}
+
+	public function GetClass()
+	{
+		return $this->oFilter->GetClass();
+	}
+
+	public function GetClassAlias()
+	{
+		return $this->oFilter->GetClassAlias();
+	}
+}

core/modulehandler.class.inc.php

@@ -1,27 +1,28 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Class ModuleHandler
  * Defines the API to implement module specific actions during page execution 
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 abstract class ModuleHandlerAPI

core/mutex.class.inc.php

@@ -0,0 +1,193 @@
+<?php
+// Copyright (C) 2013 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+
+/**
+ * Class iTopMutex
+ * A class to serialize the execution of some code sections
+ * Emulates the API of PECL Mutex class
+ * Relies on MySQL locks because the API sem_get is not always present in the
+ * installed PHP.    
+ *
+ * @copyright   Copyright (C) 2013 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+class iTopMutex
+{
+	protected $sName;
+	protected $hDBLink;
+	protected $bLocked; // Whether or not this instance of the Mutex is locked
+	static protected $aAcquiredLocks = array(); // Number of instances of the Mutex, having the lock, in this page
+
+	public function __construct($sName, $sDBHost = null, $sDBUser = null, $sDBPwd = null)
+	{
+		// Compute the name of a lock for mysql
+		// Note: the name is server-wide!!!
+		$this->sName = 'itop.'.$sName;
+		$this->bLocked = false; // Not yet locked
+
+		if (!array_key_exists($this->sName, self::$aAcquiredLocks))
+		{
+			self::$aAcquiredLocks[$this->sName] = 0;
+		}
+
+		// It is a MUST to create a dedicated session each time a lock is required, because
+		// using GET_LOCK anytime on the same session will RELEASE the current and unique session lock (known issue)
+		$oConfig = utils::GetConfig();
+		$sDBHost = is_null($sDBHost) ? $oConfig->GetDBHost() : $sDBHost;
+		$sDBUser = is_null($sDBUser) ? $oConfig->GetDBUser() : $sDBUser;
+		$sDBPwd = is_null($sDBPwd) ? $oConfig->GetDBPwd() : $sDBPwd;
+		$this->InitMySQLSession($sDBHost, $sDBUser, $sDBPwd);
+	}
+
+	public function __destruct()
+	{
+		if ($this->bLocked)
+		{
+			$this->Unlock();
+		}
+		mysqli_close($this->hDBLink);
+	}
+
+	/**
+	 *	Acquire the mutex
+	 */	
+	public function Lock()
+	{
+		if ($this->bLocked)
+		{
+			// Lock already acquired
+			return;
+		}
+		if (self::$aAcquiredLocks[$this->sName] == 0)
+		{
+			do
+			{
+				$res = $this->QueryToScalar("SELECT GET_LOCK('".$this->sName."', 3600)");
+				if (is_null($res))
+				{
+					throw new Exception("Failed to acquire the lock '".$this->sName."'");
+				}
+				// $res === '1' means I hold the lock
+				// $res === '0' means it timed out
+			}
+			while ($res !== '1');
+		}
+		$this->bLocked = true;
+		self::$aAcquiredLocks[$this->sName]++;
+	}
+
+	/**
+	 *	Attempt to acquire the mutex
+	 *	@returns bool True if the mutex is acquired, false if already locked elsewhere	 
+	 */	
+	public function TryLock()
+	{
+		if ($this->bLocked)
+		{
+			return true; // Already acquired
+		}
+		if (self::$aAcquiredLocks[$this->sName] > 0)
+		{
+			self::$aAcquiredLocks[$this->sName]++;
+			$this->bLocked = true;
+			return true;
+		}
+		
+		$res = $this->QueryToScalar("SELECT GET_LOCK('".$this->sName."', 0)");
+		if (is_null($res))
+		{
+			throw new Exception("Failed to acquire the lock '".$this->sName."'");
+		}
+		// $res === '1' means I hold the lock
+		// $res === '0' means it timed out
+		if ($res === '1')
+		{
+			$this->bLocked = true;
+			self::$aAcquiredLocks[$this->sName]++;
+		}
+		return ($res === '1');
+	}
+
+	/**
+	 *	Release the mutex
+	 */	
+	public function Unlock()
+	{
+		if (!$this->bLocked)
+		{
+			// ??? the lock is not acquired, exit
+	        return;	
+		}
+		if (self::$aAcquiredLocks[$this->sName] == 0)
+		{
+			return; // Safety net
+		}
+		
+		if (self::$aAcquiredLocks[$this->sName] == 1)
+		{
+			$res = $this->QueryToScalar("SELECT RELEASE_LOCK('".$this->sName."')");
+		}
+		$this->bLocked = false;
+		self::$aAcquiredLocks[$this->sName]--;
+	}
+
+
+
+	public function InitMySQLSession($sHost, $sUser, $sPwd)
+	{
+		$aConnectInfo = explode(':', $sHost);
+		if (count($aConnectInfo) > 1)
+		{
+			// Override the default port
+			$sServer = $aConnectInfo[0];
+			$iPort = $aConnectInfo[1];
+			$this->hDBLink = @mysqli_connect($sServer, $sUser, $sPwd, '', $iPort);
+		}
+		else
+		{
+			$this->hDBLink = @mysqli_connect($sHost, $sUser, $sPwd);
+		}
+
+		if (!$this->hDBLink)
+		{
+			throw new Exception("Could not connect to the DB server (host=$sHost, user=$sUser): ".mysqli_connect_error().' (mysql errno: '.mysqli_connect_errno().')');
+		}
+	}
+
+
+	protected function QueryToScalar($sSql)
+	{
+		$result = mysqli_query($this->hDBLink, $sSql);
+		if (!$result)
+		{
+			throw new Exception("Failed to issue MySQL query '".$sSql."': ".mysqli_error($this->hDBLink).' (mysql errno: '.mysqli_errno($this->hDBLink).')');
+		}
+		if ($aRow = mysqli_fetch_array($result, MYSQLI_BOTH))
+		{
+			$res = $aRow[0];
+		}
+		else
+		{
+			mysqli_free_result($result);
+			throw new Exception("No result for query '".$sSql."'");
+		}
+		mysqli_free_result($result);
+		return $res;
+	}
+}

core/oql/oql-lexer.php

@@ -1,27 +1,28 @@
 <?php
 
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * OQL syntax analyzer, to be used prior to run the lexical analyzer
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 // Notes (from the source file: oql-lexer.plex) - Romain
@@ -119,6 +120,11 @@ class OQLLexerRaw
                 '/\G-/ ',
                 '/\GAND/ ',
                 '/\GOR/ ',
+                '/\G\\|/ ',
+                '/\G&/ ',
+                '/\G\\^/ ',
+                '/\G<</ ',
+                '/\G>>/ ',
                 '/\G,/ ',
                 '/\G\\(/ ',
                 '/\G\\)/ ',
@@ -168,7 +174,8 @@ class OQLLexerRaw
                 '/\GABOVE STRICT/ ',
                 '/\GNOT ABOVE/ ',
                 '/\GNOT ABOVE STRICT/ ',
-                '/\G[0-9]+|0x[0-9a-fA-F]+/ ',
+                '/\G(0x[0-9a-fA-F]+)/ ',
+                '/\G([0-9]+)/ ',
                 '/\G\"([^\\\\\"]|\\\\\"|\\\\\\\\)*\"|'.chr(94).chr(39).'([^\\\\'.chr(39).']|\\\\'.chr(39).'|\\\\\\\\)*'.chr(39).'/ ',
                 '/\G([_a-zA-Z][_a-zA-Z0-9]*|`[^`]+`)/ ',
                 '/\G:([_a-zA-Z][_a-zA-Z0-9]*->[_a-zA-Z][_a-zA-Z0-9]*|[_a-zA-Z][_a-zA-Z0-9]*)/ ',
@@ -333,269 +340,299 @@ class OQLLexerRaw
     function yy_r1_13($yy_subpatterns)
     {
 
-	$this->token = OQLParser::COMA;
+	$this->token = OQLParser::BITWISE_OR;
     }
     function yy_r1_14($yy_subpatterns)
     {
 
-	$this->token = OQLParser::PAR_OPEN;
+	$this->token = OQLParser::BITWISE_AND;
     }
     function yy_r1_15($yy_subpatterns)
     {
 
-	$this->token = OQLParser::PAR_CLOSE;
+	$this->token = OQLParser::BITWISE_XOR;
     }
     function yy_r1_16($yy_subpatterns)
     {
 
-	$this->token = OQLParser::REGEXP;
+	$this->token = OQLParser::BITWISE_LEFT_SHIFT;
     }
     function yy_r1_17($yy_subpatterns)
     {
 
-	$this->token = OQLParser::EQ;
+	$this->token = OQLParser::BITWISE_RIGHT_SHIFT;
     }
     function yy_r1_18($yy_subpatterns)
     {
 
-	$this->token = OQLParser::NOT_EQ;
+	$this->token = OQLParser::COMA;
     }
     function yy_r1_19($yy_subpatterns)
     {
 
-	$this->token = OQLParser::GT;
+	$this->token = OQLParser::PAR_OPEN;
     }
     function yy_r1_20($yy_subpatterns)
     {
 
-	$this->token = OQLParser::LT;
+	$this->token = OQLParser::PAR_CLOSE;
     }
     function yy_r1_21($yy_subpatterns)
     {
 
-	$this->token = OQLParser::GE;
+	$this->token = OQLParser::REGEXP;
     }
     function yy_r1_22($yy_subpatterns)
     {
 
-	$this->token = OQLParser::LE;
+	$this->token = OQLParser::EQ;
     }
     function yy_r1_23($yy_subpatterns)
     {
 
-	$this->token = OQLParser::LIKE;
+	$this->token = OQLParser::NOT_EQ;
     }
     function yy_r1_24($yy_subpatterns)
     {
 
-	$this->token = OQLParser::NOT_LIKE;
+	$this->token = OQLParser::GT;
     }
     function yy_r1_25($yy_subpatterns)
     {
 
-	$this->token = OQLParser::IN;
+	$this->token = OQLParser::LT;
     }
     function yy_r1_26($yy_subpatterns)
     {
 
-	$this->token = OQLParser::NOT_IN;
+	$this->token = OQLParser::GE;
     }
     function yy_r1_27($yy_subpatterns)
     {
 
-	$this->token = OQLParser::INTERVAL;
+	$this->token = OQLParser::LE;
     }
     function yy_r1_28($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_IF;
+	$this->token = OQLParser::LIKE;
     }
     function yy_r1_29($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_ELT;
+	$this->token = OQLParser::NOT_LIKE;
     }
     function yy_r1_30($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_COALESCE;
+	$this->token = OQLParser::IN;
     }
     function yy_r1_31($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_ISNULL;
+	$this->token = OQLParser::NOT_IN;
     }
     function yy_r1_32($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_CONCAT;
+	$this->token = OQLParser::INTERVAL;
     }
     function yy_r1_33($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_SUBSTR;
+	$this->token = OQLParser::F_IF;
     }
     function yy_r1_34($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_TRIM;
+	$this->token = OQLParser::F_ELT;
     }
     function yy_r1_35($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_DATE;
+	$this->token = OQLParser::F_COALESCE;
     }
     function yy_r1_36($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_DATE_FORMAT;
+	$this->token = OQLParser::F_ISNULL;
     }
     function yy_r1_37($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_CURRENT_DATE;
+	$this->token = OQLParser::F_CONCAT;
     }
     function yy_r1_38($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_NOW;
+	$this->token = OQLParser::F_SUBSTR;
     }
     function yy_r1_39($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_TIME;
+	$this->token = OQLParser::F_TRIM;
     }
     function yy_r1_40($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_TO_DAYS;
+	$this->token = OQLParser::F_DATE;
     }
     function yy_r1_41($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_FROM_DAYS;
+	$this->token = OQLParser::F_DATE_FORMAT;
     }
     function yy_r1_42($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_YEAR;
+	$this->token = OQLParser::F_CURRENT_DATE;
     }
     function yy_r1_43($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_MONTH;
+	$this->token = OQLParser::F_NOW;
     }
     function yy_r1_44($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_DAY;
+	$this->token = OQLParser::F_TIME;
     }
     function yy_r1_45($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_HOUR;
+	$this->token = OQLParser::F_TO_DAYS;
     }
     function yy_r1_46($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_MINUTE;
+	$this->token = OQLParser::F_FROM_DAYS;
     }
     function yy_r1_47($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_SECOND;
+	$this->token = OQLParser::F_YEAR;
     }
     function yy_r1_48($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_DATE_ADD;
+	$this->token = OQLParser::F_MONTH;
     }
     function yy_r1_49($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_DATE_SUB;
+	$this->token = OQLParser::F_DAY;
     }
     function yy_r1_50($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_ROUND;
+	$this->token = OQLParser::F_HOUR;
     }
     function yy_r1_51($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_FLOOR;
+	$this->token = OQLParser::F_MINUTE;
     }
     function yy_r1_52($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_INET_ATON;
+	$this->token = OQLParser::F_SECOND;
     }
     function yy_r1_53($yy_subpatterns)
     {
 
-	$this->token = OQLParser::F_INET_NTOA;
+	$this->token = OQLParser::F_DATE_ADD;
     }
     function yy_r1_54($yy_subpatterns)
     {
 
-	$this->token = OQLParser::BELOW;
+	$this->token = OQLParser::F_DATE_SUB;
     }
     function yy_r1_55($yy_subpatterns)
     {
 
-	$this->token = OQLParser::BELOW_STRICT;
+	$this->token = OQLParser::F_ROUND;
     }
     function yy_r1_56($yy_subpatterns)
     {
 
-	$this->token = OQLParser::NOT_BELOW;
+	$this->token = OQLParser::F_FLOOR;
     }
     function yy_r1_57($yy_subpatterns)
     {
 
-	$this->token = OQLParser::NOT_BELOW_STRICT;
+	$this->token = OQLParser::F_INET_ATON;
     }
     function yy_r1_58($yy_subpatterns)
     {
 
-	$this->token = OQLParser::ABOVE;
+	$this->token = OQLParser::F_INET_NTOA;
     }
     function yy_r1_59($yy_subpatterns)
     {
 
-	$this->token = OQLParser::ABOVE_STRICT;
+	$this->token = OQLParser::BELOW;
     }
     function yy_r1_60($yy_subpatterns)
     {
 
-	$this->token = OQLParser::NOT_ABOVE;
+	$this->token = OQLParser::BELOW_STRICT;
     }
     function yy_r1_61($yy_subpatterns)
     {
 
-	$this->token = OQLParser::NOT_ABOVE_STRICT;
+	$this->token = OQLParser::NOT_BELOW;
     }
     function yy_r1_62($yy_subpatterns)
     {
 
-	$this->token = OQLParser::NUMVAL;
+	$this->token = OQLParser::NOT_BELOW_STRICT;
     }
     function yy_r1_63($yy_subpatterns)
     {
 
-	$this->token = OQLParser::STRVAL;
+	$this->token = OQLParser::ABOVE;
     }
     function yy_r1_64($yy_subpatterns)
     {
 
-	$this->token = OQLParser::NAME;
+	$this->token = OQLParser::ABOVE_STRICT;
     }
     function yy_r1_65($yy_subpatterns)
     {
 
-	$this->token = OQLParser::VARNAME;
+	$this->token = OQLParser::NOT_ABOVE;
     }
     function yy_r1_66($yy_subpatterns)
+    {
+
+	$this->token = OQLParser::NOT_ABOVE_STRICT;
+    }
+    function yy_r1_67($yy_subpatterns)
+    {
+
+	$this->token = OQLParser::HEXVAL;
+    }
+    function yy_r1_68($yy_subpatterns)
+    {
+
+	$this->token = OQLParser::NUMVAL;
+    }
+    function yy_r1_69($yy_subpatterns)
+    {
+
+	$this->token = OQLParser::STRVAL;
+    }
+    function yy_r1_70($yy_subpatterns)
+    {
+
+	$this->token = OQLParser::NAME;
+    }
+    function yy_r1_71($yy_subpatterns)
+    {
+
+	$this->token = OQLParser::VARNAME;
+    }
+    function yy_r1_72($yy_subpatterns)
     {
 
 	$this->token = OQLParser::DOT;

core/oql/oql-lexer.plex

@@ -1,27 +1,28 @@
 <?php
 
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * OQL syntax analyzer, to be used prior to run the lexical analyzer
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 // Notes (from the source file: oql-lexer.plex) - Romain
@@ -94,6 +95,11 @@ math_plus  = "+"
 math_minus = "-"
 log_and    = "AND"
 log_or     = "OR"
+bitwise_and    = "&"
+bitwise_or     = "|"
+bitwise_xor     = "^"
+bitwise_leftshift     = "<<"
+bitwise_rightshift     = ">>"
 regexp     = "REGEXP"
 eq         = "="
 not_eq     = "!="
@@ -140,7 +146,26 @@ above            = "ABOVE"
 above_strict     = "ABOVE STRICT"
 not_above        = "NOT ABOVE"
 not_above_strict = "NOT ABOVE STRICT"
-numval     = /[0-9]+|0x[0-9a-fA-F]+/
+//
+// WARNING: there seems to be a bug in the Lexer about matching the longest pattern
+//          when there are alternates in the regexp.
+//
+// For instance:
+// numval     = /[0-9]+|0x[0-9a-fA-F]+/
+// Does not work: SELECT Toto WHERE name = 'Text0xCTest' => Fails because 0xC is recongnized as a numval (inside the string) instead of a strval !!
+//
+// Inserting a ^ after the alternate (see comment at the top of this file) does not work either
+// numval     = /[0-9]+|'.chr(94).'0x[0-9a-fA-F]+/
+// SELECT Toto WHERE name = 'Text0xCTest' => works but
+// SELECT Toto WHERE id = 0xC => does not work, 'xC' is found as a name (apparently 0 is recognized as a numval and the remaining is a name !)
+//
+// numval     = /([0-9]+|0x[0-9a-fA-F]+)/
+// Does not work either, the hexadecimal numbers are not matched properly
+// Anyhow let's distinguish the hexadecimal values from decimal integers, hex numbers will be stored as strings
+// and passed as-is to MySQL which enables us to pass 64-bit values without messing with them in PHP
+//
+hexval     = /(0x[0-9a-fA-F]+)/
+numval     = /([0-9]+)/
 strval     = /"([^\\"]|\\"|\\\\)*"|'.chr(94).chr(39).'([^\\'.chr(39).']|\\'.chr(39).'|\\\\)*'.chr(39).'/
 name       = /([_a-zA-Z][_a-zA-Z0-9]*|`[^`]+`)/
 varname    = /:([_a-zA-Z][_a-zA-Z0-9]*->[_a-zA-Z][_a-zA-Z0-9]*|[_a-zA-Z][_a-zA-Z0-9]*)/
@@ -187,6 +212,21 @@ log_and {
 log_or {
 	$this->token = OQLParser::LOG_OR;
 }
+bitwise_or {
+	$this->token = OQLParser::BITWISE_OR;
+}
+bitwise_and {
+	$this->token = OQLParser::BITWISE_AND;
+}
+bitwise_xor {
+	$this->token = OQLParser::BITWISE_XOR;
+}
+bitwise_leftshift {
+	$this->token = OQLParser::BITWISE_LEFT_SHIFT;
+}
+bitwise_rightshift {
+	$this->token = OQLParser::BITWISE_RIGHT_SHIFT;
+}
 coma {
 	$this->token = OQLParser::COMA;
 }
@@ -334,6 +374,9 @@ not_above {
 not_above_strict {
 	$this->token = OQLParser::NOT_ABOVE_STRICT;
 }
+hexval {
+	$this->token = OQLParser::HEXVAL;
+}
 numval {
 	$this->token = OQLParser::NUMVAL;
 }

core/oql/oql-parser.y

@@ -164,19 +164,23 @@ name(A) ::= NAME(X). {
 	}
 	A = new OqlName($name, $this->m_iColPrev);
 }
-
-num_value(A) ::= NUMVAL(X). {A=X;}
+num_value(A) ::= NUMVAL(X). {A=(int)X;}
+num_value(A) ::= MATH_MINUS NUMVAL(X). {A=(int)-X;}
+num_value(A) ::= HEXVAL(X). {A=new OqlHexValue(X);}
 str_value(A) ::= STRVAL(X). {A=stripslashes(substr(X, 1, strlen(X) - 2));}
 
 
 operator1(A) ::= num_operator1(X). {A=X;}
+operator1(A) ::= bitwise_operator1(X). {A=X;}
 operator2(A) ::= num_operator2(X). {A=X;}
 operator2(A) ::= str_operator(X). {A=X;}
 operator2(A) ::= REGEXP(X). {A=X;}
 operator2(A) ::= EQ(X). {A=X;}
 operator2(A) ::= NOT_EQ(X). {A=X;}
 operator3(A) ::= LOG_AND(X). {A=X;}
+operator3(A) ::= bitwise_operator3(X). {A=X;}
 operator4(A) ::= LOG_OR(X). {A=X;}
+operator4(A) ::= bitwise_operator4(X). {A=X;}
 
 num_operator1(A) ::= MATH_DIV(X). {A=X;}
 num_operator1(A) ::= MATH_MULT(X). {A=X;}
@@ -190,6 +194,12 @@ num_operator2(A) ::= LE(X). {A=X;}
 str_operator(A) ::= LIKE(X). {A=X;}
 str_operator(A) ::= NOT_LIKE(X). {A=X;}
 
+bitwise_operator1(A) ::= BITWISE_LEFT_SHIFT(X). {A=X;}
+bitwise_operator1(A) ::= BITWISE_RIGHT_SHIFT(X). {A=X;}
+bitwise_operator3(A) ::= BITWISE_AND(X). {A=X;}
+bitwise_operator4(A) ::= BITWISE_OR(X). {A=X;}
+bitwise_operator4(A) ::= BITWISE_XOR(X). {A=X;}
+
 list_operator(A) ::= IN(X). {A=X;}
 list_operator(A) ::= NOT_IN(X). {A=X;}
 

core/oql/oqlexception.class.inc.php

@@ -1,26 +1,26 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * Special handling for OQL syntax errors
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -50,7 +50,13 @@ class OQLException extends CoreException
 		parent::__construct($sMessage, 0);
 	}
 
-	public function getHtmlDesc($sHighlightHtmlBegin = '<b>', $sHighlightHtmlEnd = '</b>')
+	public function GetUserFriendlyDescription()
+	{
+		// Todo - translate all errors!
+		return $this->getMessage();
+	}
+
+	public function getHtmlDesc($sHighlightHtmlBegin = '<span style="font-weight: bolder">', $sHighlightHtmlEnd = '</span>')
 	{
 		$sRet = htmlentities($this->m_MyIssue.", found '".$this->m_sUnexpected."' in: ", ENT_QUOTES, 'UTF-8');
 		$sRet .= htmlentities(substr($this->m_sInput, 0, $this->m_iCol), ENT_QUOTES, 'UTF-8');
@@ -59,8 +65,11 @@ class OQLException extends CoreException
 
 		if (!is_null($this->m_aExpecting) && (count($this->m_aExpecting) > 0))
 		{
-			$sExpectations = '{'.implode(', ', $this->m_aExpecting).'}';
-			$sRet .= ", expecting ".htmlentities($sExpectations, ENT_QUOTES, 'UTF-8'); 
+			if (count($this->m_aExpecting) < 30)
+			{
+				$sExpectations = '{'.implode(', ', $this->m_aExpecting).'}';
+				$sRet .= ", expecting ".htmlentities($sExpectations, ENT_QUOTES, 'UTF-8');
+			} 
 			$sSuggest = self::FindClosestString($this->m_sUnexpected, $this->m_aExpecting);
 			if (strlen($sSuggest) > 0)
 			{
@@ -71,7 +80,27 @@ class OQLException extends CoreException
 		return $sRet;
 	}
 
-	static protected function FindClosestString($sInput, $aDictionary)
+	public function GetIssue()
+	{
+		return $this->m_MyIssue;
+	}
+
+	public function GetSuggestions()
+	{
+		return $this->m_aExpecting;
+	}
+
+	public function GetWrongWord()
+	{
+		return $this->m_sUnexpected;
+	}
+
+	public function GetColumn()
+	{
+		return $this->m_iCol;
+	}
+
+	static public function FindClosestString($sInput, $aDictionary)
 	{
 		// no shortest distance found, yet
 		$fShortest = -1;
@@ -88,7 +117,7 @@ class OQLException extends CoreException
 				return $sSuggestion;
 			}
 			
-			if ($fShortest < 0 || ($fDist < 4 && $fDist <= $fShortest))
+			if (($fDist <= 3) && ($fShortest < 0 || $fDist <= $fShortest))
 			{
 				// set the closest match, and shortest distance
 				$sRet = $sSuggestion;

core/oql/oqlinterpreter.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Wrapper to execute the parser, lexical analyzer and normalization of an OQL query
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -31,6 +32,28 @@ class OqlNormalizeException extends OQLException
 		parent::__construct($sIssue, $sInput, 0, $oName->GetPos(), $oName->GetValue(), $aExpecting);
 	}
 }
+class UnknownClassOqlException extends OqlNormalizeException
+{
+	public function __construct($sInput, OqlName $oName, $aExpecting = null)
+	{
+		parent::__construct('Unknown class', $sInput, $oName, $aExpecting);
+	}
+
+	public function GetUserFriendlyDescription()
+	{
+		$sWrongClass = $this->GetWrongWord();
+		$sSuggest = self::FindClosestString($sWrongClass, $this->GetSuggestions());
+
+		if ($sSuggest != '')
+		{
+			return Dict::Format('UI:OQL:UnknownClassAndFix', $sWrongClass, $sSuggest);
+		}
+		else
+		{
+			return Dict::Format('UI:OQL:UnknownClassNoFix', $sWrongClass);
+		}
+	}
+}
 
 class OqlInterpreterException extends OQLException
 {

core/oql/oqlquery.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2013 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Classes defined for lexical analyze (see oql-parser.y)
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 // Position a string within an OQL query
@@ -53,6 +54,27 @@ class OqlName
 	} 
 }
 
+/**
+ * 
+ * Store hexadecimal values as strings so that we can support 64-bit values
+ *
+ */
+class OqlHexValue
+{
+	protected $m_sValue;
+
+	public function __construct($sValue)
+	{
+		$this->m_sValue = $sValue;
+	}
+	
+	public function __toString()
+	{
+		return $this->m_sValue;
+	}
+	
+}
+
 class OqlJoinSpec
 {
 	protected $m_oClass;
@@ -105,15 +127,38 @@ class OqlJoinSpec
 	}
 }
 
-class BinaryOqlExpression extends BinaryExpression
+interface CheckableExpression
 {
+	/**
+	 * Check the validity of the expression with regard to the data model
+	 * and the query in which it is used
+	 *
+	 * @param ModelReflection $oModelReflection MetaModel to consider
+	 * @param array $aAliases Aliases to class names (for the current query)
+	 * @param string $sSourceQuery For the reporting
+	 * @throws OqlNormalizeException
+	 */	 	
+	public function Check(ModelReflection $oModelReflection, $aAliases, $sSourceQuery);
 }
 
-class ScalarOqlExpression extends ScalarExpression
+class BinaryOqlExpression extends BinaryExpression implements CheckableExpression
 {
+	public function Check(ModelReflection $oModelReflection, $aAliases, $sSourceQuery)
+	{
+		$this->m_oLeftExpr->Check($oModelReflection, $aAliases, $sSourceQuery);
+		$this->m_oRightExpr->Check($oModelReflection, $aAliases, $sSourceQuery);
+	}
 }
 
-class FieldOqlExpression extends FieldExpression
+class ScalarOqlExpression extends ScalarExpression implements CheckableExpression
+{
+	public function Check(ModelReflection $oModelReflection, $aAliases, $sSourceQuery)
+	{
+		// a scalar is always fine
+	}
+}
+
+class FieldOqlExpression extends FieldExpression implements CheckableExpression
 {
 	protected $m_oParent;
 	protected $m_oName;
@@ -139,22 +184,84 @@ class FieldOqlExpression extends FieldExpression
 	{
 		return $this->m_oName;
 	}
+
+	public function Check(ModelReflection $oModelReflection, $aAliases, $sSourceQuery)
+	{
+		$sClassAlias = $this->GetParent();
+		$sFltCode = $this->GetName();
+		if (empty($sClassAlias))
+		{
+			// Try to find an alias
+			// Build an array of field => array of aliases
+			$aFieldClasses = array();
+			foreach($aAliases as $sAlias => $sReal)
+			{
+				foreach($oModelReflection->GetFiltersList($sReal) as $sAnFltCode)
+				{
+					$aFieldClasses[$sAnFltCode][] = $sAlias;
+				}
+			}
+			if (!array_key_exists($sFltCode, $aFieldClasses))
+			{
+				throw new OqlNormalizeException('Unknown filter code', $sSourceQuery, $this->GetNameDetails(), array_keys($aFieldClasses));
+			}
+			if (count($aFieldClasses[$sFltCode]) > 1)
+			{
+				throw new OqlNormalizeException('Ambiguous filter code', $sSourceQuery, $this->GetNameDetails());
+			}
+			$sClassAlias = $aFieldClasses[$sFltCode][0];
+		}
+		else
+		{
+			if (!array_key_exists($sClassAlias, $aAliases))
+			{
+				throw new OqlNormalizeException('Unknown class [alias]', $sSourceQuery, $this->GetParentDetails(), array_keys($aAliases));
+			}
+			$sClass = $aAliases[$sClassAlias];
+			if (!$oModelReflection->IsValidFilterCode($sClass, $sFltCode))
+			{
+				throw new OqlNormalizeException('Unknown filter code', $sSourceQuery, $this->GetNameDetails(), $oModelReflection->GetFiltersList($sClass));
+			}
+		}
+	}
 }
 
-class VariableOqlExpression extends VariableExpression
+class VariableOqlExpression extends VariableExpression implements CheckableExpression
 {
+	public function Check(ModelReflection $oModelReflection, $aAliases, $sSourceQuery)
+	{
+		// a scalar is always fine
+	}
 }
 
-class ListOqlExpression extends ListExpression
+class ListOqlExpression extends ListExpression implements CheckableExpression
 {
+	public function Check(ModelReflection $oModelReflection, $aAliases, $sSourceQuery)
+	{
+		foreach ($this->GetItems() as $oItemExpression)
+		{
+			$oItemExpression->Check($oModelReflection, $aAliases, $sSourceQuery);
+		}
+	}
 }
 
-class FunctionOqlExpression extends FunctionExpression
+class FunctionOqlExpression extends FunctionExpression implements CheckableExpression
 {
+	public function Check(ModelReflection $oModelReflection, $aAliases, $sSourceQuery)
+	{
+		foreach ($this->GetArgs() as $oArgExpression)
+		{
+			$oArgExpression->Check($oModelReflection, $aAliases, $sSourceQuery);
+		}
+	}
 }
 
-class IntervalOqlExpression extends IntervalExpression
+class IntervalOqlExpression extends IntervalExpression implements CheckableExpression
 {
+	public function Check(ModelReflection $oModelReflection, $aAliases, $sSourceQuery)
+	{
+		// an interval is always fine (made of a scalar and unit)
+	}
 }
 
 abstract class OqlQuery
@@ -213,6 +320,155 @@ class OqlObjectQuery extends OqlQuery
 	{
 		return $this->m_oClassAlias;
 	}
+
+	/**
+	 * Recursively check the validity of the expression with regard to the data model
+	 * and the query in which it is used
+	 * 	 	 
+	 * @param ModelReflection $oModelReflection MetaModel to consider	 	
+	 * @throws OqlNormalizeException
+	 */	 	
+	public function Check(ModelReflection $oModelReflection, $sSourceQuery)
+	{
+		$sClass = $this->GetClass();
+		$sClassAlias = $this->GetClassAlias();
+
+		if (!$oModelReflection->IsValidClass($sClass))
+		{
+			throw new UnknownClassOqlException($sSourceQuery, $this->GetClassDetails(), $oModelReflection->GetClasses());
+		}
+
+		$aAliases = array($sClassAlias => $sClass);
+
+		$aJoinSpecs = $this->GetJoins();
+		if (is_array($aJoinSpecs))
+		{
+			foreach ($aJoinSpecs as $oJoinSpec)
+			{
+				$sJoinClass = $oJoinSpec->GetClass();
+				$sJoinClassAlias = $oJoinSpec->GetClassAlias();
+				if (!$oModelReflection->IsValidClass($sJoinClass))
+				{
+					throw new UnknownClassOqlException($sSourceQuery, $oJoinSpec->GetClassDetails(), $oModelReflection->GetClasses());
+				}
+				if (array_key_exists($sJoinClassAlias, $aAliases))
+				{
+					if ($sJoinClassAlias != $sJoinClass)
+					{
+						throw new OqlNormalizeException('Duplicate class alias', $sSourceQuery, $oJoinSpec->GetClassAliasDetails());
+					}
+					else
+					{
+						throw new OqlNormalizeException('Duplicate class name', $sSourceQuery, $oJoinSpec->GetClassDetails());
+					}
+				} 
+
+				// Assumption: ext key on the left only !!!
+				// normalization should take care of this
+				$oLeftField = $oJoinSpec->GetLeftField();
+				$sFromClass = $oLeftField->GetParent();
+				$sExtKeyAttCode = $oLeftField->GetName();
+
+				$oRightField = $oJoinSpec->GetRightField();
+				$sToClass = $oRightField->GetParent();
+				$sPKeyDescriptor = $oRightField->GetName();
+				if ($sPKeyDescriptor != 'id')
+				{
+					throw new OqlNormalizeException('Wrong format for Join clause (right hand), expecting an id', $sSourceQuery, $oRightField->GetNameDetails(), array('id'));
+				}
+
+				$aAliases[$sJoinClassAlias] = $sJoinClass;
+
+				if (!array_key_exists($sFromClass, $aAliases))
+				{
+					throw new OqlNormalizeException('Unknown class in join condition (left expression)', $sSourceQuery, $oLeftField->GetParentDetails(), array_keys($aAliases));
+				}
+				if (!array_key_exists($sToClass, $aAliases))
+				{
+					throw new OqlNormalizeException('Unknown class in join condition (right expression)', $sSourceQuery, $oRightField->GetParentDetails(), array_keys($aAliases));
+				}
+				$aExtKeys = $oModelReflection->ListAttributes($aAliases[$sFromClass], 'AttributeExternalKey');
+				if (!array_key_exists($sExtKeyAttCode, $aExtKeys))
+				{
+					throw new OqlNormalizeException('Unknown external key in join condition (left expression)', $sSourceQuery, $oLeftField->GetNameDetails(), array_keys($aExtKeys));
+				}
+
+				if ($sFromClass == $sJoinClassAlias)
+				{
+					$sTargetClass = $oModelReflection->GetAttributeProperty($aAliases[$sFromClass], $sExtKeyAttCode, 'targetclass');
+					if(!$oModelReflection->IsSameFamilyBranch($aAliases[$sToClass], $sTargetClass))
+					{
+						throw new OqlNormalizeException("The joined class ($aAliases[$sFromClass]) is not compatible with the external key, which is pointing to $sTargetClass", $sSourceQuery, $oLeftField->GetNameDetails());
+					}
+				}
+				else
+				{
+					$sOperator = $oJoinSpec->GetOperator();
+					switch($sOperator)
+					{
+						case '=':
+						$iOperatorCode = TREE_OPERATOR_EQUALS;
+						break;
+						case 'BELOW':
+						$iOperatorCode = TREE_OPERATOR_BELOW;
+						break;
+						case 'BELOW_STRICT':
+						$iOperatorCode = TREE_OPERATOR_BELOW_STRICT;
+						break;
+						case 'NOT_BELOW':
+						$iOperatorCode = TREE_OPERATOR_NOT_BELOW;
+						break;
+						case 'NOT_BELOW_STRICT':
+						$iOperatorCode = TREE_OPERATOR_NOT_BELOW_STRICT;
+						break;
+						case 'ABOVE':
+						$iOperatorCode = TREE_OPERATOR_ABOVE;
+						break;
+						case 'ABOVE_STRICT':
+						$iOperatorCode = TREE_OPERATOR_ABOVE_STRICT;
+						break;
+						case 'NOT_ABOVE':
+						$iOperatorCode = TREE_OPERATOR_NOT_ABOVE;
+						break;
+						case 'NOT_ABOVE_STRICT':
+						$iOperatorCode = TREE_OPERATOR_NOT_ABOVE_STRICT;
+						break;
+					}
+					$sTargetClass = $oModelReflection->GetAttributeProperty($aAliases[$sFromClass], $sExtKeyAttCode, 'targetclass');
+					if(!$oModelReflection->IsSameFamilyBranch($aAliases[$sToClass], $sTargetClass))
+					{
+						throw new OqlNormalizeException("The joined class ($aAliases[$sToClass]) is not compatible with the external key, which is pointing to $sTargetClass", $sSourceQuery, $oLeftField->GetNameDetails());
+					}
+					$aAttList = $oModelReflection->ListAttributes($aAliases[$sFromClass]);
+					$sAttType = $aAttList[$sExtKeyAttCode];
+					if(($iOperatorCode != TREE_OPERATOR_EQUALS) && !is_subclass_of($sAttType, 'AttributeHierarchicalKey') && ($sAttType != 'AttributeHierarchicalKey'))
+					{
+						throw new OqlNormalizeException("The specified tree operator $sOperator is not applicable to the key", $sSourceQuery, $oLeftField->GetNameDetails());
+					}
+				}
+			}
+		}
+
+		// Check the select information
+		//
+		$aSelected = array();
+		foreach ($this->GetSelectedClasses() as $oClassDetails)
+		{
+			$sClassToSelect = $oClassDetails->GetValue();
+			if (!array_key_exists($sClassToSelect, $aAliases))
+			{
+				throw new OqlNormalizeException('Unknown class [alias]', $sSourceQuery, $oClassDetails, array_keys($aAliases));
+			}
+			$aSelected[$sClassToSelect] = $aAliases[$sClassToSelect];
+		}
+
+		// Check the condition tree
+		//
+		if ($this->m_oCondition instanceof Expression)
+		{
+			$this->m_oCondition->Check($oModelReflection, $aAliases, $sSourceQuery);
+		}
+	}
 }
 
 ?>

core/ormcaselog.class.inc.php

@@ -1,31 +1,35 @@
 <?php
-// Copyright (C) 2011 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 define('CASELOG_VISIBLE_ITEMS', 2);
 define('CASELOG_SEPARATOR', "\n".'========== %1$s : %2$s (%3$d) ============'."\n\n");
 
-//require_once(APPROOT.'/core/userrights.class.inc.php');
-//require_once(APPROOT.'/application/webpage.class.inc.php');
 
 /**
  * Class to store a "case log" in a structured way, keeping track of its successive entries
+ *  
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 class ormCaseLog {
 	protected $m_sLog;
 	protected $m_aIndex;
+	protected $m_bModified;
 	
 	/**
 	 * Initializes the log with the first (initial) entry
@@ -36,6 +40,7 @@ class ormCaseLog {
 	{
 		$this->m_sLog = $sLog;
 		$this->m_aIndex = $aIndex;
+		$this->m_bModified = false;
 	}
 	
 	public function GetText()
@@ -43,42 +48,33 @@ class ormCaseLog {
 		return $this->m_sLog;
 	}
 	
-	public function GetIndex()
+	public static function FromJSON($oJson)
 	{
-		return $this->m_aIndex;
+		if (!isset($oJson->items))
+		{
+			throw new Exception("Missing 'items' elements");
+		}
+		$oCaseLog = new ormCaseLog();
+		foreach($oJson->items as $oItem)
+		{
+			$oCaseLog->AddLogEntryFromJSON($oItem);
+		}
+		return $oCaseLog;
 	}
 
-	public function __toString()
+	/**
+	 * Return a value that will be further JSON encoded	
+	 */	
+	public function GetForJSON()
 	{
-		return $this->m_sLog;
-	}
-	
-	public function GetAsHTML(WebPage $oP = null, $bEditMode = false, $aTransfoHandler = null)
-	{
-		$sHtml = '<table style="width:100%;table-layout:fixed"><tr><td>'; // Use table-layout:fixed to force the with to be independent from the actual content
+		$aEntries = array();
 		$iPos = 0;
 		for($index=count($this->m_aIndex)-1 ; $index >= 0 ; $index--)
 		{
-			if ($index < count($this->m_aIndex) - CASELOG_VISIBLE_ITEMS)
-			{
-				$sOpen = '';
-				$sDisplay = 'style="display:none;"';
-			}
-			else
-			{
-				$sOpen = ' open';
-				$sDisplay = '';
-			}
 			$iPos += $this->m_aIndex[$index]['separator_length'];
 			$sTextEntry = substr($this->m_sLog, $iPos, $this->m_aIndex[$index]['text_length']);
-			$sTextEntry = str_replace(array("\r\n", "\n", "\r"), "<br/>", htmlentities($sTextEntry, ENT_QUOTES, 'UTF-8'));
-			if (!is_null($aTransfoHandler))
-			{
-				$sTextEntry = call_user_func($aTransfoHandler, $sTextEntry);
-			}
 			$iPos += $this->m_aIndex[$index]['text_length'];
 
-			$sEntry = '<div class="caselog_header'.$sOpen.'">';
 			// Workaround: PHP < 5.3 cannot unserialize correctly DateTime objects,
 			// therefore we have changed the format. To preserve the compatibility with existing
 			// installations of iTop, both format are allowed:
@@ -86,7 +82,7 @@ class ormCaseLog {
 			if (is_int($this->m_aIndex[$index]['date']))
 			{
 				// Unix timestamp
-				$sDate = date(Dict::S('UI:CaseLog:DateFormat'), $this->m_aIndex[$index]['date']);
+				$sDate = date(Dict::S('UI:CaseLog:DateFormat'),$this->m_aIndex[$index]['date']);
 			}
 			elseif (is_object($this->m_aIndex[$index]['date']))
 			{
@@ -101,7 +97,180 @@ class ormCaseLog {
 					$sDate = '';
 				}
 			}
-			$sEntry .= sprintf(Dict::S('UI:CaseLog:Header_Date_UserName'), $sDate, $this->m_aIndex[$index]['user_name']);
+			$aEntries[] = array(
+				'date' => $sDate,
+				'user_login' => $this->m_aIndex[$index]['user_name'],
+				'user_id' => $this->m_aIndex[$index]['user_id'],
+				'message' => $sTextEntry
+			);
+		}
+
+		// Process the case of an eventual remainder (quick migration of AttributeText fields)
+		if ($iPos < (strlen($this->m_sLog) - 1))
+		{
+			$sTextEntry = substr($this->m_sLog, $iPos);
+
+			$aEntries[] = array(
+				'date' => '',
+				'user_login' => '',
+				'message' => $sTextEntry
+			);
+		}
+
+		// Order by ascending date
+		$aRet = array('entries' => array_reverse($aEntries));
+		return $aRet;
+	}
+	
+	public function GetIndex()
+	{
+		return $this->m_aIndex;
+	}
+
+	public function __toString()
+	{
+		return $this->m_sLog;
+	}
+	
+	public function ClearModifiedFlag()
+	{
+		$this->m_bModified = false;
+	}
+
+	/**
+	 * Produces an HTML representation, aimed at being used within an email
+	 */	 	
+	public function GetAsEmailHtml()
+	{
+		$sStyleCaseLogHeader = '';
+		$sStyleCaseLogEntry = '';
+
+		$sHtml = '<table style="width:100%;table-layout:fixed"><tr><td>'; // Use table-layout:fixed to force the with to be independent from the actual content
+		$iPos = 0;
+		$aIndex = $this->m_aIndex;
+		for($index=count($aIndex)-1 ; $index >= 0 ; $index--)
+		{
+			$iPos += $aIndex[$index]['separator_length'];
+			$sTextEntry = substr($this->m_sLog, $iPos, $aIndex[$index]['text_length']);
+			$sTextEntry = str_replace(array("\r\n", "\n", "\r"), "<br/>", htmlentities($sTextEntry, ENT_QUOTES, 'UTF-8'));
+			$iPos += $aIndex[$index]['text_length'];
+
+			$sEntry = '<div class="caselog_header" style="'.$sStyleCaseLogHeader.'">';
+			// Workaround: PHP < 5.3 cannot unserialize correctly DateTime objects,
+			// therefore we have changed the format. To preserve the compatibility with existing
+			// installations of iTop, both format are allowed:
+			//     the 'date' item is either a DateTime object, or a unix timestamp
+			if (is_int($aIndex[$index]['date']))
+			{
+				// Unix timestamp
+				$sDate = date(Dict::S('UI:CaseLog:DateFormat'),$aIndex[$index]['date']);
+			}
+			elseif (is_object($aIndex[$index]['date']))
+			{
+				if (version_compare(phpversion(), '5.3.0', '>='))
+				{
+					// DateTime
+					$sDate = $aIndex[$index]['date']->format(Dict::S('UI:CaseLog:DateFormat'));
+				}
+				else
+				{
+					// No Warning... but the date is unknown
+					$sDate = '';
+				}
+			}
+			$sEntry .= sprintf(Dict::S('UI:CaseLog:Header_Date_UserName'), '<span class="caselog_header_date">'.$sDate.'</span>', '<span class="caselog_header_user">'.$aIndex[$index]['user_name'].'</span>');
+			$sEntry .= '</div>';
+			$sEntry .= '<div class="caselog_entry" style="'.$sStyleCaseLogEntry.'">';
+			$sEntry .= $sTextEntry;
+			$sEntry .= '</div>';
+			$sHtml = $sHtml.$sEntry;
+		}
+
+		// Process the case of an eventual remainder (quick migration of AttributeText fields)
+		if ($iPos < (strlen($this->m_sLog) - 1))
+		{
+			$sTextEntry = substr($this->m_sLog, $iPos);
+			$sTextEntry = str_replace(array("\r\n", "\n", "\r"), "<br/>", htmlentities($sTextEntry, ENT_QUOTES, 'UTF-8'));
+
+			if (count($this->m_aIndex) == 0)
+			{
+				$sHtml .= '<div class="caselog_entry" style="'.$sStyleCaseLogEntry.'"">';
+				$sHtml .= $sTextEntry;
+				$sHtml .= '</div>';
+			}
+			else
+			{
+				$sHtml .= '<div class="caselog_header" style="'.$sStyleCaseLogHeader.'">';
+				$sHtml .= Dict::S('UI:CaseLog:InitialValue');
+				$sHtml .= '</div>';
+				$sHtml .= '<div class="caselog_entry" style="'.$sStyleCaseLogEntry.'">';
+				$sHtml .= $sTextEntry;
+				$sHtml .= '</div>';
+			}
+		}
+		$sHtml .= '</td></tr></table>';
+		return $sHtml;
+	}
+	
+	/**
+	 * Produces an HTML representation, aimed at being used within the iTop framework
+	 */	 	
+	public function GetAsHTML(WebPage $oP = null, $bEditMode = false, $aTransfoHandler = null)
+	{
+		$sHtml = '<table style="width:100%;table-layout:fixed"><tr><td>'; // Use table-layout:fixed to force the with to be independent from the actual content
+		$iPos = 0;
+		$aIndex = $this->m_aIndex;
+		if (($bEditMode) && (count($aIndex) > 0) && $this->m_bModified)
+		{
+			// Don't display the first element, that is still considered as editable
+			$iPos = $aIndex[0]['separator_length'] + $aIndex[0]['text_length'];
+			array_shift($aIndex); 
+		}
+		for($index=count($aIndex)-1 ; $index >= 0 ; $index--)
+		{
+			if ($index < count($aIndex) - CASELOG_VISIBLE_ITEMS)
+			{
+				$sOpen = '';
+				$sDisplay = 'style="display:none;"';
+			}
+			else
+			{
+				$sOpen = ' open';
+				$sDisplay = '';
+			}
+			$iPos += $aIndex[$index]['separator_length'];
+			$sTextEntry = substr($this->m_sLog, $iPos, $aIndex[$index]['text_length']);
+			$sTextEntry = str_replace(array("\r\n", "\n", "\r"), "<br/>", htmlentities($sTextEntry, ENT_QUOTES, 'UTF-8'));
+			if (!is_null($aTransfoHandler))
+			{
+				$sTextEntry = call_user_func($aTransfoHandler, $sTextEntry);
+			}
+			$iPos += $aIndex[$index]['text_length'];
+
+			$sEntry = '<div class="caselog_header'.$sOpen.'">';
+			// Workaround: PHP < 5.3 cannot unserialize correctly DateTime objects,
+			// therefore we have changed the format. To preserve the compatibility with existing
+			// installations of iTop, both format are allowed:
+			//     the 'date' item is either a DateTime object, or a unix timestamp
+			if (is_int($aIndex[$index]['date']))
+			{
+				// Unix timestamp
+				$sDate = date(Dict::S('UI:CaseLog:DateFormat'),$aIndex[$index]['date']);
+			}
+			elseif (is_object($aIndex[$index]['date']))
+			{
+				if (version_compare(phpversion(), '5.3.0', '>='))
+				{
+					// DateTime
+					$sDate = $aIndex[$index]['date']->format(Dict::S('UI:CaseLog:DateFormat'));
+				}
+				else
+				{
+					// No Warning... but the date is unknown
+					$sDate = '';
+				}
+			}
+			$sEntry .= sprintf(Dict::S('UI:CaseLog:Header_Date_UserName'), $sDate, $aIndex[$index]['user_name']);
 			$sEntry .= '</div>';
 			$sEntry .= '<div class="caselog_entry"'.$sDisplay.'>';
 			$sEntry .= $sTextEntry;
@@ -150,11 +319,13 @@ class ormCaseLog {
 	}
 	
 	/**
-	 * Add a new entry to the log and updates the internal index
+	 * Add a new entry to the log or merge the given text into the currently modified entry 
+	 * and updates the internal index
 	 * @param $sText string The text of the new entry 
 	 */
 	public function AddLogEntry($sText, $sOnBehalfOf = '')
 	{
+		$bMergeEntries = false;
 		$sDate = date(Dict::S('UI:CaseLog:DateFormat'));
 		if ($sOnBehalfOf == '')
 		{
@@ -165,6 +336,92 @@ class ormCaseLog {
 		{
 			$iUserId = null;
 		}
+		if ($this->m_bModified)
+		{
+			$aLatestEntry = end($this->m_aIndex);
+			if ($aLatestEntry['user_name'] != $sOnBehalfOf)
+			{
+				$bMergeEntries = false;
+			}
+			else
+			{
+				$bMergeEntries = true;
+			}
+		}
+		
+		if ($bMergeEntries)
+		{
+			$aLatestEntry = end($this->m_aIndex);
+			$this->m_sLog = substr($this->m_sLog, $aLatestEntry['separator_length']);
+			$sSeparator = sprintf(CASELOG_SEPARATOR, $sDate, $sOnBehalfOf, $iUserId);
+			$iSepLength = strlen($sSeparator);
+			$iTextlength = strlen($sText."\n");
+			$this->m_sLog = $sSeparator.$sText.$this->m_sLog; // Latest entry printed first
+			$this->m_aIndex[] = array(
+				'user_name' => $sOnBehalfOf,	
+				'user_id' => $iUserId,	
+				'date' => time(),	
+				'text_length' => $aLatestEntry['text_length'] + $iTextlength,	
+				'separator_length' => $iSepLength,	
+			);
+			
+		}
+		else
+		{
+			$sSeparator = sprintf(CASELOG_SEPARATOR, $sDate, $sOnBehalfOf, $iUserId);
+			$iSepLength = strlen($sSeparator);
+			$iTextlength = strlen($sText);
+			$this->m_sLog = $sSeparator.$sText.$this->m_sLog; // Latest entry printed first
+			$this->m_aIndex[] = array(
+				'user_name' => $sOnBehalfOf,	
+				'user_id' => $iUserId,	
+				'date' => time(),	
+				'text_length' => $iTextlength,	
+				'separator_length' => $iSepLength,	
+			);
+		}
+		$this->m_bModified = true;
+	}
+
+
+	public function AddLogEntryFromJSON($oJson)
+	{
+		$sText = isset($oJson->message) ? $oJson->message : '';
+
+		if (isset($oJson->user_id))
+		{
+			if (!UserRights::IsAdministrator())
+			{
+				throw new Exception("Only administrators can set the user id", RestResult::UNAUTHORIZED);
+			}
+			try
+			{
+				$oUser = RestUtils::FindObjectFromKey('User', $oJson->user_id);
+			}
+			catch(Exception $e)
+			{
+				throw new Exception('user_id: '.$e->getMessage(), $e->getCode());
+			}
+			$iUserId = $oUser->GetKey();
+			$sOnBehalfOf = $oUser->GetFriendlyName();
+		}
+		else
+		{
+			$iUserId = UserRights::GetUserId();
+			$sOnBehalfOf = UserRights::GetUserFriendlyName();
+		}
+		
+		if (isset($oJson->date))
+		{
+			$oDate = new DateTime($oJson->date);
+			$iDate = (int) $oDate->format('U');
+		}
+		else
+		{
+			$iDate = time();
+		}
+		$sDate = date(Dict::S('UI:CaseLog:DateFormat'), $iDate);
+
 		$sSeparator = sprintf(CASELOG_SEPARATOR, $sDate, $sOnBehalfOf, $iUserId);
 		$iSepLength = strlen($sSeparator);
 		$iTextlength = strlen($sText);
@@ -172,10 +429,23 @@ class ormCaseLog {
 		$this->m_aIndex[] = array(
 			'user_name' => $sOnBehalfOf,	
 			'user_id' => $iUserId,	
-			'date' => time(),	
+			'date' => $iDate,	
 			'text_length' => $iTextlength,	
 			'separator_length' => $iSepLength,	
 		);
+
+		$this->m_bModified = true;
+	}
+
+
+	public function GetModifiedEntry()
+	{
+		$sModifiedEntry = '';
+		if ($this->m_bModified)
+		{
+			$sModifiedEntry = $this->GetLatestEntry();
+		}
+		return $sModifiedEntry;
 	}
 
 	/**
@@ -200,4 +470,4 @@ class ormCaseLog {
 		return $iLast;
 	}
 }
-?>
+?>

core/ormdocument.class.inc.php

@@ -1,27 +1,28 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * ormDocument
  * encapsulate the behavior of a binary data set that will be stored an attribute of class AttributeBlob 
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -116,5 +117,32 @@ class ormDocument
 	{
 		return "<a href=\"".utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php?operation=download_document&class=$sClass&id=$Id&field=$sAttCode\">".$this->GetFileName()."</a>\n";
 	}
+
+	/**
+	 * Returns an URL to download a document like an image (uses HTTP caching)
+	 * @return string
+	 */	 	 	
+	public function GetDownloadURL($sClass, $Id, $sAttCode)
+	{
+		// Compute a signature to reset the cache anytime the data changes (this is acceptable if used only with icon files)
+		$sSignature = md5($this->GetData());
+		return utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php?operation=download_document&class=$sClass&id=$Id&field=$sAttCode&s=$sSignature&cache=86400";
+	}
+
+	
+	public function IsPreviewAvailable()
+	{
+		$bRet = false;
+		switch($this->GetMimeType())
+		{
+			case 'image/png':
+			case 'image/jpg':
+			case 'image/jpeg':
+			case 'image/gif':
+			$bRet = true;
+			break;
+		}
+		return $bRet;
+	}
 }
 ?>

core/ormpassword.class.inc.php

@@ -1,18 +1,21 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 require_once(APPROOT.'/core/simplecrypt.class.inc.php');
 
@@ -23,10 +26,8 @@ require_once(APPROOT.'/core/simplecrypt.class.inc.php');
  * If a cryptographic random number generator is available (on Linux or Windows)
  * it will be used for generating the salt.
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  * @package     itopORM
  */
 

core/ormstopwatch.class.inc.php

@@ -0,0 +1,467 @@
+<?php
+// Copyright (C) 2010-2013 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+require_once('backgroundprocess.inc.php');
+
+/**
+ * ormStopWatch
+ * encapsulate the behavior of a stop watch that will be stored as an attribute of class AttributeStopWatch 
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+
+/**
+ * ormStopWatch
+ * encapsulate the behavior of a stop watch that will be stored as an attribute of class AttributeStopWatch 
+ *
+ * @package     itopORM
+ */
+class ormStopWatch
+{
+	protected $iTimeSpent; // seconds
+	protected $iStarted; // unix time (seconds)
+	protected $iLastStart; // unix time (seconds)
+	protected $iStopped; // unix time (seconds)
+	protected $aThresholds;
+	
+	/**
+	 * Constructor
+	 */
+	public function __construct($iTimeSpent = 0, $iStarted = null, $iLastStart = null, $iStopped = null)
+	{
+		$this->iTimeSpent = (int) $iTimeSpent;
+		$this->iStarted = $iStarted;
+		$this->iLastStart = $iLastStart;
+		$this->iStopped = $iStopped;
+
+		$this->aThresholds = array();
+	}
+
+	/**
+	 * Necessary for the triggers
+	 */	 	
+	public function __toString()
+	{
+		return (string) $this->iTimeSpent;
+	}
+
+	public function DefineThreshold($iPercent, $tDeadline = null, $bPassed = false, $bTriggered = false, $iOverrun = null)
+	{
+		$this->aThresholds[$iPercent] = array(
+			'deadline' => $tDeadline, // unix time (seconds)
+			'triggered' => $bTriggered,
+			'overrun' => $iOverrun
+		);
+	}
+
+	public function MarkThresholdAsTriggered($iPercent)
+	{
+		$this->aThresholds[$iPercent]['triggered'] = true;
+	}
+
+	public function GetTimeSpent()
+	{
+		return $this->iTimeSpent;
+	}
+
+	public function GetStartDate()
+	{
+		return $this->iStarted;
+	}
+
+	public function GetLastStartDate()
+	{
+		return $this->iLastStart;
+	}
+
+	public function GetStopDate()
+	{
+		return $this->iStopped;
+	}
+
+	public function GetThresholdDate($iPercent)
+	{
+		if (array_key_exists($iPercent, $this->aThresholds))
+		{
+			return $this->aThresholds[$iPercent]['deadline'];
+		}
+		else
+		{
+			return null;
+		}
+	}
+
+	public function GetOverrun($iPercent)
+	{
+		if (array_key_exists($iPercent, $this->aThresholds))
+		{
+			return $this->aThresholds[$iPercent]['overrun'];
+		}
+		else
+		{
+			return null;
+		}
+	}
+	public function IsThresholdPassed($iPercent)
+	{
+		$bRet = false;
+		if (array_key_exists($iPercent, $this->aThresholds))
+		{
+			$aThresholdData = $this->aThresholds[$iPercent];
+			if (!is_null($aThresholdData['deadline']) && ($aThresholdData['deadline'] <= time()))
+			{
+				$bRet = true;
+			}
+		}
+		return $bRet;
+	}
+	public function IsThresholdTriggered($iPercent)
+	{
+		if (array_key_exists($iPercent, $this->aThresholds))
+		{
+			return $this->aThresholds[$iPercent]['triggered'];
+		}
+		else
+		{
+			return false;
+		}
+	}
+
+	public function GetAsHTML($oAttDef, $oHostObject = null)
+	{
+		$aProperties = array();
+
+		$aProperties['States'] = implode(', ', $oAttDef->GetStates());
+
+		if (is_null($this->iLastStart))
+		{
+			if (is_null($this->iStarted))
+			{
+				$aProperties['Elapsed'] = 'never started';
+			}
+			else
+			{
+				$aProperties['Elapsed'] = $this->iTimeSpent.' s';
+			}
+		}
+		else
+		{
+			$aProperties['Elapsed'] = 'running <img src="../images/indicator.gif">';
+		}
+
+		$aProperties['Started'] = $oAttDef->SecondsToDate($this->iStarted);
+		$aProperties['LastStart'] = $oAttDef->SecondsToDate($this->iLastStart);
+		$aProperties['Stopped'] = $oAttDef->SecondsToDate($this->iStopped);
+
+		foreach ($this->aThresholds as $iPercent => $aThresholdData)
+		{
+			$sThresholdDesc = $oAttDef->SecondsToDate($aThresholdData['deadline']);
+			if ($aThresholdData['triggered'])
+			{
+				$sThresholdDesc .= " <b>TRIGGERED</b>";
+			}
+			if ($aThresholdData['overrun'])
+			{
+				$sThresholdDesc .= " Overrun:".(int) $aThresholdData['overrun']." sec.";
+			}
+			$aProperties[$iPercent.'%'] = $sThresholdDesc;
+		}
+		$sRes = "<TABLE>";
+		$sRes .= "<TBODY>";
+		foreach ($aProperties as $sProperty => $sValue)
+		{
+			$sRes .= "<TR>";
+			$sCell = str_replace("\n", "<br>\n", $sValue);
+			$sRes .= "<TD class=\"label\">$sProperty</TD><TD>$sCell</TD>";
+			$sRes .= "</TR>";
+		}
+		$sRes .= "</TBODY>";
+		$sRes .= "</TABLE>";
+		return $sRes;
+	}
+
+	protected function ComputeGoal($oObject, $oAttDef)
+	{
+		$sMetricComputer = $oAttDef->Get('goal_computing');
+		$oComputer = new $sMetricComputer();
+		$aCallSpec = array($oComputer, 'ComputeMetric');
+		if (!is_callable($aCallSpec))
+		{
+			throw new CoreException("Unknown class/verb '$sMetricComputer/ComputeMetric'");
+		}
+		$iRet = call_user_func($aCallSpec, $oObject);
+		return $iRet;
+	}
+
+	protected function ComputeDeadline($oObject, $oAttDef, $iStartTime, $iDurationSec)
+	{
+		$sWorkingTimeComputer = $oAttDef->Get('working_time_computing');
+		if ($sWorkingTimeComputer == '')
+		{
+			$sWorkingTimeComputer = class_exists('SLAComputation') ? 'SLAComputation' : 'DefaultWorkingTimeComputer';
+		}
+		$aCallSpec = array($sWorkingTimeComputer, '__construct');
+		if (!is_callable($aCallSpec))
+		{
+			//throw new CoreException("Pas de constructeur pour $sWorkingTimeComputer!");
+		}
+		$oComputer = new $sWorkingTimeComputer();
+		$aCallSpec = array($oComputer, 'GetDeadline');
+		if (!is_callable($aCallSpec))
+		{
+			throw new CoreException("Unknown class/verb '$sWorkingTimeComputer/GetDeadline'");
+		}
+		// GetDeadline($oObject, $iDuration, DateTime $oStartDate)
+		$oStartDate = new DateTime('@'.$iStartTime); // setTimestamp not available in PHP 5.2
+		$oDeadline = call_user_func($aCallSpec, $oObject, $iDurationSec, $oStartDate);
+		$iRet = $oDeadline->format('U');
+		return $iRet;
+	}
+
+	protected function ComputeDuration($oObject, $oAttDef, $iStartTime, $iEndTime)
+	{
+		$sWorkingTimeComputer = $oAttDef->Get('working_time_computing');
+		if ($sWorkingTimeComputer == '')
+		{
+			$sWorkingTimeComputer = class_exists('SLAComputation') ? 'SLAComputation' : 'DefaultWorkingTimeComputer';
+		}
+		$oComputer = new $sWorkingTimeComputer();
+		$aCallSpec = array($oComputer, 'GetOpenDuration');
+		if (!is_callable($aCallSpec))
+		{
+			throw new CoreException("Unknown class/verb '$sWorkingTimeComputer/GetOpenDuration'");
+		}
+		// GetOpenDuration($oObject, DateTime $oStartDate, DateTime $oEndDate)
+		$oStartDate = new DateTime('@'.$iStartTime); // setTimestamp not available in PHP 5.2
+		$oEndDate = new DateTime('@'.$iEndTime);
+		$iRet = call_user_func($aCallSpec, $oObject, $oStartDate, $oEndDate);
+		return $iRet;
+	}
+
+	public function Reset($oObject, $oAttDef)
+	{
+		$this->iTimeSpent = 0;
+		$this->iStopped = null;
+		$this->iStarted = null;
+
+		foreach ($this->aThresholds as $iPercent => &$aThresholdData)
+		{
+			$aThresholdData['triggered'] = false;
+			$aThresholdData['overrun'] = null;
+		}
+
+		if (!is_null($this->iLastStart))
+		{
+			// Currently running... starting again from now!
+			$this->iStarted = time();
+			$this->iLastStart = time();
+			$this->ComputeDeadlines($oObject, $oAttDef);
+		}
+	}
+
+	/**
+	 * Start or continue
+	 * It is the responsibility of the caller to compute the deadlines
+	 * (to avoid computing twice for the same result) 	 
+	 */	 	 	
+	public function Start($oObject, $oAttDef)
+	{
+		if (!is_null($this->iLastStart))
+		{
+			// Already started
+			return false;
+		}
+
+		if (is_null($this->iStarted))
+		{
+			$this->iStarted = time();
+		}
+		$this->iLastStart = time();
+		$this->iStopped = null;
+
+		return true;
+	}
+
+	/**
+	 * Compute or recompute the goal and threshold deadlines
+	 */	 	 	
+	public function ComputeDeadlines($oObject, $oAttDef)
+	{
+		if (is_null($this->iLastStart))
+		{
+			// Currently stopped - do nothing
+			return false;
+		}
+		
+		$iDurationGoal = $this->ComputeGoal($oObject, $oAttDef);
+		foreach ($this->aThresholds as $iPercent => &$aThresholdData)
+		{
+			if (is_null($iDurationGoal))
+			{
+				// No limit: leave null thresholds
+				$aThresholdData['deadline'] = null;
+			}
+			else
+			{
+				$iThresholdDuration = round($iPercent * $iDurationGoal / 100);
+				$aThresholdData['deadline'] = $this->ComputeDeadline($oObject, $oAttDef, $this->iLastStart, $iThresholdDuration - $this->iTimeSpent);
+				// OR $aThresholdData['deadline'] = $this->ComputeDeadline($oObject, $oAttDef, $this->iStarted, $iThresholdDuration);
+
+			}
+			if (is_null($aThresholdData['deadline']) || ($aThresholdData['deadline'] > time()))
+			{
+				// The threshold is in the future, reset
+				$aThresholdData['triggered'] = false;
+				$aThresholdData['overrun'] = null;
+			}
+			else
+			{
+				// The new threshold is in the past
+				// Note: the overrun can be wrong, but the correct algorithm to compute
+				// the overrun of a deadline in the past requires that the ormStopWatch keeps track of all its history!!!
+			}
+		}
+
+		return true;
+	}
+
+	/**
+	 * Stop counting if not already done
+	 */	 	 	
+	public function Stop($oObject, $oAttDef)
+	{
+		if (is_null($this->iLastStart))
+		{
+			// Already stopped
+			return false;
+		}
+
+		$iElapsed = $this->ComputeDuration($oObject, $oAttDef, $this->iLastStart, time());
+		$this->iTimeSpent = $this->iTimeSpent + $iElapsed;
+
+		foreach ($this->aThresholds as $iPercent => &$aThresholdData)
+		{
+			if (!is_null($aThresholdData['deadline']) && (time() > $aThresholdData['deadline']))
+			{
+				if ($aThresholdData['overrun'] > 0)
+				{
+					// Accumulate from last start
+					$aThresholdData['overrun'] += $iElapsed;
+				}
+				else
+				{
+					// First stop after the deadline has been passed
+					$iOverrun = $this->ComputeDuration($oObject, $oAttDef, $aThresholdData['deadline'], time());
+					$aThresholdData['overrun'] = $iOverrun;
+				}
+			}
+			$aThresholdData['deadline'] = null;
+		}
+
+		$this->iLastStart = null;
+		$this->iStopped = time();
+
+		return true;
+	}
+}
+
+/**
+ * CheckStopWatchThresholds
+ * Implements the automatic actions 
+ *
+ * @package     itopORM
+ */
+class CheckStopWatchThresholds implements iBackgroundProcess
+{
+	public function GetPeriodicity()
+	{	
+		return 10; // seconds
+	}
+
+	public function Process($iTimeLimit)
+	{
+		$aList = array();
+		foreach (MetaModel::GetClasses() as $sClass)
+		{
+			foreach (MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef)
+			{
+				if ($oAttDef instanceof AttributeStopWatch)
+				{
+					foreach ($oAttDef->ListThresholds() as $iThreshold => $aThresholdData)
+					{
+						$iPercent = $aThresholdData['percent']; // could be different than the index !
+		
+						$sNow = date('Y-m-d H:i:s');
+						$sExpression = "SELECT $sClass WHERE {$sAttCode}_laststart AND {$sAttCode}_{$iThreshold}_triggered = 0 AND {$sAttCode}_{$iThreshold}_deadline < '$sNow'";
+						$oFilter = DBObjectSearch::FromOQL($sExpression);
+						$oSet = new DBObjectSet($oFilter);
+						while ((time() < $iTimeLimit) && ($oObj = $oSet->Fetch()))
+						{
+							$sClass = get_class($oObj);
+
+							$aList[] = $sClass.'::'.$oObj->GetKey().' '.$sAttCode.' '.$iThreshold;
+
+							// Execute planned actions
+							//
+							foreach ($aThresholdData['actions'] as $aActionData)
+							{
+								$sVerb = $aActionData['verb'];
+								$aParams = $aActionData['params'];
+								$sParams = implode(', ', $aParams);
+								$aCallSpec = array($oObj, $sVerb);
+								call_user_func_array($aCallSpec, $aParams);
+							}
+
+							// Mark the threshold as "triggered"
+							//
+							$oSW = $oObj->Get($sAttCode);
+							$oSW->MarkThresholdAsTriggered($iThreshold);
+							$oObj->Set($sAttCode, $oSW);
+		
+							if($oObj->IsModified())
+							{
+								CMDBObject::SetTrackInfo("Automatic - threshold triggered");
+					
+								$oMyChange = CMDBObject::GetCurrentChange();
+								$oObj->DBUpdateTracked($oMyChange, true /*skip security*/);
+							}
+
+							// Activate any existing trigger
+							// 
+							$sClassList = implode("', '", MetaModel::EnumParentClasses($sClass, ENUM_PARENT_CLASSES_ALL));
+							$oTriggerSet = new DBObjectSet(
+								DBObjectSearch::FromOQL("SELECT TriggerOnThresholdReached AS t WHERE t.target_class IN ('$sClassList') AND stop_watch_code=:stop_watch_code AND threshold_index = :threshold_index"),
+								array(), // order by
+								array('stop_watch_code' => $sAttCode, 'threshold_index' => $iThreshold)
+							);
+							while ($oTrigger = $oTriggerSet->Fetch())
+							{
+								$oTrigger->DoActivate($oObj->ToArgs('this'));
+							}
+						}
+					}
+				}
+			}
+		}
+
+		$iProcessed = count($aList);
+		return "Triggered $iProcessed threshold(s):".implode(", ", $aList);
+	}
+}

core/querybuildercontext.class.inc.php

@@ -0,0 +1,74 @@
+<?php
+// Copyright (C) 2010-2012 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+/**
+ * Associated with the metamodel -> MakeQuery/MakeQuerySingleTable
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+class QueryBuilderContext
+{
+	protected $m_oRootFilter;
+	protected $m_aClassAliases;
+	protected $m_aTableAliases;
+	protected $m_aModifierProperties;
+
+	public $m_oQBExpressions;
+
+	public function __construct($oFilter, $aModifierProperties, $aGroupByExpr = null)
+	{
+		$this->m_oRootFilter = $oFilter;
+		$this->m_oQBExpressions = new QueryBuilderExpressions($oFilter, $aGroupByExpr);
+
+		$this->m_aClassAliases = $oFilter->GetJoinedClasses();
+		$this->m_aTableAliases = array();
+
+		$this->m_aModifierProperties = $aModifierProperties;
+	}
+
+	public function GetRootFilter()
+	{
+		return $this->m_oRootFilter;
+	}
+
+	public function GenerateTableAlias($sNewName, $sRealName)
+	{
+		return MetaModel::GenerateUniqueAlias($this->m_aTableAliases, $sNewName, $sRealName);
+	}
+
+	public function GenerateClassAlias($sNewName, $sRealName)
+	{
+		return MetaModel::GenerateUniqueAlias($this->m_aClassAliases, $sNewName, $sRealName);
+	}
+
+	public function GetModifierProperties($sPluginClass)
+	{
+		if (array_key_exists($sPluginClass, $this->m_aModifierProperties))
+		{
+			return $this->m_aModifierProperties[$sPluginClass];
+		}
+		else
+		{
+			return array();
+		}
+	}
+}
+
+?>

core/querymodifier.class.inc.php

@@ -0,0 +1,34 @@
+<?php
+// Copyright (C) 2010-2012 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+
+/**
+ * Interface iQueryModifier
+ * Defines the API to tweak queries (e.g. translate data on the fly) 
+ *
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+interface iQueryModifier
+{
+	public function __construct();
+
+	public function GetFieldExpression(QueryBuilderContext &$oBuild, $sClass, $sAttCode, $sColId, Expression $oFieldSQLExp, SQLQuery &$oSelect);
+}
+?>

core/restservices.class.inc.php

@@ -0,0 +1,643 @@
+<?php
+// Copyright (C) 2013 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
+//   but WITHOUT ANY WARRANTY; without even the implied warranty of
+//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//   GNU Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
+/**
+ * REST/json services
+ * 
+ * Definition of common structures + the very minimum service provider (manage objects)
+ *
+ * @package     REST Services
+ * @copyright   Copyright (C) 2013 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ * @api
+ */
+
+/**
+ * Element of the response formed by RestResultWithObjects
+ *
+ * @package     REST Services
+ */
+class ObjectResult
+{
+	public $code;
+	public $message;
+	public $class;
+	public $key;
+	public $fields;
+	
+	/**
+	 * Default constructor
+	 */
+	public function __construct($sClass = null, $iId = null)
+	{
+		$this->code = RestResult::OK;
+		$this->message = '';
+		$this->class = $sClass;
+		$this->key = $iId;
+		$this->fields = array();
+	}
+
+	/**
+	 * Helper to make an output value for a given attribute
+	 * 	 
+	 * @param DBObject $oObject The object being reported
+	 * @param string $sAttCode The attribute code (must be valid)
+	 * @param boolean $bExtendedOutput Output all of the link set attributes ?
+	 * @return string A scalar representation of the value
+	 */
+	protected function MakeResultValue(DBObject $oObject, $sAttCode, $bExtendedOutput = false)
+	{
+		if ($sAttCode == 'id')
+		{
+			$value = $oObject->GetKey();
+		}
+		else
+		{
+			$sClass = get_class($oObject);
+			$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+			if ($oAttDef instanceof AttributeLinkedSet)
+			{
+				// Iterate on the set and build an array of array of attcode=>value
+				$oSet = $oObject->Get($sAttCode);
+				$value = array();
+				while ($oLnk = $oSet->Fetch())
+				{
+					$sLnkRefClass = $bExtendedOutput ? get_class($oLnk) : $oAttDef->GetLinkedClass();
+
+					$aLnkValues = array();
+					foreach (MetaModel::ListAttributeDefs($sLnkRefClass) as $sLnkAttCode => $oLnkAttDef)
+					{
+						// Skip attributes pointing to the current object (redundant data)
+						if ($sLnkAttCode == $oAttDef->GetExtKeyToMe())
+						{
+							continue;
+						}
+						// Skip any attribute of the link that points to the current object
+						$oLnkAttDef = MetaModel::GetAttributeDef($sLnkRefClass, $sLnkAttCode);
+						if (method_exists($oLnkAttDef, 'GetKeyAttCode'))
+						{
+							if ($oLnkAttDef->GetKeyAttCode() == $oAttDef->GetExtKeyToMe())
+							{
+								continue;
+							}
+						}
+						
+						$aLnkValues[$sLnkAttCode] = $this->MakeResultValue($oLnk, $sLnkAttCode, $bExtendedOutput);
+					}
+					$value[] = $aLnkValues;
+				}
+			}
+			else
+			{
+				$value = $oAttDef->GetForJSON($oObject->Get($sAttCode));
+			}
+		}
+		return $value;
+	}
+
+	/**
+	 * Report the value for the given object attribute
+	 * 	 
+	 * @param DBObject $oObject The object being reported
+	 * @param string $sAttCode The attribute code (must be valid)
+	 * @param boolean $bExtendedOutput Output all of the link set attributes ?
+	 * @return void
+	 */
+	public function AddField(DBObject $oObject, $sAttCode, $bExtendedOutput = false)
+	{
+		$this->fields[$sAttCode] = $this->MakeResultValue($oObject, $sAttCode, $bExtendedOutput);
+	}
+}
+
+
+
+/**
+ * REST response for services managing objects. Derive this structure to add information and/or constants
+ *
+ * @package     Extensibility
+ * @package     REST Services
+ * @api
+ */
+class RestResultWithObjects extends RestResult
+{
+	public $objects;
+
+	/**
+	 * Report the given object
+	 * 	 
+	 * @param int An error code (RestResult::OK is no issue has been found)
+	 * @param string $sMessage Description of the error if any, an empty string otherwise
+	 * @param DBObject $oObject The object being reported
+	 * @param array $aFieldSpec An array of class => attribute codes (Cf. RestUtils::GetFieldList). List of the attributes to be reported.
+	 * @param boolean $bExtendedOutput Output all of the link set attributes ?
+	 * @return void
+	 */
+	public function AddObject($iCode, $sMessage, $oObject, $aFieldSpec = null, $bExtendedOutput = false)
+	{
+		$sClass = get_class($oObject);
+		$oObjRes = new ObjectResult($sClass, $oObject->GetKey());
+		$oObjRes->code = $iCode;
+		$oObjRes->message = $sMessage;
+
+		$aFields = null;
+		if (!is_null($aFieldSpec))
+		{
+			// Enum all classes in the hierarchy, starting with the current one
+			foreach (MetaModel::EnumParentClasses($sClass, ENUM_PARENT_CLASSES_ALL, false) as $sRefClass)
+			{
+				if (array_key_exists($sRefClass, $aFieldSpec))
+				{
+					$aFields = $aFieldSpec[$sRefClass];
+					break;
+				}
+			}
+		}
+		if (is_null($aFields))
+		{
+			// No fieldspec given, or not found...
+			$aFields = array('id', 'friendlyname');
+		}
+
+		foreach ($aFields as $sAttCode)
+		{
+			$oObjRes->AddField($oObject, $sAttCode, $bExtendedOutput);
+		}
+
+		$sObjKey = get_class($oObject).'::'.$oObject->GetKey();
+		$this->objects[$sObjKey] = $oObjRes;
+	}
+}
+
+class RestResultWithRelations extends RestResultWithObjects
+{
+	public $relations;
+	
+	public function __construct()
+	{
+		parent::__construct();
+		$this->relations = array();
+	}
+	
+	public function AddRelation($sSrcKey, $sDestKey)
+	{
+		if (!array_key_exists($sSrcKey, $this->relations))
+		{
+			$this->relations[$sSrcKey] = array();
+		}
+		$this->relations[$sSrcKey][] = array('key' => $sDestKey);
+	}
+}
+
+/**
+ * Deletion result codes for a target object (either deleted or updated)
+ *
+ * @package     Extensibility
+ * @api
+ * @since 2.0.1  
+ */
+class RestDelete
+{
+	/**
+	 * Result: Object deleted as per the initial request
+	 */
+	const OK = 0;
+	/**
+	 * Result: general issue (user rights or ... ?) 
+	 */
+	const ISSUE = 1;
+	/**
+	 * Result: Must be deleted to preserve database integrity 
+	 */
+	const AUTO_DELETE = 2;
+	/**
+	 * Result: Must be deleted to preserve database integrity, but that is NOT possible 
+	 */
+	const AUTO_DELETE_ISSUE = 3;
+	/**
+	 * Result: Must be deleted to preserve database integrity, but this must be requested explicitely 
+	 */
+	const REQUEST_EXPLICITELY = 4;
+	/**
+	 * Result: Must be updated to preserve database integrity
+	 */
+	const AUTO_UPDATE = 5;
+	/**
+	 * Result: Must be updated to preserve database integrity, but that is NOT possible
+	 */
+	const AUTO_UPDATE_ISSUE = 6;
+}
+
+/**
+ * Implementation of core REST services (create/get/update... objects)
+ *
+ * @package     Core
+ */
+class CoreServices implements iRestServiceProvider
+{
+	/**
+	 * Enumerate services delivered by this class
+	 * 	 
+	 * @param string $sVersion The version (e.g. 1.0) supported by the services
+	 * @return array An array of hash 'verb' => verb, 'description' => description
+	 */
+	public function ListOperations($sVersion)
+	{
+		// 1.1 - In the reply, objects have a 'key' entry so that it is no more necessary to split class::key programmaticaly
+		//
+		$aOps = array();
+		if (in_array($sVersion, array('1.0', '1.1'))) 
+		{
+			$aOps[] = array(
+				'verb' => 'core/create',
+				'description' => 'Create an object'
+			);
+			$aOps[] = array(
+				'verb' => 'core/update',
+				'description' => 'Update an object'
+			);
+			$aOps[] = array(
+				'verb' => 'core/apply_stimulus',
+				'description' => 'Apply a stimulus to change the state of an object'
+			);
+			$aOps[] = array(
+				'verb' => 'core/get',
+				'description' => 'Search for objects'
+			);
+			$aOps[] = array(
+				'verb' => 'core/delete',
+				'description' => 'Delete objects'
+			);
+			$aOps[] = array(
+				'verb' => 'core/get_related',
+				'description' => 'Get related objects through the specified relation'
+			);
+			$aOps[] = array(
+				'verb' => 'core/check_credentials',
+				'description' => 'Check user credentials'
+			);
+		}
+		return $aOps;
+	}
+
+	/**
+	 * Enumerate services delivered by this class
+	 * @param string $sVersion The version (e.g. 1.0) supported by the services
+	 * @return RestResult The standardized result structure (at least a message)
+	 * @throws Exception in case of internal failure.	 
+	 */
+	public function ExecOperation($sVersion, $sVerb, $aParams)
+	{
+		$oResult = new RestResultWithObjects();
+		switch ($sVerb)
+		{
+		case 'core/create':
+			RestUtils::InitTrackingComment($aParams);
+			$sClass = RestUtils::GetClass($aParams, 'class');
+			$aFields = RestUtils::GetMandatoryParam($aParams, 'fields');
+			$aShowFields = RestUtils::GetFieldList($sClass, $aParams, 'output_fields');
+			$bExtendedOutput = (RestUtils::GetOptionalParam($aParams, 'output_fields', '*') == '*+');
+	
+			$oObject = RestUtils::MakeObjectFromFields($sClass, $aFields);
+			$oObject->DBInsert();
+	
+			$oResult->AddObject(0, 'created', $oObject, $aShowFields, $bExtendedOutput);
+			break;
+	
+		case 'core/update':
+			RestUtils::InitTrackingComment($aParams);
+			$sClass = RestUtils::GetClass($aParams, 'class');
+			$key = RestUtils::GetMandatoryParam($aParams, 'key');
+			$aFields = RestUtils::GetMandatoryParam($aParams, 'fields');
+			$aShowFields = RestUtils::GetFieldList($sClass, $aParams, 'output_fields');
+			$bExtendedOutput = (RestUtils::GetOptionalParam($aParams, 'output_fields', '*') == '*+');
+	
+			$oObject = RestUtils::FindObjectFromKey($sClass, $key);
+			RestUtils::UpdateObjectFromFields($oObject, $aFields);
+			$oObject->DBUpdate();
+	
+			$oResult->AddObject(0, 'updated', $oObject, $aShowFields, $bExtendedOutput);
+			break;
+	
+		case 'core/apply_stimulus':
+			RestUtils::InitTrackingComment($aParams);
+			$sClass = RestUtils::GetClass($aParams, 'class');
+			$key = RestUtils::GetMandatoryParam($aParams, 'key');
+			$aFields = RestUtils::GetMandatoryParam($aParams, 'fields');
+			$aShowFields = RestUtils::GetFieldList($sClass, $aParams, 'output_fields');
+			$bExtendedOutput = (RestUtils::GetOptionalParam($aParams, 'output_fields', '*') == '*+');
+			$sStimulus = RestUtils::GetMandatoryParam($aParams, 'stimulus');
+	
+			$oObject = RestUtils::FindObjectFromKey($sClass, $key);
+			RestUtils::UpdateObjectFromFields($oObject, $aFields);
+		
+			$aTransitions = $oObject->EnumTransitions();
+			$aStimuli = MetaModel::EnumStimuli(get_class($oObject));
+			if (!isset($aTransitions[$sStimulus]))
+			{
+				// Invalid stimulus
+				$oResult->code = RestResult::INTERNAL_ERROR;
+				$oResult->message = "Invalid stimulus: '$sStimulus' on the object ".$oObject->GetName()." in state '".$oObject->GetState()."'";
+			}
+			else
+			{
+				$aTransition = $aTransitions[$sStimulus];
+				$sTargetState = $aTransition['target_state'];
+				$aStates = MetaModel::EnumStates($sClass);
+				$aTargetStateDef = $aStates[$sTargetState];
+				$aExpectedAttributes = $aTargetStateDef['attribute_list'];
+				
+				$aMissingMandatory = array();
+				foreach($aExpectedAttributes as $sAttCode => $iExpectCode)
+				{
+					if ( ($iExpectCode & OPT_ATT_MANDATORY) && ($oObject->Get($sAttCode) == ''))
+					{
+						$aMissingMandatory[] = $sAttCode;
+					}
+				}				
+				if (count($aMissingMandatory) == 0)
+				{
+					// If all the mandatory fields are already present, just apply the transition silently...
+					if ($oObject->ApplyStimulus($sStimulus))
+					{
+						$oObject->DBUpdate();
+						$oResult->AddObject(0, 'updated', $oObject, $aShowFields, $bExtendedOutput);
+					}
+				}
+				else
+				{
+					// Missing mandatory attributes for the transition
+					$oResult->code = RestResult::INTERNAL_ERROR;
+					$oResult->message = 'Missing mandatory attribute(s) for applying the stimulus: '.implode(', ', $aMissingMandatory).'.';
+				}
+			}	
+			break;
+	
+		case 'core/get':
+			$sClass = RestUtils::GetClass($aParams, 'class');
+			$key = RestUtils::GetMandatoryParam($aParams, 'key');
+			$aShowFields = RestUtils::GetFieldList($sClass, $aParams, 'output_fields');
+			$bExtendedOutput = (RestUtils::GetOptionalParam($aParams, 'output_fields', '*') == '*+');
+	
+			$oObjectSet = RestUtils::GetObjectSetFromKey($sClass, $key);
+			while ($oObject = $oObjectSet->Fetch())
+			{
+				$oResult->AddObject(0, '', $oObject, $aShowFields, $bExtendedOutput);
+			}
+			$oResult->message = "Found: ".$oObjectSet->Count();
+			break;
+
+		case 'core/delete':
+			$sClass = RestUtils::GetClass($aParams, 'class');
+			$key = RestUtils::GetMandatoryParam($aParams, 'key');
+			$bSimulate = RestUtils::GetOptionalParam($aParams, 'simulate', false);
+	
+			$oObjectSet = RestUtils::GetObjectSetFromKey($sClass, $key);
+			$aObjects = $oObjectSet->ToArray();
+			$this->DeleteObjects($oResult, $aObjects, $bSimulate);
+			break;
+
+		case 'core/get_related':
+			$oResult = new RestResultWithRelations();
+			$sClass = RestUtils::GetClass($aParams, 'class');
+			$key = RestUtils::GetMandatoryParam($aParams, 'key');
+			$sRelation = RestUtils::GetMandatoryParam($aParams, 'relation');
+			$iMaxRecursionDepth = RestUtils::GetOptionalParam($aParams, 'depth', 20 /* = MAX_RECURSION_DEPTH */);
+	
+			$oObjectSet = RestUtils::GetObjectSetFromKey($sClass, $key);
+			$aIndexByClass = array();
+			while ($oObject = $oObjectSet->Fetch())
+			{
+				$aRelated = array();
+				$aGraph = array();
+				$aIndexByClass[get_class($oObject)][$oObject->GetKey()] = null;
+				$oResult->AddObject(0, '', $oObject);
+				$this->GetRelatedObjects($oObject, $sRelation, $iMaxRecursionDepth, $aRelated, $aGraph);
+	
+				foreach($aRelated as $sClass => $aObjects)
+				{
+					foreach($aObjects as $oRelatedObj)
+					{
+						$aIndexByClass[get_class($oRelatedObj)][$oRelatedObj->GetKey()] = null;
+						$oResult->AddObject(0, '', $oRelatedObj);
+					}				
+				}
+				foreach($aGraph as $sSrcKey => $aDestinations)
+				{
+					foreach ($aDestinations as $sDestKey)
+					{
+						$oResult->AddRelation($sSrcKey, $sDestKey);
+					}
+				}
+			}
+			if (count($aIndexByClass) > 0)
+			{
+				$aStats = array();
+				foreach ($aIndexByClass as $sClass => $aIds)
+				{
+					$aStats[] = $sClass.'= '.count($aIds);
+				}
+				$oResult->message = "Scope: ".$oObjectSet->Count()."; Related objects: ".implode(', ', $aStats);
+			}
+			else
+			{
+				$oResult->message = "Nothing found";
+			}
+			break;
+			
+		case 'core/check_credentials':
+			$oResult = new RestResult();
+			$sUser = RestUtils::GetMandatoryParam($aParams, 'user');
+			$sPassword = RestUtils::GetMandatoryParam($aParams, 'password');
+
+			if (UserRights::CheckCredentials($sUser, $sPassword) !== true)
+			{
+				$oResult->authorized = false;
+			}
+			else
+			{
+				$oResult->authorized = true;
+			}
+			break;
+	
+		default:
+			// unknown operation: handled at a higher level
+		}
+		return $oResult;
+	}
+
+	/**
+	 * Helper for object deletion	
+	 */
+	public function DeleteObjects($oResult, $aObjects, $bSimulate)
+	{
+		$oDeletionPlan = new DeletionPlan();
+		foreach($aObjects as $oObj)
+		{
+			if ($bSimulate)
+			{
+				$oObj->CheckToDelete($oDeletionPlan);
+			}
+			else
+			{
+				$oObj->DBDelete($oDeletionPlan);
+			}
+		}
+
+		foreach ($oDeletionPlan->ListDeletes() as $sTargetClass => $aDeletes)
+		{
+			foreach ($aDeletes as $iId => $aData)
+			{
+				$oToDelete = $aData['to_delete'];
+				$bAutoDel = (($aData['mode'] == DEL_SILENT) || ($aData['mode'] == DEL_AUTO));
+				if (array_key_exists('issue', $aData))
+				{
+					if ($bAutoDel)
+					{
+						if (isset($aData['requested_explicitely'])) // i.e. in the initial list of objects to delete
+						{
+							$iCode = RestDelete::ISSUE;
+							$sPlanned = 'Cannot be deleted: '.$aData['issue'];
+						}
+						else
+						{
+							$iCode = RestDelete::AUTO_DELETE_ISSUE;
+							$sPlanned = 'Should be deleted automatically... but: '.$aData['issue'];
+						}
+					}
+					else
+					{
+						$iCode = RestDelete::REQUEST_EXPLICITELY;
+						$sPlanned = 'Must be deleted explicitely... but: '.$aData['issue'];
+					}
+				}
+				else
+				{
+					if ($bAutoDel)
+					{
+						if (isset($aData['requested_explicitely']))
+						{
+							$iCode = RestDelete::OK;
+		               $sPlanned = '';
+						}
+						else
+						{
+							$iCode = RestDelete::AUTO_DELETE;
+							$sPlanned = 'Deleted automatically';
+						}
+					}
+					else
+					{
+						$iCode = RestDelete::REQUEST_EXPLICITELY;
+						$sPlanned = 'Must be deleted explicitely';
+					}
+				}
+				$oResult->AddObject($iCode, $sPlanned, $oToDelete);
+			}
+		}
+		foreach ($oDeletionPlan->ListUpdates() as $sRemoteClass => $aToUpdate)
+		{
+			foreach ($aToUpdate as $iId => $aData)
+			{
+				$oToUpdate = $aData['to_reset'];
+				if (array_key_exists('issue', $aData))
+				{
+					$iCode = RestDelete::AUTO_UPDATE_ISSUE;
+					$sPlanned = 'Should be updated automatically... but: '.$aData['issue'];
+				}
+				else
+				{
+					$iCode = RestDelete::AUTO_UPDATE;
+					$sPlanned = 'Reset external keys: '.$aData['attributes_list'];
+				}
+				$oResult->AddObject($iCode, $sPlanned, $oToUpdate);
+			}
+		}
+		
+		if ($oDeletionPlan->FoundStopper())
+		{
+			if ($oDeletionPlan->FoundSecurityIssue())
+			{
+				$iRes = RestResult::UNAUTHORIZED;
+				$sRes = 'Deletion not allowed on some objects';
+			}
+			elseif ($oDeletionPlan->FoundManualOperation())
+			{
+				$iRes = RestResult::UNSAFE; 
+				$sRes = 'The deletion requires that other objects be deleted/updated, and those operations must be requested explicitely';
+			}
+			else
+			{
+				$iRes = RestResult::INTERNAL_ERROR; 
+				$sRes = 'Some issues have been encountered. See the list of planned changes for more information about the issue(s).';
+			}		
+		}
+		else
+		{
+			$iRes = RestResult::OK; 
+			$sRes = 'Deleted: '.count($aObjects);
+			$iIndirect = $oDeletionPlan->GetTargetCount() - count($aObjects);
+			if ($iIndirect > 0)
+			{
+				$sRes .= ' plus (for DB integrity) '.$iIndirect;
+			}
+		}
+		$oResult->code = $iRes;
+		if ($bSimulate)
+		{
+			$oResult->message = 'SIMULATING: '.$sRes;
+		}
+		else
+		{
+			$oResult->message = $sRes;
+		}
+	}
+	
+	/**
+	 * Helper function to get the related objects up to the given depth along with the "graph" of the relation
+	 * @param DBObject $oObject Starting point of the computation
+	 * @param string $sRelation Code of the relation (i.e; 'impact', 'depends on'...)
+	 * @param integer $iMaxRecursionDepth Maximum level of recursion
+	 * @param Hash $aRelated Two dimensions hash of the already related objects: array( 'class' => array(key => ))
+	 * @param Hash	$aGraph Hash array for the topology of the relation: source => related: array('class:key' => array( DBObjects ))
+	 * @param integer $iRecursionDepth Current level of recursion
+	 */
+	protected function GetRelatedObjects(DBObject $oObject, $sRelation, $iMaxRecursionDepth, &$aRelated, &$aGraph, $iRecursionDepth = 1)
+	{
+		// Avoid loops
+		if ((array_key_exists(get_class($oObject), $aRelated)) && (array_key_exists($oObject->GetKey(), $aRelated[get_class($oObject)]))) return;
+		// Stop at maximum recursion level
+		if ($iRecursionDepth > $iMaxRecursionDepth) return;
+		
+		$sSrcKey = get_class($oObject).'::'.$oObject->GetKey();
+		$aNewRelated = array();
+		$oObject->GetRelatedObjects($sRelation, 1, $aNewRelated);
+		foreach($aNewRelated as $sClass => $aObjects)
+		{
+			if (!array_key_exists($sSrcKey, $aGraph))
+			{
+				$aGraph[$sSrcKey] = array();
+			}
+			foreach($aObjects as $oRelatedObject)
+			{
+				$aRelated[$sClass][$oRelatedObject->GetKey()] = $oRelatedObject;
+				$aGraph[$sSrcKey][] = get_class($oRelatedObject).'::'.$oRelatedObject->GetKey();
+				$this->GetRelatedObjects($oRelatedObject, $sRelation, $iMaxRecursionDepth, $aRelated, $aGraph, $iRecursionDepth+1);
+			}
+		}
+	}
+}

core/simplecrypt.class.inc.php

@@ -1,18 +1,20 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
 
 /**
  * SimpleCrypt Class - crypto helpers
@@ -34,12 +36,9 @@
  * A string encrypted with one engine can't be decrypted with
  * a different one even if the key is the same.
  *
- * @author Miguel Ros <rossoft@gmail.com>
- * @author Erwan Taloc <erwan.taloc@combodo.com>
- * @author Romain Quetiez <romain.quetiez@combodo.com>
- * @author Denis Flaven <denis.flaven@combodo.com>
- * @version 0.3
- * @license GPL
+ * @author      Miguel Ros <rossoft@gmail.com>
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 class SimpleCrypt
@@ -221,9 +220,16 @@ class SimpleCryptMcryptEngine implements CryptEngine
     {
         $iv = substr($encrypted_data, 0, mcrypt_enc_get_iv_size($this->td));
         $string = substr($encrypted_data, mcrypt_enc_get_iv_size($this->td));       
-		mcrypt_generic_init($this->td, $key, $iv);
-		$decrypted_data = rtrim(mdecrypt_generic($this->td, $string), "\0");
-		mcrypt_generic_deinit($this->td);
+		$r = mcrypt_generic_init($this->td, $key, $iv);
+		if (($r < 0) || ($r === false))
+		{
+			$decrypted_data = '** decryption error **';
+		}
+		else
+		{
+			$decrypted_data = rtrim(mdecrypt_generic($this->td, $string), "\0");
+			mcrypt_generic_deinit($this->td);
+		}
         return $decrypted_data;
     }
     

core/sqlquery.class.inc.php

@@ -1,27 +1,28 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * SQLQuery
  * build an mySQL compatible SQL query
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -41,11 +42,13 @@ class SQLQuery
 	private $m_sTable = '';
 	private $m_sTableAlias = '';
 	private $m_aFields = array();
+	private $m_aGroupBy = array();
 	private $m_oConditionExpr = null;
 	private $m_bToDelete = true; // The current table must be listed for deletion ?
 	private $m_aValues = array(); // Values to set in case of an update query
 	private $m_oSelectedIdField = null;
 	private $m_aJoinSelects = array();
+	private $m_bBeautifulQuery = false;
 
 	public function __construct($sTable, $sTableAlias, $aFields, $bToDelete = true, $aValues = array(), $oSelectedIdField = null)
 	{
@@ -62,12 +65,26 @@ class SQLQuery
 		$this->m_sTable = $sTable;
 		$this->m_sTableAlias = $sTableAlias;
 		$this->m_aFields = $aFields;
+		$this->m_aGroupBy = null;
 		$this->m_oConditionExpr = null;
 		$this->m_bToDelete = $bToDelete;
 		$this->m_aValues = $aValues;
 		$this->m_oSelectedIdField = $oSelectedIdField;
 	}
 
+	/**
+	 * Perform a deep clone (as opposed to "clone" which does copy a reference to the underlying objects
+	 **/	 	
+	public function DeepClone()
+	{
+		return unserialize(serialize($this));
+	}
+
+	public function GetTableAlias()
+	{
+		return $this->m_sTableAlias;
+	}
+
 	public function SetSourceOQL($sOQL)
 	{
 		$this->m_SourceOQL = $sOQL;
@@ -101,21 +118,31 @@ class SQLQuery
 			{
 				$sJoinType = $aJoinInfo["jointype"];
 				$oSQLQuery = $aJoinInfo["select"];
-				$sLeftField = $aJoinInfo["leftfield"];
-				$sRightField = $aJoinInfo["rightfield"];
-				$sRightTableAlias = $aJoinInfo["righttablealias"];
+				if (isset($aJoinInfo["on_expression"]))
+				{
+					$sOnCondition = $aJoinInfo["on_expression"]->Render();
 
-				echo "<li>Join '$sJoinType', $sLeftField, $sRightTableAlias.$sRightField".$oSQLQuery->DisplayHtml()."</li>\n";
+					echo "<li>Join '$sJoinType', ON ($sOnCondition)".$oSQLQuery->DisplayHtml()."</li>\n";
+				}
+				else
+				{
+					$sLeftField = $aJoinInfo["leftfield"];
+					$sRightField = $aJoinInfo["rightfield"];
+					$sRightTableAlias = $aJoinInfo["righttablealias"];
+	
+					echo "<li>Join '$sJoinType', $sLeftField, $sRightTableAlias.$sRightField".$oSQLQuery->DisplayHtml()."</li>\n";
+				}
 			}
 			echo "</ul>";
 		}
 		$aFrom = array();
 		$aFields = array();
+		$aGroupBy = array();
 		$oCondition = null;
 		$aDelTables = array();
 		$aSetValues = array();
 		$aSelectedIdFields = array();
-		$this->privRender($aFrom, $aFields, $oCondition, $aDelTables, $aSetValues, $aSelectedIdFields);
+		$this->privRender($aFrom, $aFields, $aGroupBy, $oCondition, $aDelTables, $aSetValues, $aSelectedIdFields);
 		echo "From ...<br/>\n";
 		echo "<pre style=\"font-size: smaller;\">\n";
 		print_r($aFrom);
@@ -127,6 +154,11 @@ class SQLQuery
 		$this->m_aFields = $aExpressions;
 	}
 
+	public function SetGroupBy($aExpressions)
+	{
+		$this->m_aGroupBy = $aExpressions;
+	}
+
 	public function SetCondition($oConditionExpr)
 	{
 		$this->m_oConditionExpr = $oConditionExpr;
@@ -196,6 +228,24 @@ class SQLQuery
 	{
 		return $this->AddJoin("left", $oSQLQuery, $sLeftField, $sRightField);
 	}
+
+	public function AddInnerJoinEx(SQLQuery $oSQLQuery, Expression $oOnExpression)
+	{
+		$this->m_aJoinSelects[] = array(
+			"jointype" => 'inner',
+			"select" => $oSQLQuery,
+			"on_expression" => $oOnExpression
+		);
+	}
+
+	public function AddLeftJoinEx(SQLQuery $oSQLQuery, Expression $oOnExpression)
+	{
+		$this->m_aJoinSelects[] = array(
+			"jointype" => 'left',
+			"select" => $oSQLQuery,
+			"on_expression" => $oOnExpression
+		);
+	}
 	
 	// Interface, build the SQL query
 	public function RenderDelete($aArgs = array())
@@ -203,11 +253,12 @@ class SQLQuery
 		// The goal will be to complete the list as we build the Joins
 		$aFrom = array();
 		$aFields = array();
+		$aGroupBy = array();
 		$oCondition = null;
 		$aDelTables = array();
 		$aSetValues = array();
 		$aSelectedIdFields = array();
-		$this->privRender($aFrom, $aFields, $oCondition, $aDelTables, $aSetValues, $aSelectedIdFields);
+		$this->privRender($aFrom, $aFields, $aGroupBy, $oCondition, $aDelTables, $aSetValues, $aSelectedIdFields);
 
 		// Target: DELETE myAlias1, myAlias2 FROM t1 as myAlias1, t2 as myAlias2, t3 as topreserve WHERE ...
 
@@ -238,11 +289,12 @@ class SQLQuery
 		// The goal will be to complete the list as we build the Joins
 		$aFrom = array();
 		$aFields = array();
+		$aGroupBy = array();
 		$oCondition = null;
 		$aDelTables = array();
 		$aSetValues = array();
 		$aSelectedIdFields = array();
-		$this->privRender($aFrom, $aFields, $oCondition, $aDelTables, $aSetValues, $aSelectedIdFields);
+		$this->privRender($aFrom, $aFields, $aGroupBy, $oCondition, $aDelTables, $aSetValues, $aSelectedIdFields);
 		$sFrom   = self::ClauseFrom($aFrom);
 		$sValues = self::ClauseValues($aSetValues);
 		$sWhere  = self::ClauseWhere($oCondition, $aArgs);
@@ -250,29 +302,39 @@ class SQLQuery
 	}
 
 	// Interface, build the SQL query
-	public function RenderSelect($aOrderBy = array(), $aArgs = array(), $iLimitCount = 0, $iLimitStart = 0, $bGetCount = false)
+	public function RenderSelect($aOrderBy = array(), $aArgs = array(), $iLimitCount = 0, $iLimitStart = 0, $bGetCount = false, $bBeautifulQuery = false)
 	{
+		$this->m_bBeautifulQuery = $bBeautifulQuery;
+		$sLineSep = $this->m_bBeautifulQuery ? "\n" : '';
+		$sIndent = $this->m_bBeautifulQuery ? "   " : null;
+
 		// The goal will be to complete the lists as we build the Joins
 		$aFrom = array();
 		$aFields = array();
+		$aGroupBy = array();
 		$oCondition = null;
 		$aDelTables = array();
 		$aSetValues = array();
 		$aSelectedIdFields = array();
-		$this->privRender($aFrom, $aFields, $oCondition, $aDelTables, $aSetValues, $aSelectedIdFields);
+		$this->privRender($aFrom, $aFields, $aGroupBy, $oCondition, $aDelTables, $aSetValues, $aSelectedIdFields);
 
-		$sFrom   = self::ClauseFrom($aFrom);
+		$sFrom   = self::ClauseFrom($aFrom, $sIndent);
 		$sWhere  = self::ClauseWhere($oCondition, $aArgs);
 		if ($bGetCount)
 		{
 			if (count($aSelectedIdFields) > 0)
 			{
-				$sIDFields = implode(', ', $aSelectedIdFields);
-				$sSQL = "SELECT COUNT(DISTINCT $sIDFields) AS COUNT FROM $sFrom WHERE $sWhere";
+				$aCountFields = array();
+				foreach ($aSelectedIdFields as $sFieldExpr)
+				{
+					$aCountFields[] = "COALESCE($sFieldExpr, 0)"; // Null values are excluded from the count
+				}
+				$sCountFields = implode(', ', $aCountFields);
+				$sSQL = "SELECT$sLineSep COUNT(DISTINCT $sCountFields) AS COUNT$sLineSep FROM $sFrom$sLineSep WHERE $sWhere";
 			}
 			else
 			{
-				$sSQL = "SELECT COUNT(*) AS COUNT FROM $sFrom WHERE $sWhere";
+				$sSQL = "SELECT$sLineSep COUNT(*) AS COUNT$sLineSep FROM $sFrom$sLineSep WHERE $sWhere";
 			}
 		}
 		else
@@ -291,11 +353,36 @@ class SQLQuery
 			{
 				$sLimit = '';
 			}
-			$sSQL = "SELECT DISTINCT $sSelect FROM $sFrom WHERE $sWhere $sOrderBy $sLimit";
+			$sSQL = "SELECT$sLineSep DISTINCT $sSelect$sLineSep FROM $sFrom$sLineSep WHERE $sWhere$sLineSep $sOrderBy$sLineSep $sLimit";
 		}
 		return $sSQL;
 	}
 
+	// Interface, build the SQL query
+	public function RenderGroupBy($aArgs = array(), $bBeautifulQuery = false)
+	{
+		$this->m_bBeautifulQuery = $bBeautifulQuery;
+		$sLineSep = $this->m_bBeautifulQuery ? "\n" : '';
+		$sIndent = $this->m_bBeautifulQuery ? "   " : null;
+
+		// The goal will be to complete the lists as we build the Joins
+		$aFrom = array();
+		$aFields = array();
+		$aGroupBy = array();
+		$oCondition = null;
+		$aDelTables = array();
+		$aSetValues = array();
+		$aSelectedIdFields = array();
+		$this->privRender($aFrom, $aFields, $aGroupBy, $oCondition, $aDelTables, $aSetValues, $aSelectedIdFields);
+
+		$sSelect = self::ClauseSelect($aFields);
+		$sFrom   = self::ClauseFrom($aFrom, $sIndent);
+		$sWhere  = self::ClauseWhere($oCondition, $aArgs);
+		$sGroupBy = self::ClauseGroupBy($aGroupBy);
+		$sSQL = "SELECT $sSelect,$sLineSep COUNT(*) AS _itop_count_$sLineSep FROM $sFrom$sLineSep WHERE $sWhere$sLineSep GROUP BY $sGroupBy";
+		return $sSQL;
+	}
+
 	private static function ClauseSelect($aFields)
 	{
 		$aSelect = array();
@@ -307,6 +394,12 @@ class SQLQuery
 		return $sSelect;
 	}
 
+	private static function ClauseGroupBy($aGroupBy)
+	{
+		$sRes = implode(', ', $aGroupBy);
+		return $sRes;
+	}
+
 	private static function ClauseDelete($aDelTableAliases)
 	{
 		$aDelTables = array();
@@ -318,27 +411,30 @@ class SQLQuery
 		return $sDelTables;
 	}
 
-	private static function ClauseFrom($aFrom)
+	private static function ClauseFrom($aFrom, $sIndent = null, $iIndentLevel = 0)
 	{
+		$sLineBreakLong = $sIndent ? "\n".str_repeat($sIndent, $iIndentLevel + 1) : '';
+		$sLineBreak = $sIndent ? "\n".str_repeat($sIndent, $iIndentLevel) : '';
+
 		$sFrom = "";
 		foreach ($aFrom as $sTableAlias => $aJoinInfo)
 		{
 			switch ($aJoinInfo["jointype"])
 			{
 				case "first":
-					$sFrom .= "`".$aJoinInfo["tablename"]."` AS `$sTableAlias`";
-					$sFrom .= " ".self::ClauseFrom($aJoinInfo["subfrom"]);
+					$sFrom .= $sLineBreakLong."`".$aJoinInfo["tablename"]."` AS `$sTableAlias`";
+					$sFrom .= self::ClauseFrom($aJoinInfo["subfrom"], $sIndent, $iIndentLevel + 1);
 					break;
 				case "inner":
 				case "inner_tree":
-					$sFrom .= " INNER JOIN (`".$aJoinInfo["tablename"]."` AS `$sTableAlias`";
-					$sFrom .= " ".self::ClauseFrom($aJoinInfo["subfrom"]);
-					$sFrom .= ") ON ".$aJoinInfo["joincondition"];
+					$sFrom .= $sLineBreak."INNER JOIN ($sLineBreakLong`".$aJoinInfo["tablename"]."` AS `$sTableAlias`";
+					$sFrom .= " ".self::ClauseFrom($aJoinInfo["subfrom"], $sIndent, $iIndentLevel + 1);
+					$sFrom .= $sLineBreak.") ON ".$aJoinInfo["joincondition"];
 					break;
 				case "left":
-					$sFrom .= " LEFT JOIN (`".$aJoinInfo["tablename"]."` AS `$sTableAlias`";
-					$sFrom .= " ".self::ClauseFrom($aJoinInfo["subfrom"]);
-					$sFrom .= ") ON ".$aJoinInfo["joincondition"];
+					$sFrom .= $sLineBreak."LEFT JOIN ($sLineBreakLong`".$aJoinInfo["tablename"]."` AS `$sTableAlias`";
+					$sFrom .= " ".self::ClauseFrom($aJoinInfo["subfrom"], $sIndent, $iIndentLevel + 1);
+					$sFrom .= $sLineBreak.") ON ".$aJoinInfo["joincondition"];
 					break;
 				default:
 					throw new CoreException("Unknown jointype: '".$aJoinInfo["jointype"]."'");
@@ -375,24 +471,23 @@ class SQLQuery
 		$aOrderBySpec = array();
 		foreach($aOrderBy as $sFieldAlias => $bAscending)
 		{
-			$aOrderBySpec[] = '`'.$sFieldAlias.'`'.($bAscending ? " ASC" : " DESC");
+			// Note: sFieldAlias must have backticks around column aliases
+			$aOrderBySpec[] = $sFieldAlias.($bAscending ? " ASC" : " DESC");
 		}
 		$sOrderBy = implode(", ", $aOrderBySpec);
 		return $sOrderBy;
 	}
 
 	// Purpose: prepare the query data, once for all
-	private function privRender(&$aFrom, &$aFields, &$oCondition, &$aDelTables, &$aSetValues, &$aSelectedIdFields)
+	private function privRender(&$aFrom, &$aFields, &$aGroupBy, &$oCondition, &$aDelTables, &$aSetValues, &$aSelectedIdFields)
 	{
-		$sTableAlias = $this->privRenderSingleTable($aFrom, $aFields, $aDelTables, $aSetValues, $aSelectedIdFields, '', array('jointype' => 'first'));
+		$sTableAlias = $this->privRenderSingleTable($aFrom, $aFields, $aGroupBy, $aDelTables, $aSetValues, $aSelectedIdFields, '', array('jointype' => 'first'));
 		$oCondition = $this->m_oConditionExpr;
 		return $sTableAlias; 
 	}
 
-	private function privRenderSingleTable(&$aFrom, &$aFields, &$aDelTables, &$aSetValues, &$aSelectedIdFields, $sCallerAlias = '', $aJoinData)
+	private function privRenderSingleTable(&$aFrom, &$aFields, &$aGroupBy, &$aDelTables, &$aSetValues, &$aSelectedIdFields, $sCallerAlias = '', $aJoinData)
 	{
-		$aActualTableFields = CMDBSource::GetTableFieldsList($this->m_sTable);
-
 		$aTranslationTable[$this->m_sTable]['*'] = $this->m_sTableAlias;
 
 		// Handle the various kinds of join (or first table in the list)
@@ -412,8 +507,14 @@ class SQLQuery
 				break;
 			case "inner":
 			case "left":
-			// table or tablealias ???
-				$sJoinCond = "`$sCallerAlias`.`{$aJoinData['leftfield']}` = `$sRightTableAlias`.`{$aJoinData['rightfield']}`";
+				if (isset($aJoinData["on_expression"]))
+				{
+					$sJoinCond = $aJoinData["on_expression"]->Render();
+				}
+				else
+				{
+					$sJoinCond = "`$sCallerAlias`.`{$aJoinData['leftfield']}` = `$sRightTableAlias`.`{$aJoinData['rightfield']}`";
+				}
 				$aFrom[$this->m_sTableAlias] = array("jointype"=>$aJoinData['jointype'], "tablename"=>$this->m_sTable, "joincondition"=>"$sJoinCond");
 				break;
 			case "inner_tree":
@@ -467,11 +568,17 @@ class SQLQuery
 		{
 			$aFields["`$sAlias`"] = $oExpression->Render();
 		}
+		if ($this->m_aGroupBy)
+		{
+			foreach($this->m_aGroupBy as $sAlias => $oExpression)
+			{
+				$aGroupBy["`$sAlias`"] = $oExpression->Render();
+			}
+		}
 		if ($this->m_bToDelete)
 		{
 			$aDelTables[] = "`{$this->m_sTableAlias}`";
 		}
-//echo "<p>in privRenderSingleTable this->m_aValues<pre>".print_r($this->m_aValues, true)."</pre></p>\n";	
 		foreach($this->m_aValues as $sFieldName=>$value)
 		{
 			$aSetValues["`{$this->m_sTableAlias}`.`$sFieldName`"] = $value; // quoted further!
@@ -488,18 +595,106 @@ class SQLQuery
 		foreach ($this->m_aJoinSelects as $aJoinData)
 		{
 			$oRightSelect = $aJoinData["select"];
-//			$sJoinType = $aJoinData["jointype"];
-//			$sLeftField = $aJoinData["leftfield"];
-//			$sRightField = $aJoinData["rightfield"];
-//			$sRightTableAlias = $aJoinData["righttablealias"];
 
-			$sJoinTableAlias = $oRightSelect->privRenderSingleTable($aTempFrom, $aFields, $aDelTables, $aSetValues, $aSelectedIdFields, $this->m_sTableAlias, $aJoinData);
+			$sJoinTableAlias = $oRightSelect->privRenderSingleTable($aTempFrom, $aFields, $aGroupBy, $aDelTables, $aSetValues, $aSelectedIdFields, $this->m_sTableAlias, $aJoinData);
 		}
 		$aFrom[$this->m_sTableAlias]['subfrom'] = $aTempFrom;
 
 		return $this->m_sTableAlias;
 	}
 
-}
+	public function OptimizeJoins($aUsedTables, $bTopCall = true)
+	{
+		if ($bTopCall)
+		{
+			// Top call: complete the list of tables absolutely required to perform the right query
+			$this->CollectUsedTables($aUsedTables);
+		}
 
-?>
+		$aToDiscard = array();
+		foreach ($this->m_aJoinSelects as $i => $aJoinInfo)
+		{
+			$oSQLQuery = $aJoinInfo["select"];
+			$sTableAlias = $oSQLQuery->GetTableAlias();
+			if ($oSQLQuery->OptimizeJoins($aUsedTables, false) && !array_key_exists($sTableAlias, $aUsedTables))
+			{
+				$aToDiscard[] = $i;
+			}
+		}
+		foreach ($aToDiscard as $i)
+		{
+			unset($this->m_aJoinSelects[$i]);
+		}
+
+		return (count($this->m_aJoinSelects) == 0);
+	}
+
+	protected function CollectUsedTables(&$aTables)
+	{
+		$this->m_oConditionExpr->CollectUsedParents($aTables);
+		foreach($this->m_aFields as $sFieldAlias => $oField)
+		{
+			$oField->CollectUsedParents($aTables);
+		}
+		if ($this->m_aGroupBy)
+		{
+			foreach($this->m_aGroupBy as $sAlias => $oExpression)
+			{
+				$oExpression->CollectUsedParents($aTables);
+			}
+		}
+  		if (!is_null($this->m_oSelectedIdField))
+  		{
+  			$this->m_oSelectedIdField->CollectUsedParents($aTables);
+		}
+
+		foreach ($this->m_aJoinSelects as $i => $aJoinInfo)
+		{
+			$oSQLQuery = $aJoinInfo["select"];
+			if ($oSQLQuery->HasRequiredTables($aTables))
+			{
+				// There is something required in the branch, then this node is a MUST
+				if (isset($aJoinInfo['righttablealias']))
+				{
+					$aTables[$aJoinInfo['righttablealias']] = true;
+				}
+				if (isset($aJoinInfo["on_expression"]))
+				{
+					$sJoinCond = $aJoinInfo["on_expression"]->CollectUsedParents($aTables);
+				}
+			}
+		}
+
+		return $aTables;
+	}
+
+	// Is required in the JOIN, and therefore we must ensure that the join expression will be valid
+	protected function HasRequiredTables(&$aTables)
+	{
+		$bResult = false;
+		if (array_key_exists($this->m_sTableAlias, $aTables))
+		{
+			$bResult = true;
+		}
+		foreach ($this->m_aJoinSelects as $i => $aJoinInfo)
+		{
+			$oSQLQuery = $aJoinInfo["select"];
+			if ($oSQLQuery->HasRequiredTables($aTables))
+			{
+				// There is something required in the branch, then this node is a MUST
+				if (isset($aJoinInfo['righttablealias']))
+				{
+					$aTables[$aJoinInfo['righttablealias']] = true;
+				}
+				if (isset($aJoinInfo["on_expression"]))
+				{
+					$sJoinCond = $aJoinInfo["on_expression"]->CollectUsedParents($aTables);
+				}
+				$bResult = true;
+			}
+		}
+		// None of the tables is in the list of required tables
+		return $bResult;
+	}
+}
+?>

core/stimulus.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2012 Combodo SARL
 //
-//   This program is free software; you can redistribute it and/or modify
-//   it under the terms of the GNU General Public License as published by
-//   the Free Software Foundation; version 3 of the License.
+//   This file is part of iTop.
 //
-//   This program is distributed in the hope that it will be useful,
+//   iTop is free software; you can redistribute it and/or modify	
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop is distributed in the hope that it will be useful,
 //   but WITHOUT ANY WARRANTY; without even the implied warranty of
 //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-//   GNU General Public License for more details.
+//   GNU Affero General Public License for more details.
 //
-//   You should have received a copy of the GNU General Public License
-//   along with this program; if not, write to the Free Software
-//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+
 
 /**
  * Object lifecycle management: stimulus
  *
- * @author      Erwan Taloc <erwan.taloc@combodo.com>
- * @author      Romain Quetiez <romain.quetiez@combodo.com>
- * @author      Denis Flaven <denis.flaven@combodo.com>
- * @license     http://www.opensource.org/licenses/gpl-3.0.html LGPL
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */