* @author Bart Visscher * @author Christopher Schäpers * @author Clark Tomlinson * @author Hendrik Leppelsack * @author Joas Schilling * @author Jörn Friedrich Dreyer * @author Lukas Reschke * @author Michael Gapczynski * @author Morris Jobke * @author Remco Brenninkmeijer * @author Robin Appelman * @author Robin McCorkell * @author Roeland Jago Douma * @author Thomas Müller * @author Victor Dubiniuk * * @copyright Copyright (c) 2016, ownCloud, Inc. * @license AGPL-3.0 * * This code is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License, version 3, * as published by the Free Software Foundation. * * This program 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, version 3, * along with this program. If not, see * */ namespace OC; use Assetic\Asset\AssetCollection; use Assetic\Asset\FileAsset; use Assetic\AssetWriter; use Assetic\Filter\CssImportFilter; use Assetic\Filter\CssMinFilter; use Assetic\Filter\CssRewriteFilter; use Assetic\Filter\JSqueezeFilter; use Assetic\Filter\SeparatorFilter; class TemplateLayout extends \OC_Template { private static $versionHash = ''; /** * @var \OCP\IConfig */ private $config; /** * @param string $renderAs * @param string $appId application id */ public function __construct( $renderAs, $appId = '' ) { // yes - should be injected .... $this->config = \OC::$server->getConfig(); // Decide which page we show if($renderAs == 'user') { parent::__construct( 'core', 'layout.user' ); if(in_array(\OC_App::getCurrentApp(), ['settings','admin', 'help']) !== false) { $this->assign('bodyid', 'body-settings'); }else{ $this->assign('bodyid', 'body-user'); } // Code integrity notification $integrityChecker = \OC::$server->getIntegrityCodeChecker(); if(\OC_User::isAdminUser(\OC_User::getUser()) && !$integrityChecker->hasPassedCheck()) { \OCP\Util::addScript('core', 'integritycheck-failed-notification'); } // Add navigation entry $this->assign( 'application', ''); $this->assign( 'appid', $appId ); $navigation = \OC_App::getNavigation(); $this->assign( 'navigation', $navigation); $settingsNavigation = \OC_App::getSettingsNavigation(); $this->assign( 'settingsnavigation', $settingsNavigation); foreach($navigation as $entry) { if ($entry['active']) { $this->assign( 'application', $entry['name'] ); break; } } foreach($settingsNavigation as $entry) { if ($entry['active']) { $this->assign( 'application', $entry['name'] ); break; } } $userDisplayName = \OC_User::getDisplayName(); $appsMgmtActive = strpos(\OC::$server->getRequest()->getRequestUri(), \OC::$server->getURLGenerator()->linkToRoute('settings.AppSettings.viewApps')) === 0; if ($appsMgmtActive) { $l = \OC::$server->getL10N('lib'); $this->assign('application', $l->t('Apps')); } $this->assign('user_displayname', $userDisplayName); $this->assign('user_uid', \OC_User::getUser()); $this->assign('appsmanagement_active', $appsMgmtActive); $this->assign('enableAvatars', $this->config->getSystemValue('enable_avatars', true) === true); if (\OC_User::getUser() === false) { $this->assign('userAvatarSet', false); } else { $this->assign('userAvatarSet', \OC::$server->getAvatarManager()->getAvatar(\OC_User::getUser())->exists()); } } else if ($renderAs == 'error') { parent::__construct('core', 'layout.guest', '', false); $this->assign('bodyid', 'body-login'); } else if ($renderAs == 'guest') { parent::__construct('core', 'layout.guest'); $this->assign('bodyid', 'body-login'); } else { parent::__construct('core', 'layout.base'); } // Send the language to our layouts $this->assign('language', \OC_L10N::findLanguage()); if(\OC::$server->getSystemConfig()->getValue('installed', false)) { if (empty(self::$versionHash)) { $v = \OC_App::getAppVersions(); $v['core'] = implode('.', \OCP\Util::getVersion()); self::$versionHash = md5(implode(',', $v)); } } else { self::$versionHash = md5('not installed'); } $useAssetPipeline = self::isAssetPipelineEnabled(); if ($useAssetPipeline) { $this->append( 'jsfiles', \OC::$server->getURLGenerator()->linkToRoute('js_config', ['v' => self::$versionHash])); $this->generateAssets(); } else { // Add the js files $jsFiles = self::findJavascriptFiles(\OC_Util::$scripts); $this->assign('jsfiles', array()); if ($this->config->getSystemValue('installed', false) && $renderAs != 'error') { $this->append( 'jsfiles', \OC::$server->getURLGenerator()->linkToRoute('js_config', ['v' => self::$versionHash])); } foreach($jsFiles as $info) { $web = $info[1]; $file = $info[2]; $this->append( 'jsfiles', $web.'/'.$file . '?v=' . self::$versionHash); } // Add the css files $cssFiles = self::findStylesheetFiles(\OC_Util::$styles); $this->assign('cssfiles', array()); $this->assign('printcssfiles', []); foreach($cssFiles as $info) { $web = $info[1]; $file = $info[2]; if (substr($file, -strlen('print.css')) === 'print.css') { $this->append( 'printcssfiles', $web.'/'.$file . '?v=' . self::$versionHash); } else { $this->append( 'cssfiles', $web.'/'.$file . '?v=' . self::$versionHash); } } } } /** * @param array $styles * @return array */ static public function findStylesheetFiles($styles) { // Read the selected theme from the config file $theme = \OC_Util::getTheme(); $locator = new \OC\Template\CSSResourceLocator( \OC::$server->getLogger(), $theme, array( \OC::$SERVERROOT => \OC::$WEBROOT ), array( \OC::$SERVERROOT => \OC::$WEBROOT )); $locator->find($styles); return $locator->getResources(); } /** * @param array $scripts * @return array */ static public function findJavascriptFiles($scripts) { // Read the selected theme from the config file $theme = \OC_Util::getTheme(); $locator = new \OC\Template\JSResourceLocator( \OC::$server->getLogger(), $theme, array( \OC::$SERVERROOT => \OC::$WEBROOT ), array( \OC::$SERVERROOT => \OC::$WEBROOT )); $locator->find($scripts); return $locator->getResources(); } public function generateAssets() { $assetDir = \OC::$server->getConfig()->getSystemValue('assetdirectory', \OC::$SERVERROOT); $jsFiles = self::findJavascriptFiles(\OC_Util::$scripts); $jsHash = self::hashFileNames($jsFiles); if (!file_exists("$assetDir/assets/$jsHash.js")) { $jsFiles = array_map(function ($item) { $root = $item[0]; $file = $item[2]; // no need to minifiy minified files if (substr($file, -strlen('.min.js')) === '.min.js') { return new FileAsset($root . '/' . $file, array( new SeparatorFilter(';') ), $root, $file); } return new FileAsset($root . '/' . $file, array( new JSqueezeFilter(), new SeparatorFilter(';') ), $root, $file); }, $jsFiles); $jsCollection = new AssetCollection($jsFiles); $jsCollection->setTargetPath("assets/$jsHash.js"); $writer = new AssetWriter($assetDir); $writer->writeAsset($jsCollection); } $cssFiles = self::findStylesheetFiles(\OC_Util::$styles); // differentiate between screen stylesheets and printer stylesheets $screenCssFiles = array_filter($cssFiles, function($cssFile) { return substr_compare($cssFile[2], 'print.css', -strlen('print.css')) !== 0; }); $screenCssAsset = $this->generateCssAsset($screenCssFiles); $printCssFiles = array_filter($cssFiles, function($cssFile) { return substr_compare($cssFile[2], 'print.css', -strlen('print.css')) === 0; }); $printCssAsset = $this->generateCssAsset($printCssFiles); $this->append('jsfiles', \OC::$server->getURLGenerator()->linkTo('assets', "$jsHash.js")); $this->append('cssfiles', $screenCssAsset); $this->append('printcssfiles', $printCssAsset); } /** * generates a single css asset file from an array of css files if at least one of them has changed * otherwise it just returns the path to the old asset file * @param $files * @return string */ private function generateCssAsset($files) { $assetDir = \OC::$server->getConfig()->getSystemValue('assetdirectory', \OC::$SERVERROOT); $hash = self::hashFileNames($files); if (!file_exists("$assetDir/assets/$hash.css")) { $files = array_map(function ($item) { $root = $item[0]; $file = $item[2]; $assetPath = $root . '/' . $file; $sourceRoot = \OC::$SERVERROOT; $sourcePath = substr($assetPath, strlen(\OC::$SERVERROOT)); return new FileAsset( $assetPath, array( new CssRewriteFilter(), new CssMinFilter(), new CssImportFilter() ), $sourceRoot, $sourcePath ); }, $files); $cssCollection = new AssetCollection($files); $cssCollection->setTargetPath("assets/$hash.css"); $writer = new AssetWriter($assetDir); $writer->writeAsset($cssCollection); } return \OC::$server->getURLGenerator()->linkTo('assets', "$hash.css"); } /** * Converts the absolute file path to a relative path from \OC::$SERVERROOT * @param string $filePath Absolute path * @return string Relative path * @throws \Exception If $filePath is not under \OC::$SERVERROOT */ public static function convertToRelativePath($filePath) { $relativePath = explode(\OC::$SERVERROOT, $filePath); if(count($relativePath) !== 2) { throw new \Exception('$filePath is not under the \OC::$SERVERROOT'); } return $relativePath[1]; } /** * @param array $files * @return string */ private static function hashFileNames($files) { foreach($files as $i => $file) { try { $files[$i] = self::convertToRelativePath($file[0]).'/'.$file[2]; } catch (\Exception $e) { $files[$i] = $file[0].'/'.$file[2]; } } sort($files); // include the apps' versions hash to invalidate the cached assets $files[] = self::$versionHash; return hash('md5', implode('', $files)); } }