<?php
  /**
   * ownCloud
   *
   * @author Frank Karlitschek
   * @author Jakob Sack
   * @copyright 2012 Frank Karlitschek frank@owncloud.org
   *
   * 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 Affero General Public
   * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
   *
   */
  
  require_once __DIR__.'/template/functions.php';
  
  /**
   * This class provides the templates for ownCloud.
   */
  class OC_Template extends \OC\Template\Base {
  	private $renderas; // Create a full page?
  	private $path; // The path to the template
  	private $headers=array(); //custom headers

  	protected $app; // app id

  
  	/**

  	 * Constructor

  	 * @param string $app app providing the template
  	 * @param string $name of the template file (without suffix)
  	 * @param string $renderas = ""; produce a full page
  	 * @return OC_Template object
  	 *
  	 * This function creates an OC_Template object.
  	 *
  	 * If $renderas is set, OC_Template will try to produce a full page in the
  	 * according layout. For now, renderas can be set to "guest", "user" or
  	 * "admin".
  	 */
  	public function __construct( $app, $name, $renderas = "" ) {
  		// Read the selected theme from the config file
  		$theme = OC_Util::getTheme();
  
  		// Read the detected formfactor and use the right file name.
  		$fext = self::getFormFactorExtension();
  
  		$requesttoken = OC::$session ? OC_Util::callRegister() : '';
  
  		$parts = explode('/', $app); // fix translation when app is something like core/lostpassword
  		$l10n = OC_L10N::get($parts[0]);
  		$themeDefaults = new OC_Defaults();
  
  		list($path, $template) = $this->findTemplate($theme, $app, $name, $fext);
  
  		// Set the private data
  		$this->renderas = $renderas;
  		$this->path = $path;

  		$this->app = $app;

  
  		parent::__construct($template, $requesttoken, $l10n, $themeDefaults);

  	}
  
  	/**
  	 * autodetect the formfactor of the used device
  	 * default -> the normal desktop browser interface
  	 * mobile -> interface for smartphones
  	 * tablet -> interface for tablets
  	 * standalone -> the default interface but without header, footer and
  	 *	sidebar, just the application. Useful to use just a specific
  	 *	app on the desktop in a standalone window.
  	 */
  	public static function detectFormfactor() {
  		// please add more useragent strings for other devices
  		if(isset($_SERVER['HTTP_USER_AGENT'])) {
  			if(stripos($_SERVER['HTTP_USER_AGENT'], 'ipad')>0) {
  				$mode='tablet';
  			}elseif(stripos($_SERVER['HTTP_USER_AGENT'], 'iphone')>0) {
  				$mode='mobile';
  			}elseif((stripos($_SERVER['HTTP_USER_AGENT'], 'N9')>0)
  				and (stripos($_SERVER['HTTP_USER_AGENT'], 'nokia')>0)) {
  				$mode='mobile';
  			}else{
  				$mode='default';
  			}
  		}else{
  			$mode='default';
  		}
  		return($mode);
  	}
  
  	/**

  	 * Returns the formfactor extension for current formfactor

  	 */
  	static public function getFormFactorExtension()
  	{
  		if (!\OC::$session) {
  			return '';
  		}
  		// if the formfactor is not yet autodetected do the
  		// autodetection now. For possible formfactors check the
  		// detectFormfactor documentation
  		if (!\OC::$session->exists('formfactor')) {
  			\OC::$session->set('formfactor', self::detectFormfactor());
  		}
  		// allow manual override via GET parameter
  		if(isset($_GET['formfactor'])) {
  			\OC::$session->set('formfactor', $_GET['formfactor']);
  		}
  		$formfactor = \OC::$session->get('formfactor');
  		if($formfactor==='default') {
  			$fext='';
  		}elseif($formfactor==='mobile') {
  			$fext='.mobile';
  		}elseif($formfactor==='tablet') {
  			$fext='.tablet';
  		}elseif($formfactor==='standalone') {
  			$fext='.standalone';
  		}else{
  			$fext='';
  		}
  		return $fext;
  	}
  
  	/**

  	 * find the template with the given name

  	 * @param string $name of the template file (without suffix)
  	 *
  	 * Will select the template file for the selected theme and formfactor.
  	 * Checking all the possible locations.

  	 * @param string $theme
  	 * @param string $app
  	 * @param string $fext
  	 * @return array

  	 */
  	protected function findTemplate($theme, $app, $name, $fext) {
  		// Check if it is a app template or not.
  		if( $app !== '' ) {
  			$dirs = $this->getAppTemplateDirs($theme, $app, OC::$SERVERROOT, OC_App::getAppPath($app));
  		} else {
  			$dirs = $this->getCoreTemplateDirs($theme, OC::$SERVERROOT);
  		}
  		$locator = new \OC\Template\TemplateFileLocator( $fext, $dirs );
  		$template = $locator->find($name);
  		$path = $locator->getPath();
  		return array($path, $template);
  	}
  
  	/**

  	 * Add a custom element to the header

  	 * @param string $tag tag name of the element
  	 * @param array $attributes array of attributes for the element
  	 * @param string $text the text content for the element
  	 */
  	public function addHeader( $tag, $attributes, $text='') {
  		$this->headers[]=array('tag'=>$tag,'attributes'=>$attributes, 'text'=>$text);
  	}
  
  	/**

  	 * Process the template
  	 * @return boolean|string

  	 *
  	 * This function process the template. If $this->renderas is set, it
  	 * will produce a full page.
  	 */
  	public function fetchPage() {
  		$data = parent::fetchPage();
  
  		if( $this->renderas ) {

  			$page = new OC_TemplateLayout($this->renderas, $this->app);

  
  			// Add custom headers
  			$page->assign('headers', $this->headers, false);
  			foreach(OC_Util::$headers as $header) {
  				$page->append('headers', $header);
  			}
  
  			$page->assign( "content", $data, false );
  			return $page->fetchPage();
  		}
  		else{
  			return $data;
  		}
  	}
  
  	/**

  	 * Include template

  	 * @return string returns content of included template
  	 *
  	 * Includes another template. use <?php echo $this->inc('template'); ?> to
  	 * do this.
  	 */
  	public function inc( $file, $additionalparams = null ) {
  		return $this->load($this->path.$file.'.php', $additionalparams);
  	}
  
  	/**

  	 * Shortcut to print a simple page for users

  	 * @param string $application The application we render the template for
  	 * @param string $name Name of the template
  	 * @param array $parameters Parameters for the template

  	 * @return boolean|null

  	 */
  	public static function printUserPage( $application, $name, $parameters = array() ) {
  		$content = new OC_Template( $application, $name, "user" );
  		foreach( $parameters as $key => $value ) {
  			$content->assign( $key, $value );
  		}
  		print $content->printPage();
  	}
  
  	/**

  	 * Shortcut to print a simple page for admins

  	 * @param string $application The application we render the template for
  	 * @param string $name Name of the template
  	 * @param array $parameters Parameters for the template
  	 * @return bool
  	 */
  	public static function printAdminPage( $application, $name, $parameters = array() ) {
  		$content = new OC_Template( $application, $name, "admin" );
  		foreach( $parameters as $key => $value ) {
  			$content->assign( $key, $value );
  		}
  		return $content->printPage();
  	}
  
  	/**

  	 * Shortcut to print a simple page for guests

  	 * @param string $application The application we render the template for
  	 * @param string $name Name of the template

  	 * @param array|string $parameters Parameters for the template

  	 * @return bool
  	 */
  	public static function printGuestPage( $application, $name, $parameters = array() ) {
  		$content = new OC_Template( $application, $name, "guest" );
  		foreach( $parameters as $key => $value ) {
  			$content->assign( $key, $value );
  		}
  		return $content->printPage();
  	}
  
  	/**

  		* Print a fatal error page and terminates the script

  		* @param string $error_msg The error message to show
  		* @param string $hint An optional hint message
  		* Warning: All data passed to $hint needs to get sanitized using OC_Util::sanitizeHTML
  		*/
  	public static function printErrorPage( $error_msg, $hint = '' ) {
  		$content = new OC_Template( '', 'error', 'error' );
  		$errors = array(array('error' => $error_msg, 'hint' => $hint));
  		$content->assign( 'errors', $errors );
  		$content->printPage();
  		die();
  	}

  	/**
  	 * print error page using Exception details
  	 * @param Exception $exception
  	 */

  	public static function printExceptionErrorPage(Exception $exception) {
  		$error_msg = $exception->getMessage();
  		if ($exception->getCode()) {
  			$error_msg = '['.$exception->getCode().'] '.$error_msg;
  		}
  		if (defined('DEBUG') and DEBUG) {
  			$hint = $exception->getTraceAsString();
  			if (!empty($hint)) {
  				$hint = '<pre>'.$hint.'</pre>';
  			}

  			while (method_exists($exception, 'previous') && $exception = $exception->previous()) {

  				$error_msg .= '<br/>Caused by:' . ' ';

  				if ($exception->getCode()) {
  					$error_msg .= '['.$exception->getCode().'] ';
  				}
  				$error_msg .= $exception->getMessage();
  			};
  		} else {
  			$hint = '';
  			if ($exception instanceof \OC\HintException) {
  				$hint = $exception->getHint();
  			}
  		}
  		self::printErrorPage($error_msg, $hint);
  	}
  }