nextcloud / server

lib/private/Log/LogFactory.php

Indentation +40 added lines, -40 removed lines

@@ -32,50 +32,50 @@
 use OCP\Log\IWriter;
 
 class LogFactory implements ILogFactory {
-	/** @var IServerContainer */
-	private $c;
-	/** @var SystemConfig */
-	private $systemConfig;
+    /** @var IServerContainer */
+    private $c;
+    /** @var SystemConfig */
+    private $systemConfig;
 
-	public function __construct(IServerContainer $c, SystemConfig $systemConfig) {
-		$this->c = $c;
-		$this->systemConfig = $systemConfig;
-	}
+    public function __construct(IServerContainer $c, SystemConfig $systemConfig) {
+        $this->c = $c;
+        $this->systemConfig = $systemConfig;
+    }
 
-	/**
-	 * @throws \OCP\AppFramework\QueryException
-	 */
-	public function get(string $type):IWriter {
-		switch (strtolower($type)) {
-			case 'errorlog':
-				return new Errorlog();
-			case 'syslog':
-				return $this->c->resolve(Syslog::class);
-			case 'systemd':
-				return $this->c->resolve(Systemdlog::class);
-			case 'file':
-				return $this->buildLogFile();
+    /**
+     * @throws \OCP\AppFramework\QueryException
+     */
+    public function get(string $type):IWriter {
+        switch (strtolower($type)) {
+            case 'errorlog':
+                return new Errorlog();
+            case 'syslog':
+                return $this->c->resolve(Syslog::class);
+            case 'systemd':
+                return $this->c->resolve(Systemdlog::class);
+            case 'file':
+                return $this->buildLogFile();
 
-			// Backwards compatibility for old and fallback for unknown log types
-			case 'owncloud':
-			case 'nextcloud':
-			default:
-				return $this->buildLogFile();
-		}
-	}
+            // Backwards compatibility for old and fallback for unknown log types
+            case 'owncloud':
+            case 'nextcloud':
+            default:
+                return $this->buildLogFile();
+        }
+    }
 
-	public function getCustomLogger(string $path):ILogger {
-		$log = $this->buildLogFile($path);
-		return new Log($log, $this->systemConfig);
-	}
+    public function getCustomLogger(string $path):ILogger {
+        $log = $this->buildLogFile($path);
+        return new Log($log, $this->systemConfig);
+    }
 
-	protected function buildLogFile(string $logFile = ''):File {
-		$defaultLogFile = $this->systemConfig->getValue('datadirectory', \OC::$SERVERROOT.'/data').'/nextcloud.log';
-		if($logFile === '') {
-			$logFile = $this->systemConfig->getValue('logfile', $defaultLogFile);
-		}
-		$fallback = $defaultLogFile !== $logFile ? $defaultLogFile : '';
+    protected function buildLogFile(string $logFile = ''):File {
+        $defaultLogFile = $this->systemConfig->getValue('datadirectory', \OC::$SERVERROOT.'/data').'/nextcloud.log';
+        if($logFile === '') {
+            $logFile = $this->systemConfig->getValue('logfile', $defaultLogFile);
+        }
+        $fallback = $defaultLogFile !== $logFile ? $defaultLogFile : '';
 
-		return new File($logFile, $fallback, $this->systemConfig);
-	}
+        return new File($logFile, $fallback, $this->systemConfig);
+    }
 }

lib/public/Log/ILogFactory.php

Indentation +12 added lines, -12 removed lines

@@ -33,17 +33,17 @@
  * @since 14.0.0
  */
 interface ILogFactory {
-	/**
-	 * @param string $type - one of: file, errorlog, syslog, systemd
-	 * @return IWriter
-	 * @since 14.0.0
-	 */
-	public function get(string $type): IWriter;
+    /**
+     * @param string $type - one of: file, errorlog, syslog, systemd
+     * @return IWriter
+     * @since 14.0.0
+     */
+    public function get(string $type): IWriter;
 
-	/**
-	 * @param string $path
-	 * @return ILogger
-	 * @since 14.0.0
-	 */
-	public function getCustomLogger(string $path): ILogger;
+    /**
+     * @param string $path
+     * @return ILogger
+     * @since 14.0.0
+     */
+    public function getCustomLogger(string $path): ILogger;
 }

core/Command/Log/Manage.php

Indentation +163 added lines, -163 removed lines

