nextcloud / server

lib/private/Template/JSCombiner.php

Doc Comments +1 added lines

@@ -151,6 +151,7 @@
 	 * @param string $path
 	 * @param string $fileName
 	 * @param ISimpleFolder $folder
+	 * @param string $app
 	 * @return bool
 	 */
 	protected function cache($path, $fileName, ISimpleFolder $folder, $app) {

Indentation +235 added lines, -235 removed lines

@@ -36,239 +36,239 @@
 
 class JSCombiner {
 
-	/** @var IAppData */
-	protected $appData;
-
-	/** @var IURLGenerator */
-	protected $urlGenerator;
-
-	/** @var ICache */
-	protected $depsCache;
-
-	/** @var SystemConfig */
-	protected $config;
-
-	/** @var ILogger */
-	protected $logger;
-
-	/** @var ICacheFactory */
-	private $cacheFactory;
-
-	/**
-	 * @param IAppData $appData
-	 * @param IURLGenerator $urlGenerator
-	 * @param ICacheFactory $cacheFactory
-	 * @param SystemConfig $config
-	 * @param ILogger $logger
-	 */
-	public function __construct(IAppData $appData,
-								IURLGenerator $urlGenerator,
-								ICacheFactory $cacheFactory,
-								SystemConfig $config,
-								ILogger $logger) {
-		$this->appData = $appData;
-		$this->urlGenerator = $urlGenerator;
-		$this->cacheFactory = $cacheFactory;
-		$this->depsCache = $this->cacheFactory->createDistributed('JS-' . md5($this->urlGenerator->getBaseUrl()));
-		$this->config = $config;
-		$this->logger = $logger;
-	}
-
-	/**
-	 * @param string $root
-	 * @param string $file
-	 * @param string $app
-	 * @return bool
-	 */
-	public function process($root, $file, $app) {
-		if ($this->config->getValue('debug') || !$this->config->getValue('installed')) {
-			return false;
-		}
-
-		$path = explode('/', $root . '/' . $file);
-
-		$fileName = array_pop($path);
-		$path = implode('/', $path);
-
-		try {
-			$folder = $this->appData->getFolder($app);
-		} catch(NotFoundException $e) {
-			// creating css appdata folder
-			$folder = $this->appData->newFolder($app);
-		}
-
-		if($this->isCached($fileName, $folder, $app)) {
-			return true;
-		}
-		return $this->cache($path, $fileName, $folder, $app);
-	}
-
-	/**
-	 * @param string $fileName
-	 * @param ISimpleFolder $folder
-	 * @return bool
-	 */
-	protected function isCached($fileName, ISimpleFolder $folder, string $app) {
-		$fileName = $this->prependVersionPrefix(str_replace('.json', '.js', $fileName), $app);
-
-		if (!$folder->fileExists($fileName)) {
-			return false;
-		}
-
-		$fileName = $fileName . '.deps';
-		try {
-			$deps = $this->depsCache->get($folder->getName() . '-' . $fileName);
-			if ($deps === null || $deps === '') {
-				$depFile = $folder->getFile($fileName);
-				$deps = $depFile->getContent();
-			}
-
-			// check again
-			if ($deps === null || $deps === '') {
-				$this->logger->info('JSCombiner: deps file empty: ' . $fileName);
-				return false;
-			}
-
-			$deps = json_decode($deps, true);
-
-			if ($deps === NULL) {
-				return false;
-			}
-
-			foreach ($deps as $file=>$mtime) {
-				if (!file_exists($file) || filemtime($file) > $mtime) {
-					return false;
-				}
-			}
-
-			return true;
-		} catch(NotFoundException $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $fileName
-	 * @param ISimpleFolder $folder
-	 * @return bool
-	 */
-	protected function cache($path, $fileName, ISimpleFolder $folder, $app) {
-		$deps = [];
-		$fullPath = $path . '/' . $fileName;
-		$data = json_decode(file_get_contents($fullPath));
-		$deps[$fullPath] = filemtime($fullPath);
-
-		$res = '';
-		foreach ($data as $file) {
-			$filePath = $path . '/' . $file;
-
-			if (is_file($filePath)) {
-				$res .= file_get_contents($filePath);
-				$res .= PHP_EOL . PHP_EOL;
-				$deps[$filePath] = filemtime($filePath);
-			}
-		}
-
-		$fileNameCached = $this->prependVersionPrefix(str_replace('.json', '.js', $fileName), $app);
-		try {
-			$cachedfile = $folder->getFile($fileNameCached);
-		} catch(NotFoundException $e) {
-			$cachedfile = $folder->newFile($fileNameCached);
-		}
-
-		$depFileName = $fileNameCached . '.deps';
-		try {
-			$depFile = $folder->getFile($depFileName);
-		} catch (NotFoundException $e) {
-			$depFile = $folder->newFile($depFileName);
-		}
-
-		try {
-			$gzipFile = $folder->getFile($fileNameCached . '.gzip'); # Safari doesn't like .gz
-		} catch (NotFoundException $e) {
-			$gzipFile = $folder->newFile($fileNameCached . '.gzip'); # Safari doesn't like .gz
-		}
-
-		try {
-			$cachedfile->putContent($res);
-			$deps = json_encode($deps);
-			$depFile->putContent($deps);
-			$this->depsCache->set($folder->getName() . '-' . $depFileName, $deps);
-			$gzipFile->putContent(gzencode($res, 9));
-			$this->logger->debug('JSCombiner: successfully cached: ' . $fileNameCached);
-			return true;
-		} catch (NotPermittedException $e) {
-			$this->logger->error('JSCombiner: unable to cache: ' . $fileNameCached);
-			return false;
-		}
-	}
-
-	/**
-	 * @param string $appName
-	 * @param string $fileName
-	 * @return string
-	 */
-	public function getCachedJS($appName, $fileName) {
-		$tmpfileLoc = explode('/', $fileName);
-		$fileName = array_pop($tmpfileLoc);
-		$fileName = $this->prependVersionPrefix(str_replace('.json', '.js', $fileName), $appName);
-
-		return substr($this->urlGenerator->linkToRoute('core.Js.getJs', array('fileName' => $fileName, 'appName' => $appName)), strlen(\OC::$WEBROOT) + 1);
-	}
-
-	/**
-	 * @param string $root
-	 * @param string $file
-	 * @return string[]
-	 */
-	public function getContent($root, $file) {
-		/** @var array $data */
-		$data = json_decode(file_get_contents($root . '/' . $file));
-		if(!is_array($data)) {
-			return [];
-		}
-
-		$path = explode('/', $file);
-		array_pop($path);
-		$path = implode('/', $path);
-
-		$result = [];
-		foreach ($data as $f) {
-			$result[] = $path . '/' . $f;
-		}
-
-		return $result;
-	}
-
-
-	/**
-	 * Clear cache with combined javascript files
-	 *
-	 * @throws NotFoundException
-	 */
-	public function resetCache() {
-		$this->cacheFactory->createDistributed('JS-')->clear();
-		$appDirectory = $this->appData->getDirectoryListing();
-		foreach ($appDirectory as $folder) {
-			foreach ($folder->getDirectoryListing() as $file) {
-				$file->delete();
-			}
-		}
-	}
-
-	/**
-	 * Prepend hashed app version hash
-	 * @param string $jsFile
-	 * @param string $appId
-	 * @return string
-	 */
-	private function prependVersionPrefix(string $jsFile, string $appId): string {
-		$appVersion = \OC_App::getAppVersion($appId);
-		if ($appVersion !== '0') {
-			return substr(md5($appVersion), 0, 5) . '-' . $jsFile;
-		}
-		$coreVersion = \OC_Util::getVersionString();
-		return substr(md5($coreVersion), 0, 5) . '-' . $jsFile;
-	}
+    /** @var IAppData */
+    protected $appData;
+
+    /** @var IURLGenerator */
+    protected $urlGenerator;
+
+    /** @var ICache */
+    protected $depsCache;
+
+    /** @var SystemConfig */
+    protected $config;
+
+    /** @var ILogger */
+    protected $logger;
+
+    /** @var ICacheFactory */
+    private $cacheFactory;
+
+    /**
+     * @param IAppData $appData
+     * @param IURLGenerator $urlGenerator
+     * @param ICacheFactory $cacheFactory
+     * @param SystemConfig $config
+     * @param ILogger $logger
+     */
+    public function __construct(IAppData $appData,
+                                IURLGenerator $urlGenerator,
+                                ICacheFactory $cacheFactory,
+                                SystemConfig $config,
+                                ILogger $logger) {
+        $this->appData = $appData;
+        $this->urlGenerator = $urlGenerator;
+        $this->cacheFactory = $cacheFactory;
+        $this->depsCache = $this->cacheFactory->createDistributed('JS-' . md5($this->urlGenerator->getBaseUrl()));
+        $this->config = $config;
+        $this->logger = $logger;
+    }
+
+    /**
+     * @param string $root
+     * @param string $file
+     * @param string $app
+     * @return bool
+     */
+    public function process($root, $file, $app) {
+        if ($this->config->getValue('debug') || !$this->config->getValue('installed')) {
+            return false;
+        }
+
+        $path = explode('/', $root . '/' . $file);
+
+        $fileName = array_pop($path);
+        $path = implode('/', $path);
+
+        try {
+            $folder = $this->appData->getFolder($app);
+        } catch(NotFoundException $e) {
+            // creating css appdata folder
+            $folder = $this->appData->newFolder($app);
+        }
+
+        if($this->isCached($fileName, $folder, $app)) {
+            return true;
+        }
+        return $this->cache($path, $fileName, $folder, $app);
+    }
+
+    /**
+     * @param string $fileName
+     * @param ISimpleFolder $folder
+     * @return bool
+     */
+    protected function isCached($fileName, ISimpleFolder $folder, string $app) {
+        $fileName = $this->prependVersionPrefix(str_replace('.json', '.js', $fileName), $app);
+
+        if (!$folder->fileExists($fileName)) {
+            return false;
+        }
+
+        $fileName = $fileName . '.deps';
+        try {
+            $deps = $this->depsCache->get($folder->getName() . '-' . $fileName);
+            if ($deps === null || $deps === '') {
+                $depFile = $folder->getFile($fileName);
+                $deps = $depFile->getContent();
+            }
+
+            // check again
+            if ($deps === null || $deps === '') {
+                $this->logger->info('JSCombiner: deps file empty: ' . $fileName);
+                return false;
+            }
+
+            $deps = json_decode($deps, true);
+
+            if ($deps === NULL) {
+                return false;
+            }
+
+            foreach ($deps as $file=>$mtime) {
+                if (!file_exists($file) || filemtime($file) > $mtime) {
+                    return false;
+                }
+            }
+
+            return true;
+        } catch(NotFoundException $e) {
+            return false;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param string $fileName
+     * @param ISimpleFolder $folder
+     * @return bool
+     */
+    protected function cache($path, $fileName, ISimpleFolder $folder, $app) {
+        $deps = [];
+        $fullPath = $path . '/' . $fileName;
+        $data = json_decode(file_get_contents($fullPath));
+        $deps[$fullPath] = filemtime($fullPath);
+
+        $res = '';
+        foreach ($data as $file) {
+            $filePath = $path . '/' . $file;
+
+            if (is_file($filePath)) {
+                $res .= file_get_contents($filePath);
+                $res .= PHP_EOL . PHP_EOL;
+                $deps[$filePath] = filemtime($filePath);
+            }
+        }
+
+        $fileNameCached = $this->prependVersionPrefix(str_replace('.json', '.js', $fileName), $app);
+        try {
+            $cachedfile = $folder->getFile($fileNameCached);
+        } catch(NotFoundException $e) {
+            $cachedfile = $folder->newFile($fileNameCached);
+        }
+
+        $depFileName = $fileNameCached . '.deps';
+        try {
+            $depFile = $folder->getFile($depFileName);
+        } catch (NotFoundException $e) {
+            $depFile = $folder->newFile($depFileName);
+        }
+
+        try {
+            $gzipFile = $folder->getFile($fileNameCached . '.gzip'); # Safari doesn't like .gz
+        } catch (NotFoundException $e) {
+            $gzipFile = $folder->newFile($fileNameCached . '.gzip'); # Safari doesn't like .gz
+        }
+
+        try {
+            $cachedfile->putContent($res);
+            $deps = json_encode($deps);
+            $depFile->putContent($deps);
+            $this->depsCache->set($folder->getName() . '-' . $depFileName, $deps);
+            $gzipFile->putContent(gzencode($res, 9));
+            $this->logger->debug('JSCombiner: successfully cached: ' . $fileNameCached);
+            return true;
+        } catch (NotPermittedException $e) {
+            $this->logger->error('JSCombiner: unable to cache: ' . $fileNameCached);
+            return false;
+        }
+    }
+
+    /**
+     * @param string $appName
+     * @param string $fileName
+     * @return string
+     */
+    public function getCachedJS($appName, $fileName) {
+        $tmpfileLoc = explode('/', $fileName);
+        $fileName = array_pop($tmpfileLoc);
+        $fileName = $this->prependVersionPrefix(str_replace('.json', '.js', $fileName), $appName);
+
+        return substr($this->urlGenerator->linkToRoute('core.Js.getJs', array('fileName' => $fileName, 'appName' => $appName)), strlen(\OC::$WEBROOT) + 1);
+    }
+
+    /**
+     * @param string $root
+     * @param string $file
+     * @return string[]
+     */
+    public function getContent($root, $file) {
+        /** @var array $data */
+        $data = json_decode(file_get_contents($root . '/' . $file));
+        if(!is_array($data)) {
+            return [];
+        }
+
+        $path = explode('/', $file);
+        array_pop($path);
+        $path = implode('/', $path);
+
+        $result = [];
+        foreach ($data as $f) {
+            $result[] = $path . '/' . $f;
+        }
+
+        return $result;
+    }
+
+
+    /**
+     * Clear cache with combined javascript files
+     *
+     * @throws NotFoundException
+     */
+    public function resetCache() {
+        $this->cacheFactory->createDistributed('JS-')->clear();
+        $appDirectory = $this->appData->getDirectoryListing();
+        foreach ($appDirectory as $folder) {
+            foreach ($folder->getDirectoryListing() as $file) {
+                $file->delete();
+            }
+        }
+    }
+
+    /**
+     * Prepend hashed app version hash
+     * @param string $jsFile
+     * @param string $appId
+     * @return string
+     */
+    private function prependVersionPrefix(string $jsFile, string $appId): string {
+        $appVersion = \OC_App::getAppVersion($appId);
+        if ($appVersion !== '0') {
+            return substr(md5($appVersion), 0, 5) . '-' . $jsFile;
+        }
+        $coreVersion = \OC_Util::getVersionString();
+        return substr(md5($coreVersion), 0, 5) . '-' . $jsFile;
+    }
 }

Spacing +23 added lines, -23 removed lines

@@ -69,7 +69,7 @@ 
 		$this->appData = $appData;
 		$this->urlGenerator = $urlGenerator;
 		$this->cacheFactory = $cacheFactory;
-		$this->depsCache = $this->cacheFactory->createDistributed('JS-' . md5($this->urlGenerator->getBaseUrl()));
+		$this->depsCache = $this->cacheFactory->createDistributed('JS-'.md5($this->urlGenerator->getBaseUrl()));
 		$this->config = $config;
 		$this->logger = $logger;
 	}
@@ -85,19 +85,19 @@ 
 			return false;
 		}
 
-		$path = explode('/', $root . '/' . $file);
+		$path = explode('/', $root.'/'.$file);
 
 		$fileName = array_pop($path);
 		$path = implode('/', $path);
 
 		try {
 			$folder = $this->appData->getFolder($app);
-		} catch(NotFoundException $e) {
+		} catch (NotFoundException $e) {
 			// creating css appdata folder
 			$folder = $this->appData->newFolder($app);
 		}
 
-		if($this->isCached($fileName, $folder, $app)) {
+		if ($this->isCached($fileName, $folder, $app)) {
 			return true;
 		}
 		return $this->cache($path, $fileName, $folder, $app);
@@ -115,9 +115,9 @@ 
 			return false;
 		}
 
-		$fileName = $fileName . '.deps';
+		$fileName = $fileName.'.deps';
 		try {
-			$deps = $this->depsCache->get($folder->getName() . '-' . $fileName);
+			$deps = $this->depsCache->get($folder->getName().'-'.$fileName);
 			if ($deps === null || $deps === '') {
 				$depFile = $folder->getFile($fileName);
 				$deps = $depFile->getContent();
@@ -125,7 +125,7 @@ 
 
 			// check again
 			if ($deps === null || $deps === '') {
-				$this->logger->info('JSCombiner: deps file empty: ' . $fileName);
+				$this->logger->info('JSCombiner: deps file empty: '.$fileName);
 				return false;
 			}
 
@@ -142,7 +142,7 @@ 
 			}
 
 			return true;
-		} catch(NotFoundException $e) {
+		} catch (NotFoundException $e) {
 			return false;
 		}
 	}
@@ -155,17 +155,17 @@ 
 	 */
 	protected function cache($path, $fileName, ISimpleFolder $folder, $app) {
 		$deps = [];
-		$fullPath = $path . '/' . $fileName;
+		$fullPath = $path.'/'.$fileName;
 		$data = json_decode(file_get_contents($fullPath));
 		$deps[$fullPath] = filemtime($fullPath);
 
 		$res = '';
 		foreach ($data as $file) {
-			$filePath = $path . '/' . $file;
+			$filePath = $path.'/'.$file;
 
 			if (is_file($filePath)) {
 				$res .= file_get_contents($filePath);
-				$res .= PHP_EOL . PHP_EOL;
+				$res .= PHP_EOL.PHP_EOL;
 				$deps[$filePath] = filemtime($filePath);
 			}
 		}
@@ -173,11 +173,11 @@ 
 		$fileNameCached = $this->prependVersionPrefix(str_replace('.json', '.js', $fileName), $app);
 		try {
 			$cachedfile = $folder->getFile($fileNameCached);
-		} catch(NotFoundException $e) {
+		} catch (NotFoundException $e) {
 			$cachedfile = $folder->newFile($fileNameCached);
 		}
 
-		$depFileName = $fileNameCached . '.deps';
+		$depFileName = $fileNameCached.'.deps';
 		try {
 			$depFile = $folder->getFile($depFileName);
 		} catch (NotFoundException $e) {
@@ -185,21 +185,21 @@ 
 		}
 
 		try {
-			$gzipFile = $folder->getFile($fileNameCached . '.gzip'); # Safari doesn't like .gz
+			$gzipFile = $folder->getFile($fileNameCached.'.gzip'); # Safari doesn't like .gz
 		} catch (NotFoundException $e) {
-			$gzipFile = $folder->newFile($fileNameCached . '.gzip'); # Safari doesn't like .gz
+			$gzipFile = $folder->newFile($fileNameCached.'.gzip'); # Safari doesn't like .gz
 		}
 
 		try {
 			$cachedfile->putContent($res);
 			$deps = json_encode($deps);
 			$depFile->putContent($deps);
-			$this->depsCache->set($folder->getName() . '-' . $depFileName, $deps);
+			$this->depsCache->set($folder->getName().'-'.$depFileName, $deps);
 			$gzipFile->putContent(gzencode($res, 9));
-			$this->logger->debug('JSCombiner: successfully cached: ' . $fileNameCached);
+			$this->logger->debug('JSCombiner: successfully cached: '.$fileNameCached);
 			return true;
 		} catch (NotPermittedException $e) {
-			$this->logger->error('JSCombiner: unable to cache: ' . $fileNameCached);
+			$this->logger->error('JSCombiner: unable to cache: '.$fileNameCached);
 			return false;
 		}
 	}
@@ -224,8 +224,8 @@ 
 	 */
 	public function getContent($root, $file) {
 		/** @var array $data */
-		$data = json_decode(file_get_contents($root . '/' . $file));
-		if(!is_array($data)) {
+		$data = json_decode(file_get_contents($root.'/'.$file));
+		if (!is_array($data)) {
 			return [];
 		}
 
@@ -235,7 +235,7 @@ 
 
 		$result = [];
 		foreach ($data as $f) {
-			$result[] = $path . '/' . $f;
+			$result[] = $path.'/'.$f;
 		}
 
 		return $result;
@@ -266,9 +266,9 @@ 
 	private function prependVersionPrefix(string $jsFile, string $appId): string {
 		$appVersion = \OC_App::getAppVersion($appId);
 		if ($appVersion !== '0') {
-			return substr(md5($appVersion), 0, 5) . '-' . $jsFile;
+			return substr(md5($appVersion), 0, 5).'-'.$jsFile;
 		}
 		$coreVersion = \OC_Util::getVersionString();
-		return substr(md5($coreVersion), 0, 5) . '-' . $jsFile;
+		return substr(md5($coreVersion), 0, 5).'-'.$jsFile;
 	}
 }