← Back
Editing: Watcher.php
<?php /** * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors * SPDX-FileCopyrightText: 2016 ownCloud, Inc. * SPDX-License-Identifier: AGPL-3.0-only */ namespace OC\Files\Cache; use OCP\Files\Cache\ICache; use OCP\Files\Cache\ICacheEntry; use OCP\Files\Cache\IScanner; use OCP\Files\Cache\IWatcher; use OCP\Files\Storage\IStorage; /** * check the storage backends for updates and change the cache accordingly */ class Watcher implements IWatcher { protected $watchPolicy = self::CHECK_ONCE; protected $checkedPaths = []; /** * @var IStorage $storage */ protected $storage; /** * @var ICache $cache */ protected $cache; /** * @var IScanner $scanner ; */ protected $scanner; /** @var callable[] */ protected $onUpdate = []; protected ?string $checkFilter = null; public function __construct(IStorage $storage) { $this->storage = $storage; $this->cache = $storage->getCache(); $this->scanner = $storage->getScanner(); } /** * @param int $policy either \OC\Files\Cache\Watcher::CHECK_NEVER, \OC\Files\Cache\Watcher::CHECK_ONCE, \OC\Files\Cache\Watcher::CHECK_ALWAYS */ public function setPolicy($policy) { $this->watchPolicy = $policy; } public function setCheckFilter(?string $filter): void { $this->checkFilter = $filter; } /** * @return int either \OC\Files\Cache\Watcher::CHECK_NEVER, \OC\Files\Cache\Watcher::CHECK_ONCE, \OC\Files\Cache\Watcher::CHECK_ALWAYS */ public function getPolicy() { return $this->watchPolicy; } /** * check $path for updates and update if needed * * @param string $path * @param ICacheEntry|null $cachedEntry * @return boolean true if path was updated */ public function checkUpdate($path, $cachedEntry = null) { if (is_null($cachedEntry)) { $cachedEntry = $this->cache->get($path); } if ($cachedEntry === false || $this->needsUpdate($path, $cachedEntry)) { $this->update($path, $cachedEntry); if ($cachedEntry === false) { return true; } else { // storage backends can sometimes return false positives, only return true if the scanner actually found a change $newEntry = $this->cache->get($path); return $newEntry->getStorageMTime() > $cachedEntry->getStorageMTime(); } } else { return false; } } /** * Update the cache for changes to $path * * @param string $path * @param ICacheEntry $cachedData */ public function update($path, $cachedData) { if ($this->storage->is_dir($path)) { $this->scanner->scan($path, Scanner::SCAN_SHALLOW); } else { $this->scanner->scanFile($path); } if (is_array($cachedData) && $cachedData['mimetype'] === 'httpd/unix-directory') { $this->cleanFolder($path); } if ($this->cache instanceof Cache) { $this->cache->correctFolderSize($path); } foreach ($this->onUpdate as $callback) { $callback($path); } } /** * Check if the cache for $path needs to be updated * * @param string $path * @param ICacheEntry $cachedData * @return bool */ public function needsUpdate($path, $cachedData) { if ($this->checkFilter !== null) { if (!preg_match($this->checkFilter, $path)) { return false; } } if ($this->watchPolicy === self::CHECK_ALWAYS || ($this->watchPolicy === self::CHECK_ONCE && !in_array($path, $this->checkedPaths))) { $this->checkedPaths[] = $path; return $cachedData['storage_mtime'] === null || $this->storage->hasUpdated($path, $cachedData['storage_mtime']); } return false; } /** * remove deleted files in $path from the cache * * @param string $path */ public function cleanFolder($path) { $cachedContent = $this->cache->getFolderContents($path); foreach ($cachedContent as $entry) { if (!$this->storage->file_exists($entry['path'])) { $this->cache->remove($entry['path']); } } } /** * register a callback to be called whenever the watcher triggers and update */ public function onUpdate(callable $callback): void { $this->onUpdate[] = $callback; } }
Save File
Cancel