N°3123 - Refactor Directories

sources/application/UI/Base/Layout/ActivityPanel/ActivityEntry/ActivityEntry.php

@@ -0,0 +1,293 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry;
+
+
+use AttributeDateTime;
+use Combodo\iTop\Application\UI\Base\UIBlock;
+use DateTime;
+use UserRights;
+
+/**
+ * Class ActivityEntry
+ *
+ * @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry
+ * @internal
+ * @since 3.0.0
+ */
+class ActivityEntry extends UIBlock
+{
+	// Overloaded constants
+	public const BLOCK_CODE = 'ibo-activity-entry';
+	public const HTML_TEMPLATE_REL_PATH = 'base/layouts/activity-panel/activity-entry/layout';
+
+	// Specific constants
+	/** @var string DEFAULT_ORIGIN */
+	public const DEFAULT_ORIGIN = 'unknown';
+	/** @var string DEFAULT_TYPE */
+	public const DEFAULT_TYPE = 'generic';
+	/** @var string DEFAULT_DECORATION_CLASSES */
+	public const DEFAULT_DECORATION_CLASSES = 'fas fa-fw fa-mortar-pestle';
+
+	/** @var string $sType Type of entry, used for filtering (eg. case log, edits, transition, ...) */
+	protected $sType;
+	/** @var string $sDecorationClasses CSS classes to use to decorate the entry */
+	protected $sDecorationClasses;
+	/** @var string|null $sContent Raw content of the entry itself (should not have been processed / escaped) */
+	protected $sContent;
+	/** @var \DateTime $oDateTime Date / time the entry occurred */
+	protected $oDateTime;
+	/** @var string $sAuthorLogin Login of the author (user, cron, extension, ...) who made the activity of the entry */
+	protected $sAuthorLogin;
+	/** @var string $sAuthorFriendlyname */
+	protected $sAuthorFriendlyname;
+	/** @var string $sAuthorInitials */
+	protected $sAuthorInitials;
+	/** @var string $sAuthorPictureAbsUrl */
+	protected $sAuthorPictureAbsUrl;
+	/** @var bool $bIsFromCurrentUser Flag to know if the user who made the activity was the current user */
+	protected $bIsFromCurrentUser;
+	/** @var string $sOrigin Origin of the entry (case log, cron, lifecycle, user edit, ...) */
+	protected $sOrigin;
+
+	/**
+	 * ActivityEntry constructor.
+	 *
+	 * @param \DateTime $oDateTime
+	 * @param string $sAuthorLogin
+	 * @param string|null $sContent
+	 * @param string|null $sId
+	 *
+	 * @throws \OQLException
+	 */
+	public function __construct(DateTime $oDateTime, string $sAuthorLogin, ?string $sContent = null, ?string $sId = null)
+	{
+		parent::__construct($sId);
+
+		$this->SetType(static::DEFAULT_TYPE);
+		$this->SetDecorationClasses(static::DEFAULT_DECORATION_CLASSES);
+		$this->SetContent($sContent);
+		$this->SetDateTime($oDateTime);
+		$this->SetAuthor($sAuthorLogin);
+		$this->SetOrigin(static::DEFAULT_ORIGIN);
+	}
+
+	/**
+	 * Set the type of the entry (eg. case log, edits, transition, ...)
+	 *
+	 * @param string $sType
+	 *
+	 * @return $this
+	 */
+	public function SetType(string $sType)
+	{
+		$this->sType = $sType;
+
+		return $this;
+	}
+
+	/**
+	 * Return the type of the entry (eg. case log, edits, transition, ...)
+	 *
+	 * @return string
+	 */
+	public function GetType()
+	{
+		return $this->sType;
+	}
+
+	/**
+	 * Set the CSS decoration classes
+	 *
+	 * @param string $sDecorationClasses Must be a space-separated list of CSS classes
+	 *
+	 * @return $this
+	 */
+	public function SetDecorationClasses(string $sDecorationClasses)
+	{
+		$this->sDecorationClasses = $sDecorationClasses;
+
+		return $this;
+	}
+
+	/**
+	 * Return a string of the space separated CSS decoration classes
+	 *
+	 * @return string
+	 */
+	public function GetDecorationClasses()
+	{
+		return $this->sDecorationClasses;
+	}
+
+	/**
+	 * Set the content without any filtering / escaping
+	 *
+	 * @param string|null $sContent
+	 *
+	 * @return $this
+	 */
+	public function SetContent(?string $sContent)
+	{
+		$this->sContent = $sContent;
+
+		return $this;
+	}
+
+	/**
+	 * Return the raw content without any filtering / escaping
+	 *
+	 * @return string
+	 */
+	public function GetContent()
+	{
+		return $this->sContent;
+	}
+
+	/**
+	 * @param \DateTime $oDateTime
+	 *
+	 * @return $this
+	 */
+	public function SetDateTime(DateTime $oDateTime)
+	{
+		$this->oDateTime = $oDateTime;
+		return $this;
+	}
+
+	/**
+	 * Return the date time without formatting, as per the mysql format
+	 * @return string
+	 */
+	public function GetRawDateTime()
+	{
+		return $this->oDateTime->format(AttributeDateTime::GetInternalFormat());
+	}
+
+	/**
+	 * Return the date time formatted as per the iTop config.
+	 *
+	 * @return string
+	 * @throws \Exception
+	 */
+	public function GetFormattedDateTime()
+	{
+		$oDateTimeFormat = AttributeDateTime::GetFormat();
+		return $oDateTimeFormat->Format($this->oDateTime);
+	}
+
+	/**
+	 * Set the author and its information based on the $sAuthorLogin
+	 *
+	 * @param string $sAuthorLogin
+	 *
+	 * @return $this
+	 * @throws \OQLException
+	 * @throws \Exception
+	 */
+	public function SetAuthor(string $sAuthorLogin)
+	{
+		$this->sAuthorLogin = $sAuthorLogin;
+
+		// Set friendlyname to whatever we have in case $sAuthorLogin is not a valid login (deleted user, cron, ...)
+		$iAuthorId = UserRights::GetUserId($this->sAuthorLogin);
+		if(empty($iAuthorId) === true)
+		{
+			$this->sAuthorFriendlyname = $this->sAuthorLogin;
+		}
+		else
+		{
+			// TODO 3.0.0: Check that this does not return '' when author is the CRON or an extension.
+			$this->sAuthorFriendlyname = UserRights::GetUserFriendlyName($this->sAuthorLogin);
+		}
+		$this->sAuthorInitials = UserRights::GetUserInitials($this->sAuthorLogin);
+		$this->sAuthorPictureAbsUrl = UserRights::GetContactPictureAbsUrl($this->sAuthorLogin, false);
+		$this->bIsFromCurrentUser = UserRights::GetUserId($this->sAuthorLogin) === UserRights::GetUserId();
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function GetAuthorLogin()
+	{
+		return $this->sAuthorLogin;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function GetAuthorFriendlyname()
+	{
+		return $this->sAuthorFriendlyname;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function GetAuthorInitials()
+	{
+		return $this->sAuthorInitials;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function GetAuthorPictureAbsUrl()
+	{
+		return $this->sAuthorPictureAbsUrl;
+	}
+
+	/**
+	 * Return true if the current user is the author of the activity entry
+	 *
+	 * @return bool
+	 */
+	public function IsFromCurrentUser()
+	{
+		return $this->bIsFromCurrentUser;
+	}
+
+	/**
+	 * Set the origin of the activity entry
+	 *
+	 * @param string $sOrigin
+	 *
+	 * @return $this
+	 */
+	protected function SetOrigin(string $sOrigin)
+	{
+		$this->sOrigin = $sOrigin;
+
+		return $this;
+	}
+
+	/**
+	 * Return the origin of the activity entry
+	 *
+	 * @return string
+	 */
+	public function GetOrigin()
+	{
+		return $this->sOrigin;
+	}
+}

sources/application/UI/Base/Layout/ActivityPanel/ActivityEntry/ActivityEntryFactory.php

@@ -0,0 +1,129 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry;
+
+
+use AttributeDateTime;
+use CMDBChangeOp;
+use DateTime;
+use Exception;
+use MetaModel;
+use ReflectionClass;
+
+/**
+ * Class ActivityEntryFactory
+ *
+ * @internal
+ * @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry
+ * @since 3.0.0
+ */
+class ActivityEntryFactory
+{
+	/**
+	 * Make an ActivityEntry entry (for ActivityPanel) based on the $oChangeOp.
+	 *
+	 * @param \CMDBChangeOp $oChangeOp
+	 *
+	 * @return \Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\ActivityEntry
+	 * @throws \Exception
+	 */
+	public static function MakeFromCmdbChangeOp(CMDBChangeOp $oChangeOp)
+	{
+		$sFactoryFqcn = static::GetCmdbChangeOpFactoryClass($oChangeOp);
+
+		// If no factory found, throw an exception as the developer most likely forgot to create it
+		if(empty($sFactoryFqcn))
+		{
+			throw new Exception('No factory found for '.get_class($oChangeOp).', did you forgot to create one?');
+		}
+
+		/** @var \Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\ActivityEntry $oEntry */
+		/** @noinspection PhpUndefinedMethodInspection Call static method from the $sFactoryFqcn class */
+		$oEntry = $sFactoryFqcn::MakeFromCmdbChangeOp($oChangeOp);
+
+		return $oEntry;
+	}
+
+	/**
+	 * Make a CaseLogEntry entry (for ActivityPanel) from an ormCaseLog array entry.
+	 *
+	 * @param string $sAttCode Code of the case log attribute
+	 * @param array $aOrmEntry
+	 *
+	 * @return \Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CaseLogEntry
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 * @throws \OQLException
+	 */
+	public static function MakeFromCaseLogEntryArray(string $sAttCode, array $aOrmEntry)
+	{
+		$oUser = MetaModel::GetObject('User', $aOrmEntry['user_id'], false, true);
+		$sUserLogin = ($oUser === null) ? '' : $oUser->Get('login');
+
+		$oEntry = new CaseLogEntry(
+			DateTime::createFromFormat(AttributeDateTime::GetInternalFormat(), $aOrmEntry['date']),
+			$sUserLogin,
+			$sAttCode,
+			$aOrmEntry['message_html']
+		);
+
+		return $oEntry;
+	}
+
+	/**
+	 * Return the FQCN of the best fitted factory for the $oChangeOp. If none found, null will be returned.
+	 *
+	 * @param \CMDBChangeOp $oChangeOp
+	 *
+	 * @return string|null
+	 * @throws \ReflectionException
+	 */
+	protected static function GetCmdbChangeOpFactoryClass(CMDBChangeOp $oChangeOp)
+	{
+		// Classes to search a factory for
+		$aClassesTree = [get_class($oChangeOp)];
+
+		// Add parent classes to tree if not a root class
+		$aParentClasses = class_parents($oChangeOp);
+		if(is_array($aParentClasses))
+		{
+			$aClassesTree = array_merge($aClassesTree, array_values($aParentClasses));
+		}
+
+		$sFactoryFqcn = null;
+		foreach($aClassesTree as $sClass)
+		{
+			// Warning: This will replace all occurrences of 'CMDBChangeOp' which can be an issue on classes using this
+			// We used the case sensitive search to limit this issue.
+			$sSimplifiedClass = (new ReflectionClass($sClass))->getShortName();
+			$sFactoryFqcnToTry = __NAMESPACE__ . '\\CMDBChangeOp\\' . $sSimplifiedClass . 'Factory';
+
+			// Stop at the first factory found
+			if(class_exists($sFactoryFqcnToTry))
+			{
+				$sFactoryFqcn = $sFactoryFqcnToTry;
+				break;
+			}
+		}
+
+		return $sFactoryFqcn;
+	}
+}

sources/application/UI/Base/Layout/ActivityPanel/ActivityEntry/CMDBChangeOp/CMDBChangeOpAttachmentAddedFactory.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp;
+
+
+/**
+ * Class CMDBChangeOpAttachmentAddedFactory
+ *
+ * @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp
+ */
+class CMDBChangeOpAttachmentAddedFactory extends CMDBChangeOpFactory
+{
+	public const DEFAULT_DECORATION_CLASSES = 'fas fa-fw fa-paperclip';
+}

sources/application/UI/Base/Layout/ActivityPanel/ActivityEntry/CMDBChangeOp/CMDBChangeOpAttachmentRemovedFactory.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp;
+
+
+/**
+ * Class CMDBChangeOpAttachmentRemovedFactory
+ *
+ * @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp
+ */
+class CMDBChangeOpAttachmentRemovedFactory extends CMDBChangeOpFactory
+{
+	public const DEFAULT_DECORATION_CLASSES = 'fas fa-fw fa-unlink';
+}

sources/application/UI/Base/Layout/ActivityPanel/ActivityEntry/CMDBChangeOp/CMDBChangeOpCreateFactory.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp;
+
+
+/**
+ * Class CMDBChangeOpCreateFactory
+ *
+ * @author  Guillaume Lajarige <guillaume.lajarige@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp
+ */
+class CMDBChangeOpCreateFactory extends CMDBChangeOpFactory {
+	public const DEFAULT_DECORATION_CLASSES = 'fas fa-fw fa-seedling';
+}

sources/application/UI/Base/Layout/ActivityPanel/ActivityEntry/CMDBChangeOp/CMDBChangeOpDeleteFactory.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp;
+
+
+/**
+ * Class CMDBChangeOpDeleteFactory
+ *
+ * @author  Guillaume Lajarige <guillaume.lajarige@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp
+ */
+class CMDBChangeOpDeleteFactory extends CMDBChangeOpFactory {
+	public const DEFAULT_DECORATION_CLASSES = 'fas fa-fw fa-trash';
+}

sources/application/UI/Base/Layout/ActivityPanel/ActivityEntry/CMDBChangeOp/CMDBChangeOpFactory.php

@@ -0,0 +1,94 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp;
+
+
+use AttributeDateTime;
+use Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\ActivityEntry;
+use Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\EditsEntry;
+use DateTime;
+use iCMDBChangeOp;
+use MetaModel;
+
+/**
+ * Class CMDBChangeOpFactory
+ *
+ * Default factory for CMDBChangeOp change ops
+ *
+ * @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp
+ */
+class CMDBChangeOpFactory
+{
+	/** @var string DEFAULT_TYPE Used to overload the type from the ActivityEntry */
+	public const DEFAULT_TYPE = EditsEntry::DEFAULT_TYPE;
+	/** @var string DEFAULT_DECORATION_CLASSES Used to overload the decoration classes from the ActivityEntry */
+	public const DEFAULT_DECORATION_CLASSES = ActivityEntry::DEFAULT_DECORATION_CLASSES;
+
+	/**
+	 * Make an ActivityEntry from the iCMDBChangeOp $oChangeOp
+	 *
+	 * @param \iCMDBChangeOp $oChangeOp
+	 *
+	 * @return \Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\ActivityEntry
+	 * @throws \OQLException
+	 */
+	public static function MakeFromCmdbChangeOp(iCMDBChangeOp $oChangeOp)
+	{
+		$oDateTime = DateTime::createFromFormat(AttributeDateTime::GetInternalFormat(), $oChangeOp->Get('date'));
+		$sContent = $oChangeOp->GetDescription();
+
+		// Retrieve author login
+		$sAuthorLogin = static::GetUserLoginFromChangeOp($oChangeOp);
+
+		$oEntry = new ActivityEntry($oDateTime, $sAuthorLogin, $sContent);
+		$oEntry->SetType(static::DEFAULT_TYPE)
+			->SetDecorationClasses(static::DEFAULT_DECORATION_CLASSES);
+
+		return $oEntry;
+	}
+
+	/**
+	 * Return the login of the $oChangeOp author or its friendlyname if the user cannot be retrieved.
+	 *
+	 * @param \iCMDBChangeOp $oChangeOp
+	 *
+	 * @return string|null
+	 * @throws \ArchivedObjectException
+	 * @throws \CoreException
+	 */
+	public static function GetUserLoginFromChangeOp(iCMDBChangeOp $oChangeOp)
+	{
+		$iAuthorId = $oChangeOp->Get('user_id');
+		// - Set login in the friendlyname as a fallback
+		$sAuthorLogin = $oChangeOp->Get('userinfo');
+		// - Try to find user login from its ID if present (since iTop 3.0.0)
+		if(empty($iAuthorId) === false)
+		{
+			$oAuthor = MetaModel::GetObject('User', $iAuthorId, false, true);
+			if(empty($oAuthor) === false)
+			{
+				$sAuthorLogin = $oAuthor->Get('login');
+			}
+		}
+
+		return $sAuthorLogin;
+	}
+}

sources/application/UI/Base/Layout/ActivityPanel/ActivityEntry/CMDBChangeOp/CMDBChangeOpSetAttributeFactory.php

@@ -0,0 +1,61 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp;
+
+
+use AttributeDateTime;
+use Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\EditsEntry;
+use DateTime;
+use iCMDBChangeOp;
+
+/**
+ * Class CMDBChangeOpSetAttributeFactory
+ *
+ * Default factory for CMDBChangeOpSetAttribute change ops
+ *
+ * @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp
+ */
+class CMDBChangeOpSetAttributeFactory extends CMDBChangeOpFactory
+{
+	/**
+	 * Make an EditsEntry from the iCMDBChangeOpSetAttribute $oChangeOp
+	 *
+	 * @param \iCMDBChangeOp $oChangeOp
+	 *
+	 * @return \Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\EditsEntry
+	 * @throws \OQLException
+	 * @throws \Exception
+	 */
+	public static function MakeFromCmdbChangeOp(iCMDBChangeOp $oChangeOp)
+	{
+		$sHostObjectClass = $oChangeOp->Get('objclass');
+		$sAttCode = $oChangeOp->Get('attcode');
+		$oDateTime = DateTime::createFromFormat(AttributeDateTime::GetInternalFormat(), $oChangeOp->Get('date'));
+
+		// Retrieve author login
+		$sAuthorLogin = static::GetUserLoginFromChangeOp($oChangeOp);
+
+		$oEntry = new EditsEntry($oDateTime, $sAuthorLogin, $sHostObjectClass);
+		$oEntry->AddAttribute($sAttCode, $oChangeOp->GetDescription());
+
+		return $oEntry;
+	}
+}

sources/application/UI/Base/Layout/ActivityPanel/ActivityEntry/CMDBChangeOp/CMDBChangeOpSetAttributeScalarFactory.php

@@ -0,0 +1,67 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp;
+
+
+use AttributeDateTime;
+use Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\TransitionEntry;
+use DateTime;
+use iCMDBChangeOp;
+use MetaModel;
+
+/**
+ * Class CMDBChangeOpSetAttributeScalarFactory
+ *
+ * @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp\Factory
+ * @since 3.0.0
+ */
+class CMDBChangeOpSetAttributeScalarFactory extends CMDBChangeOpSetAttributeFactory
+{
+	/**
+	 * @inheritDoc
+	 * @throws \CoreException
+	 */
+	public static function MakeFromCmdbChangeOp(iCMDBChangeOp $oChangeOp)
+	{
+		$sHostObjectClass = $oChangeOp->Get('objclass');
+		$sAttCode = $oChangeOp->Get('attcode');
+
+		// Specific ActivityEntry for transition, otherwise just a regular EditsEntry
+		if(MetaModel::HasLifecycle($sHostObjectClass) && ($sAttCode === MetaModel::GetStateAttributeCode($sHostObjectClass)))
+		{
+			$oDateTime = DateTime::createFromFormat(AttributeDateTime::GetInternalFormat(), $oChangeOp->Get('date'));
+
+			// Retrieve author login
+			$sAuthorLogin = static::GetUserLoginFromChangeOp($oChangeOp);
+
+			$sOriginStateLabel = MetaModel::GetStateLabel($sHostObjectClass, $oChangeOp->Get('oldvalue'));
+			$sTargetStateLabel = MetaModel::GetStateLabel($sHostObjectClass, $oChangeOp->Get('newvalue'));
+
+			$oEntry = new TransitionEntry($oDateTime, $sAuthorLogin, $sHostObjectClass, $sOriginStateLabel, $sTargetStateLabel);
+		}
+		else
+		{
+			$oEntry = parent::MakeFromCmdbChangeOp($oChangeOp);
+		}
+
+		return $oEntry;
+	}
+}

sources/application/UI/Base/Layout/ActivityPanel/ActivityEntry/CaseLogEntry.php

@@ -0,0 +1,103 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry;
+
+
+use DateTime;
+
+/**
+ * Class CaseLogEntry
+ *
+ * @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry
+ * @internal
+ * @since 3.0.0
+ */
+class CaseLogEntry extends ActivityEntry
+{
+	// Overloaded constants
+	public const BLOCK_CODE = 'ibo-caselog-entry';
+	public const HTML_TEMPLATE_REL_PATH = 'base/layouts/activity-panel/activity-entry/caselog-entry';
+
+	public const DEFAULT_TYPE = 'caselog';
+	public const DEFAULT_DECORATION_CLASSES = 'fas fa-fw fa-quote-left';
+
+	// Specific constants
+	public const DEFAULT_CASELOG_RANK = 0;
+
+	/** @var string $sAttCode Code of the corresponding case log attribute */
+	protected $sAttCode;
+	/** @var int $iCaseLogRank Rank of its case log in the host panel, can be used for highlight purposes for example */
+	protected $iCaseLogRank;
+
+	/**
+	 * CaseLogEntry constructor.
+	 *
+	 * @param \DateTime $oDateTime
+	 * @param \User $sAuthorLogin
+	 * @param string $sAttCode
+	 * @param string $sContent
+	 * @param string|null $sId
+	 *
+	 * @throws \OQLException
+	 */
+	public function __construct(DateTime $oDateTime, string $sAuthorLogin, string $sAttCode, string $sContent, ?string $sId = null)
+	{
+		parent::__construct($oDateTime, $sAuthorLogin, $sContent, $sId);
+
+		$this->sAttCode = $sAttCode;
+		$this->SetCaseLogRank(static::DEFAULT_CASELOG_RANK);
+		$this->SetOrigin('caselog:'.$this->sAttCode);
+	}
+
+	/**
+	 * Return the code of the corresponding case log attribute
+	 *
+	 * @return string
+	 */
+	public function GetAttCode()
+	{
+		return $this->sAttCode;
+	}
+
+	/**
+	 * Set the rank of the case log in the host panel
+	 *
+	 * @param int $iCaseLogRank
+	 *
+	 * @return $this
+	 */
+	public function SetCaseLogRank(int $iCaseLogRank)
+	{
+		$this->iCaseLogRank = $iCaseLogRank;
+
+		return $this;
+	}
+
+	/**
+	 * Return the rank of the case log in the host panel
+	 *
+	 * @return int
+	 */
+	public function GetCaseLogRank()
+	{
+		return $this->iCaseLogRank;
+	}
+}

sources/application/UI/Base/Layout/ActivityPanel/ActivityEntry/EditsEntry.php

@@ -0,0 +1,206 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry;
+
+
+use DateTime;
+use Dict;
+use Exception;
+use MetaModel;
+
+/**
+ * Class EditsEntry
+ *
+ * @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry
+ * @internal
+ * @since 3.0.0
+ */
+class EditsEntry extends ActivityEntry
+{
+	// Overloaded constants
+	public const BLOCK_CODE = 'ibo-edits-entry';
+	public const HTML_TEMPLATE_REL_PATH = 'base/layouts/activity-panel/activity-entry/edits-entry';
+
+	public const DEFAULT_TYPE = 'edits';
+	public const DEFAULT_DECORATION_CLASSES = 'fas fa-fw fa-pen';
+
+	/** @var string $sObjectClass */
+	protected $sObjectClass;
+	/** @var array $aAttributes Array of edited attributes with their code, label and description */
+	protected $aAttributes;
+
+	/**
+	 * EditsEntry constructor.
+	 *
+	 * @param \DateTime $oDateTime
+	 * @param \User $sAuthorLogin
+	 * @param string $sObjectClass Class of the object concerned by the edits
+	 * @param string|null $sId
+	 *
+	 * @throws \OQLException
+	 */
+	public function __construct(DateTime $oDateTime, string $sAuthorLogin, string $sObjectClass, ?string $sId = null)
+	{
+		parent::__construct($oDateTime, $sAuthorLogin, null, $sId);
+
+		$this->sObjectClass = $sObjectClass;
+		$this->SetAttributes([]);
+	}
+
+	/**
+	 * Return the class of the object concerned by the edits
+	 *
+	 * @return string
+	 */
+	public function GetObjectClass()
+	{
+		return $this->sObjectClass;
+	}
+
+	/**
+	 * Set all attributes at once, replacing all existing.
+	 *
+	 * @param array $aAttributes
+	 *
+	 * @return $this
+	 */
+	public function SetAttributes(array $aAttributes)
+	{
+		$this->aAttributes = $aAttributes;
+
+		return $this;
+	}
+
+	/**
+	 * Return an array of edited attributes with their code, label and description
+	 *
+	 * @return array
+	 */
+	public function GetAttributes()
+	{
+		return $this->aAttributes;
+	}
+
+	/**
+	 * Add the attribute identified by $sAttCode to the edited attribute.
+	 * Note that if an attribute with the same $sAttCode already exists, it will be replaced.
+	 *
+	 * @param string $sAttCode
+	 * @param string $sEditDescriptionAsHtml The description of the edit already in HTML, it MUSt have been sanitized first (Already in
+	 *     HTML because most of the time it comes from CMDBChangeOp::GetDescription())
+	 *
+	 * @throws \Exception
+	 */
+	public function AddAttribute(string $sAttCode, string $sEditDescriptionAsHtml)
+	{
+		$this->aAttributes[$sAttCode] = [
+			'code' => $sAttCode,
+			'label' => MetaModel::GetLabel($this->sObjectClass, $sAttCode),
+			'description' => $sEditDescriptionAsHtml,
+		];
+	}
+
+	/**
+	 * Remove the attribute of code $sAttCode from the edited attributes.
+	 * Note that if there is no attribute with this code, it will proceed silently.
+	 *
+	 * @param string $sAttCode
+	 *
+	 * @return array
+	 */
+	public function RemoveAttribute(string $sAttCode)
+	{
+		if (array_key_exists($sAttCode, $this->aAttributes))
+		{
+			unset($this->aAttributes[$sAttCode]);
+		}
+
+		return $this->aAttributes;
+	}
+
+	/**
+	 * Merge $oEntry into the current one ($this).
+	 * Note that edits on any existing attribute codes will be replaced.
+	 *
+	 * @param \Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry\EditsEntry $oEntry
+	 *
+	 * @return $this
+	 * @throws \Exception
+	 */
+	public function Merge(EditsEntry $oEntry)
+	{
+		if($oEntry->GetObjectClass() !== $this->GetObjectClass())
+		{
+			throw new Exception("Cannot merge an entry from {$oEntry->GetObjectClass()} into {$this->GetObjectClass()}, they must be for the same class");
+		}
+
+		// Merging attributes
+		foreach($oEntry->GetAttributes() as $sAttCode => $aAttData)
+		{
+			$this->aAttributes[$sAttCode] = $aAttData;
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Return the short description of the edits entry in HTML
+	 *
+	 * @return string
+	 */
+	public function GetShortDescriptionAsHtml()
+	{
+		// We need the array to be indexed by numbers instead of being associative
+		$aAttributesData = array_values($this->GetAttributes());
+		$iAttributesCount = count($aAttributesData);
+		switch($iAttributesCount)
+		{
+			case 0:
+				$sDescriptionAsHtml = '';
+				break;
+
+			case 1:
+				$sDescriptionAsHtml = $aAttributesData[0]['description'];
+				break;
+
+			default:
+				$sFirstAttLabelAsHtml = '<span class="ibo-edits-entry--attribute-label" data-attribute-code="'.$aAttributesData[0]['code'].'">'.$aAttributesData[0]['label'].'</span>';
+				$sSecondAttLabelAsHtml = '<span class="ibo-edits-entry--attribute-label" data-attribute-code="'.$aAttributesData[1]['code'].'">'.$aAttributesData[1]['label'].'</span>';
+
+				switch($iAttributesCount)
+				{
+					case 2:
+						$sDescriptionAsHtml = Dict::Format('Change:TwoAttributesChanged', $sFirstAttLabelAsHtml, $sSecondAttLabelAsHtml);
+						break;
+
+					case 3:
+						$sDescriptionAsHtml = Dict::Format('Change:ThreeAttributesChanged', $sFirstAttLabelAsHtml, $sSecondAttLabelAsHtml);
+						break;
+
+					default:
+						$sDescriptionAsHtml = Dict::Format('Change:FourOrMoreAttributesChanged', $sFirstAttLabelAsHtml, $sSecondAttLabelAsHtml, count($aAttributesData) - 2);
+						break;
+				}
+		}
+
+		return $sDescriptionAsHtml;
+	}
+}

sources/application/UI/Base/Layout/ActivityPanel/ActivityEntry/TransitionEntry.php

@@ -0,0 +1,148 @@
+<?php
+/**
+ * Copyright (C) 2013-2020 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
+ */
+
+namespace Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry;
+
+
+use DateTime;
+use MetaModel;
+
+/**
+ * Class TransitionEntry
+ *
+ * @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
+ * @package Combodo\iTop\Application\UI\Base\Layout\ActivityPanel\ActivityEntry
+ * @internal
+ * @since 3.0.0
+ */
+class TransitionEntry extends ActivityEntry
+{
+	// Overloaded constants
+	public const BLOCK_CODE = 'ibo-transition-entry';
+	public const HTML_TEMPLATE_REL_PATH = 'base/layouts/activity-panel/activity-entry/transition-entry';
+
+	public const DEFAULT_TYPE = 'transition';
+	public const DEFAULT_DECORATION_CLASSES = 'fas fa-fw fa-map-signs';
+
+	/** @var string $sOriginStateCode Code of the state before the transition */
+	protected $sOriginStateCode;
+	/** @var string $sOriginStateLabel Label of the $sOriginStateCode state */
+	protected $sOriginStateLabel;
+	/** @var string $sTargetStateCode Code of the state after the transition */
+	protected $sTargetStateCode;
+	/** @var string $sTargetStateLabel Label of the $sTargetStateCode state */
+	protected $sTargetStateLabel;
+
+	/**
+	 * TransitionEntry constructor.
+	 *
+	 * @param \DateTime $oDateTime
+	 * @param \User $sAuthorLogin
+	 * @param string $sObjectClass Class of the object which made the transition
+	 * @param string $sOriginStateCode
+	 * @param string $sTargetStateCode
+	 * @param string|null $sId
+	 *
+	 * @throws \CoreException
+	 * @throws \OQLException
+	 */
+	public function __construct(
+		DateTime $oDateTime, string $sAuthorLogin, string $sObjectClass, string $sOriginStateCode, string $sTargetStateCode,
+		?string $sId = null
+	) {
+		parent::__construct($oDateTime, $sAuthorLogin, null, $sId);
+
+		$this->SetOriginalState($sObjectClass, $sOriginStateCode);
+		$this->SetTargetState($sObjectClass, $sTargetStateCode);
+	}
+
+	/**
+	 * Set the code / label of the state before the transition
+	 *
+	 * @param string $sObjectClass Class of the object the state is from
+	 * @param string $sStateCode
+	 *
+	 * @return $this
+	 * @throws \CoreException
+	 */
+	public function SetOriginalState(string $sObjectClass, string $sStateCode)
+	{
+		$this->sOriginStateCode = $sStateCode;
+		$this->sOriginStateLabel = MetaModel::GetStateLabel($sObjectClass, $sStateCode);
+
+		return $this;
+	}
+
+	/**
+	 * Return the code of the state before the transition
+	 *
+	 * @return string
+	 */
+	public function GetOriginalStateCode()
+	{
+		return $this->sOriginStateCode;
+	}
+
+	/**
+	 * Return the label of the state before the transition
+	 *
+	 * @return string
+	 */
+	public function GetOriginalStateLabel()
+	{
+		return $this->sOriginStateLabel;
+	}
+
+	/**
+	 * Set the code / label of the state after the transition
+	 *
+	 * @param string $sObjectClass
+	 * @param string $sStateCode
+	 *
+	 * @return $this
+	 * @throws \CoreException
+	 */
+	public function SetTargetState(string $sObjectClass, string $sStateCode)
+	{
+		$this->sTargetStateCode = $sStateCode;
+		$this->sTargetStateLabel = MetaModel::GetStateLabel($sObjectClass, $sStateCode);
+
+		return $this;
+	}
+
+	/**
+	 * Return the code of the state after the transition
+	 *
+	 * @return string
+	 */
+	public function GetTargetStateCode()
+	{
+		return $this->sTargetStateCode;
+	}
+
+	/**
+	 * Return the label of the state after the transition
+	 *
+	 * @return string
+	 */
+	public function GetTargetStateLabel()
+	{
+		return $this->sTargetStateLabel;
+	}
+}