nextcloud/lib/private/template.php

294 lines
9.2 KiB
PHP
Raw Normal View History

<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @author Jakob Sack
2012-05-26 21:14:24 +04:00
* @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
2012-09-23 04:39:11 +04:00
* @param string $app app providing the template
* @param string $name of the template file (without suffix)
2012-09-23 04:39:11 +04:00
* @param string $renderas = ""; produce a full page
* @param bool $registerCall = true
2012-09-23 04:39:11 +04:00
* @return OC_Template object
*
2011-07-29 23:36:03 +04:00
* This function creates an OC_Template object.
*
2011-07-29 23:36:03 +04:00
* 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 = "", $registerCall = true ) {
// 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::$server->getSession() and $registerCall) ? OC_Util::callRegister() : '';
$parts = explode('/', $app); // fix translation when app is something like core/lostpassword
2014-08-31 12:05:59 +04:00
$l10n = \OC::$server->getL10N($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);
2014-04-13 13:52:31 +04:00
}
2012-06-18 14:57:11 +04:00
/**
2012-09-23 04:39:11 +04:00
* autodetect the formfactor of the used device
2012-06-18 14:57:11 +04:00
* default -> the normal desktop browser interface
* mobile -> interface for smartphones
* tablet -> interface for tablets
* standalone -> the default interface but without header, footer and
2012-08-29 22:34:44 +04:00
* sidebar, just the application. Useful to use just a specific
* app on the desktop in a standalone window.
2012-06-18 14:57:11 +04:00
*/
2012-09-07 17:22:01 +04:00
public static function detectFormfactor() {
2012-06-18 14:57:11 +04:00
// please add more useragent strings for other devices
2012-09-07 17:22:01 +04:00
if(isset($_SERVER['HTTP_USER_AGENT'])) {
2012-11-04 14:10:46 +04:00
if(stripos($_SERVER['HTTP_USER_AGENT'], 'ipad')>0) {
2012-06-18 14:57:11 +04:00
$mode='tablet';
2012-11-04 14:10:46 +04:00
}elseif(stripos($_SERVER['HTTP_USER_AGENT'], 'iphone')>0) {
2012-06-18 14:57:11 +04:00
$mode='mobile';
2013-02-11 20:44:02 +04:00
}elseif((stripos($_SERVER['HTTP_USER_AGENT'], 'N9')>0)
and (stripos($_SERVER['HTTP_USER_AGENT'], 'nokia')>0)) {
2012-06-18 14:57:11 +04:00
$mode='mobile';
}else{
$mode='default';
}
}else{
$mode='default';
}
return($mode);
}
/**
* Returns the formfactor extension for current formfactor
*/
static public function getFormFactorExtension()
{
if (!\OC::$server->getSession()) {
return '';
}
2012-06-18 14:57:11 +04:00
// if the formfactor is not yet autodetected do the
// autodetection now. For possible formfactors check the
// detectFormfactor documentation
if (!\OC::$server->getSession()->exists('formfactor')) {
\OC::$server->getSession()->set('formfactor', self::detectFormfactor());
2012-06-18 14:57:11 +04:00
}
// allow manual override via GET parameter
2012-09-07 17:22:01 +04:00
if(isset($_GET['formfactor'])) {
\OC::$server->getSession()->set('formfactor', $_GET['formfactor']);
2012-06-18 14:57:11 +04:00
}
$formfactor = \OC::$server->getSession()->get('formfactor');
2013-07-19 19:40:07 +04:00
if($formfactor==='default') {
$fext='';
2013-07-19 19:40:07 +04:00
}elseif($formfactor==='mobile') {
$fext='.mobile';
2013-07-19 19:40:07 +04:00
}elseif($formfactor==='tablet') {
$fext='.tablet';
2013-07-19 19:40:07 +04:00
}elseif($formfactor==='standalone') {
$fext='.standalone';
}else{
$fext='';
}
return $fext;
}
/**
* find the template with the given name
2012-09-23 04:39:11 +04:00
* @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
2014-04-21 17:44:54 +04:00
* @return array
*/
protected function findTemplate($theme, $app, $name, $fext) {
// Check if it is a app template or not.
2013-07-19 19:40:07 +04:00
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
2012-09-23 04:39:11 +04:00
* @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
*/
2012-09-07 17:22:01 +04:00
public function addHeader( $tag, $attributes, $text='') {
2012-11-04 14:10:46 +04:00
$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.
*/
2012-09-07 17:22:01 +04:00
public function fetchPage() {
$data = parent::fetchPage();
2012-09-07 17:22:01 +04:00
if( $this->renderas ) {
$page = new OC_TemplateLayout($this->renderas, $this->app);
// Add custom headers
2012-11-02 22:53:02 +04:00
$page->assign('headers', $this->headers, false);
2012-09-07 17:22:01 +04:00
foreach(OC_Util::$headers as $header) {
2012-11-02 22:53:02 +04:00
$page->append('headers', $header);
}
2012-06-11 17:03:45 +04:00
$page->assign( "content", $data, false );
return $page->fetchPage();
}
2011-08-09 01:14:47 +04:00
else{
return $data;
}
}
/**
* Include template
2012-09-23 04:39:11 +04:00
* @return string returns content of included template
*
* Includes another template. use <?php echo $this->inc('template'); ?> to
* do this.
*/
2012-09-07 17:22:01 +04:00
public function inc( $file, $additionalparams = null ) {
return $this->load($this->path.$file.'.php', $additionalparams);
}
/**
* Shortcut to print a simple page for users
2012-09-23 04:39:11 +04:00
* @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
*/
2012-09-07 17:22:01 +04:00
public static function printUserPage( $application, $name, $parameters = array() ) {
2011-07-29 23:36:03 +04:00
$content = new OC_Template( $application, $name, "user" );
2012-09-07 17:22:01 +04:00
foreach( $parameters as $key => $value ) {
2013-02-28 01:55:39 +04:00
$content->assign( $key, $value );
2011-03-02 20:21:08 +03:00
}
print $content->printPage();
}
/**
* Shortcut to print a simple page for admins
2012-09-23 04:39:11 +04:00
* @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
*/
2012-09-07 17:22:01 +04:00
public static function printAdminPage( $application, $name, $parameters = array() ) {
2011-07-29 23:36:03 +04:00
$content = new OC_Template( $application, $name, "admin" );
2012-09-07 17:22:01 +04:00
foreach( $parameters as $key => $value ) {
2013-02-28 01:55:39 +04:00
$content->assign( $key, $value );
2011-03-02 20:21:08 +03:00
}
return $content->printPage();
}
/**
* Shortcut to print a simple page for guests
2012-09-23 04:39:11 +04:00
* @param string $application The application we render the template for
* @param string $name Name of the template
2014-04-21 17:44:54 +04:00
* @param array|string $parameters Parameters for the template
2012-09-23 04:39:11 +04:00
* @return bool
*/
2012-09-07 17:22:01 +04:00
public static function printGuestPage( $application, $name, $parameters = array() ) {
2011-07-29 23:36:03 +04:00
$content = new OC_Template( $application, $name, "guest" );
2012-09-07 17:22:01 +04:00
foreach( $parameters as $key => $value ) {
2013-02-28 01:55:39 +04:00
$content->assign( $key, $value );
2011-03-02 20:21:08 +03:00
}
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
2013-03-06 16:05:22 +04:00
* 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', false );
$errors = array(array('error' => $error_msg, 'hint' => $hint));
2013-03-06 16:05:22 +04:00
$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;
}
2013-07-22 00:56:21 +04:00
if (defined('DEBUG') and DEBUG) {
$hint = $exception->getTraceAsString();
if (!empty($hint)) {
2014-08-27 19:01:51 +04:00
$hint = '<pre>'.OC_Util::sanitizeHTML($hint).'</pre>';
2013-07-22 00:56:21 +04:00
}
2013-07-23 01:04:14 +04:00
while (method_exists($exception, 'previous') && $exception = $exception->previous()) {
$error_msg .= '<br/>Caused by:' . ' ';
2013-07-22 00:56:21 +04:00
if ($exception->getCode()) {
2014-08-27 19:01:51 +04:00
$error_msg .= '['.OC_Util::sanitizeHTML($exception->getCode()).'] ';
2013-07-22 00:56:21 +04:00
}
2014-08-27 19:01:51 +04:00
$error_msg .= OC_Util::sanitizeHTML($exception->getMessage());
2013-07-22 00:56:21 +04:00
};
} else {
$hint = '';
if ($exception instanceof \OC\HintException) {
2014-08-27 19:01:51 +04:00
$hint = OC_Util::sanitizeHTML($exception->getHint());
}
2013-07-22 00:56:21 +04:00
}
self::printErrorPage($error_msg, $hint);
}
}