nextcloud / server

lib/private/Template/SCSSCacher.php

Indentation +258 added lines, -258 removed lines

@@ -38,262 +38,262 @@
 
 class SCSSCacher {
 
-	/** @var ILogger */
-	protected $logger;
-
-	/** @var IAppData */
-	protected $appData;
-
-	/** @var IURLGenerator */
-	protected $urlGenerator;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var string */
-	protected $serverRoot;
-
-	/** @var ICache */
-	protected $depsCache;
-
-	/**
-	 * @param ILogger $logger
-	 * @param Factory $appDataFactory
-	 * @param IURLGenerator $urlGenerator
-	 * @param IConfig $config
-	 * @param \OC_Defaults $defaults
-	 * @param string $serverRoot
-	 * @param ICache $depsCache
-	 */
-	public function __construct(ILogger $logger,
-								Factory $appDataFactory,
-								IURLGenerator $urlGenerator,
-								IConfig $config,
-								\OC_Defaults $defaults,
-								$serverRoot,
-								ICache $depsCache) {
-		$this->logger = $logger;
-		$this->appData = $appDataFactory->get('css');
-		$this->urlGenerator = $urlGenerator;
-		$this->config = $config;
-		$this->defaults = $defaults;
-		$this->serverRoot = $serverRoot;
-		$this->depsCache = $depsCache;
-	}
-
-	/**
-	 * 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
-	 */
-	public function process($root, $file, $app) {
-		$path = explode('/', $root . '/' . $file);
-
-		$fileNameSCSS = array_pop($path);
-		$fileNameCSS = str_replace('.scss', '.css', $fileNameSCSS);
-
-		$path = implode('/', $path);
-
-		$webDir = substr($path, strlen($this->serverRoot)+1);
-
-		try {
-			$folder = $this->appData->getFolder($app);
-		} catch(NotFoundException $e) {
-			// creating css appdata folder
-			$folder = $this->appData->newFolder($app);
-		}
-
-
-		if(!$this->variablesChanged() && $this->isCached($fileNameCSS, $folder)) {
-			return true;
-		}
-		return $this->cache($path, $fileNameCSS, $fileNameSCSS, $folder, $webDir);
-	}
-
-	/**
-	 * @param $appName
-	 * @param $fileName
-	 * @return ISimpleFile
-	 */
-	public function getCachedCSS($appName, $fileName) {
-		$folder = $this->appData->getFolder($appName);
-		return $folder->getFile($fileName);
-	}
-
-	/**
-	 * Check if the file is cached or not
-	 * @param string $fileNameCSS
-	 * @param ISimpleFolder $folder
-	 * @return boolean
-	 */
-	private function isCached($fileNameCSS, ISimpleFolder $folder) {
-		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 ($deps as $file=>$mtime) {
-					if (!file_exists($file) || filemtime($file) > $mtime) {
-						return false;
-					}
-				}
-			}
-			return true;
-		} catch(NotFoundException $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * Check if the variables file has changed
-	 * @return bool
-	 */
-	private function variablesChanged() {
-		$injectedVariables = $this->getInjectedVariables();
-		if($this->config->getAppValue('core', 'scss.variables') !== md5($injectedVariables)) {
-			$this->resetCache();
-			$this->config->setAppValue('core', 'scss.variables', md5($injectedVariables));
-			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
-	 */
-	private function cache($path, $fileNameCSS, $fileNameSCSS, ISimpleFolder $folder, $webDir) {
-		$scss = new Compiler();
-		$scss->setImportPaths([
-			$path,
-			\OC::$SERVERROOT . '/core/css/',
-		]);
-		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(
-				'@import "variables.scss";' .
-				$this->getInjectedVariables() .
-				'@import "'.$fileNameSCSS.'";');
-		} catch(ParserException $e) {
-			$this->logger->error($e, ['app' => 'core']);
-			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($webDir.'/'.$fileNameSCSS.' compiled and successfully cached', ['app' => 'core']);
-			return true;
-		} catch(NotPermittedException $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * Reset scss cache by deleting all generated css files
-	 * We need to regenerate all files when variables change
-	 */
-	private function resetCache() {
-		$appDirectory = $this->appData->getDirectoryListing();
-		if(empty($appDirectory)){
-			return;
-		}
-		foreach ($appDirectory as $folder) {
-			foreach ($folder->getDirectoryListing() as $file) {
-				if (substr($file->getName(), -3) === "css" || substr($file->getName(), -4) === "deps") {
-					$file->delete();
-				}
-			}
-		}
-	}
-
-	/**
-	 * @return string SCSS code for variables from OC_Defaults
-	 */
-	private function getInjectedVariables() {
-		$variables = '';
-		foreach ($this->defaults->getScssVariables() as $key => $value) {
-			$variables .= '$' . $key . ': ' . $value . ';';
-		}
-		return $variables;
-	}
-
-	/**
-	 * Add the correct uri prefix to make uri valid again
-	 * @param string $css
-	 * @param string $webDir
-	 * @return string
-	 */
-	private function rebaseUrls($css, $webDir) {
-		$re = '/url\([\'"]([\.\w?=\/-]*)[\'"]\)/x';
-		// OC\Route\Router:75
-		if(($this->config->getSystemValue('htaccess.IgnoreFrontController', false) === true || getenv('front_controller_active') === 'true')) {
-			$subst = 'url(\'../../'.$webDir.'/$1\')';	
-		} else {
-			$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($appName, $fileName) {
-		$tmpfileLoc = explode('/', $fileName);
-		$fileName = array_pop($tmpfileLoc);
-		$fileName = str_replace('.scss', '.css', $fileName);
-
-		return substr($this->urlGenerator->linkToRoute('core.Css.getCss', array('fileName' => $fileName, 'appName' => $appName)), strlen(\OC::$WEBROOT) + 1);
-	}
+    /** @var ILogger */
+    protected $logger;
+
+    /** @var IAppData */
+    protected $appData;
+
+    /** @var IURLGenerator */
+    protected $urlGenerator;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var string */
+    protected $serverRoot;
+
+    /** @var ICache */
+    protected $depsCache;
+
+    /**
+     * @param ILogger $logger
+     * @param Factory $appDataFactory
+     * @param IURLGenerator $urlGenerator
+     * @param IConfig $config
+     * @param \OC_Defaults $defaults
+     * @param string $serverRoot
+     * @param ICache $depsCache
+     */
+    public function __construct(ILogger $logger,
+                                Factory $appDataFactory,
+                                IURLGenerator $urlGenerator,
+                                IConfig $config,
+                                \OC_Defaults $defaults,
+                                $serverRoot,
+                                ICache $depsCache) {
+        $this->logger = $logger;
+        $this->appData = $appDataFactory->get('css');
+        $this->urlGenerator = $urlGenerator;
+        $this->config = $config;
+        $this->defaults = $defaults;
+        $this->serverRoot = $serverRoot;
+        $this->depsCache = $depsCache;
+    }
+
+    /**
+     * 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
+     */
+    public function process($root, $file, $app) {
+        $path = explode('/', $root . '/' . $file);
+
+        $fileNameSCSS = array_pop($path);
+        $fileNameCSS = str_replace('.scss', '.css', $fileNameSCSS);
+
+        $path = implode('/', $path);
+
+        $webDir = substr($path, strlen($this->serverRoot)+1);
+
+        try {
+            $folder = $this->appData->getFolder($app);
+        } catch(NotFoundException $e) {
+            // creating css appdata folder
+            $folder = $this->appData->newFolder($app);
+        }
+
+
+        if(!$this->variablesChanged() && $this->isCached($fileNameCSS, $folder)) {
+            return true;
+        }
+        return $this->cache($path, $fileNameCSS, $fileNameSCSS, $folder, $webDir);
+    }
+
+    /**
+     * @param $appName
+     * @param $fileName
+     * @return ISimpleFile
+     */
+    public function getCachedCSS($appName, $fileName) {
+        $folder = $this->appData->getFolder($appName);
+        return $folder->getFile($fileName);
+    }
+
+    /**
+     * Check if the file is cached or not
+     * @param string $fileNameCSS
+     * @param ISimpleFolder $folder
+     * @return boolean
+     */
+    private function isCached($fileNameCSS, ISimpleFolder $folder) {
+        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 ($deps as $file=>$mtime) {
+                    if (!file_exists($file) || filemtime($file) > $mtime) {
+                        return false;
+                    }
+                }
+            }
+            return true;
+        } catch(NotFoundException $e) {
+            return false;
+        }
+    }
+
+    /**
+     * Check if the variables file has changed
+     * @return bool
+     */
+    private function variablesChanged() {
+        $injectedVariables = $this->getInjectedVariables();
+        if($this->config->getAppValue('core', 'scss.variables') !== md5($injectedVariables)) {
+            $this->resetCache();
+            $this->config->setAppValue('core', 'scss.variables', md5($injectedVariables));
+            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
+     */
+    private function cache($path, $fileNameCSS, $fileNameSCSS, ISimpleFolder $folder, $webDir) {
+        $scss = new Compiler();
+        $scss->setImportPaths([
+            $path,
+            \OC::$SERVERROOT . '/core/css/',
+        ]);
+        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(
+                '@import "variables.scss";' .
+                $this->getInjectedVariables() .
+                '@import "'.$fileNameSCSS.'";');
+        } catch(ParserException $e) {
+            $this->logger->error($e, ['app' => 'core']);
+            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($webDir.'/'.$fileNameSCSS.' compiled and successfully cached', ['app' => 'core']);
+            return true;
+        } catch(NotPermittedException $e) {
+            return false;
+        }
+    }
+
+    /**
+     * Reset scss cache by deleting all generated css files
+     * We need to regenerate all files when variables change
+     */
+    private function resetCache() {
+        $appDirectory = $this->appData->getDirectoryListing();
+        if(empty($appDirectory)){
+            return;
+        }
+        foreach ($appDirectory as $folder) {
+            foreach ($folder->getDirectoryListing() as $file) {
+                if (substr($file->getName(), -3) === "css" || substr($file->getName(), -4) === "deps") {
+                    $file->delete();
+                }
+            }
+        }
+    }
+
+    /**
+     * @return string SCSS code for variables from OC_Defaults
+     */
+    private function getInjectedVariables() {
+        $variables = '';
+        foreach ($this->defaults->getScssVariables() as $key => $value) {
+            $variables .= '$' . $key . ': ' . $value . ';';
+        }
+        return $variables;
+    }
+
+    /**
+     * Add the correct uri prefix to make uri valid again
+     * @param string $css
+     * @param string $webDir
+     * @return string
+     */
+    private function rebaseUrls($css, $webDir) {
+        $re = '/url\([\'"]([\.\w?=\/-]*)[\'"]\)/x';
+        // OC\Route\Router:75
+        if(($this->config->getSystemValue('htaccess.IgnoreFrontController', false) === true || getenv('front_controller_active') === 'true')) {
+            $subst = 'url(\'../../'.$webDir.'/$1\')';	
+        } else {
+            $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($appName, $fileName) {
+        $tmpfileLoc = explode('/', $fileName);
+        $fileName = array_pop($tmpfileLoc);
+        $fileName = str_replace('.scss', '.css', $fileName);
+
+        return substr($this->urlGenerator->linkToRoute('core.Css.getCss', array('fileName' => $fileName, 'appName' => $appName)), strlen(\OC::$WEBROOT) + 1);
+    }
 }