(HTML) Formatted Case Logs, Description and Notifications with inline images uploaded as Attachments. Beta Version !!

SVN:trunk[3916]

application/Html2Text.php

@@ -0,0 +1,321 @@
+<?php
+namespace Html2Text;
+
+/**
+ * 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("\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/cmdbabstract.class.inc.php

@@ -1825,7 +1825,7 @@ EOF
 					$sPreviousLog = is_object($value) ? $value->GetAsHTML($oPage, true /* bEditMode */, array('AttributeText', 'RenderWikiHtml')) : '';
 					$iEntriesCount = is_object($value) ? count($value->GetIndex()) : 0;
 					$sHidden = "<input type=\"hidden\" id=\"{$iId}_count\" value=\"$iEntriesCount\"/>"; // To know how many entries the case log already contains
-					$sHTMLValue = "<div class=\"caselog\" $sStyle><table style=\"width:100%;\"><tr><td>$sHeader<textarea style=\"border:0;width:100%\" title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" rows=\"8\" cols=\"40\" id=\"$iId\">".htmlentities($sEditValue, ENT_QUOTES, 'UTF-8')."</textarea>$sPreviousLog</td><td>{$sValidationField}</td></tr></table>$sHidden</div>";
+					$sHTMLValue = "<div class=\"caselog\" $sStyle><table style=\"width:100%;\"><tr><td>$sHeader<textarea class=\"htmlEditor\" style=\"border:0;width:100%\" title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" rows=\"8\" cols=\"40\" id=\"$iId\">".htmlentities($sEditValue, ENT_QUOTES, 'UTF-8')."</textarea>$sPreviousLog</td><td>{$sValidationField}</td></tr></table>$sHidden</div>";
 					$oPage->add_ready_script("$('#$iId').bind('keyup change validate', function(evt, sFormId) { return ValidateCaseLogField('$iId', $bMandatory, sFormId) } );"); // Custom validation function
 				break;
 
@@ -3364,9 +3364,23 @@ EOF
 				{
 					$sHTMLValue = '<span>'.$sComment.'</span><br/>';
 				}
-				$sHTMLValue .= "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
+				$sHTMLValue .= "<span style=\"font-family:Tahoma,Verdana,Arial,Helvetica;font-size:12px;\" id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
 				$aFieldsMap[$sAttCode] = $sInputId;
+
+				// 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()));
+				$aConfig['font_style'] = $sLanguage;
+				$aConfig['language'] = $sLanguage;
+				$aConfig['contentsLanguage'] = $sLanguage;
+				$aConfig['extraPlugins'] = 'disabler';
+				$sConfigJS = json_encode($aConfig);
 				
+				$oPage->add_ready_script("$('#$sInputId').ckeditor(function() { /* callback code */ }, $sConfigJS);"); // Transform $iId into a CKEdit
+								
 			}
 			//$aVal = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
 			$oPage->add('<fieldset><legend>'.$oAttDef->GetLabel().'</legend>');

application/displayblock.class.inc.php

@@ -1,5 +1,5 @@
 <?php
-// Copyright (C) 2010-2015 Combodo SARL
+// Copyright (C) 2010-2016 Combodo SARL
 //
 //   This file is part of iTop.
 //
