add ICopyFromCache trait to expose existing implementation

Signed-off-by: Robin Appelman <robin@icewind.nl>
This commit is contained in:
Robin Appelman 2021-03-08 18:49:08 +01:00 committed by backportbot[bot]
parent f9c9e27e46
commit 603ec9be0c
3 changed files with 54 additions and 35 deletions

View File

@ -598,7 +598,7 @@ class Cache implements ICache {
/**
* Move a file or folder in the cache
*
* @param \OCP\Files\Cache\ICache $sourceCache
* @param ICache $sourceCache
* @param string $sourcePath
* @param string $targetPath
* @throws \OC\DatabaseException
@ -992,4 +992,44 @@ class Cache implements ICache {
public function normalize($path) {
return trim(\OC_Util::normalizeUnicode($path), '/');
}
/**
* Copy a file or folder in the cache
*
* @param ICache $sourceCache
* @param ICacheEntry $sourceEntry
* @param string $targetPath
* @return int fileid of copied entry
*/
public function copyFromCache(ICache $sourceCache, ICacheEntry $sourceEntry, string $targetPath): int {
$data = $this->cacheEntryToArray($sourceEntry);
$fileId = $this->put($targetPath, $data);
if ($fileId <= 0) {
throw new \RuntimeException("Failed to copy to " . $targetPath . " from cache with source data " . json_encode($data) . " ");
}
if ($sourceEntry->getMimeType() === ICacheEntry::DIRECTORY_MIMETYPE) {
$folderContent = $sourceCache->getFolderContentsById($sourceEntry->getId());
foreach ($folderContent as $subEntry) {
$subTargetPath = $targetPath . '/' . $subEntry->getName();
$this->copyFromCache($sourceCache, $subEntry, $subTargetPath);
}
}
return $fileId;
}
private function cacheEntryToArray(ICacheEntry $entry): array {
return [
'size' => $entry->getSize(),
'mtime' => $entry->getMTime(),
'storage_mtime' => $entry->getStorageMTime(),
'mimetype' => $entry->getMimeType(),
'mimepart' => $entry->getMimePart(),
'etag' => $entry->getEtag(),
'permissions' => $entry->getPermissions(),
'encrypted' => $entry->isEncrypted(),
'creation_time' => $entry->getCreationTime(),
'upload_time' => $entry->getUploadTime(),
'metadata_etag' => $entry->getMetadataEtag(),
];
}
}

View File

@ -41,6 +41,8 @@ trait MoveFromCacheTrait {
*/
abstract public function put($file, array $data);
abstract public function copyFromCache(ICache $sourceCache, ICacheEntry $sourceEntry, string $targetPath): int;
/**
* Move a file or folder in the cache
*
@ -55,38 +57,4 @@ trait MoveFromCacheTrait {
$sourceCache->remove($sourcePath);
}
/**
* Copy a file or folder in the cache
*
* @param \OCP\Files\Cache\ICache $sourceCache
* @param ICacheEntry $sourceEntry
* @param string $targetPath
*/
public function copyFromCache(ICache $sourceCache, ICacheEntry $sourceEntry, $targetPath) {
$this->put($targetPath, $this->cacheEntryToArray($sourceEntry));
if ($sourceEntry->getMimeType() === ICacheEntry::DIRECTORY_MIMETYPE) {
$folderContent = $sourceCache->getFolderContentsById($sourceEntry->getId());
foreach ($folderContent as $subEntry) {
$subTargetPath = $targetPath . '/' . $subEntry->getName();
$this->copyFromCache($sourceCache, $subEntry, $subTargetPath);
}
}
}
private function cacheEntryToArray(ICacheEntry $entry) {
return [
'size' => $entry->getSize(),
'mtime' => $entry->getMTime(),
'storage_mtime' => $entry->getStorageMTime(),
'mimetype' => $entry->getMimeType(),
'mimepart' => $entry->getMimePart(),
'etag' => $entry->getEtag(),
'permissions' => $entry->getPermissions(),
'encrypted' => $entry->isEncrypted(),
'creation_time' => $entry->getCreationTime(),
'upload_time' => $entry->getUploadTime(),
'metadata_etag' => $entry->getMetadataEtag(),
];
}
}

View File

@ -179,6 +179,17 @@ interface ICache {
*/
public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath);
/**
* Copy a file or folder in the cache
*
* @param ICache $sourceCache
* @param ICacheEntry $sourceEntry
* @param string $targetPath
* @return int fileid of copied entry
* @since 22.0.0
*/
public function copyFromCache(ICache $sourceCache, ICacheEntry $sourceEntry, string $targetPath): int;
/**
* Get the scan status of a file
*