@@ -36,167 +36,167 @@
 
 class Manage extends Command implements CompletionAwareInterface {
 
-	const DEFAULT_BACKEND = 'file';
-	const DEFAULT_LOG_LEVEL = 2;
-	const DEFAULT_TIMEZONE = 'UTC';
-
-	/** @var IConfig */
-	protected $config;
-
-	public function __construct(IConfig $config) {
-		$this->config = $config;
-		parent::__construct();
-	}
-
-	protected function configure() {
-		$this
-			->setName('log:manage')
-			->setDescription('manage logging configuration')
-			->addOption(
-				'backend',
-				null,
-				InputOption::VALUE_REQUIRED,
-				'set the logging backend [file, syslog, errorlog, systemd]'
-			)
-			->addOption(
-				'level',
-				null,
-				InputOption::VALUE_REQUIRED,
-				'set the log level [debug, info, warning, error]'
-			)
-			->addOption(
-				'timezone',
-				null,
-				InputOption::VALUE_REQUIRED,
-				'set the logging timezone'
-			)
-		;
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output) {
-		// collate config setting to the end, to avoid partial configuration
-		$toBeSet = [];
-
-		if ($backend = $input->getOption('backend')) {
-			$this->validateBackend($backend);
-			$toBeSet['log_type'] = $backend;
-		}
-
-		$level = $input->getOption('level');
-		if ($level !== null) {
-			if (is_numeric($level)) {
-				$levelNum = $level;
-				// sanity check
-				$this->convertLevelNumber($levelNum);
-			} else {
-				$levelNum = $this->convertLevelString($level);
-			}
-			$toBeSet['loglevel'] = $levelNum;
-		}
-
-		if ($timezone = $input->getOption('timezone')) {
-			$this->validateTimezone($timezone);
-			$toBeSet['logtimezone'] = $timezone;
-		}
-
-		// set config
-		foreach ($toBeSet as $option => $value) {
-			$this->config->setSystemValue($option, $value);
-		}
-
-		// display configuration
-		$backend = $this->config->getSystemValue('log_type', self::DEFAULT_BACKEND);
-		$output->writeln('Enabled logging backend: '.$backend);
-
-		$levelNum = $this->config->getSystemValue('loglevel', self::DEFAULT_LOG_LEVEL);
-		$level = $this->convertLevelNumber($levelNum);
-		$output->writeln('Log level: '.$level.' ('.$levelNum.')');
-
-		$timezone = $this->config->getSystemValue('logtimezone', self::DEFAULT_TIMEZONE);
-		$output->writeln('Log timezone: '.$timezone);
-	}
-
-	/**
-	 * @param string $backend
-	 * @throws \InvalidArgumentException
-	 */
-	protected function validateBackend($backend) {
-		if (!class_exists('OC\\Log\\'.ucfirst($backend))) {
-			throw new \InvalidArgumentException('Invalid backend');
-		}
-	}
-
-	/**
-	 * @param string $timezone
-	 * @throws \Exception
-	 */
-	protected function validateTimezone($timezone) {
-		new \DateTimeZone($timezone);
-	}
-
-	/**
-	 * @param string $level
-	 * @return int
-	 * @throws \InvalidArgumentException
-	 */
-	protected function convertLevelString($level) {
-		$level = strtolower($level);
-		switch ($level) {
-		case 'debug':
-			return 0;
-		case 'info':
-			return 1;
-		case 'warning':
-		case 'warn':
-			return 2;
-		case 'error':
-		case 'err':
-			return 3;
-		}
-		throw new \InvalidArgumentException('Invalid log level string');
-	}
-
-	/**
-	 * @param int $levelNum
-	 * @return string
-	 * @throws \InvalidArgumentException
-	 */
-	protected function convertLevelNumber($levelNum) {
-		switch ($levelNum) {
-		case 0:
-			return 'Debug';
-		case 1:
-			return 'Info';
-		case 2:
-			return 'Warning';
-		case 3:
-			return 'Error';
-		}
-		throw new \InvalidArgumentException('Invalid log level number');
-	}
-
-	/**
-	 * @param string $optionName
-	 * @param CompletionContext $context
-	 * @return string[]
-	 */
-	public function completeOptionValues($optionName, CompletionContext $context) {
-		if ($optionName === 'backend') {
-			return ['file', 'syslog', 'errorlog', 'systemd'];
-		} else if ($optionName === 'level') {
-			return ['debug', 'info', 'warning', 'error'];
-		} else if ($optionName === 'timezone') {
-			return \DateTimeZone::listIdentifiers();
-		}
-		return [];
-	}
-
-	/**
-	 * @param string $argumentName
-	 * @param CompletionContext $context
-	 * @return string[]
-	 */
-	public function completeArgumentValues($argumentName, CompletionContext $context) {
-		return [];
-	}
+    const DEFAULT_BACKEND = 'file';
+    const DEFAULT_LOG_LEVEL = 2;
+    const DEFAULT_TIMEZONE = 'UTC';
+
+    /** @var IConfig */
+    protected $config;
+
+    public function __construct(IConfig $config) {
+        $this->config = $config;
+        parent::__construct();
+    }
+
+    protected function configure() {
+        $this
+            ->setName('log:manage')
+            ->setDescription('manage logging configuration')
+            ->addOption(
+                'backend',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'set the logging backend [file, syslog, errorlog, systemd]'
+            )
+            ->addOption(
+                'level',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'set the log level [debug, info, warning, error]'
+            )
+            ->addOption(
+                'timezone',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'set the logging timezone'
+            )
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output) {
+        // collate config setting to the end, to avoid partial configuration
+        $toBeSet = [];
+
+        if ($backend = $input->getOption('backend')) {
+            $this->validateBackend($backend);
+            $toBeSet['log_type'] = $backend;
+        }
+
+        $level = $input->getOption('level');
+        if ($level !== null) {
+            if (is_numeric($level)) {
+                $levelNum = $level;
+                // sanity check
+                $this->convertLevelNumber($levelNum);
+            } else {
+                $levelNum = $this->convertLevelString($level);
+            }
+            $toBeSet['loglevel'] = $levelNum;
+        }
+
+        if ($timezone = $input->getOption('timezone')) {
+            $this->validateTimezone($timezone);
+            $toBeSet['logtimezone'] = $timezone;
+        }
+
+        // set config
+        foreach ($toBeSet as $option => $value) {
+            $this->config->setSystemValue($option, $value);
+        }
+
+        // display configuration
+        $backend = $this->config->getSystemValue('log_type', self::DEFAULT_BACKEND);
+        $output->writeln('Enabled logging backend: '.$backend);
+
+        $levelNum = $this->config->getSystemValue('loglevel', self::DEFAULT_LOG_LEVEL);
+        $level = $this->convertLevelNumber($levelNum);
+        $output->writeln('Log level: '.$level.' ('.$levelNum.')');
+
+        $timezone = $this->config->getSystemValue('logtimezone', self::DEFAULT_TIMEZONE);
+        $output->writeln('Log timezone: '.$timezone);
+    }
+
+    /**
+     * @param string $backend
+     * @throws \InvalidArgumentException
+     */
+    protected function validateBackend($backend) {
+        if (!class_exists('OC\\Log\\'.ucfirst($backend))) {
+            throw new \InvalidArgumentException('Invalid backend');
+        }
+    }
+
+    /**
+     * @param string $timezone
+     * @throws \Exception
+     */
+    protected function validateTimezone($timezone) {
+        new \DateTimeZone($timezone);
+    }
+
+    /**
+     * @param string $level
+     * @return int
+     * @throws \InvalidArgumentException
+     */
+    protected function convertLevelString($level) {
+        $level = strtolower($level);
+        switch ($level) {
+        case 'debug':
+            return 0;
+        case 'info':
+            return 1;
+        case 'warning':
+        case 'warn':
+            return 2;
+        case 'error':
+        case 'err':
+            return 3;
+        }
+        throw new \InvalidArgumentException('Invalid log level string');
+    }
+
+    /**
+     * @param int $levelNum
+     * @return string
+     * @throws \InvalidArgumentException
+     */
+    protected function convertLevelNumber($levelNum) {
+        switch ($levelNum) {
+        case 0:
+            return 'Debug';
+        case 1:
+            return 'Info';
+        case 2:
+            return 'Warning';
+        case 3:
+            return 'Error';
+        }
+        throw new \InvalidArgumentException('Invalid log level number');
+    }
+
+    /**
+     * @param string $optionName
+     * @param CompletionContext $context
+     * @return string[]
+     */
+    public function completeOptionValues($optionName, CompletionContext $context) {
+        if ($optionName === 'backend') {
+            return ['file', 'syslog', 'errorlog', 'systemd'];
+        } else if ($optionName === 'level') {
+            return ['debug', 'info', 'warning', 'error'];
+        } else if ($optionName === 'timezone') {
+            return \DateTimeZone::listIdentifiers();
+        }
+        return [];
+    }
+
+    /**
+     * @param string $argumentName
+     * @param CompletionContext $context
+     * @return string[]
+     */
+    public function completeArgumentValues($argumentName, CompletionContext $context) {
+        return [];
+    }
 }

