nextcloud/apps/files_sharing/lib/Cache.php

181 lines
5.0 KiB
PHP
Raw Normal View History

<?php
/**
2016-07-21 17:49:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2015-03-26 13:44:34 +03:00
* @author Christopher Schäpers <kondou@ts.unde.re>
* @author Joas Schilling <coding@schilljs.com>
2015-03-26 13:44:34 +03:00
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Michael Gapczynski <GapczynskiM@gmail.com>
* @author Morris Jobke <hey@morrisjobke.de>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2016-07-21 17:49:16 +03:00
* @author Roeland Jago Douma <roeland@famdouma.nl>
2013-01-29 00:25:19 +04:00
*
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
2013-01-29 00:25:19 +04:00
*
2015-03-26 13:44:34 +03:00
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
2013-01-29 00:25:19 +04:00
*
2015-03-26 13:44:34 +03:00
* This program is distributed in the hope that it will be useful,
2013-01-29 00:25:19 +04:00
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 13:44:34 +03:00
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
2013-01-29 00:25:19 +04:00
*
*/
namespace OCA\Files_Sharing;
2014-03-28 18:26:15 +04:00
use OC\Files\Cache\FailedCache;
2016-01-22 15:01:37 +03:00
use OC\Files\Cache\Wrapper\CacheJail;
use OC\Files\Storage\Wrapper\Jail;
use OCP\Files\Cache\ICacheEntry;
use OCP\Files\StorageNotAvailableException;
/**
* Metadata cache for shared files
*
* don't use this class directly if you need to get metadata, use \OC\Files\Filesystem::getFileInfo instead
*/
class Cache extends CacheJail {
/**
* @var \OCA\Files_Sharing\SharedStorage
*/
2016-01-22 15:01:37 +03:00
private $storage;
2012-12-29 00:06:12 +04:00
/**
2016-01-22 15:01:37 +03:00
* @var ICacheEntry
*/
2016-01-22 15:01:37 +03:00
private $sourceRootInfo;
private $rootUnchanged = true;
private $ownerDisplayName;
private $numericId;
/**
* @param \OCA\Files_Sharing\SharedStorage $storage
2016-01-22 15:01:37 +03:00
* @param ICacheEntry $sourceRootInfo
*/
public function __construct($storage, ICacheEntry $sourceRootInfo) {
2016-01-22 15:01:37 +03:00
$this->storage = $storage;
$this->sourceRootInfo = $sourceRootInfo;
$this->numericId = $sourceRootInfo->getStorageId();
2016-01-22 15:01:37 +03:00
parent::__construct(
null,
''
2016-01-22 15:01:37 +03:00
);
}
protected function getRoot() {
if ($this->root === '') {
$absoluteRoot = $this->sourceRootInfo->getPath();
// the sourceRootInfo path is the absolute path of the folder in the "real" storage
// in the case where a folder is shared from a Jail we need to ensure that the share Jail
// has it's root set relative to the source Jail
$currentStorage = $this->storage->getSourceStorage();
if ($currentStorage->instanceOfStorage(Jail::class)) {
/** @var Jail $currentStorage */
$absoluteRoot = $currentStorage->getJailedPath($absoluteRoot);
}
$this->root = $absoluteRoot;
}
return $this->root;
}
public function getCache() {
if (is_null($this->cache)) {
$sourceStorage = $this->storage->getSourceStorage();
if ($sourceStorage) {
$this->cache = $sourceStorage->getCache();
} else {
// don't set $this->cache here since sourceStorage will be set later
return new FailedCache();
}
}
return $this->cache;
}
public function getNumericStorageId() {
if (isset($this->numericId)) {
return $this->numericId;
} else {
return false;
}
}
public function get($file) {
if ($this->rootUnchanged && ($file === '' || $file === $this->sourceRootInfo->getId())) {
return $this->formatCacheEntry(clone $this->sourceRootInfo, '');
}
return parent::get($file);
}
public function update($id, array $data) {
$this->rootUnchanged = false;
parent::update($id, $data);
}
public function insert($file, array $data) {
$this->rootUnchanged = false;
return parent::insert($file, $data);
}
public function remove($file) {
$this->rootUnchanged = false;
parent::remove($file);
}
public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
$this->rootUnchanged = false;
return parent::moveFromCache($sourceCache, $sourcePath, $targetPath);
}
protected function formatCacheEntry($entry, $path = null) {
if (is_null($path)) {
$path = $entry['path'] ?? '';
$entry['path'] = $this->getJailedPath($path);
} else {
$entry['path'] = $path;
}
try {
$sharePermissions = $this->storage->getPermissions($entry['path']);
} catch (StorageNotAvailableException $e) {
// thrown by FailedStorage e.g. when the sharer does not exist anymore
// (IDE may say the exception is never thrown false negative)
$sharePermissions = 0;
}
2016-01-22 15:01:37 +03:00
if (isset($entry['permissions'])) {
$entry['permissions'] &= $sharePermissions;
} else {
$entry['permissions'] = $sharePermissions;
2013-01-08 05:52:51 +04:00
}
$entry['uid_owner'] = $this->storage->getOwner('');
$entry['displayname_owner'] = $this->getOwnerDisplayName();
2016-01-22 15:01:37 +03:00
if ($path === '') {
$entry['is_share_mount_point'] = true;
}
2016-01-22 15:01:37 +03:00
return $entry;
}
private function getOwnerDisplayName() {
if (!$this->ownerDisplayName) {
$this->ownerDisplayName = \OC_User::getDisplayName($this->storage->getOwner(''));
}
return $this->ownerDisplayName;
}
/**
* remove all entries for files that are stored on the storage from the cache
*/
public function clear() {
// Not a valid action for Shared Cache
}
}