Merge branch 'release/2.6' of https://github.com/Combodo/iTop into release/2.6

application/applicationextension.inc.php

@@ -16,6 +16,8 @@
 //   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/newsroomprovider.class.inc.php');
+
 /**
  * Management of application plugins
  * 

application/itopwebpage.class.inc.php

@@ -105,6 +105,8 @@ class iTopWebPage extends NiceWebPage implements iTabbedPage
 		$this->add_linked_script('../js/jquery.magnific-popup.min.js');
 		$this->add_linked_script('../js/breadcrumb.js');
 		$this->add_linked_script('../js/moment-with-locales.min.js');
+		$this->add_linked_script('../js/showdown.min.js');
+		$this->add_linked_script('../js/newsroom_menu.js');
 
 		$this->add_dict_entry('UI:FillAllMandatoryFields');
 
@@ -257,6 +259,10 @@ EOF;
 		}
 		$this->add_script(
 			<<< EOF
+	function GetUserLanguage()
+	{
+		return $sJSLangShort;
+	}
 	function PrepareWidgets()
 	{
 		// note: each action implemented here must be idempotent,
@@ -794,6 +800,69 @@ EOF
 		ApplicationMenu::DisplayMenu($this, $oAppContext->GetAsHash());
 	}
 
+	/**
+	* Handles the "newsroom" menu at the top-right of the screen
+	*/
+	protected function InitNewsroom()
+	{
+		$sNewsroomInitialImage = '';
+		if (MetaModel::GetConfig()->Get('newsroom_enabled') !== false)
+	 	{
+			$oUser = UserRights::GetUserObject();
+			/**
+			 * @var iNewsroomProvider[] $aProviders
+			 */
+			$aProviders = MetaModel::EnumPlugins('iNewsroomProvider');
+			$aProviderParams = array();
+			foreach($aProviders as $oProvider)
+			{
+				$oProvider->SetConfig(MetaModel::GetConfig());
+				$bProviderEnabled = appUserPreferences::GetPref('newsroom_provider_'.get_class($oProvider), true);
+			if ($bProviderEnabled && $oProvider->IsApplicable($oUser))
+			{
+				$aProviderParams[] = array(
+					'label' => $oProvider->GetLabel(),
+					'fetch_url' => $oProvider->GetFetchURL(),
+					'view_all_url' => $oProvider->GetViewAllURL(),
+					'mark_all_as_read_url' => $oProvider->GetMarkAllAsReadURL(),
+					'ttl' => $oProvider->GetTTL(),
+				);
+			}
+		}
+		if (count($aProviderParams) > 0)
+		{
+			$sImageUrl= '../images/newsroom_menu.png';
+			$sPlaceholderImageUrl= '../images/news-32x32.png';
+			$aParams = array(
+				'image_url' => $sImageUrl,
+				'placeholder_image_url' => $sPlaceholderImageUrl,
+				'cache_uuid' => 'itop-newsroom-'.md5(APPROOT),
+				'providers' => $aProviderParams,
+				'display_limit' => (int)appUserPreferences::GetPref('newsroom_display_size', 7),
+				'labels' => array(
+					'no_message' => Dict::S('UI:Newsroom:NoNewMessage'),
+					'mark_all_as_read' => Dict::S('UI:Newsroom:MarkAllAsRead'),
+					'view_all' => Dict::S('UI:Newsroom:ViewAllMessages'),
+				),
+			);
+			$sParams = json_encode($aParams);
+			$this->add_ready_script(
+<<<EOF
+	$('#top-left-newsroom-cell').newsroom_menu($sParams);
+EOF
+			);
+			$sNewsroomInitialImage = '<img style="opacity:0.4" src="../images/newsroom_menu.png">';
+		}
+		else
+		{
+			// No newsroom menu at all
+		}
+	}
+	// else no newsroom menu
+	return $sNewsroomInitialImage;
+	}
+
+
 	/**
 	 * Outputs (via some echo) the complete HTML page by assembling all its elements
 	 */
@@ -891,6 +960,8 @@ EOF
 			);
 		}
 
+		$sNewsRoomInitialImage = $this->InitNewsroom();
+
 		$this->outputCollapsibleSectionInit();
 
 		if ($this->GetOutputFormat() == 'html')
