You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
512 lines
15 KiB
512 lines
15 KiB
<?php |
|
/** |
|
* @copyright Copyright (c) 2016, John Molakvoæ (skjnldsv@protonmail.com) |
|
* |
|
* @author John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com> |
|
* @author Julius Haertl <jus@bitgrid.net> |
|
* @author Julius Härtl <jus@bitgrid.net> |
|
* @author Lukas Reschke <lukas@statuscode.ch> |
|
* @author Morris Jobke <hey@morrisjobke.de> |
|
* @author Roeland Jago Douma <roeland@famdouma.nl> |
|
* |
|
* @license GNU AGPL version 3 or any later version |
|
* |
|
* This program is free software: you can redistribute it and/or modify |
|
* it under the terms of the GNU Affero General Public License as |
|
* published by the Free Software Foundation, either version 3 of the |
|
* License, or (at your option) any later version. |
|
* |
|
* 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 |
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
* |
|
*/ |
|
|
|
namespace OC\Template; |
|
|
|
use Leafo\ScssPhp\Compiler; |
|
use Leafo\ScssPhp\Exception\ParserException; |
|
use Leafo\ScssPhp\Formatter\Crunched; |
|
use Leafo\ScssPhp\Formatter\Expanded; |
|
use OC\Memcache\NullCache; |
|
use OCP\AppFramework\Utility\ITimeFactory; |
|
use OCP\Files\IAppData; |
|
use OCP\Files\NotFoundException; |
|
use OCP\Files\NotPermittedException; |
|
use OCP\Files\SimpleFS\ISimpleFile; |
|
use OCP\Files\SimpleFS\ISimpleFolder; |
|
use OCP\ICache; |
|
use OCP\ICacheFactory; |
|
use OCP\IConfig; |
|
use OCP\ILogger; |
|
use OCP\IMemcache; |
|
use OCP\IURLGenerator; |
|
use OC\Files\AppData\Factory; |
|
use OC\Template\IconsCacher; |
|
|
|
class SCSSCacher { |
|
|
|
/** @var ILogger */ |
|
protected $logger; |
|
|
|
/** @var IAppData */ |
|
protected $appData; |
|
|
|
/** @var IURLGenerator */ |
|
protected $urlGenerator; |
|
|
|
/** @var IConfig */ |
|
protected $config; |
|
|
|
/** @var \OC_Defaults */ |
|
private $defaults; |
|
|
|
/** @var string */ |
|
protected $serverRoot; |
|
|
|
/** @var ICache */ |
|
protected $depsCache; |
|
|
|
/** @var null|string */ |
|
private $injectedVariables; |
|
|
|
/** @var ICacheFactory */ |
|
private $cacheFactory; |
|
|
|
/** @var IconsCacher */ |
|
private $iconsCacher; |
|
|
|
/** @var ICache */ |
|
private $isCachedCache; |
|
|
|
/** @var ITimeFactory */ |
|
private $timeFactory; |
|
|
|
/** @var IMemcache */ |
|
private $lockingCache; |
|
|
|
/** |
|
* @param ILogger $logger |
|
* @param Factory $appDataFactory |
|
* @param IURLGenerator $urlGenerator |
|
* @param IConfig $config |
|
* @param \OC_Defaults $defaults |
|
* @param string $serverRoot |
|
* @param ICacheFactory $cacheFactory |
|
* @param IconsCacher $iconsCacher |
|
* @param ITimeFactory $timeFactory |
|
*/ |
|
public function __construct(ILogger $logger, |
|
Factory $appDataFactory, |
|
IURLGenerator $urlGenerator, |
|
IConfig $config, |
|
\OC_Defaults $defaults, |
|
$serverRoot, |
|
ICacheFactory $cacheFactory, |
|
IconsCacher $iconsCacher, |
|
ITimeFactory $timeFactory) { |
|
$this->logger = $logger; |
|
$this->appData = $appDataFactory->get('css'); |
|
$this->urlGenerator = $urlGenerator; |
|
$this->config = $config; |
|
$this->defaults = $defaults; |
|
$this->serverRoot = $serverRoot; |
|
$this->cacheFactory = $cacheFactory; |
|
$this->depsCache = $cacheFactory->createDistributed('SCSS-deps-' . md5($this->urlGenerator->getBaseUrl())); |
|
$this->isCachedCache = $cacheFactory->createDistributed('SCSS-cached-' . md5($this->urlGenerator->getBaseUrl())); |
|
$lockingCache = $cacheFactory->createDistributed('SCSS-locks-' . md5($this->urlGenerator->getBaseUrl())); |
|
if (!($lockingCache instanceof IMemcache)) { |
|
$lockingCache = new NullCache(); |
|
} |
|
$this->lockingCache = $lockingCache; |
|
$this->iconsCacher = $iconsCacher; |
|
$this->timeFactory = $timeFactory; |
|
} |
|
|
|
/** |
|
* Process the caching process if needed |
|
* |
|
* @param string $root Root path to the nextcloud installation |
|
* @param string $file |
|
* @param string $app The app name |
|
* @return boolean |
|
* @throws NotPermittedException |
|
*/ |
|
public function process(string $root, string $file, string $app): bool { |
|
$path = explode('/', $root . '/' . $file); |
|
|
|
$fileNameSCSS = array_pop($path); |
|
$fileNameCSS = $this->prependVersionPrefix($this->prependBaseurlPrefix(str_replace('.scss', '.css', $fileNameSCSS)), $app); |
|
|
|
$path = implode('/', $path); |
|
$webDir = $this->getWebDir($path, $app, $this->serverRoot, \OC::$WEBROOT); |
|
|
|
if (!$this->variablesChanged() && $this->isCached($fileNameCSS, $app)) { |
|
// Inject icons vars css if any |
|
return $this->injectCssVariablesIfAny(); |
|
} |
|
|
|
try { |
|
$folder = $this->appData->getFolder($app); |
|
} catch (NotFoundException $e) { |
|
// creating css appdata folder |
|
$folder = $this->appData->newFolder($app); |
|
} |
|
|
|
$lockKey = $webDir . '/' . $fileNameSCSS; |
|
|
|
if (!$this->lockingCache->add($lockKey, 'locked!', 120)) { |
|
$retry = 0; |
|
sleep(1); |
|
while ($retry < 10) { |
|
if (!$this->variablesChanged() && $this->isCached($fileNameCSS, $app)) { |
|
// Inject icons vars css if any |
|
$this->lockingCache->remove($lockKey); |
|
$this->logger->debug('SCSSCacher: ' .$lockKey.' is now available after '.$retry.'s. Moving on...', ['app' => 'core']); |
|
return $this->injectCssVariablesIfAny(); |
|
} |
|
$this->logger->debug('SCSSCacher: scss cache file locked for '.$lockKey, ['app' => 'core']); |
|
sleep($retry); |
|
$retry++; |
|
} |
|
$this->logger->debug('SCSSCacher: Giving up scss caching for '.$lockKey, ['app' => 'core']); |
|
return false; |
|
} |
|
|
|
try { |
|
$cached = $this->cache($path, $fileNameCSS, $fileNameSCSS, $folder, $webDir); |
|
} catch (\Exception $e) { |
|
$this->lockingCache->remove($lockKey); |
|
throw $e; |
|
} |
|
|
|
// Cleaning lock |
|
$this->lockingCache->remove($lockKey); |
|
|
|
// Inject icons vars css if any |
|
if ($this->iconsCacher->getCachedCSS() && $this->iconsCacher->getCachedCSS()->getSize() > 0) { |
|
$this->iconsCacher->injectCss(); |
|
} |
|
|
|
return $cached; |
|
} |
|
|
|
/** |
|
* @param $appName |
|
* @param $fileName |
|
* @return ISimpleFile |
|
*/ |
|
public function getCachedCSS(string $appName, string $fileName): ISimpleFile { |
|
$folder = $this->appData->getFolder($appName); |
|
$cachedFileName = $this->prependVersionPrefix($this->prependBaseurlPrefix($fileName), $appName); |
|
|
|
return $folder->getFile($cachedFileName); |
|
} |
|
|
|
/** |
|
* Check if the file is cached or not |
|
* @param string $fileNameCSS |
|
* @param string $app |
|
* @return boolean |
|
*/ |
|
private function isCached(string $fileNameCSS, string $app) { |
|
$key = $this->config->getSystemValue('version') . '/' . $app . '/' . $fileNameCSS; |
|
|
|
// If the file mtime is more recent than our cached one, |
|
// let's consider the file is properly cached |
|
if ($cacheValue = $this->isCachedCache->get($key)) { |
|
if ($cacheValue > $this->timeFactory->getTime()) { |
|
return true; |
|
} |
|
} |
|
|
|
// Creating file cache if none for further checks |
|
try { |
|
$folder = $this->appData->getFolder($app); |
|
} catch (NotFoundException $e) { |
|
return false; |
|
} |
|
|
|
// Checking if file size is coherent |
|
// and if one of the css dependency changed |
|
try { |
|
$cachedFile = $folder->getFile($fileNameCSS); |
|
if ($cachedFile->getSize() > 0) { |
|
$depFileName = $fileNameCSS . '.deps'; |
|
$deps = $this->depsCache->get($folder->getName() . '-' . $depFileName); |
|
if ($deps === null) { |
|
$depFile = $folder->getFile($depFileName); |
|
$deps = $depFile->getContent(); |
|
// Set to memcache for next run |
|
$this->depsCache->set($folder->getName() . '-' . $depFileName, $deps); |
|
} |
|
$deps = json_decode($deps, true); |
|
|
|
foreach ((array) $deps as $file => $mtime) { |
|
if (!file_exists($file) || filemtime($file) > $mtime) { |
|
return false; |
|
} |
|
} |
|
|
|
$this->isCachedCache->set($key, $this->timeFactory->getTime() + 5 * 60); |
|
return true; |
|
} |
|
|
|
return false; |
|
} catch (NotFoundException $e) { |
|
return false; |
|
} |
|
} |
|
|
|
/** |
|
* Check if the variables file has changed |
|
* @return bool |
|
*/ |
|
private function variablesChanged(): bool { |
|
$injectedVariables = $this->getInjectedVariables(); |
|
if ($this->config->getAppValue('core', 'theming.variables') !== md5($injectedVariables)) { |
|
$this->config->setAppValue('core', 'theming.variables', md5($injectedVariables)); |
|
$this->resetCache(); |
|
return true; |
|
} |
|
return false; |
|
} |
|
|
|
/** |
|
* Cache the file with AppData |
|
* |
|
* @param string $path |
|
* @param string $fileNameCSS |
|
* @param string $fileNameSCSS |
|
* @param ISimpleFolder $folder |
|
* @param string $webDir |
|
* @return boolean |
|
* @throws NotPermittedException |
|
*/ |
|
private function cache(string $path, string $fileNameCSS, string $fileNameSCSS, ISimpleFolder $folder, string $webDir) { |
|
$scss = new Compiler(); |
|
$scss->setImportPaths([ |
|
$path, |
|
$this->serverRoot . '/core/css/' |
|
]); |
|
|
|
// Continue after throw |
|
$scss->setIgnoreErrors(true); |
|
if ($this->config->getSystemValue('debug')) { |
|
// Debug mode |
|
$scss->setFormatter(Expanded::class); |
|
$scss->setLineNumberStyle(Compiler::LINE_COMMENTS); |
|
} else { |
|
// Compression |
|
$scss->setFormatter(Crunched::class); |
|
} |
|
|
|
try { |
|
$cachedfile = $folder->getFile($fileNameCSS); |
|
} catch (NotFoundException $e) { |
|
$cachedfile = $folder->newFile($fileNameCSS); |
|
} |
|
|
|
$depFileName = $fileNameCSS . '.deps'; |
|
try { |
|
$depFile = $folder->getFile($depFileName); |
|
} catch (NotFoundException $e) { |
|
$depFile = $folder->newFile($depFileName); |
|
} |
|
|
|
// Compile |
|
try { |
|
$compiledScss = $scss->compile( |
|
'$webroot: \'' . $this->getRoutePrefix() . '\';' . |
|
$this->getInjectedVariables() . |
|
'@import "variables.scss";' . |
|
'@import "functions.scss";' . |
|
'@import "' . $fileNameSCSS . '";'); |
|
} catch (ParserException $e) { |
|
$this->logger->logException($e, ['app' => 'core']); |
|
|
|
return false; |
|
} |
|
|
|
// Parse Icons and create related css variables |
|
$compiledScss = $this->iconsCacher->setIconsCss($compiledScss); |
|
|
|
// Gzip file |
|
try { |
|
$gzipFile = $folder->getFile($fileNameCSS . '.gzip'); # Safari doesn't like .gz |
|
} catch (NotFoundException $e) { |
|
$gzipFile = $folder->newFile($fileNameCSS . '.gzip'); # Safari doesn't like .gz |
|
} |
|
|
|
try { |
|
$data = $this->rebaseUrls($compiledScss, $webDir); |
|
$cachedfile->putContent($data); |
|
$deps = json_encode($scss->getParsedFiles()); |
|
$depFile->putContent($deps); |
|
$this->depsCache->set($folder->getName() . '-' . $depFileName, $deps); |
|
$gzipFile->putContent(gzencode($data, 9)); |
|
$this->logger->debug('SCSSCacher: ' . $webDir . '/' . $fileNameSCSS . ' compiled and successfully cached', ['app' => 'core']); |
|
|
|
return true; |
|
} catch (NotPermittedException $e) { |
|
$this->logger->error('SCSSCacher: unable to cache: ' . $fileNameSCSS); |
|
|
|
return false; |
|
} |
|
} |
|
|
|
/** |
|
* Reset scss cache by deleting all generated css files |
|
* We need to regenerate all files when variables change |
|
*/ |
|
public function resetCache() { |
|
if (!$this->lockingCache->add('resetCache', 'locked!', 120)) { |
|
return; |
|
} |
|
$this->injectedVariables = null; |
|
|
|
// do not clear locks |
|
$this->cacheFactory->createDistributed('SCSS-deps-')->clear(); |
|
$this->cacheFactory->createDistributed('SCSS-cached-')->clear(); |
|
|
|
$appDirectory = $this->appData->getDirectoryListing(); |
|
foreach ($appDirectory as $folder) { |
|
foreach ($folder->getDirectoryListing() as $file) { |
|
try { |
|
$file->delete(); |
|
} catch (NotPermittedException $e) { |
|
$this->logger->logException($e, ['message' => 'SCSSCacher: unable to delete file: ' . $file->getName()]); |
|
} |
|
} |
|
} |
|
$this->logger->debug('SCSSCacher: css cache cleared!'); |
|
$this->lockingCache->remove('resetCache'); |
|
} |
|
|
|
/** |
|
* @return string SCSS code for variables from OC_Defaults |
|
*/ |
|
private function getInjectedVariables(): string { |
|
if ($this->injectedVariables !== null) { |
|
return $this->injectedVariables; |
|
} |
|
$variables = ''; |
|
foreach ($this->defaults->getScssVariables() as $key => $value) { |
|
$variables .= '$' . $key . ': ' . $value . ' !default;'; |
|
} |
|
|
|
// check for valid variables / otherwise fall back to defaults |
|
try { |
|
$scss = new Compiler(); |
|
$scss->compile($variables); |
|
$this->injectedVariables = $variables; |
|
} catch (ParserException $e) { |
|
$this->logger->logException($e, ['app' => 'core']); |
|
} |
|
|
|
return $variables; |
|
} |
|
|
|
/** |
|
* Add the correct uri prefix to make uri valid again |
|
* @param string $css |
|
* @param string $webDir |
|
* @return string |
|
*/ |
|
private function rebaseUrls(string $css, string $webDir): string { |
|
$re = '/url\([\'"]([^\/][\.\w?=\/-]*)[\'"]\)/x'; |
|
$subst = 'url(\'' . $webDir . '/$1\')'; |
|
|
|
return preg_replace($re, $subst, $css); |
|
} |
|
|
|
/** |
|
* Return the cached css file uri |
|
* @param string $appName the app name |
|
* @param string $fileName |
|
* @return string |
|
*/ |
|
public function getCachedSCSS(string $appName, string $fileName): string { |
|
$tmpfileLoc = explode('/', $fileName); |
|
$fileName = array_pop($tmpfileLoc); |
|
$fileName = $this->prependVersionPrefix($this->prependBaseurlPrefix(str_replace('.scss', '.css', $fileName)), $appName); |
|
|
|
return substr($this->urlGenerator->linkToRoute('core.Css.getCss', [ |
|
'fileName' => $fileName, |
|
'appName' => $appName, |
|
'v' => $this->config->getAppValue('core', 'theming.variables', '0') |
|
]), \strlen(\OC::$WEBROOT) + 1); |
|
} |
|
|
|
/** |
|
* Prepend hashed base url to the css file |
|
* @param string $cssFile |
|
* @return string |
|
*/ |
|
private function prependBaseurlPrefix(string $cssFile): string { |
|
return substr(md5($this->urlGenerator->getBaseUrl() . $this->getRoutePrefix()), 0, 4) . '-' . $cssFile; |
|
} |
|
|
|
private function getRoutePrefix() { |
|
$frontControllerActive = ($this->config->getSystemValue('htaccess.IgnoreFrontController', false) === true || getenv('front_controller_active') === 'true'); |
|
$prefix = \OC::$WEBROOT . '/index.php'; |
|
if ($frontControllerActive) { |
|
$prefix = \OC::$WEBROOT; |
|
} |
|
return $prefix; |
|
} |
|
|
|
/** |
|
* Prepend hashed app version hash |
|
* @param string $cssFile |
|
* @param string $appId |
|
* @return string |
|
*/ |
|
private function prependVersionPrefix(string $cssFile, string $appId): string { |
|
$appVersion = \OC_App::getAppVersion($appId); |
|
if ($appVersion !== '0') { |
|
return substr(md5($appVersion), 0, 4) . '-' . $cssFile; |
|
} |
|
$coreVersion = \OC_Util::getVersionString(); |
|
|
|
return substr(md5($coreVersion), 0, 4) . '-' . $cssFile; |
|
} |
|
|
|
/** |
|
* Get WebDir root |
|
* @param string $path the css file path |
|
* @param string $appName the app name |
|
* @param string $serverRoot the server root path |
|
* @param string $webRoot the nextcloud installation root path |
|
* @return string the webDir |
|
*/ |
|
private function getWebDir(string $path, string $appName, string $serverRoot, string $webRoot): string { |
|
// Detect if path is within server root AND if path is within an app path |
|
if (strpos($path, $serverRoot) === false && $appWebPath = \OC_App::getAppWebPath($appName)) { |
|
// Get the file path within the app directory |
|
$appDirectoryPath = explode($appName, $path)[1]; |
|
// Remove the webroot |
|
|
|
return str_replace($webRoot, '', $appWebPath . $appDirectoryPath); |
|
} |
|
|
|
return $webRoot . substr($path, strlen($serverRoot)); |
|
} |
|
|
|
/** |
|
* Add the icons css cache in the header if needed |
|
* |
|
* @return boolean true |
|
*/ |
|
private function injectCssVariablesIfAny() { |
|
// Inject icons vars css if any |
|
if ($this->iconsCacher->getCachedCSS() && $this->iconsCacher->getCachedCSS()->getSize() > 0) { |
|
$this->iconsCacher->injectCss(); |
|
} |
|
return true; |
|
} |
|
}
|
|
|