<?php
  
  /**
   * ownCloud - Activity App
   *
   * @author Joas Schilling
   * @copyright 2014 Joas Schilling nickvergessen@owncloud.com
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
   * License as published by the Free Software Foundation; either
   * version 3 of the License, or any later version.
   *
   * This library 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 Lesser General Public
   * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
   *
   */
  
  namespace OCA\Activity;
  
  use \OCP\User;
  use \OCP\Util;
  use \OC\Files\View;
  
  class ParameterHelper
  {
  	/** @var \OC\Files\View */
  	protected $rootView;
  
  	/** @var \OC_L10N */
  	protected $l;
  
  	public function __construct(View $rootView, \OC_L10N $l) {
  		$this->rootView = $rootView;
  		$this->l = $l;
  	}
  
  	/**
  	 * Prepares the parameters before we use them in the subject or message
  	 * @param array $params
  	 * @param array $paramTypes Type of parameters, if they need special handling
  	 * @param bool $stripPath Shall we remove the path from the filename
  	 * @param bool $highlightParams
  	 * @return array
  	 */
  	public function prepareParameters($params, $paramTypes = array(), $stripPath = false, $highlightParams = false) {
  		$preparedParams = array();
  		foreach ($params as $i => $param) {
  			if (is_array($param)) {
  				$preparedParams[] = $this->prepareArrayParameter($param, $paramTypes[$i], $stripPath, $highlightParams);
  			} else {
  				$preparedParams[] = $this->prepareStringParameter($param, isset($paramTypes[$i]) ? $paramTypes[$i] : '', $stripPath, $highlightParams);
  			}
  		}
  		return $preparedParams;
  	}
  
  	/**
  	 * Prepares a string parameter before we use it in the subject or message
  	 *
  	 * @param string $param
  	 * @param string $paramType Type of parameter, if it needs special handling
  	 * @param bool $stripPath Shall we remove the path from the filename
  	 * @param bool $highlightParams
  	 * @return string
  	 */
  	public function prepareStringParameter($param, $paramType, $stripPath, $highlightParams) {
  		if ($paramType === 'file') {
  			return $this->prepareFileParam($param, $stripPath, $highlightParams);
  		} else if ($paramType === 'username') {
  			return $this->prepareUserParam($param, $highlightParams);
  		}
  		return $this->prepareParam($param, $highlightParams);
  	}
  
  	/**
  	 * Prepares an array parameter before we use it in the subject or message
  	 *
  	 * @param array $params
  	 * @param string $paramType Type of parameters, if it needs special handling
  	 * @param bool $stripPath Shall we remove the path from the filename
  	 * @param bool $highlightParams
  	 * @return string
  	 */
  	public function prepareArrayParameter($params, $paramType, $stripPath, $highlightParams) {
  		$parameterList = $plainParameterList = array();
  		foreach ($params as $parameter) {
  			if ($paramType === 'file') {
  				$parameterList[] = $this->prepareFileParam($parameter, $stripPath, $highlightParams);
  				$plainParameterList[] = $this->prepareFileParam($parameter, false, false);
  			} else {
  				$parameterList[] = $this->prepareParam($parameter, $highlightParams);
  				$plainParameterList[] = $this->prepareParam($parameter, false);
  			}
  		}
  		return $this->joinParameterList($parameterList, $plainParameterList, $highlightParams);
  	}
  
  	/**
  	 * Prepares a parameter for usage by adding highlights
  	 *
  	 * @param string $param
  	 * @param bool $highlightParams
  	 * @return string
  	 */
  	protected function prepareParam($param, $highlightParams) {
  		if ($highlightParams) {
  			return '<strong>' . Util::sanitizeHTML($param) . '</strong>';
  		} else {
  			return $param;
  		}
  	}
  
  	/**
  	 * Prepares a user name parameter for usage
  	 *
  	 * Add an avatar to usernames
  	 *
  	 * @param string $param
  	 * @param bool $highlightParams
  	 * @return string
  	 */
  	protected function prepareUserParam($param, $highlightParams) {
  		$displayName = User::getDisplayName($param);
  		$param = Util::sanitizeHTML($param);
  		$displayName = Util::sanitizeHTML($displayName);
  
  		if ($highlightParams) {
  			return '<div class="avatar" data-user="' . $param . '"></div>'
  				. '<strong>' . $displayName . '</strong>';
  		} else {
  			return $displayName;
  		}
  	}
  
  	/**
  	 * Prepares a file parameter for usage
  	 *
  	 * Removes the path from filenames and adds highlights
  	 *
  	 * @param string $param
  	 * @param bool $stripPath Shall we remove the path from the filename
  	 * @param bool $highlightParams
  	 * @return string
  	 */
  	protected function prepareFileParam($param, $stripPath, $highlightParams) {
  		$param = $this->fixLegacyFilename($param);
  		$is_dir = $this->rootView->is_dir('/' . User::getUser() . '/files' . $param);
  
  		if ($is_dir) {
  			$parent_dir = $param;
  		} else {
  			$parent_dir = (substr_count($param, '/') == 1) ? '/' : dirname($param);
  		}
  
  		$fileLink = Util::linkTo('files', 'index.php', array('dir' => $parent_dir));
  		$param = trim($param, '/');
  
  		list($path, $name) = $this->splitPathFromFilename($param);
  		if (!$stripPath || $path === '') {
  			if (!$highlightParams) {
  				return $param;
  			}
  			return '<a class="filename" href="' . $fileLink . '">' . Util::sanitizeHTML($param) . '</a>';
  		}
  
  		if (!$highlightParams) {
  			return $name;
  		}
  
  		$title = ' title="' . $this->l->t('in %s', array(Util::sanitizeHTML($path))) . '"';
  		return '<a class="filename tooltip" href="' . $fileLink . '"' . $title . '>' . Util::sanitizeHTML($name) . '</a>';
  	}
  
  	/**
  	 * Prepend leading slash to filenames of legacy activities
  	 * @param string $filename
  	 * @return string
  	 */
  	protected function fixLegacyFilename($filename) {
  		if (strpos($filename, '/') !== 0) {
  			return '/' . $filename;
  		}
  		return $filename;
  	}
  
  	/**
  	 * Split the path from the filename string
  	 *
  	 * @param string $filename
  	 * @return array Array with path and filename
  	 */
  	protected function splitPathFromFilename($filename) {
  		if (strrpos($filename, '/') !== false) {
  			return array(
  				trim(substr($filename, 0, strrpos($filename, '/')), '/'),
  				substr($filename, strrpos($filename, '/') + 1),
  			);
  		}
  		return array('', $filename);
  	}
  
  	/**
  	 * Returns a list of grouped parameters
  	 *
  	 * 2 parameters are joined by "and":
  	 * => A and B
  	 * Up to 5 parameters are joined by "," and "and":
  	 * => A, B, C, D and E
  	 * More than 5 parameters are joined by "," and trimmed:
  	 * => A, B, C and #n more
  	 *
  	 * @param array $parameterList
  	 * @param array $plainParameterList
  	 * @param bool $highlightParams
  	 * @return string
  	 */
  	protected function joinParameterList($parameterList, $plainParameterList, $highlightParams) {
  		if (empty($parameterList)) {
  			return '';
  		}
  
  		$count = sizeof($parameterList);
  		$lastItem = array_pop($parameterList);
  
  		if ($count == 1)
  		{
  			return $lastItem;
  		}
  		else if ($count == 2)
  		{
  			$firstItem = array_pop($parameterList);
  			return $this->l->t('%s and %s', array($firstItem, $lastItem));
  		}
  		else if ($count <= 5)
  		{
  			$list = implode($this->l->t(', '), $parameterList);
  			return $this->l->t('%s and %s', array($list, $lastItem));
  		}
  
  		$firstParams = array_slice($parameterList, 0, 3);
  		$firstList = implode($this->l->t(', '), $firstParams);
  		$trimmedParams = array_slice($plainParameterList, 3);
  		$trimmedList = implode($this->l->t(', '), $trimmedParams);
  		if ($highlightParams) {
  			return $this->l->n(
  				'%s and <strong class="tooltip" title="%s">%n more</strong>',
  				'%s and <strong class="tooltip" title="%s">%n more</strong>',
  				$count - 3,
  				array($firstList, $trimmedList));
  		}
  		return $this->l->n('%s and %n more', '%s and %n more', $count - 3, array($firstList));
  	}
  
  	/**
  	 * List with special parameters for the message
  	 *
  	 * @param string $app
  	 * @param string $text
  	 * @return array
  	 */
  	public function getSpecialParameterList($app, $text) {
  		if ($app === 'files' && $text === 'shared_group_self') {
  			return array(0 => 'file');
  		}
  		else if ($app === 'files') {
  			return array(0 => 'file', 1 => 'username');
  		}
  		return array();
  	}
  }