@@ -1273,6 +1344,7 @@ EOF;
 			$sHtml .= '		<table id="top-left-buttons-area"><tr>';
 			$sHtml .= '			<td id="top-left-global-search-cell"><div id="global-search-area"><input id="global-search-input" type="text" name="text" placeholder="'.$sDefaultPlaceHolder.'" value="'.$sText.'"></input><div '.$sOnClick.' id="global-search-image"><input type="hidden" name="operation" value="full_text"/></div></div></td>';
 			$sHtml .= '     	<td id="top-left-help-cell"><a id="help-link" href="'.$sOnlineHelpUrl.'" target="_blank"><img title="'.Dict::S('UI:Help').'" src="../images/help.png?t='.utils::GetCacheBusterTimestamp().'"/></td>';
+			$sHtml .= '		<td id="top-left-newsroom-cell">'.$sNewsRoomInitialImage.'</td>';
 			$sHtml .= '     	<td id="top-left-logoff-cell">'.self::FilterXSS($sLogOffMenu).'</td>';
 			$sHtml .= '     </tr></table></form></div>';
 			$sHtml .= ' </td>';

application/newsroomprovider.class.inc.php

@@ -0,0 +1,143 @@
+<?php
+// Copyright (C) 2010-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/>
+
+/**
+ * A provider for messages to be displayed in the iTop Newsroom
+ */
+interface iNewsroomProvider
+{
+	/**
+	 * Inject the current configuration in the provider
+	 * @param Config $oConfig
+	 * @return void
+	 */
+	public function SetConfig(Config $oConfig);
+
+	/**
+	 * Tells if this provider is enabled for the given user
+	 * @param User $oUser The user for who to check if the provider is applicable.
+	 * return bool
+	 */
+	public function IsApplicable(User $oUser = null);
+	
+	/**
+	 * The human readable (localized) label for this provider
+	 * @return string
+	 */
+	public function GetLabel();
+	
+	/**
+	 * The URL to query (from the browser, using jsonp) to fetch all unread messages
+	 * @return string
+	 */
+	public function GetFetchURL();
+	
+	/**
+	 * The URL to navigate to in order to display all messages
+	 * @return string
+	 */
+	public function GetViewAllURL();
+	
+	/**
+	 * The URL to query(from the browser, using jsonp) to mark all unread messages as read
+	 * @return string
+	 */
+	public function GetMarkAllAsReadURL();
+	
+	/**
+	 * Return the URL to configure the preferences for this provider or null is there is nothing to configure
+	 * @return string|null
+	 */
+	public function GetPreferencesUrl();
+	
+	/**
+	 * The duration between to refreshes of the cache (in seconds)
+	 * @return int
+	 */
+	public function GetTTL();
+}
+
+/**
+ * Basic implementation of a Newsroom provider, to be overloaded by your own provider implementation
+ *
+ */
+abstract class NewsroomProviderBase implements iNewsroomProvider
+{
+	/**
+	 * The current configuration parameters
+	 * @var Config
+	 */
+	protected $oConfig;
+	
+	public function __construct()
+	{
+		$this->oConfig = null;
+	}
+	
+	/**
+	 * {@inheritDoc}
+	 * @see iNewsroomProvider::SetConfig()
+	 */
+	public function SetConfig(Config $oConfig)
+	{
+		$this->oConfig = $oConfig;		
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see iNewsroomProvider::GetPreferencesUrl()
+	 */
+	public function GetPreferencesUrl()
+	{
+		return null; // No preferences
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see iNewsroomProvider::GetLabel()
+	 */
+	public abstract function GetLabel();
+	
+	/**
+	 * {@inheritDoc}
+	 * @see iNewsroomProvider::GetFetchURL()
+	 */
+	public abstract function GetFetchURL();
+
+	/**
+	 * {@inheritDoc}
+	 * @see iNewsroomProvider::GetMarkAllURL()
+	 */
+	public abstract function GetMarkAllAsReadURL();
+
+	/**
+	 * {@inheritDoc}
+	 * @see iNewsroomProvider::GetViewAllURL()
+	 */
+	public abstract function GetViewAllURL();
+
+	public function IsApplicable(User $oUser = null)
+	{
+		return false;
+	}
+	
+	public function GetTTL()
+	{
+		return 10*60; // Refresh every 10 minutes
+	}
+}