Creating SVN tag for iTop 2.4.1

SVN:2.4.1[5355]

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
  */
 
 

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

addons/userrights/userrightsprofile.class.inc.php

@@ -1,27 +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/>
 
 /**
  * UserRightsProfile
  * User management Module, basing the right on profiles and a matrix (similar to UserRightsMatrix, but profiles and other decorations have been added) 
  *
- * @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_NAME', 'Administrator');
@@ -47,28 +47,6 @@ class UserRightsBaseClassGUI extends cmdbAbstractObject
 	}
 }
 
-class UserRightsBaseClass extends DBObject
-{
-	// Whenever something changes, reload the privileges
-	
-	protected function AfterInsert()
-	{
-		UserRights::FlushPrivileges();
-	}
-
-	protected function AfterUpdate()
-	{
-		UserRights::FlushPrivileges();
-	}
-
-	protected function AfterDelete()
-	{
-		UserRights::FlushPrivileges();
-	}
-}
-
-
-
 
 class URP_Profiles extends UserRightsBaseClassGUI
 {
@@ -101,27 +79,9 @@ class URP_Profiles extends UserRightsBaseClassGUI
 		MetaModel::Init_SetZListItems('advanced_search', array('name')); // Criteria of the advanced search form
 	}
 
-	protected $m_bCheckReservedNames = true;
-	protected function DisableCheckOnReservedNames()
-	{
-		$this->m_bCheckReservedNames = false;
-	}
-
-	
-	protected static $m_aActions = array(
-		UR_ACTION_READ => 'Read',
-		UR_ACTION_MODIFY => 'Modify',
-		UR_ACTION_DELETE => 'Delete',
-		UR_ACTION_BULK_READ => 'Bulk Read',
-		UR_ACTION_BULK_MODIFY => 'Bulk Modify',
-		UR_ACTION_BULK_DELETE => 'Bulk Delete',
-	);
-
-	protected static $m_aCacheActionGrants = null;
-	protected static $m_aCacheStimulusGrants = null;
 	protected static $m_aCacheProfiles = null;
 	
-	public static function DoCreateProfile($sName, $sDescription, $bReservedName = false)
+	public static function DoCreateProfile($sName, $sDescription)
 	{
 		if (is_null(self::$m_aCacheProfiles))
 		{
@@ -142,118 +102,19 @@ class URP_Profiles extends UserRightsBaseClassGUI
 		$oNewObj = MetaModel::NewObject("URP_Profiles");
 		$oNewObj->Set('name', $sName);
 		$oNewObj->Set('description', $sDescription);
-		if ($bReservedName)
-		{
-			$oNewObj->DisableCheckOnReservedNames();			
-		}
 		$iId = $oNewObj->DBInsertNoReload();
 		self::$m_aCacheProfiles[$sCacheKey] = $iId;	
 		return $iId;
 	}
 	
-	public static function DoCreateActionGrant($iProfile, $iAction, $sClass, $bPermission = true)
-	{
-		$sAction = self::$m_aActions[$iAction];
-	
-		if (is_null(self::$m_aCacheActionGrants))
-		{
-			self::$m_aCacheActionGrants = array();
-			$oFilterAll = new DBObjectSearch('URP_ActionGrant');
-			$oSet = new DBObjectSet($oFilterAll);
-			while ($oGrant = $oSet->Fetch())
-			{
-				self::$m_aCacheActionGrants[$oGrant->Get('profileid').'-'.$oGrant->Get('action').'-'.$oGrant->Get('class')] = $oGrant->GetKey();
-			}
-		}	
-
-		$sCacheKey = "$iProfile-$sAction-$sClass";
-		if (isset(self::$m_aCacheActionGrants[$sCacheKey]))
-		{
-			return self::$m_aCacheActionGrants[$sCacheKey];
-		}
-
-		$oNewObj = MetaModel::NewObject("URP_ActionGrant");
-		$oNewObj->Set('profileid', $iProfile);
-		$oNewObj->Set('permission', $bPermission ? 'yes' : 'no');
-		$oNewObj->Set('class', $sClass);
-		$oNewObj->Set('action', $sAction);
-		$iId = $oNewObj->DBInsertNoReload();
-		self::$m_aCacheActionGrants[$sCacheKey] = $iId;	
-		return $iId;
-	}
-	
-	public static function DoCreateStimulusGrant($iProfile, $sStimulusCode, $sClass)
-	{
-		if (is_null(self::$m_aCacheStimulusGrants))
-		{
-			self::$m_aCacheStimulusGrants = array();
-			$oFilterAll = new DBObjectSearch('URP_StimulusGrant');
-			$oSet = new DBObjectSet($oFilterAll);
-			while ($oGrant = $oSet->Fetch())
-			{
-				self::$m_aCacheStimulusGrants[$oGrant->Get('profileid').'-'.$oGrant->Get('stimulus').'-'.$oGrant->Get('class')] = $oGrant->GetKey();
-			}
-		}	
-
-		$sCacheKey = "$iProfile-$sStimulusCode-$sClass";
-		if (isset(self::$m_aCacheStimulusGrants[$sCacheKey]))
-		{
-			return self::$m_aCacheStimulusGrants[$sCacheKey];
-		}
-		$oNewObj = MetaModel::NewObject("URP_StimulusGrant");
-		$oNewObj->Set('profileid', $iProfile);
-		$oNewObj->Set('permission', 'yes');
-		$oNewObj->Set('class', $sClass);
-		$oNewObj->Set('stimulus', $sStimulusCode);
-		$iId = $oNewObj->DBInsertNoReload();
-		self::$m_aCacheStimulusGrants[$sCacheKey] = $iId;	
-		return $iId;
-	}
-	
-	/*
-	* Create the built-in Administrator profile with its reserved name
-	*/	
-	public static function DoCreateAdminProfile()
-	{
-		self::DoCreateProfile(ADMIN_PROFILE_NAME, 'Has the rights on everything (bypassing any control)', true /* reserved name */);
-	}
-
-	/*
-	* Overload the standard behavior to preserve reserved names
-	*/	
-	public function DoCheckToWrite()
-	{
-		parent::DoCheckToWrite();
-
-		if ($this->m_bCheckReservedNames)
-		{
-			$aChanges = $this->ListChanges();
-			if (array_key_exists('name', $aChanges))
-			{
-				if ($this->GetOriginal('name') == ADMIN_PROFILE_NAME)
-				{
-					$this->m_aCheckIssues[] = "The name of the Administrator profile must not be changed";
-				}
-				elseif ($this->Get('name') == ADMIN_PROFILE_NAME)
-				{
-					$this->m_aCheckIssues[] = ADMIN_PROFILE_NAME." is a reserved to the built-in Administrator profile";
-				}
-				elseif ($this->GetOriginal('name') == PORTAL_PROFILE_NAME)
-				{
-					$this->m_aCheckIssues[] = "The name of the User Portal profile must not be changed";
-				}
-				elseif ($this->Get('name') == PORTAL_PROFILE_NAME)
-				{
-					$this->m_aCheckIssues[] = PORTAL_PROFILE_NAME." is a reserved to the built-in User Portal profile";
-				}
-			}
-		}
-	}
-
 	function GetGrantAsHtml($oUserRights, $sClass, $sAction)
 	{
-		$iGrant = $oUserRights->GetProfileActionGrant($this->GetKey(), $sClass, $sAction);
-		if (!is_null($iGrant))
+		$bGrant = $oUserRights->GetProfileActionGrant($this->GetKey(), $sClass, $sAction);
+		if (is_null($bGrant))
+		{
+			return '<span style="background-color: #ffdddd;">'.Dict::S('UI:UserManagement:ActionAllowed:No').'</span>';
+		}
+		elseif ($bGrant)
 		{
 			return '<span style="background-color: #ddffdd;">'.Dict::S('UI:UserManagement:ActionAllowed:Yes').'</span>';
 		}
@@ -284,8 +145,8 @@ class URP_Profiles extends UserRightsBaseClassGUI
 			$aStimuli = array();
 			foreach (MetaModel::EnumStimuli($sClass) as $sStimulusCode => $oStimulus)
 			{
-				$oGrant = $oUserRights->GetClassStimulusGrant($this->GetKey(), $sClass, $sStimulusCode);
-				if (is_object($oGrant) && ($oGrant->Get('permission') == 'yes'))
+				$bGrant = $oUserRights->GetClassStimulusGrant($this->GetKey(), $sClass, $sStimulusCode);
+				if ($bGrant === true)
 				{ 
 					$aStimuli[] = '<span title="'.$sStimulusCode.': '.htmlentities($oStimulus->GetDescription(), ENT_QUOTES, 'UTF-8').'">'.htmlentities($oStimulus->GetLabel(), ENT_QUOTES, 'UTF-8').'</span>';
 				}
@@ -294,12 +155,12 @@ class URP_Profiles extends UserRightsBaseClassGUI
 			
 			$aDisplayData[] = array(
 				'class' => MetaModel::GetName($sClass),
-				'read' => $this->GetGrantAsHtml($oUserRights, $sClass, 'Read'),
-				'bulkread' => $this->GetGrantAsHtml($oUserRights, $sClass, 'Bulk Read'),
-				'write' => $this->GetGrantAsHtml($oUserRights, $sClass, 'Modify'),
-				'bulkwrite' => $this->GetGrantAsHtml($oUserRights, $sClass, 'Bulk Modify'),
-				'delete' => $this->GetGrantAsHtml($oUserRights, $sClass, 'Delete'),
-				'bulkdelete' => $this->GetGrantAsHtml($oUserRights, $sClass, 'Bulk Delete'),
+				'read' => $this->GetGrantAsHtml($oUserRights, $sClass, 'r'),
+				'bulkread' => $this->GetGrantAsHtml($oUserRights, $sClass, 'br'),
+				'write' => $this->GetGrantAsHtml($oUserRights, $sClass, 'w'),
+				'bulkwrite' => $this->GetGrantAsHtml($oUserRights, $sClass, 'bw'),
+				'delete' => $this->GetGrantAsHtml($oUserRights, $sClass, 'd'),
+				'bulkdelete' => $this->GetGrantAsHtml($oUserRights, $sClass, 'bd'),
 				'stimuli' => $sStimuli,
 			);
 		}
@@ -325,6 +186,49 @@ class URP_Profiles extends UserRightsBaseClassGUI
 			$this->DoShowGrantSumary($oPage);		
 		}
 	}
+
+	public static function GetReadOnlyAttributes()
+	{
+		return array('name', 'description');
+	}
+
+
+	// returns an array of id => array of column => php value(so-called "real value")
+	public static function GetPredefinedObjects()
+	{
+		return ProfilesConfig::GetProfilesValues();
+	}
+
+	// Before deleting a profile,
+	// preserve DB integrity by deleting links to users
+	protected function OnDelete()
+	{
+		// Note: this may break the rule that says: "a user must have at least ONE profile" !
+		$oLnkSet = $this->Get('user_list');
+		while($oLnk = $oLnkSet->Fetch())
+		{
+			$oLnk->DBDelete();
+		}
+	}
+
+	/**
+	 * Returns the set of flags (OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY...)
+	 * for the given attribute in the current state of the object
+	 * @param $sAttCode string $sAttCode The code of the attribute
+	 * @param $aReasons array To store the reasons why the attribute is read-only (info about the synchro replicas)
+	 * @param $sTargetState string The target state in which to evalutate the flags, if empty the current state will be used
+	 * @return integer Flags: the binary combination of the flags applicable to this attribute
+	 */	 	  	 	
+	public function GetAttributeFlags($sAttCode, &$aReasons = array(), $sTargetState = '')
+	{
+		$iFlags = parent::GetAttributeFlags($sAttCode, $aReasons, $sTargetState);
+		if (MetaModel::GetConfig()->Get('demo_mode'))
+		{
+			$aReasons[] = 'Sorry, profiles are read-only in the demonstration mode!';
+			$iFlags |= OPT_ATT_READONLY;
+		}
+		return $iFlags;
+	}
 }
 
 
@@ -367,6 +271,19 @@ class URP_UserProfile extends UserRightsBaseClassGUI
 	{
 		return Dict::Format('UI:UserManagement:LinkBetween_User_And_Profile', $this->Get('userlogin'), $this->Get('profile'));
 	}
+
+	public function CheckToDelete(&$oDeletionPlan)
+	{
+		if (MetaModel::GetConfig()->Get('demo_mode'))
+		{
+			// Users deletion is NOT allowed in demo mode
+			$oDeletionPlan->AddToDelete($this, null);
+			$oDeletionPlan->SetDeletionIssues($this, array('deletion not allowed in demo mode.'), true);
+			$oDeletionPlan->ComputeResults();
+			return false;
+		}
+		return parent::CheckToDelete($oDeletionPlan);
+	}
 }
 
 class URP_UserOrg extends UserRightsBaseClassGUI
@@ -410,133 +327,25 @@ class URP_UserOrg extends UserRightsBaseClassGUI
 }
 
 
-class URP_ActionGrant extends UserRightsBaseClass
-{
-	public static function Init()
-	{
-		$aParams = array
-		(
-			"category" => "addon/userrights",
-			"key_type" => "autoincrement",
-			"name_attcode" => "profileid",
-			"state_attcode" => "",
-			"reconc_keys" => array(),
-			"db_table" => "priv_urp_grant_actions",
-			"db_key_field" => "id",
-			"db_finalclass_field" => "",
-			"display_template" => "",
-		);
-		MetaModel::Init_Params($aParams);
-		//MetaModel::Init_InheritAttributes();
-
-		// Common to all grant classes (could be factorized by class inheritence, but this has to be benchmarked)
-		MetaModel::Init_AddAttribute(new AttributeExternalKey("profileid", array("targetclass"=>"URP_Profiles", "jointype"=> "", "allowed_values"=>null, "sql"=>"profileid", "is_null_allowed"=>false, "on_target_delete"=>DEL_MANUAL, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeExternalField("profile", array("allowed_values"=>null, "extkey_attcode"=> 'profileid', "target_attcode"=>"name")));
-		MetaModel::Init_AddAttribute(new AttributeClass("class", array("class_category"=>"", "more_values"=>"", "sql"=>"class", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeEnum("permission", array("allowed_values"=>new ValueSetEnum('yes,no'), "sql"=>"permission", "default_value"=>"yes", "is_null_allowed"=>false, "depends_on"=>array())));
-
-		MetaModel::Init_AddAttribute(new AttributeString("action", array("allowed_values"=>null, "sql"=>"action", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
-
-		// Display lists
-		MetaModel::Init_SetZListItems('details', array('profileid', 'class', 'permission', 'action')); // Attributes to be displayed for the complete details
-		MetaModel::Init_SetZListItems('list', array('class', 'permission', 'action')); // Attributes to be displayed for a list
-		// Search criteria
-		MetaModel::Init_SetZListItems('standard_search', array('profileid', 'class', 'permission', 'action')); // Criteria of the std search form
-		MetaModel::Init_SetZListItems('advanced_search', array('profileid', 'class', 'permission', 'action')); // Criteria of the advanced search form
-	}
-}
-
-
-class URP_StimulusGrant extends UserRightsBaseClass
-{
-	public static function Init()
-	{
-		$aParams = array
-		(
-			"category" => "addon/userrights",
-			"key_type" => "autoincrement",
-			"name_attcode" => "profileid",
-			"state_attcode" => "",
-			"reconc_keys" => array(),
-			"db_table" => "priv_urp_grant_stimulus",
-			"db_key_field" => "id",
-			"db_finalclass_field" => "",
-			"display_template" => "",
-		);
-		MetaModel::Init_Params($aParams);
-		//MetaModel::Init_InheritAttributes();
-
-		// Common to all grant classes (could be factorized by class inheritence, but this has to be benchmarked)
-		MetaModel::Init_AddAttribute(new AttributeExternalKey("profileid", array("targetclass"=>"URP_Profiles", "jointype"=> "", "allowed_values"=>null, "sql"=>"profileid", "is_null_allowed"=>false, "on_target_delete"=>DEL_MANUAL, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeExternalField("profile", array("allowed_values"=>null, "extkey_attcode"=> 'profileid', "target_attcode"=>"name")));
-		MetaModel::Init_AddAttribute(new AttributeClass("class", array("class_category"=>"", "more_values"=>"", "sql"=>"class", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeEnum("permission", array("allowed_values"=>new ValueSetEnum('yes,no'), "sql"=>"permission", "default_value"=>"yes", "is_null_allowed"=>false, "depends_on"=>array())));
-
-		MetaModel::Init_AddAttribute(new AttributeString("stimulus", array("allowed_values"=>null, "sql"=>"action", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
-
-		// Display lists
-		MetaModel::Init_SetZListItems('details', array('profileid', 'class', 'permission', 'stimulus')); // Attributes to be displayed for the complete details
-		MetaModel::Init_SetZListItems('list', array('class', 'permission', 'stimulus')); // Attributes to be displayed for a list
-		// Search criteria
-		MetaModel::Init_SetZListItems('standard_search', array('profileid', 'class', 'permission', 'stimulus')); // Criteria of the std search form
-		MetaModel::Init_SetZListItems('advanced_search', array('profileid', 'class', 'permission', 'stimulus')); // Criteria of the advanced search form
-	}
-}
-
-
-class URP_AttributeGrant extends UserRightsBaseClass
-{
-	public static function Init()
-	{
-		$aParams = array
-		(
-			"category" => "addon/userrights",
-			"key_type" => "autoincrement",
-			"name_attcode" => "actiongrantid",
-			"state_attcode" => "",
-			"reconc_keys" => array(),
-			"db_table" => "priv_urp_grant_attributes",
-			"db_key_field" => "id",
-			"db_finalclass_field" => "",
-			"display_template" => "",
-		);
-		MetaModel::Init_Params($aParams);
-		//MetaModel::Init_InheritAttributes();
-
-		MetaModel::Init_AddAttribute(new AttributeExternalKey("actiongrantid", array("targetclass"=>"URP_ActionGrant", "jointype"=> "", "allowed_values"=>null, "sql"=>"actiongrantid", "is_null_allowed"=>false, "on_target_delete"=>DEL_MANUAL, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeString("attcode", array("allowed_values"=>null, "sql"=>"attcode", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
-
-		// Display lists
-		MetaModel::Init_SetZListItems('details', array('actiongrantid', 'attcode')); // Attributes to be displayed for the complete details
-		MetaModel::Init_SetZListItems('list', array('attcode')); // Attributes to be displayed for a list
-		// Search criteria
-		MetaModel::Init_SetZListItems('standard_search', array('actiongrantid', 'attcode')); // Criteria of the std search form
-		MetaModel::Init_SetZListItems('advanced_search', array('actiongrantid', 'attcode')); // Criteria of the advanced search form
-	}
-}
-
-
 
 
 class UserRightsProfile extends UserRightsAddOnAPI
 {
 	static public $m_aActionCodes = array(
-		UR_ACTION_READ => 'read',
-		UR_ACTION_MODIFY => 'modify',
-		UR_ACTION_DELETE => 'delete',
-		UR_ACTION_BULK_READ => 'bulk read',
-		UR_ACTION_BULK_MODIFY => 'bulk modify',
-		UR_ACTION_BULK_DELETE => 'bulk delete',
+		UR_ACTION_READ => 'r',
+		UR_ACTION_MODIFY => 'w',
+		UR_ACTION_DELETE => 'd',
+		UR_ACTION_BULK_READ => 'br',
+		UR_ACTION_BULK_MODIFY => 'bw',
+		UR_ACTION_BULK_DELETE => 'bd',
 	);
 
 	// Installation: create the very first user
 	public function CreateAdministrator($sAdminUser, $sAdminPwd, $sLanguage = 'EN US')
 	{
-		// Create a change to record the history of the User object
-		$oChange = MetaModel::NewObject("CMDBChange");
-		$oChange->Set("date", time());
-		$oChange->Set("userinfo", "Initialization");
-		$iChangeId = $oChange->DBInsert();
+		CMDBObject::SetTrackInfo('Initialization');
+
+		$oChange = CMDBObject::GetCurrentChange();
 
 		$iContactId = 0;
 		// Support drastic data model changes: no organization class (or not writable)!
@@ -596,18 +405,8 @@ class UserRightsProfile extends UserRightsAddOnAPI
 	{
 	}
 
-
-	protected $m_aAdmins = array(); // id -> bool, true if the user has the well-known admin profile
-	protected $m_aPortalUsers = array(); // id -> bool, true if the user has the well-known portal user profile
-
-	protected $m_aProfiles; // id -> object
-	protected $m_aUserProfiles = array(); // userid,profileid -> object
 	protected $m_aUserOrgs = array(); // userid -> array of orgid
 
-	// Those arrays could be completed on demand (inheriting parent permissions)
-	protected $m_aClassActionGrants = null; // profile, class, action -> actiongrantid (or false if NO, or null/missing if undefined)
-	protected $m_aClassStimulusGrants = array(); // profile, class, stimulus -> permission
-
 	// Built on demand, could be optimized if necessary (doing a query for each attribute that needs to be read)
 	protected $m_aObjectActionGrants = array();
 
@@ -653,146 +452,65 @@ class UserRightsProfile extends UserRightsAddOnAPI
 		return $this->m_aUserOrgs[$iUser];
 	}
 
-	/**
-	 * Read and cache profiles of the given user
-	 */
-	protected function GetUserProfiles($iUser)
-	{
-		if (!array_key_exists($iUser, $this->m_aUserProfiles))
-		{
-			$oSearch = new DBObjectSearch('URP_UserProfile');
-			$oSearch->AllowAllData();
-			$oCondition = new BinaryExpression(new FieldExpression('userid'), '=', new VariableExpression('userid'));
-			$oSearch->AddConditionExpression($oCondition);
-			
-			$this->m_aUserProfiles[$iUser] = array();
-			$oUserProfileSet = new DBObjectSet($oSearch, array(), array('userid' => $iUser));
-			while ($oUserProfile = $oUserProfileSet->Fetch())
-			{
-				$this->m_aUserProfiles[$iUser][$oUserProfile->Get('profileid')] = $oUserProfile;
-			}
-		}
-		return $this->m_aUserProfiles[$iUser];
-
-	}
-
 	public function ResetCache()
 	{
 		// Loaded by Load cache
-		$this->m_aProfiles = null; 
-		$this->m_aUserProfiles = array();
 		$this->m_aUserOrgs = array();
 
-		$this->m_aAdmins = array();
-		$this->m_aPortalUsers = array();
-
-		// Loaded on demand (time consuming as compared to the others)
-		$this->m_aClassActionGrants = null;
-		$this->m_aClassStimulusGrants = null;
-		
+		// Cache
 		$this->m_aObjectActionGrants = array();
 	}
 
-	// Separate load: this cache is much more time consuming while loading
-	// Thus it is loaded iif required
-	// Could be improved by specifying the profile id
-	public function LoadActionGrantCache()
-	{
-		if (!is_null($this->m_aClassActionGrants)) return;
-
-		$oKPI = new ExecutionKPI();
-
-		$oFilter = DBObjectSearch::FromOQL_AllData("SELECT URP_ActionGrant AS p WHERE p.permission = 'yes'");
-		$aGrants = $oFilter->ToDataArray();
-		foreach($aGrants as $aGrant)
-		{
-			$this->m_aClassActionGrants[$aGrant['profileid']][$aGrant['class']][strtolower($aGrant['action'])] = $aGrant['id'];
-		}
-
-		$oKPI->ComputeAndReport('Load of action grants');
-	}
-
 	public function LoadCache()
 	{
-		if (!is_null($this->m_aProfiles)) return;
-		// Could be loaded in a shared memory (?)
-
-		$oKPI = new ExecutionKPI();
-
-		if (self::HasSharing())
+		static $bSharedObjectInitialized = false;
+		if (!$bSharedObjectInitialized)
 		{
-			SharedObject::InitSharedClassProperties();
+			$bSharedObjectInitialized = true;
+			if (self::HasSharing())
+			{
+				SharedObject::InitSharedClassProperties();
+			}
 		}
-
-		$oProfileSet = new DBObjectSet(DBObjectSearch::FromOQL_AllData("SELECT URP_Profiles"));
-		$this->m_aProfiles = array(); 
-		while ($oProfile = $oProfileSet->Fetch())
-		{
-			$this->m_aProfiles[$oProfile->GetKey()] = $oProfile; 
-		}
-
-		$this->m_aClassStimulusGrants = array();
-		$oStimGrantSet = new DBObjectSet(DBObjectSearch::FromOQL_AllData("SELECT URP_StimulusGrant"));
-		$this->m_aStimGrants = array();
-		while ($oStimGrant = $oStimGrantSet->Fetch())
-		{
-			$this->m_aClassStimulusGrants[$oStimGrant->Get('profileid')][$oStimGrant->Get('class')][$oStimGrant->Get('stimulus')] = $oStimGrant;
-		}
-
-		$oKPI->ComputeAndReport('Load of user management cache (excepted Action Grants)');
-
-/*
-		echo "<pre>\n";
-		print_r($this->m_aProfiles);
-		print_r($this->m_aUserProfiles);
-		print_r($this->m_aUserOrgs);
-		print_r($this->m_aClassActionGrants);
-		print_r($this->m_aClassStimulusGrants);
-		echo "</pre>\n";
-exit;
-*/
-
 		return true;
 	}
 
+	/**
+	 * @param $oUser User
+	 * @return array
+	 */
 	public function IsAdministrator($oUser)
 	{
-		//$this->LoadCache();
-		$iUser = $oUser->GetKey();
-		if (!array_key_exists($iUser, $this->m_aAdmins))
-		{
-			$bIsAdmin = false;
-			foreach($this->GetUserProfiles($iUser) as $oUserProfile)
-		{
-				if ($oUserProfile->Get('profile') == ADMIN_PROFILE_NAME)
-				{
-					$bIsAdmin = true;
-					break;
-		}
-	}
-			$this->m_aAdmins[$iUser] = $bIsAdmin;
-		}
-		return $this->m_aAdmins[$iUser];
+		// UserRights caches the list for us
+		return UserRights::HasProfile(ADMIN_PROFILE_NAME, $oUser);
 	}
 
+	/**
+	 * @param $oUser User
+	 * @return array
+	 */
 	public function IsPortalUser($oUser)
 	{
-		//$this->LoadCache();
-		$iUser = $oUser->GetKey();
-		if (!array_key_exists($iUser, $this->m_aPortalUsers))
-		{
-			$bIsPortalUser = false;
-			foreach($this->GetUserProfiles($iUser) as $oUserProfile)
-		{
-				if ($oUserProfile->Get('profile') == PORTAL_PROFILE_NAME)
-				{
-					$bIsPortalUser = true;
-					break;
-		}
+		// UserRights caches the list for us
+		return UserRights::HasProfile(PORTAL_PROFILE_NAME, $oUser);
 	}
-			$this->m_aPortalUsers[$iUser] = $bIsPortalUser;
+	/**
+	 * @param $oUser User
+	 * @return bool
+	 */
+	public function ListProfiles($oUser)
+	{
+		$aRet = array();
+		$oSearch = new DBObjectSearch('URP_UserProfile');
+		$oSearch->AllowAllData();
+		$oSearch->NoContextParameters();
+		$oSearch->Addcondition('userid', $oUser->GetKey(), '=');
+		$oProfiles = new DBObjectSet($oSearch);
+		while ($oUserProfile = $oProfiles->Fetch())
+		{
+			$aRet[$oUserProfile->Get('profileid')] = $oUserProfile->Get('profileid_friendlyname');
 		}
-		return $this->m_aPortalUsers[$iUser];
+		return $aRet;
 	}
 
 	public function GetSelectFilter($oUser, $sClass, $aSettings = array())
@@ -822,98 +540,17 @@ exit;
 			return true;
 		}
 
-		$oExpression = new FieldExpression($sAttCode, $sClass);
-		$oFilter  = new DBObjectSearch($sClass);
-		$oListExpr = ListExpression::FromScalars($aUserOrgs);
-		
-		$oCondition = new BinaryExpression($oExpression, 'IN', $oListExpr);
-		$oFilter->AddConditionExpression($oCondition);
-
-		if (self::HasSharing())
-		{
-			if (($sAttCode == 'id') && isset($aSettings['bSearchMode']) && $aSettings['bSearchMode'])
-			{
-				// Querying organizations (or derived)
-				// and the expected list of organizations will be used as a search criteria
-				// Therefore the query can also return organization having objects shared with the allowed organizations
-				//
-				// 1) build the list of organizations sharing something with the allowed organizations
-				// Organization <== sharing_org_id == SharedObject having org_id IN {user orgs}
-				$oShareSearch = new DBObjectSearch('SharedObject');
-				$oOrgField = new FieldExpression('org_id', 'SharedObject');
-				$oShareSearch->AddConditionExpression(new BinaryExpression($oOrgField, 'IN', $oListExpr));
-	
-				$oSearchSharers = new DBObjectSearch('Organization');
-				$oSearchSharers->AllowAllData();
-				$oSearchSharers->AddCondition_ReferencedBy($oShareSearch, 'sharing_org_id');
-				$aSharers = array();
-				foreach($oSearchSharers->ToDataArray(array('id')) as $aRow)
-				{
-					$aSharers[] = $aRow['id'];
-				}
-				// 2) Enlarge the overall results: ... OR id IN(id1, id2, id3)
-				if (count($aSharers) > 0)
-				{
-					$oSharersList = ListExpression::FromScalars($aSharers);
-					$oFilter->MergeConditionExpression(new BinaryExpression($oExpression, 'IN', $oSharersList));
-				}
-			}
-	
-			$aShareProperties = SharedObject::GetSharedClassProperties($sClass);
-			if ($aShareProperties)
-			{
-				$sShareClass = $aShareProperties['share_class'];
-				$sShareAttCode = $aShareProperties['attcode'];
-	
-				$oSearchShares = new DBObjectSearch($sShareClass);
-				$oSearchShares->AllowAllData();
-	
-				$sHierarchicalKeyCode = MetaModel::IsHierarchicalClass('Organization');
-				$oOrgField = new FieldExpression('org_id', $sShareClass);
-				$oSearchShares->AddConditionExpression(new BinaryExpression($oOrgField, 'IN', $oListExpr));
-				$aShared = array();
-				foreach($oSearchShares->ToDataArray(array($sShareAttCode)) as $aRow)
-				{
-					$aShared[] = $aRow[$sShareAttCode];
-				}
-				if (count($aShared) > 0)
-				{
-					$oObjId = new FieldExpression('id', $sClass);
-					$oSharedIdList = ListExpression::FromScalars($aShared);
-					$oFilter->MergeConditionExpression(new BinaryExpression($oObjId, 'IN', $oSharedIdList));
-				}
-			}
-		} // if HasSharing
-
-		return $oFilter;
+		return $this->MakeSelectFilter($sClass, $aUserOrgs, $aSettings, $sAttCode);
 	}
 
+
 	// This verb has been made public to allow the development of an accurate feedback for the current configuration
 	public function GetProfileActionGrant($iProfile, $sClass, $sAction)
 	{
-		$this->LoadActionGrantCache();
-
 		// Note: action is forced lowercase to be more flexible (historical bug)
 		$sAction = strtolower($sAction);
-		if (isset($this->m_aClassActionGrants[$iProfile][$sClass][$sAction]))
-		{
-			return $this->m_aClassActionGrants[$iProfile][$sClass][$sAction];
-		}
 
-		// Recursively look for the grant record in the class hierarchy
-		$sParentClass = MetaModel::GetParentPersistentClass($sClass);
-		if (empty($sParentClass))
-		{
-			$iGrant = null;
-		}
-		else
-		{
-			// Recursively look for the grant record in the class hierarchy
-			$iGrant = $this->GetProfileActionGrant($iProfile, $sParentClass, $sAction);
-		}
-
-		$this->m_aClassActionGrants[$iProfile][$sClass][$sAction] = $iGrant;
-		return $iGrant;
+		return ProfilesConfig::GetProfileActionGrant($iProfile, $sClass, $sAction);
 	}
 
 	protected function GetUserActionGrant($oUser, $sClass, $iActionCode)
@@ -928,44 +565,36 @@ exit;
 
 		$sAction = self::$m_aActionCodes[$iActionCode];
 
-		$iPermission = UR_ALLOWED_NO;
-		$aAttributes = array();
-		foreach($this->GetUserProfiles($iUser) as $iProfile => $oProfile)
+		$bStatus = null;
+		// Call the API of UserRights because it caches the list for us
+		foreach(UserRights::ListProfiles($oUser) as $iProfile => $oProfile)
 		{
-				$iGrant = $this->GetProfileActionGrant($iProfile, $sClass, $sAction);
-				if (is_null($iGrant) || !$iGrant)
+			$bGrant = $this->GetProfileActionGrant($iProfile, $sClass, $sAction);
+			if (!is_null($bGrant))
+			{
+				if ($bGrant)
 				{
-					continue; // loop to the next profile
+					if (is_null($bStatus))
+					{
+						$bStatus = true;
+					}
 				}
 				else
 				{
-					$iPermission = UR_ALLOWED_YES;
-
-					// update the list of attributes with those allowed for this profile
-					//
-					$oSearch = DBObjectSearch::FromOQL_AllData("SELECT URP_AttributeGrant WHERE actiongrantid = :actiongrantid");
-					$oSet = new DBObjectSet($oSearch, array(), array('actiongrantid' => $iGrant));
-					$aProfileAttributes = $oSet->GetColumnAsArray('attcode', false);
-					if (count($aProfileAttributes) == 0)
-					{
-						$aAllAttributes = array_keys(MetaModel::ListAttributeDefs($sClass));
-						$aAttributes = array_merge($aAttributes, $aAllAttributes);
-					}
-					else
-					{
-						$aAttributes = array_merge($aAttributes, $aProfileAttributes);
-					}
+					$bStatus = false;
 				}
 			}
+		}
+
+		$iPermission = $bStatus ? UR_ALLOWED_YES : UR_ALLOWED_NO;
 
 		$aRes = array(
 			'permission' => $iPermission,
-			'attributes' => $aAttributes,
 		);
 		$this->m_aObjectActionGrants[$iUser][$sClass][$iActionCode] = $aRes;
 		return $aRes;
 	}
-	
+
 	public function IsActionAllowed($oUser, $sClass, $iActionCode, $oInstanceSet = null)
 	{
 		$this->LoadCache();
@@ -1049,30 +678,13 @@ exit;
 		// Note: The object set is ignored because it was interesting to optimize for huge data sets
 		//       and acceptable to consider only the root class of the object set
 		$aObjectPermissions = $this->GetUserActionGrant($oUser, $sClass, $iActionCode);
-		$aAttributes = $aObjectPermissions['attributes'];
-		if (in_array($sAttCode, $aAttributes))
-		{
-			return $aObjectPermissions['permission'];
-		}
-		else
-		{
-			return UR_ALLOWED_NO;
-		}
+		return $aObjectPermissions['permission'];
 	}
 
 	// This verb has been made public to allow the development of an accurate feedback for the current configuration
 	public function GetClassStimulusGrant($iProfile, $sClass, $sStimulusCode)
 	{
-		$this->LoadCache();
-
-		if (isset($this->m_aClassStimulusGrants[$iProfile][$sClass][$sStimulusCode]))
-		{
-			return $this->m_aClassStimulusGrants[$iProfile][$sClass][$sStimulusCode];
-		}
-		else
-		{
-			return null;
-		}
+		return ProfilesConfig::GetProfileStimulusGrant($iProfile, $sClass, $sStimulusCode);
 	}
 
 	public function IsStimulusAllowed($oUser, $sClass, $sStimulusCode, $oInstanceSet = null)
@@ -1083,16 +695,28 @@ exit;
 
 		// Note: The object set is ignored because it was interesting to optimize for huge data sets
 		//       and acceptable to consider only the root class of the object set
-		$iPermission = UR_ALLOWED_NO;
-		foreach($this->GetUserProfiles($iUser) as $iProfile => $oProfile)
+		$bStatus = null;
+		// Call the API of UserRights because it caches the list for us
+		foreach(UserRights::ListProfiles($oUser) as $iProfile => $oProfile)
 		{
-				$oGrantRecord = $this->GetClassStimulusGrant($iProfile, $sClass, $sStimulusCode);
-				if (!is_null($oGrantRecord))
+			$bGrant = $this->GetClassStimulusGrant($iProfile, $sClass, $sStimulusCode);
+			if (!is_null($bGrant))
+			{
+				if ($bGrant)
 				{
-					// no need to fetch the record, we've requested the records having permission = 'yes'
-					$iPermission = UR_ALLOWED_YES;
+					if (is_null($bStatus))
+					{
+						$bStatus = true;
+					}
+				}
+				else
+				{
+					$bStatus = false;
 				}
 			}
+		}
+
+		$iPermission = $bStatus ? UR_ALLOWED_YES : UR_ALLOWED_NO;
 		return $iPermission;
 	}
 

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);

application/Html2Text.php

@@ -0,0 +1,328 @@
+<?php
+namespace Html2Text;
+
+if (!function_exists('mb_split'))
+{
+	function mb_split($pattern, $subject, $limit = -1)
+	{
+		return preg_split('/'.$pattern.'/', $subject, $limit);
+	}
+}
+/**
+ * Replace all occurrences of the search string with the replacement string.
+ *
+ * @author Sean Murphy <sean@iamseanmurphy.com>
+ * @copyright Copyright 2012 Sean Murphy. All rights reserved.
+ * @license http://creativecommons.org/publicdomain/zero/1.0/
+ * @link http://php.net/manual/function.str-replace.php
+ *
+ * @param mixed $search
+ * @param mixed $replace
+ * @param mixed $subject
+ * @param int $count
+ * @return mixed
+ */
+function mb_str_replace($search, $replace, $subject, &$count = 0) {
+	if (!is_array($subject)) {
+		// Normalize $search and $replace so they are both arrays of the same length
+		$searches = is_array($search) ? array_values($search) : array($search);
+		$replacements = is_array($replace) ? array_values($replace) : array($replace);
+		$replacements = array_pad($replacements, count($searches), '');
+		foreach ($searches as $key => $search) {
+			$parts = mb_split(preg_quote($search), $subject);
+			$count += count($parts) - 1;
+			$subject = implode($replacements[$key], $parts);
+		}
+	} else {
+		// Call mb_str_replace for each subject in array, recursively
+		foreach ($subject as $key => $value) {
+			$subject[$key] = mb_str_replace($search, $replace, $value, $count);
+		}
+	}
+	return $subject;
+}
+
+/******************************************************************************
+ * Copyright (c) 2010 Jevon Wright and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * or
+ *
+ * LGPL which is available at http://www.gnu.org/licenses/lgpl.html
+ *
+ *
+ * Contributors:
+ *    Jevon Wright - initial API and implementation
+ *    Denis Flaven - some fixes for properly handling UTF-8 characters
+ ****************************************************************************/
+
+class Html2Text {
+
+	/**
+	 * Tries to convert the given HTML into a plain text format - best suited for
+	 * e-mail display, etc.
+	 *
+	 * <p>In particular, it tries to maintain the following features:
+	 * <ul>
+	 *   <li>Links are maintained, with the 'href' copied over
+	 *   <li>Information in the &lt;head&gt; is lost
+	 * </ul>
+	 *
+	 * @param string html the input HTML
+	 * @return string the HTML converted, as best as possible, to text
+	 * @throws Html2TextException if the HTML could not be loaded as a {@link DOMDocument}
+	 */
+	static function convert($html) {
+		// replace &nbsp; with spaces
+
+		$html = str_replace("&nbsp;", " ", $html);
+		$html = mb_str_replace("\xc2\xa0", " ", $html); // DO NOT USE str_replace since it breaks the "à" character which is \xc3 \xa0 in UTF-8
+
+		$html = static::fixNewlines($html);
+
+		$doc = new \DOMDocument();
+		if (!@$doc->loadHTML('<?xml encoding="UTF-8">'.$html)) // Forces the UTF-8 character set for HTML fragments
+		{
+			throw new Html2TextException("Could not load HTML - badly formed?", $html);
+		}
+
+		$output = static::iterateOverNode($doc);
+
+		// remove leading and trailing spaces on each line
+		$output = preg_replace("/[ \t]*\n[ \t]*/im", "\n", $output);
+		$output = preg_replace("/ *\t */im", "\t", $output);
+
+		// remove unnecessary empty lines
+		$output = preg_replace("/\n\n\n*/im", "\n\n", $output);
+
+		// remove leading and trailing whitespace
+		$output = trim($output);
+
+		return $output;
+	}
+
+	/**
+	 * Unify newlines; in particular, \r\n becomes \n, and
+	 * then \r becomes \n. This means that all newlines (Unix, Windows, Mac)
+	 * all become \ns.
+	 *
+	 * @param string text text with any number of \r, \r\n and \n combinations
+	 * @return string the fixed text
+	 */
+	static function fixNewlines($text) {
+		// replace \r\n to \n
+		$text = str_replace("\r\n", "\n", $text);
+		// remove \rs
+		$text = str_replace("\r", "\n", $text);
+
+		return $text;
+	}
+
+	static function nextChildName($node) {
+		// get the next child
+		$nextNode = $node->nextSibling;
+		while ($nextNode != null) {
+			if ($nextNode instanceof \DOMElement) {
+				break;
+			}
+			$nextNode = $nextNode->nextSibling;
+		}
+		$nextName = null;
+		if ($nextNode instanceof \DOMElement && $nextNode != null) {
+			$nextName = strtolower($nextNode->nodeName);
+		}
+
+		return $nextName;
+	}
+
+	static function prevChildName($node) {
+		// get the previous child
+		$nextNode = $node->previousSibling;
+		while ($nextNode != null) {
+			if ($nextNode instanceof \DOMElement) {
+				break;
+			}
+			$nextNode = $nextNode->previousSibling;
+		}
+		$nextName = null;
+		if ($nextNode instanceof \DOMElement && $nextNode != null) {
+			$nextName = strtolower($nextNode->nodeName);
+		}
+
+		return $nextName;
+	}
+
+	static function iterateOverNode($node) {
+		if ($node instanceof \DOMText) {
+		  // Replace whitespace characters with a space (equivilant to \s)
+			return preg_replace("/[\\t\\n\\f\\r ]+/im", " ", $node->wholeText);
+		}
+		if ($node instanceof \DOMDocumentType) {
+			// ignore
+			return "";
+		}
+
+		$nextName = static::nextChildName($node);
+		$prevName = static::prevChildName($node);
+
+		$name = strtolower($node->nodeName);
+
+		// start whitespace
+		switch ($name) {
+			case "hr":
+				return "---------------------------------------------------------------\n";
+
+			case "style":
+			case "head":
+			case "title":
+			case "meta":
+			case "script":
+				// ignore these tags
+				return "";
+
+			case "h1":
+			case "h2":
+			case "h3":
+			case "h4":
+			case "h5":
+			case "h6":
+			case "ol":
+			case "ul":
+				// add two newlines, second line is added below
+				$output = "\n";
+				break;
+
+			case "td":
+			case "th":
+				// add tab char to separate table fields
+			   $output = "\t";
+			   break;
+
+			case "tr":
+			case "p":
+			case "div":
+				// add one line
+				$output = "\n";
+				break;
+
+			case "li":
+				$output = "- ";
+				break;
+
+			default:
+				// print out contents of unknown tags
+				$output = "";
+				break;
+		}
+
+		// debug
+		//$output .= "[$name,$nextName]";
+
+		if (isset($node->childNodes)) {
+			for ($i = 0; $i < $node->childNodes->length; $i++) {
+				$n = $node->childNodes->item($i);
+
+				$text = static::iterateOverNode($n);
+
+				$output .= $text;
+			}
+		}
+
+		// end whitespace
+		switch ($name) {
+			case "h1":
+			case "h2":
+			case "h3":
+			case "h4":
+			case "h5":
+			case "h6":
+				$output .= "\n";
+				break;
+
+			case "p":
+			case "br":
+				// add one line
+				if ($nextName != "div")
+					$output .= "\n";
+				break;
+
+			case "div":
+				// add one line only if the next child isn't a div
+				if ($nextName != "div" && $nextName != null)
+					$output .= "\n";
+				break;
+
+			case "a":
+				// links are returned in [text](link) format
+				$href = $node->getAttribute("href");
+
+				$output = trim($output);
+
+				// remove double [[ ]] s from linking images
+				if (substr($output, 0, 1) == "[" && substr($output, -1) == "]") {
+					$output = substr($output, 1, strlen($output) - 2);
+
+					// for linking images, the title of the <a> overrides the title of the <img>
+					if ($node->getAttribute("title")) {
+						$output = $node->getAttribute("title");
+					}
+				}
+
+				// if there is no link text, but a title attr
+				if (!$output && $node->getAttribute("title")) {
+					$output = $node->getAttribute("title");
+				}
+
+				if ($href == null) {
+					// it doesn't link anywhere
+					if ($node->getAttribute("name") != null) {
+						$output = "[$output]";
+					}
+				} else {
+					if ($href == $output || $href == "mailto:$output" || $href == "http://$output" || $href == "https://$output") {
+						// link to the same address: just use link
+						$output;
+					} else {
+						// replace it
+						if ($output) {
+							$output = "[$output]($href)";
+						} else {
+							// empty string
+							$output = $href;
+						}
+					}
+				}
+
+				// does the next node require additional whitespace?
+				switch ($nextName) {
+					case "h1": case "h2": case "h3": case "h4": case "h5": case "h6":
+						$output .= "\n";
+						break;
+				}
+				break;
+
+			case "img":
+				if ($node->getAttribute("title")) {
+					$output = "[" . $node->getAttribute("title") . "]";
+				} elseif ($node->getAttribute("alt")) {
+					$output = "[" . $node->getAttribute("alt") . "]";
+				} else {
+					$output = "";
+				}
+				break;
+
+			case "li":
+				$output .= "\n";
+				break;
+
+			default:
+				// do nothing
+		}
+
+		return $output;
+	}
+
+}

application/Html2TextException.php

@@ -0,0 +1,28 @@
+<?php
+
+/******************************************************************************
+ * Copyright (c) 2010 Jevon Wright and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * or
+ *
+ * LGPL which is available at http://www.gnu.org/licenses/lgpl.html
+ *
+ *
+ * Contributors:
+ *    Jevon Wright - initial API and implementation
+ ****************************************************************************/
+
+namespace Html2Text;
+
+class Html2TextException extends \Exception {
+	var $more_info;
+
+	public function __construct($message = "", $more_info = "") {
+		parent::__construct($message);
+		$this->more_info = $more_info;
+	}
+}

application/ajaxwebpage.class.inc.php

@@ -1,41 +1,40 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2017 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-2017 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
@@ -43,56 +42,93 @@ class ajax_page extends WebPage
      */	  
 	function __construct($s_title)
     {
-        parent::__construct($s_title);
+		$sPrintable = utils::ReadParam('printable', '0');
+		$bPrintable = ($sPrintable == '1');
+
+        parent::__construct($s_title, $bPrintable);
         $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 = "";
+
+		utils::InitArchiveMode();
+    }
 
 	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,75 +147,75 @@ 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, $this);
+		
+		// Additional UI widgets to be activated inside the ajax fragment
+		// Important: Testing the content type is not enough because some ajax handlers have not correctly positionned the flag (e.g json response corrupted by the script)
+		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
+PrepareWidgets();
+EOF
+			);
 		}
-	
-        $s_captured_output = ob_get_contents();
-        ob_end_clean();
-        if (($this->sContentType == 'text/html') &&  ($this->sContentDisposition == 'inline'))
+        $s_captured_output = $this->ob_get_clean_safe();
+		  if (($this->sContentType == 'text/html') &&  ($this->sContentDisposition == 'inline'))
         {
         	// inline content != attachment && html => filter all scripts for malicious XSS scripts
         	echo self::FilterXSS($this->s_content);
@@ -188,6 +224,23 @@ 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 "\n</script>\n";
+        }
+
         //echo $this->s_deferred_content;
         if (count($this->a_scripts) > 0)
         {
@@ -207,10 +260,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('DBSearch'))
+        {
+            DBSearch::RecordQueryTrace();
+        }
     }
 
     /**
@@ -225,9 +284,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 +300,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 +322,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 +361,7 @@ EOF
 	 */	 	 	
 	public function add_ready_script($sScript)
 	{
-		$this->m_sReadyScript .= $sScript;
+		$this->m_sReadyScript .= $sScript."\n";
 	}
 	
 	/**
@@ -319,4 +380,3 @@ EOF
 	}
 }
 
-?>

application/application.inc.php

@@ -1,35 +1,36 @@
 <?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');
 require_once(APPROOT.'/application/cmdbabstract.class.inc.php');
 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");
@@ -98,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] : '';
@@ -221,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);
+						}
 					}
 				}
 			}

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, "tracking_level" => LINKSET_TRACKING_ALL)));
 
 		// 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/capturewebpage.class.inc.php

@@ -0,0 +1,84 @@
+<?php
+// Copyright (C) 2016 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/>
+
+/**
+ * Adapter class: when an API requires WebPage and you want to produce something else
+ *
+ * @copyright   Copyright (C) 2016 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT."/application/webpage.class.inc.php");
+
+class CaptureWebPage extends WebPage
+{
+	protected $aReadyScripts;
+
+	function __construct()
+	{
+		parent::__construct('capture web page');
+		$this->aReadyScripts = array();
+	}
+
+	public function GetHtml()
+	{
+		$trash = $this->ob_get_clean_safe();
+		return $this->s_content;
+	}
+
+	public function GetJS()
+	{
+		$sRet = implode("\n", $this->a_scripts);
+		if (!empty($this->s_deferred_content))
+		{
+			$sRet .= "\n\$('body').append('".addslashes(str_replace("\n", '', $this->s_deferred_content))."');";
+		}
+		return $sRet;
+	}
+
+	public function GetReadyJS()
+	{
+		return "\$(document).ready(function() {\n".implode("\n", $this->aReadyScripts)."\n});";
+	}
+
+	public function GetCSS()
+	{
+		return $this->a_styles;
+	}
+
+	public function GetJSFiles()
+	{
+		return $this->a_linked_scripts;
+	}
+
+	public function GetCSSFiles()
+	{
+		return $this->a_linked_stylesheets;
+	}
+
+	public function output()
+	{
+		throw new Exception(__method__.' should not be called');
+	}
+
+	public function add_ready_script($sScript)
+	{
+		$this->aReadyScripts[] = $sScript;
+	}
+}
+

application/clipage.class.inc.php

@@ -1,32 +1,33 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2015 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-2015 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('DBSearch'))
+        {
+            DBSearch::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-2015 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-2015 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT."/application/webpage.class.inc.php");
@@ -31,18 +32,33 @@ 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()
     {
-		$this->add_header("Content-Length: ".strlen(trim($this->s_content)));
+			$this->add_header("Content-Length: ".strlen(trim($this->s_content)));
+
+			// Get the unexpected output but do nothing with it
+			$sTrash = $this->ob_get_clean_safe();
+
         foreach($this->a_headers as $s_header)
         {
             header($s_header);
         }
         echo trim($this->s_content);
+        echo "\n";
+
+        if (class_exists('DBSearch'))
+        {
+            DBSearch::RecordQueryTrace();
+        }
+        if (class_exists('ExecutionKPI'))
+        {
+            ExecutionKPI::ReportStats();
+        }
     }
 
 	public function small_p($sText)
@@ -93,4 +109,3 @@ class CSVPage extends WebPage
 	}
 }
 
-?>

application/dashboard.class.inc.php

@@ -0,0 +1,907 @@
+<?php
+// Copyright (C) 2010-2017 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-2017 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(MetaModel::GetConfig()->Get('min_reload_interval'), (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(MetaModel::GetConfig()->Get('min_reload_interval'), (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(MetaModel::GetConfig()->Get('min_reload_interval'), (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>'.htmlentities(Dict::S($this->sTitle), ENT_QUOTES, 'UTF-8', false).'</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 DesignerIntegerField('auto_reload_sec', Dict::S('UI:DashboardEdit:AutoReloadSec'), $this->iAutoReloadSec);
+		$oField->SetBoundaries(MetaModel::GetConfig()->Get('min_reload_interval'), null); // no upper limit
+		$oForm->AddField($oField);
+
+
+		$this->SetFormParams($oForm);
+		$oForm->RenderAsPropertySheet($oPage, false, '.itop-dashboard');	
+
+		$oPage->add('</div>');
+
+		$sRateTitle = addslashes(Dict::Format('UI:DashboardEdit:AutoReloadSec+', MetaModel::GetConfig()->Get('min_reload_interval')));
+		$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);
+		}
+		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);
+		}
+		utils::PushArchiveMode(false);
+		$oUserDashboard->DBWrite();
+		utils::PopArchiveMode();
+	}
+	
+	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();
+			utils::PushArchiveMode(false);
+			$oUserDashboard->DBDelete();
+			utils::PopArchiveMode();
+		}
+	}
+	
+	public function RenderEditionTools($oPage)
+	{
+		$oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.iframe-transport.js');
+		$oPage->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.fileupload.js');
+		$sEditMenu = "<td><span id=\"DashboardMenu\"><ul><li><img src=\"../images/pencil-menu.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)
+	{
+		$oAppContext = new ApplicationContext();
+		$sContextMenuId = $oAppContext->GetCurrentValue('menu', null);
+
+		$oForm = new DesignerForm();
+	
+		// Get the list of all 'dashboard' menus in which we can insert a dashlet
+		$aAllMenus = ApplicationMenu::ReflectionMenuNodes();
+		$sRootMenuId = ApplicationMenu::GetRootMenuId($sContextMenuId);
+		$aAllowedDashboards = array();
+		$sDefaultDashboard = null;
+
+		// Store the parent menus for acces check
+        $aParentMenus = array();
+        foreach($aAllMenus as $idx => $aMenu)
+        {
+            /** @var MenuNode $oMenu */
+            $oMenu = $aMenu['node'];
+            if (count(ApplicationMenu::GetChildren($oMenu->GetIndex())) > 0)
+            {
+                $aParentMenus[$oMenu->GetMenuId()] = $aMenu;
+            }
+        }
+
+        foreach($aAllMenus as $idx => $aMenu)
+		{
+			$oMenu = $aMenu['node'];
+            if ($oMenu instanceof DashboardMenuNode)
+            {
+                // Get the root parent for access check
+                $sParentId = $aMenu['parent'];
+                $aParentMenu = $aParentMenus[$sParentId];
+                while (isset($aParentMenus[$aParentMenu['parent']]))
+                {
+                    // grand parent exists
+                    $sParentId = $aParentMenu['parent'];
+                    $aParentMenu = $aParentMenus[$sParentId];
+                }
+                $oParentMenu = $aParentMenu['node'];
+                if ($oMenu->IsEnabled() && $oParentMenu->IsEnabled())
+                {
+                    $sMenuLabel = $oMenu->GetTitle();
+                    $sParentLabel = Dict::S('Menu:'.$sParentId);
+                    if ($sParentLabel != $sMenuLabel)
+                    {
+                        $aAllowedDashboards[$oMenu->GetMenuId()] = $sParentLabel.' - '.$sMenuLabel;
+                    }
+                    else
+                    {
+                        $aAllowedDashboards[$oMenu->GetMenuId()] = $sMenuLabel;
+                    }
+                    if (empty($sDefaultDashboard) && ($sRootMenuId == ApplicationMenu::GetRootMenuId($oMenu->GetMenuId())))
+                    {
+                        $sDefaultDashboard = $oMenu->GetMenuId();
+                    }
+                }
+            }
+		}
+		asort($aAllowedDashboards);
+		
+		$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: 600,
+	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%;table-layout:fixed;"><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/datamodel.application.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<itop_design>
+  <portals>
+    <portal id="legacy_portal" _delta="define">
+      <url>portal/index.php</url>
+      <rank>1.0</rank>
+      <handler/>
+      <allow>
+      </allow>
+      <deny/>
+    </portal>
+    <portal id="backoffice" _delta="define">
+      <url>pages/UI.php</url>
+      <rank>2.0</rank>
+      <handler/>
+      <allow/>
+      <deny>
+        <profile id="Portal user"/>
+      </deny>
+    </portal>
+  </portals>
+</itop_design>

application/datatable.class.inc.php

@@ -0,0 +1,961 @@
+<?php
+// Copyright (C) 2010-2017 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-2017 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
+	protected $bShowObsoleteData;
+
+	/**
+	 * @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;
+		$this->bShowObsoleteData = $oSet->GetShowObsoleteData();
+	}
+	
+	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);
+
+		$aExtraParams['show_obsolete_data'] = $this->bShowObsoleteData;
+
+		$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)
+	{
+		if (!$oPage->IsPrintableVersion())
+		{
+			$sMenuTitle = Dict::S('UI:ConfigureThisList');
+			$sHtml = '<div class="itop_popup toolkit_menu" id="tk_'.$this->iListId.'"><ul><li><img src="../images/toolkit_menu.png?itopversion='.ITOP_VERSION.'"><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);
+		}
+		else
+		{
+			$sHtml = '';
+		}
+		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;
+		}
+		$aExtraParams['show_obsolete_data'] = $this->bShowObsoleteData;
+
+		$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.tableHover();
+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()");
+		}
+	}
+}
+
+/**
+ * Simplified version of the data table with less "decoration" (and no paging)
+ * which is optimized for printing
+ */
+class PrintableDataTable extends DataTable
+{
+	public function GetAsHTML(WebPage $oPage, $iPageSize, $iDefaultPageSize, $iPageIndex, $aColumns, $bActionsMenu, $bToolkitMenu, $sSelectMode, $bViewLink, $aExtraParams)
+	{
+		return $this->GetHTMLTable($oPage, $aColumns, $sSelectMode, -1, $bViewLink, $aExtraParams);
+	}
+	
+	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 = $oPage->GetTable($aAttribs, $aValues);
+		
+		return $sHtml;
+	}
+}
+
+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';
+				}
+				$sNormalizedFName = MetaModel::NormalizeFieldSpec($sClass, 'friendlyname');
+				if(array_key_exists($sNormalizedFName, $aSortOrder))
+				{
+					$sSort = $aSortOrder[$sNormalizedFName] ? '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())
+			{
+				if ($oAttDef->IsFriendlyName())
+				{
+					$sLabel = Dict::Format('UI:ExtKey_AsFriendlyName', $oAttDef->GetLabel());
+				}
+				else
+				{
+					$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/excelexporter.class.inc.php

@@ -0,0 +1,536 @@
+<?php
+require_once('xlsxwriter.class.php');
+
+class ExcelExporter
+{
+	protected $sToken;
+	protected $aStatistics;
+	protected $sState;
+	protected $fStartTime;
+	protected $oSearch;
+	protected $aObjectsIDs;
+	protected $aTableHeaders;
+	protected $aAuthorizedClasses;
+	protected $iChunkSize = 1000;
+	protected $iPosition;
+	protected $sOutputFilePath;
+	protected $bAdvancedMode;
+	
+	public function __construct($sToken = null)
+	{
+		$this->aStatistics = array(
+			'objects_count' => 0,
+			'total_duration' => 0,
+			'data_retrieval_duration' => 0,
+			'excel_build_duration' => 0,
+			'excel_write_duration' => 0,
+			'peak_memory_usage' => 0,		
+		);
+		$this->fStartTime = microtime(true);
+		$this->oSearch = null;
+		
+		$this->sState = 'new';
+		$this->aObjectsIDs = array();
+		$this->iPosition = 0;
+		$this->aAuthorizedClasses = null;
+		$this->aTableHeaders = null;
+		$this->sOutputFilePath = null;
+		$this->bAdvancedMode = false;
+		$this->CheckDataDir();
+		if ($sToken == null)
+		{
+			$this->sToken = $this->GetNewToken();
+		}
+		else
+		{
+			$this->sToken = $sToken;
+			$this->ReloadState();
+		}
+	}
+	
+	public function __destruct()
+	{
+		if (($this->sState != 'done') && ($this->sState != 'error') && ($this->sToken != null))
+		{
+			// Operation in progress, save the state
+			$this->SaveState();
+		}
+		else
+		{
+			// Operation completed, cleanup the temp files
+			@unlink($this->GetStateFile());
+			@unlink($this->GetDataFile());
+		}
+		self::CleanupOldFiles();	
+	}
+	
+	public function SetChunkSize($iChunkSize)
+	{
+		$this->iChunkSize = $iChunkSize;	
+	}
+	
+	public function SetOutputFilePath($sDestFilePath)
+	{
+		$this->sOutputFilePath = $sDestFilePath;
+	}
+	
+	public function SetAdvancedMode($bAdvanced)
+	{
+		$this->bAdvancedMode = $bAdvanced;
+	}
+	
+	public function SaveState()
+	{
+		$aState = array(
+			'state' => $this->sState,
+			'statistics' => $this->aStatistics,
+			'filter' => $this->oSearch->serialize(),
+			'position' => $this->iPosition,
+			'chunk_size' => $this->iChunkSize,
+			'object_ids' => $this->aObjectsIDs,
+			'output_file_path' => $this->sOutputFilePath,
+			'advanced_mode' => $this->bAdvancedMode,
+		);
+		
+		file_put_contents($this->GetStateFile(), json_encode($aState));
+		
+		return $this->sToken;
+	}
+	
+	public function ReloadState()
+	{
+		if ($this->sToken == null)
+		{
+			throw new Exception('ExcelExporter not initialized with a token, cannot reload state');
+		}
+		
+		if (!file_exists($this->GetStateFile()))
+		{
+			throw new Exception("ExcelExporter: missing status file '".$this->GetStateFile()."', cannot reload state.");
+		}
+		$sJson = file_get_contents($this->GetStateFile());
+		$aState = json_decode($sJson, true);
+		if ($aState === null)
+		{
+			throw new Exception("ExcelExporter:corrupted status file '".$this->GetStateFile()."', not a JSON, cannot reload state.");
+		}
+		
+		$this->sState = $aState['state'];
+		$this->aStatistics = $aState['statistics'];
+		$this->oSearch = DBObjectSearch::unserialize($aState['filter']);
+		$this->iPosition = $aState['position'];
+		$this->iChunkSize = $aState['chunk_size'];
+		$this->aObjectsIDs = $aState['object_ids'];
+		$this->sOutputFilePath  = $aState['output_file_path'];
+		$this->bAdvancedMode = $aState['advanced_mode'];
+	}
+	
+	public function SetObjectList($oSearch)
+	{
+		$this->oSearch = $oSearch;
+	}
+	
+	public function Run()
+	{
+		$sCode = 'error';
+		$iPercentage = 100;
+		$sMessage = Dict::Format('ExcelExporter:ErrorUnexpected_State', $this->sState);
+		$fTime = microtime(true);
+		
+		try
+		{
+			switch($this->sState)
+			{
+				case 'new':
+				$oIDSet = new DBObjectSet($this->oSearch);
+				$oIDSet->OptimizeColumnLoad(array('id'));
+				$this->aObjectsIDs = array();
+				while($oObj = $oIDSet->Fetch())
+				{
+					$this->aObjectsIDs[] = $oObj->GetKey();
+				}		
+				$sCode = 'retrieving-data';
+				$iPercentage = 5;
+				$sMessage = Dict::S('ExcelExporter:RetrievingData');
+				$this->iPosition = 0;
+				$this->aStatistics['objects_count'] = count($this->aObjectsIDs);
+				$this->aStatistics['data_retrieval_duration'] += microtime(true) - $fTime;
+				
+				// The first line of the file is the "headers" specifying the label and the type of each column
+				$this->GetFieldsList($oIDSet, $this->bAdvancedMode);
+				$sRow = json_encode($this->aTableHeaders);
+				$hFile = @fopen($this->GetDataFile(), 'ab');
+				if ($hFile === false)
+				{
+					throw new Exception('ExcelExporter: Failed to open temporary data file: "'.$this->GetDataFile().'" for writing.');
+				}
+				fwrite($hFile, $sRow."\n");
+				fclose($hFile);	
+				
+				// Next state
+				$this->sState = 'retrieving-data';
+				break;
+				
+				case 'retrieving-data':
+				$oCurrentSearch = clone $this->oSearch;
+				$aIDs = array_slice($this->aObjectsIDs, $this->iPosition, $this->iChunkSize);
+				
+				$oCurrentSearch->AddCondition('id', $aIDs, 'IN');
+				$hFile = @fopen($this->GetDataFile(), 'ab');
+				if ($hFile === false)
+				{
+					throw new Exception('ExcelExporter: Failed to open temporary data file: "'.$this->GetDataFile().'" for writing.');
+				}
+				$oSet = new DBObjectSet($oCurrentSearch);
+				$this->GetFieldsList($oSet, $this->bAdvancedMode);
+				while($aObjects = $oSet->FetchAssoc())
+				{
+					$aRow = array();
+					foreach($this->aAuthorizedClasses as $sAlias => $sClassName)
+					{
+						$oObj = $aObjects[$sAlias];
+						if ($this->bAdvancedMode)
+						{
+							$aRow[] = $oObj->GetKey();
+						}
+						foreach($this->aFieldsList[$sAlias] as $sAttCodeEx => $oAttDef)
+						{
+							$value = $oObj->Get($sAttCodeEx);
+							if ($value instanceOf ormCaseLog)
+							{
+								// Extract the case log as text and remove the "===" which make Excel think that the cell contains a formula the next time you edit it!
+								$sExcelVal = trim(preg_replace('/========== ([^=]+) ============/', '********** $1 ************', $value->GetText()));
+							}
+							else
+							{
+								$sExcelVal =  $oAttDef->GetEditValue($value, $oObj);					
+							}
+							$aRow[] = $sExcelVal;				
+						}
+					}
+					$sRow = json_encode($aRow);
+					fwrite($hFile, $sRow."\n");
+				}
+				fclose($hFile);
+				
+				if (($this->iPosition + $this->iChunkSize) > count($this->aObjectsIDs))
+				{
+					// Next state
+					$this->sState = 'building-excel';
+					$sCode = 'building-excel';
+					$iPercentage = 80;
+					$sMessage = Dict::S('ExcelExporter:BuildingExcelFile');
+				}
+				else
+				{
+					$sCode = 'retrieving-data';
+					$this->iPosition += $this->iChunkSize;
+					$iPercentage = 5 + round(75 * ($this->iPosition / count($this->aObjectsIDs)));
+					$sMessage = Dict::S('ExcelExporter:RetrievingData');			
+				}
+				break;
+				
+				case 'building-excel':
+				$hFile = @fopen($this->GetDataFile(), 'rb');
+				if ($hFile === false)
+				{
+					throw new Exception('ExcelExporter: Failed to open temporary data file: "'.$this->GetDataFile().'" for reading.');
+				}
+				$sHeaders = fgets($hFile);
+				$aHeaders = json_decode($sHeaders, true);
+				
+				$aData = array();
+				while($sLine = fgets($hFile))
+				{
+					$aRow = json_decode($sLine);
+					$aData[] = $aRow;
+				}
+				fclose($hFile);
+				@unlink($this->GetDataFile());
+					
+				$fStartExcel = microtime(true);
+				$writer = new XLSXWriter();
+				$writer->setAuthor(UserRights::GetUserFriendlyName());
+				$writer->writeSheet($aData,'Sheet1', $aHeaders);
+				$fExcelTime = microtime(true) - $fStartExcel;
+				$this->aStatistics['excel_build_duration'] = $fExcelTime;
+				
+				$fTime = microtime(true);
+				$writer->writeToFile($this->GetExcelFilePath());
+				$fExcelSaveTime = microtime(true) - $fTime;
+				$this->aStatistics['excel_write_duration'] = $fExcelSaveTime;
+				
+				// Next state
+				$this->sState = 'done';
+				$sCode = 'done';
+				$iPercentage = 100;
+				$sMessage = Dict::S('ExcelExporter:Done');
+				break;
+				
+				case 'done':
+				$this->sState = 'done';
+				$sCode = 'done';
+				$iPercentage = 100;
+				$sMessage = Dict::S('ExcelExporter:Done');
+				break;
+			}
+		}
+		catch(Exception $e)
+		{
+			$sCode = 'error';
+			$sMessage = $e->getMessage();
+		}
+		
+		$this->aStatistics['total_duration'] += microtime(true) - $fTime;
+		$peak_memory = memory_get_peak_usage(true);
+		if ($peak_memory > $this->aStatistics['peak_memory_usage'])
+		{
+			$this->aStatistics['peak_memory_usage'] = $peak_memory;
+		}
+		
+		return array(
+			'code' => $sCode,
+			'message' => $sMessage,
+			'percentage' => $iPercentage,
+		);
+	}
+	
+	public function GetExcelFilePath()
+	{
+		if ($this->sOutputFilePath == null)
+		{
+			return APPROOT.'data/bulk_export/'.$this->sToken.'.xlsx';
+		}
+		else
+		{
+			return $this->sOutputFilePath;
+		}
+	}
+	
+	public static function GetExcelFileFromToken($sToken)
+	{
+		return @file_get_contents(APPROOT.'data/bulk_export/'.$sToken.'.xlsx');
+	}
+	
+	public static function CleanupFromToken($sToken)
+	{
+		@unlink(APPROOT.'data/bulk_export/'.$sToken.'.status');
+		@unlink(APPROOT.'data/bulk_export/'.$sToken.'.data');
+		@unlink(APPROOT.'data/bulk_export/'.$sToken.'.xlsx');
+	}
+	
+	public function Cleanup()
+	{
+		self::CleanupFromToken($this->sToken);
+	}
+	
+	/**
+	 * Delete all files in the data/bulk_export directory which are older than 1 day
+	 * unless a different delay is configured.
+	 */
+	public static function CleanupOldFiles()
+	{
+		$aFiles = glob(APPROOT.'data/bulk_export/*.*');
+		$iDelay = MetaModel::GetConfig()->Get('xlsx_exporter_cleanup_old_files_delay');
+		
+		if($iDelay > 0)
+		{
+			foreach($aFiles as $sFile)
+			{
+				$iModificationTime = filemtime($sFile);
+				
+				if($iModificationTime < (time() - $iDelay))
+				{
+					// Temporary files older than one day are deleted
+					//echo "Supposed to delete: '".$sFile." (Unix Modification Time: $iModificationTime)'\n";
+					@unlink($sFile);
+				}
+			}
+		}
+	}
+	
+	public function DisplayStatistics(Page $oPage)
+	{
+		$aStats = array(
+				'Number of objects exported' => $this->aStatistics['objects_count'],
+				'Total export duration' => sprintf('%.3f s', $this->aStatistics['total_duration']),
+				'Data retrieval duration' => sprintf('%.3f s', $this->aStatistics['data_retrieval_duration']),
+				'Excel build duration' => sprintf('%.3f s', $this->aStatistics['excel_build_duration']),
+				'Excel write duration' => sprintf('%.3f s', $this->aStatistics['excel_write_duration']),
+				'Peak memory usage' => self::HumanDisplay($this->aStatistics['peak_memory_usage']),
+		);
+		
+		if ($oPage instanceof CLIPage)
+		{
+			$oPage->add($this->GetStatistics('text'));
+		}
+		else
+		{
+			$oPage->add($this->GetStatistics('html'));
+		}
+	}
+	
+	public function GetStatistics($sFormat = 'html')
+	{
+		$sStats = '';
+		$aStats = array(
+				'Number of objects exported' => $this->aStatistics['objects_count'],
+				'Total export duration' => sprintf('%.3f s', $this->aStatistics['total_duration']),
+				'Data retrieval duration' => sprintf('%.3f s', $this->aStatistics['data_retrieval_duration']),
+				'Excel build duration' => sprintf('%.3f s', $this->aStatistics['excel_build_duration']),
+				'Excel write duration' => sprintf('%.3f s', $this->aStatistics['excel_write_duration']),
+				'Peak memory usage' => self::HumanDisplay($this->aStatistics['peak_memory_usage']),
+		);
+		
+		if ($sFormat == 'text')
+		{
+			foreach($aStats as $sLabel => $sValue)
+			{
+				$sStats .= "+------------------------------+----------+\n";
+				$sStats .= sprintf("|%-30s|%10s|\n", $sLabel, $sValue);
+			}
+			$sStats .= "+------------------------------+----------+";
+		}
+		else
+		{
+			$sStats .= '<table><tbody>';
+			foreach($aStats as $sLabel => $sValue)
+			{
+				$sStats .= "<tr><td>$sLabel</td><td>$sValue</td></tr>";
+			}
+			$sStats .= '</tbody></table>';
+			
+		}
+		return $sStats;
+	}
+	
+	public static function HumanDisplay($iSize)
+	{
+		$aUnits = array('B','KB','MB','GB','TB','PB');
+		return @round($iSize/pow(1024,($i=floor(log($iSize,1024)))),2).' '.$aUnits[$i];
+	}
+	
+	protected function CheckDataDir()
+	{
+		if(!is_dir(APPROOT."data/bulk_export"))
+		{
+			@mkdir(APPROOT."data/bulk_export", 0777, true /* recursive */);
+			clearstatcache();
+		}
+		if (!is_writable(APPROOT."data/bulk_export"))
+		{
+			throw new Exception('Data directory "'.APPROOT.'data/bulk_export" could not be written.');
+		}
+	}
+	
+	protected function GetStateFile($sToken = null)
+	{
+		if ($sToken == null)
+		{
+			$sToken = $this->sToken;
+		}
+		return APPROOT."data/bulk_export/$sToken.status";
+	}
+	
+	protected function GetDataFile()
+	{
+		return APPROOT.'data/bulk_export/'.$this->sToken.'.data';
+	}
+	
+	protected function GetNewToken()
+	{
+		$iNum = rand();
+		do
+		{
+			$iNum++;
+			$sToken = sprintf("%08x", $iNum);
+			$sFileName = $this->GetStateFile($sToken);
+			$hFile = @fopen($sFileName, 'x');
+		}
+		while($hFile === false);
+		
+		fclose($hFile);
+		return $sToken;
+	}
+	
+	protected function GetFieldsList($oSet, $bFieldsAdvanced = false, $bLocalize = true, $aFields = null)
+	{
+		$this->aFieldsList = array();
+	
+		$oAppContext = new ApplicationContext();
+		$aClasses = $oSet->GetFilter()->GetSelectedClasses();
+		$this->aAuthorizedClasses = array();
+		foreach($aClasses as $sAlias => $sClassName)
+		{
+			if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
+			{
+				$this->aAuthorizedClasses[$sAlias] = $sClassName;
+			}
+		}
+		$aAttribs = array();
+		$this->aTableHeaders = array();
+		foreach($this->aAuthorizedClasses as $sAlias => $sClassName)
+		{
+			$aList[$sAlias] = array();
+	
+			foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef)
+			{
+				if (is_null($aFields) || (count($aFields) == 0))
+				{
+					// Standard list of attributes (no link sets)
+					if ($oAttDef->IsScalar() && ($oAttDef->IsWritable() || $oAttDef->IsExternalField()))
+					{
+						$sAttCodeEx = $oAttDef->IsExternalField() ? $oAttDef->GetKeyAttCode().'->'.$oAttDef->GetExtAttCode() : $sAttCode;
+						
+						if ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE))
+						{
+							if ($bFieldsAdvanced)
+							{
+								$aList[$sAlias][$sAttCodeEx] = $oAttDef;
+	
+								if ($oAttDef->IsExternalKey(EXTKEY_RELATIVE))
+								{
+							  		$sRemoteClass = $oAttDef->GetTargetClass();
+									foreach(MetaModel::GetReconcKeys($sRemoteClass) as $sRemoteAttCode)
+								  	{
+										$this->aFieldsList[$sAlias][$sAttCode.'->'.$sRemoteAttCode] = MetaModel::GetAttributeDef($sRemoteClass, $sRemoteAttCode);
+								  	}
+								}
+							}
+						}
+						else
+						{
+							// Any other attribute
+							$this->aFieldsList[$sAlias][$sAttCodeEx] = $oAttDef;
+						}
+					}
+				}
+				else
+				{
+					// User defined list of attributes
+					if (in_array($sAttCode, $aFields) || in_array($sAlias.'.'.$sAttCode, $aFields))
+					{
+						$this->aFieldsList[$sAlias][$sAttCode] = $oAttDef;
+					}
+				}
+			}
+			if ($bFieldsAdvanced)
+			{
+				$this->aTableHeaders['id'] = '0';
+			}
+			foreach($this->aFieldsList[$sAlias] as $sAttCodeEx => $oAttDef)
+			{
+				$sLabel = $bLocalize ? MetaModel::GetLabel($sClassName, $sAttCodeEx, isset($aParams['showMandatoryFields'])) : $sAttCodeEx;
+				if($oAttDef instanceof AttributeDateTime)
+				{
+					$this->aTableHeaders[$sLabel] = 'datetime';
+				}
+				else
+				{
+					$this->aTableHeaders[$sLabel] = 'string';
+				}
+			}
+		}
+	}
+}
+

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-2016 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-2016 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
@@ -110,7 +140,7 @@ class ApplicationMenu
 			//       they were not used to display the menus (redundant or unused)
 			//
 			$aBacktrace = debug_backtrace();
-			$sFile = $aBacktrace[2]["file"];
+			$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
@@ -118,6 +148,7 @@ class ApplicationMenu
 			// the menu already exists, let's combine the conditions that make it visible
 			self::$aMenusIndex[$index]['node']->AddCondition($oMenuNode);
 		}
+
 		return $index;
 	}
 
@@ -126,23 +157,25 @@ class ApplicationMenu
 	 */
 	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']);
 			if (!$oMenuNode->IsEnabled()) continue; // Don't display a non-enabled menu
-			$oPage->AddToMenu('<h3>'.$oMenuNode->GetTitle().'</h3>');
+			$oPage->AddToMenu('<h3 id="'.utils::GetSafeId('AccordionMenu_'.$oMenuNode->GetMenuID()).'">'.$oMenuNode->GetTitle().'</h3>');
 			$oPage->AddToMenu('<div>');
 			$aChildren = self::GetChildren($aMenu['index']);
 			if (count($aChildren) > 0)
@@ -152,8 +185,12 @@ 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(
+<<<EOF
+		// Accordion Menu
+		$("#accordion").css({display:'block'}).accordion({ header: "h3", navigation: true, heightStyle: "content", collapsible: true,  active: $iAccordion, icons: false, animate:true }); // collapsible will be enabled once the item will be selected
+EOF
+					);
 				}
 			}
 			$oPage->AddToMenu('</div>');
@@ -181,11 +218,11 @@ class ApplicationMenu
 				$sHyperlink = $oMenu->GetHyperlink($aExtraParams);
 				if ($sHyperlink != '')
 				{
-					$oPage->AddToMenu('<li'.$sCSSClass.'><a href="'.$oMenu->GetHyperlink($aExtraParams).'">'.$oMenu->GetTitle().'</a></li>');
+					$oPage->AddToMenu('<li id="'.utils::GetSafeId('AccordionMenu_'.$oMenu->GetMenuID()).'"'.$sCSSClass.'><a href="'.$oMenu->GetHyperlink($aExtraParams).'">'.$oMenu->GetTitle().'</a></li>');
 				}
 				else
 				{
-					$oPage->AddToMenu('<li'.$sCSSClass.'>'.$oMenu->GetTitle().'</li>');
+					$oPage->AddToMenu('<li id="'.utils::GetSafeId('AccordionMenu_'.$oMenu->GetMenuID()).'"'.$sCSSClass.'>'.$oMenu->GetTitle().'</li>');
 				}
 				$aCurrentMenu = self::$aMenusIndex[$index];
 				if ($iActiveMenu == $index)
@@ -230,11 +267,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)
@@ -256,23 +293,49 @@ 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)
+		{
+			$sMenuId = self::GetDefaultMenuId();
+		}
+		return $sMenuId;
+	}	
+
+	static public function GetDefaultMenuId()
+	{
+		static $sDefaultMenuId = null;
+		if (is_null($sDefaultMenuId))
 		{
 			// 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']);
+			$sDefaultMenuId = $oMenuNode->GetMenuId();
 		}
-		return $iMenuIndex;
-	}	
+		return $sDefaultMenuId;
+	}
+
+	static public function GetRootMenuId($sMenuId)
+	{
+		$iMenuIndex = self::GetMenuIndexById($sMenuId);
+		if ($iMenuIndex == -1)
+		{
+			return '';
+		}
+		$oMenu = ApplicationMenu::GetMenuNode($iMenuIndex);
+		while ($oMenu->GetParentIndex() != -1)
+		{
+			$oMenu = ApplicationMenu::GetMenuNode($oMenu->GetParentIndex());
+		}
+		return $oMenu->GetMenuId();
+	}
 }
 
 /**
@@ -305,6 +368,7 @@ abstract class MenuNode
 {
 	protected $sMenuId;
 	protected $index;
+	protected $iParentIndex;
 
 	/**
 	 * Properties reflecting how the node has been declared
@@ -345,6 +409,7 @@ 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->iParentIndex = $iParentIndex;
 		$this->aReflectionProperties = array();
 		if (strlen($sEnableClass) > 0)
 		{
@@ -369,15 +434,34 @@ abstract class MenuNode
 	{
 		return $this->sMenuId;
 	}
-	
+
+	public function GetParentIndex()
+	{
+		return $this->iParentIndex;
+	}
+
 	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+");
+		$sRet = Dict::S("Menu:$this->sMenuId+", "");
+		if ($sRet === '')
+		{
+			if ($this->iParentIndex != -1)
+			{
+				$oParentMenu = ApplicationMenu::GetMenuNode($this->iParentIndex);
+				$sRet = $oParentMenu->GetTitle().' / '.$this->GetTitle();
+			}
+			else
+			{
+				$sRet = $this->GetTitle();
+			}
+			//$sRet = $this->GetTitle();
+		}
+		return $sRet;
 	}
 	
 	public function GetIndex()
@@ -385,9 +469,19 @@ 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);
 	}
 	
@@ -528,6 +622,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);
 		}
@@ -547,6 +642,7 @@ class OQLMenuNode extends MenuNode
 	protected $sPageTitle;
 	protected $sOQL;
 	protected $bSearch;
+	protected $bSearchFormOpen;
 	
 	/**
 	 * Extra parameters to be passed to the display block to fine tune its appearence
@@ -566,12 +662,20 @@ class OQLMenuNode extends MenuNode
 	 * @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, $sOQL, $iParentIndex, $fRank = 0, $bSearch = false, $sEnableClass = null, $iActionCode = null, $iAllowedResults = UR_ALLOWED_YES, $sEnableStimulus = null)
+	public function __construct($sMenuId, $sOQL, $iParentIndex, $fRank = 0, $bSearch = false, $sEnableClass = null, $iActionCode = null, $iAllowedResults = UR_ALLOWED_YES, $sEnableStimulus = null, $bSearchFormOpen = null)
 	{
 		parent::__construct($sMenuId, $iParentIndex, $fRank, $sEnableClass, $iActionCode, $iAllowedResults, $sEnableStimulus);
 		$this->sPageTitle = "Menu:$sMenuId+";
 		$this->sOQL = $sOQL;
 		$this->bSearch = $bSearch;
+		if ($bSearchFormOpen == null)
+		{
+			$this->bSearchFormOpen = MetaModel::GetConfig()->Get('legacy_search_drawer_open');
+		}
+		else
+		{
+			$this->bSearchFormOpen = $bSearchFormOpen;
+		}
 		$this->m_aParams = array();
 		$this->aReflectionProperties['oql'] = $sOQL;
 		$this->aReflectionProperties['do_search'] = $bSearch;
@@ -594,43 +698,49 @@ class OQLMenuNode extends MenuNode
 	
 	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
+			$this->bSearchFormOpen, // Search open
+			$oPage, 
+			array_merge($this->m_aParams, $aExtraParams),
+			true
+		);
+	}
 
-		if ($this->bSearch)
+	public static function RenderOQLSearch($sOql, $sTitle, $sUsageId, $bSearchPane, $bSearchOpen, WebPage $oPage, $aExtraParams = array(), $bEnableBreadcrumb = false)
+	{
+		$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))
+		
+		$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);
+
+		if ($bEnableBreadcrumb && ($oPage instanceof iTopWebPage))
 		{
-			$sParams = 'parameters="';
-			foreach($this->m_aParams as $sName => $sValue)
-			{
-				$sParams .= $sName.':'.$sValue.';';
-			}
-			$sParams .= '"';
+			// Breadcrumb
+			//$iCount = $oBlock->GetDisplayedCount();
+			$sPageId = "ui-search-".$oSearch->GetClass();
+			$sLabel = MetaModel::GetName($oSearch->GetClass());
+			$oPage->SetBreadCrumbEntry($sPageId, $sLabel, $sTitle, '', '../images/breadcrumb-search.png');
 		}
-		$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);
 	}
 }
+
 /**
  * This class defines a menu item that displays a search form for the given class of objects
  */
@@ -658,15 +768,15 @@ class SearchMenuNode extends MenuNode
 		$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);
+		$oPage->SetBreadCrumbEntry("menu-".$this->sMenuId, $this->GetTitle(), '', '', utils::GetAbsoluteUrlAppRoot().'images/search.png');
+
+		$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);
 	}
 }
 
@@ -701,7 +811,7 @@ class WebPageMenuNode extends MenuNode
 
 	public function GetHyperlink($aExtraParams)
 	{
-		$aExtraParams['c[menu]'] = $this->GetIndex();
+		$aExtraParams['c[menu]'] = $this->GetMenuId();
 		return $this->AddParams( $this->sHyperlink, $aExtraParams);
 	}
 	
@@ -740,7 +850,7 @@ class NewObjectMenuNode extends MenuNode
 	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);
 	}
 
@@ -771,4 +881,264 @@ 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
+			{
+				$oParentMenu = ApplicationMenu::GetMenuNode($this->iParentIndex);
+				$sParentTitle = $oParentMenu->GetTitle();
+				$sThisTitle = $this->GetTitle();
+				if ($sParentTitle != $sThisTitle)
+				{
+					$sDescription = $sParentTitle.' / '.$sThisTitle;
+				}
+				else
+				{
+					$sDescription = $sThisTitle;
+				}
+				if ($this->sMenuId == ApplicationMenu::GetDefaultMenuId())
+				{
+					$sIcon = '../images/breadcrumb_home.png';
+				}
+				else
+				{
+					$sIcon = '../images/breadcrumb-dashboard.png';
+				}
+				$oPage->SetBreadCrumbEntry("ui-dashboard-".$this->sMenuId, $this->GetTitle(), $sDescription, '', $sIcon);
+			}
+		}
+		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
+		{
+			throw new Exception("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-2016 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-2016 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)
+    public function __construct($s_title, $bPrintable = false)
     {
-        parent::__construct($s_title);
+        parent::__construct($s_title, $bPrintable);
 		$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/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);');
-    }
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery-1.10.0.min.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery-migrate-1.2.1.min.js'); // Needed since many other plugins still rely on oldies like $.browser
+		$this->add_linked_stylesheet(utils::GetAbsoluteUrlAppRoot().'css/ui-lightness/jquery-ui-1.10.3.custom.min.css');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery-ui-1.10.3.custom.min.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/hovertip.js');
+		// table sorting
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.tablesorter.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.tablesorter.pager.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.tablehover.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/field_sorter.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/datatable.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.positionBy.js');
+		$this->add_linked_script(utils::GetAbsoluteUrlAppRoot().'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_saas("css/light-grey.scss");
+
+		$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/pdfpage.class.inc.php

@@ -0,0 +1,194 @@
+<?php
+require_once(APPROOT.'lib/tcpdf/tcpdf.php');
+
+/**
+ * Custom class derived from TCPDF for providing custom headers and footers
+ * @author denis
+ *
+ */
+class iTopPDF extends TCPDF
+{
+	protected $sDocumentTitle;
+	
+	public function SetDocumentTitle($sDocumentTitle)
+	{
+		$this->sDocumentTitle = $sDocumentTitle;
+	}
+
+	/**
+	 * Builds the custom header. Called for each new page.
+	 * @see TCPDF::Header()
+	 */
+	public function Header()
+	{
+		// Title
+		// Set font
+		$this->SetFont('dejavusans', 'B', 10);
+		
+		$iPageNumberWidth = 25;
+		$aMargins = $this->getMargins();
+		
+		// Display the title (centered)
+		$this->SetXY($aMargins['left'] + $iPageNumberWidth, 0);
+		$this->MultiCell($this->getPageWidth() - $aMargins['left'] - $aMargins['right'] - 2*$iPageNumberWidth, 15, $this->sDocumentTitle, 0, 'C', false, 0 /* $ln */, '', '', true, 0, false, true, 15, 'M' /* $valign */);
+		$this->SetFont('dejavusans', '', 10);
+		
+		// Display the page number (right aligned)
+		// Warning: the 'R'ight alignment does not work when using placeholders like $this->getAliasNumPage() or $this->getAliasNbPages()
+		$this->MultiCell($iPageNumberWidth, 15, 'Page '.$this->page, 0, 'R', false, 0 /* $ln */, '', '', true, 0, false, true, 15, 'M' /* $valign */);
+		
+		// Branding logo
+		$sBrandingIcon = APPROOT.'images/itop-logo.png';
+		if (file_exists(MODULESROOT.'branding/main-logo.png'))
+		{
+			$sBrandingIcon = MODULESROOT.'branding/main-logo.png';
+		}
+		$this->Image($sBrandingIcon, $aMargins['left'], 5, 0, 10);
+	}
+
+	// Page footer
+	public function Footer()
+	{
+		// No footer
+	}
+}
+
+/**
+ * Special class of WebPage for printing into a PDF document
+ */
+class PDFPage extends WebPage
+{
+	/**
+	 * Instance of the TCPDF object for creating the PDF
+	 * @var TCPDF
+	 */
+	protected $oPdf;
+	
+	public function __construct($s_title, $sPageFormat = 'A4', $sPageOrientation = 'L')
+	{
+		parent::__construct($s_title);
+		define(K_PATH_FONTS, APPROOT.'lib/tcpdf/fonts');
+		$this->oPdf = new iTopPDF($sPageOrientation, 'mm', $sPageFormat, true, 'UTF-8', false);
+		
+		// set document information
+		$this->oPdf->SetCreator(PDF_CREATOR);
+		$this->oPdf->SetAuthor('iTop');
+		$this->oPdf->SetTitle($s_title);
+		$this->oPdf->SetDocumentTitle($s_title);
+		
+		$this->oPdf->setFontSubsetting(true);
+		
+		// Set font
+		// dejavusans is a UTF-8 Unicode font. Standard PDF fonts like helvetica or times new roman are NOT UTF-8
+		$this->oPdf->SetFont('dejavusans', '', 10, '', true);
+		
+		// set auto page breaks
+		$this->oPdf->SetAutoPageBreak(true, 15); // 15 mm break margin at the bottom
+		$this->oPdf->SetTopMargin(15);
+		
+		// Add a page, we're ready to start
+		$this->oPdf->AddPage();
+		
+		$this->SetContentDisposition('inline', $s_title.'.pdf');
+		$this->SetDefaultStyle();
+		
+	}
+	
+	/**
+	 * Sets a default style (suitable for printing) to be included each time $this->oPdf->writeHTML() is called
+	 */
+	protected function SetDefaultStyle()
+	{
+		$this->add_style(
+<<<EOF
+table {
+	padding: 2pt;
+}
+table.listResults td {
+	border: 0.5pt solid #000 ;
+}
+table.listResults th {
+	background-color: #eee;
+	border: 0.5pt solid #000 ;
+}
+a {
+	text-decoration: none;
+	color: #000;
+}
+table.section td {
+	vertical-align: middle;
+	font-size: 10pt;
+	background-color:#eee;
+}
+td.icon {
+	width: 30px;
+}
+EOF
+		);		
+	}
+	
+	/**
+	 * Get access to the underlying TCPDF object
+	 * @return TCPDF
+	 */
+	public function get_tcpdf()
+	{
+		$this->flush();
+		return $this->oPdf;
+	}
+	
+	/**
+	 * Writes the currently buffered HTML content into the PDF. This can be useful:
+	 * - to sync the flow in case you want to access the underlying TCPDF object for some specific/graphic output
+	 * - to process the HTML by smaller chunks instead of processing the whole page at once for performance reasons
+	 */
+	public function flush()
+	{
+		if (strlen($this->s_content) > 0)
+		{
+			$sHtml = '';
+			if (count($this->a_styles) > 0)
+			{
+				$sHtml .= "<style>\n".implode("\n", $this->a_styles)."\n</style>\n";
+			}
+			$sHtml .= $this->s_content;
+			$this->oPdf->writeHTML($sHtml); // The style(s) must be supplied each time we call writeHtml
+			$this->s_content = '';
+		}
+	}
+	
+	/**
+	 * Whether or not the page is a PDF page
+	 * @return boolean
+	 */
+	public function is_pdf()
+	{
+		return true;
+	}
+	
+	/**
+	 * Generates the PDF document and returns the PDF content as a string
+	 * @return string
+	 * @see WebPage::output()
+	 */
+	public function output()
+	{
+		$this->add_header('Content-type: application/x-pdf');
+    	if (!empty($this->sContentDisposition))
+    	{
+			$this->add_header('Content-Disposition: '.$this->sContentDisposition.'; filename="'.$this->sContentFileName.'"');
+    	}
+    	foreach($this->a_headers as $s_header)
+        {
+            header($s_header);
+        }
+        $this->flush();
+		echo $this->oPdf->Output($this->s_title.'.pdf', 'S');
+	}
+	
+	public function get_pdf()
+	{
+		$this->flush();
+		return $this->oPdf->Output($this->s_title.'.pdf', 'S');
+	}
+}

application/portaldispatcher.class.inc.php

@@ -0,0 +1,66 @@
+<?php
+class PortalDispatcher
+{
+	protected $sPortalid;
+	protected $aData;
+	
+	public function __construct($sPortalId)
+	{
+		$this->sPortalid = $sPortalId;
+		$this->aData = PortalDispatcherData::GetData($sPortalId);
+	}
+	
+	public function IsUserAllowed()
+	{
+		$bRet = true;
+		$aProfiles = UserRights::ListProfiles();
+		
+		foreach($this->aData['deny'] as $sDeniedProfile)
+		{
+			// If one denied profile is present, it's enough => return false
+			if (in_array($sDeniedProfile, $aProfiles))
+			{
+				return false;
+			}
+		}
+		// If there are some "allow" profiles, then by default the result is false
+		// since the user must have at least one of the profiles to be allowed
+		if (count($this->aData['allow']) > 0)
+		{
+			$bRet = false;
+		}
+		foreach($this->aData['allow'] as $sAllowProfile)
+		{
+			// If one "allow" profile is present, it's enough => return true
+			if (in_array($sAllowProfile, $aProfiles))
+			{
+				return true;
+			}
+		}
+		return $bRet;
+	}
+	
+	public function GetURL()
+	{
+		$aOverloads = MetaModel::GetConfig()->Get('portal_dispatch_urls');
+		if (array_key_exists($this->sPortalid, $aOverloads))
+		{
+			$sRet = $aOverloads[$this->sPortalid];
+		}
+		else
+		{
+			$sRet = utils::GetAbsoluteUrlAppRoot().$this->aData['url'];
+		}
+		return $sRet;
+	}
+	
+	public function GetLabel()
+	{
+		return Dict::S('portal:'.$this->sPortalid);
+	}
+	
+	public function GetRank()
+	{
+		return $this->aData['rank'];
+	}
+}

application/portalwebpage.class.inc.php

@@ -1,26 +1,26 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2017 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-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT."/application/nicewebpage.class.inc.php");
@@ -49,9 +49,12 @@ class PortalWebPage extends NiceWebPage
 	 */
 	protected $m_sWelcomeMsg;
 	protected $m_aMenuButtons;
+	protected $m_oCtx;
+	
 	
     public function __construct($sTitle, $sAlternateStyleSheet = '')
     {
+    	$this->m_oCtx = new ContextTag('GUI:Portal');
     	$this->m_sWelcomeMsg = '';
     	$this->m_aMenuButtons = array();
         parent::__construct($sTitle);
@@ -59,9 +62,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 +91,94 @@ 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.js');
+		$this->add_linked_script("../js/ajaxfileupload.js");
+		$this->add_linked_script("../js/ckeditor/ckeditor.js");
+		$this->add_linked_script("../js/ckeditor/adapters/jquery.js");
+
+		$this->add_linked_script("../js/jquery-ui-timepicker-addon.js");
+		$this->add_linked_script("../js/jquery-ui-timepicker-addon-i18n.min.js");
+		$this->add_linked_stylesheet("../css/jquery-ui-timepicker-addon.css");
+
+		$sJSDisconnectedMessage = json_encode(Dict::S('UI:DisconnectedDlgMessage'));
+		$sJSTitle = json_encode(Dict::S('UI:DisconnectedDlgTitle'));
+		$sJSLoginAgain = json_encode(Dict::S('UI:LoginAgain'));
+		$sJSStayOnThePage = json_encode(Dict::S('UI:StayOnThePage'));
+		$aDaysMin = array(Dict::S('DayOfWeek-Sunday-Min'), Dict::S('DayOfWeek-Monday-Min'), Dict::S('DayOfWeek-Tuesday-Min'), Dict::S('DayOfWeek-Wednesday-Min'),
+			Dict::S('DayOfWeek-Thursday-Min'), Dict::S('DayOfWeek-Friday-Min'), Dict::S('DayOfWeek-Saturday-Min'));
+		$aMonthsShort = array(Dict::S('Month-01-Short'), Dict::S('Month-02-Short'), Dict::S('Month-03-Short'), Dict::S('Month-04-Short'), Dict::S('Month-05-Short'), Dict::S('Month-06-Short'),
+			Dict::S('Month-07-Short'), Dict::S('Month-08-Short'), Dict::S('Month-09-Short'), Dict::S('Month-10-Short'), Dict::S('Month-11-Short'), Dict::S('Month-12-Short'));
+		$sTimeFormat = AttributeDateTime::GetFormat()->ToTimeFormat();
+		$oTimeFormat = new DateTimeFormat($sTimeFormat);
+		$sJSLangShort = json_encode(strtolower(substr(Dict::GetUserLanguage(), 0, 2)));
+
+		// Date picker options
+		$aPickerOptions = array(
+			'showOn' => 'button',
+			'buttonImage' => '../images/calendar.png',
+			'buttonImageOnly' => true,
+			'dateFormat' => AttributeDate::GetFormat()->ToDatePicker(),
+			'constrainInput' => false,
+			'changeMonth' => true,
+			'changeYear' => true,
+			'dayNamesMin' => $aDaysMin,
+			'monthNamesShort' => $aMonthsShort,
+			'firstDay' => (int) Dict::S('Calendar-FirstDayOfWeek'),
+		);
+		$sJSDatePickerOptions = json_encode($aPickerOptions);
+
+		// Time picker additional options
+		$aPickerOptions['showOn'] = '';
+		$aPickerOptions['buttonImage'] = null;
+		$aPickerOptions['timeFormat'] = $oTimeFormat->ToDatePicker();
+		$aPickerOptions['controlType'] = 'select';
+		$aPickerOptions['closeText'] = 	Dict::S('UI:Button:Ok');
+		$sJSDateTimePickerOptions = json_encode($aPickerOptions);
+		if ($sJSLangShort != '"en"')
+		{
+			// More options that cannot be passed via json_encode since they must be evaluated client-side
+			$aMoreJSOptions = ",
+				'timeText': $.timepicker.regional[$sJSLangShort].timeText,
+				'hourText': $.timepicker.regional[$sJSLangShort].hourText,
+				'minuteText': $.timepicker.regional[$sJSLangShort].minuteText,
+				'secondText': $.timepicker.regional[$sJSLangShort].secondText,
+				'currentText': $.timepicker.regional[$sJSLangShort].currentText
+			}";
+			$sJSDateTimePickerOptions = substr($sJSDateTimePickerOptions, 0, -1).$aMoreJSOptions;
+		}
+		$this->add_script(
+			<<< EOF
+				function PrepareWidgets()
+	{
+		// note: each action implemented here must be idempotent,
+		//       because this helper function might be called several times on a given page 
+	
+		$(".date-pick").datepicker($sJSDatePickerOptions);
+	
+		// Hack for the date and time picker addon issue on Chrome (see #1305)
+		// The workaround is to instantiate the widget on demand
+		// It relies on the same markup, thus reverting to the original implementation should be straightforward
+		$(".datetime-pick:not(.is-widget-ready)").each(function(){
+			var oInput = this;
+			$(oInput).addClass('is-widget-ready');
+			$('<img class="datetime-pick-button" src="../images/calendar.png">')
+				.insertAfter($(this))
+				.on('click', function(){
+					$(oInput)
+						.datetimepicker($sJSDateTimePickerOptions)
+						.datetimepicker('show')
+						.datetimepicker('option', 'onClose', function(dateText,inst){
+							$(oInput).datetimepicker('destroy');
+						})
+						.on('click keypress', function(){
+							$(oInput).datetimepicker('hide');
+						});
+				});
+		});
+	}
+EOF
+		);
+		
 		$this->add_ready_script(
 <<<EOF
 try
@@ -125,17 +219,29 @@ try
 	    } 
 	});
 		
-	$(".date-pick").datepicker({
-			showOn: 'button',
-			buttonImage: '../images/calendar.png',
-			buttonImageOnly: true,
-			dateFormat: 'yy-mm-dd',
-			constrainInput: false,
-			changeMonth: true,
-			changeYear: true
-		});
+	PrepareWidgets();
+
 	//$('.resizable').resizable(); // Make resizable everything that claims to be resizable !
-	$('.caselog_header').click( function () { $(this).toggleClass('open').next('.caselog_entry').toggle(); });
+	$('.caselog_header').click( function () { $(this).toggleClass('open').next('.caselog_entry,.caselog_entry_html').toggle(); });
+			
+	$(document).ajaxSend(function(event, jqxhr, options) {
+		jqxhr.setRequestHeader('X-Combodo-Ajax', 'true');
+	});
+	$(document).ajaxError(function(event, jqxhr, options) {
+		if (jqxhr.status == 401)
+		{
+			$('<div>'+$sJSDisconnectedMessage+'</div>').dialog({
+				modal:true,
+				title: $sJSTitle,
+				close: function() { $(this).remove(); },
+				minWidth: 400,
+				buttons: [
+				{ text: $sJSLoginAgain, click: function() { window.location.href= GetAbsoluteUrlAppRoot()+'pages/UI.php' } },
+				{ text: $sJSStayOnThePage, click: function() { $(this).dialog('close'); } }
+				]
+			});
+		}
+	});
 }
 catch(err)
 {
@@ -172,6 +278,11 @@ EOF
 		return '$sAbsURLAppRoot';
 	}
 	
+	function GetAbsoluteUrlModulesRoot()
+	{
+		return '$sAbsURLModulesRoot';
+	}
+
 	function AddAppContext(sURL)
 	{
 		var sContext = '$sAppContext';
@@ -201,7 +312,7 @@ EOF
 	{
 		var form = $('FORM');
 		form.unbind('submit'); // De-activate validation
-		window.location.href = '?operation=';
+		window.location.href = window.location.href.replace(/operation=[^&]*&?/, '');
 		return false;
 	}
 
@@ -210,11 +321,36 @@ EOF
 		var next_step = $('input[id=next_step]');
 		next_step.val(sStep);
 	}
+		
+	// For disabling the CKEditor at init time when the corresponding textarea is disabled !
+	CKEDITOR.plugins.add( 'disabler',
+	{
+		init : function( editor )
+		{
+			editor.on( 'instanceReady', function(e)
+			{
+				e.removeListener();
+				$('#'+ editor.name).trigger('update');
+			});
+		}
+		
+	});
 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 = '')
@@ -246,16 +382,31 @@ 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 class="app-message">';
+			$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)
 		{
-			$this->AddMenuButton('logoff', 'Portal:Disconnect', utils::GetAbsoluteUrlAppRoot().'pages/logoff.php'); // This menu is always present and is the last one
+			$this->AddMenuButton('logoff', 'Portal:Disconnect', utils::GetAbsoluteUrlAppRoot().'pages/logoff.php?operation=do_logoff'); // This menu is always present and is the last one
 		}
 		foreach($this->m_aMenuButtons as $aMenuItem)
 		{
 			$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();
 	}
 
@@ -277,7 +428,7 @@ EOF
 
 				$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, 'zlist' => false, 'extra_fields' => implode(',', $aZList)));
+				cmdbAbstractObject::DisplaySet($this, $oSet, array('currentId' => $sUniqueId, 'menu' => false, 'toolkit_menu' => false, 'zlist' => false, 'extra_fields' => implode(',', $aZList)));
 				$this->add("</div>\n");
 			}
 			else
@@ -373,7 +524,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);
 		}
@@ -383,8 +534,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))
 		{
@@ -415,7 +565,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
 		{
@@ -429,7 +579,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();
@@ -449,7 +616,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
 				{
@@ -486,9 +654,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(
@@ -505,13 +694,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");
@@ -590,7 +783,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++;
@@ -623,7 +816,7 @@ EOF
 		$sClass = get_class($oObj);
 
 		$sStimulus = trim(utils::ReadPostedParam('apply_stimulus', ''));
-		$sTargetState = '';
+		$aExpectedAttributes = array();
 		if (!empty($sStimulus))
 		{
 			// Compute the target state
@@ -633,10 +826,10 @@ EOF
 			{
 				throw new ApplicationException(Dict::Format('UI:Error:Invalid_Stimulus_On_Object_In_State', $sStimulus, $oObj->GetName(), $oObj->GetStateLabel()));
 			}
-			$sTargetState = $aTransitions[$sStimulus]['target_state'];
-		}
+			$aExpectedAttributes = $oObj->GetTransitionAttributes($sStimulus /*, current state*/);
+        }
 			
-		$oObj->UpdateObjectFromPostedForm('' /* form prefix */, $aAttList, $sTargetState);
+		$oObj->UpdateObjectFromPostedForm('' /* form prefix */, $aAttList, $aExpectedAttributes);
 
 		// Optional: apply a stimulus
 		//
@@ -648,26 +841,35 @@ 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");
+		}
+		$bLockEnabled = MetaModel::GetConfig()->Get('concurrent_lock_enabled');
+		if ($bLockEnabled)
+		{
+			// Release the concurrent lock, if any
+			$sOwnershipToken = utils::ReadPostedParam('ownership_token', null, false, 'raw_data');
+			if ($sOwnershipToken !== null)
+			{
+				// We're done, let's release the lock
+				iTopOwnershipLock::ReleaseLock(get_class($oObj), $oObj->GetKey(), $sOwnershipToken);
+			}
 		}
-
-		$this->p("<h1>".Dict::Format('UI:Class_Object_Updated', MetaModel::GetName(get_class($oObj)), $oObj->GetName())."</h1>\n");
 	}
 
 	/**
@@ -709,7 +911,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");
@@ -724,7 +926,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)
@@ -739,7 +941,7 @@ EOF
 		}
 
 		$sStepHistory = implode(',', $aPreviousSteps);
-		$this->add("<input type=\"hidden\" id=\"step_history\" name=\"step_history\" value=\"$sStepHistory\">");
+		$this->add("<input type=\"hidden\" id=\"step_history\" name=\"step_history\" value=\"".htmlentities($sStepHistory, ENT_QUOTES, 'UTF-8')."\">");
 
 		if (!is_null($sNextStep))
 		{		
@@ -762,7 +964,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

@@ -1,28 +1,29 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2015 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-2015 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 abstract class Query extends cmdbAbstractObject
@@ -46,13 +47,13 @@ abstract class Query extends cmdbAbstractObject
 		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 AttributeString("fields", array("allowed_values"=>null, "sql"=>"fields", "default_value"=>null, "is_null_allowed"=>true, "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')); // Criteria of the std search form
+		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
 	}
 }
@@ -81,26 +82,59 @@ class QueryOQL extends Query
 		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')); // Criteria of the std search form
+		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())
 	{
-		parent::DisplayBareProperties($oPage, $bEditMode, $sPrefix, $aExtraParams);
+		$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');
-			$oSearch = DBObjectSearch::FromOQL($sOql);
-			$aParameters = $oSearch->GetQueryParams();
-			foreach($aParameters as $sParam => $val)
+			$sFields = trim($this->Get('fields'));
+			$bExportV1Recommended = ($sFields == '');
+			if ($bExportV1Recommended)
 			{
-				$sUrl .= '&arg_'.$sParam.'=["'.$sParam.'"]';
+				$oFieldAttDef = MetaModel::GetAttributeDef('QueryOQL', 'fields');
+				$oPage->add('<div class="message message_error" style="padding-left: 30px;"><div style="padding: 10px;">'.Dict::Format('UI:Query:UrlV1', $oFieldAttDef->GetLabel()).'</div></div>');
+				$sUrl = utils::GetAbsoluteUrlAppRoot().'webservices/export.php?format=spreadsheet&login_mode=basic&query='.$this->GetKey();
+			}
+			else 
+			{
+				$sUrl = utils::GetAbsoluteUrlAppRoot().'webservices/export-v2.php?format=spreadsheet&login_mode=basic&date_format='.urlencode((string)AttributeDateTime::GetFormat()).'&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);
 			}
-			$oPage->p(Dict::S('UI:Query:UrlForExcel').':<br/><textarea cols="80" rows="3" READONLY>'.$sUrl.'</textarea>');		
 		}
+		return $aFieldsMap;
 	}
 }
 

application/shortcut.class.inc.php

@@ -0,0 +1,338 @@
+<?php
+// Copyright (C) 2010-2016 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-2016 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, true);
+		}
+		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 DesignerIntegerField('auto_reload_sec', Dict::S('Class:ShortcutOQL/Attribute:auto_reload_sec'), MetaModel::GetConfig()->GetStandardReloadInterval());
+		$oField->SetBoundaries(MetaModel::GetConfig()->Get('min_reload_interval'), null); // no upper limit
+		$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::Format('Class:ShortcutOQL/Attribute:auto_reload_sec/tip', MetaModel::GetConfig()->Get('min_reload_interval')));
+
+		$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,531 +0,0 @@
-<?php
-// Copyright (C) 2010 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 program 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.
-//
-//   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
-
-/**
- * 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
- */
-
-
-require_once(APPROOT.'/application/webpage.class.inc.php');
-require_once(APPROOT.'/application/utils.inc.php');
-
-require_once(APPROOT.'/pages/php-ofc-library/open-flash-chart.php');
-
-/**
- * Helper class to design optimized dashboards, based on an SQL query
- *  
- */
-class SqlBlock
-{
-	protected $m_sQuery;
-	protected $m_aColumns;
-	protected $m_sTitle;
-	protected $m_sType;
-	protected $m_aParams;
-	                            
-	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;
-	}
-	
-	/**
-	 * Constructs a SqlBlock object from an XML template
-	/*
-	 *
-	 *		<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') 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>
-	 *				<drilldown></drilldown>
-	 *			</column>
-	 *			<column>
-	 *				<name>Count</name>
-	 *				<label>UserRequest:Overview-Count</label>
-	 *				<drilldown>SELECT UserIssue WHERE date_format(start_date, '%d') = :Date</drilldown>
-	 *			</column>
-	 *		</sqlblock>
-	 *
-	 * Tags
-	 * - 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
-	 * - column / drilldown: NOT IMPLEMENTED YET - OQL with parameters corresponding to column names (in the query)
-	 *
-	 * @param $sTemplate string The XML template
-	 * @return DisplayBlock The DisplayBlock object, or null if the template is invalid
-	 */
-	public static function FromTemplate($sTemplate)
-	{
-		$oXml = simplexml_load_string('<root>'.$sTemplate.'</root>', 'SimpleXMLElement', LIBXML_NOCDATA);
-		if (false)
-		{
-			// Debug
-			echo "<pre>\n";
-			print_r($oXml);
-			echo "</pre>\n";
-		}
-
-		if (isset($oXml->title))
-		{
-			$sTitle = (string)$oXml->title;
-		}
-		if (isset($oXml->type))
-		{
-			$sType = (string)$oXml->type;
-		}
-		else
-		{
-			$sType = 'table';
-		}
-		if (!isset($oXml->sql))
-		{
-			throw new Exception('Missing tag "sql" in sqlblock');
-		}
-		$sQuery = (string)$oXml->sql;
-
-		$aColumns = array();
-		if (isset($oXml->column))
-		{
-			foreach ($oXml->column AS $oColumnData)
-			{
-				if (!isset($oColumnData->name))
-				{
-					throw new Exception("Missing tag 'name' in sqlblock/column");
-				}
-				$sName = (string) $oColumnData->name;
-				if (strlen($sName) == 0)
-				{
-					throw new Exception("Empty tag 'name' in sqlblock/column");
-				}
-
-				$aColumns[$sName] = array();
-				if (isset($oColumnData->label))
-				{
-					$sLabel = (string)$oColumnData->label;
-					if (strlen($sLabel) > 0)
-					{
-						$aColumns[$sName]['label'] = Dict::S($sLabel);
-					}
-				}
-				if (isset($oColumnData->drilldown))
-				{
-					$sDrillDown = (string)$oColumnData->drilldown;
-					if (strlen($sDrillDown) > 0)
-					{
-						$aColumns[$sName]['drilldown'] = $sDrillDown;
-					}
-				}
-			}
-		}
-		$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())
-	{
-		if (empty($aExtraParams['currentId']))
-		{
-			$sId = 'sqlblock_'.$oPage->GetUniqueId(); // Works only if the page is not an Ajax one !
-		}
-		else
-		{
-			$sId = $aExtraParams['currentId'];
-		}
-//		$oPage->add($this->GetRenderContent($oPage, $aExtraParams, $sId));
-
-		$sQuery = $this->BuildQuery();
-		$res = CMDBSource::Query($sQuery);
-		$aQueryCols = CMDBSource::GetColumns($res);
-
-		// Prepare column definitions (check + give default values)
-		//
-		foreach($this->m_aColumns as $sName => $aColumnData)
-		{
-			if (!in_array($sName, $aQueryCols))
-			{
-				throw new Exception("Unknown column name '$sName' in sqlblock column");
-			}
-			if (!isset($aColumnData['label']))
-			{
-				$this->m_aColumns[$sName]['label'] = $sName;
-			}
-			if (isset($aColumnData['drilldown']) && !empty($aColumnData['drilldown']))
-			{
-				// Check if the OQL is valid
-				try
-				{
-					$this->m_aColumns[$sName]['filter'] = DBObjectSearch::FromOQL($aColumnData['drilldown']);
-				}
-				catch(OQLException $e)
-				{
-					unset($aColumnData['drilldown']);
-				}
-			}
-		}
-
-		if (strlen($this->m_sTitle) > 0)
-		{
-			$oPage->add("<h2>".Dict::S($this->m_sTitle)."</h2>\n");
-		}
-
-		switch ($this->m_sType)
-		{
-		case 'bars':
-		case 'pie':
-			$aColNames = array_keys($this->m_aColumns);
-			$sXColName = $aColNames[0];
-			$sYColName = $aColNames[1]; 
-			$aData = array();
-			$aRows = array();
-			while($aRow = CMDBSource::FetchArray($res))
-			{
-				$aData[$aRow[$sXColName]] = $aRow[$sYColName];
-				$aRows[$aRow[$sXColName]] = $aRow;
-			}
-			$this->RenderChart($oPage, $sId, $aData, $this->m_aColumns[$sYColName]['drilldown'], $aRows);
-			break;
-
-		default:
-		case 'table':
-			$oAppContext = new ApplicationContext();
-			$sContext = $oAppContext->GetForLink();
-			if (!empty($sContext))
-			{
-				$sContext = '&'.$sContext;
-			}
-			$aDisplayConfig = array();
-			foreach($this->m_aColumns as $sName => $aColumnData)
-			{
-				$aDisplayConfig[$sName] = array('label' => $aColumnData['label'], 'description' => '');
-			}
-	
-			$aDisplayData = array();
-			while($aRow = CMDBSource::FetchArray($res))
-			{
-				$aSQLColNames = array_keys($aRow);
-				$aDisplayRow = array();
-				foreach($this->m_aColumns as $sName => $aColumnData)
-				{
-					if (isset($aColumnData['filter']))
-					{
-						$sFilter = $aColumnData['drilldown'];
-						$sClass = $aColumnData['filter']->GetClass();
-						$sFilter = str_replace('SELECT '.$sClass, '', $sFilter);
-						foreach($aSQLColNames as $sColName)
-						{
-							$sFilter = str_replace(':'.$sColName, "'".addslashes( $aRow[$sColName] )."'", $sFilter);
-						}
-						$sURL = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=search_oql&search_form=0&oql_class='.$sClass.'&oql_clause='.urlencode($sFilter).'&format=html'.$sContext;
-						$aDisplayRow[$sName] = '<a href="'.$sURL.'">'.$aRow[$sName]."</a>";					
-					}
-					else
-					{
-						$aDisplayRow[$sName] = $aRow[$sName];
-					}
-				}
-				$aDisplayData[] = $aDisplayRow;
-			}
-			$oPage->table($aDisplayConfig, $aDisplayData);
-			break;
-		}
-	}
-	
-	public function GetRenderContent(WebPage $oPage, $aExtraParams = array(), $sId)
-	{
-		$sHtml = '';
-		return $sHtml;
-	}
-
-	protected function RenderChart($oPage, $sId, $aValues, $sDrillDown = '', $aRows = array())
-	{
-		// 1- Compute Open Flash Chart data
-		//
-		$aValueKeys = array();
-		$index = 0;
-		if ((count($aValues) > 0) && ($sDrillDown != ''))
-		{
-			$oFilter = DBObjectSearch::FromOQL($sDrillDown);
-			$sClass = $oFilter->GetClass();
-			$sOQLClause = str_replace('SELECT '.$sClass, '', $sDrillDown);
-			$aSQLColNames = array_keys(current($aRows)); // Read the list of columns from the current (i.e. first) element of the array
-			$oAppContext = new ApplicationContext();
-			$sURL = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=search_oql&search_form=0&oql_class='.$sClass.'&format=html&'.$oAppContext->GetForLink().'&oql_clause=';				
-		}
-		$aURLs = array();
-		foreach($aValues as $key => $value)
-		{
-			// Make sure that values are integers (so that max() will work....)
-			// and build an array of STRING with the keys (numeric keys are transformed into string by PHP :-(
-			$aValues[$key] = (int)$value;
-			$aValueKeys[] = (string)$key;
-			
-			// Build the custom query for the 'drill down' on each element
-			if ($sDrillDown != '')
-			{
-				$sFilter = $sOQLClause;
-				foreach($aSQLColNames as $sColName)
-				{
-					$sFilter = str_replace(':'.$sColName, "'".addslashes( $aRows[$key][$sColName] )."'", $sFilter);
-					$aURLs[$index] = $sURL.urlencode($sFilter);
-				}
-			}
-			$index++;
-		}
-	
-		$oChart = new open_flash_chart();
-	
-		if ($this->m_sType == 'bars')
-		{
-			$oChartElement = new bar_glass();
-		
-			if (count($aValues) > 0)
-			{
-				$maxValue = max($aValues);
-			}
-			else
-			{
-				$maxValue = 1;
-			}
-			$oYAxis = new y_axis();
-			$aMagicValues = array(1,2,5,10);
-			$iMultiplier = 1;
-			$index = 0;
-			$iTop = $aMagicValues[$index % count($aMagicValues)]*$iMultiplier;
-			while($maxValue > $iTop)
-			{
-				$index++;
-				$iTop = $aMagicValues[$index % count($aMagicValues)]*$iMultiplier;
-				if (($index % count($aMagicValues)) == 0)
-				{
-					$iMultiplier = $iMultiplier * 10;
-				}
-			}
-			//echo "oYAxis->set_range(0, $iTop, $iMultiplier);\n";
-			$oYAxis->set_range(0, $iTop, $iMultiplier);
-			$oChart->set_y_axis( $oYAxis );
-			$aBarValues = array();
-			foreach($aValues as $iValue)
-			{
-				$oBarValue = new bar_value($iValue);
-				$oBarValue->on_click("ofc_drilldown_{$sId}");
-				$aBarValues[] = $oBarValue;
-			}
-			$oChartElement->set_values($aBarValues);	
-			//$oChartElement->set_values(array_values($aValues));
-			$oXAxis = new x_axis();
-			$oXLabels = new x_axis_labels();
-			// set them vertical
-			$oXLabels->set_vertical();
-			// set the label text
-			$oXLabels->set_labels($aValueKeys);
-			// Add the X Axis Labels to the X Axis
-			$oXAxis->set_labels( $oXLabels );
-			$oChart->set_x_axis( $oXAxis );
-		}
-		else
-		{
-			$oChartElement = new pie();
-			$oChartElement->set_start_angle( 35 );
-			$oChartElement->set_animate( true );
-			$oChartElement->set_tooltip( '#label# - #val# (#percent#)' );
-			$oChartElement->set_colours( array('#FF8A00', '#909980', '#2C2B33', '#CCC08D', '#596664') );
-	
-			$aData = array();
-			foreach($aValues as $sValue => $iValue)
-			{
-				$oPieValue = new pie_value($iValue, $sValue); //@@ BUG: not passed via ajax !!!
-				$oPieValue->on_click("ofc_drilldown_{$sId}");
-				$aData[] = $oPieValue;
-			}
-	
-			$oChartElement->set_values( $aData );
-			$oChart->x_axis = null;
-		}
-	
-		// Title given in HTML
-		//$oTitle = new title($this->m_sTitle);
-		//$oChart->set_title($oTitle);
-		$oChart->set_bg_colour('#FFFFFF');
-		$oChart->add_element( $oChartElement );
-			
-		$sData = $oChart->toPrettyString();
-		$sData = json_encode($sData);
-
-		// 2- Declare the Javascript function that will render the chart data\
-		//
-		$oPage->add_script(
-<<< EOF
-function ofc_get_data_{$sId}()
-{
-	return $sData;
-}
-EOF
-		);
-		
-		if (count($aURLs) > 0)
-		{
-			$sURLList = '';
-			foreach($aURLs as $index => $sURL)
-			{
-				$sURLList .= "\taURLs[$index] = '".addslashes($sURL)."';\n";
-			}
-
-			$oPage->add_script(
-<<< EOF
-function ofc_drilldown_{$sId}(index)
-{
-	var aURLs = new Array();
-{$sURLList}
-	var sURL = aURLs[index];
-	
-	window.location.href = sURL; // Navigate ! 
-}
-EOF
-			);
-		}
-
-		// 3- Insert the Open Flash chart
-		//
-		$oPage->add("<div id=\"$sId\"><div>\n");
-		$oPage->add_ready_script(
-<<<EOF
-swfobject.embedSWF(	"../images/open-flash-chart.swf", 
-	"{$sId}", 
-	"100%", "300","9.0.0",
-	"expressInstall.swf",
-	{"get-data":"ofc_get_data_{$sId}", "id":"{$sId}"}, 
-	{'wmode': 'transparent'}
-);
-EOF
-		);
-	}
-}
-
-?>

application/startup.inc.php

@@ -1,31 +1,49 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2016 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-2016 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);
-
-?>
+require_once(APPROOT.'/core/contexttag.class.inc.php');
+session_name('itop-'.md5(APPROOT));
+session_start();
+$sSwitchEnv = utils::ReadParam('switch_env', null);
+if (($sSwitchEnv != null) && (file_exists(APPCONF.$sSwitchEnv.'/'.ITOP_CONFIG_FILE)))
+{
+	$_SESSION['itop_env'] = $sSwitchEnv;
+	$sEnv = $sSwitchEnv;
+	// 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, false /* $bModelOnly */, true /* $bAllowCache */, false /* $bTraceSourceFiles */, $sEnv);

application/template.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2017 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-2017 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();
 
@@ -332,11 +353,15 @@ class ObjectDetailsTemplate extends DisplayTemplate
 						if ($iFlags & OPT_ATT_SLAVE)
 						{
 							$iSynchroFlags = $this->m_oObj->GetSynchroReplicaFlags($sAttCode, $aReasons);
-							$sSynchroIcon = "&nbsp;<img id=\"synchro_$sInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
+							$sSynchroIcon = "&nbsp;<img id=\"synchro_$iInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
 							$sTip = '';
 							foreach($aReasons as $aRow)
 							{
-								$sTip .= "<p>Synchronized with {$aRow['name']} - {$aRow['description']}</p>";
+								$sDescription = htmlentities($aRow['description'], ENT_QUOTES, 'UTF-8');
+								$sDescription = str_replace(array("\r\n", "\n"), "<br/>", $sDescription);
+								$sTip .= "<div class='synchro-source'>";
+								$sTip .= "<div class='synchro-source-title'>Synchronized with {$aRow['name']}</div>";
+								$sTip .= "<div class='synchro-source-description'>$sDescription</div>";
 							}
 							$oPage->add_ready_script("$('#synchro_$iInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
 						}

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,28 +1,109 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2015 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
+ * until the user's session expires. This class is actually a wrapper to the underlying implementation
+ * which choice is configured via the parameter 'transaction_storage'
+ *  
  * @package     iTop
+ * @copyright   Copyright (C) 2010-2012 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
 class privUITransaction
+{
+	/**
+	 * Create a new transaction id, store it in the session and return its id
+	 * @param void
+	 * @return int The identifier of the new transaction
+	 */
+	public static function GetNewTransactionId()
+	{
+		$bTransactionsEnabled = MetaModel::GetConfig()->Get('transactions_enabled');
+		if (!$bTransactionsEnabled)
+		{
+			return 'notransactions'; // Any value will do
+		}
+		$sClass = 'privUITransaction'.MetaModel::GetConfig()->Get('transaction_storage');
+		if (!class_exists($sClass, false))
+		{
+			IssueLog::Error("Incorrect value '".MetaModel::GetConfig()->Get('transaction_storage')."' for 'transaction_storage', the class '$sClass' does not exists. Using privUITransactionSession instead for storing sessions.");
+			$sClass = 'privUITransactionSession';
+		}
+
+		return (string)$sClass::GetNewTransactionId();
+	}
+
+	/**
+	 * Check whether a transaction is valid or not and (optionally) remove the valid transaction from
+	 * the session so that another call to IsTransactionValid for the same transaction id
+	 * will return false
+	 * @param int $id Identifier of the transaction, as returned by GetNewTransactionId
+	 * @param bool $bRemoveTransaction True if the transaction must be removed
+	 * @return bool True if the transaction is valid, false otherwise
+	 */
+	public static function IsTransactionValid($id, $bRemoveTransaction = true)
+	{
+		$bTransactionsEnabled = MetaModel::GetConfig()->Get('transactions_enabled');
+		if (!$bTransactionsEnabled)
+		{
+			return true; // All values are valid
+		}
+		$sClass = 'privUITransaction'.MetaModel::GetConfig()->Get('transaction_storage');
+		if (!class_exists($sClass, false))
+		{
+			$sClass = 'privUITransactionSession';
+		}
+		
+		return $sClass::IsTransactionValid($id, $bRemoveTransaction);
+	}
+
+	/**
+	 * Removes the transaction specified by its id
+	 * @param int $id The Identifier (as returned by GetNewTranscationId) of the transaction to be removed.
+	 * @return void
+	 */
+	public static function RemoveTransaction($id)
+	{
+		$bTransactionsEnabled = MetaModel::GetConfig()->Get('transactions_enabled');
+		if (!$bTransactionsEnabled)
+		{
+			return; // Nothing to do
+		}
+		$sClass = 'privUITransaction'.MetaModel::GetConfig()->Get('transaction_storage');
+		if (!class_exists($sClass, false))
+		{
+			$sClass = 'privUITransactionSession';
+		}
+		
+		$sClass::RemoveTransaction($id);
+	}
+}
+
+/**
+ * The original (and by default) mechanism for storing transaction information
+ * as an array in the $_SESSION variable
+ *
+ */
+class privUITransactionSession
 {
 	/**
 	 * Create a new transaction id, store it in the session and return its id
@@ -94,4 +175,178 @@ class privUITransaction
 		}		
 	}
 }
-?>
+
+/**
+ * An alternate implementation for storing the transactions as temporary files
+ * Useful when using an in-memory storage for the session which do not
+ * guarantee mutual exclusion for writing
+ */
+class privUITransactionFile
+{
+	/**
+	 * Create a new transaction id, store it in the session and return its id
+	 * @param void
+	 * @return int The identifier of the new transaction
+	 */
+	public static function GetNewTransactionId()
+	{
+		if (!is_dir(APPROOT.'data/transactions'))
+		{
+			if (!is_writable(APPROOT.'data'))
+			{
+				throw new Exception('The directory "'.APPROOT.'data" must be writable to the application.');
+			}
+			if (!@mkdir(APPROOT.'data/transactions'))
+			{
+				throw new Exception('Failed to create the directory "'.APPROOT.'data/transactions". Ajust the rights on the parent directory or let an administrator create the transactions directory and give the web sever enough rights to write into it.');
+			}
+		}
+		if (!is_writable(APPROOT.'data/transactions'))
+		{
+			throw new Exception('The directory "'.APPROOT.'data/transactions" must be writable to the application.');
+		}
+		self::CleanupOldTransactions();
+		$id = basename(tempnam(APPROOT.'data/transactions', self::GetUserPrefix()));
+		self::Info('GetNewTransactionId: Created transaction: '.$id);
+
+		return (string)$id;
+	}
+
+	/**
+	 * Check whether a transaction is valid or not and (optionally) remove the valid transaction from
+	 * the session so that another call to IsTransactionValid for the same transaction id
+	 * will return false
+	 * @param int $id Identifier of the transaction, as returned by GetNewTransactionId
+	 * @param bool $bRemoveTransaction True if the transaction must be removed
+	 * @return bool True if the transaction is valid, false otherwise
+	 */
+	public static function IsTransactionValid($id, $bRemoveTransaction = true)
+	{
+		$sFilepath = APPROOT.'data/transactions/'.$id;
+		clearstatcache(true, $sFilepath);
+		$bResult = file_exists($sFilepath);
+		if ($bResult)
+		{
+			if ($bRemoveTransaction)
+			{
+				$bResult = @unlink($sFilepath);
+				if (!$bResult)
+				{
+					self::Error('IsTransactionValid: FAILED to remove transaction '.$id);
+				}
+				else
+				{
+					self::Info('IsTransactionValid: OK. Removed transaction: '.$id);
+				}
+			}
+		}
+		else
+		{
+			self::Info("IsTransactionValid: Transaction '$id' not found. Pending transactions for this user:\n".implode("\n", self::GetPendingTransactions()));
+		}
+		return $bResult;
+	}
+
+	/**
+	 * Removes the transaction specified by its id
+	 * @param int $id The Identifier (as returned by GetNewTransactionId) of the transaction to be removed.
+	 * @return void
+	 */
+	public static function RemoveTransaction($id)
+	{
+		$bSuccess = true;
+		$sFilepath = APPROOT.'data/transactions/'.$id;
+		clearstatcache(true, $sFilepath);
+		if(!file_exists($sFilepath))
+		{
+			$bSuccess = false;
+			self::Error("RemoveTransaction: Transaction '$id' not found. Pending transactions for this user:\n".implode("\n", self::GetPendingTransactions()));
+		}
+		$bSuccess = @unlink($sFilepath);
+		if (!$bSuccess)
+		{
+			self::Error('RemoveTransaction: FAILED to remove transaction '.$id);
+		}
+		else
+		{
+			self::Info('RemoveTransaction: OK '.$id);
+		}
+		return $bSuccess;
+	}
+
+	/**
+	 * Cleanup old transactions which have been pending since more than 24 hours
+	 * Use filemtime instead of filectime since filectime may be affected by operations on the directory (like changing the access rights)
+	 */
+	protected static function CleanupOldTransactions()
+	{
+		$iLimit = time() - 24*3600;
+		clearstatcache();
+		$aTransactions = glob(APPROOT.'data/transactions/*-*');
+		foreach($aTransactions as $sFileName)
+		{
+			if (filemtime($sFileName) < $iLimit)
+			{
+				@unlink($sFileName);
+				self::Info('CleanupOldTransactions: Deleted transaction: '.$sFileName);
+			}
+		}
+	}
+
+	/**
+	 * For debugging purposes: gets the pending transactions of the current user
+	 * as an array, with the date of the creation of the transaction file
+	 */
+	protected static function GetPendingTransactions()
+	{
+		clearstatcache();
+		$aResult = array();
+		$aTransactions = glob(APPROOT.'data/transactions/'.self::GetUserPrefix().'*');
+		foreach($aTransactions as $sFileName)
+		{
+			$aResult[] = date('Y-m-d H:i:s', filemtime($sFileName)).' - '.basename($sFileName);
+		}
+		sort($aResult);
+		return $aResult;
+	}
+
+	protected static function GetUserPrefix()
+	{
+		$sPrefix = substr(UserRights::GetUser(), 0, 10);
+		$sPrefix = preg_replace('/[^a-zA-Z0-9-_]/', '_', $sPrefix);
+		return $sPrefix.'-';
+	}
+
+	protected static function Info($sText)
+	{
+		self::Write('Info | '.$sText);
+	}
+
+	protected static function Warning($sText)
+	{
+		self::Write('Warning | '.$sText);
+	}
+			
+	protected static function Error($sText)
+	{
+		self::Write('Error | '.$sText);
+	}
+	
+	protected static function Write($sText)
+	{
+		$bLogEnabled = MetaModel::GetConfig()->Get('log_transactions');
+		if ($bLogEnabled)
+		{
+		$hLogFile = @fopen(APPROOT.'log/transactions.log', 'a');
+		if ($hLogFile !== false)
+		{
+			flock($hLogFile, LOCK_EX);
+			$sDate = date('Y-m-d H:i:s');
+			fwrite($hLogFile, "$sDate | $sText\n");
+			fflush($hLogFile);
+			flock($hLogFile, LOCK_UN);
+			fclose($hLogFile);
+			}
+		}
+	}
+}

application/ui.extkeywidget.class.inc.php

@@ -1,18 +1,20 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2017 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-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/webpage.class.inc.php');
@@ -96,12 +96,12 @@ class UIExtKeyWidget
 	}
 	
 	/**
-	 * 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 = null, $sDisplayStyle = 'select')
+	public function Display(WebPage $oPage, $iMaxComboLength, $bAllowTargetCreation, $sTitle, DBObjectset $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName, $sFormPrefix = '', $aArgs = array(), $bSearchMode = null, $sDisplayStyle = 'select', $bSearchMultiple = true)
 	{
 		if (!is_null($bSearchMode))
 		{
@@ -111,12 +111,12 @@ class UIExtKeyWidget
 		$oPage->add_linked_script('../js/extkeywidget.js');
 		$oPage->add_linked_script('../js/forms-json-utils.js');
 		
-		$bCreate = (!$this->bSearchMode) && (!MetaModel::IsAbstract($this->sTargetClass)) && (UserRights::IsActionAllowed($this->sTargetClass, UR_ACTION_BULK_MODIFY) && $bAllowTargetCreation);
+		$bCreate = (!$this->bSearchMode) && (UserRights::IsActionAllowed($this->sTargetClass, UR_ACTION_BULK_MODIFY) && $bAllowTargetCreation);
 		$bExtensions = true;
 		$sMessage = Dict::S('UI:Message:EmptyList:UseSearchForm');
 		$sAttrFieldPrefix = ($this->bSearchMode) ? '' : 'attr_';
 
-		$sHTMLValue = "<span style=\"white-space:nowrap\">"; // no wrap
+		$sHTMLValue = "<div class=\"field_input_zone field_input_extkey\">";
 		$sFilter = addslashes($oAllowedValues->GetFilter()->ToOQL());
 		if($this->bSearchMode)
 		{
@@ -141,16 +141,17 @@ class UIExtKeyWidget
 		{
 			throw new Exception('Implementation: null value for allowed values definition');
 		}
-		elseif ($oAllowedValues->Count() < $iMaxComboLength)
+		$oAllowedValues->SetShowObsoleteData(utils::ShowObsoleteData());
+		if ($oAllowedValues->Count() < $iMaxComboLength)
 		{
-			// Discrete list of values, use a SELECT or RADIO buttons depending on the config
+            // Discrete list of values, use a SELECT or RADIO buttons depending on the config
 			switch($sDisplayStyle)
 			{
 				case 'radio':
 				case 'radio_horizontal':
 				case 'radio_vertical':
-				$sValidationField = "<span id=\"v_{$this->iId}\"></span>";
-				$sHTMLValue = '';
+				$sValidationField = null;
+
 				$bVertical = ($sDisplayStyle != 'radio_horizontal');
 				$bExtensions = false;
 				$oAllowedValues->Rewind();
@@ -159,26 +160,37 @@ class UIExtKeyWidget
 				{
 					$aAllowedValues[$oObj->GetKey()] = $oObj->GetName();
 				}				
-				$sHTMLValue = $oPage->GetRadioButtons($aAllowedValues, $value, $this->iId, "{$sAttrFieldPrefix}{$sFieldName}", $bMandatory, $bVertical, $sValidationField);
+				$sHTMLValue .= $oPage->GetRadioButtons($aAllowedValues, $value, $this->iId, "{$sAttrFieldPrefix}{$sFieldName}", false /*  $bMandatory will be placed manually */, $bVertical, $sValidationField);
 				$aEventsList[] ='change';
 				break;
 
 				case 'select':
+				case 'list':
 				default:
 				$sSelectMode = 'true';
 				
 				$sHelpText = ''; //$this->oAttDef->GetHelpOnEdition();
-				
-				$sHTMLValue = "<select title=\"$sHelpText\" name=\"{$sAttrFieldPrefix}{$sFieldName}\" id=\"$this->iId\">\n";
+				$sHTMLValue .= "<div class=\"field_select_wrapper\">\n";
+
 				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();
 				while($oObj = $oAllowedValues->Fetch())
 				{
@@ -192,11 +204,26 @@ 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";
+				$sHTMLValue .= "</div>\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, '{$this->sAttCode}', $sJSSearchMode);
@@ -213,6 +240,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'] : '';
@@ -222,14 +258,14 @@ EOF
 				$sDisplayValue = $this->GetObjectName($value);
 			}
 			$iMinChars = isset($aArgs['iMinChars']) ? $aArgs['iMinChars'] : 3; //@@@ $this->oAttDef->GetMinAutoCompleteChars();
-			$iFieldSize = isset($aArgs['iFieldSize']) ? $aArgs['iFieldSize'] : 30; //@@@ $this->oAttDef->GetMaxSize();
+			$iFieldSize = isset($aArgs['iFieldSize']) ? $aArgs['iFieldSize'] : 20; //@@@ $this->oAttDef->GetMaxSize();
 	
 			// the input for the auto-complete
-			$sHTMLValue = "<input count=\"".$oAllowedValues->Count()."\" type=\"text\" id=\"label_$this->iId\" size=\"$iFieldSize\" value=\"$sDisplayValue\"/>&nbsp;";
-			$sHTMLValue .= "<img id=\"mini_search_{$this->iId}\" style=\"border:0;vertical-align:middle;cursor:pointer;\" src=\"../images/mini_search.gif\" onClick=\"oACWidget_{$this->iId}.Search();\"/>&nbsp;";
+			$sHTMLValue .= "<input class=\"field_autocomplete\" count=\"".$oAllowedValues->Count()."\" type=\"text\" id=\"label_$this->iId\" value=\"$sDisplayValue\"/>";
+			$sHTMLValue .= "<span class=\"field_input_btn\"><img id=\"mini_search_{$this->iId}\" style=\"border:0;vertical-align:middle;cursor:pointer;\" src=\"../images/mini_search.gif?itopversion=".ITOP_VERSION."\" onClick=\"oACWidget_{$this->iId}.Search();\"/></span>";
 	
 			// another hidden input to store & pass the object's Id
-			$sHTMLValue .= "<input type=\"hidden\" id=\"$this->iId\" name=\"{$sAttrFieldPrefix}{$sFieldName}\" value=\"$value\" />\n";
+			$sHTMLValue .= "<input type=\"hidden\" id=\"$this->iId\" name=\"{$sAttrFieldPrefix}{$sFieldName}\" value=\"".htmlentities($value, ENT_QUOTES, 'UTF-8')."\" />\n";
 
 			$JSSearchMode = $this->bSearchMode ? 'true' : 'false';	
 			// Scripts to start the autocomplete and bind some events to it
@@ -250,7 +286,7 @@ EOF
 		}
 		if ($bExtensions && MetaModel::IsHierarchicalClass($this->sTargetClass) !== false)
 		{
-			$sHTMLValue .= "<img id=\"mini_tree_{$this->iId}\" style=\"border:0;vertical-align:middle;cursor:pointer;\" src=\"../images/mini_tree.gif\" onClick=\"oACWidget_{$this->iId}.HKDisplay();\"/>&nbsp;";
+			$sHTMLValue .= "<span class=\"field_input_btn\"><img id=\"mini_tree_{$this->iId}\" style=\"border:0;vertical-align:middle;cursor:pointer;\" src=\"../images/mini_tree.gif?itopversion=".ITOP_VERSION."\" onClick=\"oACWidget_{$this->iId}.HKDisplay();\"/></span>";
 			$oPage->add_ready_script(
 <<<EOF
 			if ($('#ac_tree_{$this->iId}').length == 0)
@@ -262,7 +298,9 @@ EOF
 		}
 		if ($bCreate && $bExtensions)
 		{
-			$sHTMLValue .= "<img id=\"mini_add_{$this->iId}\" style=\"border:0;vertical-align:middle;cursor:pointer;\" src=\"../images/mini_add.gif\" onClick=\"oACWidget_{$this->iId}.CreateObject();\"/>&nbsp;";
+			$sCallbackName = (MetaModel::IsAbstract($this->sTargetClass)) ? 'SelectObjectClass' : 'CreateObject';
+
+			$sHTMLValue .= "<span class=\"field_input_btn\"><img id=\"mini_add_{$this->iId}\" style=\"border:0;vertical-align:middle;cursor:pointer;\" src=\"../images/mini_add.gif?itopversion=".ITOP_VERSION."\" onClick=\"oACWidget_{$this->iId}.{$sCallbackName}();\"/></span>";
 			$oPage->add_ready_script(
 <<<EOF
 		if ($('#ajax_{$this->iId}').length == 0)
@@ -272,11 +310,14 @@ EOF
 EOF
 );
 		}
-		if ($sDisplayStyle == 'select')
-		{
-			$sHTMLValue .= "<span id=\"v_{$this->iId}\"></span>";
-		}
-		$sHTMLValue .= "</span>"; // end of no wrap
+        $sHTMLValue .= "</div>";
+
+		// Note: This test is no longer necessary as we changed the markup to extract validation decoration in the standard .field_input_xxx container
+		//if (($sDisplayStyle == 'select') || ($sDisplayStyle == 'list'))
+		//{
+			$sHTMLValue .= "<span class=\"form_validation\" id=\"v_{$this->iId}\"></span><span class=\"field_status\" id=\"fstatus_{$this->iId}\"></span>";
+		//}
+
 		return $sHTMLValue;
 	}
 	
@@ -287,8 +328,9 @@ EOF
 		if ( ($oCurrObject != null) && ($this->sAttCode != ''))
 		{
 			$oAttDef = MetaModel::GetAttributeDef(get_class($oCurrObject), $this->sAttCode);
-			$aParams = array('query_params' => array('this' => $oCurrObject));
-			$oSet = $oAttDef->GetAllowedValuesAsObjectSet($aParams);
+			$aArgs = array('this' => $oCurrObject);
+			$aParams = array('query_params' => $aArgs);
+			$oSet = $oAttDef->GetAllowedValuesAsObjectSet($aArgs);
 			$oFilter = $oSet->GetFilter();
 		}
 		else
@@ -296,9 +338,10 @@ EOF
 			$aParams = array();
 			$oFilter = new DBObjectSearch($this->sTargetClass);
 		}
+		$bOpen = MetaModel::GetConfig()->Get('legacy_search_drawer_open');
 		$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 .= $oBlock->GetDisplay($oPage, $this->iId, array('open' => $bOpen, '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";
 		$sHTML .= "<div style=\"background: #fff; border:0; text-align:center; vertical-align:middle;\"><p>".Dict::S('UI:Message:EmptyList:UseSearchForm')."</p></div>\n";
@@ -323,7 +366,7 @@ EOF
 	/**
 	 * Search for objects to be selected
 	 * @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 sTargetClass
+	 * @param string $sRemoteClass Name of the "remote" class to perform the search on, must be a derived class of m_sRemoteClass
 	 * @param Array $aAlreadyLinkedIds List of IDs of objects of "remote" class already linked, to be filtered out of the search
 	 */
 	public function SearchObjectsToSelect(WebPage $oP, $sFilter, $sRemoteClass = '', $oObj = null)
@@ -332,38 +375,19 @@ EOF
 		{
 			throw new Exception('Implementation: null value for allowed values definition');
 		}
-		try
+		
+		$oFilter = DBObjectSearch::FromOQL($sFilter);
+		if (strlen($sRemoteClass) > 0)
 		{
-			if ($sRemoteClass != $this->sTargetClass)
-			{
-				//$oBaseClassFilter = DBObjectSearch::FromOQL($sFilter);
-				//$oFilter = new DBObjectSearch($sRemoteClass);
-				//$oFilter->AddConditionExpression($oBaseClassFilter->GetCriteria());
-				//$oFilter->TransferConditionExpression($oBaseClassFilter, array());
-				//$oFilter->TransferConditionExpression($oBaseClassFilter, array($this->sTargetClass => array('*' => $sRemoteClass.'_'.strtolower($this->sTargetClass))));
-				$sFilter = str_replace(" $this->sTargetClass ", " $sRemoteClass ", $sFilter);
-				$sFilter = str_replace("`$this->sTargetClass`", "`$sRemoteClass`", $sFilter);
-				$oFilter = DBObjectSearch::FromOQL($sFilter);
-			}
-			else
-			{
-				$oFilter = DBObjectSearch::FromOQL($sFilter);
-			}
-			//$oP->p($oFilter->ToOQL());
-			$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')); // 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);
-			$oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
-			//$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);
+
+		// Current extkey value, so we can display event if it is not available anymore (eg. archived).
+		$iCurrentExtKeyId = (is_null($oObj)) ? 0 : $oObj->Get($this->sAttCode);
+
+		$oBlock = new DisplayBlock($oFilter, 'list', false, array('query_params' => array('this' => $oObj, 'current_extkey_id' => $iCurrentExtKeyId)));
+		$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
 	}
 	
 	/**
@@ -379,9 +403,13 @@ EOF
 		{
 			throw new Exception('Implementation: null value for allowed values definition');
 		}
+
+        // Current extkey value, so we can display event if it is not available anymore (eg. archived).
+        $iCurrentExtKeyId = (is_null($oObj) || $this->sAttCode === '') ? 0 : $oObj->Get($this->sAttCode);
+
 		$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);
+		$aValues = $oValuesSet->GetValues(array('this' => $oObj, 'current_extkey_id' => $iCurrentExtKeyId), $sContains);
 		foreach($aValues as $sKey => $sFriendlyName)
 		{
 			$oP->add(trim($sFriendlyName)."\t".$sKey."\n");
@@ -406,7 +434,49 @@ EOF
 			return '';
 		}
 	}
-	
+
+    /**
+	 * Get the form to select a leaf class from the $this->sTargetClass (that should be abstract)
+	 * Note: Inspired from UILinksWidgetDirect::GetObjectCreationDialog()
+	 *
+     * @param WebPage $oPage
+     */
+	public function GetClassSelectionForm(WebPage $oPage)
+	{
+        // 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
+        $aSubClasses = MetaModel::EnumChildClasses($this->sTargetClass);
+        $aPossibleClasses = array();
+        foreach($aSubClasses as $sCandidateClass)
+        {
+            if (!MetaModel::IsAbstract($sCandidateClass) && (UserRights::IsActionAllowed($sCandidateClass, UR_ACTION_MODIFY) == UR_ALLOWED_YES))
+            {
+                $aPossibleClasses[$sCandidateClass] = MetaModel::GetName($sCandidateClass);
+            }
+        }
+
+        $sDialogTitle = '';
+        $oPage->add('<div id="ac_create_'.$this->iId.'"><div class="wizContainer" style="vertical-align:top;"><div id="dcr_'.$this->iId.'">');
+        $oPage->add('<form>');
+
+		$sClassLabel = MetaModel::GetName($this->sTargetClass);
+		$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="submit" class="action" style="margin-top:15px;"><span>' . Dict::S('UI:Button:Ok') . '</span></button></nobr></p>');
+
+        $oPage->add('</form>');
+        $oPage->add('</div></div></div>');
+        $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}.DoSelectObjectClass);");
+	}
+
 	/**
 	 * Get the form to create a new object of the 'target' class
 	 */
@@ -439,13 +509,23 @@ EOF
 		// 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));	
+		$aFieldsFlags = array();
+		$aFieldsComments = array();
+		foreach(MetaModel::ListAttributeDefs($this->sTargetClass) as $sAttCode => $oAttDef)
+		{
+			if (($oAttDef instanceof AttributeBlob) || (false))
+			{
+				$aFieldsFlags[$sAttCode] = OPT_ATT_READONLY;
+				$aFieldsComments[$sAttCode] = '&nbsp;<img src="../images/transp-lock.png" style="vertical-align:middle" title="'.htmlentities(Dict::S('UI:UploadNotSupportedInThisMode')).'"/>';
+			}
+		}
+	 	cmdbAbstractObject::DisplayCreationForm($oPage, $this->sTargetClass, $oNewObj, array(), array('formPrefix' => $this->iId, 'noRelations' => true, 'fieldsFlags' => $aFieldsFlags, 'fieldsComments' => $aFieldsComments));	
 		$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);");
 	}
@@ -464,9 +544,9 @@ EOF
 		}
 		try
 		{
-			$oFilter = DBObjectSearch::FromOQL($sFilter);
+		    $oFilter = DBObjectSearch::FromOQL($sFilter);
 			$oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
-			$oSet = new DBObjectSet($oFilter, array(), array('this' => $oObj));
+			$oSet = new DBObjectSet($oFilter, array(), array('this' => $oObj, 'current_extkey_id' => $currValue));
 		}
 		catch(MissingQueryArgument $e)
 		{
@@ -477,6 +557,7 @@ EOF
 			$oFilter->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', $this->bSearchMode);
 			$oSet = new DBObjectSet($oFilter);
 		}
+		$oSet->SetShowObsoleteData(utils::ShowObsoleteData());
 
 		$sHKAttCode = MetaModel::IsHierarchicalClass($this->sTargetClass);
 		$this->DumpTree($oPage, $oSet, $sHKAttCode, $currValue);
@@ -496,21 +577,23 @@ EOF
 	 */
 	public function DoCreateObject($oPage)
 	{
-		$oObj = MetaModel::NewObject($this->sTargetClass);
-		$aErrors = $oObj->UpdateObjectFromPostedForm($this->iId);
-		if (count($aErrors) == 0)
+		try
 		{
-			$oMyChange = MetaModel::NewObject("CMDBChange");
-			$oMyChange->Set("date", time());
-			$sUserString = CMDBChange::GetCurrentUserName();
-			$oMyChange->Set("userinfo", $sUserString);
-			$iChangeId = $oMyChange->DBInsert();
-			$oObj->DBInsertTracked($oMyChange);
-			return array('name' => $oObj->GetName(), 'id' => $oObj->GetKey());
+			$oObj = MetaModel::NewObject($this->sTargetClass);
+			$aErrors = $oObj->UpdateObjectFromPostedForm($this->iId);
+			if (count($aErrors) == 0)
+			{
+				$oObj->DBInsert();
+				return array('name' => $oObj->GetName(), 'id' => $oObj->GetKey());
+			}
+			else
+			{
+				return array('error' => implode(' ', $aErrors), 'id' => 0);		
+			}
 		}
-		else
+		catch(Exception $e)
 		{
-			return array('name' => implode(' ', $aErrors), 'id' => 0);		
+			return array('error' => $e->getMessage(), 'id' => 0);
 		}
 	}
 
@@ -554,6 +637,7 @@ EOF
 			$aSortedRoots = $aTree[$iRootId];
 			asort($aSortedRoots);
 			$oP->add("<ul>\n");
+			$fUniqueId = microtime(true);
 			foreach($aSortedRoots as $id => $sName)
 			{
 				if ($bSelect)
@@ -561,14 +645,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");
 			}
@@ -577,4 +661,3 @@ EOF
 	}
 
 }
-?>

application/ui.htmleditorwidget.class.inc.php

@@ -1,32 +1,34 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2016 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
+ * @author      Romain Quetiez
+ * @copyright   Copyright (C) 2010-2016 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 class UIHTMLEditorWidget 
 {
 	protected $m_iId;
+	protected $m_oAttDef;
 	protected $m_sAttCode;
 	protected $m_sNameSuffix;
 	protected $m_sFieldPrefix;
@@ -35,10 +37,11 @@ class UIHTMLEditorWidget
 	protected $m_sValue;
 	protected $m_sMandatory;
 	
-	public function __construct($iInputId, $sAttCode, $sNameSuffix, $sFieldPrefix, $sHelpText, $sValidationField, $sValue, $sMandatory)
+	public function __construct($iInputId, $oAttDef, $sNameSuffix, $sFieldPrefix, $sHelpText, $sValidationField, $sValue, $sMandatory)
 	{
 		$this->m_iId = $iInputId;
-		$this->m_sAttCode = $sAttCode;
+		$this->m_oAttDef = $oAttDef;
+		$this->m_sAttCode = $oAttDef->GetCode();
 		$this->m_sNameSuffix = $sNameSuffix;
 		$this->m_sHelpText = $sHelpText;
 		$this->m_sValidationField = $sValidationField;
@@ -61,14 +64,30 @@ class UIHTMLEditorWidget
 		$sHelpText = $this->m_sHelpText;
 		$sValidationField = $this->m_sValidationField;
 
-		$sHtmlValue = "<table><tr><td><textarea class=\"htmlEditor\" title=\"$sHelpText\" name=\"attr_{$this->m_sFieldPrefix}{$sCode}\" rows=\"10\" cols=\"10\" id=\"$iId\">$sValue</textarea></td><td>$sValidationField</td></tr></table>";
+		$sHtmlValue = "<div class=\"field_input_zone field_input_html\"><textarea class=\"htmlEditor\" title=\"$sHelpText\" name=\"attr_{$this->m_sFieldPrefix}{$sCode}\" rows=\"10\" cols=\"10\" id=\"$iId\">$sValue</textarea></div>$sValidationField";
 
 		// Replace the text area with CKEditor
 		// To change the default settings of the editor,
 		// a) edit the file /js/ckeditor/config.js
 		// b) or override some of the configuration settings, using the second parameter of ckeditor()
+		$aConfig = array();
 		$sLanguage = strtolower(trim(UserRights::GetUserLanguage()));
-		$oPage->add_ready_script("$('#$iId').ckeditor(function() { /* callback code */ }, { language : '$sLanguage' , contentsLanguage : '$sLanguage', extraPlugins: 'disabler' });"); // Transform $iId into a CKEdit
+		$aConfig['language'] = $sLanguage;
+		$aConfig['contentsLanguage'] = $sLanguage;
+		$aConfig['extraPlugins'] = 'disabler';
+		$sWidthSpec = addslashes(trim($this->m_oAttDef->GetWidth()));
+		if ($sWidthSpec != '')
+		{
+			$aConfig['width'] = $sWidthSpec;
+		}
+		$sHeightSpec = addslashes(trim($this->m_oAttDef->GetHeight()));
+		if ($sHeightSpec != '')
+		{
+			$aConfig['height'] = $sHeightSpec;
+		}
+		$sConfigJS = json_encode($aConfig);
+
+		$oPage->add_ready_script("$('#$iId').ckeditor(function() { /* callback code */ }, $sConfigJS);"); // Transform $iId into a CKEdit
 
 		// Please read...
 		// ValidateCKEditField triggers a timer... calling itself indefinitely
@@ -79,9 +98,26 @@ class UIHTMLEditorWidget
 
 		// Could also be bound to 'instanceReady.ckeditor'
 		$oPage->add_ready_script("$('#$iId').bind('validate', function(evt, sFormId) { return ValidateCKEditField('$iId', '', {$this->m_sMandatory}, sFormId, '') } );\n");
-		$oPage->add_ready_script("$('#$iId').bind('update', function() { BlockField('cke_$iId', $('#$iId').attr('disabled')); } );\n");
-
+		$oPage->add_ready_script(
+				<<<EOF
+$('#$iId').bind('update', function(evt){
+	BlockField('cke_$iId', $('#$iId').attr('disabled'));
+	//Delayed execution - ckeditor must be properly initialized before setting readonly
+	var retryCount = 0;
+	var oMe = $('#$iId');
+	var delayedSetReadOnly = function () {
+		if (oMe.data('ckeditorInstance').editable() == undefined && retryCount++ < 10) {
+			setTimeout(delayedSetReadOnly, retryCount * 100); //Wait a while longer each iteration
+		}
+		else
+		{
+			oMe.data('ckeditorInstance').setReadOnly(oMe.prop('disabled'));
+		}
+	};
+	setTimeout(delayedSetReadOnly, 50);
+});
+EOF
+		);
 		return $sHtmlValue;
 	}
 }
-?>

application/ui.linksdirectwidget.class.inc.php

@@ -0,0 +1,446 @@
+<?php
+// Copyright (C) 2010-2017 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-2017 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;
+				}
+			}
+		}
+		
+	}
+
+	/**
+	 * @param WebPage $oPage
+	 * @param DBObjectSet $oValue
+	 * @param array $aArgs
+	 * @param $sFormPrefix
+	 * @param $oCurrentObj
+	 */
+	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*/);
+		}
+	}
+
+	/**
+	 * @param WebPage $oPage
+	 * @param DBObjectSet $oValue
+	 * @param array $aArgs
+	 * @param $sFormPrefix
+	 * @param $oCurrentObj
+	 * @param $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,
+                'menu_actions_target' => '_blank',
+				'default' => $aDefaults,
+				'table_id' => $this->sClass.'_'.$this->sAttCode,
+			);
+
+			$oBlock = new DisplayBlock($oFilter, 'list', false);
+			$oBlock->Display($oPage, $this->sInputid, $aParams);
+		}	
+	}
+
+	/**
+	 * @param WebPage $oPage
+	 * @param DBObjectSet $oValue
+	 * @param array $aArgs
+	 * @param $sFormPrefix
+	 * @param $oCurrentObj
+	 * @param array $aButtons
+	 */
+	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);
+		}
+		$bOpen = MetaModel::GetConfig()->Get('legacy_search_drawer_open');
+		$oBlock = new DisplayBlock($oFilter, 'search', false);
+		$sHtml .= $oBlock->GetDisplay($oPage, "SearchFormToAdd_{$this->sInputid}", array('open' => $bOpen));
+		$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);
+	}
+	
+	/**
+	 * 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($sRemoteClass);
+		}
+		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 DBSearch $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-2017 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-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/webpage.class.inc.php');
@@ -91,21 +92,24 @@ class UILinksWidget
 			}
 		}
 	}
-	
+
 	/**
 	 * A one-row form for editing a link record
 	 * @param WebPage $oP Web page used for the ouput
-	 * @param DBObject $oLinkedObj The object to which all the elements of the linked set refer to
+	 * @param DBObject $oLinkedObj Remote object
 	 * @param mixed $linkObjOrId Either the object linked or a unique number for new link records to add
-	 * @param Hash $aArgs Extra context arguments
+	 * @param array|Hash $aArgs Extra context arguments
+	 * @param $oCurrentObj The object to which all the elements of the linked set refer to
+	 * @param $iUniqueId A unique identifier of new links
+     * @param boolean $bReadOnly Display link as editable or read-only. Default is false (editable)
 	 * @return string The HTML fragment of the one-row form
 	 */
-	protected function GetFormRow(WebPage $oP, DBObject $oLinkedObj, $linkObjOrId = null, $aArgs = array(), $oCurrentObj )
+	protected function GetFormRow(WebPage $oP, DBObject $oLinkedObj, $linkObjOrId, $aArgs, $oCurrentObj, $iUniqueId, $bReadOnly = false)
 	{
 		$sPrefix = "$this->m_sAttCode{$this->m_sNameSuffix}";
 		$aRow = array();
 		$aFieldsMap = array();
-		if(is_object($linkObjOrId))
+		if(is_object($linkObjOrId) && (!$linkObjOrId->IsNew()))
 		{
 			$key = $linkObjOrId->GetKey();
 			$iRemoteObjKey =  $linkObjOrId->Get($this->m_sExtKeyToRemote);
@@ -114,74 +118,97 @@ class UILinksWidget
 			$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 = self::MakeID($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;
-			}
+
+			if($bReadOnly)
+            {
+                $aRow['form::checkbox'] = "";
+                foreach($this->m_aEditableFields as $sFieldCode)
+                {
+                    $sDisplayValue = $linkObjOrId->GetEditValue($sFieldCode);
+                    $aRow[$sFieldCode] = $sDisplayValue;
+                }
+            }
+            else
+            {
+                $aRow['form::checkbox'] = "<input class=\"selection\" data-remote-id=\"$iRemoteObjKey\" data-link-id=\"$key\" data-unique-id=\"$iUniqueId\" type=\"checkbox\" onClick=\"oWidget".$this->m_iInputId.".OnSelectChange();\" value=\"$key\">";
+                foreach($this->m_aEditableFields as $sFieldCode)
+                {
+                    $sFieldId = $this->m_iInputId.'_'.$sFieldCode.'['.$linkObjOrId->GetKey().']';
+                    $sSafeId = utils::GetSafeId($sFieldId);
+                    $sValue = $linkObjOrId->Get($sFieldCode);
+                    $sDisplayValue = $linkObjOrId->GetEditValue($sFieldCode);
+                    $oAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $sFieldCode);
+                    $aRow[$sFieldCode] = '<div class="field_container" style="border:none;"><div class="field_data"><div class="field_value">'.
+                        cmdbAbstractObject::GetFormElementForField($oP, $this->m_sLinkedClass, $sFieldCode, $oAttDef, $sValue, $sDisplayValue, $sSafeId, $sNameSuffix, 0, $aArgs).
+	                    '</div></div></div>';
+                    $aFieldsMap[$sFieldCode] = $sSafeId;
+                }
+            }
+
 			$sState = $linkObjOrId->GetState();
 		}
 		else
 		{
 			// form for creating a new record
-			$sPrefix .= "[$linkObjOrId][";
-			$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
+			if (is_object($linkObjOrId))
+			{
+				// New link existing only in memory
+				$oNewLinkObj = $linkObjOrId;
+				$iRemoteObjKey = $oNewLinkObj->Get($this->m_sExtKeyToRemote);
+				$oNewLinkObj->Set($this->m_sExtKeyToMe, $oCurrentObj); // Setting the extkey with the object also fills the related external fields
+			}
+			else
+			{
+				$iRemoteObjKey = $linkObjOrId;
+				$oNewLinkObj = MetaModel::NewObject($this->m_sLinkedClass);
+				$oRemoteObj = MetaModel::GetObject($this->m_sRemoteClass, $iRemoteObjKey);
+				$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 .= "[-$iUniqueId][";
 			$sNameSuffix = "]"; // To make a tabular form
 			$aArgs['prefix'] = $sPrefix;
-			$aArgs['wizHelper'] = "oWizardHelper{$this->m_iInputId}_".(-$linkObjOrId);
+			$aArgs['wizHelper'] = "oWizardHelper{$this->m_iInputId}_".($iUniqueId < 0 ? -$iUniqueId : $iUniqueId);
 			$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=\"\">";
+			$aRow['form::checkbox'] = "<input class=\"selection\" data-remote-id=\"$iRemoteObjKey\" data-link-id=\"\" data-unique-id=\"$iUniqueId\" type=\"checkbox\" onClick=\"oWidget".$this->m_iInputId.".OnSelectChange();\" value=\"-$iUniqueId\">";
 			foreach($this->m_aEditableFields as $sFieldCode)
 			{
-				$sFieldId = $this->m_iInputId.'_'.$sFieldCode.'['.$linkObjOrId.']';
-				$sSafeId = self::MakeID($sFieldId);
+				$sFieldId = $this->m_iInputId.'_'.$sFieldCode.'['.-$iUniqueId.']';
+				$sSafeId = utils::GetSafeId($sFieldId);
+				$sValue = $oNewLinkObj->Get($sFieldCode);
+				$sDisplayValue = $oNewLinkObj->GetEditValue($sFieldCode);
 				$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] = '<div class="field_container" style="border:none;"><div class="field_data"><div class="field_value">'.
+					cmdbAbstractObject::GetFormElementForField($oP, $this->m_sLinkedClass, $sFieldCode, $oAttDef, $sValue, $sDisplayValue, $sSafeId /* id */, $sNameSuffix, 0, $aArgs).
+					'</div></div></div>';
 				$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 = self::MakeID($sPrefix.$this->m_sExtKeyToMe);
-		$aFieldsMap[$this->m_sExtKeyToMe] = $sExtKeyToMeId;
-		$aRow['form::checkbox'] .= "<input type=\"hidden\" id=\"$sExtKeyToMeId\" value=\"".$oCurrentObj->GetKey()."\">";
 
-		$sExtKeyToRemoteId = self::MakeID($sPrefix.$this->m_sExtKeyToRemote);
-		$aFieldsMap[$this->m_sExtKeyToRemote] = $sExtKeyToRemoteId;
-		$aRow['form::checkbox'] .= "<input type=\"hidden\" id=\"$sExtKeyToRemoteId\" value=\"$iRemoteObjKey\">";
-		
+			// Rows created with ajax call need OnLinkAdded call.
+			// Rows added before loading the form cannot call OnLinkAdded.
+			if ($iUniqueId > 0)
+			{
+				$oP->add_script(
+					<<<EOF
+PrepareWidgets();
+oWidget{$this->m_iInputId}.OnLinkAdded($iUniqueId, $iRemoteObjKey);
+EOF
+				);
+			}
+		}
+
+		if(!$bReadOnly)
+        {
+            $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);
 		
@@ -199,11 +226,6 @@ EOF
 		}
 		return $aRow;
 	}
-	
-	protected function MakeID($sName)
-	{
-		return str_replace(array('[', ']'), '_', $sName);
-	}
 
 	/**
 	 * Display one row of the whole form
@@ -231,7 +253,7 @@ EOF
 	 */
 	protected function DisplayFormTable(WebPage $oP, $aConfig, $aData)
 	{
-		$sHtml = '';
+		$sHtml = "<input type=\"hidden\" name=\"attr_{$this->m_sAttCode}{$this->m_sNameSuffix}\" value=\"\">";
 		$sHtml .= "<table class=\"listResults\">\n";
 		// Header
 		$sHtml .= "<thead>\n";
@@ -251,11 +273,11 @@ EOF
 			$sEmptyRowStyle = 'style="display:none;"';
 		}
 
-		$sHtml .= "<tr $sEmptyRowStyle id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_empty_row\"><td colspan=\"".count($aConfig)."\" style=\"text-align:center;\">".Dict::S('UI:Message:EmptyList:UseAdd')."<input type=\"hidden\" name=\"attr_{$this->m_sAttCode}{$this->m_sNameSuffix}\" value=\"\"></td></td>";
 		foreach($aData as $iRowId => $aRow)
 		{
 			$sHtml .= $this->DisplayFormRow($oP, $aConfig, $aRow, $iRowId);
 		}		
+		$sHtml .= "<tr $sEmptyRowStyle id=\"{$this->m_sAttCode}{$this->m_sNameSuffix}_empty_row\"><td colspan=\"".count($aConfig)."\" style=\"text-align:center;\">".Dict::S('UI:Message:EmptyList:UseAdd')."</td></tr>";
 		$sHtml .= "</tbody>\n";
 		
 		// Footer
@@ -279,29 +301,41 @@ EOF
 		$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();
+		$iAddedId = 1; // Unique id for new links
 		while($oCurrentLink = $oValue->Fetch())
 		{
-			$aRow = array();
-			$oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $oCurrentLink->Get($this->m_sExtKeyToRemote));
-			if ($oCurrentLink->IsNew())
-			{
-				$key = -$oLinkedObj->GetKey();
-				$aForm[$key] = $this->GetFormRow($oPage, $oLinkedObj, $key, $aArgs, $oCurrentObj);
-			}
-			else
-			{
-				$key = $oCurrentLink->GetKey();
-				$aForm[$key] = $this->GetFormRow($oPage, $oLinkedObj, $oCurrentLink, $aArgs, $oCurrentObj);
-			}
+		    // We try to retrieve the remote object as usual
+			$oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $oCurrentLink->Get($this->m_sExtKeyToRemote), false /* Must not be found */);
+			// If successful, it means that we can edit its link
+			if($oLinkedObj !== null)
+            {
+                $bReadOnly = false;
+            }
+            // Else we retrieve it without restrictions (silos) and will display its link as readonly
+            else
+            {
+                $bReadOnly = true;
+                $oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $oCurrentLink->Get($this->m_sExtKeyToRemote), false /* Must not be found */, true);
+            }
 
+            if ($oCurrentLink->IsNew())
+            {
+                $key = -($iAddedId++);
+            }
+            else
+            {
+                $key = $oCurrentLink->GetKey();
+            }
+            $aForm[$key] = $this->GetFormRow($oPage, $oLinkedObj, $oCurrentLink, $aArgs, $oCurrentObj, $key, $bReadOnly);
 		}
 		$sHtmlValue .= $this->DisplayFormTable($oPage, $this->m_aTableConfig, $aForm);
 		$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();
 EOF
 );
@@ -310,7 +344,7 @@ EOF
 		$sHtmlValue .= "<span style=\"clear:both;\"><p>&nbsp;</p></span>\n";
 		$sHtmlValue .= "</div>\n";
 		$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;
+        return $sHtmlValue;
 	}
 	         
 	protected static function GetTargetClass($sClass, $sAttCode)
@@ -334,11 +368,12 @@ EOF
 	
 	public function GetObjectPickerDialog($oPage, $oCurrentObj)
 	{
+		$bOpen = MetaModel::GetConfig()->Get('legacy_search_drawer_open');
 		$sHtml = "<div class=\"wizContainer\" style=\"vertical-align:top;\">\n";
 		$oFilter = new DBObjectSearch($this->m_sRemoteClass);
 		$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 .= $oBlock->GetDisplay($oPage, "SearchFormToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix}", array('open' => $bOpen));
 		$sHtml .= "<form id=\"ObjectsAddForm_{$this->m_sAttCode}{$this->m_sNameSuffix}\" OnSubmit=\"return oWidget{$this->m_iInputId}.DoAddObjects(this.id);\">\n";
 		$sHtml .= "<div id=\"SearchResultsToAdd_{$this->m_sAttCode}{$this->m_sNameSuffix}\" 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";
@@ -374,51 +409,25 @@ EOF
 		}
 		if (!$this->m_bDuplicatesAllowed && count($aAlreadyLinkedIds) > 0)
 		{
-			// Positive IDs correspond to existing link records
-			// negative IDs correspond to "remote" objects to be linked
-			$aLinkIds = array();
-			$aRemoteObjIds = array();
-			foreach($aAlreadyLinkedIds as $iId)
-			{
-				if ($iId > 0)
-				{
-					$aLinkIds[] = $iId;
-				}
-				else
-				{
-					$aRemoteObjIds[] = -$iId;
-				}
-			}
-			
-			if (count($aLinkIds) >0)
-			{
-				// Search for the links to find to which "remote" object they are linked
-				$oLinkFilter = new DBObjectSearch($this->m_sLinkedClass);
-				$oLinkFilter->AddCondition('id', $aLinkIds, 'IN');
-				$oLinkSet = new CMDBObjectSet($oLinkFilter);
-				while($oLink = $oLinkSet->Fetch())
-				{
-					$aRemoteObjIds[] = $oLink->Get($this->m_sExtKeyToRemote);
-				}
-			}
-			$oFilter->AddCondition('id', $aRemoteObjIds, 'NOTIN');
+			$oFilter->AddCondition('id', $aAlreadyLinkedIds, 'NOTIN');
 		}
-		$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)
+	public function DoAddObjects(WebPage $oP, $iMaxAddedId, $oFullSetFilter, $oCurrentObj)
 	{
 		$aLinkedObjectIds = utils::ReadMultipleSelection($oFullSetFilter);
 
+		$iAdditionId = $iMaxAddedId + 1;
 		foreach($aLinkedObjectIds as $iObjectId)
 		{
-			$oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $iObjectId);
+			$oLinkedObj = MetaModel::GetObject($this->m_sRemoteClass, $iObjectId, false);
 			if (is_object($oLinkedObj))
 			{
-				$aRow = $this->GetFormRow($oP, $oLinkedObj, -$iObjectId, array(), $oCurrentObj ); // Not yet created link get negative Ids
-				$oP->add($this->DisplayFormRow($oP, $this->m_aTableConfig, $aRow, -$iObjectId)); 
+				$aRow = $this->GetFormRow($oP, $oLinkedObj, $iObjectId, array(), $oCurrentObj, $iAdditionId); // Not yet created link get negative Ids
+				$oP->add($this->DisplayFormRow($oP, $this->m_aTableConfig, $aRow, -$iAdditionId));
+				$iAdditionId++;
 			}
 			else
 			{
@@ -430,7 +439,7 @@ 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
+	 * @param DBSearch $oSearch
 	 */
 	protected function SetSearchDefaultFromContext($oSourceObj, &$oSearch)
 	{
@@ -469,4 +478,3 @@ EOF
 		}
 	}
 }
-?>

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,13 +52,21 @@ 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/>';
-		$sHtmlValue .= '<input type="password" maxlength="255" id="'.$this->iId.'_confirm" value="'.htmlentities($sConfirmPasswordValue, ENT_QUOTES, 'UTF-8').'" name="attr_'.$sCode.'[confirm]"/> '.Dict::S('UI:PasswordConfirm').' <input id="'.$this->iId.'_reset" type="button" value="'.Dict::S('UI:Button:ResetPassword').'" onClick="ResetPwd(\''.$this->iId.'\');">';
+		$sHtmlValue .= '<div class="field_input_zone field_input_onewaypassword">';
+		$sHtmlValue .= '<input type="password" maxlength="255" name="attr_'.$sCode.'[value]" id="'.$this->iId.'" value="'.htmlentities($sPasswordValue, ENT_QUOTES, 'UTF-8').'"/>';
+		$sHtmlValue .= '<input type="password" maxlength="255" id="'.$this->iId.'_confirm" value="'.htmlentities($sConfirmPasswordValue, ENT_QUOTES, 'UTF-8').'" name="attr_'.$sCode.'[confirm]"/>';
+		$sHtmlValue .= '<span>'.Dict::S('UI:PasswordConfirm').'</span>';
+		$sHtmlValue .= '<input id="'.$this->iId.'_reset" type="button" value="'.Dict::S('UI:Button:ResetPassword').'" onClick="ResetPwd(\''.$this->iId.'\');">';
 		$sHtmlValue .= '<input type="hidden" id="'.$this->iId.'_changed" name="attr_'.$sCode.'[changed]" value="'.$sChangedValue.'"/>';
+		$sHtmlValue .= '</div>';
+
+		$sHtmlValue .= '<span class="form_validation" id="v_'.$this->iId.'"></span><span class="field_status" id="fstatus_'.$this->iId.'"></span>';
 
 		$oPage->add_ready_script("$('#$this->iId').bind('keyup change', function(evt) { return PasswordFieldChanged('$this->iId') } );"); // Bind to a custom event: validate
 		$oPage->add_ready_script("$('#$this->iId').bind('keyup change validate', function(evt, sFormId) { return ValidatePasswordField('$this->iId', sFormId) } );"); // Bind to a custom event: validate

application/uilinkswizard.class.inc.php

@@ -1,422 +0,0 @@
-<?php
-// Copyright (C) 2010 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 program 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.
-//
-//   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
-
-/**
- * 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
- */
-
-class UILinksWizard
-{
-	protected $m_sClass;
-	protected $m_sLinkageAttr;
-	protected $m_iObjectId;
-	protected $m_sLinkedClass;
-	protected $m_sLinkingAttCode;
-	protected $m_aEditableFields;
-	protected $m_aTableConfig;
-	
-	public function __construct($sClass,  $sLinkageAttr, $iObjectId, $sLinkedClass = '')
-	{
-		$this->m_sClass = $sClass;
-		$this->m_sLinkageAttr = $sLinkageAttr;
-		$this->m_iObjectId = $iObjectId;
-		$this->m_sLinkedClass = $sLinkedClass; // Will try to guess below, if it's empty
-		$this->m_sLinkingAttCode = ''; // Will be filled once we've found the attribute corresponding to the linked class
-		
-		$this->m_aEditableFields = array();
-		$this->m_aTableConfig = array();
-		$this->m_aTableConfig['form::checkbox'] = array( 'label' => "<input class=\"select_all\" type=\"checkbox\" value=\"1\" onChange=\"var value = this.checked; $('.selection').each( function() { this.checked = value; } );OnSelectChange();\">", 'description' => Dict::S('UI:SelectAllToggle+'));
-		foreach(MetaModel::GetAttributesList($this->m_sClass) as $sAttCode)
-		{
-			$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
-			if ($oAttDef->IsExternalKey() && ($sAttCode != $this->m_sLinkageAttr))
-			{
-				if (empty($this->m_sLinkedClass))
-				{
-					// This is a class of objects we can manage !
-					// Since nothing was specify, any class will do !
-					$this->m_sLinkedClass = $oAttDef->GetTargetClass();
-					$this->m_sLinkingAttCode = $sAttCode;
-				}
-				else if ($this->m_sLinkedClass == $oAttDef->GetTargetClass())
-				{
-					// This is the class of objects we want to manage !
-					$this->m_sLinkingAttCode = $sAttCode;
-				}
-			}
-			else if ( (!$oAttDef->IsExternalKey()) && (!$oAttDef->IsExternalField()))
-			{
-				$this->m_aEditableFields[] = $sAttCode;
-				$this->m_aTableConfig[$sAttCode] = array( 'label' => $oAttDef->GetLabel(), 'description' => $oAttDef->GetDescription());
-			}
-		}
-		if (empty($this->m_sLinkedClass))
-		{
-			throw( new Exception(Dict::Format('UI:Error:IncorrectLinkDefinition_LinkedClass_Class', $sLinkedClass, $sClass)));
-		}
-		foreach(MetaModel::GetZListItems($this->m_sLinkedClass, 'list') as $sFieldCode)
-		{
-			$oAttDef = MetaModel::GetAttributeDef($this->m_sLinkedClass, $sFieldCode);
-			$this->m_aTableConfig['static::'.$sFieldCode] = array( 'label' => $oAttDef->GetLabel(), 'description' => $oAttDef->GetDescription());
-		}
-	}
-
-	public function Display(WebPage $oP, $aExtraParams = array())
-	{
-		$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $this->m_sLinkageAttr);
-		$sTargetClass = $oAttDef->GetTargetClass();
-		$oTargetObj = MetaModel::GetObject($sTargetClass, $this->m_iObjectId);
-
-		$oP->set_title("iTop - ".MetaModel::GetName($this->m_sLinkedClass)." objects linked with ".MetaModel::GetName(get_class($oTargetObj)).": ".$oTargetObj->GetRawName());
-		$oP->add("<div class=\"wizContainer\">\n");
-		$oP->add("<form method=\"post\">\n");
-		$oP->add("<div class=\"page_header\">\n");
-		$oP->add("<input type=\"hidden\" id=\"linksToRemove\" name=\"linksToRemove\" value=\"\">\n");
-		$oP->add("<input type=\"hidden\" name=\"operation\" value=\"do_modify_links\">\n");
-		$oP->add("<input type=\"hidden\" name=\"class\" value=\"{$this->m_sClass}\">\n");
-		$oP->add("<input type=\"hidden\" name=\"linkage\" value=\"{$this->m_sLinkageAttr}\">\n");
-		$oP->add("<input type=\"hidden\" name=\"object_id\" value=\"{$this->m_iObjectId}\">\n");
-		$oP->add("<input type=\"hidden\" name=\"linking_attcode\" value=\"{$this->m_sLinkingAttCode}\">\n");
-		$oP->add("<h1>".Dict::Format('UI:ManageObjectsOf_Class_LinkedWith_Class_Instance', MetaModel::GetName($this->m_sLinkedClass), MetaModel::GetName(get_class($oTargetObj)), "<span class=\"hilite\">".$oTargetObj->GetHyperlink()."</span>")."</h1>\n");
-		$oP->add("</div>\n");
-		$oP->add_script(
-<<<EOF
-		function OnSelectChange()
-		{
-			var nbChecked = $('.selection:checked').length;
-			if (nbChecked > 0)
-			{
-				$('#btnRemove').attr('disabled','');
-			}
-			else
-			{
-				$('#btnRemove').attr('disabled','disabled');
-			}
-		}
-		
-		function RemoveSelected()
-		{
-			$('.selection:checked').each(
-				function()
-				{
-					$('#linksToRemove').val($('#linksToRemove').val() + ' ' + this.value);
-					$('#row_'+this.value).remove();
-				}
-			);
-			// Disable the button since all the selected items have been removed
-			$('#btnRemove').attr('disabled','disabled');
-			// Re-run the zebra plugin to properly highlight the remaining lines
-			$('.listResults').trigger('update');
-			
-		}
-		
-		function AddObjects()
-		{
-			// TO DO: compute the list of objects already linked with the current Object
-			$.post( GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', { 'operation': 'addObjects',
-										'class': '{$this->m_sClass}',
-										'linkageAttr': '{$this->m_sLinkageAttr}',
-										'linkedClass': '{$this->m_sLinkedClass}',
-										'objectId': '{$this->m_iObjectId}'
-										}, 
-				function(data)
-				{
-					$('#ModalDlg').html(data);
-					dlgWidth = $(document).width() - 100;
-					$('#ModalDlg').css('width', dlgWidth);
-					$('#ModalDlg').css('left', 50);
-					$('#ModalDlg').css('top', 50);
-					$('#ModalDlg').dialog( 'open' );
-				},
-				'html'
-			);
-		}
-		
-		function SearchObjectsToAdd(currentFormId)
-		{
-			var theMap = { 'class': '{$this->m_sClass}',
-						   'linkageAttr': '{$this->m_sLinkageAttr}',
-						   'linkedClass': '{$this->m_sLinkedClass}',
-						   'objectId': '{$this->m_iObjectId}'
-						 }
-			if ($('#'+currentFormId+' :input[name=class]').val() != undefined)
-			{
-				theMap.linkedClass = $('#'+currentFormId+' :input[name=class]').val();
-			}
-			// Gather the parameters from the search form
-			$('#'+currentFormId+' :input').each(
-				function(i)
-				{
-					if (this.name != '')
-					{
-						theMap[this.name] = this.value;
-					}
-				}
-			);
-			theMap['operation'] = 'searchObjectsToAdd';
-			
-			// Run the query and display the results
-			$.post( GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', theMap, 
-				function(data)
-				{
-					$('#SearchResultsToAdd').html(data);
-					$('#SearchResultsToAdd .listResults').tablesorter( { headers: {0: false}}, widgets: ['myZebra', 'truncatedList']} ); // sortable and zebra tables
-					
-				},
-				'html'
-			);
-
-			return false;
-		}
-		
-		function DoAddObjects(currentFormId)
-		{
-			var theMap = { 'class': '{$this->m_sClass}',
-						   'linkageAttr': '{$this->m_sLinkageAttr}',
-						   'linkedClass': '{$this->m_sLinkedClass}',
-						   'objectId': '{$this->m_iObjectId}'
-						 }
-			
-			// Gather the parameters from the search form
-			$('#'+currentFormId+' :input').each(
-				function(i)
-				{
-					if ( (this.name != '') && ((this.type != 'checkbox') || (this.checked)) ) 
-					{
-						//console.log(this.type);
-						arrayExpr = /\[\]$/;
-						if (arrayExpr.test(this.name))
-						{
-							// Array
-							if (theMap[this.name] == undefined)
-							{
-								theMap[this.name] = new Array();
-							}
-							theMap[this.name].push(this.value);
-						}
-						else
-						{
-							theMap[this.name] = this.value;
-						}
-					}
-				}
-			);
-			theMap['operation'] = 'doAddObjects';
-			
-			// Run the query and display the results
-			$.post( GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', theMap, 
-				function(data)
-				{
-					//console.log('Data: ' + data);
-					if (data != '')
-					{
-						$('#empty_row').remove();
-					}
-					$('.listResults tbody').append(data);
-					$('.listResults').trigger('update');
-					$('.listResults').tablesorter( { headers: {0: false}}, widgets: ['myZebra', 'truncatedList']} ); // sortable and zebra tables
-				},
-				'html'
-			);
-			$('#ModalDlg').dialog('close');
-			return false;
-		}
-		
-		function InitForm()
-		{
-			// make sure that the form is clean
-			$('.selection').each( function() { this.checked = false; });
-			$('#btnRemove').attr('disabled','disabled');
-			$('#linksToRemove').val('');
-		}
-		
-		function SubmitHook() 
-		{
-			var the_form = this;
-			SearchObjectsToAdd(the_form.id);
-			return false;
-		}
-EOF
-);
-		$oP->add_ready_script("InitForm();");
-		$oFilter = new DBObjectSearch($this->m_sClass);
-		$oFilter->AddCondition($this->m_sLinkageAttr, $this->m_iObjectId, '=');
-		$oSet = new DBObjectSet($oFilter);
-		$aForm = array();
-		while($oCurrentLink = $oSet->Fetch())
-		{
-			$aRow = array();
-			$key = $oCurrentLink->GetKey();
-			$oLinkedObj = MetaModel::GetObject($this->m_sLinkedClass, $oCurrentLink->Get($this->m_sLinkingAttCode));
-
-			$aForm[$key] = $this->GetFormRow($oP, $oLinkedObj, $oCurrentLink);
-		}
-		//var_dump($aTableLabels);
-		//var_dump($aForm);
-		$this->DisplayFormTable($oP, $this->m_aTableConfig, $aForm);
-		$oP->add("<span style=\"float:left;\">&nbsp;&nbsp;&nbsp;<img src=\"../images/tv-item-last.gif\">&nbsp;&nbsp;<input id=\"btnRemove\" type=\"button\" value=\"".Dict::S('UI:RemoveLinkedObjectsOf_Class')."\" onClick=\"RemoveSelected();\" >");
-		$oP->add("&nbsp;&nbsp;&nbsp;<input id=\"btnAdd\" type=\"button\" value=\"".Dict::Format('UI:AddLinkedObjectsOf_Class', MetaModel::GetName($this->m_sLinkedClass))."\" onClick=\"AddObjects();\"></span>\n");
-		$oP->add("<span style=\"float:right;\"><input id=\"btnCancel\" type=\"button\" value=\"".Dict::S('UI:Button:Cancel')."\" onClick=\"BackToDetails('".$sTargetClass."', ".$this->m_iObjectId.");\">");
-		$oP->add("&nbsp;&nbsp;&nbsp;<input id=\"btnOk\" type=\"submit\" value=\"".Dict::S('UI:Button:Ok')."\"></span>\n");
-		$oP->add("<span style=\"clear:both;\"><p>&nbsp;</p></span>\n");
-		$oP->add("</div>\n");
-		$oP->add("</form>\n");
-		if (isset($aExtraParams['StartWithAdd']) && ($aExtraParams['StartWithAdd']))
-		{
-			$oP->add_ready_script("AddObjects();");
-		}
-	}
-	
-	protected function GetFormRow($oP, $oLinkedObj, $currentLink = null )
-	{
-		$aRow = array();
-		if(is_object($currentLink))
-		{
-			$key = $currentLink->GetKey();
-			$sNameSuffix = "[$key]"; // To make a tabular form
-			$aRow['form::checkbox'] = "<input class=\"selection\" type=\"checkbox\" onChange=\"OnSelectChange();\" value=\"$key\">";
-			$aRow['form::checkbox'] .= "<input type=\"hidden\" name=\"linkId[$key]\" value=\"$key\">";
-			foreach($this->m_aEditableFields as $sFieldCode)
-			{
-				$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sFieldCode);
-				$aRow[$sFieldCode] = cmdbAbstractObject::GetFormElementForField($oP, $this->m_sClass, $sFieldCode, $oAttDef, $currentLink->Get($sFieldCode), '' /* DisplayValue */, $key, $sNameSuffix);
-			}
-		}
-		else
-		{
-			// form for creating a new record
-			$sNameSuffix = "[$currentLink]"; // To make a tabular form
-			$aRow['form::checkbox'] = "<input class=\"selection\" type=\"checkbox\" onChange=\"OnSelectChange();\" value=\"$currentLink\">";
-			$aRow['form::checkbox'] .= "<input type=\"hidden\" name=\"linkId[$currentLink]\" value=\"$currentLink\">";
-			foreach($this->m_aEditableFields as $sFieldCode)
-			{
-				$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sFieldCode);
-				$aRow[$sFieldCode] = cmdbAbstractObject::GetFormElementForField($oP, $this->m_sClass, $sFieldCode, $oAttDef, '' /* TO DO/ call GetDefaultValue($oObject->ToArgs()) */, '' /* DisplayValue */, '' /* id */, $sNameSuffix);
-			}
-		}
-		foreach(MetaModel::GetZListItems($this->m_sLinkedClass, 'list') as $sFieldCode)
-		{
-			$aRow['static::'.$sFieldCode] = $oLinkedObj->GetAsHTML($sFieldCode);
-		}
-		return $aRow;
-	}
-	
-	protected function DisplayFormTable(WebPage $oP, $aConfig, $aData)
-	{
-		$oP->add("<table class=\"listResults\">\n");
-		// Header
-		$oP->add("<thead>\n");
-		$oP->add("<tr>\n");
-		foreach($aConfig as $sName=>$aDef)
-		{
-			$oP->add("<th title=\"".$aDef['description']."\">".$aDef['label']."</th>\n");
-		}
-		$oP->add("</tr>\n");
-		$oP->add("</thead>\n");
-		
-		// Content
-		$oP->add("</tbody>\n");
-		if (count($aData) == 0)
-		{
-			$oP->add("<tr id=\"empty_row\"><td colspan=\"".count($aConfig)."\" style=\"text-align:center;\">".Dict::S('UI:Message:EmptyList:UseAdd')."</td></td>");
-		}
-		else
-		{
-			foreach($aData as $iRowId => $aRow)
-			{
-				$this->DisplayFormRow($oP, $aConfig, $aRow, $iRowId);
-			}		
-		}
-		$oP->add("</tbody>\n");
-		
-		// Footer
-		$oP->add("</table>\n");
-	}
-	
-	protected function DisplayFormRow(WebPage $oP, $aConfig, $aRow, $iRowId)
-	{
-		$oP->add("<tr id=\"row_$iRowId\">\n");
-		foreach($aConfig as $sName=>$void)
-		{
-			$oP->add("<td>".$aRow[$sName]."</td>\n");
-		}
-		$oP->add("</tr>\n");
-	}
-	
-	public function DisplayAddForm(WebPage $oP)
-	{
-		$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $this->m_sLinkageAttr);
-		$sTargetClass = $oAttDef->GetTargetClass();
-		$oTargetObj = MetaModel::GetObject($sTargetClass, $this->m_iObjectId);
-		$oP->add("<div class=\"wizContainer\">\n");
-		//$oP->add("<div class=\"page_header\">\n");
-		//$oP->add("<h1>".Dict::Format('UI:AddObjectsOf_Class_LinkedWith_Class_Instance', MetaModel::GetName($this->m_sLinkedClass), MetaModel::GetName(get_class($oTargetObj)), "<span class=\"hilite\">".$oTargetObj->GetHyperlink()."</span>")."</h1>\n");
-		//$oP->add("</div>\n");
-
-		$oFilter = new DBObjectSearch($this->m_sLinkedClass);
-		$oSet = new CMDBObjectSet($oFilter);
-		$oBlock = new DisplayBlock($oFilter, 'search', false);
-		$oBlock->Display($oP, 'SearchFormToAdd', array('open' => true));
-		$oP->Add("<form id=\"ObjectsAddForm\" OnSubmit=\"return DoAddObjects(this.id);\">\n");
-		$oP->Add("<div id=\"SearchResultsToAdd\">\n");
-		$oP->Add("<div style=\"height: 100px; background: #fff;border-color:#F6F6F1 #E6E6E1 #E6E6E1 #F6F6F1; border-style:solid; border-width:3px; text-align: center; vertical-align: center;\"><p>".Dict::S('UI:Message:EmptyList:UseSearchForm')."</p></div>\n");
-		$oP->Add("</div>\n");
-		$oP->add("<input type=\"button\" value=\"".Dict::S('UI:Button:Cancel')."\" onClick=\"$('#ModalDlg').dialog('close');\">&nbsp;&nbsp;<input type=\"submit\" value=\"".Dict::S('UI:Button:Add')."\">");
-		$oP->Add("</div>\n");
-		$oP->Add("</form>\n");
-		$oP->add_ready_script("$('#ModalDlg').dialog('option', {title:'".Dict::Format('UI:AddObjectsOf_Class_LinkedWith_Class_Instance', MetaModel::GetName($this->m_sLinkedClass), MetaModel::GetName(get_class($oTargetObj)), "<span class=\"hilite\">".$oTargetObj->GetHyperlink()."</span>")."'});");
-		$oP->add_ready_script("$('div#SearchFormToAdd form').bind('submit.uilinksWizard', SubmitHook);");
-	}
-
-	public function SearchObjectsToAdd(WebPage $oP)
-	{
-		//$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $this->m_sLinkageAttr);
-
-		$oFilter = new DBObjectSearch($this->m_sLinkedClass);
-		$oSet = new CMDBObjectSet($oFilter);
-		$oBlock = new DisplayBlock($oFilter, 'list', false);
-		$oBlock->Display($oP, 'ResultsToAdd', array('menu' => false, 'selection_mode' => true)); // Don't display the 'Actions' menu on the results
-	}
-	
-	public function DoAddObjects(WebPage $oP, $aLinkedObjectIds = array())
-	{
-		//$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $this->m_sLinkageAttr);
-		//$sTargetClass = $oAttDef->GetTargetClass();
-		//$oP->Add("<!-- nb of objects to add: ".count($aLinkedObjectIds)." -->\n"); // Just to make sure it's not empty
-		$aTable = array();
-		foreach($aLinkedObjectIds as $iObjectId)
-		{
-			$oLinkedObj = MetaModel::GetObject($this->m_sLinkedClass, $iObjectId);
-			if (is_object($oLinkedObj))
-			{
-				$aRow = $this->GetFormRow($oP, $oLinkedObj, -$iObjectId ); // Not yet created link get negative Ids
-				$this->DisplayFormRow($oP, $this->m_aTableConfig, $aRow, -$iObjectId); 
-			}
-			else
-			{
-				echo Dict::Format('UI:Error:Object_Class_Id_NotFound', $this->m_sLinkedClass, $iObjectId);
-			}
-		}
-		//var_dump($aTable);
-		//$oP->Add("<!-- end of added list -->\n"); // Just to make sure it's not empty
-	}
-}
-?>

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-2017 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-2017 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');
@@ -50,7 +50,7 @@ class appUserPreferences extends DBObject
 			self::Load();
 		}
 		$aPrefs = self::$oUserPrefs->Get('preferences');
-		if (isset($aPrefs[$sCode]))
+		if (array_key_exists($sCode, $aPrefs))
 		{
 			return $aPrefs[$sCode];
 		}
@@ -72,9 +72,52 @@ class appUserPreferences extends DBObject
 			self::Load();
 		}
 		$aPrefs = self::$oUserPrefs->Get('preferences');
-		$aPrefs[$sCode] = $sValue;
-		self::$oUserPrefs->Set('preferences', $aPrefs);
-		self::Save();
+		if (array_key_exists($sCode, $aPrefs) && ($aPrefs[$sCode] === $sValue))
+		{
+			// Do not write it again
+		}
+		else
+		{
+			$aPrefs[$sCode] = $sValue;
+			self::$oUserPrefs->Set('preferences', $aPrefs);
+			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();
+		}
 	}
 	
 	/**
@@ -94,7 +137,7 @@ class appUserPreferences extends DBObject
 	/**
 	 * Call this function if the user has changed (like when doing a logoff...)
 	 */
-	static public function Reset()
+	static public function ResetPreferences()
 	{
 		self::$oUserPrefs = null;
 	}
@@ -112,7 +155,9 @@ class appUserPreferences extends DBObject
 		{
 			if (self::$oUserPrefs->IsModified())
 			{
+				utils::PushArchiveMode(false);
 				self::$oUserPrefs->DBUpdate();
+				utils::PopArchiveMode();
 			}
 		}
 	}
@@ -136,7 +181,9 @@ class appUserPreferences extends DBObject
 			$oObj->Set('preferences', array()); // Default preferences: an empty array
 			try
 			{
+				utils::PushArchiveMode(false);
 				$oObj->DBInsert();
+				utils::PopArchiveMode();
 			}
 			catch(Exception $e)
 			{
@@ -171,7 +218,8 @@ class appUserPreferences extends DBObject
 	*/
 	public function DBDeleteTracked(CMDBChange $oChange, $bSkipStrongSecurity = null, &$oDeletionPlan = null)
 	{
+		utils::PushArchiveMode(false);
 		$this->DBDelete($oDeletionPlan);
+		utils::PopArchiveMode();
 	}
 }
-?>

application/webpage.class.inc.php

@@ -1,28 +1,45 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2015 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-2015 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,15 +68,18 @@ class WebPage
 	protected $sContentType;
 	protected $sContentDisposition;
 	protected $sContentFileName;
+	protected $bTrashUnexpectedOutput;
 	protected $s_sOutputFormat;
 	protected $a_OutputOptions;
+	protected $bPrintable;
 	    
-    public function __construct($s_title)
+    public function __construct($s_title, $bPrintable = false)
     {
         $this->s_title = $s_title;
         $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();
@@ -69,8 +90,10 @@ class WebPage
         $this->sContentType = '';
         $this->sContentDisposition = '';
         $this->sContentFileName = '';
+		$this->bTrashUnexpectedOutput = false;
 		$this->s_OutputFormat = utils::ReadParam('output_format', 'html');
 		$this->a_OutputOptions = array();
+		$this->bPrintable = $bPrintable;
         ob_start(); // Start capturing the output
     }
 	
@@ -125,6 +148,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
 	 */
@@ -207,6 +237,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
 	 */
@@ -231,6 +271,18 @@ class WebPage
         $this->a_linked_stylesheets[] = array( 'link' => $s_linked_stylesheet, 'condition' => $s_condition);
     }
 
+	public function add_saas($sSaasRelPath)
+	{
+		$sCssRelPath = utils::GetCSSFromSASS($sSaasRelPath);
+		$sRootUrl =  utils::GetAbsoluteUrlAppRoot();
+		if ($sRootUrl === '')
+		{
+			// We're running the setup of the first install...
+			$sRootUrl = '../';
+		}
+		$sCSSUrl = $sRootUrl.$sCssRelPath;
+		$this->add_linked_stylesheet($sCSSUrl);
+	}
 	/**
 	 * Add some custom header to the page
 	 */
@@ -256,6 +308,15 @@ class WebPage
 
 		$this->add($this->GetDetails($aFields));
     }
+    
+    /**
+     * Whether or not the page is a PDF page
+     * @return boolean
+     */
+    public function is_pdf()
+    {
+    	return false;
+    }
 
 	/**
 	 * Records the current state of the 'html' part of the page output
@@ -284,27 +345,40 @@ class WebPage
 	 */
 	public function GetDetails($aFields)
 	{
-		$sHtml = "<table class=\"details\">\n";
-		$sHtml .= "<tbody>\n";
+		$sHtml = "<div class=\"details\">\n";
 		foreach($aFields as $aAttrib)
 		{
-			$sHtml .= "<tr>\n";
+			$sDataAttCode = isset($aAttrib['attcode']) ? "data-attcode=\"{$aAttrib['attcode']}\"" : '';
+			$sLayout = isset($aAttrib['layout']) ? $aAttrib['layout'] : 'small';
+		    $sHtml .= "<div class=\"field_container field_{$sLayout}\" $sDataAttCode>\n";
+            $sHtml .= "<div class=\"field_label label\">{$aAttrib['label']}</div>\n";
+
+            $sHtml .= "<div class=\"field_data\">\n";
 			// By Rom, for csv import, proposed to show several values for column selection
 			if (is_array($aAttrib['value']))
 			{
-				$sHtml .= "<td class=\"label\">".$aAttrib['label']."</td><td>".implode("</td><td>", $aAttrib['value'])."</td>\n";
+				$sHtml .= "<div class=\"field_value\">".implode("</div><div>", $aAttrib['value'])."</div>\n";
 			}
 			else
 			{
-				$sHtml .= "<td class=\"label\">".$aAttrib['label']."</td><td>".$aAttrib['value']."</td>\n";
+				$sHtml .= "<div class=\"field_value\">".$aAttrib['value']."</div>\n";
 			}
-			$sComment = (isset($aAttrib['comments'])) ? $aAttrib['comments'] : '&nbsp;';
-			$sInfo = (isset($aAttrib['infos'])) ? $aAttrib['infos'] : '&nbsp;';
-			$sHtml .= "<td>$sComment</td><td>$sInfo</td>\n";
-    		$sHtml .= "</tr>\n";
+			// Checking if we should add comments & infos
+			$sComment = (isset($aAttrib['comments'])) ? $aAttrib['comments'] : '';
+			$sInfo = (isset($aAttrib['infos'])) ? $aAttrib['infos'] : '';
+			if($sComment !== '')
+            {
+                $sHtml .= "<div class=\"field_comments\">$sComment</div>\n";
+            }
+            if($sInfo !== '')
+            {
+                $sHtml .= "<div class=\"field_infos\">$sInfo</div>\n";
+            }
+			$sHtml .= "</div>\n";
+
+			$sHtml .= "</div>\n";
 		}
-		$sHtml .= "</tbody>\n";
-		$sHtml .= "</table>\n";
+		$sHtml .= "</div>\n";
 		return $sHtml;
     }
 
@@ -355,6 +429,58 @@ class WebPage
 		return $sHTMLValue;
 	}
 	
+	/**
+	 * Discard unexpected output data (such as PHP warnings)
+	 * This is a MUST when the Page output is DATA (download of a document, download CSV export, download ...)
+	 */	
+	public function TrashUnexpectedOutput()
+	{
+		$this->bTrashUnexpectedOutput = true;
+	}
+
+	/**
+	 * Read the output buffer and deal with its contents:
+	 * - trash unexpected output if the flag has been set
+	 * - report unexpected behaviors such as the output buffering being stopped
+	 * 
+	 * Possible improvement: I've noticed that several output buffers are stacked,
+	 * if they are not empty, the output will be corrupted. The solution would
+	 * consist in unstacking all of them (and concatenate the contents).	 	 
+	 */
+	protected function ob_get_clean_safe()
+	{
+		$sOutput = ob_get_contents();
+		if ($sOutput === false)
+		{
+			$sMsg = "Design/integration issue: No output buffer. Some piece of code has called ob_get_clean() or ob_end_clean() without calling ob_start()";
+			if ($this->bTrashUnexpectedOutput)
+			{
+				IssueLog::Error($sMsg);
+				$sOutput = '';
+			}
+			else
+			{
+				$sOutput = $sMsg;
+			}
+		}
+		else
+		{
+			ob_end_clean(); // on some versions of PHP doing so when the output buffering is stopped can cause a notice
+			if ($this->bTrashUnexpectedOutput)
+			{
+				if (trim($sOutput) != '')
+				{
+					if (Utils::GetConfig() && Utils::GetConfig()->Get('debug_report_spurious_chars'))
+					{
+						IssueLog::Error("Trashing unexpected output:'$sOutput'\n");
+					}
+				}
+				$sOutput = '';
+			}
+		}
+		return $sOutput;
+	}
+
 	/**
 	 * Outputs (via some echo) the complete HTML page by assembling all its elements
 	 */
@@ -364,12 +490,13 @@ class WebPage
         {
             header($s_header);
         }
-        $s_captured_output = ob_get_contents();
-        ob_end_clean();
+
+        $s_captured_output = $this->ob_get_clean_safe();
         echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n";
         echo "<html>\n";
         echo "<head>\n";
 		echo "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
+		echo "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0, shrink-to-fit=no\" />";
         echo "<title>".htmlentities($this->s_title, ENT_QUOTES, 'UTF-8')."</title>\n";
         echo $this->get_base_tag();
         foreach($this->a_linked_scripts as $s_script)
@@ -395,13 +522,22 @@ class WebPage
             }
             echo "</script>\n";
         }
+        $this->output_dict_entries();
         foreach($this->a_linked_stylesheets as $a_stylesheet)
         {
+			if (strpos($a_stylesheet['link'], '?') === false)
+			{
+				$s_stylesheet = $a_stylesheet['link']."?itopversion=".ITOP_VERSION;
+			}
+			else
+			{
+				$s_stylesheet = $a_stylesheet['link']."&itopversion=".ITOP_VERSION;
+			}
 			if ($a_stylesheet['condition'] != "")
 			{
 				echo "<!--[if {$a_stylesheet['condition']}]>\n";
 			}
-            echo "<link rel=\"stylesheet\" type=\"text/css\" href=\"{$a_stylesheet['link']}\" />\n";
+			echo "<link rel=\"stylesheet\" type=\"text/css\" href=\"{$s_stylesheet}\" />\n";
 			if ($a_stylesheet['condition'] != "")
 			{
 				echo "<![endif]-->\n";
@@ -419,7 +555,7 @@ class WebPage
         }
         if (class_exists('MetaModel') && MetaModel::GetConfig())
         {
- 			echo "<link rel=\"shortcut icon\" href=\"".utils::GetAbsoluteUrlAppRoot()."images/favicon.ico\" />\n";
+ 			echo "<link rel=\"shortcut icon\" href=\"".utils::GetAbsoluteUrlAppRoot()."images/favicon.ico?itopversion=".ITOP_VERSION."\" />\n";
         }
         echo "</head>\n";
         echo "<body>\n";
@@ -431,18 +567,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('DBSearch'))
+        {
+            DBSearch::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\">");
+			}
 		}
 	}
 
@@ -549,7 +697,16 @@ class WebPage
 		}
 		return $bResult;
 	}
-	
+
+	/**
+	 * Check whether the output must be printable (using print.css, for sure!)
+	 * @return bool ...
+	 */
+	public function IsPrintableVersion()
+	{
+		return $this->bPrintable;
+	}
+
 	/** 
 	 * Retrieves the value of a named output option for the given format
 	 * @param string $sFormat The format: html or pdf
@@ -581,5 +738,406 @@ class WebPage
 			$this->a_OutputOptions[$sFormat][$sOptionName] = $sValue;
 		}
 	}
+	
+	public function RenderPopupMenuItems($aActions, $aFavoriteActions = array())
+	{
+		$sPrevUrl = '';
+		$sHtml = '';
+		if (!$this->IsPrintableVersion())
+		{
+			foreach ($aActions as $aAction)
+			{
+				$sClass = isset($aAction['css_classes']) ? ' class="'.implode(' ', $aAction['css_classes']).'"' : '';
+				$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 actual name of the tab (as a string) or false if not found
+	 */
+	public function FindTab($sPattern, $sTabContainer = null)
+	{
+		$result = 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, WebPage $oPage)
+	{
+		// 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)
+			{
+				if ($oPage->IsPrintableVersion())
+				{
+					$oPage->add_ready_script(
+<<< EOF
+oHiddeableChapters = {};
+EOF
+					);
+					$sTabs = "<!-- tabs -->\n<div id=\"tabbedContent_{$sPrefix}{$container_index}\" class=\"light\">\n";
+					$i = 0;
+					foreach($aTabs['tabs'] as $sTabName => $aTabData)
+					{
+						$sTabNameEsc = addslashes($sTabName);
+						$sTabId = "tab_{$sPrefix}{$container_index}$i";
+						switch($aTabData['type'])
+						{
+							case 'ajax':
+							$sTabHtml = '';
+							$sUrl = $aTabData['url'];	
+							$oPage->add_ready_script(
+<<< EOF
+$.post('$sUrl', {printable: '1'}, function(data){
+	$('#$sTabId > .printable-tab-content').append(data);
+});
+EOF
+							);
+							break;
+							
+							case 'html':
+							default:
+							$sTabHtml = $aTabData['html'];
+						}
+						$sTabs .= "<div class=\"printable-tab\" id=\"$sTabId\"><h2 class=\"printable-tab-title\">".htmlentities($sTabName, ENT_QUOTES, 'UTF-8')."</h2><div class=\"printable-tab-content\">".$sTabHtml."</div></div>\n";	
+						$oPage->add_ready_script(
+<<< EOF
+oHiddeableChapters['$sTabId'] = '$sTabNameEsc';
+EOF
+						);
+						$i++;
+					}
+					$sTabs .= "</div>\n<!-- end of tabs-->\n";
+				}
+				else
+				{
+					$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-2016 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-2016 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT.'/application/uiwizard.class.inc.php');
@@ -34,7 +35,7 @@ class WizardHelper
 	}
 	/**
 	 * Constructs the PHP target object from the parameters sent to the web page by the wizard
-	 * @param boolean $bReadUploadedFiles True to also ready any uploaded file (for blob/document fields)
+	 * @param boolean $bReadUploadedFiles True to also read any uploaded file (for blob/document fields)
 	 * @return object
 	 */	 	 	 	
 	public function GetTargetObject($bReadUploadedFiles = false)
@@ -51,7 +52,7 @@ class WizardHelper
 		{
 			// Because this is stored in a Javascript array, unused indexes
 			// are filled with null values and unused keys (stored as strings) contain $$NULL$$
-			if ( ($sAttCode !='id') && ($sAttCode !== false) && ($value !== null) && ($value !== '$$NULL$$'))
+			if ( ($sAttCode !='id') && ($value !== '$$NULL$$'))
 			{
 				$oAttDef = MetaModel::GetAttributeDef($this->m_aData['m_sClass'], $sAttCode);
 				if (($oAttDef->IsLinkSet()) && ($value != '') )
@@ -76,13 +77,25 @@ 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
 									$oTargetObj = MetaModel::GetObject($sLinkedAttDef->GetTargetClass(), $aLinkedObject[$sLinkedAttCode]);
 									$oLinkedObj->Set($sLinkedAttCode, $oTargetObj);
 								}
+								elseif($sLinkedAttDef instanceof AttributeDateTime)
+                                {
+                                    $sDate = $aLinkedObject[$sLinkedAttCode];
+                                    if($sDate !== null && $sDate !== '')
+                                    {
+                                        $oDateTimeFormat = AttributeDateTime::GetFormat();
+                                        $oDate = $oDateTimeFormat->Parse($sDate);
+                                        $sDate = $oDate->format('Y-m-d H:i:s');
+                                    }
+
+                                    $oLinkedObj->Set($sLinkedAttCode, $sDate);
+                                }
 								else
 								{
 									$oLinkedObj->Set($sLinkedAttCode, $aLinkedObject[$sLinkedAttCode]);
@@ -108,12 +121,50 @@ class WizardHelper
 						$oObj->Set($sAttCode, $oDocument);
 					}
 				}
-				else if (($oAttDef->IsExternalKey()) && (!empty($value)) )
+				else if ( $oAttDef->GetEditClass() == 'Image' )
+				{
+					if ($bReadUploadedFiles)
+					{
+						$oDocument = utils::ReadPostedDocument('attr_'.$sAttCode, 'fcontents');
+						$oObj->Set($sAttCode, $oDocument);
+					}
+					else
+					{
+						// Create a new empty document, just for displaying the file name
+						$oDocument = new ormDocument(null, '', $value);
+						$oObj->Set($sAttCode, $oDocument);
+					}
+				}
+				else if (($oAttDef->IsExternalKey()) && (!empty($value)) && ($value > 0) )
 				{
 					// For external keys: load the target object so that external fields
 					// get filled too
-					$oTargetObj = MetaModel::GetObject($oAttDef->GetTargetClass(), $value);
-					$oObj->Set($sAttCode, $oTargetObj);
+					$oTargetObj = MetaModel::GetObject($oAttDef->GetTargetClass(), $value, false);
+					if ($oTargetObj)
+					{
+						$oObj->Set($sAttCode, $oTargetObj);
+					}
+					else
+					{
+						// May happen for security reasons (portal, see ticket #1074)
+						$oObj->Set($sAttCode, $value);
+					}
+				}
+				else if ($oAttDef instanceof AttributeDateTime) // AttributeDate is derived from AttributeDateTime
+				{
+					if ($value != null)
+					{
+						$oDate = $oAttDef->GetFormat()->Parse($value);
+						if ($oDate instanceof DateTime)
+						{
+							$value = $oDate->format($oAttDef->GetInternalFormat());
+						}
+						else
+						{
+							$value = null;
+						}
+					}
+					$oObj->Set($sAttCode, $value);
 				}
 				else
 				{
@@ -231,11 +282,21 @@ class WizardHelper
 	{
 		return $this->m_aData['m_sClass'];
 	}
-	
-	public function GetFormPrefix()
-	{
-		return $this->m_aData['m_sFormPrefix'];
-	}
+
+    public function GetFormPrefix()
+    {
+        return $this->m_aData['m_sFormPrefix'];
+    }
+
+    public function GetInitialState()
+    {
+        return isset($this->m_aData['m_sInitialState']) ? $this->m_aData['m_sInitialState'] : null;
+    }
+
+    public function GetStimulus()
+    {
+        return isset($this->m_aData['m_sStimulus']) ? $this->m_aData['m_sStimulus'] : null;
+    }
 	
 	public function GetIdForField($sFieldName)
 	{
@@ -260,7 +321,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
@@ -275,4 +336,3 @@ class WizardHelper
 		return $oSet;
 	}
 }
-?>

application/xlsxwriter.class.php

@@ -0,0 +1,467 @@
+<?php
+/* @author Mark Jones
+ * @license MIT License
+ * */
+
+if (!class_exists('ZipArchive')) { throw new Exception('ZipArchive not found'); }
+
+Class XLSXWriter
+{
+	//------------------------------------------------------------------
+	protected $author ='Doc Author';
+	protected $sheets_meta = array();
+	protected $shared_strings = array();//unique set
+	protected $shared_string_count = 0;//count of non-unique references to the unique set
+	protected $temp_files = array();
+	protected $date_format = 'YYYY-MM-DD';
+	protected $date_time_format = 'YYYY-MM-DD\ HH:MM:SS';
+
+	public function __construct(){}
+	public function setAuthor($author='') { $this->author=$author; }
+
+	public function __destruct()
+	{
+		if (!empty($this->temp_files)) {
+			foreach($this->temp_files as $temp_file) {
+				@unlink($temp_file);
+			}
+		}
+	}
+	
+	public function setDateFormat($date_format)
+	{
+		$this->date_format = $date_format;
+	}
+	
+	public function setDateTimeFormat($date_time_format)
+	{
+		$this->date_time_format = $date_time_format;
+	}
+	
+	protected function tempFilename()
+	{
+		$filename = tempnam("/tmp", "xlsx_writer_");
+		$this->temp_files[] = $filename;
+		return $filename;
+	}
+
+	public function writeToStdOut()
+	{
+		$temp_file = $this->tempFilename();
+		self::writeToFile($temp_file);
+		readfile($temp_file);
+	}
+
+	public function writeToString()
+	{
+		$temp_file = $this->tempFilename();
+		self::writeToFile($temp_file);
+		$string = file_get_contents($temp_file);
+		return $string;
+	}
+
+	public function writeToFile($filename)
+	{
+		@unlink($filename);//if the zip already exists, overwrite it
+		$zip = new ZipArchive();
+		if (empty($this->sheets_meta))                  { self::log("Error in ".__CLASS__."::".__FUNCTION__.", no worksheets defined."); return; }
+		if (!$zip->open($filename, ZipArchive::CREATE)) { self::log("Error in ".__CLASS__."::".__FUNCTION__.", unable to create zip."); return; }
+		
+		$zip->addEmptyDir("docProps/");
+		$zip->addFromString("docProps/app.xml" , self::buildAppXML() );
+		$zip->addFromString("docProps/core.xml", self::buildCoreXML());
+
+		$zip->addEmptyDir("_rels/");
+		$zip->addFromString("_rels/.rels", self::buildRelationshipsXML());
+
+		$zip->addEmptyDir("xl/worksheets/");
+		foreach($this->sheets_meta as $sheet_meta) {
+			$zip->addFile($sheet_meta['filename'], "xl/worksheets/".$sheet_meta['xmlname'] );
+		}
+		if (!empty($this->shared_strings)) {
+			$zip->addFile($this->writeSharedStringsXML(), "xl/sharedStrings.xml" );  //$zip->addFromString("xl/sharedStrings.xml",     self::buildSharedStringsXML() );
+		}
+		$zip->addFromString("xl/workbook.xml"         , self::buildWorkbookXML() );
+		$zip->addFile($this->writeStylesXML(), "xl/styles.xml" );  //$zip->addFromString("xl/styles.xml"           , self::buildStylesXML() );
+		$zip->addFromString("[Content_Types].xml"     , self::buildContentTypesXML() );
+
+		$zip->addEmptyDir("xl/_rels/");
+		$zip->addFromString("xl/_rels/workbook.xml.rels", self::buildWorkbookRelsXML() );
+		$zip->close();
+	}
+
+	
+	public function writeSheet(array $data, $sheet_name='', array $header_types=array(), array $header_row=array() )
+	{
+		$data = empty($data) ? array( array('') ) : $data;
+		
+		$sheet_filename = $this->tempFilename();
+		$sheet_default = 'Sheet'.(count($this->sheets_meta)+1);
+		$sheet_name = !empty($sheet_name) ? $sheet_name : $sheet_default;
+		$this->sheets_meta[] = array('filename'=>$sheet_filename, 'sheetname'=>$sheet_name ,'xmlname'=>strtolower($sheet_default).".xml" );
+
+		$header_offset = empty($header_types) ? 0 : 1;
+		$row_count = count($data) + $header_offset;
+		$column_count = count($data[self::array_first_key($data)]);
+		$max_cell = self::xlsCell( $row_count-1, $column_count-1 );
+
+		$tabselected = count($this->sheets_meta)==1 ? 'true' : 'false';//only first sheet is selected
+		$cell_formats_arr = empty($header_types) ? array_fill(0, $column_count, 'string') : array_values($header_types);
+		if (empty($header_row) && !empty($header_types))
+		{
+			$header_row = empty($header_types) ? array() : array_keys($header_types);
+		}
+
+		$fd = fopen($sheet_filename, "w+");
+		if ($fd===false) { self::log("write failed in ".__CLASS__."::".__FUNCTION__."."); return; }
+		
+		fwrite($fd,'<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'."\n");
+		fwrite($fd,'<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">');
+		fwrite($fd,    '<sheetPr filterMode="false">');
+		fwrite($fd,        '<pageSetUpPr fitToPage="false"/>');
+		fwrite($fd,    '</sheetPr>');
+		fwrite($fd,    '<dimension ref="A1:'.$max_cell.'"/>');
+		fwrite($fd,    '<sheetViews>');
+		fwrite($fd,        '<sheetView colorId="64" defaultGridColor="true" rightToLeft="false" showFormulas="false" showGridLines="true" showOutlineSymbols="true" showRowColHeaders="true" showZeros="true" tabSelected="'.$tabselected.'" topLeftCell="A1" view="normal" windowProtection="false" workbookViewId="0" zoomScale="100" zoomScaleNormal="100" zoomScalePageLayoutView="100">');
+		fwrite($fd,            '<selection activeCell="A1" activeCellId="0" pane="topLeft" sqref="A1"/>');
+		fwrite($fd,        '</sheetView>');
+		fwrite($fd,    '</sheetViews>');
+		fwrite($fd,    '<cols>');
+		fwrite($fd,        '<col collapsed="false" hidden="false" max="1025" min="1" style="0" width="19"/>');
+		fwrite($fd,    '</cols>');
+		fwrite($fd,    '<sheetData>');
+		if (!empty($header_row))
+		{
+			fwrite($fd, '<row collapsed="false" customFormat="false" customHeight="false" hidden="false" ht="12.1" outlineLevel="0" r="'.(1).'">');
+			foreach($header_row as $k=>$v)
+			{
+				$this->writeCell($fd, 0, $k, $v, $cell_format='string');
+			}
+			fwrite($fd, '</row>');
+		}
+		foreach($data as $i=>$row)
+		{
+			fwrite($fd, '<row collapsed="false" customFormat="false" customHeight="false" hidden="false" ht="12.1" outlineLevel="0" r="'.($i+$header_offset+1).'">');
+			foreach($row as $k=>$v)
+			{
+				$this->writeCell($fd, $i+$header_offset, $k, $v, $cell_formats_arr[$k]);
+			}
+			fwrite($fd, '</row>');
+		}
+		fwrite($fd,    '</sheetData>');
+		fwrite($fd,    '<printOptions headings="false" gridLines="false" gridLinesSet="true" horizontalCentered="false" verticalCentered="false"/>');
+		fwrite($fd,    '<pageMargins left="0.5" right="0.5" top="1.0" bottom="1.0" header="0.5" footer="0.5"/>');
+		fwrite($fd,    '<pageSetup blackAndWhite="false" cellComments="none" copies="1" draft="false" firstPageNumber="1" fitToHeight="1" fitToWidth="1" horizontalDpi="300" orientation="portrait" pageOrder="downThenOver" paperSize="1" scale="100" useFirstPageNumber="true" usePrinterDefaults="false" verticalDpi="300"/>');
+		fwrite($fd,    '<headerFooter differentFirst="false" differentOddEven="false">');
+		fwrite($fd,        '<oddHeader>&amp;C&amp;&quot;Times New Roman,Regular&quot;&amp;12&amp;A</oddHeader>');
+		fwrite($fd,        '<oddFooter>&amp;C&amp;&quot;Times New Roman,Regular&quot;&amp;12Page &amp;P</oddFooter>');
+		fwrite($fd,    '</headerFooter>');
+		fwrite($fd,'</worksheet>');
+		fclose($fd);
+	}
+
+	protected function writeCell($fd, $row_number, $column_number, $value, $cell_format)
+	{
+		static $styles = array('money'=>1,'dollar'=>1,'datetime'=>2,'date'=>3,'string'=>0);
+		$cell = self::xlsCell($row_number, $column_number);
+		$s = isset($styles[$cell_format]) && ($value !== '') ? $styles[$cell_format] : '0';
+		
+		if (is_int($value) || is_float($value)) {
+			fwrite($fd,'<c r="'.$cell.'" s="'.$s.'" t="n"><v>'.($value*1).'</v></c>');//int,float, etc
+		} else if (($cell_format=='date') && ($value != '')) {
+			fwrite($fd,'<c r="'.$cell.'" s="'.$s.'" t="n"><v>'.intval(self::convert_date_time($value)).'</v></c>');
+		} else if (($cell_format=='datetime') && ($value != '')) {
+			fwrite($fd,'<c r="'.$cell.'" s="'.$s.'" t="n"><v>'.self::convert_date_time($value).'</v></c>');
+		} else if ($value==''){
+			fwrite($fd,'<c r="'.$cell.'" s="'.$s.'"/>');
+		} else if ($value{0}=='='){
+			fwrite($fd,'<c r="'.$cell.'" s="'.$s.'" t="s"><f>'.self::xmlspecialchars($value).'</f></c>');
+		} else if ($value!==''){
+			fwrite($fd,'<c r="'.$cell.'" s="'.$s.'" t="s"><v>'.self::xmlspecialchars($this->setSharedString($value)).'</v></c>');
+		}
+	}
+
+	protected function writeStylesXML()
+	{
+		$tempfile = $this->tempFilename();
+		$fd = fopen($tempfile, "w+");
+		if ($fd===false) { self::log("write failed in ".__CLASS__."::".__FUNCTION__."."); return; }
+		fwrite($fd, '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'."\n");
+		fwrite($fd, '<styleSheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">');
+		fwrite($fd, '<numFmts count="4">');
+		fwrite($fd, 		'<numFmt formatCode="GENERAL" numFmtId="164"/>');
+		fwrite($fd, 		'<numFmt formatCode="[$$-1009]#,##0.00;[RED]\-[$$-1009]#,##0.00" numFmtId="165"/>');
+		fwrite($fd, 		'<numFmt formatCode="'.$this->date_time_format.'" numFmtId="166"/>');
+		fwrite($fd, 		'<numFmt formatCode="'.$this->date_format.'" numFmtId="167"/>');
+		fwrite($fd, '</numFmts>');
+		fwrite($fd, '<fonts count="4">');
+		fwrite($fd, 		'<font><name val="Arial"/><charset val="1"/><family val="2"/><sz val="10"/></font>');
+		fwrite($fd, 		'<font><name val="Arial"/><family val="0"/><sz val="10"/></font>');
+		fwrite($fd, 		'<font><name val="Arial"/><family val="0"/><sz val="10"/></font>');
+		fwrite($fd, 		'<font><name val="Arial"/><family val="0"/><sz val="10"/></font>');
+		fwrite($fd, '</fonts>');
+		fwrite($fd, '<fills count="2"><fill><patternFill patternType="none"/></fill><fill><patternFill patternType="gray125"/></fill></fills>');
+		fwrite($fd, '<borders count="1"><border diagonalDown="false" diagonalUp="false"><left/><right/><top/><bottom/><diagonal/></border></borders>');
+		fwrite($fd, 	'<cellStyleXfs count="15">');
+		fwrite($fd, 		'<xf applyAlignment="true" applyBorder="true" applyFont="true" applyProtection="true" borderId="0" fillId="0" fontId="0" numFmtId="164">');
+		fwrite($fd, 		'<alignment horizontal="general" indent="0" shrinkToFit="false" textRotation="0" vertical="bottom" wrapText="false"/>');
+		fwrite($fd, 		'<protection hidden="false" locked="true"/>');
+		fwrite($fd, 		'</xf>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="1" numFmtId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="1" numFmtId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="2" numFmtId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="2" numFmtId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="0"/>');
+		//fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="1" numFmtId="43"/>');
+		//fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="1" numFmtId="41"/>');
+		//fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="1" numFmtId="44"/>');
+		//fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="1" numFmtId="42"/>');
+		//fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="true" applyProtection="false" borderId="0" fillId="0" fontId="1" numFmtId="9"/>');
+		fwrite($fd, 	'</cellStyleXfs>');
+		fwrite($fd, 	'<cellXfs count="4">');
+		fwrite($fd, 		'<xf applyAlignment="1" applyBorder="false" applyFont="false" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="164" xfId="0"><alignment wrapText="1"/></xf>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="false" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="165" xfId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="false" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="166" xfId="0"/>');
+		fwrite($fd, 		'<xf applyAlignment="false" applyBorder="false" applyFont="false" applyProtection="false" borderId="0" fillId="0" fontId="0" numFmtId="167" xfId="0"/>');
+		fwrite($fd, 	'</cellXfs>');
+		fwrite($fd, 	'<cellStyles count="1">');
+		fwrite($fd, 		'<cellStyle builtinId="0" customBuiltin="false" name="Normal" xfId="0"/>');
+		//fwrite($fd, 		'<cellStyle builtinId="3" customBuiltin="false" name="Comma" xfId="15"/>');
+		//fwrite($fd, 		'<cellStyle builtinId="6" customBuiltin="false" name="Comma [0]" xfId="16"/>');
+		//fwrite($fd, 		'<cellStyle builtinId="4" customBuiltin="false" name="Currency" xfId="17"/>');
+		//fwrite($fd, 		'<cellStyle builtinId="7" customBuiltin="false" name="Currency [0]" xfId="18"/>');
+		//fwrite($fd, 		'<cellStyle builtinId="5" customBuiltin="false" name="Percent" xfId="19"/>');
+		fwrite($fd, 	'</cellStyles>');
+		fwrite($fd, '</styleSheet>');
+		fclose($fd);
+		return $tempfile;
+	}
+
+	protected function setSharedString($v)
+	{
+		// Strip control characters which Excel does not seem to like...
+		$v = preg_replace('/[\x00-\x09\x0B\x0C\x0E-\x1F]/u', '', $v);
+		if (isset($this->shared_strings[$v]))
+		{
+			$string_value = $this->shared_strings[$v];
+		}
+		else
+		{
+			$string_value = count($this->shared_strings);
+			$this->shared_strings[$v] = $string_value;
+		}
+		$this->shared_string_count++;//non-unique count
+		return $string_value;
+	}
+
+	protected function writeSharedStringsXML()
+	{
+		$tempfile = $this->tempFilename();
+		$fd = fopen($tempfile, "w+");
+		if ($fd===false) { self::log("write failed in ".__CLASS__."::".__FUNCTION__."."); return; }
+		
+		fwrite($fd,'<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'."\n");
+		fwrite($fd,'<sst count="'.($this->shared_string_count).'" uniqueCount="'.count($this->shared_strings).'" xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">');
+		foreach($this->shared_strings as $s=>$c)
+		{
+			fwrite($fd,'<si><t>'.self::xmlspecialchars($s).'</t></si>');
+		}
+		fwrite($fd, '</sst>');
+		fclose($fd);
+		return $tempfile;
+	}
+
+	protected function buildAppXML()
+	{
+		$app_xml="";
+		$app_xml.='<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'."\n";
+		$app_xml.='<Properties xmlns="http://schemas.openxmlformats.org/officeDocument/2006/extended-properties" xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes"><TotalTime>0</TotalTime></Properties>';
+		return $app_xml;
+	}
+
+	protected function buildCoreXML()
+	{
+		$core_xml="";
+		$core_xml.='<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'."\n";
+		$core_xml.='<cp:coreProperties xmlns:cp="http://schemas.openxmlformats.org/package/2006/metadata/core-properties" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcmitype="http://purl.org/dc/dcmitype/" xmlns:dcterms="http://purl.org/dc/terms/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">';
+		$core_xml.='<dcterms:created xsi:type="dcterms:W3CDTF">'.date("Y-m-d\TH:i:s.00\Z").'</dcterms:created>';//$date_time = '2013-07-25T15:54:37.00Z';
+		$core_xml.='<dc:creator>'.self::xmlspecialchars($this->author).'</dc:creator>';
+		$core_xml.='<cp:revision>0</cp:revision>';
+		$core_xml.='</cp:coreProperties>';
+		return $core_xml;
+	}
+
+	protected function buildRelationshipsXML()
+	{
+		$rels_xml="";
+		$rels_xml.='<?xml version="1.0" encoding="UTF-8"?>'."\n";
+		$rels_xml.='<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">';
+		$rels_xml.='<Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml"/>';
+		$rels_xml.='<Relationship Id="rId2" Type="http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties" Target="docProps/core.xml"/>';
+		$rels_xml.='<Relationship Id="rId3" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties" Target="docProps/app.xml"/>';
+		$rels_xml.="\n";
+		$rels_xml.='</Relationships>';
+		return $rels_xml;
+	}
+
+	protected function buildWorkbookXML()
+	{
+		$workbook_xml="";
+		$workbook_xml.='<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'."\n";
+		$workbook_xml.='<workbook xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">';
+		$workbook_xml.='<fileVersion appName="Calc"/><workbookPr backupFile="false" showObjects="all" date1904="false"/><workbookProtection/>';
+		$workbook_xml.='<bookViews><workbookView activeTab="0" firstSheet="0" showHorizontalScroll="true" showSheetTabs="true" showVerticalScroll="true" tabRatio="212" windowHeight="8192" windowWidth="16384" xWindow="0" yWindow="0"/></bookViews>';
+		$workbook_xml.='<sheets>';
+		foreach($this->sheets_meta as $i=>$sheet_meta) {
+			$workbook_xml.='<sheet name="'.self::xmlspecialchars($sheet_meta['sheetname']).'" sheetId="'.($i+1).'" state="visible" r:id="rId'.($i+2).'"/>';
+		}
+		$workbook_xml.='</sheets>';
+		$workbook_xml.='<calcPr iterateCount="100" refMode="A1" iterate="false" iterateDelta="0.001"/></workbook>';
+		return $workbook_xml;
+	}
+
+	protected function buildWorkbookRelsXML()
+	{
+		$wkbkrels_xml="";
+		$wkbkrels_xml.='<?xml version="1.0" encoding="UTF-8"?>'."\n";
+		$wkbkrels_xml.='<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">';
+		$wkbkrels_xml.='<Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" Target="styles.xml"/>';
+		foreach($this->sheets_meta as $i=>$sheet_meta) {
+			$wkbkrels_xml.='<Relationship Id="rId'.($i+2).'" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet" Target="worksheets/'.($sheet_meta['xmlname']).'"/>';
+		}
+		if (!empty($this->shared_strings)) {
+			$wkbkrels_xml.='<Relationship Id="rId'.(count($this->sheets_meta)+2).'" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings" Target="sharedStrings.xml"/>';
+		}
+		$wkbkrels_xml.="\n";
+		$wkbkrels_xml.='</Relationships>';
+		return $wkbkrels_xml;
+	}
+
+	protected function buildContentTypesXML()
+	{
+		$content_types_xml="";
+		$content_types_xml.='<?xml version="1.0" encoding="UTF-8"?>'."\n";
+		$content_types_xml.='<Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types">';
+		$content_types_xml.='<Override PartName="/_rels/.rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/>';
+		$content_types_xml.='<Override PartName="/xl/_rels/workbook.xml.rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/>';
+		foreach($this->sheets_meta as $i=>$sheet_meta) {
+			$content_types_xml.='<Override PartName="/xl/worksheets/'.($sheet_meta['xmlname']).'" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml"/>';
+		}
+		if (!empty($this->shared_strings)) {
+			$content_types_xml.='<Override PartName="/xl/sharedStrings.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml"/>';
+		}
+		$content_types_xml.='<Override PartName="/xl/workbook.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml"/>';
+		$content_types_xml.='<Override PartName="/xl/styles.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml"/>';
+		$content_types_xml.='<Override PartName="/docProps/app.xml" ContentType="application/vnd.openxmlformats-officedocument.extended-properties+xml"/>';
+		$content_types_xml.='<Override PartName="/docProps/core.xml" ContentType="application/vnd.openxmlformats-package.core-properties+xml"/>';
+		$content_types_xml.="\n";
+		$content_types_xml.='</Types>';
+		return $content_types_xml;
+	}
+
+	//------------------------------------------------------------------
+	/*
+	 * @param $row_number int, zero based
+	 * @param $column_number int, zero based
+	 * @return Cell label/coordinates, ex: A1, C3, AA42
+	 * */
+	public static function xlsCell($row_number, $column_number)
+	{
+		$n = $column_number;
+		for($r = ""; $n >= 0; $n = intval($n / 26) - 1) {
+			$r = chr($n%26 + 0x41) . $r;
+		}
+		return $r . ($row_number+1);
+	}
+	//------------------------------------------------------------------
+	public static function log($string)
+	{
+		file_put_contents("php://stderr", date("Y-m-d H:i:s:").rtrim(is_array($string) ? json_encode($string) : $string)."\n");
+	}
+	//------------------------------------------------------------------
+	public static function xmlspecialchars($val)
+	{
+		return str_replace("'", "&#39;", htmlspecialchars($val));
+	}
+	//------------------------------------------------------------------
+	public static function array_first_key(array $arr)
+	{
+		reset($arr);
+		$first_key = key($arr);
+		return $first_key;
+	}
+	//------------------------------------------------------------------
+	public static function convert_date_time($date_input) //thanks to Excel::Writer::XLSX::Worksheet.pm (perl)
+	{
+		$days    = 0;    # Number of days since epoch
+		$seconds = 0;    # Time expressed as fraction of 24h hours in seconds
+		$year=$month=$day=0;
+		$hour=$min  =$sec=0;
+
+		$date_time = $date_input;
+		if (preg_match("/(\d{4})\-(\d{2})\-(\d{2})/", $date_time, $matches))
+		{
+			list($junk,$year,$month,$day) = $matches;
+		}
+		if (preg_match("/(\d{2}):(\d{2}):(\d{2})/", $date_time, $matches))
+		{
+			list($junk,$hour,$min,$sec) = $matches;
+			$seconds = ( $hour * 60 * 60 + $min * 60 + $sec ) / ( 24 * 60 * 60 );
+		}
+
+		//using 1900 as epoch, not 1904, ignoring 1904 special case
+		
+		# Special cases for Excel.
+		if ("$year-$month-$day"=='1899-12-31')  return $seconds      ;    # Excel 1900 epoch
+		if ("$year-$month-$day"=='1900-01-00')  return $seconds      ;    # Excel 1900 epoch
+		if ("$year-$month-$day"=='1900-02-29')  return 60 + $seconds ;    # Excel false leapday
+
+		# We calculate the date by calculating the number of days since the epoch
+		# and adjust for the number of leap days. We calculate the number of leap
+		# days by normalising the year in relation to the epoch. Thus the year 2000
+		# becomes 100 for 4 and 100 year leapdays and 400 for 400 year leapdays.
+		$epoch  = 1900;
+		$offset = 0;
+		$norm   = 300;
+		$range  = $year - $epoch;
+
+		# Set month days and check for leap year.
+		$leap = (($year % 400 == 0) || (($year % 4 == 0) && ($year % 100)) ) ? 1 : 0;
+		$mdays = array( 31, ($leap ? 29 : 28), 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 );
+
+		# Some boundary checks
+		if($year < $epoch || $year > 9999) return 0;
+		if($month < 1     || $month > 12)  return 0;
+		if($day < 1       || $day > $mdays[ $month - 1 ]) return 0;
+
+		# Accumulate the number of days since the epoch.
+		$days = $day;    # Add days for current month
+		$days += array_sum( array_slice($mdays, 0, $month-1 ) );    # Add days for past months
+		$days += $range * 365;                      # Add days for past years
+		$days += intval( ( $range ) / 4 );             # Add leapdays
+		$days -= intval( ( $range + $offset ) / 100 ); # Subtract 100 year leapdays
+		$days += intval( ( $range + $offset + $norm ) / 400 );  # Add 400 year leapdays
+		$days -= $leap;                                      # Already counted above
+
+		# Adjust for Excel erroneously treating 1900 as a leap year.
+		if ($days > 59) { $days++;}
+
+		return $days + $seconds;
+	}
+	//------------------------------------------------------------------
+}
+
+
+
+
+
+

application/xmlpage.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2015 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-2015 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 require_once(APPROOT."/application/webpage.class.inc.php");
@@ -36,65 +37,70 @@ 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)
+		{
+			// Get the unexpected output but do nothing with it
+			$sTrash = $this->ob_get_clean_safe();
+					
+			$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('DBSearch'))
+		{
+			DBSearch::RecordQueryTrace();
+		}
 	}
-	
+
+	public function add($sText)
+	{
+		if (!$this->m_bPassThrough)
+		{
+			parent::add($sText);
+		}
+		else
+		{
+			if ($this->m_bHeaderSent)
+			{
+				echo $sText;
+			}
+			else
+			{
+				$s_captured_output = $this->ob_get_clean_safe();
+				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())
 	{
 	}
 }
-?>

approot.inc.php

@@ -1,6 +1,9 @@
 <?php
+
 define('APPROOT', dirname(__FILE__).'/');
-define('MODULESROOT', APPROOT.'modules/');
+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-2016 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-2016 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -135,7 +136,7 @@ class ActionEmail extends ActionNotification
 	{
 		$aParams = array
 		(
-			"category" => "core/cmdb,bizmodel",
+			"category" => "core/cmdb,application",
 			"key_type" => "autoincrement",
 			"name_attcode" => "name",
 			"state_attcode" => "",
@@ -156,7 +157,7 @@ class ActionEmail extends ActionNotification
 		MetaModel::Init_AddAttribute(new AttributeOQL("cc", array("allowed_values"=>null, "sql"=>"cc", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
 		MetaModel::Init_AddAttribute(new AttributeOQL("bcc", array("allowed_values"=>null, "sql"=>"bcc", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
 		MetaModel::Init_AddAttribute(new AttributeTemplateString("subject", array("allowed_values"=>null, "sql"=>"subject", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeTemplateText("body", array("allowed_values"=>null, "sql"=>"body", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeTemplateHTML("body", array("allowed_values"=>null, "sql"=>"body", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
 		MetaModel::Init_AddAttribute(new AttributeEnum("importance", array("allowed_values"=>new ValueSetEnum('low,normal,high'), "sql"=>"importance", "default_value"=>'normal', "is_null_allowed"=>false, "depends_on"=>array())));
 
 		// Display lists
@@ -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);
 	}
@@ -257,8 +262,10 @@ class ActionEmail extends ActionNotification
 			{
 				$sPrefix = '';
 			}
-			$oLog->Set('message', $sPrefix.$sRes);
-
+			if ($oLog)
+			{
+				$oLog->Set('message', $sPrefix . $sRes);
+			}
 		}
 		catch (Exception $e)
 		{
@@ -276,7 +283,6 @@ class ActionEmail extends ActionNotification
 	protected function _DoExecute($oTrigger, $aContextArgs, &$oLog)
 	{
 		$sPreviousUrlMaker = ApplicationContext::SetUrlMakerClass();
-		$aHeaders = array();
 		try
 		{
 			$this->m_iRecipients = 0;
@@ -289,16 +295,15 @@ 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)
 		{
@@ -319,8 +324,10 @@ class ActionEmail extends ActionNotification
 			if (isset($sSubject))  $oLog->Set('subject', $sSubject);
 			if (isset($sBody))     $oLog->Set('body', $sBody);
 		}
+		$sStyles = file_get_contents(APPROOT.'css/email.css');
+		$sStyles .= MetaModel::GetConfig()->Get('email_css');
 
-		$oEmail = new EMail('', '', '', $aHeaders);
+		$oEmail = new EMail();
 
 		if ($this->IsBeingTested())
 		{
@@ -339,21 +346,34 @@ class ActionEmail extends ActionNotification
 			$sTestBody .= "</ul>\n";
 			$sTestBody .= "</p>\n";
 			$sTestBody .= "</div>\n";
-			$oEmail->SetBody($sTestBody);
+			$oEmail->SetBody($sTestBody, 'text/html', $sStyles);
 			$oEmail->SetRecipientTO($this->Get('test_recipient'));
 			$oEmail->SetRecipientFrom($this->Get('test_recipient'));
 			$oEmail->SetReferences($sReference);
+			$oEmail->SetMessageId($sMessageId);
 		}
 		else
 		{
 			$oEmail->SetSubject($sSubject);
-			$oEmail->SetBody($sBody);
+			$oEmail->SetBody($sBody, 'text/html', $sStyles);
 			$oEmail->SetRecipientTO($sTo);
 			$oEmail->SetRecipientCC($sCC);
 			$oEmail->SetRecipientBCC($sBCC);
 			$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))
@@ -392,4 +412,4 @@ class ActionEmail extends ActionNotification
 		}
 	}
 }
-?>
+?>

core/apc-compat.php

@@ -0,0 +1,98 @@
+<?php
+// Copyright (C) 2016-2017 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/>
+
+// Emulate the API of APC, over APCU
+// Note: for PHP < 7, this compatibility used to be provided by APCU itself (if compiled with some options)
+//       for PHP 7+, it can be provided by the mean of apcu_bc, which is not so simple to install
+//       The current emulation aims at skipping this complexity
+if (!function_exists('apc_store') && function_exists('apcu_store'))
+{
+	function apc_add($key, $var, $ttl = 0)
+	{
+		return apcu_add($key, $var, $ttl);
+	}
+	function apc_cache_info($cache_type = '', $limited = false)
+	{
+		return apcu_cache_info($limited);
+	}
+	function apc_cas($key, $old, $new)
+	{
+		return apcu_cas($key, $old, $new);
+	}
+	function apc_clear_cache($cache_type = '')
+	{
+		return apcu_clear_cache();
+	}
+	function apc_dec($key, $step = 1, &$success = null)
+	{
+		apcu_dec($key, $step, $success);
+	}
+	function apc_delete($key)
+	{
+		return apcu_delete($key);
+	}
+	function apc_exists($keys)
+	{
+		return apcu_exists($keys);
+	}
+	function apc_fetch($key)
+	{
+		return apcu_fetch($key);
+	}
+	function apc_inc($key, $step = 1, &$success = null)
+	{
+		apcu_inc($key, $step, $success);
+	}
+	function apc_sma_info($limited = false)
+	{
+		return apcu_sma_info($limited);
+	}
+	function apc_store($key, $var, $ttl = 0)
+	{
+		return apcu_store($key, $var, $ttl);
+	}
+}
+
+/**
+ * Returns user cache info... beware of the format of the returned structure that may vary (See usages)
+ * @return array
+ */
+function apc_cache_info_compat()
+{
+	if (!function_exists('apc_cache_info')) return array();
+
+	$oFunction = new ReflectionFunction('apc_cache_info');
+	if ($oFunction->getNumberOfParameters() != 2)
+	{
+		// Beware: APCu behaves slightly differently from APC !!
+		// Worse: the compatibility layer integrated into APC differs from apcu-bc (testing the number of parameters is a must)
+		// In CLI mode (PHP > 7) apc_cache_info returns null and outputs an error message.
+		$aCacheUserData = @apc_cache_info();
+	}
+	else
+	{
+		$aCacheUserData = @apc_cache_info('user');
+	}
+	return $aCacheUserData;
+}
+
+// Cache emulation
+if (!function_exists('apc_store'))
+{
+	require_once(APPROOT.'core/apc-emulation.php');
+}

core/apc-emulation.php

@@ -0,0 +1,301 @@
+<?php
+// Copyright (c) 2010-2017 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/>
+//
+
+/**
+ * Date: 27/09/2017
+ */
+
+/**
+ * @param string $cache_type
+ * @param bool $limited
+ * @return array|bool
+ */
+function apc_cache_info($cache_type = '', $limited = false)
+{
+	$aInfo = array();
+	$sRootCacheDir = apc_emul_get_cache_filename('');
+	$aInfo['cache_list'] = apc_emul_get_cache_entries($sRootCacheDir);
+	return $aInfo;
+}
+
+function apc_emul_get_cache_entries($sEntry)
+{
+	$aResult = array();
+	if (is_dir($sEntry))
+	{
+		$aFiles = array_diff(scandir($sEntry), array('.', '..'));
+		foreach($aFiles as $sFile)
+		{
+			$sSubFile = $sEntry.'/'.$sFile;
+			$aResult = array_merge($aResult, apc_emul_get_cache_entries($sSubFile));
+		}
+	}
+	else
+	{
+		$sKey = basename($sEntry);
+		if (strpos($sKey, '-') === 0)
+		{
+			$sKey = substr($sKey, 1);
+		}
+		$aResult[] = array('info' => $sKey);
+	}
+	return $aResult;
+}
+
+/**
+ * @param array|string $key
+ * @param $var
+ * @param int $ttl
+ * @return array|bool
+ */
+function apc_store($key, $var = NULL, $ttl = 0)
+{
+	if (is_array($key))
+	{
+		$aResult = array();
+		foreach($key as $sKey => $value)
+		{
+			$aResult[] = apc_emul_store_unit($sKey, $value, $ttl);
+		}
+		return $aResult;
+	}
+	return apc_emul_store_unit($key, $var, $ttl);
+}
+
+/**
+ * @param string $sKey
+ * @param $value
+ * @param int $iTTL time to live
+ * @return bool
+ */
+function apc_emul_store_unit($sKey, $value, $iTTL)
+{
+	if ($iTTL > 0)
+	{
+		// hint for ttl management
+		$sKey = '-'.$sKey;
+	}
+
+	$sFilename = apc_emul_get_cache_filename($sKey);
+	// try to create the folder
+	$sDirname = dirname($sFilename);
+	if (!file_exists($sDirname))
+	{
+		if (!@mkdir($sDirname, 0755, true))
+		{
+			return false;
+		}
+	}
+	$bRes = !(@file_put_contents($sFilename, serialize($value), LOCK_EX) === false);
+	apc_emul_manage_new_entry($sFilename);
+	return $bRes;
+}
+
+/**
+ * @param $key string|array
+ * @return mixed
+ */
+function apc_fetch($key)
+{
+	if (is_array($key))
+	{
+		$aResult = array();
+		foreach($key as $sKey)
+		{
+			$aResult[$sKey] = apc_emul_fetch_unit($sKey);
+		}
+		return $aResult;
+	}
+	return apc_emul_fetch_unit($key);
+}
+
+/**
+ * @param $sKey
+ * @return bool|mixed
+ */
+function apc_emul_fetch_unit($sKey)
+{
+	// Try the 'TTLed' version
+	$sValue = apc_emul_readcache_locked(apc_emul_get_cache_filename('-'.$sKey));
+	if ($sValue === false)
+	{
+		$sValue = apc_emul_readcache_locked(apc_emul_get_cache_filename($sKey));
+		if ($sValue === false)
+		{
+			return false;
+		}
+	}
+	$oRes = @unserialize($sValue);
+	return $oRes;
+}
+
+function apc_emul_readcache_locked($sFilename)
+{
+	$file = @fopen($sFilename, 'r');
+	if ($file === false)
+	{
+		return false;
+	}
+	flock($file, LOCK_SH);
+	$sContent = @fread($file, @filesize($sFilename));
+	flock($file, LOCK_UN);
+	fclose($file);
+	return $sContent;
+}
+
+/**
+ * @param string $cache_type
+ * @return bool
+ */
+function apc_clear_cache($cache_type = '')
+{
+	$sRootCacheDir = apc_emul_get_cache_filename('');
+	apc_emul_delete_entry($sRootCacheDir);
+	return true;
+}
+
+function apc_emul_delete_entry($sCache)
+{
+	if (is_dir($sCache))
+	{
+		$aFiles = array_diff(scandir($sCache), array('.', '..'));
+		foreach($aFiles as $sFile)
+		{
+			$sSubFile = $sCache.'/'.$sFile;
+			if (!apc_emul_delete_entry($sSubFile))
+			{
+				return false;
+			}
+		}
+		if (!@rmdir($sCache))
+		{
+			return false;
+		}
+	}
+	else
+	{
+		if (!@unlink($sCache))
+		{
+			return false;
+		}
+	}
+	return true;
+}
+
+/**
+ * @param $key
+ * @return bool|string[]
+ */
+function apc_delete($key)
+{
+	return apc_emul_delete_entry(apc_emul_get_cache_filename($key));
+}
+
+
+function apc_emul_get_cache_filename($sKey)
+{
+	$sPath = str_replace(array(' ', '/', '\\', '.'), '-', $sKey);
+	return utils::GetCachePath().'apc-emul/'.$sPath;
+}
+
+
+/** Manage the cache files when a new cache entry is added
+ * @param string $sNewFilename new cache file added
+ */
+function apc_emul_manage_new_entry($sNewFilename)
+{
+	// Check only once per request
+	static $aFilesByTime = null;
+	static $iFileCount = 0;
+	$iMaxFiles = MetaModel::GetConfig()->Get('apc_cache_emulation.max_entries');
+	if ($iMaxFiles == 0)
+	{
+		return;
+	}
+	if (!$aFilesByTime)
+	{
+		$sRootCacheDir = apc_emul_get_cache_filename('');
+		$aFilesByTime = apc_emul_list_files_time($sRootCacheDir);
+		$iFileCount = count($aFilesByTime);
+		if ($iMaxFiles !== 0)
+		{
+			asort($aFilesByTime);
+		}
+	}
+	else
+	{
+		$aFilesByTime[$sNewFilename] = time();
+		$iFileCount++;
+	}
+	if ($iFileCount > $iMaxFiles)
+	{
+		$iFileNbToRemove = $iFileCount - $iMaxFiles;
+		foreach($aFilesByTime as $sFileToRemove => $iTime)
+		{
+			@unlink($sFileToRemove);
+			if ($iFileNbToRemove-- === 0)
+			{
+				break;
+			}
+		}
+		$aFilesByTime = array_slice($aFilesByTime, $iFileCount - $iMaxFiles, null, true);
+		$iFileCount = $iMaxFiles;
+	}
+}
+
+/** Get the list of files with their associated access time
+ * @param string $sCheck Directory to scan
+ * @param array $aFilesByTime used by recursion
+ * @return array
+ */
+function apc_emul_list_files_time($sCheck, &$aFilesByTime = array())
+{
+	// Garbage collection
+	$aFiles = array_diff(@scandir($sCheck), array('.', '..'));
+	foreach($aFiles as $sFile)
+	{
+		$sSubFile = $sCheck.'/'.$sFile;
+		if (is_dir($sSubFile))
+		{
+			apc_emul_list_files_time($sSubFile, $aFilesByTime);
+		}
+		else
+		{
+			$iTime = apc_emul_get_file_time($sSubFile);
+			if ($iTime !== false)
+			{
+				$aFilesByTime[$sSubFile] = $iTime;
+			}
+		}
+	}
+	return $aFilesByTime;
+}
+
+/** Get the file access time if TTL is managed
+ * @param string $sFilename
+ * @return bool|int returns the file atime or false if not relevant
+ */
+function apc_emul_get_file_time($sFilename)
+{
+	if (strpos(basename($sFilename), '-') === 0)
+	{
+		return @fileatime($sFilename);
+	}
+	return false;
+}

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(AttributeDateTime::GetSQLFormat());
+		// 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,20 +80,101 @@ 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())));
+		MetaModel::Init_AddAttribute(new AttributeInteger("last_error_code", array("allowed_values"=>null, "sql"=>"last_error_code", "default_value"=>0, "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeString("last_error", array("allowed_values"=>null, "sql"=>"last_error", "default_value"=>'', "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeDateTime("last_attempt", array("allowed_values"=>null, "sql"=>"last_attempt", "default_value"=>"", "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
+		{
+			if ($this->Get('status') == 'running')
+			{
+				return self::ALREADY_RUNNING;
+			}
+			else
+			{
+				$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($iErrorCode = null)
+	{
+		$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($iErrorCode = null)
+	{
+		$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'];
+		}
+	}
+
+	/**
+	 * Override to notify people that a task cannot be performed
+	 */
+	protected function OnDefinitiveFailure()
+	{
 	}
 
   	protected function OnInsert()
@@ -100,18 +182,92 @@ abstract class AsyncTask extends DBObject
 		$this->Set('created', time());
 	}
 
-   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)
+			{
+				$this->HandleError($e->getMessage(), $e->getCode());
+			}
 		}
+		else
+		{
+			// Already done or being handled by another process... skip...
+			$bRet = false;
+		}
+		return $bRet;
 	}
 
+	/**
+	 * Overridable to extend the behavior in case of error (logging)
+	 */
+	protected function HandleError($sErrorMessage, $iErrorCode)
+	{
+		if ($this->Get('last_attempt') == '')
+		{
+			// First attempt
+			$this->Set('remaining_retries', $this->GetMaxRetries($iErrorCode));
+		}
+
+		$this->Set('last_error', $sErrorMessage);
+		$this->Set('last_error_code', $iErrorCode); // Note: can be ZERO !!!
+		$this->Set('last_attempt', time());
+
+		$iRemaining = $this->Get('remaining_retries');
+		if ($iRemaining > 0)
+		{
+			$iRetryDelay = $this->GetRetryDelay($iErrorCode);
+			IssueLog::Info('Failed to process async task #'.$this->GetKey().' - reason: '.$sErrorMessage.' - 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);
+		}
+		else
+		{
+			IssueLog::Error('Failed to process async task #'.$this->GetKey().' - reason: '.$sErrorMessage);
+
+			$this->Set('status', 'error');
+			$this->Set('started', null);
+			$this->Set('planned', null);
+			$this->OnDefinitiveFailure();
+		}
+		$this->DBUpdate();
+	}
+
+	/**
+	 * Throws an exception (message and code)
+	 */	 	
 	abstract public function DoProcess();
+
+	/**
+	 * Describes the error codes that DoProcess can return by the mean of exceptions	
+	 */	
+	static public function EnumErrorCodes()
+	{
+		return array();
+	}
 }
 
 /**
@@ -138,10 +294,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 AttributeLongText("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 +307,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 +356,4 @@ class AsyncSendEmail extends AsyncTask
 		}
 	}
 }
-?>
+?>

core/autoload.php

@@ -0,0 +1,38 @@
+<?php
+// Copyright (C) 2016 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/>
+
+MetaModel::IncludeModule('application/transaction.class.inc.php');
+MetaModel::IncludeModule('application/menunode.class.inc.php');
+MetaModel::IncludeModule('application/user.preferences.class.inc.php');
+MetaModel::IncludeModule('application/user.dashboard.class.inc.php');
+MetaModel::IncludeModule('application/audit.rule.class.inc.php');
+MetaModel::IncludeModule('application/query.class.inc.php');
+MetaModel::IncludeModule('setup/moduleinstallation.class.inc.php');
+
+MetaModel::IncludeModule('core/event.class.inc.php');
+MetaModel::IncludeModule('core/action.class.inc.php');
+MetaModel::IncludeModule('core/trigger.class.inc.php');
+MetaModel::IncludeModule('core/bulkexport.class.inc.php');
+MetaModel::IncludeModule('core/ownershiplock.class.inc.php');
+MetaModel::IncludeModule('synchro/synchrodatasource.class.inc.php');
+MetaModel::IncludeModule('core/backgroundtask.class.inc.php');
+MetaModel::IncludeModule('core/inlineimage.class.inc.php');
+
+MetaModel::IncludeModule('webservices/webservices.basic.php');
+
+//MetaModel::IncludeModule('addons', 'user rights', 'addons/userrights/userrightsprofile.class.inc.php');

core/background.inc.php

@@ -0,0 +1,55 @@
+<?php
+// Copyright (C) 2017 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/>
+
+
+/**
+ * Tasks performed in the background
+ *
+ * @copyright   Copyright (C) 2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+
+class ObsolescenceDateUpdater implements iBackgroundProcess
+{
+	public function GetPeriodicity()
+	{
+		return MetaModel::GetConfig()->Get('obsolescence.date_update_interval'); // 10 mn
+	}
+
+	public function Process($iUnixTimeLimit)
+	{
+		$iCountSet = 0;
+		$iCountReset = 0;
+		$iClasses = 0;
+		foreach (MetaModel::EnumObsoletableClasses() as $sClass)
+		{
+			$oObsoletedToday = new DBObjectSearch($sClass);
+			$oObsoletedToday->AddCondition('obsolescence_flag', 1, '=');
+			$oObsoletedToday->AddCondition('obsolescence_date', null, '=');
+			$sToday = date(AttributeDate::GetSQLFormat());
+			$iCountSet += MetaModel::BulkUpdate($oObsoletedToday, array('obsolescence_date' => $sToday));
+
+			$oObsoletedToday = new DBObjectSearch($sClass);
+			$oObsoletedToday->AddCondition('obsolescence_flag', 1, '!=');
+			$oObsoletedToday->AddCondition('obsolescence_date', null, '!=');
+			$iCountReset += MetaModel::BulkUpdate($oObsoletedToday, array('obsolescence_date' => null));
+		}
+		echo "Obsolescence date updated (classes: $iClasses ; set: $iCountSet ; reset: $iCountReset)\n";
+	}
+}

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-2017 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-2015 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);
 	}
 }
 
@@ -252,9 +258,11 @@ class BulkChange
 	protected $m_aReconcilKeys; // attcode (attcode = 'id' for the pkey)
 	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_sDateFormat; // Date format specification, see DateTime::createFromFormat
+	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;
@@ -285,11 +295,20 @@ class BulkChange
 	protected function ResolveExternalKey($aRowData, $sAttCode, &$aResults)
 	{
 		$oExtKey = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
-		$oReconFilter = new CMDBSearchFilter($oExtKey->GetTargetClass());
+		$oReconFilter = new DBObjectSearch($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());
+				$oReconFilter = new DBObjectSearch($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', $iCount);
+					$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
@@ -400,36 +471,49 @@ class BulkChange
 			// skip the private key, if any
 			if ($sAttCode == 'id') continue;
 
+			$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
+
+			// skip reconciliation keys
+			if (!$oAttDef->IsWritable() && in_array($sAttCode, $this->m_aReconcilKeys)){ continue; }
+
 			$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
 			$aReasons = array();
 			$iFlags = $oTargetObj->GetAttributeFlags($sAttCode, $aReasons);
 			if ( (($iFlags & OPT_ATT_READONLY) == OPT_ATT_READONLY) && ( $oTargetObj->Get($sAttCode) != $aRowData[$iCol]) )
 			{
-					$aErrors[$sAttCode] = "the attribute '$sAttCode' is read-only and cannot be modified (current value: ".$oTargetObj->Get($sAttCode).", proposed value: {$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);
+					}
 				}
 			}
 		}
@@ -447,17 +531,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))
 				{
@@ -473,7 +559,15 @@ class BulkChange
 				else
 				{
 					// By default... nothing happens
-					$aResults[$iCol]= new CellStatus_Void($aRowData[$iCol]);
+					$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
+					if ($oAttDef instanceof AttributeDateTime)
+					{
+						$aResults[$iCol]= new CellStatus_Void($oAttDef->GetFormat()->Format($aRowData[$iCol]));
+					}
+					else
+					{
+						$aResults[$iCol]= new CellStatus_Void($aRowData[$iCol]);
+					}
 				}
 			}
 		}
@@ -484,7 +578,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;
 	}
@@ -548,7 +642,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;
 	}
@@ -562,7 +656,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;
 		}
 	
@@ -581,7 +675,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;
 		}
 	
@@ -615,7 +709,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;
 		}
 	
@@ -656,7 +750,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;
 		}
 	
@@ -714,26 +808,55 @@ class BulkChange
 
 		if (!is_null($this->m_sDateFormat) && (strlen($this->m_sDateFormat) > 0))
 		{
+			$sDateTimeFormat = $this->m_sDateFormat; // the specified format is actually the date AND time format
+			$oDateTimeFormat = new DateTimeFormat($sDateTimeFormat);
+			$sDateFormat = $oDateTimeFormat->ToDateFormat();
+			AttributeDateTime::SetFormat($oDateTimeFormat);
+			AttributeDate::SetFormat(new DateTimeFormat($sDateFormat));
 			// Translate dates from the source data
 			//
 			foreach ($this->m_aAttList as $sAttCode => $iCol)
 			{
+				if ($sAttCode == 'id') continue;
+				
 				$oAttDef = MetaModel::GetAttributeDef($this->m_sClass, $sAttCode);
-				if ($oAttDef instanceof AttributeDateTime)
+				if ($oAttDef instanceof AttributeDateTime) // AttributeDate is derived from AttributeDateTime
 				{
 					foreach($this->m_aData as $iRow => $aRowData)
 					{
-						$sNewDate = utils::StringToTime($this->m_aData[$iRow][$iCol], $this->m_sDateFormat);
-						if ($sNewDate !== false)
+						$sFormat = $sDateTimeFormat;
+						$sValue = $this->m_aData[$iRow][$iCol];
+						if (!empty($sValue))
 						{
-							// Todo - improve the reporting
-							$this->m_aData[$iRow][$iCol] = $sNewDate;
+							if ($oAttDef instanceof AttributeDate)
+							{
+								$sFormat = $sDateFormat;
+							}
+							$oFormat = new DateTimeFormat($sFormat);
+							$sRegExp = $oFormat->ToRegExpr('/');
+							if (!preg_match($sRegExp, $this->m_aData[$iRow][$iCol]))
+							{
+								$aResult[$iRow]["__STATUS__"]= new RowStatus_Issue(Dict::S('UI:CSVReport-Row-Issue-DateFormat'));
+							}
+							else
+							{
+								$oDate = DateTime::createFromFormat($sFormat, $this->m_aData[$iRow][$iCol]);
+								if ($oDate !== false)
+								{
+									$sNewDate = $oDate->format($oAttDef->GetInternalFormat());
+									$this->m_aData[$iRow][$iCol] = $sNewDate;
+								}
+								else
+								{
+									// Leave the cell unchanged
+									$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'));
+								}
+							}
 						}
 						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');
+							$this->m_aData[$iRow][$iCol] = '';
 						}
 					}
 				}
@@ -746,98 +869,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 DBObjectSearch($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()));
 			}
 		}
 
@@ -851,11 +992,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
 		//
@@ -899,22 +1042,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);
 			}
 		}
@@ -923,7 +1066,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))
 			{
@@ -967,7 +1110,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+')),
@@ -987,7 +1129,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>');
@@ -1005,6 +1147,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);
@@ -1072,7 +1215,7 @@ EOF
 			{
 				$sAttCode = $oOperation->Get('attcode');
 
-				if (get_class($oOperation) == 'CMDBChangeOpSetAttributeScalar')
+				if ((get_class($oOperation) == 'CMDBChangeOpSetAttributeScalar') || (get_class($oOperation) == 'CMDBChangeOpSetAttributeURL'))
 				{
 					$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
 					if ($oAttDef->IsExternalKey())
@@ -1166,50 +1309,5 @@ 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/bulkexport.class.inc.php

@@ -0,0 +1,431 @@
+<?php
+// Copyright (C) 2015 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/>
+
+define('EXPORTER_DEFAULT_CHUNK_SIZE', 1000);
+
+class BulkExportException extends Exception
+{
+	protected $sLocalizedMessage;
+	public function __construct($message, $sLocalizedMessage, $code = null, $previous = null)
+	{
+		parent::__construct($message, $code, $previous);
+		$this->sLocalizedMessage = $sLocalizedMessage;
+	}
+	
+	public function GetLocalizedMessage()
+	{
+		return $this->sLocalizedMessage;
+	}
+}
+class BulkExportMissingParameterException extends BulkExportException
+{
+	public function __construct($sFieldCode)
+	{
+		parent::__construct('Missing parameter: '.$sFieldCode, Dict::Format('Core:BulkExport:MissingParameter_Param', $sFieldCode));
+	}
+		
+}
+
+/**
+ * Class BulkExport
+ *
+ * @copyright   Copyright (C) 2015 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+class BulkExportResult extends DBObject
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => 'core/cmdb',
+			"key_type" => 'autoincrement',
+			"name_attcode" => array('created'),
+			"state_attcode" => '',
+			"reconc_keys" => array(),
+			"db_table" => 'priv_bulk_export_result',
+			"db_key_field" => 'id',
+			"db_finalclass_field" => '',
+			"display_template" => '',
+		);
+		MetaModel::Init_Params($aParams);
+
+		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 AttributeInteger("user_id", array("allowed_values"=>null, "sql"=>"user_id", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeInteger("chunk_size", array("allowed_values"=>null, "sql"=>"chunk_size", "default_value"=>0, "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeString("format", array("allowed_values"=>null, "sql"=>"format", "default_value"=>'', "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeString("temp_file_path", array("allowed_values"=>null, "sql"=>"temp_file_path", "default_value"=>'', "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeLongText("search", array("allowed_values"=>null, "sql"=>"search", "default_value"=>'', "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeLongText("status_info", array("allowed_values"=>null, "sql"=>"status_info", "default_value"=>'', "is_null_allowed"=>false, "depends_on"=>array())));
+	}
+	
+	public function ComputeValues()
+	{
+		$this->Set('user_id', UserRights::GetUserId());
+	}
+}
+
+/**
+ * Garbage collector for cleaning "old" export results from the database and the disk.
+ * This background process runs once per day and deletes the results of all exports which
+ * are older than one day.
+ */
+class BulkExportResultGC implements iBackgroundProcess
+{
+	public function GetPeriodicity()
+	{
+		return 24*3600; // seconds
+	}
+
+	public function Process($iTimeLimit)
+	{
+		$sDateLimit = date(AttributeDateTime::GetSQLFormat(), time() - 24*3600); // Every BulkExportResult older than one day will be deleted
+
+		$sOQL = "SELECT BulkExportResult WHERE created < '$sDateLimit'";
+		$iProcessed = 0;
+		while (time() < $iTimeLimit)
+		{
+			// Next one ?
+			$oSet = new CMDBObjectSet(DBObjectSearch::FromOQL($sOQL), array('created' => true) /* order by*/, array(), null, 1 /* limit count */);
+			$oSet->OptimizeColumnLoad(array('temp_file_path'));
+			$oResult = $oSet->Fetch();
+			if (is_null($oResult))
+			{
+				// Nothing to be done
+				break;
+			}
+			$iProcessed++;
+			@unlink($oResult->Get('temp_file_path'));
+			utils::PushArchiveMode(false);
+			$oResult->DBDelete();
+			utils::PopArchiveMode();
+		}
+		return "Cleaned $iProcessed old export results(s).";
+	}
+}
+
+/**
+ * Class BulkExport
+ *
+ * @copyright   Copyright (C) 2015 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+abstract class BulkExport
+{
+	protected $oSearch;
+	protected $iChunkSize;
+	protected $sFormatCode;
+	protected $aStatusInfo;
+	protected $oBulkExportResult;
+	protected $sTmpFile;
+	protected $bLocalizeOutput;
+	
+	public function __construct()
+	{
+		$this->oSearch = null;
+		$this->iChunkSize = 0;
+		$this->sFormatCode = null;
+		$this->aStatusInfo = array();
+		$this->oBulkExportResult = null;
+		$this->sTmpFile = '';
+		$this->bLocalizeOutput = false;
+	}
+		
+	/**
+	 * Find the first class capable of exporting the data in the given format
+	 * @param string $sFormat The lowercase format (e.g. html, csv, spreadsheet, xlsx, xml, json, pdf...)
+	 * @param DBSearch $oSearch The search/filter defining the set of objects to export or null when listing the supported formats
+	 * @return iBulkExport|NULL
+	 */
+	static public function FindExporter($sFormatCode, $oSearch = null)
+	{
+		foreach(get_declared_classes() as $sPHPClass)
+		{
+			$oRefClass = new ReflectionClass($sPHPClass);
+			if ($oRefClass->isSubclassOf('BulkExport') && !$oRefClass->isAbstract())
+			{
+				$oBulkExporter = new $sPHPClass();
+				if ($oBulkExporter->IsFormatSupported($sFormatCode, $oSearch))
+				{
+					if ($oSearch)
+					{
+						$oBulkExporter->SetObjectList($oSearch);
+					}
+					return $oBulkExporter;
+				}
+			}
+		}
+		return null;
+	}
+	
+	/**
+	 * Find the exporter corresponding to the given persistent token
+	 * @param int $iPersistentToken The identifier of the BulkExportResult object storing the information
+	 * @return iBulkExport|NULL
+	 */
+	static public function FindExporterFromToken($iPersistentToken = null)
+	{
+		$oBulkExporter = null;
+		$oInfo = MetaModel::GetObject('BulkExportResult', $iPersistentToken, false);
+		if ($oInfo && ($oInfo->Get('user_id') == UserRights::GetUserId()))
+		{
+			$sFormatCode = $oInfo->Get('format');
+			$oSearch = DBObjectSearch::unserialize($oInfo->Get('search'));
+			
+			$oBulkExporter = self::FindExporter($sFormatCode, $oSearch);
+			if ($oBulkExporter)
+			{
+				$oBulkExporter->SetFormat($sFormatCode);
+				$oBulkExporter->SetObjectList($oSearch);
+				$oBulkExporter->SetChunkSize($oInfo->Get('chunk_size'));
+				$oBulkExporter->SetStatusInfo(json_decode($oInfo->Get('status_info'), true));
+				$oBulkExporter->sTmpFile = $oInfo->Get('temp_file_path');
+				$oBulkExporter->oBulkExportResult = $oInfo;
+			}
+		}
+		return $oBulkExporter;
+	}
+	
+	public function AppendToTmpFile($data)
+	{
+		if ($this->sTmpFile == '')
+		{
+			$this->sTmpFile = $this->MakeTmpFile($this->GetFileExtension());
+		}
+		$hFile = fopen($this->sTmpFile, 'ab');
+		if ($hFile !== false)
+		{
+			fwrite($hFile, $data);
+			fclose($hFile);
+		}
+	}
+	
+	public function GetTmpFilePath()
+	{
+		return $this->sTmpFile;
+	}
+	
+	/**
+	 * Lists all possible export formats. The output is a hash array in the form: 'format_code' => 'localized format label'
+	 * @return multitype:string
+	 */
+	static public function FindSupportedFormats()
+	{
+		$aSupportedFormats = array();
+		foreach(get_declared_classes() as $sPHPClass)
+		{
+			$oRefClass = new ReflectionClass($sPHPClass);
+			if ($oRefClass->isSubClassOf('BulkExport') && !$oRefClass->isAbstract())
+			{
+				$oBulkExporter = new $sPHPClass;
+				$aFormats = $oBulkExporter->GetSupportedFormats();
+				$aSupportedFormats = array_merge($aSupportedFormats, $aFormats);
+			}
+		}
+		return $aSupportedFormats;
+	}
+
+	/**
+	 * (non-PHPdoc)
+	 * @see iBulkExport::SetChunkSize()
+	 */
+	public function SetChunkSize($iChunkSize)
+	{
+		$this->iChunkSize = $iChunkSize;
+	}
+	
+	/**
+	 * (non-PHPdoc)
+	 * @see iBulkExport::SetObjectList()
+	 */
+	public function SetObjectList(DBSearch $oSearch)
+	{
+		$this->oSearch = $oSearch;
+	}
+	
+	public function SetFormat($sFormatCode)
+	{
+		$this->sFormatCode = $sFormatCode;	
+	}
+	
+	/**
+	 * (non-PHPdoc)
+	 * @see iBulkExport::IsFormatSupported()
+	 */
+	public function IsFormatSupported($sFormatCode, $oSearch = null)
+	{
+		return array_key_exists($sFormatCode, $this->GetSupportedFormats());
+	}
+
+	/**
+	 * (non-PHPdoc)
+	 * @see iBulkExport::GetSupportedFormats()
+	 */
+	public function GetSupportedFormats()
+	{
+		return array(); // return array('csv' => Dict::S('UI:ExportFormatCSV'));
+	}
+	
+
+	public function SetHttpHeaders(WebPage $oPage)
+	{
+	}
+
+	public function GetHeader()
+	{
+	}
+	abstract public function GetNextChunk(&$aStatus);
+	public function GetFooter()
+	{
+		
+	}
+	
+	public function SaveState()
+	{
+		if ($this->oBulkExportResult === null)
+		{
+			$this->oBulkExportResult = new BulkExportResult();
+			$this->oBulkExportResult->Set('format', $this->sFormatCode);
+			$this->oBulkExportResult->Set('search', $this->oSearch->serialize());
+			$this->oBulkExportResult->Set('chunk_size', $this->iChunkSize);	
+			$this->oBulkExportResult->Set('temp_file_path', $this->sTmpFile);	
+		}
+		$this->oBulkExportResult->Set('status_info', json_encode($this->GetStatusInfo()));
+		utils::PushArchiveMode(false);
+		$ret = $this->oBulkExportResult->DBWrite();
+		utils::PopArchiveMode();
+		return $ret;
+	}
+	
+	public function Cleanup()
+	{
+		if (($this->oBulkExportResult &&  (!$this->oBulkExportResult->IsNew())))
+		{
+			$sFilename = $this->oBulkExportResult->Get('temp_file_path');
+			if ($sFilename != '')
+			{
+				@unlink($sFilename);
+			}
+			utils::PushArchiveMode(false);
+			$this->oBulkExportResult->DBDelete();
+			utils::PopArchiveMode();
+		}
+	}
+	
+	public function EnumFormParts()
+	{
+		return array();
+	}
+	
+	public function DisplayFormPart(WebPage $oP, $sPartId)
+	{
+	}
+	
+	public function DisplayUsage(Page $oP)
+	{
+		
+	}
+	public function ReadParameters()
+	{
+		$this->bLocalizeOutput = !((bool)utils::ReadParam('no_localize', 0, true, 'integer'));
+	}
+	
+	public function GetResultAsHtml()
+	{
+		
+	}
+	public function GetRawResult()
+	{
+		
+	}
+	public function GetMimeType()
+	{
+		
+	}
+	public function GetFileExtension()
+	{
+		
+	}
+	public function GetCharacterSet()
+	{
+		return 'UTF-8';
+	}
+	
+	public function GetStatistics()
+	{
+		
+	}
+	
+	public function GetDownloadFileName()
+	{
+		return Dict::Format('Core:BulkExportOf_Class', MetaModel::GetName($this->oSearch->GetClass())).'.'.$this->GetFileExtension();
+	}
+
+	public function SetStatusInfo($aStatusInfo)
+	{
+		$this->aStatusInfo = $aStatusInfo;
+	}
+	
+	public function GetStatusInfo()
+	{
+		return $this->aStatusInfo;
+	}
+
+	protected function MakeTmpFile($sExtension)
+	{
+		if(!is_dir(APPROOT."data/bulk_export"))
+		{
+			@mkdir(APPROOT."data/bulk_export", 0777, true /* recursive */);
+			clearstatcache();
+		}
+		if (!is_writable(APPROOT."data/bulk_export"))
+		{
+			throw new Exception('Data directory "'.APPROOT.'data/bulk_export" could not be written.');
+		}
+
+		$iNum = rand();
+		$sFileName = '';
+		do
+		{
+			$iNum++;
+			$sToken = sprintf("%08x", $iNum);
+			$sFileName = APPROOT."data/bulk_export/$sToken.".$sExtension;
+			$hFile = @fopen($sFileName, 'x');
+		}
+		while($hFile === false);
+	
+		fclose($hFile);
+		return $sFileName;
+	}
+}
+
+// The built-in exports
+require_once(APPROOT.'core/tabularbulkexport.class.inc.php');
+require_once(APPROOT.'core/htmlbulkexport.class.inc.php');
+if (extension_loaded('gd'))
+{
+	// PDF export - via TCPDF - requires GD
+	require_once(APPROOT.'core/pdfbulkexport.class.inc.php');
+}
+require_once(APPROOT.'core/csvbulkexport.class.inc.php');
+require_once(APPROOT.'core/excelbulkexport.class.inc.php');
+require_once(APPROOT.'core/spreadsheetbulkexport.class.inc.php');
+require_once(APPROOT.'core/xmlbulkexport.class.inc.php');
+

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-2016 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-2016 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();
@@ -51,7 +55,7 @@ class CMDBChangeOp extends DBObject
 		MetaModel::Init_AddAttribute(new AttributeExternalField("date", array("allowed_values"=>null, "extkey_attcode"=>"change", "target_attcode"=>"date")));
 		MetaModel::Init_AddAttribute(new AttributeExternalField("userinfo", array("allowed_values"=>null, "extkey_attcode"=>"change", "target_attcode"=>"userinfo")));
 		MetaModel::Init_AddAttribute(new AttributeString("objclass", array("allowed_values"=>null, "sql"=>"objclass", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
-		MetaModel::Init_AddAttribute(new AttributeString("objkey", array("allowed_values"=>null, "sql"=>"objkey", "default_value"=>"", "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeObjectKey("objkey", array("allowed_values"=>null, "class_attcode"=>"objclass", "sql"=>"objkey", "is_null_allowed"=>false, "depends_on"=>array())));
 
 		MetaModel::Init_SetZListItems('details', array('change', 'date', 'userinfo')); // Attributes to be displayed for the complete details
 		MetaModel::Init_SetZListItems('list', array('change', 'date', 'userinfo')); // Attributes to be displayed for the complete details
@@ -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,62 @@ 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->DescribeChangeAsHTML($sOldValue, $sNewValue);
+		}
+		return $sResult;
+	}
+}
+/**
+ * Record the modification of an URL 
+ *
+ * @package     iTopORM
+ */
+class CMDBChangeOpSetAttributeURL 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_url",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_InheritAttributes();
+		MetaModel::Init_AddAttribute(new AttributeURL("oldvalue", array("allowed_values"=>null, "sql"=>"oldvalue", "target" => '_blank', "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeURL("newvalue", array("allowed_values"=>null, "sql"=>"newvalue", "target" => '_blank', "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
+		
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('date', 'userinfo', 'attcode', 'oldvalue', 'newvalue')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('date', 'userinfo', 'attcode', 'oldvalue', 'newvalue')); // Attributes to be displayed for a list
+	}
+	
+	/**
+	 * 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();
+			$sNewValue = $this->Get('newvalue');
+			$sOldValue = $this->Get('oldvalue');
+			$sResult = $oAttDef->DescribeChangeAsHTML($sOldValue, $sNewValue);
 		}
 		return $sResult;
 	}
@@ -339,14 +344,30 @@ 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";
-			$sDocView .= Dict::Format('UI:DownloadDocument_', $oPrevDoc->GetDownloadLink(get_class($this), $this->GetKey(), 'prevdata'))."\n";
-			//$sDocView = $oPrevDoc->GetDisplayInline(get_class($this), $this->GetKey(), 'prevdata');
-			$sResult = Dict::Format('Change:AttName_Changed_PreviousValue_OldValue', $sAttName, $sDocView);
+			if ($oPrevDoc->IsEmpty())
+			{
+				$sPrevious = '';
+				$sResult = Dict::Format('Change:AttName_Changed_PreviousValue_OldValue', $sAttName, $sPrevious);
+			}
+			else
+			{
+				$sDocView = $oPrevDoc->GetAsHtml();
+				$sDocView .= "<br/>".Dict::Format('UI:OpenDocumentInNewWindow_', $oPrevDoc->GetDisplayLink(get_class($this), $this->GetKey(), 'prevdata')).", \n";
+				$sDocView .= Dict::Format('UI:DownloadDocument_', $oPrevDoc->GetDownloadLink(get_class($this), $this->GetKey(), 'prevdata'))."\n";
+				//$sDocView = $oPrevDoc->GetDisplayInline(get_class($this), $this->GetKey(), 'prevdata');
+				$sResult = Dict::Format('Change:AttName_Changed_PreviousValue_OldValue', $sAttName, $sDocView);
+			}
 		}
 		return $sResult;
 	}
@@ -395,8 +416,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 +476,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 +539,16 @@ 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');
@@ -513,6 +558,128 @@ class CMDBChangeOpSetAttributeText extends CMDBChangeOpSetAttribute
 	}
 }
 
+/**
+ * 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()
+	{
+		$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');
+			$sResult = Dict::Format('Change:AttName_Changed_PreviousValue_OldValue', $sAttName, $sTextView);
+		}
+		return $sResult;
+	}
+}
+
+/**
+ * Record the modification of a multiline string (text) containing some HTML markup
+ *
+ * @package     iTopORM
+ */
+class CMDBChangeOpSetAttributeHTML extends CMDBChangeOpSetAttributeLongText
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "core/cmdb",
+			"key_type" => "",
+			"name_attcode" => "change",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_changeop_setatt_html",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_InheritAttributes();
+		
+		// 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()
+	{
+		$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 class="history_entry history_entry_truncated"><div class="history_html_content">'.$this->Get('prevdata').'</div></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 caselog (text)
  * since the caselog itself stores the history
@@ -562,12 +729,30 @@ 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();
-			$sResult = Dict::Format('Change:AttName_EntryAdded', $sAttName);
+			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');
+			}
+			$oObj = $oMonoObjectSet->Fetch();
+			$oCaseLog = $oObj->Get($this->Get('attcode'));
+			$iMaxVisibleLength = MetaModel::getConfig()->Get('max_history_case_log_entry_length', 0);
+			$sTextEntry = '<div class="history_entry history_entry_truncated"><div class="history_html_content">'.$oCaseLog->GetEntryAt($this->Get('lastentry')).'</div></div>';
+
+			$sResult = Dict::Format('Change:AttName_EntryAdded', $sAttName, $sTextEntry);
 		}
 		return $sResult;
 	}
+	
+	protected function ToHtml($sRawText)
+	{
+		return str_replace(array("\r\n", "\n", "\r"), "<br/>", htmlentities($sRawText, ENT_QUOTES, 'UTF-8'));
+	}
 }
 
 /**
@@ -607,4 +792,251 @@ 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;
+	}
+}
+
+/**
+ * Record the modification of custom fields
+ *
+ * @package     iTopORM
+ */
+class CMDBChangeOpSetAttributeCustomFields 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_custfields",
+			"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()
+	{
+		$sResult = '';
+		if (MetaModel::IsValidAttCode($this->Get('objclass'), $this->Get('attcode')))
+		{
+			$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)
+			{
+				$aValues = json_decode($this->Get('prevdata'), true);
+				$oAttDef = MetaModel::GetAttributeDef($this->Get('objclass'), $this->Get('attcode'));
+				$sAttName = $oAttDef->GetLabel();
+
+				try
+				{
+					$oHandler = $oAttDef->GetHandler($aValues);
+					$sValueDesc = $oHandler->GetAsHTML($aValues);
+				}
+				catch (Exception $e)
+				{
+					$sValueDesc = 'Custom field error: '.htmlentities($e->getMessage(), ENT_QUOTES, 'UTF-8');
+				}
+				$sTextView = '<div>'.$sValueDesc.'</div>';
+
+				$sResult = Dict::Format('Change:AttName_Changed_PreviousValue_OldValue', $sAttName, $sTextView);
+			}
+		}
+		return $sResult;
+	}
+}

core/cmdbobject.class.inc.php

@@ -1,26 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2017 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-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 
@@ -45,18 +46,20 @@ require_once('stimulus.class.inc.php');
 require_once('valuesetdef.class.inc.php');
 require_once('MyHelpers.class.inc.php');
 
-require_once('expression.class.inc.php');
-
-require_once('cmdbsource.class.inc.php');
-require_once('sqlquery.class.inc.php');
+require_once('oql/expression.class.inc.php');
 require_once('oql/oqlquery.class.inc.php');
 require_once('oql/oqlexception.class.inc.php');
 require_once('oql/oql-parser.php');
 require_once('oql/oql-lexer.php');
 require_once('oql/oqlinterpreter.class.inc.php');
 
+require_once('cmdbsource.class.inc.php');
+require_once('sqlquery.class.inc.php');
+require_once('sqlobjectquery.class.inc.php');
+require_once('sqlunionquery.class.inc.php');
+
 require_once('dbobject.class.php');
-require_once('dbobjectsearch.class.php');
+require_once('dbsearch.class.php');
 require_once('dbobjectset.class.php');
 
 require_once('backgroundprocess.inc.php');
@@ -91,8 +94,12 @@ 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;
-
-
+	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;
@@ -100,158 +107,343 @@ abstract class CMDBObject extends DBObject
 
 	//
 	// Todo: simplify the APIs and do not pass the current change as an argument anymore
-	//       SetCurrentChange to be invoked in very few cases (UI.php, CSV import, Data synchro)
+	//       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
 	//
-	public static function GetCurrentChange()
+	/**
+	 * 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;
 	}
 
-
-	private function RecordObjCreation(CMDBChange $oChange)
+	/**
+	 * 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)
+
+	/**
+	 * @param $sAttCode
+	 * @param $original Original value
+	 * @param $value Current value
+	 */
+	protected function RecordAttChange($sAttCode, $original, $value)
 	{
+		$oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
+		if ($oAttDef->IsExternalField()) return;
+		if ($oAttDef->IsLinkSet()) return;
+		if ($oAttDef->GetTrackingLevel() == ATTRIBUTE_TRACKING_NONE) return;
+
+		if ($oAttDef instanceOf AttributeOneWayPassword)
+		{
+			// One Way encrypted passwords' history is stored -one way- encrypted
+			$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeOneWayPassword");
+			$oMyChangeOp->Set("objclass", get_class($this));
+			$oMyChangeOp->Set("objkey", $this->GetKey());
+			$oMyChangeOp->Set("attcode", $sAttCode);
+
+			if (is_null($original))
+			{
+				$original = '';
+			}
+			$oMyChangeOp->Set("prev_pwd", $original);
+			$iId = $oMyChangeOp->DBInsertNoReload();
+		}
+		elseif ($oAttDef instanceOf AttributeEncryptedString)
+		{
+			// Encrypted string history is stored encrypted
+			$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeEncrypted");
+			$oMyChangeOp->Set("objclass", get_class($this));
+			$oMyChangeOp->Set("objkey", $this->GetKey());
+			$oMyChangeOp->Set("attcode", $sAttCode);
+
+			if (is_null($original))
+			{
+				$original = '';
+			}
+			$oMyChangeOp->Set("prevstring", $original);
+			$iId = $oMyChangeOp->DBInsertNoReload();
+		}
+		elseif ($oAttDef instanceOf AttributeBlob)
+		{
+			// Data blobs
+			$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeBlob");
+			$oMyChangeOp->Set("objclass", get_class($this));
+			$oMyChangeOp->Set("objkey", $this->GetKey());
+			$oMyChangeOp->Set("attcode", $sAttCode);
+
+			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)
+			//
+			foreach ($oAttDef->ListSubItems() as $sSubItemAttCode => $oSubItemAttDef)
+			{
+				$item_value = $oAttDef->GetSubItemValue($oSubItemAttDef->Get('item_code'), $value, $this);
+				$item_original = $oAttDef->GetSubItemValue($oSubItemAttDef->Get('item_code'), $original, $this);
+
+				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("objclass", get_class($this));
+			$oMyChangeOp->Set("objkey", $this->GetKey());
+			$oMyChangeOp->Set("attcode", $sAttCode);
+
+			$oMyChangeOp->Set("lastentry", $value->GetLatestEntryIndex());
+			$iId = $oMyChangeOp->DBInsertNoReload();
+		}
+		elseif ($oAttDef instanceOf AttributeLongText)
+		{
+			// Data blobs
+			if ($oAttDef->GetFormat() == 'html')
+			{
+				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeHTML");
+			}
+			else
+			{
+				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeLongText");
+			}
+			$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 AttributeText)
+		{
+			// Data blobs
+			if ($oAttDef->GetFormat() == 'html')
+			{
+				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeHTML");
+			}
+			else
+			{
+				$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();
+		}
+		elseif ($oAttDef instanceOf AttributeCustomFields)
+		{
+			// Custom fields
+			//
+			$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeCustomFields");
+			$oMyChangeOp->Set("objclass", get_class($this));
+			$oMyChangeOp->Set("objkey", $this->GetKey());
+			$oMyChangeOp->Set("attcode", $sAttCode);
+			$oMyChangeOp->Set("prevdata", json_encode($original->GetValues()));
+			$iId = $oMyChangeOp->DBInsertNoReload();
+		}
+		elseif ($oAttDef instanceOf AttributeURL)
+		{
+			// URLs
+			//
+			$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeURL");
+			$oMyChangeOp->Set("objclass", get_class($this));
+			$oMyChangeOp->Set("objkey", $this->GetKey());
+			$oMyChangeOp->Set("attcode", $sAttCode);
+			$oMyChangeOp->Set("oldvalue", $original);
+			$oMyChangeOp->Set("newvalue", $value);
+			$iId = $oMyChangeOp->DBInsertNoReload();
+		}
+		else
+		{
+			// Scalars
+			//
+			$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);
+			$iId = $oMyChangeOp->DBInsertNoReload();
+		}
+	}
+
+	/**
+	 * @param array $aValues
+	 * @param 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 instanceOf AttributeOneWayPassword)
+			if (array_key_exists($sAttCode, $aOrigValues))
 			{
-				// 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
-				{
-					$original = '';
-				}
-				$oMyChangeOp->Set("prev_pwd", $original);
-				$iId = $oMyChangeOp->DBInsertNoReload();
-			}
-			elseif ($oAttDef instanceOf AttributeEncryptedString)
-			{
-				// 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
-				{
-					$original = '';
-				}
-				$oMyChangeOp->Set("prevstring", $original);
-				$iId = $oMyChangeOp->DBInsertNoReload();
-			}
-			elseif ($oAttDef instanceOf AttributeBlob)
-			{
-				// 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
-				{
-					$original = new ormDocument();
-				}
-				$oMyChangeOp->Set("prevdata", $original);
-				$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);
-
-				$oMyChangeOp->Set("lastentry", $value->GetLatestEntryIndex());
-				$iId = $oMyChangeOp->DBInsertNoReload();
-			}
-			elseif ($oAttDef instanceOf AttributeText)
-			{
-				// Data blobs
-				$oMyChangeOp = MetaModel::NewObject("CMDBChangeOpSetAttributeText");
-				$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];
-					if ($original instanceof ormCaseLog)
-					{
-						$original = $original->GetText();
-					}
-				}
-				else
-				{
-					$original = null;
-				}
-				$oMyChangeOp->Set("prevdata", $original);
-				$iId = $oMyChangeOp->DBInsertNoReload();
+				$original = $aOrigValues[$sAttCode];
 			}
 			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("newvalue", $value);
-				$iId = $oMyChangeOp->DBInsertNoReload();
+				$original = null;
 			}
+			$this->RecordAttChange($sAttCode, $original, $value);
 		}
 	}
 
@@ -284,66 +476,51 @@ 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;
 	}
-
+	
+	/**
+	 * To Be Obsoleted: DO NOT rely on an overload of this method since
+	 * DBInsertTracked (resp. DBInsertTrackedNoReload) may call directly
+	 * DBInsert (resp. DBInsertNoReload) in future versions of iTop.
+	 * @param bool $bDoNotReload
+	 * @return integer Identifier of the created object
+	 */
 	protected function DBInsertTracked_Internal($bDoNotReload = false)
 	{
 		if ($bDoNotReload)
 		{
-			$ret = parent::DBInsertNoReload();
+			$ret = $this->DBInsertNoReload();
 		}
 		else
 		{
-			$ret = parent::DBInsert();
+			$ret = $this->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)
@@ -351,131 +528,60 @@ 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)
+	public static function BulkUpdate(DBSearch $oFilter, array $aValues)
 	{
-		if(!self::$m_oCurrChange)
-		{
-			throw new CoreException("BulkDelete() could not be used here, please use BulkDeleteTracked() instead");
-		}
-		return $this->BulkDeleteTracked_Internal($oFilter);
+		return static::BulkUpdateTracked_Internal($oFilter, $aValues);
 	}
 
-	public static function BulkDeleteTracked(CMDBChange $oChange, DBObjectSearch $oFilter)
+	public static function BulkUpdateTracked(CMDBChange $oChange, DBSearch $oFilter, array $aValues)
 	{
-		$oPreviousChange = self::$m_oCurrChange;
-		self::$m_oCurrChange = $oChange;
-		$this->BulkDeleteTracked_Internal($oFilter);
-		self::$m_oCurrChange = $oPreviousChange;
+		self::SetCurrentChange($oChange);
+		static::BulkUpdateTracked_Internal($oFilter, $aValues);
 	}
 
-	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;
-		$this->BulkUpdateTracked_Internal($oFilter, $aValues);
-		self::$m_oCurrChange = $oPreviousChange;
-	}
-
-	protected static function BulkUpdateTracked_Internal(DBObjectSearch $oFilter, array $aValues)
+	protected static function BulkUpdateTracked_Internal(DBSearch $oFilter, array $aValues)
 	{
 		// $aValues is an array of $sAttCode => $value
 
@@ -499,10 +605,38 @@ 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;
 	}
+
+	public function DBArchive()
+	{
+		// Note: do the job anyway, so as to repair any DB discrepancy
+		$bOriginal = $this->Get('archive_flag');
+		parent::DBArchive();
+
+		if (!$bOriginal)
+		{
+			utils::PushArchiveMode(false);
+			$this->RecordAttChange('archive_flag', false, true);
+			utils::PopArchiveMode();
+		}
+	}
+
+	public function DBUnarchive()
+	{
+		// Note: do the job anyway, so as to repair any DB discrepancy
+		$bOriginal = $this->Get('archive_flag');
+		parent::DBUnarchive();
+
+		if ($bOriginal)
+		{
+			utils::PushArchiveMode(false);
+			$this->RecordAttChange('archive_flag', true, false);
+			utils::PopArchiveMode();
+		}
+	}
 }
 
 
@@ -522,7 +656,7 @@ class CMDBObjectSet extends DBObjectSet
 	
 	static public function FromScratch($sClass)
 	{
-		$oFilter = new CMDBSearchFilter($sClass);
+		$oFilter = new DBObjectSearch($sClass);
 		$oFilter->AddConditionExpression(new FalseExpression());
 		$oRetSet = new self($oFilter);
 		// NOTE: THIS DOES NOT WORK IF m_bLoaded is private in the base class (and you will not get any error message)
@@ -546,7 +680,7 @@ class CMDBObjectSet extends DBObjectSet
 		// let's create one search definition
 		$sClass = reset($aClasses);
 		$sAlias = key($aClasses);
-		$oFilter = new CMDBSearchFilter($sClass, $sAlias);
+		$oFilter = new DBObjectSearch($sClass, $sAlias);
 
 		$oRetSet = new CMDBObjectSet($oFilter);
 		$oRetSet->m_bLoaded = true; // no DB load
@@ -556,18 +690,5 @@ class CMDBObjectSet extends DBObjectSet
 			$oRetSet->AddObjectExtended($aObjectsByClassAlias);
 		}
 		return $oRetSet;
-	} 
+	}
 }
-
-/**
- * TODO: investigate how to get rid of this class that was made to workaround some language limitation... or a poor design!
- *
- * @package     iTopORM
- */
-class CMDBSearchFilter extends DBObjectSearch
-{
-	// this is the public interface (?)
-}
-
-
-?>

core/cmdbsource.class.inc.php

@@ -1,36 +1,48 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2015 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-2015 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_errno'] = $oException->getCode();
+			$this->code = $oException->getCode();
+			$aContext['mysql_error'] = $oException->getMessage();
+		}
+		else
+		{
+			$aContext['mysql_errno'] = CMDBSource::GetErrNo();
+			$this->code = CMDBSource::GetErrNo();
+			$aContext['mysql_error'] = CMDBSource::GetError();
+		}
 		parent::__construct($sIssue, $aContext);
 	}
 }
@@ -48,7 +60,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 +68,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($sServer, 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 +156,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 +169,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 +209,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 +270,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 +330,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);
+			throw new 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);
+			throw new 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 +400,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)
+		{
+			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));
 		}
-
-		$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)
+		{
+			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));
 		}
 
-		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 +543,54 @@ class CMDBSource
 		return ($aFieldData["Type"]);
 	}
 
-	public static function HasIndex($sTable, $sField)
+	public static function GetFieldSpec($sTable, $sField)
 	{
 		$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);
+		$sRet = $aFieldData["Type"];
+		if ($aFieldData["Null"] == 'NO')
+		{
+			$sRet .= ' NOT NULL';
+		}
+		if (is_numeric($aFieldData["Default"]))
+		{
+			if (strtolower(substr($aFieldData["Type"], 0, 5)) == 'enum(')
+			{
+				// Force quotes to match the column declaration statement
+				$sRet .= ' DEFAULT '.self::Quote($aFieldData["Default"], true);
+			}
+			else
+			{
+				$default = $aFieldData["Default"] + 0; // Coerce to a numeric variable
+				$sRet .= ' DEFAULT '.self::Quote($default);
+			}
+		}
+		elseif (is_string($aFieldData["Default"]) == 'string')
+		{
+			$sRet .= ' DEFAULT '.self::Quote($aFieldData["Default"]);
+		}
+		return $sRet;
+	}
+
+	public static function HasIndex($sTable, $sIndexId, $aFields = null)
+	{
+		$aTableInfo = self::GetTableInfo($sTable);
+		if (empty($aTableInfo)) return false;
+		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 +640,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 +676,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 +724,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 +732,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 +750,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 +786,4 @@ class CMDBSource
 		}
 		return false;
 	}
-}
-
-
-?>
+}

core/computing.inc.php

@@ -0,0 +1,139 @@
+<?php
+// Copyright (C) 2010-2014 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)
+	{
+		if (class_exists('WorkingTimeRecorder'))
+		{
+			WorkingTimeRecorder::Trace(WorkingTimeRecorder::TRACE_DEBUG, __class__.'::'.__function__);
+		}
+		//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');
+		if (class_exists('WorkingTimeRecorder'))
+		{
+			WorkingTimeRecorder::SetValues($oStartDate->format('U'), $oResult->format('U'), $iDuration, WorkingTimeRecorder::COMPUTED_END);
+		}
+		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)
+	{
+		if (class_exists('WorkingTimeRecorder'))
+		{
+			WorkingTimeRecorder::Trace(WorkingTimeRecorder::TRACE_DEBUG, __class__.'::'.__function__);
+		}
+		//echo "GetOpenDuration - default: ".$oStartDate->format('Y-m-d H:i:s')." to ".$oEndDate->format('Y-m-d H:i:s')."<br/>\n";
+		$iDuration = abs($oEndDate->format('U') - $oStartDate->format('U'));
+		if (class_exists('WorkingTimeRecorder'))
+		{
+			WorkingTimeRecorder::SetValues($oStartDate->format('U'), $oEndDate->format('U'), $iDuration, WorkingTimeRecorder::COMPUTED_DURATION);
+		}
+		return $iDuration;
+	}
+}
+
+
+?>

core/contexttag.class.inc.php

@@ -0,0 +1,75 @@
+<?php
+// Copyright (C) 2016-2017 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/>
+
+
+/**
+ * Simple helper class for keeping track of the context inside the call stack
+ * 
+ * To check (anywhere in the code) if a particular context tag is present
+ * in the call stack simply do:
+ * 
+ * if (ContextTag::Check(<the_tag>)) ...
+ * 
+ * For example to know if the code is being executed in the context of a portal do:
+ * 
+ * if (ContextTag::Check('GUI:Portal'))
+ *
+ * @copyright   Copyright (C) 2016-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+class ContextTag
+{
+	protected static $aStack = array();
+	
+	/**
+	 * Store a context tag on the stack
+	 * @param string $sTag
+	 */
+	public function __construct($sTag)
+	{
+		static::$aStack[] = $sTag;
+	}
+	
+	/**
+	 * Cleanup the context stack
+	 */
+	public function __destruct()
+	{
+		array_pop(static::$aStack);
+	}
+	
+	/**
+	 * Check if a given tag is present in the stack
+	 * @param string $sTag
+	 * @return bool
+	 */
+	public static function Check($sTag)
+	{
+		return in_array($sTag, static::$aStack);
+	}
+	
+	/**
+	 * Get the whole stack as an array
+	 * @return hash
+	 */
+	public static function GetStack()
+	{
+		return static::$aStack;
+	}
+}

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
  */
 
 
@@ -111,4 +112,13 @@ class SecurityException extends CoreException
 {
 }
 
+/**
+ * Throwned when querying on an object that exists in the database but is archived
+ *
+ * @see N.1108
+ */
+class ArchivedObjectException extends CoreException
+{
+}
+
 ?>

core/csvbulkexport.class.inc.php

@@ -0,0 +1,381 @@
+<?php
+// Copyright (C) 2015-2016 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/>
+
+/**
+ * Bulk export: CSV export
+ *
+ * @copyright   Copyright (C) 2015-2016 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+class CSVBulkExport extends TabularBulkExport
+{
+	public function DisplayUsage(Page $oP)
+	{
+		$oP->p(" * csv format options:");
+		$oP->p(" *\tfields: (mandatory) the comma separated list of field codes to export (e.g: name,org_id,service_name...).");
+		$oP->p(" *\tseparator: (optional) character to be used as the separator (default is ',').");
+		$oP->p(" *\tcharset: (optional) character set for encoding the result (default is 'UTF-8').");
+		$oP->p(" *\ttext-qualifier: (optional) character to be used around text strings (default is '\"').");
+		$oP->p(" *\tno_localize: set to 1 to retrieve non-localized values (for instance for ENUM values). Default is 0 (= localized values)");
+		$oP->p(" *\tformatted_text: set to 1 to export case logs and formatted text fields with their HTML markup. Default is 0 (= plain text)");
+		$oP->p(" *\tdate_format: the format to use when exporting date and time fields (default = the SQL format used in the user interface). e.g. 'Y-m-d H:i:s'");
+	}
+
+	public function ReadParameters()
+	{
+		parent::ReadParameters();
+		$this->aStatusInfo['separator'] = utils::ReadParam('separator', ',', true, 'raw_data');
+		if (strtolower($this->aStatusInfo['separator']) == 'tab')
+		{
+			$this->aStatusInfo['separator'] = "\t";
+		}
+		else if (strtolower($this->aStatusInfo['separator']) == 'other')
+		{
+			$this->aStatusInfo['separator'] = utils::ReadParam('other-separator', ',', true, 'raw_data');
+		}
+			
+		$this->aStatusInfo['text_qualifier'] = utils::ReadParam('text-qualifier', '"', true, 'raw_data');
+		if (strtolower($this->aStatusInfo['text_qualifier']) == 'other')
+		{
+			$this->aStatusInfo['text_qualifier'] = utils::ReadParam('other-text-qualifier', '"', true, 'raw_data');
+		}
+
+		$this->aStatusInfo['charset'] = strtoupper(utils::ReadParam('charset', 'UTF-8', true, 'raw_data'));
+		$this->aStatusInfo['formatted_text'] = (bool)utils::ReadParam('formatted_text', 0, true);
+		
+		$sDateFormatRadio = utils::ReadParam('csv_date_format_radio', '');
+		switch($sDateFormatRadio)
+		{
+			case 'default':
+			// Export from the UI => format = same as is the UI
+			$this->aStatusInfo['date_format'] = (string)AttributeDateTime::GetFormat();
+			break;
+			
+			case 'custom':
+			// Custom format specified from the UI
+			$this->aStatusInfo['date_format'] = utils::ReadParam('date_format', (string)AttributeDateTime::GetFormat(), true, 'raw_data');
+			break;
+			
+			default:
+			// Export from the command line (or scripted) => default format is SQL, as in previous versions of iTop, unless specified otherwise
+			$this->aStatusInfo['date_format'] = utils::ReadParam('date_format', (string)AttributeDateTime::GetSQLFormat(), true, 'raw_data');
+		}
+	}
+
+
+	protected function SuggestField($sClass, $sAttCode)
+	{
+		switch($sAttCode)
+		{
+			case 'id': // replace 'id' by 'friendlyname'
+				$sAttCode = 'friendlyname';
+				break;
+					
+			default:
+				$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+				if ($oAttDef instanceof AttributeExternalKey)
+				{
+					$sAttCode .= '_friendlyname';
+				}
+		}
+
+		return parent::SuggestField($sClass, $sAttCode);
+	}
+
+	public function EnumFormParts()
+	{
+		return array_merge(parent::EnumFormParts(), array('csv_options' => array('separator', 'charset', 'text-qualifier', 'no_localize', 'formatted_text') ,'interactive_fields_csv' => array('interactive_fields_csv')));
+	}
+
+	public function DisplayFormPart(WebPage $oP, $sPartId)
+	{
+		switch($sPartId)
+		{
+			case 'interactive_fields_csv':
+				$this->GetInteractiveFieldsWidget($oP, 'interactive_fields_csv');
+				break;
+
+			case 'csv_options':
+				$oP->add('<fieldset><legend>'.Dict::S('Core:BulkExport:CSVOptions').'</legend>');
+				$oP->add('<table class="export_parameters"><tr><td style="vertical-align:top">');
+				$oP->add('<h3>'.Dict::S('UI:CSVImport:SeparatorCharacter').'</h3>');
+				$sRawSeparator = utils::ReadParam('separator', ',', true, 'raw_data');
+				$sCustomDateTimeFormat = utils::ReadParam('', ',', true, 'raw_data');
+				$aSep = array(
+					';' => Dict::S('UI:CSVImport:SeparatorSemicolon+'),
+					',' => Dict::S('UI:CSVImport:SeparatorComma+'),
+					'tab' => Dict::S('UI:CSVImport:SeparatorTab+'),
+				);
+				$sOtherSeparator = '';
+				if (!array_key_exists($sRawSeparator, $aSep))
+				{
+					$sOtherSeparator = $sRawSeparator;
+					$sRawSeparator = 'other';
+				}
+				$aSep['other'] = Dict::S('UI:CSVImport:SeparatorOther').' <input type="text" size="3" name="other-separator" value="'.htmlentities($sOtherSeparator, ENT_QUOTES, 'UTF-8').'"/>';
+
+				foreach($aSep as $sVal => $sLabel)
+				{
+					$sChecked = ($sVal == $sRawSeparator) ? 'checked' : '';
+					$oP->add('<input type="radio" name="separator" value="'.htmlentities($sVal, ENT_QUOTES, 'UTF-8').'" '.$sChecked.'/>&nbsp;'.$sLabel.'<br/>');
+				}
+					
+				$oP->add('</td><td style="vertical-align:top">');
+					
+				$oP->add('<h3>'.Dict::S('UI:CSVImport:TextQualifierCharacter').'</h3>');
+
+				$sRawQualifier = utils::ReadParam('text-qualifier', '"', true, 'raw_data');
+				$aQualifiers = array(
+					'"' => Dict::S('UI:CSVImport:QualifierDoubleQuote+'),
+					'\'' => Dict::S('UI:CSVImport:QualifierSimpleQuote+'),
+				);
+				$sOtherQualifier = '';
+				if (!array_key_exists($sRawQualifier, $aQualifiers))
+				{
+					$sOtherQualifier = $sRawQualifier;
+					$sRawQualifier = 'other';
+				}
+				$aQualifiers['other'] = Dict::S('UI:CSVImport:QualifierOther').' <input type="text" size="3" name="other-text-qualifier" value="'.htmlentities($sOtherQualifier, ENT_QUOTES, 'UTF-8').'"/>';
+					
+				foreach($aQualifiers as $sVal => $sLabel)
+				{
+					$sChecked = ($sVal == $sRawQualifier) ? 'checked' : '';
+					$oP->add('<input type="radio" name="text-qualifier" value="'.htmlentities($sVal, ENT_QUOTES, 'UTF-8').'" '.$sChecked.'/>&nbsp;'.$sLabel.'<br/>');
+				}
+				
+				$sChecked = (utils::ReadParam('no_localize', 0) == 1) ? ' checked ' : '';
+				$oP->add('</td><td style="vertical-align:top">');
+				$oP->add('<h3>'.Dict::S('Core:BulkExport:CSVLocalization').'</h3>');
+				$oP->add('<input type="checkbox" id="csv_no_localize" name="no_localize" value="1"'.$sChecked.'><label for="csv_no_localize"> '.Dict::S('Core:BulkExport:OptionNoLocalize').'</label>');
+				$oP->add('<br/>');
+				$oP->add('<br/>');
+				$oP->add(Dict::S('UI:CSVImport:Encoding').': <select name="charset" style="font-family:Arial,Helvetica,Sans-serif">'); // IE 8 has some troubles if the font is different
+				$aPossibleEncodings = utils::GetPossibleEncodings(MetaModel::GetConfig()->GetCSVImportCharsets());
+				$sDefaultEncoding = MetaModel::GetConfig()->Get('csv_file_default_charset');
+				foreach($aPossibleEncodings as $sIconvCode => $sDisplayName )
+				{
+					$sSelected  = '';
+					if ($sIconvCode == $sDefaultEncoding)
+					{
+						$sSelected = ' selected';
+					}
+					$oP->add('<option value="'.$sIconvCode.'"'.$sSelected.'>'.$sDisplayName.'</option>');
+				}
+				$oP->add('</select>');
+
+				$sChecked = (utils::ReadParam('formatted_text', 0) == 1) ? ' checked ' : '';
+				$oP->add('<h3>'.Dict::S('Core:BulkExport:TextFormat').'</h3>');
+				$oP->add('<input type="checkbox" id="csv_formatted_text" name="formatted_text" value="1"'.$sChecked.'><label for="csv_formatted_text"> '.Dict::S('Core:BulkExport:OptionFormattedText').'</label>');
+				$oP->add('</td><td style="vertical-align:top">');
+				
+				$sDateTimeFormat = utils::ReadParam('date_format', (string)AttributeDateTime::GetFormat(), true, 'raw_data');
+				$sDefaultChecked = ($sDateTimeFormat == (string)AttributeDateTime::GetFormat()) ? ' checked' : '';
+				$sCustomChecked = ($sDateTimeFormat !== (string)AttributeDateTime::GetFormat()) ? ' checked' : '';
+				$oP->add('<h3>'.Dict::S('Core:BulkExport:DateTimeFormat').'</h3>');
+				$sDefaultFormat = htmlentities((string)AttributeDateTime::GetFormat(), ENT_QUOTES, 'UTF-8');
+				$sExample = htmlentities(date((string)AttributeDateTime::GetFormat()), ENT_QUOTES, 'UTF-8');
+				$oP->add('<input type="radio" id="csv_date_time_format_default" name="csv_date_format_radio" value="default"'.$sDefaultChecked.'><label for="csv_date_time_format_default"> '.Dict::Format('Core:BulkExport:DateTimeFormatDefault_Example', $sDefaultFormat, $sExample).'</label><br/>');
+				$sFormatInput = '<input type="text" size="15" name="date_format" id="csv_custom_date_time_format" title="" value="'.htmlentities($sDateTimeFormat, ENT_QUOTES, 'UTF-8').'"/>';
+				$oP->add('<input type="radio" id="csv_date_time_format_custom" name="csv_date_format_radio" value="custom"'.$sCustomChecked.'><label for="csv_date_time_format_custom"> '.Dict::Format('Core:BulkExport:DateTimeFormatCustom_Format', $sFormatInput).'</label>');
+				$oP->add('</td></tr></table>');
+				
+				$oP->add('</fieldset>');
+				$sJSTooltip = json_encode('<div class="date_format_tooltip">'.Dict::S('UI:CSVImport:CustomDateTimeFormatTooltip').'</div>');
+
+				$oP->add_ready_script(
+<<<EOF
+$('#csv_custom_date_time_format').tooltip({content: function() { return $sJSTooltip; } });
+$('#form_part_csv_options').on('preview_updated', function() { FormatDatesInPreview('csv', 'csv'); });
+$('#csv_date_time_format_default').on('click', function() { FormatDatesInPreview('csv', 'csv'); });
+$('#csv_date_time_format_custom').on('click', function() { FormatDatesInPreview('csv', 'csv'); });
+$('#csv_custom_date_time_format').on('click', function() { $('#csv_date_time_format_custom').prop('checked', true); FormatDatesInPreview('csv', 'csv'); }).on('keyup', function() { FormatDatesInPreview('csv', 'csv'); });
+EOF
+				);
+				
+				break;
+					
+					
+			default:
+				return parent:: DisplayFormPart($oP, $sPartId);
+		}
+	}
+
+	protected function GetSampleData($oObj, $sAttCode)
+	{	
+		if ($sAttCode != 'id')
+		{
+			$oAttDef = MetaModel::GetAttributeDef(get_class($oObj), $sAttCode);
+			if ($oAttDef instanceof AttributeDateTime) // AttributeDate is derived from AttributeDateTime
+			{
+				$sClass = (get_class($oAttDef) == 'AttributeDateTime') ? 'user-formatted-date-time' : 'user-formatted-date';
+				return '<div class="'.$sClass.'" data-date="'.$oObj->Get($sAttCode).'">'.htmlentities($oAttDef->GetEditValue($oObj->Get($sAttCode), $oObj), ENT_QUOTES, 'UTF-8').'</div>';
+			}
+		}
+		return '<div class="text-preview">'.htmlentities($this->GetValue($oObj, $sAttCode), ENT_QUOTES, 'UTF-8').'</div>';
+	}
+
+	protected function GetValue($oObj, $sAttCode)
+	{
+		switch($sAttCode)
+		{
+			case 'id':
+				$sRet = $oObj->GetKey();
+				break;
+					
+			default:
+				$sRet = trim($oObj->GetAsCSV($sAttCode), '"');				
+		}
+		return $sRet;
+	}
+
+	public function GetHeader()
+	{
+		$oSet = new DBObjectSet($this->oSearch);
+		$this->aStatusInfo['status'] = 'running';
+		$this->aStatusInfo['position'] = 0;
+		$this->aStatusInfo['total'] = $oSet->Count();
+
+		$aData = array();
+		foreach($this->aStatusInfo['fields'] as $iCol => $aFieldSpec)
+		{
+			$aData[] = $aFieldSpec['sColLabel'];
+		}
+		$sFrom = array("\r\n", $this->aStatusInfo['text_qualifier']);
+		$sTo = array("\n", $this->aStatusInfo['text_qualifier'].$this->aStatusInfo['text_qualifier']);
+		foreach($aData as $idx => $sData)
+		{
+			// Escape and encode (if needed) the headers
+			$sEscaped = str_replace($sFrom, $sTo, (string)$sData);
+			$aData[$idx] = $this->aStatusInfo['text_qualifier'].$sEscaped.$this->aStatusInfo['text_qualifier'];
+			if ($this->aStatusInfo['charset'] != 'UTF-8')
+			{
+				// Note: due to bugs in the glibc library it's safer to call iconv on the smallest possible string
+				// and thus to convert field by field and not the whole row or file at once (see ticket #991)
+				$aData[$idx] = @iconv('UTF-8', $this->aStatusInfo['charset'].'//IGNORE//TRANSLIT', $aData[$idx]);
+			}
+		}
+		$sData = implode($this->aStatusInfo['separator'], $aData)."\n";
+
+		return $sData;
+	}
+
+	public function GetNextChunk(&$aStatus)
+	{
+		$sRetCode = 'run';
+		$iPercentage = 0;
+
+		$oSet = new DBObjectSet($this->oSearch);
+		$oSet->SetLimit($this->iChunkSize, $this->aStatusInfo['position']);
+		$this->OptimizeColumnLoad($oSet);
+
+		$iCount = 0;
+		$sData = '';
+		$iPreviousTimeLimit = ini_get('max_execution_time');
+		$iLoopTimeLimit = MetaModel::GetConfig()->Get('max_execution_time_per_loop');
+		$sExportDateTimeFormat = $this->aStatusInfo['date_format'];
+		$oPrevDateTimeFormat = AttributeDateTime::GetFormat();
+		$oPrevDateFormat = AttributeDate::GetFormat();
+		if ($sExportDateTimeFormat !== (string)$oPrevDateTimeFormat)
+		{
+			// Change date & time formats
+			$oDateTimeFormat = new DateTimeFormat($sExportDateTimeFormat);
+			$oDateFormat = new DateTimeFormat($oDateTimeFormat->ToDateFormat());
+			AttributeDateTime::SetFormat($oDateTimeFormat);
+			AttributeDate::SetFormat($oDateFormat);
+		}
+		while($aRow = $oSet->FetchAssoc())
+		{
+			set_time_limit($iLoopTimeLimit);
+			$aData = array();
+			foreach($this->aStatusInfo['fields'] as $iCol => $aFieldSpec)
+			{
+				$sAlias = $aFieldSpec['sAlias'];
+				$sAttCode = $aFieldSpec['sAttCode'];
+
+				$sField = '';
+				$oObj = $aRow[$sAlias];
+				if ($oObj != null)
+				{
+					switch($sAttCode)
+					{
+						case 'id':
+							$sField = $oObj->GetKey();
+							break;
+								
+						default:
+							$sField = $oObj->GetAsCSV($sAttCode, $this->aStatusInfo['separator'], $this->aStatusInfo['text_qualifier'], $this->bLocalizeOutput, !$this->aStatusInfo['formatted_text']);
+					}
+				}
+				if ($this->aStatusInfo['charset'] != 'UTF-8')
+				{
+					// Note: due to bugs in the glibc library it's safer to call iconv on the smallest possible string
+					// and thus to convert field by field and not the whole row or file at once (see ticket #991)
+					$aData[] = @iconv('UTF-8', $this->aStatusInfo['charset'].'//IGNORE//TRANSLIT', $sField);
+				}
+				else
+				{
+					$aData[] = $sField;
+				}
+			}
+			$sData .= implode($this->aStatusInfo['separator'], $aData)."\n";
+			$iCount++;
+		}
+		// Restore original date & time formats
+		AttributeDateTime::SetFormat($oPrevDateTimeFormat);
+		AttributeDate::SetFormat($oPrevDateFormat);
+		set_time_limit($iPreviousTimeLimit);
+		$this->aStatusInfo['position'] += $this->iChunkSize;
+		if ($this->aStatusInfo['total'] == 0)
+		{
+			$iPercentage = 100;
+		}
+		else
+		{
+			$iPercentage = floor(min(100.0, 100.0*$this->aStatusInfo['position']/$this->aStatusInfo['total']));
+		}
+
+		if ($iCount < $this->iChunkSize)
+		{
+			$sRetCode = 'done';
+		}
+
+		$aStatus = array('code' => $sRetCode, 'message' => Dict::S('Core:BulkExport:RetrievingData'), 'percentage' => $iPercentage);
+		return $sData;
+	}
+
+	public function GetSupportedFormats()
+	{
+		return array('csv' => Dict::S('Core:BulkExport:CSVFormat'));
+	}
+
+	public function GetMimeType()
+	{
+		return 'text/csv';
+	}
+
+	public function GetFileExtension()
+	{
+		return 'csv';
+	}
+	public function GetCharacterSet()
+	{
+		return $this->aStatusInfo['charset'];
+	}
+
+}

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
  */
 
 
@@ -53,12 +54,14 @@ class CSVParser
 	private $m_sCSVData;
 	private $m_sSep;
 	private $m_sTextQualifier;
+	private $m_iTimeLimitPerRow;
 
-	public function __construct($sTxt, $sSep = ',', $sTextQualifier = '"')
+	public function __construct($sTxt, $sSep = ',', $sTextQualifier = '"', $iTimeLimitPerRow = null)
 	{
 		$this->m_sCSVData = str_replace("\r\n", "\n", $sTxt);
 		$this->m_sSep = $sSep;
 		$this->m_sTextQualifier = $sTextQualifier;
+		$this->m_iTimeLimitPerRow = $iTimeLimitPerRow;
 	}
 
 	protected $m_sCurrCell = '';
@@ -128,6 +131,12 @@ class CSVParser
 			// blank line, skip silently
 		}
 		$this->m_aCurrRow = array();
+		
+		// More time for the next row
+		if ($this->m_iTimeLimitPerRow !== null)
+		{
+			set_time_limit($this->m_iTimeLimitPerRow);
+		}
 	}
 	protected function __AddCellTrimmed($c = null, $aFieldMap = null)
 	{
@@ -180,6 +189,13 @@ class CSVParser
 		$iDataLength = strlen($this->m_sCSVData);
 
 		$iState = stSTARTING;
+		$iTimeLimit = null;
+		if ($this->m_iTimeLimitPerRow !== null)
+		{
+			// Give some time for the first row
+			$iTimeLimit = ini_get('max_execution_time');
+			set_time_limit($this->m_iTimeLimitPerRow);
+		}
 		for($i = 0; $i <= $iDataLength ; $i++)
 		{
 			if ($i == $iDataLength)
@@ -236,6 +252,11 @@ class CSVParser
 			$iLineCount = count($this->m_aDataSet);
 			if (($iMax > 0) && ($iLineCount >= $iMax)) break;
 		}
+		if ($iTimeLimit !== null)
+		{
+			// Restore the previous time limit
+			set_time_limit($iTimeLimit);
+		}
 		return $this->m_aDataSet;
 	}
 

core/customfieldshandler.class.inc.php

@@ -0,0 +1,140 @@
+<?php
+// Copyright (C) 2016 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/>
+
+use Combodo\iTop\Form\Form;
+use Combodo\iTop\Form\FormManager;
+
+/**
+ * Base class to implement a handler for AttributeCustomFields
+ *
+ * @copyright   Copyright (C) 2016 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+abstract class CustomFieldsHandler
+{
+	protected $sAttCode;
+	protected $aValues;
+	protected $oForm;
+
+	/**
+	 * This constructor's prototype must be frozen.
+	 * Any specific behavior must be implemented in BuildForm()
+	 *
+	 * @param $sAttCode
+	 */
+	final public function __construct($sAttCode)
+	{
+		$this->sAttCode = $sAttCode;
+		$this->aValues = null;
+	}
+
+	abstract public function BuildForm(DBObject $oHostObject, $sFormId);
+
+	/**
+	 *
+	 * @return \Combodo\iTop\Form\Form
+	 */
+	public function GetForm()
+	{
+		return $this->oForm;
+	}
+
+	public function SetCurrentValues($aValues)
+	{
+		$this->aValues = $aValues;
+	}
+
+	static public function GetPrerequisiteAttributes($sClass = null)
+	{
+		return array();
+	}
+
+	/**
+	 * List the available verbs for 'GetForTemplate'
+	 */
+	static public function EnumTemplateVerbs()
+	{
+		return array();
+	}
+
+	/**
+	 * Get various representations of the value, for insertion into a template (e.g. in Notifications)
+	 * @param $aValues array The current values
+	 * @param $sVerb string The verb specifying the representation of the value
+	 * @param $bLocalize bool Whether or not to localize the value
+	 * @return string
+	 */
+	abstract public function GetForTemplate($aValues, $sVerb, $bLocalize = true);
+
+	/**
+	 * @param $aValues
+	 * @param bool|true $bLocalize
+	 * @return mixed
+	 */
+	abstract public function GetAsHTML($aValues, $bLocalize = true);
+
+	/**
+	 * @param $aValues
+	 * @param bool|true $bLocalize
+	 * @return mixed
+	 */
+	abstract public function GetAsXML($aValues, $bLocalize = true);
+
+	/**
+	 * @param $aValues
+	 * @param string $sSeparator
+	 * @param string $sTextQualifier
+	 * @param bool|true $bLocalize
+	 * @return mixed
+	 */
+	abstract public function GetAsCSV($aValues, $sSeparator = ',', $sTextQualifier = '"', $bLocalize = true);
+
+	/**
+	 * @param DBObject $oHostObject
+	 * @return array Associative array id => value
+	 */
+	abstract public function ReadValues(DBObject $oHostObject);
+
+	/**
+	 * Record the data (currently in the processing of recording the host object)
+	 * It is assumed that the data has been checked prior to calling Write()
+	 * @param DBObject $oHostObject
+	 * @param array Associative array id => value
+	 */
+	abstract public function WriteValues(DBObject $oHostObject, $aValues);
+
+	/**
+	 * Cleanup data upon object deletion (object id still available here)
+	 * @param DBObject $oHostObject
+	 */
+	abstract public function DeleteValues(DBObject $oHostObject);
+
+	/**
+	 * @param $aValuesA
+	 * @param $aValuesB
+	 * @return bool
+	 */
+	abstract public function CompareValues($aValuesA, $aValuesB);
+
+	/**
+	 * String representation of the value, must depend solely on the semantics
+	 * @return string
+	 */
+	abstract public function GetValueFingerprint();
+}

core/data.generator.class.inc.php

@@ -1,27 +1,28 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2015 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-2015 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
 /**
@@ -266,7 +267,7 @@ class cmdbDataGenerator
 	function GenerateKey($sClass, $aFilterCriteria)
 	{
 		$retKey = null;
-		$oFilter = new CMDBSearchFilter($sClass);
+		$oFilter = new DBObjectSearch($sClass);
 		foreach($aFilterCriteria as $sFilterCode => $filterValue)
 		{
 			$oFilter->AddCondition($sFilterCode, $filterValue, '=');
@@ -345,7 +346,7 @@ class cmdbDataGenerator
 	 */
 	protected function OrganizationExists($sCode)
 	{
-		$oFilter = new CMDBSearchFilter('bizOrganization');
+		$oFilter = new DBObjectSearch('Organization');
 		$oFilter->AddCondition('code', $sCode, '=');
 		$oSet = new CMDBObjectSet($oFilter);
 		return ($oSet->Count() > 0);
@@ -360,7 +361,7 @@ class cmdbDataGenerator
 	protected function GetOrganization($sId)
 	{
 		$oOrg = null;
-		$oFilter = new CMDBSearchFilter('bizOrganization');
+		$oFilter = new DBObjectSearch('Organization');
 		$oFilter->AddCondition('id', $sId, '=');
 		$oSet = new CMDBObjectSet($oFilter);
 		if ($oSet->Count() > 0)

core/datamodel.core.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<itop_design>
+</itop_design>

core/datetimeformat.class.inc.php

@@ -0,0 +1,428 @@
+<?php
+// Copyright (C) 2016 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/>
+
+
+/**
+ * Helper class to generate Date & Time formatting strings in the various conventions
+ * from the PHP DateTime::createFromFormat convention.
+ * 
+ * Example:
+ * 
+ * $oFormat = new DateTimeFormat('m/d/Y H:i');
+ * $oFormat->ToExcel();
+ * >> 'MM/dd/YYYY HH:mm'
+ * 
+ * @author Denis Flaven <denis.flaven@combodo.com>
+ *
+ */
+class DateTimeFormat
+{
+	protected $sPHPFormat;
+	
+	/**
+	 * Constructs the DateTimeFormat object
+	 * @param string $sPHPFormat A format string using the PHP 'DateTime::createFromFormat' convention
+	 */
+	public function __construct($sPHPFormat)
+	{
+		$this->sPHPFormat = (string)$sPHPFormat;
+	}
+	
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->sPHPFormat;
+	}
+	
+	/**
+	 * Return the mapping table for converting between various conventions for date/time formats
+	 */
+	protected static function GetFormatMapping()
+	{
+		return array(
+				// Days
+				'd' => array('regexpr' => '(0[1-9]|[1-2][0-9]||3[0-1])', 'datepicker' => 'dd', 'excel' => 'dd', 'moment' => 'DD'), // Day of the month: 2 digits (with leading zero)
+				'j' => array('regexpr' => '([1-9]|[1-2][0-9]||3[0-1])', 'datepicker' => 'd', 'excel' => 'd', 'moment' => 'D'), // Day of the month: 1 or 2 digits (without leading zero)
+				// Months
+				'm' => array('regexpr' => '(0[1-9]|1[0-2])', 'datepicker' => 'mm', 'excel' => 'MM', 'moment' => 'MM' ), // Month on 2 digits i.e. 01-12
+				'n' => array('regexpr' => '([1-9]|1[0-2])', 'datepicker' => 'm', 'excel' => 'm', 'moment' => 'M'), // Month on 1 or 2 digits 1-12
+				// Years
+				'Y' => array('regexpr' => '([0-9]{4})', 'datepicker' => 'yy', 'excel' => 'YYYY', 'moment' => 'YYYY'), // Year on 4 digits
+				'y' => array('regexpr' => '([0-9]{2})', 'datepicker' => 'y', 'excel' => 'YY', 'moment' => 'YY'), // Year on 2 digits
+				// Hours
+				'H' => array('regexpr' => '([0-1][0-9]|2[0-3])', 'datepicker' => 'HH', 'excel' => 'HH', 'moment' => 'HH'), // Hour 00..23
+				'h' => array('regexpr' => '(0[1-9]|1[0-2])', 'datepicker' => 'hh', 'excel' => 'hh', 'moment' => 'hh'), // Hour 01..12
+				'G' => array('regexpr' => '([1-9]|[1[0-9]|2[0-3])', 'datepicker' => 'H', 'excel' => 'H', 'moment' => 'H'), // Hour 0..23
+				'g' => array('regexpr' => '([1-9]|1[0-2])', 'datepicker' => 'h', 'excel' => 'h', 'moment' => 'h'), // Hour 1..12
+				'a' => array('regexpr' => '(am|pm)', 'datepicker' => 'tt', 'excel' => 'am/pm', 'moment' => 'a'),
+				'A' => array('regexpr' => '(AM|PM)', 'datepicker' => 'TT', 'excel' => 'AM/PM', 'moment' => 'A'),
+				// Minutes
+				'i' => array('regexpr' => '([0-5][0-9])', 'datepicker' => 'mm', 'excel' => 'mm', 'moment' => 'mm'),
+				// Seconds
+				's' => array('regexpr' => '([0-5][0-9])', 'datepicker' => 'ss', 'excel' => 'ss', 'moment' => 'ss'),	
+		);
+	}
+
+	/**
+	 * Transform the PHP format into the specified format, taking care of escaping the litteral characters
+	 * using the supplied escaping expression
+	 * @param string $sOutputFormatCode THe target format code: regexpr|datepicker|excel|moment
+	 * @param string $sEscapePattern The replacement string for escaping characters in the output string. %s is the source char.
+	 * @param string $bEscapeAll True to systematically escape all litteral characters
+	 * @param array $sSpecialChars A string containing the only characters to escape in the output
+	 * @return string The string in the requested format 
+	 */
+	protected function Transform($sOutputFormatCode, $sEscapePattern, $bEscapeAll = false, $sSpecialChars = '')
+	{
+		$aMappings = static::GetFormatMapping();
+		$sResult = '';
+		
+		$bEscaping = false;
+		for($i=0; $i < strlen($this->sPHPFormat); $i++)
+		{
+			if (($this->sPHPFormat[$i] == '\\'))
+			{
+				$bEscaping = true;
+				continue;
+			}
+			
+			if ($bEscaping)
+			{
+				if (($sSpecialChars === '') || (strpos($sSpecialChars, $this->sPHPFormat[$i]) !== false))
+				{
+					$sResult .= sprintf($sEscapePattern, $this->sPHPFormat[$i]);
+				}
+				else
+				{
+					$sResult .= $this->sPHPFormat[$i];
+				}
+				
+				$bEscaping = false;
+			}
+			else if(array_key_exists($this->sPHPFormat[$i], $aMappings))
+			{
+				// Not a litteral value, must be replaced by its regular expression pattern
+				$sResult .= $aMappings[$this->sPHPFormat[$i]][$sOutputFormatCode];
+			}
+			else
+			{
+				if ($bEscapeAll || (strpos($sSpecialChars, $this->sPHPFormat[$i]) !== false))
+				{
+					$sResult .= sprintf($sEscapePattern, $this->sPHPFormat[$i]);
+				}
+				else
+				{
+					// Normal char with no special meaning, no need to escape it
+					$sResult .= $this->sPHPFormat[$i];
+				}
+			}
+		}
+		
+		return $sResult;		
+	}	
+	
+	/**
+	 * Format a date into the supplied format string
+	 * @param mixed $date An int, string, DateTime object or null !!
+	 * @throws Exception
+	 * @return string The formatted date
+	 */
+	public function Format($date)
+	{
+		if ($date == null)
+		{
+			$sDate = '';
+		}
+		else if (($date === '0000-00-00') || ($date === '0000-00-00 00:00:00'))
+		{
+			$sDate = '';
+		}
+		else if ($date instanceof DateTime)
+		{
+			// Parameter is a DateTime
+			$sDate = $date->format($this->sPHPFormat);
+		}
+		else if (is_int($date))
+		{
+			// Parameter is a Unix timestamp
+			$oDate = new DateTime();
+			$oDate->setTimestamp($date);
+			$sDate = $oDate->format($this->sPHPFormat);
+		}
+		else if (is_string($date))
+		{
+			$oDate = new DateTime($date);
+			$sDate = $oDate->format($this->sPHPFormat);
+		}
+		else
+		{
+			throw new Exception(__CLASS__."::Format: Unexpected date value: ".print_r($date, true));
+		}
+		return $sDate;
+	}
+	
+	/**
+	 * Parse a date in the supplied format and return the date as a string in the internal format
+	 * @param string $sDate The string to parse
+	 * @param string $sFormat The format, in PHP createFromFormat convention
+	 * @throws Exception
+	 * @return DateTime|null
+	 */
+	public function Parse($sDate)
+	{
+		if (($sDate == null) || ($sDate == '0000-00-00 00:00:00') || ($sDate == '0000-00-00'))
+		{
+			return null;	
+		}
+		else
+		{
+			$sFormat = preg_replace('/\\?/', '', $this->sPHPFormat); // replace escaped characters by a wildcard for parsing
+			$oDate = DateTime::createFromFormat($this->sPHPFormat, $sDate);
+			if ($oDate === false)
+			{
+				throw new Exception(__CLASS__."::Parse: Unable to parse the date: '$sDate' using the format: '{$this->sPHPFormat}'");
+			}
+			return $oDate;
+		}
+	}
+	
+	/**
+	 * Get the date or datetime format string in the jQuery UI date picker format
+	 * @return string The format string using the date picker convention
+	 */
+	public function ToDatePicker()
+	{
+		return $this->Transform('datepicker', "'%s'");
+	}
+	
+	/**
+	 * Get a date or datetime format string in the Excel format
+	 * @return string The format string using the Excel convention
+	 */
+	public function ToExcel()
+	{
+		return $this->Transform('excel', "%s");
+	}
+	
+	/**
+	 * Get a date or datetime format string in the moment.js format
+	 * @return string The format string using the moment.js convention
+	 */
+	public function ToMomentJS()
+	{
+		return $this->Transform('moment', "[%s]", true /* escape all */);
+	}
+	
+	public static function GetJSSQLToCustomFormat()
+	{
+		$aPHPToMoment = array();
+		foreach(self::GetFormatMapping() as $sPHPCode => $aMapping)
+		{
+			$aPHPToMoment[$sPHPCode] = $aMapping['moment'];
+		}
+		$sJSMapping = json_encode($aPHPToMoment);
+		
+		$sFunction =
+<<<EOF
+function PHPDateTimeFormatToSubFormat(sPHPFormat, sPlaceholders)
+{
+	var iMax = 0;
+	var iMin = 999;
+	var bEscaping = false;
+	for(var i=0; i<sPHPFormat.length; i++)
+	{
+		var c = sPHPFormat[i];
+		if (c == '\\\\')
+		{
+			bEscaping = true;
+			continue;
+		}
+		
+		if (bEscaping)
+		{
+			bEscaping = false;
+			continue;
+		}
+		else
+		{
+			if (sPlaceholders.search(c) != -1)
+			{
+				iMax = Math.max(iMax, i);
+				iMin = Math.min(iMin, i);
+			}
+		}
+	}
+	return sPHPFormat.substr(iMin, iMax - iMin + 1);
+}
+
+function PHPDateTimeFormatToMomentFormat(sPHPFormat)
+{
+	var aFormatMapping = $sJSMapping;
+	var sMomentFormat = '';
+	
+	var bEscaping = false;
+	for(var i=0; i<sPHPFormat.length; i++)
+	{
+		var c = sPHPFormat[i];
+		if (c == '\\\\')
+		{
+			bEscaping = true;
+			continue;
+		}
+		
+		if (bEscaping)
+		{
+			sMomentFormat += '['+c+']';
+			bEscaping = false;
+		}
+		else
+		{
+			if (aFormatMapping[c] !== undefined)
+			{
+				sMomentFormat += aFormatMapping[c];
+			}
+			else
+			{
+				sMomentFormat += '['+c+']';
+			}
+		}
+	}
+	return sMomentFormat;
+}
+
+function DateFormatFromPHP(sSQLDate, sPHPFormat)
+{
+	if (sSQLDate === '') return '';
+	var sPHPDateFormat = PHPDateTimeFormatToSubFormat(sPHPFormat, 'Yydjmn');
+	var sMomentFormat = PHPDateTimeFormatToMomentFormat(sPHPDateFormat);	
+	return moment(sSQLDate).format(sMomentFormat);
+}		
+
+function DateTimeFormatFromPHP(sSQLDate, sPHPFormat)
+{
+	if (sSQLDate === '') return '';
+	var sMomentFormat = PHPDateTimeFormatToMomentFormat(sPHPFormat);	
+	return moment(sSQLDate).format(sMomentFormat);
+}		
+EOF
+		;
+		return $sFunction;
+	}
+	
+	/**
+	 * Get a placeholder text for a date or datetime format string
+	 * @return string The placeholder text (localized)
+	 */
+	public function ToPlaceholder()
+	{
+		$aMappings = static::GetFormatMapping();
+		$sResult = '';
+		
+		$bEscaping = false;
+		for($i=0; $i < strlen($this->sPHPFormat); $i++)
+		{
+			if (($this->sPHPFormat[$i] == '\\'))
+			{
+				$bEscaping = true;
+				continue;
+			}
+			
+			if ($bEscaping)
+			{
+				$sResult .= $this->sPHPFormat[$i]; // No need to escape characters in the placeholder
+				$bEscaping = false;
+			}
+			else if(array_key_exists($this->sPHPFormat[$i], $aMappings))
+			{
+				// Not a litteral value, must be replaced by Dict equivalent
+				$sResult .= Dict::S('Core:DateTime:Placeholder_'.$this->sPHPFormat[$i]);
+			}
+			else
+			{
+
+				// Normal char with no special meaning
+				$sResult .= $this->sPHPFormat[$i];
+			}
+		}
+		
+		return $sResult;
+	}
+
+	/**
+	 * Produces a subformat (Date or Time) by extracting the part of the whole DateTime format containing only the given placeholders
+	 * @return string
+	 */
+	protected function ToSubFormat($aPlaceholders)
+	{
+		$iStart = 999;
+		$iEnd = 0;
+		
+		foreach($aPlaceholders as $sChar)
+		{
+			$iPos = strpos($this->sPHPFormat, $sChar);
+			if ($iPos !== false)
+			{
+				if (($iPos > 0) && ($this->sPHPFormat[$iPos-1] == '\\'))
+				{
+					// The placeholder is actually escaped, it's a litteral character, ignore it
+					continue;
+				}
+				$iStart = min($iStart, $iPos);
+				$iEnd = max($iEnd, $iPos);
+			}
+		}
+		$sFormat = substr($this->sPHPFormat, $iStart, $iEnd - $iStart + 1);
+		return $sFormat;
+	}
+	
+	/**
+	 * Produces the Date format string by extracting only the date part of the date and time format string
+	 * @return string
+	 */
+	public function ToDateFormat()
+	{
+		return $this->ToSubFormat(array('Y', 'y', 'd', 'j', 'm', 'n'));
+	}
+	
+	/**
+	 * Produces the Time format string by extracting only the time part of the date and time format string
+	 * @return string
+	 */
+	public function ToTimeFormat()
+	{
+		return $this->ToSubFormat(array('H', 'h', 'G', 'g', 'i', 's', 'a', 'A'));
+	}
+	
+	/**
+	 * Get the regular expression to (approximately) validate a date/time for the current format
+	 * The validation does not take into account the number of days in a month (i.e. June 31st will pass, as well as Feb 30th!)
+	 * @param string $sDelimiter Surround the regexp (and escape) if needed
+	 * @return string The regular expression in PCRE syntax
+	 */
+	public function ToRegExpr($sDelimiter = null)
+	{
+		$sRet = '^'.$this->Transform('regexpr', "\\%s", false /* escape all */, '.?*$^()[]:').'$';
+		if ($sDelimiter !== null)
+		{
+			$sRet = $sDelimiter.str_replace($sDelimiter, '\\'.$sDelimiter, $sRet).$sDelimiter;
+		}
+		return $sRet;
+	}
+}

core/dbobjectiterator.php

@@ -0,0 +1,63 @@
+<?php
+// Copyright (C) 2010-2017 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/>
+
+
+/**
+ * A set of persistent objects, could be heterogeneous as long as the objects in the set have a common ancestor class 
+ *
+ * @package     iTopORM
+ * @copyright   Copyright (C) 2010-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+interface iDBObjectSetIterator extends Countable
+{
+	/**
+	 * The class of the objects of the collection (at least a common ancestor)
+	 *
+	 * @return string
+	 */
+	public function GetClass();
+
+	/**
+	 * The total number of objects in the collection
+	 *
+	 * @return int
+	 */
+	public function Count();
+
+	/**
+	 * Reset the cursor to the first item in the collection. Equivalent to Seek(0)
+	 *
+	 * @return DBObject The fetched object or null when at the end
+	 */
+	public function Rewind();
+
+	/**
+	 * Position the cursor to the given 0-based position
+	 *
+	 * @param int $iRow
+	 */
+	public function Seek($iPosition);
+
+	/**
+	 * Fetch the object at the current position in the collection and move the cursor to the next position.
+	 *
+	 * @return DBObject The fetched object or null when at the end
+	 */
+	public function Fetch();
+}

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/dbsearch.class.php

@@ -0,0 +1,875 @@
+<?php
+// Copyright (C) 2015-2017 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('dbobjectsearch.class.php');
+require_once('dbunionsearch.class.php');
+
+/**
+ * An object search
+ * 
+ * Note: in the ancient times of iTop, a search was named after DBObjectSearch.
+ *  When the UNION has been introduced, it has been decided to:
+ *  - declare a hierarchy of search classes, with two leafs :
+ *    - one class to cope with a single query (A JOIN B... WHERE...)
+ *    - and the other to cope with several queries (query1 UNION query2)
+ *  - in order to preserve forward/backward compatibility of the existing modules 
+ *    - keep the name of DBObjectSearch even if it a little bit confusing
+ *    - do not provide a type-hint for function parameters defined in the modules
+ *    - leave the statements DBObjectSearch::FromOQL in the modules, though DBSearch is more relevant 
+ *
+ * @copyright   Copyright (C) 2015-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+ 
+abstract class DBSearch
+{
+	const JOIN_POINTING_TO = 0;
+	const JOIN_REFERENCED_BY = 1;
+
+	protected $m_bNoContextParameters = false;
+	protected $m_aModifierProperties = array();
+	protected $m_bArchiveMode = false;
+	protected $m_bShowObsoleteData = true;
+
+	public function __construct()
+	{
+		$this->Init();
+	}
+
+	protected function Init()
+	{
+		// Set the obsolete and archive modes to the default ones
+		$this->m_bArchiveMode = utils::IsArchiveMode();
+		$this->m_bShowObsoleteData = true;
+	}
+
+	/**
+	 * 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
+	}
+
+	abstract public function AllowAllData();
+	abstract public function IsAllDataAllowed();
+
+	public function SetArchiveMode($bEnable)
+	{
+		$this->m_bArchiveMode = $bEnable;
+	}
+	public function GetArchiveMode()
+	{
+		return $this->m_bArchiveMode;
+	}
+
+	public function SetShowObsoleteData($bShow)
+	{
+		$this->m_bShowObsoleteData = $bShow;
+	}
+	public function GetShowObsoleteData()
+	{
+		if ($this->m_bArchiveMode || $this->IsAllDataAllowed())
+		{
+			// Enable obsolete data too!
+			$bRet = true;
+		}
+		else
+		{
+			$bRet = $this->m_bShowObsoleteData;
+		}
+		return $bRet;
+	}
+
+	public function NoContextParameters() {$this->m_bNoContextParameters = true;}
+	public function HasContextParameters() {return $this->m_bNoContextParameters;}
+
+	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();
+		}
+	}
+
+	abstract public function GetClassName($sAlias);
+	abstract public function GetClass();
+	abstract public function GetClassAlias();
+
+	/**
+	 * 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	 
+	 */	 	
+	abstract public function ChangeClass($sNewClass, $sAlias = null);
+	abstract public function GetSelectedClasses();
+
+	/**
+	 * @param array $aSelectedClasses array of aliases
+	 * @throws CoreException
+	 */
+	abstract public function SetSelectedClasses($aSelectedClasses);
+
+	/**
+	 * Change any alias of the query tree
+	 *
+	 * @param $sOldName
+	 * @param $sNewName
+	 * @return bool True if the alias has been found and changed
+	 */
+	abstract public function RenameAlias($sOldName, $sNewName);
+
+	abstract public function IsAny();
+
+	public function Describe(){return 'deprecated - use ToOQL() instead';}
+	public function DescribeConditionPointTo($sExtKeyAttCode, $aPointingTo){return 'deprecated - use ToOQL() instead';}
+	public function DescribeConditionRefBy($sForeignClass, $sForeignExtKeyAttCode){return 'deprecated - use ToOQL() instead';}
+	public function DescribeConditionRelTo($aRelInfo){return 'deprecated - use ToOQL() instead';}
+	public function DescribeConditions(){return 'deprecated - use ToOQL() instead';}
+	public function __DescribeHTML(){return 'deprecated - use ToOQL() instead';}
+
+	abstract public function ResetCondition();
+	abstract public function MergeConditionExpression($oExpression);
+	abstract public function AddConditionExpression($oExpression);
+  	abstract public function AddNameCondition($sName);
+	abstract public function AddCondition($sFilterCode, $value, $sOpCode = null);
+	/**
+	 * 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 (can be an array => IN(val1, val2...)
+	 * @return void
+	 */
+	abstract public function AddConditionAdvanced($sAttSpec, $value);
+	abstract public function AddCondition_FullText($sFullText);
+
+	/**
+	 * @param DBObjectSearch $oFilter
+	 * @param $sExtKeyAttCode
+	 * @param int $iOperatorCode
+	 * @param null $aRealiasingMap array of <old-alias> => <new-alias>, for each alias that has changed
+	 * @throws CoreException
+	 * @throws CoreWarning
+	 */
+	abstract public function AddCondition_PointingTo(DBObjectSearch $oFilter, $sExtKeyAttCode, $iOperatorCode = TREE_OPERATOR_EQUALS, &$aRealiasingMap = null);
+
+	/**
+	 * @param DBObjectSearch $oFilter
+	 * @param $sForeignExtKeyAttCode
+	 * @param int $iOperatorCode
+	 * @param null $aRealiasingMap array of <old-alias> => <new-alias>, for each alias that has changed
+	 */
+	abstract public function AddCondition_ReferencedBy(DBObjectSearch $oFilter, $sForeignExtKeyAttCode, $iOperatorCode = TREE_OPERATOR_EQUALS, &$aRealiasingMap = null);
+
+	abstract public function Intersect(DBSearch $oFilter);
+
+	/**
+	 * @param DBSearch $oFilter
+	 * @param integer $iDirection
+	 * @param string $sExtKeyAttCode
+	 * @param integer $iOperatorCode
+	 * @param array &$RealisasingMap  Map of aliases from the attached query, that could have been renamed by the optimization process
+	 * @return DBSearch
+	 */
+	public function Join(DBSearch $oFilter, $iDirection, $sExtKeyAttCode, $iOperatorCode = TREE_OPERATOR_EQUALS, &$aRealiasingMap = null)
+	{
+		$oSourceFilter = $this->DeepClone();
+		$oRet = null;
+
+		if ($oFilter instanceof DBUnionSearch)
+		{
+			$aSearches = array();
+			foreach ($oFilter->GetSearches() as $oSearch)
+			{
+				$aSearches[] = $oSourceFilter->Join($oSearch, $iDirection, $sExtKeyAttCode, $iOperatorCode, $aRealiasingMap);
+			}
+			$oRet = new DBUnionSearch($aSearches);
+		}
+		else
+		{
+			if ($iDirection === static::JOIN_POINTING_TO)
+			{
+				$oSourceFilter->AddCondition_PointingTo($oFilter, $sExtKeyAttCode, $iOperatorCode, $aRealiasingMap);
+			}
+			else
+			{
+				if ($iOperatorCode !== TREE_OPERATOR_EQUALS)
+				{
+					throw new Exception('Only TREE_OPERATOR_EQUALS  operator code is supported yet for AddCondition_ReferencedBy.');
+				}
+				$oSourceFilter->AddCondition_ReferencedBy($oFilter, $sExtKeyAttCode, TREE_OPERATOR_EQUALS, $aRealiasingMap);
+			}
+			$oRet = $oSourceFilter;
+		}
+
+		return $oRet;
+	}
+
+	abstract public function SetInternalParams($aParams);
+	abstract public function GetInternalParams();
+	abstract public function GetQueryParams($bExcludeMagicParams = true);
+	abstract public function ListConstantFields();
+	
+	/**
+	 * Turn the parameters (:xxx) into scalar values in order to easily
+	 * serialize a search
+	 */
+	abstract public function ApplyParameters($aArgs);
+
+    public function serialize($bDevelopParams = false, $aContextParams = null)
+	{
+		$sOql = $this->ToOql($bDevelopParams, $aContextParams);
+		return base64_encode(serialize(array($sOql, $this->GetInternalParams(), $this->m_aModifierProperties)));
+	}
+
+	/**
+	 * @param string $sValue Serialized OQL query
+	 *
+	 * @return \DBSearch
+	 */
+	static public function unserialize($sValue)
+	{
+		$aData = unserialize(base64_decode($sValue));
+		$sOql = $aData[0];
+		$aParams = $aData[1];
+		// 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
+		$oRetFilter = self::FromOQL($sOql, $aParams);
+		$oRetFilter->m_aModifierProperties = $aData[2];
+		return $oRetFilter;
+	}
+
+    /**
+     * Create a new DBObjectSearch from $oSearch with a new alias $sAlias
+     *
+     * Note : This has not be tested with UNION queries.
+     *
+     * @param DBSearch $oSearch
+     * @param string $sAlias
+     * @return DBObjectSearch
+     */
+    static public function CloneWithAlias(DBSearch $oSearch, $sAlias)
+    {
+        $oSearchWithAlias = new DBObjectSearch($oSearch->GetClass(), $sAlias);
+        $oSearchWithAlias = $oSearchWithAlias->Intersect($oSearch);
+        return $oSearchWithAlias;
+    }
+
+    abstract public function ToOQL($bDevelopParams = false, $aContextParams = null, $bWithAllowAllFlag = false);
+
+	static protected $m_aOQLQueries = array();
+
+	// Do not filter out depending on user rights
+	// In particular when we are currently in the process of evaluating the user rights...
+	static public function FromOQL_AllData($sQuery, $aParams = null)
+	{
+		$oRes = self::FromOQL($sQuery, $aParams);
+		$oRes->AllowAllData();
+		return $oRes;
+	}
+
+	/**
+	 * @param string $sQuery
+	 * @param array $aParams
+	 * @return DBSearch
+	 * @throws OQLException
+	 */
+	static public function FromOQL($sQuery, $aParams = null)
+	{
+		if (empty($sQuery))
+		{
+			return null;
+		}
+
+		// Query caching
+		$sQueryId = md5($sQuery);
+		$bOQLCacheEnabled = true;
+		if ($bOQLCacheEnabled)
+		{
+			if (array_key_exists($sQueryId, self::$m_aOQLQueries))
+			{
+				// hit!
+				$oResultFilter = self::$m_aOQLQueries[$sQueryId]->DeepClone();
+			}
+			elseif (self::$m_bUseAPCCache)
+			{
+				// Note: For versions of APC older than 3.0.17, fetch() accepts only one parameter
+				//
+				$sAPCCacheId = 'itop-'.MetaModel::GetEnvironmentId().'-dbsearch-cache-'.$sQueryId;
+				$oKPI = new ExecutionKPI();
+				$result = apc_fetch($sAPCCacheId);
+				$oKPI->ComputeStats('Search APC (fetch)', $sQuery);
+	
+				if (is_object($result))
+				{
+					$oResultFilter = $result;
+					self::$m_aOQLQueries[$sQueryId] = $oResultFilter->DeepClone();
+				}
+			}
+		}
+
+		if (!isset($oResultFilter))
+		{
+			$oKPI = new ExecutionKPI();
+
+			$oOql = new OqlInterpreter($sQuery);
+			$oOqlQuery = $oOql->ParseQuery();
+	
+			$oMetaModel = new ModelReflectionRuntime();
+			$oOqlQuery->Check($oMetaModel, $sQuery); // Exceptions thrown in case of issue
+	
+			$oResultFilter = $oOqlQuery->ToDBSearch($sQuery);
+
+			$oKPI->ComputeStats('Parse OQL', $sQuery);
+	
+			if ($bOQLCacheEnabled)
+			{
+				self::$m_aOQLQueries[$sQueryId] = $oResultFilter->DeepClone();
+
+				if (self::$m_bUseAPCCache)
+				{
+					$oKPI = new ExecutionKPI();
+					apc_store($sAPCCacheId, $oResultFilter, self::$m_iQueryCacheTTL);
+					$oKPI->ComputeStats('Search APC (store)', $sQueryId);
+				}
+			}
+		}
+
+		if (!is_null($aParams))
+		{
+			$oResultFilter->SetInternalParams($aParams);
+		}
+
+		// Set the default fields
+		$oResultFilter->Init();
+
+		return $oResultFilter;
+	}
+
+	// Alternative to object mapping: the data are transfered directly into an array
+	// This is 10 times faster than creating a set of objects, and makes sense when optimization is required
+	/**
+	 * @param hash $aOrderBy Array of '[<classalias>.]attcode' => bAscending
+	 */	
+	public function ToDataArray($aColumns = array(), $aOrderBy = array(), $aArgs = array())
+	{
+		$sSQL = $this->MakeSelectQuery($aOrderBy, $aArgs);
+		$resQuery = CMDBSource::Query($sSQL);
+		if (!$resQuery)
+		{
+			return;
+		}
+
+		if (count($aColumns) == 0)
+		{
+			$aColumns = array_keys(MetaModel::ListAttributeDefs($this->GetClass()));
+			// Add the standard id (as first column)
+			array_unshift($aColumns, 'id');
+		}
+
+		$aQueryCols = CMDBSource::GetColumns($resQuery);
+
+		$sClassAlias = $this->GetClassAlias();
+		$aColMap = array();
+		foreach ($aColumns as $sAttCode)
+		{
+			$sColName = $sClassAlias.$sAttCode;
+			if (in_array($sColName, $aQueryCols))
+			{
+				$aColMap[$sAttCode] = $sColName;
+			}
+		}
+
+		$aRes = array();
+		while ($aRow = CMDBSource::FetchArray($resQuery))
+		{
+			$aMappedRow = array();
+			foreach ($aColMap as $sAttCode => $sColName)
+			{
+				$aMappedRow[$sAttCode] = $aRow[$sColName];
+			}
+			$aRes[] = $aMappedRow;
+		}
+		CMDBSource::FreeResult($resQuery);
+		return $aRes;
+	}
+
+	////////////////////////////////////////////////////////////////////////////
+	//
+	// Construction of the SQL queries
+	//
+	////////////////////////////////////////////////////////////////////////////
+	protected static $m_aQueryStructCache = array();
+
+
+	public function MakeGroupByQuery($aArgs, $aGroupByExpr, $bExcludeNullValues = false)
+	{
+		if ($bExcludeNullValues)
+		{
+			// Null values are not handled (though external keys set to 0 are allowed)
+			$oQueryFilter = $this->DeepClone();
+			foreach ($aGroupByExpr as $oGroupByExp)
+			{
+				$oNull = new FunctionExpression('ISNULL', array($oGroupByExp));
+				$oNotNull = new BinaryExpression($oNull, '!=', new TrueExpression());
+				$oQueryFilter->AddConditionExpression($oNotNull);
+			}
+		}
+		else
+		{
+			$oQueryFilter = $this;
+		}
+
+		$aAttToLoad = array();
+		$oSQLQuery = $oQueryFilter->GetSQLQuery(array(), $aArgs, $aAttToLoad, null, 0, 0, false, $aGroupByExpr);
+
+		$aScalarArgs = MetaModel::PrepareQueryArguments($aArgs, $this->GetInternalParams());
+		try
+		{
+			$bBeautifulSQL = self::$m_bTraceQueries || self::$m_bDebugQuery || self::$m_bIndentQueries;
+			$sRes = $oSQLQuery->RenderGroupBy($aScalarArgs, $bBeautifulSQL);
+		}
+		catch (MissingQueryArgument $e)
+		{
+			// Add some information...
+			$e->addInfo('OQL', $this->ToOQL());
+			throw $e;
+		}
+		$this->AddQueryTraceGroupBy($aArgs, $aGroupByExpr, $sRes);
+		return $sRes;
+	}
+
+
+	/**
+	 * @param array|hash $aOrderBy Array of '[<classalias>.]attcode' => bAscending
+	 * @param array $aArgs
+	 * @param null $aAttToLoad
+	 * @param null $aExtendedDataSpec
+	 * @param int $iLimitCount
+	 * @param int $iLimitStart
+	 * @param bool $bGetCount
+	 * @return string
+	 * @throws CoreException
+	 * @throws Exception
+	 * @throws MissingQueryArgument
+	 */
+	public function MakeSelectQuery($aOrderBy = array(), $aArgs = array(), $aAttToLoad = null, $aExtendedDataSpec = null, $iLimitCount = 0, $iLimitStart = 0, $bGetCount = false)
+	{
+		// Check the order by specification, and prefix with the class alias
+		// and make sure that the ordering columns are going to be selected
+		//
+		$sClass = $this->GetClass();
+		$sClassAlias = $this->GetClassAlias();
+		$aOrderSpec = array();
+		foreach ($aOrderBy as $sFieldAlias => $bAscending)
+		{
+			if (!is_bool($bAscending))
+			{
+				throw new CoreException("Wrong direction in ORDER BY spec, found '$bAscending' and expecting a boolean value");
+			}
+
+			$iDotPos = strpos($sFieldAlias, '.');
+			if ($iDotPos === false)
+			{
+				$sAttClass = $sClass;
+				$sAttClassAlias = $sClassAlias;
+				$sAttCode = $sFieldAlias;
+			}
+			else
+			{
+				$sAttClassAlias = substr($sFieldAlias, 0, $iDotPos);
+				$sAttClass = $this->GetClassName($sAttClassAlias);
+				$sAttCode = substr($sFieldAlias, $iDotPos + 1);
+			}
+
+			if ($sAttCode != 'id')
+			{
+				MyHelpers::CheckValueInArray('field name in ORDER BY spec', $sAttCode, MetaModel::GetAttributesList($sAttClass));
+
+				$oAttDef = MetaModel::GetAttributeDef($sAttClass, $sAttCode);
+				foreach($oAttDef->GetOrderBySQLExpressions($sAttClassAlias) as $sSQLExpression)
+				{
+					$aOrderSpec[$sSQLExpression] = $bAscending;
+				}
+			}
+			else
+			{
+				$aOrderSpec['`'.$sAttClassAlias.$sAttCode.'`'] = $bAscending;
+			}
+
+			// Make sure that the columns used for sorting are present in the loaded columns
+			if (!is_null($aAttToLoad) && !isset($aAttToLoad[$sAttClassAlias][$sAttCode]))
+			{
+				$aAttToLoad[$sAttClassAlias][$sAttCode] = MetaModel::GetAttributeDef($sAttClass, $sAttCode);
+			}			
+		}
+
+		$oSQLQuery = $this->GetSQLQuery($aOrderBy, $aArgs, $aAttToLoad, $aExtendedDataSpec, $iLimitCount, $iLimitStart, $bGetCount);
+
+		if ($this->m_bNoContextParameters)
+		{
+			// Only internal parameters
+			$aScalarArgs = $this->GetInternalParams();
+		}
+		else
+		{
+			// The complete list of arguments will include magic arguments (e.g. current_user->attcode)
+			$aScalarArgs = MetaModel::PrepareQueryArguments($aArgs, $this->GetInternalParams());
+		}
+		try
+		{
+			$bBeautifulSQL = self::$m_bTraceQueries || self::$m_bDebugQuery || self::$m_bIndentQueries;
+			$sRes = $oSQLQuery->RenderSelect($aOrderSpec, $aScalarArgs, $iLimitCount, $iLimitStart, $bGetCount, $bBeautifulSQL);
+			if ($sClassAlias == '_itop_')
+			{
+				IssueLog::Info('SQL Query (_itop_): '.$sRes);
+			}
+		}
+		catch (MissingQueryArgument $e)
+		{
+			// Add some information...
+			$e->addInfo('OQL', $this->ToOQL());
+			throw $e;
+		}
+		$this->AddQueryTraceSelect($aOrderBy, $aArgs, $aAttToLoad, $aExtendedDataSpec, $iLimitCount, $iLimitStart, $bGetCount, $sRes);
+		return $sRes;
+	}
+
+
+	protected function GetSQLQuery($aOrderBy, $aArgs, $aAttToLoad, $aExtendedDataSpec, $iLimitCount, $iLimitStart, $bGetCount, $aGroupByExpr = null)
+	{
+		$oSQLQuery = $this->GetSQLQueryStructure($aAttToLoad, $bGetCount, $aGroupByExpr);
+		$oSQLQuery->SetSourceOQL($this->ToOQL());
+
+		// Join to an additional table, if required...
+		//
+		if ($aExtendedDataSpec != null)
+		{
+			$sTableAlias = '_extended_data_';
+			$aExtendedFields = array();
+			foreach($aExtendedDataSpec['fields'] as $sColumn)
+			{
+				$sColRef = $this->GetClassAlias().'_extdata_'.$sColumn;
+				$aExtendedFields[$sColRef] = new FieldExpressionResolved($sColumn, $sTableAlias);
+			}
+			$oSQLQueryExt = new SQLObjectQuery($aExtendedDataSpec['table'], $sTableAlias, $aExtendedFields);
+			$oSQLQuery->AddInnerJoin($oSQLQueryExt, 'id', $aExtendedDataSpec['join_key'] /*, $sTableAlias*/);
+		}
+		
+		return $oSQLQuery;
+	}
+
+	public abstract function GetSQLQueryStructure(
+		$aAttToLoad, $bGetCount, $aGroupByExpr = null, $aSelectedClasses = null
+	);
+
+	////////////////////////////////////////////////////////////////////////////
+	//
+	// Cache/Trace/Log queries
+	//
+	////////////////////////////////////////////////////////////////////////////
+	protected static $m_bDebugQuery = false;
+	protected static $m_aQueriesLog = array();
+	protected static $m_bQueryCacheEnabled = false;
+	protected static $m_bUseAPCCache = false;
+	protected static $m_iQueryCacheTTL = 3600;
+	protected static $m_bTraceQueries = false;
+	protected static $m_bIndentQueries = false;
+	protected static $m_bOptimizeQueries = false;
+
+	public static function StartDebugQuery()
+	{
+		$aBacktrace = debug_backtrace();
+		self::$m_bDebugQuery = true;
+	}
+	public static function StopDebugQuery()
+	{
+		self::$m_bDebugQuery = false;
+	}
+	
+	public static function EnableQueryCache($bEnabled, $bUseAPC, $iTimeToLive = 3600)
+	{
+		self::$m_bQueryCacheEnabled = $bEnabled;
+		self::$m_bUseAPCCache = $bUseAPC;
+		self::$m_iQueryCacheTTL = $iTimeToLive;
+	}
+	public static function EnableQueryTrace($bEnabled)
+	{
+		self::$m_bTraceQueries = $bEnabled;
+	}
+	public static function EnableQueryIndentation($bEnabled)
+	{
+		self::$m_bIndentQueries = $bEnabled;
+	}
+	public static function EnableOptimizeQuery($bEnabled)
+	{
+		self::$m_bOptimizeQueries = $bEnabled;
+	}
+
+
+	protected function AddQueryTraceSelect($aOrderBy, $aArgs, $aAttToLoad, $aExtendedDataSpec, $iLimitCount, $iLimitStart, $bGetCount, $sSql)
+	{
+		if (self::$m_bTraceQueries)
+		{
+			$aQueryData = array(
+				'type' => 'select',
+				'filter' => $this,
+				'order_by' => $aOrderBy,
+				'args' => $aArgs,
+				'att_to_load' => $aAttToLoad,
+				'extended_data_spec' => $aExtendedDataSpec,
+				'limit_count' => $iLimitCount,
+				'limit_start' => $iLimitStart,
+				'is_count' => $bGetCount
+			);
+			$sOql = $this->ToOQL(true, $aArgs);
+			self::AddQueryTrace($aQueryData, $sOql, $sSql);
+		}
+	}
+	
+	protected function AddQueryTraceGroupBy($aArgs, $aGroupByExpr, $sSql)
+	{
+		if (self::$m_bTraceQueries)
+		{
+			$aQueryData = array(
+				'type' => 'group_by',
+				'filter' => $this,
+				'args' => $aArgs,
+				'group_by_expr' => $aGroupByExpr
+			);
+			$sOql = $this->ToOQL(true, $aArgs);
+			self::AddQueryTrace($aQueryData, $sOql, $sSql);
+		}
+	}
+
+	protected static function AddQueryTrace($aQueryData, $sOql, $sSql)
+	{
+		if (self::$m_bTraceQueries)
+		{
+			$sQueryId = md5(serialize($aQueryData));
+			$sMySQLQueryId = md5($sSql);
+			if(!isset(self::$m_aQueriesLog[$sQueryId]))
+			{
+				self::$m_aQueriesLog[$sQueryId]['data'] = serialize($aQueryData);
+				self::$m_aQueriesLog[$sQueryId]['oql'] = $sOql;
+				self::$m_aQueriesLog[$sQueryId]['hits'] = 1;
+			}
+			else
+			{
+				self::$m_aQueriesLog[$sQueryId]['hits']++;
+			}
+			if(!isset(self::$m_aQueriesLog[$sQueryId]['queries'][$sMySQLQueryId]))
+			{
+				self::$m_aQueriesLog[$sQueryId]['queries'][$sMySQLQueryId]['sql'] = $sSql;
+				self::$m_aQueriesLog[$sQueryId]['queries'][$sMySQLQueryId]['count'] = 1;
+				$iTableCount = count(CMDBSource::ExplainQuery($sSql));
+				self::$m_aQueriesLog[$sQueryId]['queries'][$sMySQLQueryId]['table_count'] = $iTableCount;
+			}
+			else
+			{
+				self::$m_aQueriesLog[$sQueryId]['queries'][$sMySQLQueryId]['count']++;
+			}
+		}
+	}
+
+	public static function RecordQueryTrace()
+	{
+		if (!self::$m_bTraceQueries)
+		{
+			return;
+		}
+
+		$iOqlCount = count(self::$m_aQueriesLog);
+		$iSqlCount = 0;
+		foreach (self::$m_aQueriesLog as $sQueryId => $aOqlData)
+		{
+			$iSqlCount += $aOqlData['hits'];
+		}
+		$sHtml = "<h2>Stats on SELECT queries: OQL=$iOqlCount, SQL=$iSqlCount</h2>\n";
+		foreach (self::$m_aQueriesLog as $sQueryId => $aOqlData)
+		{
+			$sOql = $aOqlData['oql'];
+			$sHits = $aOqlData['hits'];
+
+			$sHtml .= "<p><b>$sHits</b> hits for OQL query: $sOql</p>\n";
+			$sHtml .= "<ul id=\"ClassesRelationships\" class=\"treeview\">\n";
+			foreach($aOqlData['queries'] as $aSqlData)
+			{
+				$sQuery = $aSqlData['sql'];
+				$sSqlHits = $aSqlData['count'];
+				$iTableCount = $aSqlData['table_count'];
+				$sHtml .= "<li><b>$sSqlHits</b> hits for SQL ($iTableCount tables): <pre style=\"font-size:60%\">$sQuery</pre></li>\n";
+			}
+			$sHtml .= "</ul>\n";
+		}
+
+		$sLogFile = 'queries.latest';
+		file_put_contents(APPROOT.'data/'.$sLogFile.'.html', $sHtml);
+
+		$sLog = "<?php\n\$aQueriesLog = ".var_export(self::$m_aQueriesLog, true).";";
+		file_put_contents(APPROOT.'data/'.$sLogFile.'.log', $sLog);
+
+		// Cumulate the queries
+		$sAllQueries = APPROOT.'data/queries.log';
+		if (file_exists($sAllQueries))
+		{
+			// Merge the new queries into the existing log
+			include($sAllQueries);
+			$aQueriesLog = array();
+			foreach (self::$m_aQueriesLog as $sQueryId => $aOqlData)
+			{
+				if (!array_key_exists($sQueryId, $aQueriesLog))
+				{
+					$aQueriesLog[$sQueryId] = $aOqlData;
+				}
+			}
+		}
+		else
+		{
+			$aQueriesLog = self::$m_aQueriesLog;
+		}
+		$sLog = "<?php\n\$aQueriesLog = ".var_export($aQueriesLog, true).";";
+		file_put_contents($sAllQueries, $sLog);
+	}
+
+	protected static function DbgTrace($value)
+	{
+		if (!self::$m_bDebugQuery)
+		{
+			return;
+		}
+		$aBacktrace = debug_backtrace();
+		$iCallStackPos = count($aBacktrace) - self::$m_bDebugQuery;
+		$sIndent = ""; 
+		for ($i = 0 ; $i < $iCallStackPos ; $i++)
+		{
+			$sIndent .= " .-=^=-. ";
+		}
+		$aCallers = array();
+		foreach($aBacktrace as $aStackInfo)
+		{
+			$aCallers[] = $aStackInfo["function"];
+		}
+		$sCallers = "Callstack: ".implode(', ', $aCallers);
+		$sFunction = "<b title=\"$sCallers\">".$aBacktrace[1]["function"]."</b>";
+
+		if (is_object($value))
+		{
+			echo "$sIndent$sFunction:\n<pre>\n";
+			print_r($value);
+			echo "</pre>\n";
+		}
+		else
+		{
+			echo "$sIndent$sFunction: $value<br/>\n";
+		}
+	}
+
+	/**
+	 * Experimental!
+	 * todo: implement the change tracking
+	 *
+	 * @param $bArchive
+	 * @throws Exception
+	 */
+	function DBBulkWriteArchiveFlag($bArchive)
+	{
+		$sClass = $this->GetClass();
+		if (!MetaModel::IsArchivable($sClass))
+		{
+			throw new Exception($sClass.' is not an archivable class');
+		}
+
+		$iFlag = $bArchive ? 1 : 0;
+
+		$oSet = new DBObjectSet($this);
+		if (MetaModel::IsStandaloneClass($sClass))
+		{
+			$oSet->OptimizeColumnLoad(array($this->GetClassAlias() => array('')));
+			$aIds = array($sClass => $oSet->GetColumnAsArray('id'));
+		}
+		else
+		{
+			$oSet->OptimizeColumnLoad(array($this->GetClassAlias() => array('finalclass')));
+			$aTemp = $oSet->GetColumnAsArray('finalclass');
+			$aIds = array();
+			foreach ($aTemp as $iObjectId => $sObjectClass)
+			{
+				$aIds[$sObjectClass][$iObjectId] = $iObjectId;
+			}
+		}
+		foreach ($aIds as $sFinalClass => $aObjectIds)
+		{
+			$sIds = implode(', ', $aObjectIds);
+
+			$sArchiveRoot = MetaModel::GetAttributeOrigin($sFinalClass, 'archive_flag');
+			$sRootTable = MetaModel::DBGetTable($sArchiveRoot);
+			$sRootKey = MetaModel::DBGetKey($sArchiveRoot);
+			$aJoins = array("`$sRootTable`");
+			$aUpdates = array();
+			foreach (MetaModel::EnumParentClasses($sFinalClass, ENUM_PARENT_CLASSES_ALL) as $sParentClass)
+			{
+				if (!MetaModel::IsValidAttCode($sParentClass, 'archive_flag'))
+				{
+					continue;
+				}
+
+				$sTable = MetaModel::DBGetTable($sParentClass);
+				$aUpdates[] = "`$sTable`.`archive_flag` = $iFlag";
+				if ($sParentClass == $sArchiveRoot)
+				{
+					if ($bArchive)
+					{
+						// Set the date (do not change it)
+						$sDate = '"'.date(AttributeDate::GetSQLFormat()).'"';
+						$aUpdates[] = "`$sTable`.`archive_date` = coalesce(`$sTable`.`archive_date`, $sDate)";
+					}
+					else
+					{
+						// Reset the date
+						$aUpdates[] = "`$sTable`.`archive_date` = null";
+					}
+				}
+				else
+				{
+					$sKey = MetaModel::DBGetKey($sParentClass);
+					$aJoins[] = "`$sTable` ON `$sTable`.`$sKey` = `$sRootTable`.`$sRootKey`";
+				}
+			}
+			$sJoins = implode(' INNER JOIN ', $aJoins);
+			$sValues = implode(', ', $aUpdates);
+			$sUpdateQuery = "UPDATE $sJoins SET $sValues WHERE `$sRootTable`.`$sRootKey` IN ($sIds)";
+			CMDBSource::Query($sUpdateQuery);
+		}
+	}
+
+	public function UpdateContextFromUser()
+	{
+		$this->SetShowObsoleteData(utils::ShowObsoleteData());
+	}
+}

core/dbunionsearch.class.php

@@ -0,0 +1,563 @@
+<?php
+// Copyright (C) 2015-2017 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/>
+
+
+/**
+ * A union of DBObjectSearches 
+ *
+ * @copyright   Copyright (C) 2015-2017 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+ 
+class DBUnionSearch extends DBSearch
+{
+	protected $aSearches; // source queries
+	protected $aSelectedClasses; // alias => classes (lowest common ancestors) computed at construction
+
+	public function __construct($aSearches)
+	{
+		if (count ($aSearches) == 0)
+		{
+			throw new CoreException('A DBUnionSearch must be made of at least one search');
+		}
+
+		$this->aSearches = array();
+		foreach ($aSearches as $oSearch)
+		{
+			if ($oSearch instanceof DBUnionSearch)
+			{
+				foreach ($oSearch->aSearches as $oSubSearch)
+				{
+					$this->aSearches[] = $oSubSearch->DeepClone();
+				}
+			}
+			else
+			{
+				$this->aSearches[] = $oSearch->DeepClone();
+			}
+		}
+
+		$this->ComputeSelectedClasses();
+	}
+
+	public function AllowAllData()
+	{
+		foreach ($this->aSearches as $oSearch)
+		{
+			$oSearch->AllowAllData();
+		}
+	}
+	public function IsAllDataAllowed()
+	{
+		foreach ($this->aSearches as $oSearch)
+		{
+			if ($oSearch->IsAllDataAllowed() === false) return false;
+		}
+		return true;
+	}
+
+	public function SetArchiveMode($bEnable)
+	{
+		foreach ($this->aSearches as $oSearch)
+		{
+			$oSearch->SetArchiveMode($bEnable);
+		}
+		parent::SetArchiveMode($bEnable);
+	}
+
+	public function SetShowObsoleteData($bShow)
+	{
+		foreach ($this->aSearches as $oSearch)
+		{
+			$oSearch->SetShowObsoleteData($bShow);
+		}
+		parent::SetShowObsoleteData($bShow);
+	}
+
+	/**
+	 * Find the lowest common ancestor for each of the selected class
+	 */
+	protected function ComputeSelectedClasses()
+	{
+		// 1 - Collect all the column/classes
+		$aColumnToClasses = array();
+		foreach ($this->aSearches as $iPos => $oSearch)
+		{
+			$aSelected = array_values($oSearch->GetSelectedClasses());
+
+			if ($iPos != 0)
+			{
+				if (count($aSelected) < count($aColumnToClasses))
+				{
+					throw new Exception('Too few selected classes in the subquery #'.($iPos+1));
+				}
+				if (count($aSelected) > count($aColumnToClasses))
+				{
+					throw new Exception('Too many selected classes in the subquery #'.($iPos+1));
+				}
+			}
+
+			foreach ($aSelected as $iColumn => $sClass)
+			{
+				$aColumnToClasses[$iColumn][] = $sClass;
+			}
+		}
+
+		// 2 - Build the index column => alias
+		$oFirstSearch = $this->aSearches[0];
+		$aColumnToAlias = array_keys($oFirstSearch->GetSelectedClasses());
+
+		// 3 - Compute alias => lowest common ancestor
+		$this->aSelectedClasses = array();
+		foreach ($aColumnToClasses as $iColumn => $aClasses)
+		{
+			$sAlias = $aColumnToAlias[$iColumn];
+			$sAncestor = MetaModel::GetLowestCommonAncestor($aClasses);
+			if (is_null($sAncestor))
+			{
+				throw new Exception('Could not find a common ancestor for the column '.($iColumn+1).' (Classes: '.implode(', ', $aClasses).')');
+			}
+			$this->aSelectedClasses[$sAlias] = $sAncestor;
+		}
+	}
+
+	public function GetSearches()
+	{
+		return $this->aSearches;
+	}
+
+	/**
+	 * Limited to the selected classes
+	 */	 	
+	public function GetClassName($sAlias)
+	{
+		if (array_key_exists($sAlias, $this->aSelectedClasses))
+		{
+			return $this->aSelectedClasses[$sAlias];
+		}
+		else
+		{
+			throw new CoreException("Invalid class alias '$sAlias'");
+		}
+	}
+
+	public function GetClass()
+	{
+		return reset($this->aSelectedClasses);
+	}
+
+	public function GetClassAlias()
+	{
+		reset($this->aSelectedClasses);
+		return key($this->aSelectedClasses);
+	}
+
+
+	/**
+	 * Change the class (only subclasses are supported as of now, because the conditions must fit the new class)
+	 * Defaults to the first selected class
+	 * Only the selected classes can be changed
+	 */	 	
+	public function ChangeClass($sNewClass, $sAlias = null)
+	{
+		if (is_null($sAlias))
+		{
+			$sAlias = $this->GetClassAlias();
+		}
+		elseif (!array_key_exists($sAlias, $this->aSelectedClasses))
+		{
+			// discard silently - necessary when recursing (??? copied from DBObjectSearch)
+			return;
+		}
+
+		// 1 - identify the impacted column
+		$iColumn = array_search($sAlias, array_keys($this->aSelectedClasses));
+
+		// 2 - change for each search
+		foreach ($this->aSearches as $oSearch)
+		{
+			$aSearchAliases = array_keys($oSearch->GetSelectedClasses());
+			$sSearchAlias = $aSearchAliases[$iColumn];
+			$oSearch->ChangeClass($sNewClass, $sSearchAlias);
+		}
+
+		// 3 - record the change
+		$this->aSelectedClasses[$sAlias] = $sNewClass;
+	}
+
+	public function GetSelectedClasses()
+	{
+		return $this->aSelectedClasses;
+	}
+
+	/**
+	 * @param array $aSelectedClasses array of aliases
+	 * @throws CoreException
+	 */
+	public function SetSelectedClasses($aSelectedClasses)
+	{
+		// 1 - change for each search
+		foreach ($this->aSearches as $oSearch)
+		{
+			// Throws an exception if not valid
+			$oSearch->SetSelectedClasses($aSelectedClasses);
+		}
+		// 2 - update the lowest common ancestors
+		$this->ComputeSelectedClasses();
+	}
+
+	/**
+	 * Change any alias of the query tree
+	 *
+	 * @param $sOldName
+	 * @param $sNewName
+	 * @return bool True if the alias has been found and changed
+	 */
+	public function RenameAlias($sOldName, $sNewName)
+	{
+		$bRet = false;
+		foreach ($this->aSearches as $oSearch)
+		{
+			$bRet = $oSearch->RenameAlias($sOldName, $sNewName) || $bRet;
+		}
+		return $bRet;
+	}
+
+	public function IsAny()
+	{
+		$bIsAny = true;
+		foreach ($this->aSearches as $oSearch)
+		{
+			if (!$oSearch->IsAny())
+			{
+				$bIsAny = false;
+				break;
+			}
+		}
+		return $bIsAny;
+	}
+
+	public function ResetCondition()
+	{
+		foreach ($this->aSearches as $oSearch)
+		{
+			$oSearch->ResetCondition();
+		}
+	}
+
+	public function MergeConditionExpression($oExpression)
+	{
+		$aAliases = array_keys($this->aSelectedClasses);
+		foreach ($this->aSearches as $iSearchIndex => $oSearch)
+		{
+			$oClonedExpression = $oExpression->DeepClone();
+			if ($iSearchIndex != 0)
+			{
+				foreach (array_keys($oSearch->GetSelectedClasses()) as $iColumn => $sSearchAlias)
+				{
+					$oClonedExpression->RenameAlias($aAliases[$iColumn], $sSearchAlias);
+				}
+			}
+			$oSearch->MergeConditionExpression($oClonedExpression);
+		}
+	}
+
+	public function AddConditionExpression($oExpression)
+	{
+		$aAliases = array_keys($this->aSelectedClasses);
+		foreach ($this->aSearches as $iSearchIndex => $oSearch)
+		{
+			$oClonedExpression = $oExpression->DeepClone();
+			if ($iSearchIndex != 0)
+			{
+				foreach (array_keys($oSearch->GetSelectedClasses()) as $iColumn => $sSearchAlias)
+				{
+					$oClonedExpression->RenameAlias($aAliases[$iColumn], $sSearchAlias);
+				}
+			}
+			$oSearch->AddConditionExpression($oClonedExpression);
+		}
+	}
+
+  	public function AddNameCondition($sName)
+	{
+		foreach ($this->aSearches as $oSearch)
+		{
+			$oSearch->AddNameCondition($sName);
+		}
+	}
+
+	public function AddCondition($sFilterCode, $value, $sOpCode = null)
+	{
+		foreach ($this->aSearches as $oSearch)
+		{
+			$oSearch->AddCondition($sFilterCode, $value, $sOpCode);
+		}
+	}
+
+	/**
+	 * 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 (can be an array => IN(val1, val2...)
+	 * @return void
+	 */
+	public function AddConditionAdvanced($sAttSpec, $value)
+	{
+		foreach ($this->aSearches as $oSearch)
+		{
+			$oSearch->AddConditionAdvanced($sAttSpec, $value);
+		}
+	}
+
+	public function AddCondition_FullText($sFullText)
+	{
+		foreach ($this->aSearches as $oSearch)
+		{
+			$oSearch->AddCondition_FullText($sFullText);
+		}
+	}
+
+	/**
+	 * @param DBObjectSearch $oFilter
+	 * @param $sExtKeyAttCode
+	 * @param int $iOperatorCode
+	 * @param null $aRealiasingMap array of <old-alias> => <new-alias>, for each alias that has changed
+	 * @throws CoreException
+	 * @throws CoreWarning
+	 */
+	public function AddCondition_PointingTo(DBObjectSearch $oFilter, $sExtKeyAttCode, $iOperatorCode = TREE_OPERATOR_EQUALS, &$aRealiasingMap = null)
+	{
+		foreach ($this->aSearches as $oSearch)
+		{
+			$oSearch->AddCondition_PointingTo($oFilter, $sExtKeyAttCode, $iOperatorCode, $aRealiasingMap);
+		}
+	}
+
+	/**
+	 * @param DBObjectSearch $oFilter
+	 * @param $sForeignExtKeyAttCode
+	 * @param int $iOperatorCode
+	 * @param null $aRealiasingMap array of <old-alias> => <new-alias>, for each alias that has changed
+	 */
+	public function AddCondition_ReferencedBy(DBObjectSearch $oFilter, $sForeignExtKeyAttCode, $iOperatorCode = TREE_OPERATOR_EQUALS, &$aRealiasingMap = null)
+	{
+		foreach ($this->aSearches as $oSearch)
+		{
+			$oSearch->AddCondition_ReferencedBy($oFilter, $sForeignExtKeyAttCode, $iOperatorCode, $aRealiasingMap);
+		}
+	}
+
+	public function Intersect(DBSearch $oFilter)
+	{
+		$aSearches = array();
+		foreach ($this->aSearches as $oSearch)
+		{
+			$aSearches[] = $oSearch->Intersect($oFilter);
+		}
+		return new DBUnionSearch($aSearches);
+	}
+
+	public function SetInternalParams($aParams)
+	{
+		foreach ($this->aSearches as $oSearch)
+		{
+			$oSearch->SetInternalParams($aParams);
+		}
+	}
+
+	public function GetInternalParams()
+	{
+		$aParams = array();
+		foreach ($this->aSearches as $oSearch)
+		{
+			$aParams = array_merge($oSearch->GetInternalParams(), $aParams);
+		}
+		return $aParams;
+	}
+
+	public function GetQueryParams($bExcludeMagicParams = true)
+	{
+		$aParams = array();
+		foreach ($this->aSearches as $oSearch)
+		{
+			$aParams = array_merge($oSearch->GetQueryParams($bExcludeMagicParams), $aParams);
+		}
+		return $aParams;
+	}
+
+	public function ListConstantFields()
+	{
+		// Somewhat complex to implement for unions, for a poor benefit
+		return array();
+	}
+
+	/**
+	 * Turn the parameters (:xxx) into scalar values in order to easily
+	 * serialize a search
+	 */
+	public function ApplyParameters($aArgs)
+	{
+		foreach ($this->aSearches as $oSearch)
+		{
+			$oSearch->ApplyParameters($aArgs);
+		}
+	}
+
+	/**
+	 * Overloads for query building
+	 */ 
+	public function ToOQL($bDevelopParams = false, $aContextParams = null, $bWithAllowAllFlag = false)
+	{
+		$aSubQueries = array();
+		foreach ($this->aSearches as $oSearch)
+		{
+			$aSubQueries[] = $oSearch->ToOQL($bDevelopParams, $aContextParams, $bWithAllowAllFlag);
+		}
+		$sRet = implode(' UNION ', $aSubQueries);
+		return $sRet;
+	}
+
+	/**
+	 * Returns a new DBUnionSearch object where duplicates queries have been removed based on their OQLs
+	 * 
+	 * @return \DBUnionSearch
+	 */
+	public function RemoveDuplicateQueries()
+	{
+		$aQueries = array();
+		$aSearches = array();
+
+		foreach ($this->GetSearches() as $oTmpSearch)
+		{
+			$sQuery = $oTmpSearch->ToOQL(true);
+			if (!in_array($sQuery, $aQueries))
+			{
+				$aQueries[] = $sQuery;
+				$aSearches[] = $oTmpSearch;
+			}
+		}
+
+		$oNewSearch = new DBUnionSearch($aSearches);
+		
+		return $oNewSearch;
+	}
+
+	////////////////////////////////////////////////////////////////////////////
+	//
+	// Construction of the SQL queries
+	//
+	////////////////////////////////////////////////////////////////////////////
+
+	public function MakeDeleteQuery($aArgs = array())
+	{
+		throw new Exception('MakeDeleteQuery is not implemented for the unions!');
+	}
+
+	public function MakeUpdateQuery($aValues, $aArgs = array())
+	{
+		throw new Exception('MakeUpdateQuery is not implemented for the unions!');
+	}
+
+	public function GetSQLQueryStructure($aAttToLoad, $bGetCount, $aGroupByExpr = null, $aSelectedClasses = null)
+	{
+		if (count($this->aSearches) == 1)
+		{
+			return $this->aSearches[0]->GetSQLQueryStructure($aAttToLoad, $bGetCount, $aGroupByExpr);
+		}
+
+		$aSQLQueries = array();
+		$aAliases = array_keys($this->aSelectedClasses);
+		foreach ($this->aSearches as $iSearch => $oSearch)
+		{
+			$aSearchAliases = array_keys($oSearch->GetSelectedClasses());
+
+			// The selected classes from the query build perspective are the lowest common ancestors amongst the various queries
+			// (used when it comes to determine which attributes must be selected)
+			$aSearchSelectedClasses = array();
+			foreach ($aSearchAliases as $iColumn => $sSearchAlias)
+			{
+				$sAlias = $aAliases[$iColumn];
+				$aSearchSelectedClasses[$sSearchAlias] = $this->aSelectedClasses[$sAlias];
+			}
+
+			if ($bGetCount)
+			{
+				// Select only ids for the count to allow optimization of joins
+				foreach($aSearchAliases as $sSearchAlias)
+				{
+					$aQueryAttToLoad[$sSearchAlias] = array();
+				}
+			}
+			else
+			{
+				if (is_null($aAttToLoad))
+				{
+					$aQueryAttToLoad = null;
+				}
+				else
+				{
+					// (Eventually) Transform the aliases
+					$aQueryAttToLoad = array();
+					foreach($aAttToLoad as $sAlias => $aAttributes)
+					{
+						$iColumn = array_search($sAlias, $aAliases);
+						$sQueryAlias = ($iColumn === false) ? $sAlias : $aSearchAliases[$iColumn];
+						$aQueryAttToLoad[$sQueryAlias] = $aAttributes;
+					}
+				}
+			}
+
+			if (is_null($aGroupByExpr))
+			{
+				$aQueryGroupByExpr = null;
+			}
+			else
+			{
+				// Clone (and eventually transform) the group by expressions
+				$aQueryGroupByExpr = array();
+				$aTranslationData = array();
+				$aQueryColumns = array_keys($oSearch->GetSelectedClasses());
+				foreach ($aAliases as $iColumn => $sAlias)
+				{
+					$sQueryAlias = $aQueryColumns[$iColumn];
+					$aTranslationData[$sAlias]['*'] = $sQueryAlias;
+					$aQueryGroupByExpr[$sAlias.'id'] = new FieldExpression('id', $sQueryAlias);
+				}
+				foreach ($aGroupByExpr as $sExpressionAlias => $oExpression)
+				{
+					$aQueryGroupByExpr[$sExpressionAlias] = $oExpression->Translate($aTranslationData, false, false);
+				}
+			}
+			$oSubQuery = $oSearch->GetSQLQueryStructure($aQueryAttToLoad, false, $aQueryGroupByExpr, $aSearchSelectedClasses);
+			if (count($aSearchAliases) > 1)
+			{
+				// Necessary to make sure that selected columns will match throughout all the queries
+				// (default order of selected fields depending on the order of JOINS)
+				$oSubQuery->SortSelectedFields();
+			}
+			$aSQLQueries[] = $oSubQuery;
+		}
+
+		$oSQLQuery = new SQLUnionQuery($aSQLQueries, $aGroupByExpr);
+		//MyHelpers::var_dump_html($oSQLQuery, true);
+		//MyHelpers::var_dump_html($oSQLQuery->RenderSelect(), true);
+		if (self::$m_bDebugQuery) $oSQLQuery->DisplayHtml();
+		return $oSQLQuery;
+	}
+}

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)
@@ -97,16 +101,22 @@ class DeletionPlan
 				}
 				if ($aData['mode'] == DEL_MANUAL)
 				{
+					$this->m_aToDelete[$sClass][$iId]['issue'] = $sClass.'::'.$iId.' '.Dict::S('UI:Delete:MustBeDeletedManually');
 					$this->m_bFoundStopper = true;
 					$this->m_bFoundManualDelete = true;
 				}
 			}
 		}
 
+		// 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 +140,9 @@ class DeletionPlan
 						$this->m_bFoundSecurityIssue = true;
 					}
 				}
-
 			}
 		}
+		set_time_limit($iPreviousTimeLimit);
 	}
 
 	public function GetIssues()

core/designdocument.class.inc.php

@@ -0,0 +1,268 @@
+<?php
+// Copyright (C) 2016 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/>
+
+/**
+ * Design document and associated nodes
+ * @package Core
+ */
+
+namespace Combodo\iTop;
+
+use \DOMDocument;
+use \DOMFormatException;
+
+/**
+ * Class \Combodo\iTop\DesignDocument
+ *
+ * A design document is the DOM tree that modelize behaviors. One of its
+ * characteristics is that it can be altered by the mean of the same kind of document.
+ *
+ */
+class DesignDocument extends DOMDocument
+{
+	/**
+	 * @throws \Exception
+	 */
+	public function __construct()
+	{
+		parent::__construct('1.0', 'UTF-8');
+		$this->Init();
+	}
+
+	/**
+	 * Overloadable. Called prior to data loading.
+	 */
+	protected function Init()
+	{
+		$this->registerNodeClass('DOMElement', '\Combodo\iTop\DesignElement');
+
+		$this->formatOutput = true; // indent (must be loaded with option LIBXML_NOBLANKS)
+		$this->preserveWhiteSpace = true; // otherwise the formatOutput option would have no effect
+	}
+
+	/**
+	 * Overload of the standard API
+	 */
+	public function load($filename, $options = 0)
+	{
+		parent::load($filename, LIBXML_NOBLANKS);
+	}
+
+	/**
+	 * Overload of the standard API
+	 */
+	public function save($filename, $options = 0)
+	{
+		$this->documentElement->setAttribute('xmlns:xsi', "http://www.w3.org/2001/XMLSchema-instance");
+		return parent::save($filename, LIBXML_NOBLANKS);
+	}
+
+	/**
+	 * Create an HTML representation of the DOM, for debugging purposes
+	 * @param bool|false $bReturnRes Echoes or returns the HTML representation
+	 * @return mixed void or the HTML representation of the DOM
+	 */
+	public function Dump($bReturnRes = false)
+	{
+		$sXml = $this->saveXML();
+		if ($bReturnRes)
+		{
+			return $sXml;
+		}
+		else
+		{
+			echo "<pre>\n";
+			echo htmlentities($sXml);
+			echo "</pre>\n";
+		}
+	}
+
+	/**
+	 * Quote and escape strings for use within an XPath expression
+	 * Usage: DesignDocument::GetNodes('class[@id='.DesignDocument::XPathQuote($sId).']');
+	 * @param $sValue The value to be quoted
+	 * @return string to be used within an XPath
+	 */
+	public static function XPathQuote($sValue)
+	{
+		if (strpos($sValue, '"') !== false)
+		{
+			$aParts = explode('"', $sValue);
+			$sRet = 'concat("'.implode('", \'"\', "', $aParts).'")';
+		}
+		else
+		{
+			$sRet = '"'.$sValue.'"';
+		}
+		return $sRet;
+	}
+
+	/**
+	 * Extracts some nodes from the DOM
+	 * @param string $sXPath A XPath expression
+	 * @param DesignNode|null $oContextNode The node to start the search from
+	 * @return \DOMNodeList
+	 */
+	public function GetNodes($sXPath, $oContextNode = null)
+	{
+		$oXPath = new \DOMXPath($this);
+		if (is_null($oContextNode))
+		{
+			$oResult = $oXPath->query($sXPath);
+		}
+		else
+		{
+			$oResult = $oXPath->query($sXPath, $oContextNode);
+		}
+		return $oResult;
+	}
+
+	/**
+	 * An alternative to getNodePath, that gives the id of nodes instead of the position within the children
+	 * @param $oNode The node to describe
+	 * @return string
+	 */
+	public static function GetItopNodePath($oNode)
+	{
+		if ($oNode instanceof \DOMDocument) return '';
+		if (is_null($oNode)) return '';
+
+		$sId = $oNode->getAttribute('id');
+		$sNodeDesc = ($sId != '') ? $oNode->nodeName.'['.$sId.']' : $oNode->nodeName;
+		return self::GetItopNodePath($oNode->parentNode).'/'.$sNodeDesc;
+	}
+}
+
+/**
+ * DesignElement: helper to read/change the DOM
+ * @package ModelFactory
+ */
+class DesignElement extends \DOMElement
+{
+	/**
+	 * Extracts some nodes from the DOM
+	 * @param string $sXPath A XPath expression
+	 * @return \DOMNodeList
+	 */
+	public function GetNodes($sXPath)
+	{
+		return $this->ownerDocument->GetNodes($sXPath, $this);
+	}
+
+	/**
+	 * Create an HTML representation of the DOM, for debugging purposes
+	 * @param bool|false $bReturnRes Echoes or returns the HTML representation
+	 * @return mixed void or the HTML representation of the DOM
+	 */
+	public function Dump($bReturnRes = false)
+	{
+		$oDoc = new DesignDocument();
+		$oClone = $oDoc->importNode($this->cloneNode(true), true);
+		$oDoc->appendChild($oClone);
+
+		$sXml = $oDoc->saveXML($oClone);
+		if ($bReturnRes)
+		{
+			return $sXml;
+		}
+		else
+		{
+			echo "<pre>\n";
+			echo htmlentities($sXml);
+			echo "</pre>\n";
+		}
+	}
+
+	/**
+	 * Returns the node directly under the given node
+	 * @param $sTagName
+	 * @param bool|true $bMustExist
+	 * @return MFElement
+	 * @throws DOMFormatException
+	 */
+	public function GetUniqueElement($sTagName, $bMustExist = true)
+	{
+		$oNode = null;
+		foreach($this->childNodes as $oChildNode)
+		{
+			if ($oChildNode->nodeName == $sTagName)
+			{
+				$oNode = $oChildNode;
+				break;
+			}
+		}
+		if ($bMustExist && is_null($oNode))
+		{
+			throw new DOMFormatException('Missing unique tag: '.$sTagName);
+		}
+		return $oNode;
+	}
+
+	/**
+	 * Returns the node directly under the current node, or null if missing
+	 * @param $sTagName
+	 * @return MFElement
+	 * @throws DOMFormatException
+	 */
+	public function GetOptionalElement($sTagName)
+	{
+		return $this->GetUniqueElement($sTagName, false);
+	}
+
+	/**
+	 * Returns the TEXT of the current node (possibly from several child nodes)
+	 * @param null $sDefault
+	 * @return null|string
+	 */
+	public function GetText($sDefault = null)
+	{
+		$sText = null;
+		foreach($this->childNodes as $oChildNode)
+		{
+			if ($oChildNode instanceof \DOMText)
+			{
+				if (is_null($sText)) $sText = '';
+				$sText .= $oChildNode->wholeText;
+			}
+		}
+		if (is_null($sText))
+		{
+			return $sDefault;
+		}
+		else
+		{
+			return $sText;
+		}
+	}
+
+	/**
+	 * Get the TEXT value from a child node
+	 * @param string $sTagName
+	 * @param string|null $sDefault
+	 * @return string
+	 */
+	public function GetChildText($sTagName, $sDefault = null)
+	{
+		$sRet = $sDefault;
+		if ($oChild = $this->GetOptionalElement($sTagName))
+		{
+			$sRet = $oChild->GetText($sDefault);
+		}
+		return $sRet;
+	}
+}

core/dict.class.inc.php

@@ -1,27 +1,27 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2016 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
@@ -57,26 +57,13 @@ define('DICT_ERR_EXCEPTION', 2); // when a string is missing, throw an exception
 
 class Dict
 {
-	protected static $m_bTraceFiles = false;
-	protected static $m_aEntryFiles = array();
-
 	protected static $m_iErrorMode = DICT_ERR_STRING;
 	protected static $m_sDefaultLanguage = 'EN US';
 	protected static $m_sCurrentLanguage = null; // No language selected by default
 
 	protected static $m_aLanguages = array(); // array( code => array( 'description' => '...', 'localized_description' => '...') ...)
 	protected static $m_aData = array();
-
-
-	public static function EnableTraceFiles()
-	{
-		self::$m_bTraceFiles = true;
-	}
-
-	public static function GetEntryFiles()
-	{
-		return self::$m_aEntryFiles;
-	}
+	protected static $m_sApplicationPrefix = null;
 
 	public static function SetDefaultLanguage($sLanguageCode)
 	{
@@ -119,11 +106,20 @@ class Dict
 		self::$m_iErrorMode = $iErrorMode;
 	}
 
-
-	public static function S($sStringCode, $sDefault = null)
+	/**
+	 * Returns a localised string from the dictonary
+	 * @param string $sStringCode The code identifying the dictionary entry
+	 * @param string $sDefault Default value if there is no match in the dictionary
+	 * @param bool $bUserLanguageOnly True to allow the use of the default language as a fallback, false otherwise
+	 * @throws DictExceptionMissingString
+	 * @return unknown|Ambigous <>|string
+	 */
+	public static function S($sStringCode, $sDefault = null, $bUserLanguageOnly = false)
 	{
 		// Attempt to find the string in the user language
 		//
+		self::InitLangIfNeeded(self::GetUserLanguage());
+
 		if (!array_key_exists(self::GetUserLanguage(), self::$m_aData))
 		{
 			// It may happen, when something happens before the dictionnaries get loaded
@@ -134,19 +130,26 @@ 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
+			//
+			self::InitLangIfNeeded(self::$m_sDefaultLanguage);
+			
+			$aDefaultDictionary = self::$m_aData[self::$m_sDefaultLanguage];
+			if (array_key_exists($sStringCode, $aDefaultDictionary))
+			{
+				return $aDefaultDictionary[$sStringCode];
+			}
+			// Attempt to find the string in english
+			//
+			self::InitLangIfNeeded('EN US');
+
+			$aDefaultDictionary = self::$m_aData['EN US'];
+			if (array_key_exists($sStringCode, $aDefaultDictionary))
+			{
+				return $aDefaultDictionary[$sStringCode];
+			}
 		}
 		// Could not find the string...
 		//
@@ -172,6 +175,12 @@ class Dict
 	}
 
 
+	/**
+	 * Formats a localized string with numbered placeholders (%1$s...) for the additional arguments
+	 * See vsprintf for more information about the syntax of the placeholders
+	 * @param string $sFormatCode
+	 * @return string
+	 */
 	public static function Format($sFormatCode /*, ... arguments ....*/)
 	{
 		$sLocalizedFormat = self::S($sFormatCode);
@@ -186,43 +195,95 @@ class Dict
 
 		return vsprintf($sLocalizedFormat, $aArguments);
 	}
-
-
-	// sLanguageCode: Code identifying the language i.e. FR-FR
-	// sEnglishLanguageDesc: Description of the language code, in English. i.e. French (France)
-	// sLocalizedLanguageDesc: Description of the language code, in its own language. i.e. Français (France)
-	// aEntries: Hash array of dictionnary entries
-	// ~~ or ~* can be used to indicate entries still to be translated. 
-	public static function Add($sLanguageCode, $sEnglishLanguageDesc, $sLocalizedLanguageDesc, $aEntries)
+	
+	/**
+	 * Initialize a the entries for a given language (replaces the former Add() method)
+	 * @param string $sLanguageCode Code identifying the language i.e. 'FR-FR', 'EN-US'
+	 * @param hash $aEntries Hash array of dictionnary entries
+	 */
+	public static function SetEntries($sLanguageCode, $aEntries)
 	{
-		if (self::$m_bTraceFiles)
+		self::$m_aData[$sLanguageCode] = $aEntries;
+	}
+	
+	/**
+	 * Set the list of available languages
+	 * @param hash $aLanguagesList
+	 */
+	public static function SetLanguagesList($aLanguagesList)
+	{
+		self::$m_aLanguages = $aLanguagesList;
+	}
+	
+	/**
+	 * Load a language from the language dictionary, if not already loaded
+	 * @param string $sLangCode Language code
+	 * @return boolean
+	 */
+	public static function InitLangIfNeeded($sLangCode)
+	{
+		if (array_key_exists($sLangCode, self::$m_aData)) return true;
+		
+		$bResult = false;
+		
+		if (function_exists('apc_fetch') && (self::$m_sApplicationPrefix !== null))
 		{
-			$aBacktrace = debug_backtrace();
-			$sFile = $aBacktrace[0]["file"];
-
-			foreach($aEntries as $sKey => $sValue)
+			// Note: For versions of APC older than 3.0.17, fetch() accepts only one parameter
+			//
+			self::$m_aData[$sLangCode] = apc_fetch(self::$m_sApplicationPrefix.'-dict-'.$sLangCode);
+			if (self::$m_aData[$sLangCode] === false)
 			{
-				self::$m_aEntryFiles[$sLanguageCode][$sKey] = array(
-					'file' => $sFile,
-					'value' => $sValue
-				);
+				unset(self::$m_aData[$sLangCode]);
+			}
+			else
+			{
+				$bResult = true;
 			}
 		}
-
-		if (!array_key_exists($sLanguageCode, self::$m_aLanguages))
+		if (!$bResult)
 		{
-			self::$m_aLanguages[$sLanguageCode] = array('description' => $sEnglishLanguageDesc, 'localized_description' => $sLocalizedLanguageDesc);
-			self::$m_aData[$sLanguageCode] = array();
-		}
-		foreach($aEntries as $sCode => $sValue)
-		{
-			self::$m_aData[$sLanguageCode][$sCode] = self::FilterString($sValue);
+			$sDictFile = APPROOT.'env-'.utils::GetCurrentEnvironment().'/dictionaries/'.str_replace(' ', '-', strtolower($sLangCode)).'.dict.php';
+			require_once($sDictFile);
+			
+			if (function_exists('apc_store') && (self::$m_sApplicationPrefix !== null))
+			{
+				apc_store(self::$m_sApplicationPrefix.'-dict-'.$sLangCode, self::$m_aData[$sLangCode]);
+			}
+			$bResult = true;
 		}
+		return $bResult;
+	}
+	
+	/**
+	 * Enable caching (cached using APC)
+	 * @param string $sApplicationPrefix The prefix for uniquely identiying this iTop instance
+	 */
+	public static function EnableCache($sApplicationPrefix)
+	{
+		self::$m_sApplicationPrefix = $sApplicationPrefix;
 	}
 
+	/**
+	 * Reset the cached entries (cached using APC)
+	 * @param string $sApplicationPrefix The prefix for uniquely identiying this iTop instance
+	 */
+	public static function ResetCache($sApplicationPrefix)
+	{
+		if (function_exists('apc_delete'))
+		{
+			foreach(self::$m_aLanguages as $sLang => $void)
+			{
+				apc_delete($sApplicationPrefix.'-dict-'.$sLang);
+			}
+		}
+	}
+
+	/////////////////////////////////////////////////////////////////////////
+
+
 	/**
 	 * 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)
@@ -233,14 +294,14 @@ class Dict
 			}
 		}
 	}
-
+	
 	public static function MakeStats($sLanguageCode, $sLanguageRef = 'EN US')
 	{
 		$aMissing = array(); // Strings missing for the target language
 		$aUnexpected = array(); // Strings defined for the target language, but not found in the reference dictionary
 		$aNotTranslated = array(); // Strings having the same value in both dictionaries
 		$aOK = array(); // Strings having different values in both dictionaries
-
+	
 		foreach (self::$m_aData[$sLanguageRef] as $sStringCode => $sValue)
 		{
 			if (!array_key_exists($sStringCode, self::$m_aData[$sLanguageCode]))
@@ -248,7 +309,7 @@ class Dict
 				$aMissing[$sStringCode] = $sValue;
 			}
 		}
-
+	
 		foreach (self::$m_aData[$sLanguageCode] as $sStringCode => $sValue)
 		{
 			if (!array_key_exists($sStringCode, self::$m_aData[$sLanguageRef]))
@@ -276,57 +337,23 @@ class Dict
 	{
 		MyHelpers::var_dump_html(self::$m_aData);
 	}
-	
-	public static function InCache($sApplicationPrefix)
-	{
-		if (function_exists('apc_fetch'))
-		{
-			$bResult = false;
-			// Note: For versions of APC older than 3.0.17, fetch() accepts only one parameter
-			//
-			self::$m_aData = apc_fetch($sApplicationPrefix.'-dict');
-			if (is_bool(self::$m_aData) && (self::$m_aData === false))
-			{
-				self::$m_aData = array();
-			}
-			else
-			{
-				self::$m_aLanguages = apc_fetch($sApplicationPrefix.'-languages');
-				if (is_bool(self::$m_aLanguages) && (self::$m_aLanguages === false))
-				{
-					self::$m_aLanguages = array();
-				}
-				else
-				{
-					$bResult = true;
-				}
-			}
-			return $bResult;
-		}
-		return false;
-	}
-	
-	public static function InitCache($sApplicationPrefix)
-	{
-		if (function_exists('apc_store'))
-		{
-			apc_store($sApplicationPrefix.'-languages', self::$m_aLanguages);
-			apc_store($sApplicationPrefix.'-dict', self::$m_aData);
-		}
-	}
 
-	public static function ResetCache($sApplicationPrefix)
+	// Only used by the setup to determine the list of languages to display in the initial setup screen
+	// otherwise replaced by LoadModule by its own handler
+	// sLanguageCode: Code identifying the language i.e. FR-FR
+	// sEnglishLanguageDesc: Description of the language code, in English. i.e. French (France)
+	// sLocalizedLanguageDesc: Description of the language code, in its own language. i.e. Français (France)
+	// aEntries: Hash array of dictionnary entries
+	// ~~ or ~* can be used to indicate entries still to be translated.
+	public static function Add($sLanguageCode, $sEnglishLanguageDesc, $sLocalizedLanguageDesc, $aEntries)
 	{
-		if (function_exists('apc_delete'))
+		if (!array_key_exists($sLanguageCode, self::$m_aLanguages))
 		{
-			apc_delete($sApplicationPrefix.'-languages');
-			apc_delete($sApplicationPrefix.'-dict');
+			self::$m_aLanguages[$sLanguageCode] = array('description' => $sEnglishLanguageDesc, 'localized_description' => $sLocalizedLanguageDesc);
+			self::$m_aData[$sLanguageCode] = array();
 		}
-	}
-	
-	protected static function FilterString($s)
-	{
-		return str_replace(array('~~', '~*'), '', $s);
+		// No need to actually load the strings since it's only used to know the list of languages
+		// at setup time !!
 	}
 }
 ?>

core/email.class.inc.php

@@ -1,66 +1,147 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2016 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-2016 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();
 	}
 
+	/**
+	 * 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 +154,53 @@ 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))
+		// If the body of the message is in HTML, embed all images based on attachments
+		$this->EmbedInlineImages();
+		
+		$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 'Null':
+			$oTransport = Swift_NullTransport::newInstance();
+			break;
+		
+		case 'LogFile':
+			$oTransport = Swift_LogFileTransport::newInstance();
+			$oTransport->setLogFile(APPROOT.'log/mail.log');
+			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
-			$this->EncodeHeaderField($this->m_sSubject), // Prevent header injection & MIME Encode charsets
-			$this->m_sBody,
-			$sHeaders
-		);
-		restore_error_handler();
-		if (!$bRes && empty($this->m_aMailErrors))
+		$oMailer = Swift_Mailer::newInstance($oTransport);
+
+		$aFailedRecipients = array();
+		$this->m_oMessage->setMaxLineLength(0);
+		$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
@@ -115,10 +209,46 @@ class EMail
 			return EMAIL_SEND_OK;
 		}
 	}
+	
+	/**
+	 * Reprocess the body of the message (if it is an HTML message)
+	 * to replace the URL of images based on attachments by a link
+	 * to an embedded image (i.e. cid:....)
+	 */
+	protected function EmbedInlineImages()
+	{
+		if ($this->m_aData['body']['mimeType'] == 'text/html')
+		{
+			$oDOMDoc = new DOMDocument();
+			$oDOMDoc->preserveWhitespace = true;
+			@$oDOMDoc->loadHTML('<?xml encoding="UTF-8"?>'.$this->m_aData['body']['body']); // For loading HTML chunks where the character set is not specified
+			
+			$oXPath = new DOMXPath($oDOMDoc);
+			$sXPath = "//img[@data-img-id]";
+			$oImagesList = $oXPath->query($sXPath);
+			
+			if ($oImagesList->length != 0)
+			{
+				foreach($oImagesList as $oImg)
+				{
+					$iAttId = $oImg->getAttribute('data-img-id');
+					$oAttachment = MetaModel::GetObject('InlineImage', $iAttId, false, true /* Allow All Data */);
+					if ($oAttachment)
+					{
+						$oDoc = $oAttachment->Get('contents');
+						$oSwiftImage = new Swift_Image($oDoc->GetData(), $oDoc->GetFileName(), $oDoc->GetMimeType());
+						$sCid = $this->m_oMessage->embed($oSwiftImage);
+						$oImg->setAttribute('src', $sCid);
+					}
+				}
+			}
+			$sHtmlBody = $oDOMDoc->saveHTML();
+			$this->m_oMessage->setBody($sHtmlBody, 'text/html', 'UTF-8');
+		}
+	}
 
 	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);
@@ -139,15 +269,33 @@ class EMail
 
 	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->AddToHeader('Message-ID', $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)
@@ -155,88 +303,221 @@ class EMail
 		$this->AddToHeader('References', $sReferences);
 	}
 
-	public function SetBody($sBody)
+	public function SetBody($sBody, $sMimeType = 'text/html', $sCustomStyles = null)
 	{
-		$this->m_sBody = $sBody;
+		if (($sMimeType === 'text/html') && ($sCustomStyles !== null))
+		{
+			require_once(APPROOT.'lib/emogrifier/Classes/Emogrifier.php');
+			$emogrifier = new \Pelago\Emogrifier($sBody, $sCustomStyles);
+			$sBody = $emogrifier->emogrify(); // Adds html/body tags if not already present
+		}
+		$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; charset="UTF-8"';
- 		$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);
+		}
+	}
+
+}
+
+/////////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Extension to SwiftMailer: "debug" transport that pretends messages have been sent,
+ * but just log them to a file.
+ *
+ * @package Swift
+ * @author  Denis Flaven
+ */
+class Swift_Transport_LogFileTransport extends Swift_Transport_NullTransport
+{
+	protected $sLogFile;
 	
 	/**
-	 * MIME encode the content of a header field according to RFC2047
-	 * @param string $sFieldContent the content of the header to encode
-	 * @return string The encoded string
+	 * Sends the given message.
+	 *
+	 * @param Swift_Mime_Message $message
+	 * @param string[]           $failedRecipients An array of failures by-reference
+	 *
+	 * @return int     The number of sent emails
 	 */
-	protected function EncodeHeaderField($sFieldContent)
+	public function send(Swift_Mime_Message $message, &$failedRecipients = null)
 	{
-		$sTemp = str_replace(array("\n", "\r"), ' ', $sFieldContent);
-		$sTemp = iconv_mime_encode('Tagada', $sTemp, array('scheme' => 'Q', 'input-charset' => 'UTF-8', 'output-charset' => 'UTF-8'));
-		return preg_replace('/^Tagada: /', '', $sTemp);
+		$hFile = @fopen($this->sLogFile, 'a');
+		if ($hFile)
+		{
+			$sTxt = "================== ".date('Y-m-d H:i:s')." ==================\n";
+			$sTxt .= $message->toString()."\n";
+		
+			@fwrite($hFile, $sTxt);
+			@fclose($hFile);
+		}
+		
+		return parent::send($message, $failedRecipients);
+	}
+	
+	public function setLogFile($sFilename)
+	{
+		$this->sLogFile = $sFilename;
 	}
 }
 
-?>
+/**
+ * Pretends messages have been sent, but just log them to a file.
+ *
+ * @package Swift
+ * @author  Denis Flaven
+ */
+class Swift_LogFileTransport extends Swift_Transport_LogFileTransport
+{
+	/**
+	 * Create a new LogFileTransport.
+	 */
+	public function __construct()
+	{
+		call_user_func_array(
+		array($this, 'Swift_Transport_LogFileTransport::__construct'),
+		Swift_DependencyContainer::getInstance()
+		->createDependenciesFor('transport.null')
+		);
+	}
+
+	/**
+	 * Create a new LogFileTransport instance.
+	 *
+	 * @return Swift_LogFileTransport
+	 */
+	public static function newInstance()
+	{
+		return new self();
+	}
+}

core/event.class.inc.php

@@ -1,28 +1,29 @@
 <?php
-// Copyright (C) 2010 Combodo SARL
+// Copyright (C) 2010-2017 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();
@@ -105,7 +107,7 @@ class Event extends DBObject implements iDisplay
 	
 	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();
@@ -175,10 +183,11 @@ class EventNotificationEmail extends EventNotification
 		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 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();
@@ -254,8 +264,8 @@ class EventIssue extends Event
 				}
 				else
 				{
-					// Not a string
-					$aPost[$sKey] = (string) $sValue;
+					// Not a string (avoid warnings in case the value cannot be easily casted into a string)
+					$aPost[$sKey] = @(string) $sValue;
 				}
 			}
 			$this->Set('arguments_post', $aPost);
@@ -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();
@@ -321,6 +332,42 @@ class EventWebService extends Event
 	}
 }
 
+class EventRestService extends Event
+{
+	public static function Init()
+	{
+		$aParams = array
+		(
+			"category" => "core/cmdb,view_in_gui",
+			"key_type" => "autoincrement",
+			"name_attcode" => "",
+			"state_attcode" => "",
+			"reconc_keys" => array(),
+			"db_table" => "priv_event_restservice",
+			"db_key_field" => "id",
+			"db_finalclass_field" => "",
+			"display_template" => "",
+			"order_by_default" => array('date' => false)
+		);
+		MetaModel::Init_Params($aParams);
+		MetaModel::Init_InheritAttributes();
+		MetaModel::Init_AddAttribute(new AttributeString("operation", array("allowed_values"=>null, "sql"=>"operation", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeString("version", array("allowed_values"=>null, "sql"=>"version", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeText("json_input", array("allowed_values"=>null, "sql"=>"json_input", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
+
+		MetaModel::Init_AddAttribute(new AttributeInteger("code", array("allowed_values"=>null, "sql"=>"code", "default_value"=>0, "is_null_allowed"=>false, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeText("json_output", array("allowed_values"=>null, "sql"=>"json_output", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
+		MetaModel::Init_AddAttribute(new AttributeString("provider", array("allowed_values"=>null, "sql"=>"provider", "default_value"=>null, "is_null_allowed"=>true, "depends_on"=>array())));
+
+		// Display lists
+		MetaModel::Init_SetZListItems('details', array('date', 'userinfo', 'operation', 'version', 'json_input', 'message', 'code', 'json_output', 'provider')); // Attributes to be displayed for the complete details
+		MetaModel::Init_SetZListItems('list', array('date', 'userinfo', 'operation', 'message')); // 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
+	}
+}
+
 class EventLoginUsage extends Event
 {
 	public static function Init()
@@ -335,11 +382,12 @@ 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 AttributeExternalKey("user_id", array("targetclass"=>"User", "jointype"=> "", "allowed_values"=>null, "sql"=>"user_id", "is_null_allowed"=>false, "on_target_delete"=>DEL_SILENT, "depends_on"=>array())));
 		$aZList = array('date', 'user_id');
 		if (MetaModel::IsValidAttCode('Contact', 'name'))
 		{
@@ -360,4 +408,30 @@ class EventLoginUsage extends Event
 	}
 }
 
-?>
+class EventOnObject extends Event
+{
+    public static function Init()
+    {
+        $aParams = array
+        (
+            "category" => "core/cmdb,view_in_gui",
+            "key_type" => "autoincrement",
+            "name_attcode" => "",
+            "state_attcode" => "",
+            "reconc_keys" => array(),
+            "db_table" => "priv_event_onobject",
+            "db_key_field" => "id",
+            "db_finalclass_field" => "",
+            "display_template" => "",
+            "order_by_default" => array('date' => false)
+        );
+        MetaModel::Init_Params($aParams);
+        MetaModel::Init_InheritAttributes();
+        MetaModel::Init_AddAttribute(new AttributeString("obj_class", array("allowed_values"=>null, "sql"=>"obj_class", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+        MetaModel::Init_AddAttribute(new AttributeInteger("obj_key", array("allowed_values"=>null, "sql"=>"obj_key", "default_value"=>null, "is_null_allowed"=>false, "depends_on"=>array())));
+
+        // Display lists
+        MetaModel::Init_SetZListItems('details', array('date', 'userinfo', 'obj_class', 'obj_key', 'message')); // Attributes to be displayed for the complete details
+        MetaModel::Init_SetZListItems('list', array('date', 'userinfo', 'obj_class', 'obj_key', 'message')); // Attributes to be displayed for a list
+    }
+}

core/excelbulkexport.class.inc.php

@@ -0,0 +1,384 @@
+<?php
+// Copyright (C) 2015-2016 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/>
+
+/**
+ * Bulk export: Excel (xlsx) export
+ *
+ * @copyright   Copyright (C) 2015-2016 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+require_once(APPROOT.'application/xlsxwriter.class.php');
+
+class ExcelBulkExport extends TabularBulkExport
+{
+	protected $sData;
+
+	public function __construct()
+	{
+		parent::__construct();
+		$this->aStatusInfo['status'] = 'not_started';
+		$this->aStatusInfo['position'] = 0;
+	}
+
+	public function Cleanup()
+	{
+		@unlink($this->aStatusInfo['tmp_file']);
+		parent::Cleanup();
+	}
+
+	public function DisplayUsage(Page $oP)
+	{
+		$oP->p(" * xlsx format options:");
+		$oP->p(" *\tfields: the comma separated list of field codes to export (e.g: name,org_id,service_name...).");
+		$oP->p(" *\tformatted_text: set to 1 to export case logs and formatted text fields with their HTML markup. Default is 0 (= plain text)");
+		$oP->p(" *\tdate_format: the format to use when exporting date and time fields (default = the SQL format). e.g. 'Y-m-d H:i:s'");
+	}
+
+	public function ReadParameters()
+	{
+		parent::ReadParameters();
+		$this->aStatusInfo['formatted_text'] = (bool)utils::ReadParam('formatted_text', 0, true);
+			
+		$sDateFormatRadio = utils::ReadParam('excel_date_format_radio', '');
+		switch($sDateFormatRadio)
+		{
+			case 'default':
+			// Export from the UI => format = same as is the UI
+			$this->aStatusInfo['date_format'] = (string)AttributeDateTime::GetFormat();
+			break;
+			
+			case 'custom':
+			// Custom format specified from the UI
+			$this->aStatusInfo['date_format'] = utils::ReadParam('date_format', (string)AttributeDateTime::GetFormat(), true, 'raw_data');
+			break;
+			
+			default:
+			// Export from the command line (or scripted) => default format is SQL, as in previous versions of iTop, unless specified otherwise
+			$this->aStatusInfo['date_format'] = utils::ReadParam('date_format', (string)AttributeDateTime::GetSQLFormat(), true, 'raw_data');
+		}
+	}
+	
+	public function EnumFormParts()
+	{
+		return array_merge(parent::EnumFormParts(), array('xlsx_options' => array('formatted_text') ,'interactive_fields_xlsx' => array('interactive_fields_xlsx')));
+	}
+
+	public function DisplayFormPart(WebPage $oP, $sPartId)
+	{
+		switch($sPartId)
+		{
+			case 'interactive_fields_xlsx':
+				$this->GetInteractiveFieldsWidget($oP, 'interactive_fields_xlsx');
+				break;
+					
+			case 'xlsx_options':
+				$oP->add('<fieldset><legend>'.Dict::S('Core:BulkExport:XLSXOptions').'</legend>');
+				$oP->add('<table class="export_parameters"><tr><td style="vertical-align:top">');
+				
+				$sChecked = (utils::ReadParam('formatted_text', 0) == 1) ? ' checked ' : '';
+				$oP->add('<h3>'.Dict::S('Core:BulkExport:TextFormat').'</h3>');
+				$oP->add('<input type="checkbox" id="xlsx_formatted_text" name="formatted_text" value="1"'.$sChecked.'><label for="xlsx_formatted_text"> '.Dict::S('Core:BulkExport:OptionFormattedText').'</label>');
+				
+				$oP->add('</td><td style="vertical-align:top">');
+				
+				$sDateTimeFormat = utils::ReadParam('date_format', (string)AttributeDateTime::GetFormat(), true, 'raw_data');
+				$sDefaultChecked = ($sDateTimeFormat == (string)AttributeDateTime::GetFormat()) ? ' checked' : '';
+				$sCustomChecked = ($sDateTimeFormat !== (string)AttributeDateTime::GetFormat()) ? ' checked' : '';
+				$oP->add('<h3>'.Dict::S('Core:BulkExport:DateTimeFormat').'</h3>');
+				$sDefaultFormat = htmlentities((string)AttributeDateTime::GetFormat(), ENT_QUOTES, 'UTF-8');
+				$sExample = htmlentities(date((string)AttributeDateTime::GetFormat()), ENT_QUOTES, 'UTF-8');
+				$oP->add('<input type="radio" id="excel_date_time_format_default" name="excel_date_format_radio" value="default"'.$sDefaultChecked.'><label for="excel_date_time_format_default"> '.Dict::Format('Core:BulkExport:DateTimeFormatDefault_Example', $sDefaultFormat, $sExample).'</label><br/>');
+				$sFormatInput = '<input type="text" size="15" name="date_format" id="excel_custom_date_time_format" title="" value="'.htmlentities($sDateTimeFormat, ENT_QUOTES, 'UTF-8').'"/>';
+				$oP->add('<input type="radio" id="excel_date_time_format_custom" name="excel_date_format_radio" value="custom"'.$sCustomChecked.'><label for="excel_date_time_format_custom"> '.Dict::Format('Core:BulkExport:DateTimeFormatCustom_Format', $sFormatInput).'</label>');
+				
+				$oP->add('</td></tr></table>');
+				
+				$oP->add('</fieldset>');
+				$sJSTooltip = json_encode('<div class="date_format_tooltip">'.Dict::S('UI:CSVImport:CustomDateTimeFormatTooltip').'</div>');
+				$oP->add_ready_script(
+<<<EOF
+$('#excel_custom_date_time_format').tooltip({content: function() { return $sJSTooltip; } });
+$('#form_part_xlsx_options').on('preview_updated', function() { FormatDatesInPreview('excel', 'xlsx'); });
+$('#excel_date_time_format_default').on('click', function() { FormatDatesInPreview('excel', 'xlsx'); });
+$('#excel_date_time_format_custom').on('click', function() { FormatDatesInPreview('excel', 'xlsx'); });
+$('#excel_custom_date_time_format').on('click', function() { $('#excel_date_time_format_custom').prop('checked', true); FormatDatesInPreview('excel', 'xlsx'); }).on('keyup', function() { FormatDatesInPreview('excel', 'xlsx'); });					
+EOF
+				);
+				break;
+
+				default:
+				return parent:: DisplayFormPart($oP, $sPartId);
+		}
+	}
+
+	protected function SuggestField($sClass, $sAttCode)
+	{
+		switch($sAttCode)
+		{
+			case 'id': // replace 'id' by 'friendlyname'
+				$sAttCode = 'friendlyname';
+				break;
+					
+			default:
+				$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
+				if ($oAttDef instanceof AttributeExternalKey)
+				{
+					$sAttCode .= '_friendlyname';
+				}
+		}
+
+		return parent::SuggestField($sClass, $sAttCode);
+	}
+
+	protected function GetSampleData($oObj, $sAttCode)
+	{
+		if ($sAttCode != 'id')
+		{
+			$oAttDef = MetaModel::GetAttributeDef(get_class($oObj), $sAttCode);
+			if ($oAttDef instanceof AttributeDateTime) // AttributeDate is derived from AttributeDateTime
+			{
+				$sClass = (get_class($oAttDef) == 'AttributeDateTime') ? 'user-formatted-date-time' : 'user-formatted-date';
+				return '<div class="'.$sClass.'" data-date="'.$oObj->Get($sAttCode).'">'.htmlentities($oAttDef->GetEditValue($oObj->Get($sAttCode), $oObj), ENT_QUOTES, 'UTF-8').'</div>';
+			}
+		}
+		return '<div class="text-preview">'.htmlentities($this->GetValue($oObj, $sAttCode), ENT_QUOTES, 'UTF-8').'</div>';
+	}
+
+	protected function GetValue($oObj, $sAttCode)
+	{
+		switch($sAttCode)
+		{
+			case 'id':
+				$sRet = $oObj->GetKey();
+				break;
+					
+			default:
+			$value = $oObj->Get($sAttCode);
+			if ($value instanceOf ormCaseLog)
+			{
+				 if (array_key_exists('formatted_text', $this->aStatusInfo) && $this->aStatusInfo['formatted_text'])
+				 {
+				 	$sText = $value->GetText();
+				 }
+				 else
+				 {
+				 	$sText = $value->GetAsPlainText();
+				 }
+				// Extract the case log as text and remove the "===" which make Excel think that the cell contains a formula the next time you edit it!
+				$sRet = trim(preg_replace('/========== ([^=]+) ============/', '********** $1 ************', $sText));
+			}
+			else if ($value instanceOf DBObjectSet)
+			{
+				$oAttDef = MetaModel::GetAttributeDef(get_class($oObj), $sAttCode);
+				$sRet = $oAttDef->GetAsCSV($value, '', '', $oObj);
+			}
+			else if ($value instanceOf ormDocument)
+			{
+				$oAttDef = MetaModel::GetAttributeDef(get_class($oObj), $sAttCode);
+				$sRet = $oAttDef->GetAsCSV($value, '', '', $oObj);
+			}
+			else
+			{
+				$oAttDef = MetaModel::GetAttributeDef(get_class($oObj), $sAttCode);
+				if ($oAttDef instanceof AttributeDateTime)
+				{
+					// Date and times are formatted using the ISO encoding, not the localized format
+					if ($oAttDef->IsNull($value))
+					{
+						// NOt a valid date
+						$sRet = '';
+					}
+					else
+					{
+						$sRet = $value;
+					}
+				}
+				else if (array_key_exists('formatted_text', $this->aStatusInfo) && $this->aStatusInfo['formatted_text'])
+				{
+					$sRet = $oAttDef->GetEditValue($value, $oObj);
+				}
+				else
+				{
+					$sRet = $oAttDef->GetAsPlainText($value, $oObj);
+				}
+			}
+		}
+		return $sRet;
+	}
+
+	public function GetHeader()
+	{
+		$oSet = new DBObjectSet($this->oSearch);
+		$this->aStatusInfo['status'] = 'retrieving';
+		$this->aStatusInfo['tmp_file'] = $this->MakeTmpFile('data');
+		$this->aStatusInfo['position'] = 0;
+		$this->aStatusInfo['total'] = $oSet->Count();
+
+		foreach($this->aStatusInfo['fields'] as $iCol => $aFieldSpec)
+		{
+			$sExtendedAttCode = $aFieldSpec['sFieldSpec'];
+			$sAttCode = $aFieldSpec['sAttCode'];
+			$sColLabel = $aFieldSpec['sColLabel'];
+				
+			switch($sAttCode)
+			{
+				case 'id':
+					$sType = '0';
+					break;
+
+				default:
+					$oAttDef = MetaModel::GetAttributeDef($aFieldSpec['sClass'], $aFieldSpec['sAttCode']);
+					$sType = 'string';
+					if($oAttDef instanceof AttributeDate)
+					{
+						$sType = 'date';
+					}
+					else if($oAttDef instanceof AttributeDateTime)
+					{
+						$sType = 'datetime';
+					}
+			}
+			$aTableHeaders[] = array('label' => $sColLabel, 'type' => $sType);
+		}
+
+		$sRow = json_encode($aTableHeaders);
+		$hFile = @fopen($this->aStatusInfo['tmp_file'], 'ab');
+		if ($hFile === false)
+		{
+			throw new Exception('ExcelBulkExport: Failed to open temporary data file: "'.$this->aStatusInfo['tmp_file'].'" for writing.');
+		}
+		fwrite($hFile, $sRow."\n");
+		fclose($hFile);
+		return '';
+	}
+
+	public function GetNextChunk(&$aStatus)
+	{
+		$sRetCode = 'run';
+		$iPercentage = 0;
+
+		$hFile = fopen($this->aStatusInfo['tmp_file'], 'ab');
+
+		$oSet = new DBObjectSet($this->oSearch);
+		$oSet->SetLimit($this->iChunkSize, $this->aStatusInfo['position']);
+		$this->OptimizeColumnLoad($oSet);
+
+		$iCount = 0;
+		$iPreviousTimeLimit = ini_get('max_execution_time');
+		$iLoopTimeLimit = MetaModel::GetConfig()->Get('max_execution_time_per_loop');
+		while($aRow = $oSet->FetchAssoc())
+		{
+			set_time_limit($iLoopTimeLimit);
+			$aData = array();
+			foreach($this->aStatusInfo['fields'] as $iCol => $aFieldSpec)
+			{
+				$sAlias = $aFieldSpec['sAlias'];
+				$sAttCode = $aFieldSpec['sAttCode'];
+
+				$oObj = $aRow[$sAlias];
+				$sField = '';
+				if ($oObj)
+				{
+					$sField = $this->GetValue($oObj, $sAttCode);
+				}
+				$aData[] = $sField;
+			}
+			fwrite($hFile, json_encode($aData)."\n");
+			$iCount++;
+		}
+		set_time_limit($iPreviousTimeLimit);
+		$this->aStatusInfo['position'] += $this->iChunkSize;
+		if ($this->aStatusInfo['total'] == 0)
+		{
+			$iPercentage = 100;
+			$sRetCode = 'done';  // Next phase (GetFooter) will be to build the xlsx file
+		}
+		else
+		{
+			$iPercentage = floor(min(100.0, 100.0*$this->aStatusInfo['position']/$this->aStatusInfo['total']));
+		}
+		if ($iCount < $this->iChunkSize)
+		{
+			$sRetCode = 'done';
+		}
+		$aStatus = array('code' => $sRetCode, 'message' =>  Dict::S('Core:BulkExport:RetrievingData'), 'percentage' => $iPercentage);
+		return ''; // The actual XLSX file is built in GetFooter();
+	}
+
+	public function GetFooter()
+	{
+		$hFile = @fopen($this->aStatusInfo['tmp_file'], 'rb');
+		if ($hFile === false)
+		{
+			throw new Exception('ExcelBulkExport: Failed to open temporary data file: "'.$this->aStatusInfo['tmp_file'].'" for reading.');
+		}
+		$sHeaders = fgets($hFile);
+		$aHeaders = json_decode($sHeaders, true);
+
+		$aData = array();
+		while($sLine = fgets($hFile))
+		{
+			$aRow = json_decode($sLine);
+			$aData[] = $aRow;
+		}
+		fclose($hFile);
+			
+		$fStartExcel = microtime(true);
+		$writer = new XLSXWriter();
+		$oDateTimeFormat = new DateTimeFormat($this->aStatusInfo['date_format']);
+		$writer->setDateTimeFormat($oDateTimeFormat->ToExcel());
+		$oDateFormat = new DateTimeFormat($oDateTimeFormat->ToDateFormat());
+		$writer->setDateFormat($oDateFormat->ToExcel());
+		$writer->setAuthor(UserRights::GetUserFriendlyName());
+		$aHeaderTypes = array();
+		$aHeaderNames = array();
+		foreach($aHeaders as $Header)
+		{
+			$aHeaderNames[] = $Header['label'];
+			$aHeaderTypes[] = $Header['type'];
+		}
+		$writer->writeSheet($aData,'Sheet1', $aHeaderTypes, $aHeaderNames);
+		$fExcelTime = microtime(true) - $fStartExcel;
+		//$this->aStatistics['excel_build_duration'] = $fExcelTime;
+
+		$fTime = microtime(true);
+		$data = $writer->writeToString();
+		$fExcelSaveTime = microtime(true) - $fTime;
+		//$this->aStatistics['excel_write_duration'] = $fExcelSaveTime;
+
+		@unlink($this->aStatusInfo['tmp_file']);
+
+		return $data;
+	}
+
+	public function GetMimeType()
+	{
+		return 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
+	}
+
+	public function GetFileExtension()
+	{
+		return 'xlsx';
+	}
+
+	public function GetSupportedFormats()
+	{
+		return array('xlsx' => Dict::S('Core:BulkExport:XLSXFormat'));
+	}
+}

core/expressioncache.class.inc.php

@@ -0,0 +1,110 @@
+<?php
+// Copyright (c) 2010-2017 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 ExpressionCache
+{
+	static private $aCache = array();
+
+	static public function GetCachedExpression($sClass, $sAttCode)
+	{
+		// read current cache
+		@include_once (static::GetCacheFileName());
+
+		$oExpr = null;
+		$sKey = static::GetKey($sClass, $sAttCode);
+		if (array_key_exists($sKey, static::$aCache))
+		{
+			$oExpr =  static::$aCache[$sKey];
+		}
+		else
+		{
+			if (class_exists('ExpressionCacheData'))
+			{
+				if (array_key_exists($sKey, ExpressionCacheData::$aCache))
+				{
+					$sVal = ExpressionCacheData::$aCache[$sKey];
+					$oExpr = unserialize($sVal);
+					static::$aCache[$sKey] = $oExpr;
+				}
+			}
+		}
+		return $oExpr;
+	}
+
+
+	static public function Warmup()
+	{
+		$sFilePath = static::GetCacheFileName();
+
+		if (!is_file($sFilePath))
+		{
+			$content = <<<EOF
+<?php
+// Copyright (c) 2010-2017 Combodo SARL
+// Generated Expression Cache file
+
+class ExpressionCacheData
+{
+	static \$aCache =  array(
+EOF;
+
+			foreach(MetaModel::GetClasses() as $sClass)
+			{
+				$content .= static::GetSerializedExpression($sClass, 'friendlyname');
+				if (MetaModel::IsObsoletable($sClass))
+				{
+					$content .= static::GetSerializedExpression($sClass, 'obsolescence_flag');
+				}
+			}
+
+			$content .= <<<EOF
+	);
+}
+EOF;
+
+			file_put_contents($sFilePath, $content);
+		}
+	}
+
+	static private function GetSerializedExpression($sClass, $sAttCode)
+	{
+		$sKey = static::GetKey($sClass, $sAttCode);
+		$oExpr = DBObjectSearch::GetPolymorphicExpression($sClass, $sAttCode);
+		return "'".$sKey."' => '".serialize($oExpr)."',\n";
+	}
+
+	/**
+	 * @param $sClass
+	 * @param $sAttCode
+	 * @return string
+	 */
+	static private function GetKey($sClass, $sAttCode)
+	{
+		return $sClass.'::'.$sAttCode;
+	}
+
+	public static function GetCacheFileName()
+	{
+		return utils::GetCachePath().'expressioncache.php';
+	}
+
+}
+
+
+