lib/private/Log/Syslog.php

Indentation +23 added lines, -23 removed lines

@@ -30,30 +30,30 @@
 use OCP\Log\IWriter;
 
 class Syslog implements IWriter {
-	protected $levels = [
-		ILogger::DEBUG => LOG_DEBUG,
-		ILogger::INFO => LOG_INFO,
-		ILogger::WARN => LOG_WARNING,
-		ILogger::ERROR => LOG_ERR,
-		ILogger::FATAL => LOG_CRIT,
-	];
+    protected $levels = [
+        ILogger::DEBUG => LOG_DEBUG,
+        ILogger::INFO => LOG_INFO,
+        ILogger::WARN => LOG_WARNING,
+        ILogger::ERROR => LOG_ERR,
+        ILogger::FATAL => LOG_CRIT,
+    ];
 
-	public function __construct(IConfig $config) {
-		openlog($config->getSystemValue('syslog_tag', 'Nextcloud'), LOG_PID | LOG_CONS, LOG_USER);
-	}
+    public function __construct(IConfig $config) {
+        openlog($config->getSystemValue('syslog_tag', 'Nextcloud'), LOG_PID | LOG_CONS, LOG_USER);
+    }
 
-	public function __destruct() {
-		closelog();
-	}
+    public function __destruct() {
+        closelog();
+    }
 
-	/**
-	 * write a message in the log
-	 * @param string $app
-	 * @param string $message
-	 * @param int $level
-	 */
-	public function write(string $app, $message, int $level) {
-		$syslog_level = $this->levels[$level];
-		syslog($syslog_level, '{'.$app.'} '.$message);
-	}
+    /**
+     * write a message in the log
+     * @param string $app
+     * @param string $message
+     * @param int $level
+     */
+    public function write(string $app, $message, int $level) {
+        $syslog_level = $this->levels[$level];
+        syslog($syslog_level, '{'.$app.'} '.$message);
+    }
 }