@@ -19,7 +19,7 @@
 /**
  * DisplayBlock and derived class
  *
- * @copyright   Copyright (C) 2010-2015 Combodo SARL
+ * @copyright   Copyright (C) 2010-2016 Combodo SARL
  * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
@@ -1289,8 +1289,34 @@ class HistoryBlock extends DisplayBlock
 			else
 			{
 				$sHtml .= $this->GetHistoryTable($oPage, $oSet);
-			}	
+			}
+			$sMaxWidth = MetaModel::GetModuleSetting('itop-attachment', 'inline_image_max_width', '450px');
+		
 			$oPage->add_ready_script("$('.case-log-history-entry-toggle').on('click', function () { $(this).closest('.case-log-history-entry').toggleClass('expanded');});");
+			$oPage->add_ready_script(
+<<<EOF
+$('.history_entry').each(function() {
+	var jMe = $(this)
+	jMe.find('img[data-att-id]').each(function() {
+		if ('$sMaxWidth' != '')
+		{
+			$(this).css({'max-width': '$sMaxWidth', width: '', height: '', 'max-height': ''});
+		}
+		$(this).addClass('inline-image');
+		$(this).attr('href', $(this).attr('src'));
+	}).magnificPopup({type: 'image', closeOnContentClick: true });
+				
+	var oContent = $(this).find('.history_html_content');
+	if (jMe.height() < oContent.height())
+	{
+			jMe.prepend('<span class="history_truncated_toggler"></span>');
+			jMe.find('.history_truncated_toggler').on('click', function() {
+				jMe.toggleClass('history_entry_truncated');
+			});
+	}
+});
+EOF
+			);
 		}
 		return $sHtml;
 	}
@@ -1319,7 +1345,7 @@ class HistoryBlock extends DisplayBlock
 		}
 		$aAttribs = array('date' => array('label' => Dict::S('UI:History:Date'), 'description' => Dict::S('UI:History:Date+')),
 						  'userinfo' => array('label' => Dict::S('UI:History:User'), 'description' => Dict::S('UI:History:User+')),
-						  'log' => array('label' => Dict::S('UI:History:Changes'), 'description' => Dict::S('UI:History:Changes+')),
+						  'log' => array('label' => Dict::S('UI:History:Changes').'<span style="display:block;float:right">Expand All / Collapse All</span>', 'description' => Dict::S('UI:History:Changes+')),
 						 );
 		$aValues = array();
 		foreach($aChanges as $aChange)

application/itopwebpage.class.inc.php

@@ -1,5 +1,5 @@
 <?php
-// Copyright (C) 2010-2015 Combodo SARL
+// Copyright (C) 2010-2016 Combodo SARL
 //
 //   This file is part of iTop.
 //
@@ -20,7 +20,7 @@
 /**
  * Class iTopWebPage
  *
- * @copyright   Copyright (C) 2010-2015 Combodo SARL
+ * @copyright   Copyright (C) 2010-2016 Combodo SARL
  * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
@@ -416,7 +416,7 @@ EOF
 	ShowDebug();
 	$('#logOffBtn>ul').popupmenu();
 	
-	$('.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');

application/utils.inc.php

@@ -1,4 +1,5 @@
 <?php
+use Html2Text\Html2Text;
 // Copyright (C) 2010-2016 Combodo SARL
 //
 //   This file is part of iTop.
@@ -26,11 +27,14 @@
 
 require_once(APPROOT.'/core/config.class.inc.php');
 require_once(APPROOT.'/application/transaction.class.inc.php');
+require_once(APPROOT.'application/Html2Text.php');
+require_once(APPROOT.'application/Html2TextException.php');
 
 define('ITOP_CONFIG_FILE', 'config-itop.php');
 define('ITOP_DEFAULT_CONFIG_FILE', APPCONF.ITOP_DEFAULT_ENV.'/'.ITOP_CONFIG_FILE);
 
 define('SERVER_NAME_PLACEHOLDER', '$SERVER_NAME$');
+define('ATTACHMENT_DOWNLOAD_URL', 'pages/ajax.render.php?operation=download_document&class=Attachment&field=contents&id=');
 
 class FileUploadException extends Exception
 {
@@ -1134,4 +1138,65 @@ class utils
 		asort($aPossibleEncodings);
 		return $aPossibleEncodings;
 	}
+	
+	/**
+	 * Convert a string containing some (valid) HTML markup to plain text
+	 * @param string $sHtml
+	 * @return string
+	 */
+	public static function HtmlToText($sHtml)
+	{
+		try
+		{
+			//return '<?xml encoding="UTF-8">'.$sHtml;
+			return \Html2Text\Html2Text::convert('<?xml encoding="UTF-8">'.$sHtml);
+		}
+		catch(Exception $e)
+		{
+			return $e->getMessage();
+		}
+	}
+	
+	/**
+	 * Convert (?) plain text to some HTML markup by replacing newlines by </br> tags
+	 * and escaping HTML entities
+	 * @param string $sText
+	 * @return string
+	 */
+	public static function TextToHtml($sText)
+	{
+		$sText = str_replace("\r\n", "\n", $sText);
+		$sText = str_replace("\r", "\n", $sText);
+		return str_replace("\n", '</br>', htmlentities($sText, ENT_QUOTES, 'UTF-8'));
+	}
+	
+	/**
+	 * Parses the supplied HTML fragment to rebuild the attribute src="" for images
+	 * that refer to an attachment (detected via the attribute data-att-id="") so that
+	 * the URL is consistent with the current URL of the application.
+	 * @param string $sHtml The HTML fragment to process
+	 * @return string The modified HTML
+	 */
+	public static function FixInlineAttachments($sHtml)
+	{
+		$aNeedles = array();
+		$aReplacements = array();
+		// Find img tags with an attribute data-att-id
+		if (preg_match_all('/<img ([^>]*)data-att-id="([0-9]+)"([^>]*)>/i', $sHtml, $aMatches, PREG_SET_ORDER | PREG_OFFSET_CAPTURE))
+		{
+			$sUrl = utils::GetAbsoluteUrlAppRoot().ATTACHMENT_DOWNLOAD_URL;
+			foreach($aMatches as $aImgInfo)
+			{
+				$sImgTag = $aImgInfo[0][0];
+				$sAttId = $aImgInfo[2][0];
+				
+				$sNewImgTag = preg_replace('/src="[^"]+"/', 'src="'.$sUrl.$sAttId.'"', $sImgTag); // preserve other attributes
+				$aNeedles[] = $sImgTag;
+				$aReplacements[] = $sNewImgTag;
+			}
+			$sHtml = str_replace($aNeedles, $aReplacements, $sHtml);
+		}
+		return $sHtml;
+	}
+	
 }