define('CASELOG_VISIBLE_ITEMS', 2); define('CASELOG_SEPARATOR', "\n".'========== %1$s : %2$s (%3$d) ============'."\n\n"); /** * Class to store a "case log" in a structured way, keeping track of its successive entries * * @copyright Copyright (C) 2010-2012 Combodo SARL * @license http://opensource.org/licenses/AGPL-3.0 */ class ormCaseLog { protected $m_sLog; protected $m_aIndex; protected $m_bModified; /** * Initializes the log with the first (initial) entry * @param $sLog string The text of the whole case log * @param $aIndex hash The case log index */ public function __construct($sLog = '', $aIndex = array()) { $this->m_sLog = $sLog; $this->m_aIndex = $aIndex; $this->m_bModified = false; } public function GetText() { return $this->m_sLog; } public function GetIndex() { return $this->m_aIndex; } public function __toString() { return $this->m_sLog; } public function ClearModifiedFlag() { $this->m_bModified = false; } public function GetAsHTML(WebPage $oP = null, $bEditMode = false, $aTransfoHandler = null) { $sHtml = '

'; // Use table-layout:fixed to force the with to be independent from the actual content $iPos = 0; $aIndex = $this->m_aIndex; if (($bEditMode) && (count($aIndex) > 0) && $this->m_bModified) { // Don't display the first element, that is still considered as editable $iPos = $aIndex[0]['separator_length'] + $aIndex[0]['text_length']; array_shift($aIndex); } for($index=count($aIndex)-1 ; $index >= 0 ; $index--) { if ($index < count($aIndex) - CASELOG_VISIBLE_ITEMS) { $sOpen = ''; $sDisplay = 'style="display:none;"'; } else { $sOpen = ' open'; $sDisplay = ''; } $iPos += $aIndex[$index]['separator_length']; $sTextEntry = substr($this->m_sLog, $iPos, $aIndex[$index]['text_length']); $sTextEntry = str_replace(array("\r\n", "\n", "\r"), "
", htmlentities($sTextEntry, ENT_QUOTES, 'UTF-8')); if (!is_null($aTransfoHandler)) { $sTextEntry = call_user_func($aTransfoHandler, $sTextEntry); } $iPos += $aIndex[$index]['text_length']; $sEntry = '

'; // Workaround: PHP < 5.3 cannot unserialize correctly DateTime objects, // therefore we have changed the format. To preserve the compatibility with existing // installations of iTop, both format are allowed: // the 'date' item is either a DateTime object, or a unix timestamp if (is_int($aIndex[$index]['date'])) { // Unix timestamp $sDate = date(Dict::S('UI:CaseLog:DateFormat'),$aIndex[$index]['date']); } elseif (is_object($aIndex[$index]['date'])) { if (version_compare(phpversion(), '5.3.0', '>=')) { // DateTime $sDate = $aIndex[$index]['date']->format(Dict::S('UI:CaseLog:DateFormat')); } else { // No Warning... but the date is unknown $sDate = ''; } } $sEntry .= sprintf(Dict::S('UI:CaseLog:Header_Date_UserName'), $sDate, $aIndex[$index]['user_name']); $sEntry .= '

'; $sEntry .= '

'; $sEntry .= $sTextEntry; $sEntry .= '

'; $sHtml = $sHtml.$sEntry; } // Process the case of an eventual remainder (quick migration of AttributeText fields) if ($iPos < (strlen($this->m_sLog) - 1)) { $sTextEntry = substr($this->m_sLog, $iPos); $sTextEntry = str_replace(array("\r\n", "\n", "\r"), "
", htmlentities($sTextEntry, ENT_QUOTES, 'UTF-8')); if (!is_null($aTransfoHandler)) { $sTextEntry = call_user_func($aTransfoHandler, $sTextEntry); } if (count($this->m_aIndex) == 0) { $sHtml .= '

'; $sHtml .= $sTextEntry; $sHtml .= '

'; } else { if (count($this->m_aIndex) - CASELOG_VISIBLE_ITEMS > 0) { $sOpen = ''; $sDisplay = 'style="display:none;"'; } else { $sOpen = ' open'; $sDisplay = ''; } $sHtml .= '

'; $sHtml .= Dict::S('UI:CaseLog:InitialValue'); $sHtml .= '

'; $sHtml .= '

'; $sHtml .= $sTextEntry; $sHtml .= '

'; } } $sHtml .= '

'; return $sHtml; } /** * Add a new entry to the log or merge the given text into the currently modified entry * and updates the internal index * @param $sText string The text of the new entry */ public function AddLogEntry($sText, $sOnBehalfOf = '') { $bMergeEntries = false; $sDate = date(Dict::S('UI:CaseLog:DateFormat')); if ($sOnBehalfOf == '') { $sOnBehalfOf = UserRights::GetUserFriendlyName(); $iUserId = UserRights::GetUserId(); } else { $iUserId = null; } if ($this->m_bModified) { $aLatestEntry = end($this->m_aIndex); if ($aLatestEntry['user_name'] != $sOnBehalfOf) { $bMergeEntries = false; } else { $bMergeEntries = true; } } if ($bMergeEntries) { $aLatestEntry = end($this->m_aIndex); $this->m_sLog = substr($this->m_sLog, $aLatestEntry['separator_length']); $sSeparator = sprintf(CASELOG_SEPARATOR, $sDate, $sOnBehalfOf, $iUserId); $iSepLength = strlen($sSeparator); $iTextlength = strlen($sText."\n"); $this->m_sLog = $sSeparator.$sText.$this->m_sLog; // Latest entry printed first $this->m_aIndex[] = array( 'user_name' => $sOnBehalfOf, 'user_id' => $iUserId, 'date' => time(), 'text_length' => $aLatestEntry['text_length'] + $iTextlength, 'separator_length' => $iSepLength, ); } else { $sSeparator = sprintf(CASELOG_SEPARATOR, $sDate, $sOnBehalfOf, $iUserId); $iSepLength = strlen($sSeparator); $iTextlength = strlen($sText); $this->m_sLog = $sSeparator.$sText.$this->m_sLog; // Latest entry printed first $this->m_aIndex[] = array( 'user_name' => $sOnBehalfOf, 'user_id' => $iUserId, 'date' => time(), 'text_length' => $iTextlength, 'separator_length' => $iSepLength, ); } $this->m_bModified = true; } public function GetModifiedEntry() { $sModifiedEntry = ''; if ($this->m_bModified) { $sModifiedEntry = $this->GetLatestEntry(); } return $sModifiedEntry; } /** * Get the latest entry from the log * @return string */ public function GetLatestEntry() { $aLastEntry = end($this->m_aIndex); $sRes = substr($this->m_sLog, $aLastEntry['separator_length'], $aLastEntry['text_length']); return $sRes; } /** * Get the index of the latest entry from the log * @return integer */ public function GetLatestEntryIndex() { $aKeys = array_keys($this->m_aIndex); $iLast = end($aKeys); // Strict standards: the parameter passed to 'end' must be a variable since it is passed by reference return $iLast; } } ?>