lib/private/Log/Systemdlog.php

Indentation +28 added lines, -28 removed lines

@@ -43,36 +43,36 @@
 //     Syslog compatibility fields
 
 class Systemdlog implements IWriter {
-	protected $levels = [
-		ILogger::DEBUG => 7,
-		ILogger::INFO => 6,
-		ILogger::WARN => 4,
-		ILogger::ERROR => 3,
-		ILogger::FATAL => 2,
-	];
+    protected $levels = [
+        ILogger::DEBUG => 7,
+        ILogger::INFO => 6,
+        ILogger::WARN => 4,
+        ILogger::ERROR => 3,
+        ILogger::FATAL => 2,
+    ];
 
-	protected $syslogId;
+    protected $syslogId;
 
-	public function __construct(IConfig $config) {
-		if(!function_exists('sd_journal_send')) {
-			throw new HintException(
-				'PHP extension php-systemd is not available.',
-				'Please install and enable PHP extension systemd if you wish to log to the Systemd journal.');
+    public function __construct(IConfig $config) {
+        if(!function_exists('sd_journal_send')) {
+            throw new HintException(
+                'PHP extension php-systemd is not available.',
+                'Please install and enable PHP extension systemd if you wish to log to the Systemd journal.');
 
-		}
-		$this->syslogId = $config->getSystemValue('syslog_tag', 'Nextcloud');
-	}
+        }
+        $this->syslogId = $config->getSystemValue('syslog_tag', 'Nextcloud');
+    }
 
-	/**
-	 * Write a message to the log.
-	 * @param string $app
-	 * @param string $message
-	 * @param int $level
-	 */
-	public function write(string $app, $message, int $level) {
-		$journal_level = $this->levels[$level];
-		sd_journal_send('PRIORITY='.$journal_level,
-				'SYSLOG_IDENTIFIER='.$this->syslogId,
-				'MESSAGE={'.$app.'} '.$message);
-	}
+    /**
+     * Write a message to the log.
+     * @param string $app
+     * @param string $message
+     * @param int $level
+     */
+    public function write(string $app, $message, int $level) {
+        $journal_level = $this->levels[$level];
+        sd_journal_send('PRIORITY='.$journal_level,
+                'SYSLOG_IDENTIFIER='.$this->syslogId,
+                'MESSAGE={'.$app.'} '.$message);
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -54,7 +54,7 @@
 	protected $syslogId;
 
 	public function __construct(IConfig $config) {
-		if(!function_exists('sd_journal_send')) {
+		if (!function_exists('sd_journal_send')) {
 			throw new HintException(
 				'PHP extension php-systemd is not available.',
 				'Please install and enable PHP extension systemd if you wish to log to the Systemd journal.');

lib/private/legacy/template.php

Indentation +336 added lines, -336 removed lines

@@ -46,340 +46,340 @@
  */
 class OC_Template extends \OC\Template\Base {
 
-	/** @var string */
-	private $renderAs; // Create a full page?
-
-	/** @var string */
-	private $path; // The path to the template
-
-	/** @var array */
-	private $headers = array(); //custom headers
-
-	/** @var string */
-	protected $app; // app id
-
-	protected static $initTemplateEngineFirstRun = true;
-
-	/**
-	 * Constructor
-	 *
-	 * @param string $app app providing the template
-	 * @param string $name of the template file (without suffix)
-	 * @param string $renderAs 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".
-	 * @param bool $registerCall = true
-	 */
-	public function __construct( $app, $name, $renderAs = "", $registerCall = true ) {
-		// Read the selected theme from the config file
-		self::initTemplateEngine($renderAs);
-
-		$theme = OC_Util::getTheme();
-
-		$requestToken = (OC::$server->getSession() && $registerCall) ? \OCP\Util::callRegister() : '';
-
-		$parts = explode('/', $app); // fix translation when app is something like core/lostpassword
-		$l10n = \OC::$server->getL10N($parts[0]);
-		/** @var \OCP\Defaults $themeDefaults */
-		$themeDefaults = \OC::$server->query(\OCP\Defaults::class);
-
-		list($path, $template) = $this->findTemplate($theme, $app, $name);
-
-		// Set the private data
-		$this->renderAs = $renderAs;
-		$this->path = $path;
-		$this->app = $app;
-
-		parent::__construct($template, $requestToken, $l10n, $themeDefaults);
-	}
-
-	/**
-	 * @param string $renderAs
-	 */
-	public static function initTemplateEngine($renderAs) {
-		if (self::$initTemplateEngineFirstRun){
-
-			//apps that started before the template initialization can load their own scripts/styles
-			//so to make sure this scripts/styles here are loaded first we use OC_Util::addScript() with $prepend=true
-			//meaning the last script/style in this list will be loaded first
-			if (\OC::$server->getSystemConfig()->getValue ('installed', false) && $renderAs !== 'error' && !\OCP\Util::needUpgrade()) {
-				if (\OC::$server->getConfig ()->getAppValue ( 'core', 'backgroundjobs_mode', 'ajax' ) == 'ajax') {
-					OC_Util::addScript ( 'backgroundjobs', null, true );
-				}
-			}
-
-			OC_Util::addStyle('css-variables', null, true);
-			OC_Util::addStyle('server', null, true);
-			OC_Util::addStyle('jquery-ui-fixes',null,true);
-			OC_Util::addVendorStyle('jquery-ui/themes/base/jquery-ui',null,true);
-			OC_Util::addVendorStyle('select2/select2', null, true);
-			OC_Util::addStyle('jquery.ocdialog');
-			OC_Util::addTranslations("core", null, true);
-			OC_Util::addStyle('search', 'results');
-			OC_Util::addScript('search', 'search', true);
-			OC_Util::addScript('search', 'searchprovider');
-			OC_Util::addScript('merged-template-prepend', null, true);
-			OC_Util::addScript('jquery-ui-fixes');
-			OC_Util::addScript('files/fileinfo');
-			OC_Util::addScript('files/client');
-			OC_Util::addScript('contactsmenu');
-
-			if (\OC::$server->getConfig()->getSystemValue('debug')) {
-				// Add the stuff we need always
-				// following logic will import all vendor libraries that are
-				// specified in core/js/core.json
-				$fileContent = file_get_contents(OC::$SERVERROOT . '/core/js/core.json');
-				if($fileContent !== false) {
-					$coreDependencies = json_decode($fileContent, true);
-					foreach(array_reverse($coreDependencies['vendor']) as $vendorLibrary) {
-						//remove trailing ".js" as addVendorScript will append it
-						OC_Util::addVendorScript(
-							substr($vendorLibrary, 0, -3),null,true);
-						}
- 				} else {
-					throw new \Exception('Cannot read core/js/core.json');
-				}
-			} else {
-				// Import all (combined) default vendor libraries
-				OC_Util::addVendorScript('core', null, true);
-			}
-
-			if (\OC::$server->getRequest()->isUserAgent([\OC\AppFramework\Http\Request::USER_AGENT_IE])) {
-				// polyfill for btoa/atob for IE friends
-				OC_Util::addVendorScript('base64/base64');
-				// shim for the davclient.js library
-				\OCP\Util::addScript('files/iedavclient');
-			}
-
-			self::$initTemplateEngineFirstRun = false;
-		}
-
-	}
-
-
-	/**
-	 * 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.
-	 * Checking all the possible locations.
-	 * @param string $theme
-	 * @param string $app
-	 * @return string[]
-	 */
-	protected function findTemplate($theme, $app, $name) {
-		// 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( $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. If $text is null then the
-	 * element will be written as empty element. So use "" to get a closing tag.
-	 */
-	public function addHeader($tag, $attributes, $text=null) {
-		$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($additionalParams = null) {
-		$data = parent::fetchPage($additionalParams);
-
-		if( $this->renderAs ) {
-			$page = new TemplateLayout($this->renderAs, $this->app);
-
-			if(is_array($additionalParams)) {
-				foreach ($additionalParams as $key => $value) {
-					$page->assign($key, $value);
-				}
-			}
-
-			// Add custom headers
-			$headers = '';
-			foreach(OC_Util::$headers as $header) {
-				$headers .= '<'.\OCP\Util::sanitizeHTML($header['tag']);
-				if ( strcasecmp($header['tag'], 'script') === 0 && in_array('src', array_map('strtolower', array_keys($header['attributes']))) ) {
-					$headers .= ' defer';
-				}
-				foreach($header['attributes'] as $name=>$value) {
-					$headers .= ' '.\OCP\Util::sanitizeHTML($name).'="'.\OCP\Util::sanitizeHTML($value).'"';
-				}
-				if ($header['text'] !== null) {
-					$headers .= '>'.\OCP\Util::sanitizeHTML($header['text']).'</'.\OCP\Util::sanitizeHTML($header['tag']).'>';
-				} else {
-					$headers .= '/>';
-				}
-			}
-
-			$page->assign('headers', $headers);
-
-			$page->assign('content', $data);
-			return $page->fetchPage($additionalParams);
-		}
-
-		return $data;
-	}
-
-	/**
-	 * Include template
-	 *
-	 * @param string $file
-	 * @param array|null $additionalParams
-	 * @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 - needs to be properly escape
-	 * @param int $statusCode
-	 * @suppress PhanAccessMethodInternal
-	 */
-	public static function printErrorPage( $error_msg, $hint = '', $statusCode = 500) {
-		if (\OC::$server->getAppManager()->isEnabledForUser('theming') && !\OC_App::isAppLoaded('theming')) {
-			\OC_App::loadApp('theming');
-		}
-
-
-		if ($error_msg === $hint) {
-			// If the hint is the same as the message there is no need to display it twice.
-			$hint = '';
-		}
-
-		http_response_code($statusCode);
-		try {
-			$content = new \OC_Template( '', 'error', 'error', false );
-			$errors = array(array('error' => $error_msg, 'hint' => $hint));
-			$content->assign( 'errors', $errors );
-			$content->printPage();
-		} catch (\Exception $e) {
-			$logger = \OC::$server->getLogger();
-			$logger->error("$error_msg $hint", ['app' => 'core']);
-			$logger->logException($e, ['app' => 'core']);
-
-			header('Content-Type: text/plain; charset=utf-8');
-			print("$error_msg $hint");
-		}
-		die();
-	}
-
-	/**
-	 * print error page using Exception details
-	 * @param Exception|Throwable $exception
-	 * @param int $statusCode
-	 * @return bool|string
-	 * @suppress PhanAccessMethodInternal
-	 */
-	public static function printExceptionErrorPage($exception, $statusCode = 503) {
-		http_response_code($statusCode);
-		try {
-			$request = \OC::$server->getRequest();
-			$content = new \OC_Template('', 'exception', 'error', false);
-			$content->assign('errorClass', get_class($exception));
-			$content->assign('errorMsg', $exception->getMessage());
-			$content->assign('errorCode', $exception->getCode());
-			$content->assign('file', $exception->getFile());
-			$content->assign('line', $exception->getLine());
-			$content->assign('trace', $exception->getTraceAsString());
-			$content->assign('debugMode', \OC::$server->getSystemConfig()->getValue('debug', false));
-			$content->assign('remoteAddr', $request->getRemoteAddress());
-			$content->assign('requestID', $request->getId());
-			$content->printPage();
-		} catch (\Exception $e) {
-			try {
-				$logger = \OC::$server->getLogger();
-				$logger->logException($exception, ['app' => 'core']);
-				$logger->logException($e, ['app' => 'core']);
-			} catch (Throwable $e) {
-				// no way to log it properly - but to avoid a white page of death we send some output
-				header('Content-Type: text/plain; charset=utf-8');
-				print("Internal Server Error\n\n");
-				print("The server encountered an internal error and was unable to complete your request.\n");
-				print("Please contact the server administrator if this error reappears multiple times, please include the technical details below in your report.\n");
-				print("More details can be found in the server log.\n");
-
-				// and then throw it again to log it at least to the web server error log
-				throw $e;
-			}
-
-			header('Content-Type: text/plain; charset=utf-8');
-			print("Internal Server Error\n\n");
-			print("The server encountered an internal error and was unable to complete your request.\n");
-			print("Please contact the server administrator if this error reappears multiple times, please include the technical details below in your report.\n");
-			print("More details can be found in the server log.\n");
-		}
-		die();
-	}
+    /** @var string */
+    private $renderAs; // Create a full page?
+
+    /** @var string */
+    private $path; // The path to the template
+
+    /** @var array */
+    private $headers = array(); //custom headers
+
+    /** @var string */
+    protected $app; // app id
+
+    protected static $initTemplateEngineFirstRun = true;
+
+    /**
+     * Constructor
+     *
+     * @param string $app app providing the template
+     * @param string $name of the template file (without suffix)
+     * @param string $renderAs 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".
+     * @param bool $registerCall = true
+     */
+    public function __construct( $app, $name, $renderAs = "", $registerCall = true ) {
+        // Read the selected theme from the config file
+        self::initTemplateEngine($renderAs);
+
+        $theme = OC_Util::getTheme();
+
+        $requestToken = (OC::$server->getSession() && $registerCall) ? \OCP\Util::callRegister() : '';
+
+        $parts = explode('/', $app); // fix translation when app is something like core/lostpassword
+        $l10n = \OC::$server->getL10N($parts[0]);
+        /** @var \OCP\Defaults $themeDefaults */
+        $themeDefaults = \OC::$server->query(\OCP\Defaults::class);
+
+        list($path, $template) = $this->findTemplate($theme, $app, $name);
+
+        // Set the private data
+        $this->renderAs = $renderAs;
+        $this->path = $path;
+        $this->app = $app;
+
+        parent::__construct($template, $requestToken, $l10n, $themeDefaults);
+    }
+
+    /**
+     * @param string $renderAs
+     */
+    public static function initTemplateEngine($renderAs) {
+        if (self::$initTemplateEngineFirstRun){
+
+            //apps that started before the template initialization can load their own scripts/styles
+            //so to make sure this scripts/styles here are loaded first we use OC_Util::addScript() with $prepend=true
+            //meaning the last script/style in this list will be loaded first
+            if (\OC::$server->getSystemConfig()->getValue ('installed', false) && $renderAs !== 'error' && !\OCP\Util::needUpgrade()) {
+                if (\OC::$server->getConfig ()->getAppValue ( 'core', 'backgroundjobs_mode', 'ajax' ) == 'ajax') {
+                    OC_Util::addScript ( 'backgroundjobs', null, true );
+                }
+            }
+
+            OC_Util::addStyle('css-variables', null, true);
+            OC_Util::addStyle('server', null, true);
+            OC_Util::addStyle('jquery-ui-fixes',null,true);
+            OC_Util::addVendorStyle('jquery-ui/themes/base/jquery-ui',null,true);
+            OC_Util::addVendorStyle('select2/select2', null, true);
+            OC_Util::addStyle('jquery.ocdialog');
+            OC_Util::addTranslations("core", null, true);
+            OC_Util::addStyle('search', 'results');
+            OC_Util::addScript('search', 'search', true);
+            OC_Util::addScript('search', 'searchprovider');
+            OC_Util::addScript('merged-template-prepend', null, true);
+            OC_Util::addScript('jquery-ui-fixes');
+            OC_Util::addScript('files/fileinfo');
+            OC_Util::addScript('files/client');
+            OC_Util::addScript('contactsmenu');
+
+            if (\OC::$server->getConfig()->getSystemValue('debug')) {
+                // Add the stuff we need always
+                // following logic will import all vendor libraries that are
+                // specified in core/js/core.json
+                $fileContent = file_get_contents(OC::$SERVERROOT . '/core/js/core.json');
+                if($fileContent !== false) {
+                    $coreDependencies = json_decode($fileContent, true);
+                    foreach(array_reverse($coreDependencies['vendor']) as $vendorLibrary) {
+                        //remove trailing ".js" as addVendorScript will append it
+                        OC_Util::addVendorScript(
+                            substr($vendorLibrary, 0, -3),null,true);
+                        }
+                    } else {
+                    throw new \Exception('Cannot read core/js/core.json');
+                }
+            } else {
+                // Import all (combined) default vendor libraries
+                OC_Util::addVendorScript('core', null, true);
+            }
+
+            if (\OC::$server->getRequest()->isUserAgent([\OC\AppFramework\Http\Request::USER_AGENT_IE])) {
+                // polyfill for btoa/atob for IE friends
+                OC_Util::addVendorScript('base64/base64');
+                // shim for the davclient.js library
+                \OCP\Util::addScript('files/iedavclient');
+            }
+
+            self::$initTemplateEngineFirstRun = false;
+        }
+
+    }
+
+
+    /**
+     * 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.
+     * Checking all the possible locations.
+     * @param string $theme
+     * @param string $app
+     * @return string[]
+     */
+    protected function findTemplate($theme, $app, $name) {
+        // 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( $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. If $text is null then the
+     * element will be written as empty element. So use "" to get a closing tag.
+     */
+    public function addHeader($tag, $attributes, $text=null) {
+        $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($additionalParams = null) {
+        $data = parent::fetchPage($additionalParams);
+
+        if( $this->renderAs ) {
+            $page = new TemplateLayout($this->renderAs, $this->app);
+
+            if(is_array($additionalParams)) {
+                foreach ($additionalParams as $key => $value) {
+                    $page->assign($key, $value);
+                }
+            }
+
+            // Add custom headers
+            $headers = '';
+            foreach(OC_Util::$headers as $header) {
+                $headers .= '<'.\OCP\Util::sanitizeHTML($header['tag']);
+                if ( strcasecmp($header['tag'], 'script') === 0 && in_array('src', array_map('strtolower', array_keys($header['attributes']))) ) {
+                    $headers .= ' defer';
+                }
+                foreach($header['attributes'] as $name=>$value) {
+                    $headers .= ' '.\OCP\Util::sanitizeHTML($name).'="'.\OCP\Util::sanitizeHTML($value).'"';
+                }
+                if ($header['text'] !== null) {
+                    $headers .= '>'.\OCP\Util::sanitizeHTML($header['text']).'</'.\OCP\Util::sanitizeHTML($header['tag']).'>';
+                } else {
+                    $headers .= '/>';
+                }
+            }
+
+            $page->assign('headers', $headers);
+
+            $page->assign('content', $data);
+            return $page->fetchPage($additionalParams);
+        }
+
+        return $data;
+    }
+
+    /**
+     * Include template
+     *
+     * @param string $file
+     * @param array|null $additionalParams
+     * @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 - needs to be properly escape
+     * @param int $statusCode
+     * @suppress PhanAccessMethodInternal
+     */
+    public static function printErrorPage( $error_msg, $hint = '', $statusCode = 500) {
+        if (\OC::$server->getAppManager()->isEnabledForUser('theming') && !\OC_App::isAppLoaded('theming')) {
+            \OC_App::loadApp('theming');
+        }
+
+
+        if ($error_msg === $hint) {
+            // If the hint is the same as the message there is no need to display it twice.
+            $hint = '';
+        }
+
+        http_response_code($statusCode);
+        try {
+            $content = new \OC_Template( '', 'error', 'error', false );
+            $errors = array(array('error' => $error_msg, 'hint' => $hint));
+            $content->assign( 'errors', $errors );
+            $content->printPage();
+        } catch (\Exception $e) {
+            $logger = \OC::$server->getLogger();
+            $logger->error("$error_msg $hint", ['app' => 'core']);
+            $logger->logException($e, ['app' => 'core']);
+
+            header('Content-Type: text/plain; charset=utf-8');
+            print("$error_msg $hint");
+        }
+        die();
+    }
+
+    /**
+     * print error page using Exception details
+     * @param Exception|Throwable $exception
+     * @param int $statusCode
+     * @return bool|string
+     * @suppress PhanAccessMethodInternal
+     */
+    public static function printExceptionErrorPage($exception, $statusCode = 503) {
+        http_response_code($statusCode);
+        try {
+            $request = \OC::$server->getRequest();
+            $content = new \OC_Template('', 'exception', 'error', false);
+            $content->assign('errorClass', get_class($exception));
+            $content->assign('errorMsg', $exception->getMessage());
+            $content->assign('errorCode', $exception->getCode());
+            $content->assign('file', $exception->getFile());
+            $content->assign('line', $exception->getLine());
+            $content->assign('trace', $exception->getTraceAsString());
+            $content->assign('debugMode', \OC::$server->getSystemConfig()->getValue('debug', false));
+            $content->assign('remoteAddr', $request->getRemoteAddress());
+            $content->assign('requestID', $request->getId());
+            $content->printPage();
+        } catch (\Exception $e) {
+            try {
+                $logger = \OC::$server->getLogger();
+                $logger->logException($exception, ['app' => 'core']);
+                $logger->logException($e, ['app' => 'core']);
+            } catch (Throwable $e) {
+                // no way to log it properly - but to avoid a white page of death we send some output
+                header('Content-Type: text/plain; charset=utf-8');
+                print("Internal Server Error\n\n");
+                print("The server encountered an internal error and was unable to complete your request.\n");
+                print("Please contact the server administrator if this error reappears multiple times, please include the technical details below in your report.\n");
+                print("More details can be found in the server log.\n");
+
+                // and then throw it again to log it at least to the web server error log
+                throw $e;
+            }
+
+            header('Content-Type: text/plain; charset=utf-8');
+            print("Internal Server Error\n\n");
+            print("The server encountered an internal error and was unable to complete your request.\n");
+            print("Please contact the server administrator if this error reappears multiple times, please include the technical details below in your report.\n");
+            print("More details can be found in the server log.\n");
+        }
+        die();
+    }
 }

index.php

Indentation +33 added lines, -33 removed lines

@@ -37,48 +37,48 @@
 
 try {
 
-	require_once __DIR__ . '/lib/base.php';
+    require_once __DIR__ . '/lib/base.php';
 
-	OC::handleRequest();
+    OC::handleRequest();
 
 } catch(\OC\ServiceUnavailableException $ex) {
-	\OC::$server->getLogger()->logException($ex, array('app' => 'index'));
+    \OC::$server->getLogger()->logException($ex, array('app' => 'index'));
 
-	//show the user a detailed error page
-	OC_Template::printExceptionErrorPage($ex, 503);
+    //show the user a detailed error page
+    OC_Template::printExceptionErrorPage($ex, 503);
 } catch (\OC\HintException $ex) {
-	try {
-		OC_Template::printErrorPage($ex->getMessage(), $ex->getHint(), 503);
-	} catch (Exception $ex2) {
-		try {
-			\OC::$server->getLogger()->logException($ex, array('app' => 'index'));
-			\OC::$server->getLogger()->logException($ex2, array('app' => 'index'));
-		} catch (Throwable $e) {
-			// no way to log it properly - but to avoid a white page of death we try harder and ignore this one here
-		}
+    try {
+        OC_Template::printErrorPage($ex->getMessage(), $ex->getHint(), 503);
+    } catch (Exception $ex2) {
+        try {
+            \OC::$server->getLogger()->logException($ex, array('app' => 'index'));
+            \OC::$server->getLogger()->logException($ex2, array('app' => 'index'));
+        } catch (Throwable $e) {
+            // no way to log it properly - but to avoid a white page of death we try harder and ignore this one here
+        }
 
-		//show the user a detailed error page
-		OC_Template::printExceptionErrorPage($ex, 500);
-	}
+        //show the user a detailed error page
+        OC_Template::printExceptionErrorPage($ex, 500);
+    }
 } catch (\OC\User\LoginException $ex) {
-	OC_Template::printErrorPage($ex->getMessage(), $ex->getMessage(), 403);
+    OC_Template::printErrorPage($ex->getMessage(), $ex->getMessage(), 403);
 } catch (Exception $ex) {
-	\OC::$server->getLogger()->logException($ex, array('app' => 'index'));
+    \OC::$server->getLogger()->logException($ex, array('app' => 'index'));
 
-	//show the user a detailed error page
-	OC_Template::printExceptionErrorPage($ex, 500);
+    //show the user a detailed error page
+    OC_Template::printExceptionErrorPage($ex, 500);
 } catch (Error $ex) {
-	try {
-		\OC::$server->getLogger()->logException($ex, array('app' => 'index'));
-	} catch (Error $e) {
-		http_response_code(500);
-		header('Content-Type: text/plain; charset=utf-8');
-		print("Internal Server Error\n\n");
-		print("The server encountered an internal error and was unable to complete your request.\n");
-		print("Please contact the server administrator if this error reappears multiple times, please include the technical details below in your report.\n");
-		print("More details can be found in the webserver log.\n");
+    try {
+        \OC::$server->getLogger()->logException($ex, array('app' => 'index'));
+    } catch (Error $e) {
+        http_response_code(500);
+        header('Content-Type: text/plain; charset=utf-8');
+        print("Internal Server Error\n\n");
+        print("The server encountered an internal error and was unable to complete your request.\n");
+        print("Please contact the server administrator if this error reappears multiple times, please include the technical details below in your report.\n");
+        print("More details can be found in the webserver log.\n");
 
-		throw $e;
-	}
-	OC_Template::printExceptionErrorPage($ex, 500);
+        throw $e;
+    }
+    OC_Template::printExceptionErrorPage($ex, 500);
 }