From 31313178a56d6c173a45e7e89546da1f5d43052a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Fri, 26 Jan 2018 17:46:42 +0100 Subject: [PATCH] Add repair step to clear frontend related caches MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- lib/private/Repair.php | 4 ++ lib/private/Repair/ClearFrontendCaches.php | 78 ++++++++++++++++++++++ lib/private/Server.php | 12 ++++ lib/private/Template/JSCombiner.php | 21 +++++- lib/private/Template/SCSSCacher.php | 9 ++- 5 files changed, 118 insertions(+), 6 deletions(-) create mode 100644 lib/private/Repair/ClearFrontendCaches.php diff --git a/lib/private/Repair.php b/lib/private/Repair.php index 8562465aad..3ddcf0acce 100644 --- a/lib/private/Repair.php +++ b/lib/private/Repair.php @@ -33,6 +33,7 @@ namespace OC; use OC\App\AppStore\Bundles\BundleFetcher; use OC\Files\AppData\Factory; use OC\Repair\CleanTags; +use OC\Repair\ClearFrontendCaches; use OC\Repair\Collation; use OC\Repair\MoveUpdaterStepFile; use OC\Repair\NC11\CleanPreviews; @@ -50,6 +51,8 @@ use OC\Repair\NC13\RepairInvalidPaths; use OC\Repair\SqliteAutoincrement; use OC\Repair\RepairMimeTypes; use OC\Repair\RepairInvalidShares; +use OC\Template\JSCombiner; +use OC\Template\SCSSCacher; use OCP\AppFramework\QueryException; use OCP\Migration\IOutput; use OCP\Migration\IRepairStep; @@ -152,6 +155,7 @@ class Repair implements IOutput{ new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()), new RepairIdentityProofKeyFolders(\OC::$server->getConfig(), \OC::$server->query(Factory::class), \OC::$server->getRootFolder()), new AddLogRotateJob(\OC::$server->getJobList()), + new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OC::$server->query(SCSSCacher::class), \OC::$server->query(JSCombiner::class)) ]; } diff --git a/lib/private/Repair/ClearFrontendCaches.php b/lib/private/Repair/ClearFrontendCaches.php new file mode 100644 index 0000000000..8d109462f6 --- /dev/null +++ b/lib/private/Repair/ClearFrontendCaches.php @@ -0,0 +1,78 @@ + + * + * @author Julius Härtl + * + * @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 . + * + */ + +namespace OC\Repair; + +use OC\Core\Command\Maintenance\ClearCacheJSCSS; +use OC\Template\JSCombiner; +use OC\Template\SCSSCacher; +use OCP\AppFramework\QueryException; +use OCP\ICacheFactory; +use OCP\Migration\IOutput; +use OCP\Migration\IRepairStep; +use Symfony\Component\Console\Input\StringInput; +use Symfony\Component\Console\Output\BufferedOutput; + +class ClearFrontendCaches implements 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; + } + + public function getName() { + return 'Clear frontend caches'; + } + + public function run(IOutput $output) { + try { + $c = $this->cacheFactory->createDistributed('imagePath'); + $c->clear(''); + $output->info('Image cache cleared'); + + $this->scssCacher->resetCache(); + $c = $this->cacheFactory->createDistributed('SCSS'); + $c->clear(''); + $output->info('SCSS cache cleared'); + + $this->jsCombiner->resetCache(); + $c = $this->cacheFactory->createDistributed('JS'); + $c->clear(''); + $output->info('JS cache cleared'); + } catch (\Exception $e) { + $output->warning('Unable to clear the frontend cache'); + } + } +} diff --git a/lib/private/Server.php b/lib/private/Server.php index 4a851d6722..fa22e52eee 100644 --- a/lib/private/Server.php +++ b/lib/private/Server.php @@ -109,6 +109,7 @@ use OC\Security\TrustedDomainHelper; use OC\Session\CryptoWrapper; use OC\Share20\ShareHelper; use OC\Tagging\TagMapper; +use OC\Template\JSCombiner; use OC\Template\SCSSCacher; use OCA\Theming\ThemingDefaults; @@ -956,6 +957,17 @@ class Server extends ServerContainer implements IServerContainer { $cacheFactory->createDistributed('SCSS') ); }); + $this->registerService(JSCombiner::class, function (Server $c) { + /** @var Factory $cacheFactory */ + $cacheFactory = $c->query(Factory::class); + return new JSCombiner( + $c->getAppDataDir('js'), + $c->getURLGenerator(), + $cacheFactory->createDistributed('JS'), + $c->getSystemConfig(), + $c->getLogger() + ); + }); $this->registerService(EventDispatcher::class, function () { return new EventDispatcher(); }); diff --git a/lib/private/Template/JSCombiner.php b/lib/private/Template/JSCombiner.php index 6a67dd0ded..b95a59834a 100644 --- a/lib/private/Template/JSCombiner.php +++ b/lib/private/Template/JSCombiner.php @@ -184,9 +184,10 @@ class JSCombiner { $depFile->putContent($deps); $this->depsCache->set($folder->getName() . '-' . $depFileName, $deps); $gzipFile->putContent(gzencode($res, 9)); - + $this->logger->debug('JSCombiner: successfully cached: ' . $fileName); return true; } catch (NotPermittedException $e) { + $this->logger->error('JSCombiner: unable to cache: ' . $fileName); return false; } } @@ -227,4 +228,22 @@ class JSCombiner { return $result; } + + + /** + * Clear cache with combined javascript files + * + * @throws NotFoundException + */ + public function resetCache() { + $appDirectory = $this->appData->getDirectoryListing(); + if(empty($appDirectory)){ + return; + } + foreach ($appDirectory as $folder) { + foreach ($folder->getDirectoryListing() as $file) { + $file->delete(); + } + } + } } diff --git a/lib/private/Template/SCSSCacher.php b/lib/private/Template/SCSSCacher.php index c6473ead09..3246245543 100644 --- a/lib/private/Template/SCSSCacher.php +++ b/lib/private/Template/SCSSCacher.php @@ -242,9 +242,10 @@ class SCSSCacher { $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']); + $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; } } @@ -253,7 +254,7 @@ class SCSSCacher { * Reset scss cache by deleting all generated css files * We need to regenerate all files when variables change */ - private function resetCache() { + public function resetCache() { $this->injectedVariables = null; $appDirectory = $this->appData->getDirectoryListing(); if(empty($appDirectory)){ @@ -261,9 +262,7 @@ class SCSSCacher { } foreach ($appDirectory as $folder) { foreach ($folder->getDirectoryListing() as $file) { - if (substr($file->getName(), -3) === "css" || substr($file->getName(), -4) === "deps") { - $file->delete(); - } + $file->delete(); } } }