'OC\\Template\\JSResourceLocator' => $baseDir . '/lib/private/Template/JSResourceLocator.php',
'OC\\Template\\ResourceLocator' => $baseDir . '/lib/private/Template/ResourceLocator.php',
'OC\\Template\\ResourceNotFoundException' => $baseDir . '/lib/private/Template/ResourceNotFoundException.php',
- 'OC\\Template\\SCSSCacher' => $baseDir . '/lib/private/Template/SCSSCacher.php',
'OC\\Template\\TemplateFileLocator' => $baseDir . '/lib/private/Template/TemplateFileLocator.php',
'OC\\URLGenerator' => $baseDir . '/lib/private/URLGenerator.php',
'OC\\Updater' => $baseDir . '/lib/private/Updater.php',
'OC\\Template\\JSResourceLocator' => __DIR__ . '/../../..' . '/lib/private/Template/JSResourceLocator.php',
'OC\\Template\\ResourceLocator' => __DIR__ . '/../../..' . '/lib/private/Template/ResourceLocator.php',
'OC\\Template\\ResourceNotFoundException' => __DIR__ . '/../../..' . '/lib/private/Template/ResourceNotFoundException.php',
- 'OC\\Template\\SCSSCacher' => __DIR__ . '/../../..' . '/lib/private/Template/SCSSCacher.php',
'OC\\Template\\TemplateFileLocator' => __DIR__ . '/../../..' . '/lib/private/Template/TemplateFileLocator.php',
'OC\\URLGenerator' => __DIR__ . '/../../..' . '/lib/private/URLGenerator.php',
'OC\\Updater' => __DIR__ . '/../../..' . '/lib/private/Updater.php',
<?php return array(
'root' => array(
- 'pretty_version' => 'dev-master',
- 'version' => 'dev-master',
+ 'pretty_version' => '1.0.0+no-version-set',
+ 'version' => '1.0.0.0',
'type' => 'library',
'install_path' => __DIR__ . '/../../../',
'aliases' => array(),
- 'reference' => '4f4f8cea83a31519e55b6305c6d9471896de42be',
+ 'reference' => NULL,
'name' => '__root__',
'dev' => false,
),
'versions' => array(
'__root__' => array(
- 'pretty_version' => 'dev-master',
- 'version' => 'dev-master',
+ 'pretty_version' => '1.0.0+no-version-set',
+ 'version' => '1.0.0.0',
'type' => 'library',
'install_path' => __DIR__ . '/../../../',
'aliases' => array(),
- 'reference' => '4f4f8cea83a31519e55b6305c6d9471896de42be',
+ 'reference' => NULL,
'dev_requirement' => false,
),
),
$this->configLoaded = true;
}
-
- /**
- * Clear all the cached app config values
- *
- * WARNING: do not use this - this is only for usage with the SCSSCacher to
- * clear the memory cache of the app config
- */
- public function clearCachedConfig() {
- $this->configLoaded = false;
- }
}
use OC\Repair\RepairMimeTypes;
use OC\Repair\SqliteAutoincrement;
use OC\Template\JSCombiner;
-use OC\Template\SCSSCacher;
use OCP\AppFramework\QueryException;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\Collaboration\Resources\IManager;
\OC::$server->query(Installer::class)
),
new AddLogRotateJob(\OC::$server->getJobList()),
- new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OC::$server->query(SCSSCacher::class), \OC::$server->query(JSCombiner::class)),
+ new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OC::$server->query(JSCombiner::class)),
new ClearGeneratedAvatarCache(\OC::$server->getConfig(), \OC::$server->query(AvatarManager::class)),
new AddPreviewBackgroundCleanupJob(\OC::$server->getJobList()),
new AddCleanupUpdaterBackupsJob(\OC::$server->getJobList()),
namespace OC\Repair;
use OC\Template\JSCombiner;
-use OC\Template\SCSSCacher;
use OCP\ICacheFactory;
use OCP\Migration\IOutput;
use OCP\Migration\IRepairStep;
/** @var ICacheFactory */
protected $cacheFactory;
- /** @var SCSSCacher */
- protected $scssCacher;
-
/** @var JSCombiner */
protected $jsCombiner;
public function __construct(ICacheFactory $cacheFactory,
- SCSSCacher $SCSSCacher,
JSCombiner $JSCombiner) {
$this->cacheFactory = $cacheFactory;
- $this->scssCacher = $SCSSCacher;
$this->jsCombiner = $JSCombiner;
}
$c->clear();
$output->info('Image cache cleared');
- $this->scssCacher->resetCache();
- $output->info('SCSS cache cleared');
-
$this->jsCombiner->resetCache();
$output->info('JS cache cleared');
} catch (\Exception $e) {
class CSSResourceLocator extends ResourceLocator {
- /** @var SCSSCacher */
- protected $scssCacher;
-
/**
* @param string $theme
* @param array $core_map
* @param array $party_map
- * @param SCSSCacher $scssCacher
*/
- public function __construct(LoggerInterface $logger, $theme, $core_map, $party_map, $scssCacher) {
- $this->scssCacher = $scssCacher;
-
+ public function __construct(LoggerInterface $logger, $theme, $core_map, $party_map) {
parent::__construct($logger, $theme, $core_map, $party_map);
}
$app = substr($style, 0, strpos($style, '/'));
if (strpos($style, '3rdparty') === 0
&& $this->appendIfExist($this->thirdpartyroot, $style.'.css')
- || $this->cacheAndAppendScssIfExist($this->serverroot, $style.'.scss', $app)
- || $this->cacheAndAppendScssIfExist($this->serverroot, 'core/'.$style.'.scss')
|| $this->appendIfExist($this->serverroot, $style.'.css')
|| $this->appendIfExist($this->serverroot, 'core/'.$style.'.css')
) {
// turned into cwd.
$app_path = realpath($app_path);
- if (!$this->cacheAndAppendScssIfExist($app_path, $style.'.scss', $app)) {
- $this->append($app_path, $style.'.css', $app_url);
- }
+ $this->append($app_path, $style.'.css', $app_url);
}
/**
|| $this->appendIfExist($this->serverroot, $theme_dir.'core/'.$style.'.css');
}
- /**
- * cache and append the scss $file if exist at $root
- *
- * @param string $root path to check
- * @param string $file the filename
- * @return bool True if the resource was found and cached, false otherwise
- */
- protected function cacheAndAppendScssIfExist($root, $file, $app = 'core') {
- if (is_file($root.'/'.$file)) {
- if ($this->scssCacher !== null) {
- if ($this->scssCacher->process($root, $file, $app)) {
- $this->append($this->serverroot, $this->scssCacher->getCachedSCSS($app, $file), \OC::$WEBROOT, true, true);
- return true;
- } else {
- $this->logger->warning('Failed to compile and/or save '.$root.'/'.$file, ['app' => 'core']);
- return false;
- }
- } else {
- return true;
- }
- }
- return false;
- }
-
public function append($root, $file, $webRoot = null, $throw = true, $scss = false) {
if (!$scss) {
parent::append($root, $file, $webRoot, $throw);
+++ /dev/null
-<?php
-/**
- * @copyright Copyright (c) 2016, John Molakvoæ (skjnldsv@protonmail.com)
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author John Molakvoæ <skjnldsv@protonmail.com>
- * @author Julius Haertl <jus@bitgrid.net>
- * @author Julius Härtl <jus@bitgrid.net>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Roland Tapken <roland@bitarbeiter.net>
- *
- * @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 OC\AppConfig;
-use OC\Files\AppData\Factory;
-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\IMemcache;
-use OCP\IURLGenerator;
-use Psr\Log\LoggerInterface;
-use ScssPhp\ScssPhp\Compiler;
-use ScssPhp\ScssPhp\OutputStyle;
-
-class SCSSCacher {
- protected LoggerInterface $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 ICache */
- private $isCachedCache;
-
- /** @var ITimeFactory */
- private $timeFactory;
-
- /** @var IMemcache */
- private $lockingCache;
- /** @var AppConfig */
- private $appConfig;
-
- /**
- * @param string $serverRoot
- */
- public function __construct(LoggerInterface $logger,
- Factory $appDataFactory,
- IURLGenerator $urlGenerator,
- IConfig $config,
- \OC_Defaults $defaults,
- $serverRoot,
- ICacheFactory $cacheFactory,
- ITimeFactory $timeFactory,
- AppConfig $appConfig) {
- $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->timeFactory = $timeFactory;
- $this->appConfig = $appConfig;
- }
-
- /**
- * 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);
-
- $this->logger->debug('SCSSCacher::process ordinary check follows', ['app' => 'scss_cacher']);
-
- 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)) {
- $this->logger->debug('SCSSCacher::process could not get lock for ' . $lockKey . ' and will wait 10 seconds for cached file to be available', ['app' => 'scss_cacher']);
- $retry = 0;
- sleep(1);
- while ($retry < 10) {
- $this->appConfig->clearCachedConfig();
- $this->logger->debug('SCSSCacher::process check in while loop follows', ['app' => 'scss_cacher']);
- if (!$this->variablesChanged() && $this->isCached($fileNameCSS, $app)) {
- // Inject icons vars css if any
- $this->logger->debug("SCSSCacher::process cached file for app '$app' and file '$fileNameCSS' is now available after $retry s. Moving on...", ['app' => 'scss_cacher']);
- return true;
- }
- sleep(1);
- $retry++;
- }
- $this->logger->debug('SCSSCacher::process Giving up scss caching for ' . $lockKey, ['app' => 'scss_cacher']);
- return false;
- }
-
- $this->logger->debug('SCSSCacher::process Lock acquired for ' . $lockKey, ['app' => 'scss_cacher']);
- try {
- $cached = $this->cache($path, $fileNameCSS, $fileNameSCSS, $folder, $webDir);
- } catch (\Exception $e) {
- $this->lockingCache->remove($lockKey);
- throw $e;
- }
-
- // Cleaning lock
- $this->lockingCache->remove($lockKey);
- $this->logger->debug('SCSSCacher::process Lock removed for ' . $lockKey, ['app' => 'scss_cacher']);
-
- 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;
- }
- }
- $this->logger->debug("SCSSCacher::isCached $fileNameCSS isCachedCache is expired or unset", ['app' => 'scss_cacher']);
-
- // Creating file cache if none for further checks
- try {
- $folder = $this->appData->getFolder($app);
- } catch (NotFoundException $e) {
- $this->logger->debug("SCSSCacher::isCached app data folder for $app could not be fetched", ['app' => 'scss_cacher']);
- 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) {
- $this->logger->debug("SCSSCacher::isCached $fileNameCSS is not considered as cached due to deps file $file", ['app' => 'scss_cacher']);
- return false;
- }
- }
-
- $this->logger->debug("SCSSCacher::isCached $fileNameCSS dependencies successfully cached for 5 minutes", ['app' => 'scss_cacher']);
- // It would probably make sense to adjust this timeout to something higher and see if that has some effect then
- $this->isCachedCache->set($key, $this->timeFactory->getTime() + 5 * 60);
- return true;
- }
- $this->logger->debug("SCSSCacher::isCached $fileNameCSS is not considered as cached cacheValue: $cacheValue", ['app' => 'scss_cacher']);
- return false;
- } catch (NotFoundException $e) {
- $this->logger->debug("SCSSCacher::isCached NotFoundException " . $e->getMessage(), ['app' => 'scss_cacher']);
- return false;
- }
- }
-
- /**
- * Check if the variables file has changed
- * @return bool
- */
- private function variablesChanged(): bool {
- $cachedVariables = $this->config->getAppValue('core', 'theming.variables', '');
- $injectedVariables = $this->getInjectedVariables($cachedVariables);
- if ($cachedVariables !== md5($injectedVariables)) {
- $this->logger->debug('SCSSCacher::variablesChanged storedVariables: ' . json_encode($this->config->getAppValue('core', 'theming.variables')) . ' currentInjectedVariables: ' . json_encode($injectedVariables), ['app' => 'scss_cacher']);
- $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
- if ($this->config->getSystemValue('debug')) {
- // Debug mode
- $scss->setOutputStyle(OutputStyle::EXPANDED);
- } else {
- // Compression
- $scss->setOutputStyle(OutputStyle::COMPRESSED);
- }
-
- 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 (\Exception $e) {
- $this->logger->error($e->getMessage(), ['app' => 'scss_cacher', 'exception' => $e]);
-
- return false;
- }
-
- // 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::cache ' . $webDir . '/' . $fileNameSCSS . ' compiled and successfully cached', ['app' => 'scss_cacher']);
-
- return true;
- } catch (NotPermittedException $e) {
- $this->logger->error('SCSSCacher::cache unable to cache: ' . $fileNameSCSS, ['app' => 'scss_cacher']);
-
- return false;
- }
- }
-
- /**
- * Reset scss cache by deleting all generated css files
- * We need to regenerate all files when variables change
- */
- public function resetCache() {
- $this->logger->debug('SCSSCacher::resetCache', ['app' => 'scss_cacher']);
- if (!$this->lockingCache->add('resetCache', 'locked!', 120)) {
- $this->logger->debug('SCSSCacher::resetCache Locked', ['app' => 'scss_cacher']);
- return;
- }
- $this->logger->debug('SCSSCacher::resetCache Lock acquired', ['app' => 'scss_cacher']);
- $this->injectedVariables = null;
-
- // do not clear locks
- $this->depsCache->clear();
- $this->isCachedCache->clear();
-
- $appDirectory = $this->appData->getDirectoryListing();
- foreach ($appDirectory as $folder) {
- foreach ($folder->getDirectoryListing() as $file) {
- try {
- $file->delete();
- } catch (NotPermittedException $e) {
- $this->logger->error('SCSSCacher::resetCache unable to delete file: ' . $file->getName(), ['exception' => $e, 'app' => 'scss_cacher']);
- }
- }
- }
- $this->logger->debug('SCSSCacher::resetCache css cache cleared!', ['app' => 'scss_cacher']);
- $this->lockingCache->remove('resetCache');
- $this->logger->debug('SCSSCacher::resetCache Locking removed', ['app' => 'scss_cacher']);
- }
-
- /**
- * @return string SCSS code for variables from OC_Defaults
- */
- private function getInjectedVariables(string $cache = ''): string {
- if ($this->injectedVariables !== null) {
- return $this->injectedVariables;
- }
- $variables = '';
- foreach ($this->defaults->getScssVariables() as $key => $value) {
- $variables .= '$' . $key . ': ' . $value . ' !default;';
- }
-
- /*
- * If we are trying to return the same variables as that are cached
- * Then there is no need to do the compile step
- */
- if ($cache === md5($variables)) {
- $this->injectedVariables = $variables;
- return $variables;
- }
-
- // check for valid variables / otherwise fall back to defaults
- try {
- $scss = new Compiler();
- $scss->compile($variables);
- $this->injectedVariables = $variables;
- } catch (\Exception $e) {
- $this->logger->error($e->getMessage(), ['exception' => $e, 'app' => 'scss_cacher']);
- }
-
- 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));
- }
-}
use OC\Search\SearchQuery;
use OC\Template\JSCombiner;
use OC\Template\JSConfigHelper;
-use OC\Template\SCSSCacher;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\Defaults;
use OCP\IConfig;
// Read the selected theme from the config file
$theme = \OC_Util::getTheme();
- if ($compileScss) {
- $SCSSCacher = \OC::$server->query(SCSSCacher::class);
- } else {
- $SCSSCacher = null;
- }
-
$locator = new \OC\Template\CSSResourceLocator(
\OC::$server->get(LoggerInterface::class),
$theme,
[ \OC::$SERVERROOT => \OC::$WEBROOT ],
[ \OC::$SERVERROOT => \OC::$WEBROOT ],
- $SCSSCacher
);
$locator->find($styles);
return $locator->getResources();
namespace Test\Repair;
use OC\Template\JSCombiner;
-use OC\Template\SCSSCacher;
use OCP\ICache;
use OCP\ICacheFactory;
use OCP\Migration\IOutput;
/** @var ICacheFactory */
private $cacheFactory;
- /** @var SCSSCacher */
- private $scssCacher;
-
/** @var JSCombiner */
private $jsCombiner;
$this->outputMock = $this->createMock(IOutput::class);
$this->cacheFactory = $this->createMock(ICacheFactory::class);
- $this->scssCacher = $this->createMock(SCSSCacher::class);
$this->jsCombiner = $this->createMock(JSCombiner::class);
- $this->repair = new \OC\Repair\ClearFrontendCaches($this->cacheFactory, $this->scssCacher, $this->jsCombiner);
+ $this->repair = new \OC\Repair\ClearFrontendCaches($this->cacheFactory, $this->jsCombiner);
}
->with('');
$this->jsCombiner->expects($this->once())
->method('resetCache');
- $this->scssCacher->expects($this->once())
- ->method('resetCache');
$this->cacheFactory->expects($this->at(0))
->method('createDistributed')
->with('imagePath')
use OC\Files\AppData\AppData;
use OC\Files\AppData\Factory;
use OC\Template\CSSResourceLocator;
-use OC\Template\SCSSCacher;
use OCA\Theming\ThemingDefaults;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\Files\IAppData;
/** @var Factory|\PHPUnit\Framework\MockObject\MockObject $factory */
$factory = $this->createMock(Factory::class);
$factory->method('get')->with('css')->willReturn($this->appData);
- $scssCacher = new SCSSCacher(
- $this->logger,
- $factory,
- $this->urlGenerator,
- $this->config,
- $this->themingDefaults,
- \OC::$SERVERROOT,
- $this->cacheFactory,
- $this->timeFactory,
- $this->appConfig
- );
return new CSSResourceLocator(
$this->logger,
'theme',
['core' => 'map'],
['3rd' => 'party'],
- $scssCacher
);
}
+++ /dev/null
-<?php
-/**
- * @copyright Copyright (c) 2017 Julius Härtl <jus@bitgrid.net>
- *
- * @author Julius Härtl <jus@bitgrid.net>
- *
- * @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 Test\Template;
-
-use OC\AppConfig;
-use OC\Files\AppData\AppData;
-use OC\Files\AppData\Factory;
-use OC\Template\SCSSCacher;
-use OCA\Theming\ThemingDefaults;
-use OCP\AppFramework\Utility\ITimeFactory;
-use OCP\Files\IAppData;
-use OCP\Files\NotFoundException;
-use OCP\Files\SimpleFS\ISimpleFile;
-use OCP\Files\SimpleFS\ISimpleFolder;
-use OCP\ICache;
-use OCP\ICacheFactory;
-use OCP\IConfig;
-use OCP\IURLGenerator;
-use Psr\Log\LoggerInterface;
-
-class SCSSCacherTest extends \Test\TestCase {
- /** @var LoggerInterface|\PHPUnit\Framework\MockObject\MockObject */
- protected $logger;
- /** @var IAppData|\PHPUnit\Framework\MockObject\MockObject */
- protected $appData;
- /** @var IURLGenerator|\PHPUnit\Framework\MockObject\MockObject */
- protected $urlGenerator;
- /** @var IConfig|\PHPUnit\Framework\MockObject\MockObject */
- protected $config;
- /** @var ThemingDefaults|\PHPUnit\Framework\MockObject\MockObject */
- protected $themingDefaults;
- /** @var SCSSCacher */
- protected $scssCacher;
- /** @var ICache|\PHPUnit\Framework\MockObject\MockObject */
- protected $depsCache;
- /** @var ICacheFactory|\PHPUnit\Framework\MockObject\MockObject */
- protected $isCachedCache;
- /** @var ICacheFactory|\PHPUnit\Framework\MockObject\MockObject */
- protected $cacheFactory;
- /** @var ITimeFactory|\PHPUnit\Framework\MockObject\MockObject */
- protected $timeFactory;
- /** @var AppConfig|\PHPUnit\Framework\MockObject\MockObject */
- protected $appConfig;
-
- protected function setUp(): void {
- parent::setUp();
- $this->logger = $this->createMock(LoggerInterface::class);
- $this->appData = $this->createMock(AppData::class);
- $this->timeFactory = $this->createMock(ITimeFactory::class);
-
- /** @var Factory|\PHPUnit\Framework\MockObject\MockObject $factory */
- $factory = $this->createMock(Factory::class);
- $factory->method('get')->with('css')->willReturn($this->appData);
-
- $this->urlGenerator = $this->createMock(IURLGenerator::class);
- $this->urlGenerator->expects($this->any())
- ->method('getBaseUrl')
- ->willReturn('http://localhost/nextcloud');
-
- $this->config = $this->createMock(IConfig::class);
- $this->config->expects($this->any())
- ->method('getAppValue')
- ->will($this->returnCallback(function ($appId, $configKey, $defaultValue) {
- return $defaultValue;
- }));
- $this->cacheFactory = $this->createMock(ICacheFactory::class);
- $this->depsCache = $this->createMock(ICache::class);
- $this->isCachedCache = $this->createMock(ICache::class);
- $this->cacheFactory
- ->method('createDistributed')
- ->withConsecutive()
- ->willReturnOnConsecutiveCalls(
- $this->depsCache,
- $this->isCachedCache,
- $this->createMock(ICache::class)
- );
-
- $this->themingDefaults = $this->createMock(ThemingDefaults::class);
- $this->themingDefaults->expects($this->any())->method('getScssVariables')->willReturn([]);
-
- $iconsFile = $this->createMock(ISimpleFile::class);
-
- $this->appConfig = $this->createMock(AppConfig::class);
-
- $this->scssCacher = new SCSSCacher(
- $this->logger,
- $factory,
- $this->urlGenerator,
- $this->config,
- $this->themingDefaults,
- \OC::$SERVERROOT,
- $this->cacheFactory,
- $this->timeFactory,
- $this->appConfig
- );
- }
-
- public function testProcessUncachedFileNoAppDataFolder() {
- $folder = $this->createMock(ISimpleFolder::class);
- $file = $this->createMock(ISimpleFile::class);
- $file->expects($this->any())->method('getSize')->willReturn(1);
-
- $this->appData->expects($this->once())->method('getFolder')->with('core')->willThrowException(new NotFoundException());
- $this->appData->expects($this->once())->method('newFolder')->with('core')->willReturn($folder);
- $this->appData->method('getDirectoryListing')->willReturn([]);
-
- $fileDeps = $this->createMock(ISimpleFile::class);
- $gzfile = $this->createMock(ISimpleFile::class);
- $filePrefix = substr(md5(\OC_Util::getVersionString('core')), 0, 4) . '-' .
- substr(md5('http://localhost/nextcloud/index.php'), 0, 4) . '-';
-
- $folder->method('getFile')
- ->willReturnCallback(function ($path) use ($file, $gzfile, $filePrefix) {
- if ($path === $filePrefix.'styles.css') {
- return $file;
- } elseif ($path === $filePrefix.'styles.css.deps') {
- throw new NotFoundException();
- } elseif ($path === $filePrefix.'styles.css.gzip') {
- return $gzfile;
- } else {
- $this->fail();
- }
- });
- $folder->expects($this->once())
- ->method('newFile')
- ->with($filePrefix.'styles.css.deps')
- ->willReturn($fileDeps);
-
- $this->urlGenerator->expects($this->once())
- ->method('getBaseUrl')
- ->willReturn('http://localhost/nextcloud');
-
- $actual = $this->scssCacher->process(\OC::$SERVERROOT, '/core/css/styles.scss', 'core');
- $this->assertTrue($actual);
- }
-
- public function testProcessUncachedFile() {
- $folder = $this->createMock(ISimpleFolder::class);
- $this->appData->expects($this->once())->method('getFolder')->with('core')->willReturn($folder);
- $this->appData->method('getDirectoryListing')->willReturn([]);
- $file = $this->createMock(ISimpleFile::class);
- $file->expects($this->any())->method('getSize')->willReturn(1);
- $fileDeps = $this->createMock(ISimpleFile::class);
- $gzfile = $this->createMock(ISimpleFile::class);
- $filePrefix = substr(md5(\OC_Util::getVersionString('core')), 0, 4) . '-' .
- substr(md5('http://localhost/nextcloud/index.php'), 0, 4) . '-';
-
- $folder->method('getFile')
- ->willReturnCallback(function ($path) use ($file, $gzfile, $filePrefix) {
- if ($path === $filePrefix.'styles.css') {
- return $file;
- } elseif ($path === $filePrefix.'styles.css.deps') {
- throw new NotFoundException();
- } elseif ($path === $filePrefix.'styles.css.gzip') {
- return $gzfile;
- } else {
- $this->fail();
- }
- });
- $folder->expects($this->once())
- ->method('newFile')
- ->with($filePrefix.'styles.css.deps')
- ->willReturn($fileDeps);
-
- $actual = $this->scssCacher->process(\OC::$SERVERROOT, '/core/css/styles.scss', 'core');
- $this->assertTrue($actual);
- }
-
- public function testProcessCachedFile() {
- $folder = $this->createMock(ISimpleFolder::class);
- $this->appData->expects($this->once())->method('getFolder')->with('core')->willReturn($folder);
- $this->appData->method('getDirectoryListing')->willReturn([]);
- $file = $this->createMock(ISimpleFile::class);
- $fileDeps = $this->createMock(ISimpleFile::class);
- $fileDeps->expects($this->any())->method('getSize')->willReturn(1);
- $gzFile = $this->createMock(ISimpleFile::class);
- $filePrefix = substr(md5(\OC_Util::getVersionString('core')), 0, 4) . '-' .
- substr(md5('http://localhost/nextcloud/index.php'), 0, 4) . '-';
-
- $folder->method('getFile')
- ->willReturnCallback(function ($name) use ($file, $fileDeps, $gzFile, $filePrefix) {
- if ($name === $filePrefix.'styles.css') {
- return $file;
- } elseif ($name === $filePrefix.'styles.css.deps') {
- return $fileDeps;
- } elseif ($name === $filePrefix.'styles.css.gzip') {
- return $gzFile;
- }
- $this->fail();
- });
-
- $actual = $this->scssCacher->process(\OC::$SERVERROOT, '/core/css/styles.scss', 'core');
- $this->assertTrue($actual);
- }
-
- public function testProcessCachedFileMemcache() {
- $folder = $this->createMock(ISimpleFolder::class);
- $this->appData->expects($this->once())
- ->method('getFolder')
- ->with('core')
- ->willReturn($folder);
- $folder->method('getName')
- ->willReturn('core');
- $this->appData->method('getDirectoryListing')->willReturn([]);
-
- $file = $this->createMock(ISimpleFile::class);
-
- $fileDeps = $this->createMock(ISimpleFile::class);
- $fileDeps->expects($this->any())->method('getSize')->willReturn(1);
-
- $gzFile = $this->createMock(ISimpleFile::class);
- $filePrefix = substr(md5(\OC_Util::getVersionString('core')), 0, 4) . '-' .
- substr(md5('http://localhost/nextcloud/index.php'), 0, 4) . '-';
- $folder->method('getFile')
- ->willReturnCallback(function ($name) use ($file, $fileDeps, $gzFile, $filePrefix) {
- if ($name === $filePrefix.'styles.css') {
- return $file;
- } elseif ($name === $filePrefix.'styles.css.deps') {
- return $fileDeps;
- } elseif ($name === $filePrefix.'styles.css.gzip') {
- return $gzFile;
- }
- $this->fail();
- });
-
- $actual = $this->scssCacher->process(\OC::$SERVERROOT, '/core/css/styles.scss', 'core');
- $this->assertTrue($actual);
- }
-
- public function testIsCachedNoFile() {
- $fileNameCSS = "styles.css";
- $folder = $this->createMock(ISimpleFolder::class);
-
- $folder->expects($this->at(0))->method('getFile')->with($fileNameCSS)->willThrowException(new NotFoundException());
- $this->appData->expects($this->any())
- ->method('getFolder')
- ->willReturn($folder);
- $actual = self::invokePrivate($this->scssCacher, 'isCached', [$fileNameCSS, 'core']);
- $this->assertFalse($actual);
- }
-
- public function testIsCachedNoDepsFile() {
- $fileNameCSS = "styles.css";
- $folder = $this->createMock(ISimpleFolder::class);
- $file = $this->createMock(ISimpleFile::class);
-
- $file->expects($this->once())->method('getSize')->willReturn(1);
- $folder->method('getFile')
- ->willReturnCallback(function ($path) use ($file) {
- if ($path === 'styles.css') {
- return $file;
- } elseif ($path === 'styles.css.deps') {
- throw new NotFoundException();
- } else {
- $this->fail();
- }
- });
-
- $this->appData->expects($this->any())
- ->method('getFolder')
- ->willReturn($folder);
- $actual = self::invokePrivate($this->scssCacher, 'isCached', [$fileNameCSS, 'core']);
- $this->assertFalse($actual);
- }
- public function testCacheNoFile() {
- $fileNameCSS = "styles.css";
- $fileNameSCSS = "styles.scss";
- $folder = $this->createMock(ISimpleFolder::class);
- $file = $this->createMock(ISimpleFile::class);
- $depsFile = $this->createMock(ISimpleFile::class);
- $gzipFile = $this->createMock(ISimpleFile::class);
-
- $webDir = "core/css";
- $path = \OC::$SERVERROOT . '/core/css/';
-
- $folder->method('getFile')->willThrowException(new NotFoundException());
- $folder->method('newFile')->willReturnCallback(function ($fileName) use ($file, $depsFile, $gzipFile) {
- if ($fileName === 'styles.css') {
- return $file;
- } elseif ($fileName === 'styles.css.deps') {
- return $depsFile;
- } elseif ($fileName === 'styles.css.gzip') {
- return $gzipFile;
- }
- throw new \Exception();
- });
-
- $file->expects($this->once())->method('putContent');
- $depsFile->expects($this->once())->method('putContent');
- $gzipFile->expects($this->once())->method('putContent');
-
- $actual = self::invokePrivate($this->scssCacher, 'cache', [$path, $fileNameCSS, $fileNameSCSS, $folder, $webDir]);
- $this->assertTrue($actual);
- }
-
- public function testCache() {
- $fileNameCSS = "styles.css";
- $fileNameSCSS = "styles.scss";
- $folder = $this->createMock(ISimpleFolder::class);
- $file = $this->createMock(ISimpleFile::class);
- $depsFile = $this->createMock(ISimpleFile::class);
- $gzipFile = $this->createMock(ISimpleFile::class);
-
- $webDir = "core/css";
- $path = \OC::$SERVERROOT;
-
- $folder->method('getFile')->willReturnCallback(function ($fileName) use ($file, $depsFile, $gzipFile) {
- if ($fileName === 'styles.css') {
- return $file;
- } elseif ($fileName === 'styles.css.deps') {
- return $depsFile;
- } elseif ($fileName === 'styles.css.gzip') {
- return $gzipFile;
- }
- throw new \Exception();
- });
-
- $file->expects($this->once())->method('putContent');
- $depsFile->expects($this->once())->method('putContent');
- $gzipFile->expects($this->once())->method('putContent');
-
- $actual = self::invokePrivate($this->scssCacher, 'cache', [$path, $fileNameCSS, $fileNameSCSS, $folder, $webDir]);
- $this->assertTrue($actual);
- }
-
- public function testCacheSuccess() {
- $fileNameCSS = "styles-success.css";
- $fileNameSCSS = "../../tests/data/scss/styles-success.scss";
- $folder = $this->createMock(ISimpleFolder::class);
- $file = $this->createMock(ISimpleFile::class);
- $depsFile = $this->createMock(ISimpleFile::class);
- $gzipFile = $this->createMock(ISimpleFile::class);
-
- $webDir = "tests/data/scss";
- $path = \OC::$SERVERROOT . $webDir;
-
- $folder->method('getFile')->willReturnCallback(function ($fileName) use ($file, $depsFile, $gzipFile) {
- if ($fileName === 'styles-success.css') {
- return $file;
- } elseif ($fileName === 'styles-success.css.deps') {
- return $depsFile;
- } elseif ($fileName === 'styles-success.css.gzip') {
- return $gzipFile;
- }
- throw new \Exception();
- });
-
- $file->expects($this->at(0))->method('putContent')->with($this->callback(
- function ($content) {
- return 'body{background-color:#0082c9}' === $content;
- }));
- $depsFile->expects($this->at(0))->method('putContent')->with($this->callback(
- function ($content) {
- $deps = json_decode($content, true);
- return array_key_exists(\OC::$SERVERROOT . '/core/css/variables.scss', $deps)
- && array_key_exists(\OC::$SERVERROOT . '/tests/data/scss/styles-success.scss', $deps);
- }));
- $gzipFile->expects($this->at(0))->method('putContent')->with($this->callback(
- function ($content) {
- return gzdecode($content) === 'body{background-color:#0082c9}';
- }
- ));
-
- $actual = self::invokePrivate($this->scssCacher, 'cache', [$path, $fileNameCSS, $fileNameSCSS, $folder, $webDir]);
- $this->assertTrue($actual);
- }
-
- public function testCacheFailure() {
- $fileNameCSS = "styles-error.css";
- $fileNameSCSS = "../../tests/data/scss/styles-error.scss";
- $folder = $this->createMock(ISimpleFolder::class);
- $file = $this->createMock(ISimpleFile::class);
- $depsFile = $this->createMock(ISimpleFile::class);
-
- $webDir = "/tests/data/scss";
- $path = \OC::$SERVERROOT . $webDir;
-
- $folder->expects($this->at(0))->method('getFile')->with($fileNameCSS)->willReturn($file);
- $folder->expects($this->at(1))->method('getFile')->with($fileNameCSS . '.deps')->willReturn($depsFile);
-
- $actual = self::invokePrivate($this->scssCacher, 'cache', [$path, $fileNameCSS, $fileNameSCSS, $folder, $webDir]);
- $this->assertFalse($actual);
- }
-
- public function dataRebaseUrls() {
- return [
- ['#id { background-image: url(\'../img/image.jpg\'); }','#id { background-image: url(\'/apps/files/css/../img/image.jpg\'); }'],
- ['#id { background-image: url("../img/image.jpg"); }','#id { background-image: url(\'/apps/files/css/../img/image.jpg\'); }'],
- ['#id { background-image: url(\'/img/image.jpg\'); }','#id { background-image: url(\'/img/image.jpg\'); }'],
- ['#id { background-image: url("http://example.com/test.jpg"); }','#id { background-image: url("http://example.com/test.jpg"); }'],
- ];
- }
-
- /**
- * @dataProvider dataRebaseUrls
- */
- public function testRebaseUrls($scss, $expected) {
- $webDir = '/apps/files/css';
- $actual = self::invokePrivate($this->scssCacher, 'rebaseUrls', [$scss, $webDir]);
- $this->assertEquals($expected, $actual);
- }
-
- public function dataGetCachedSCSS() {
- return [
- ['core', 'core/css/styles.scss', '/css/core/styles.css', \OC_Util::getVersionString()],
- ['files', 'apps/files/css/styles.scss', '/css/files/styles.css', \OC_App::getAppVersion('files')]
- ];
- }
-
- /**
- * @param $appName
- * @param $fileName
- * @param $result
- * @dataProvider dataGetCachedSCSS
- */
- public function testGetCachedSCSS($appName, $fileName, $result, $version) {
- $this->urlGenerator->expects($this->once())
- ->method('linkToRoute')
- ->with('core.Css.getCss', [
- 'fileName' => substr(md5($version), 0, 4) . '-' .
- substr(md5('http://localhost/nextcloud/index.php'), 0, 4) . '-styles.css',
- 'appName' => $appName,
- 'v' => 0,
- ])
- ->willReturn(\OC::$WEBROOT . $result);
- $actual = $this->scssCacher->getCachedSCSS($appName, $fileName);
- $this->assertEquals(substr($result, 1), $actual);
- }
-
- private function randomString() {
- return sha1(uniqid(mt_rand(), true));
- }
-
- private function rrmdir($directory) {
- $files = array_diff(scandir($directory), ['.','..']);
- foreach ($files as $file) {
- if (is_dir($directory . '/' . $file)) {
- $this->rrmdir($directory . '/' . $file);
- } else {
- unlink($directory . '/' . $file);
- }
- }
- return rmdir($directory);
- }
-
- public function dataGetWebDir() {
- return [
- // Root installation
- ['/http/core/css', 'core', '', '/http', '/core/css'],
- ['/http/apps/scss/css', 'scss', '', '/http', '/apps/scss/css'],
- ['/srv/apps2/scss/css', 'scss', '', '/http', '/apps2/scss/css'],
- // Sub directory install
- ['/http/nextcloud/core/css', 'core', '/nextcloud', '/http/nextcloud', '/nextcloud/core/css'],
- ['/http/nextcloud/apps/scss/css', 'scss', '/nextcloud', '/http/nextcloud', '/nextcloud/apps/scss/css'],
- ['/srv/apps2/scss/css', 'scss', '/nextcloud', '/http/nextcloud', '/apps2/scss/css']
- ];
- }
-
- /**
- * @param $path
- * @param $appName
- * @param $webRoot
- * @param $serverRoot
- * @dataProvider dataGetWebDir
- */
- public function testgetWebDir($path, $appName, $webRoot, $serverRoot, $correctWebDir) {
- $tmpDir = sys_get_temp_dir().'/'.$this->randomString();
- // Adding fake apps folder and create fake app install
- \OC::$APPSROOTS[] = [
- 'path' => $tmpDir.'/srv/apps2',
- 'url' => '/apps2',
- 'writable' => false
- ];
- mkdir($tmpDir.$path, 0777, true);
- $actual = self::invokePrivate($this->scssCacher, 'getWebDir', [$tmpDir.$path, $appName, $tmpDir.$serverRoot, $webRoot]);
- $this->assertEquals($correctWebDir, $actual);
- array_pop(\OC::$APPSROOTS);
- $this->rrmdir($tmpDir.$path);
- }
-
- public function testResetCache() {
- $file = $this->createMock(ISimpleFile::class);
- $file->expects($this->once())
- ->method('delete');
-
- $folder = $this->createMock(ISimpleFolder::class);
- $folder->expects($this->once())
- ->method('getDirectoryListing')
- ->willReturn([$file]);
-
- $this->depsCache->expects($this->once())
- ->method('clear')
- ->with('');
- $this->isCachedCache->expects($this->once())
- ->method('clear')
- ->with('');
- $this->appData->expects($this->once())
- ->method('getDirectoryListing')
- ->willReturn([$folder]);
-
- $this->scssCacher->resetCache();
- }
-}
projects / nextcloud-server.git / commitdiff