mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #24113 from nextcloud/extend-cache-events 

extend cache events
This commit is contained in:
Roeland Jago Douma 2020-12-02 19:48:20 +01:00 committed by GitHub
parent 82cc9c1382 aef1cdba03
commit 6f4d3edb5e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 159 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lib/composer/composer/autoload_classmap.php
View File

@ -219,6 +219,9 @@ return array(
'OCP\\Federation\\ICloudIdManager' => $baseDir . '/lib/public/Federation/ICloudIdManager.php',
'OCP\\Files' => $baseDir . '/lib/public/Files.php',
'OCP\\Files\\AlreadyExistsException' => $baseDir . '/lib/public/Files/AlreadyExistsException.php',
'OCP\\Files\\Cache\\CacheEntryInsertedEvent' => $baseDir . '/lib/public/Files/Cache/CacheEntryInsertedEvent.php',
'OCP\\Files\\Cache\\CacheEntryRemovedEvent' => $baseDir . '/lib/public/Files/Cache/CacheEntryRemovedEvent.php',
'OCP\\Files\\Cache\\CacheEntryUpdatedEvent' => $baseDir . '/lib/public/Files/Cache/CacheEntryUpdatedEvent.php',
'OCP\\Files\\Cache\\CacheInsertEvent' => $baseDir . '/lib/public/Files/Cache/CacheInsertEvent.php',
'OCP\\Files\\Cache\\CacheUpdateEvent' => $baseDir . '/lib/public/Files/Cache/CacheUpdateEvent.php',
'OCP\\Files\\Cache\\ICache' => $baseDir . '/lib/public/Files/Cache/ICache.php',

3
lib/composer/composer/autoload_static.php
View File

@ -248,6 +248,9 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
'OCP\\Federation\\ICloudIdManager' => __DIR__ . '/../../..' . '/lib/public/Federation/ICloudIdManager.php',
'OCP\\Files' => __DIR__ . '/../../..' . '/lib/public/Files.php',
'OCP\\Files\\AlreadyExistsException' => __DIR__ . '/../../..' . '/lib/public/Files/AlreadyExistsException.php',
'OCP\\Files\\Cache\\CacheEntryInsertedEvent' => __DIR__ . '/../../..' . '/lib/public/Files/Cache/CacheEntryInsertedEvent.php',
'OCP\\Files\\Cache\\CacheEntryRemovedEvent' => __DIR__ . '/../../..' . '/lib/public/Files/Cache/CacheEntryRemovedEvent.php',
'OCP\\Files\\Cache\\CacheEntryUpdatedEvent' => __DIR__ . '/../../..' . '/lib/public/Files/Cache/CacheEntryUpdatedEvent.php',
'OCP\\Files\\Cache\\CacheInsertEvent' => __DIR__ . '/../../..' . '/lib/public/Files/Cache/CacheInsertEvent.php',
'OCP\\Files\\Cache\\CacheUpdateEvent' => __DIR__ . '/../../..' . '/lib/public/Files/Cache/CacheUpdateEvent.php',
'OCP\\Files\\Cache\\ICache' => __DIR__ . '/../../..' . '/lib/public/Files/Cache/ICache.php',

12
lib/private/Files/Cache/AbstractCacheEvent.php
View File

@ -36,6 +36,7 @@ class AbstractCacheEvent extends Event implements ICacheEvent {
protected $storage;
protected $path;
protected $fileId;
protected $storageId;
/**
* @param IStorage $storage
@ -43,10 +44,11 @@ class AbstractCacheEvent extends Event implements ICacheEvent {
* @param int $fileId
* @since 16.0.0
*/
public function __construct(IStorage $storage, string $path, int $fileId) {
public function __construct(IStorage $storage, string $path, int $fileId, int $storageId) {
$this->storage = $storage;
$this->path = $path;
$this->fileId = $fileId;
$this->storageId = $storageId;
}
/**
@ -80,4 +82,12 @@ class AbstractCacheEvent extends Event implements ICacheEvent {
public function getFileId(): int {
return $this->fileId;
}
/**
* @return int
* @since 21.0.0
*/
public function getStorageId(): int {
return $this->storageId;
}
}

33
lib/private/Files/Cache/Cache.php
View File

@ -41,7 +41,11 @@ namespace OC\Files\Cache;
use Doctrine\DBAL\Driver\Statement;
use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\Files\Cache\CacheEntryInsertedEvent;
use OCP\Files\Cache\CacheEntryUpdatedEvent;
use OCP\Files\Cache\CacheInsertEvent;
use OCP\Files\Cache\CacheEntryRemovedEvent;
use OCP\Files\Cache\CacheUpdateEvent;
use OCP\Files\Cache\ICache;
use OCP\Files\Cache\ICacheEntry;
@ -91,6 +95,9 @@ class Cache implements ICache {
*/
protected $connection;
/**
* @var IEventDispatcher
*/
protected $eventDispatcher;
/** @var QuerySearchHelper */
@ -109,7 +116,7 @@ class Cache implements ICache {
$this->storageCache = new Storage($storage);
$this->mimetypeLoader = \OC::$server->getMimeTypeLoader();
$this->connection = \OC::$server->getDatabaseConnection();
$this->eventDispatcher = \OC::$server->getEventDispatcher();
$this->eventDispatcher = \OC::$server->get(IEventDispatcher::class);
$this->querySearchHelper = new QuerySearchHelper($this->mimetypeLoader);
}
@ -284,7 +291,8 @@ class Cache implements ICache {
$data['name'] = basename($file);
[$values, $extensionValues] = $this->normalizeData($data);
$values['storage'] = $this->getNumericStorageId();
$storageId = $this->getNumericStorageId();
$values['storage'] = $storageId;
try {
$builder = $this->connection->getQueryBuilder();
@ -308,7 +316,9 @@ class Cache implements ICache {
$query->execute();
}
$this->eventDispatcher->dispatch(CacheInsertEvent::class, new CacheInsertEvent($this->storage, $file, $fileId));
$event = new CacheEntryInsertedEvent($this->storage, $file, $fileId, $storageId);
$this->eventDispatcher->dispatch(CacheInsertEvent::class, $event);
$this->eventDispatcher->dispatchTyped($event);
return $fileId;
}
} catch (UniqueConstraintViolationException $e) {
@ -399,7 +409,9 @@ class Cache implements ICache {
$path = $this->getPathById($id);
// path can still be null if the file doesn't exist
if ($path !== null) {
$this->eventDispatcher->dispatch(CacheUpdateEvent::class, new CacheUpdateEvent($this->storage, $path, $id));
$event = new CacheEntryUpdatedEvent($this->storage, $path, $id, $this->getNumericStorageId());
$this->eventDispatcher->dispatch(CacheUpdateEvent::class, $event);
$this->eventDispatcher->dispatchTyped($event);
}
}
@ -536,6 +548,8 @@ class Cache implements ICache {
if ($entry->getMimeType() == FileInfo::MIMETYPE_FOLDER) {
$this->removeChildren($entry);
}
$this->eventDispatcher->dispatchTyped(new CacheEntryRemovedEvent($this->storage, $entry->getPath(), $entry->getId(), $this->getNumericStorageId()));
}
}
@ -677,6 +691,17 @@ class Cache implements ICache {
$query->execute();
$this->connection->commit();
if ($sourceCache->getNumericStorageId() !== $this->getNumericStorageId()) {
$this->eventDispatcher->dispatchTyped(new CacheEntryRemovedEvent($this->storage, $sourcePath, $sourceId, $sourceCache->getNumericStorageId()));
$event = new CacheEntryInsertedEvent($this->storage, $targetPath, $sourceId, $this->getNumericStorageId());
$this->eventDispatcher->dispatch(CacheInsertEvent::class, $event);
$this->eventDispatcher->dispatchTyped($event);
} else {
$event = new CacheEntryUpdatedEvent($this->storage, $targetPath, $sourceId, $this->getNumericStorageId());
$this->eventDispatcher->dispatch(CacheUpdateEvent::class, $event);
$this->eventDispatcher->dispatchTyped($event);
}
} else {
$this->moveFromCacheFallback($sourceCache, $sourcePath, $targetPath);
}

2
lib/private/Files/Cache/CacheEntry.php
View File

@ -67,7 +67,7 @@ class CacheEntry implements ICacheEntry {
public function getPath() {
return $this->data['path'];
return (string)$this->data['path'];
}

34
lib/public/Files/Cache/CacheEntryInsertedEvent.php Normal file
View File

@ -0,0 +1,34 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2020 Robin Appelman <robin@icewind.nl>
*
* @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 OCP\Files\Cache;
use OC\Files\Cache\AbstractCacheEvent;
/**
* Event for when an existing entry in the cache gets inserted
*
* @since 21.0.0
*/
class CacheEntryInsertedEvent extends AbstractCacheEvent implements ICacheEvent {
}

34
lib/public/Files/Cache/CacheEntryRemovedEvent.php Normal file
View File

@ -0,0 +1,34 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2020 Robin Appelman <robin@icewind.nl>
*
* @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 OCP\Files\Cache;
use OC\Files\Cache\AbstractCacheEvent;
/**
* Event for when an existing entry in the cache gets removed
*
* @since 21.0.0
*/
class CacheEntryRemovedEvent extends AbstractCacheEvent implements ICacheEvent {
}

34
lib/public/Files/Cache/CacheEntryUpdatedEvent.php Normal file
View File

@ -0,0 +1,34 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2020 Robin Appelman <robin@icewind.nl>
*
* @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 OCP\Files\Cache;
use OC\Files\Cache\AbstractCacheEvent;
/**
* Event for when an existing entry in the cache gets updated
*
* @since 21.0.0
*/
class CacheEntryUpdatedEvent extends AbstractCacheEvent implements ICacheEvent {
}

5
lib/public/Files/Cache/CacheInsertEvent.php
View File

@ -26,12 +26,11 @@ declare(strict_types=1);
namespace OCP\Files\Cache;
use OC\Files\Cache\AbstractCacheEvent;
/**
* Event for when a new entry gets added to the cache
*
* @since 16.0.0
* @deprecated 21.0.0 use CacheEntryInsertedEvent instead
*/
class CacheInsertEvent extends AbstractCacheEvent {
class CacheInsertEvent extends CacheEntryInsertedEvent {
}

5
lib/public/Files/Cache/CacheUpdateEvent.php
View File

@ -26,12 +26,11 @@ declare(strict_types=1);
namespace OCP\Files\Cache;
use OC\Files\Cache\AbstractCacheEvent;
/**
* Event for when an existing entry in the cache gets updated
*
* @since 16.0.0
* @deprecated 21.0.0 use CacheEntryUpdatedEvent instead
*/
class CacheUpdateEvent extends AbstractCacheEvent {
class CacheUpdateEvent extends CacheEntryUpdatedEvent {
}

6
lib/public/Files/Cache/ICacheEvent.php
View File

@ -56,4 +56,10 @@ interface ICacheEvent {
* @since 16.0.0
*/
public function getFileId(): int;
/**
* @return int
* @since 21.0.0
*/
public function getStorageId(): int;
}