@@ -29,52 +29,52 @@ |
||
| 29 | 29 | |
| 30 | 30 | class NoopScanner extends Scanner { |
| 31 | 31 | |
| 32 | - public function __construct(Storage $storage) { |
|
| 33 | - //we don't need the storage, so do nothing here |
|
| 34 | - } |
|
| 32 | + public function __construct(Storage $storage) { |
|
| 33 | + //we don't need the storage, so do nothing here |
|
| 34 | + } |
|
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * scan a single file and store it in the cache |
|
| 38 | - * |
|
| 39 | - * @param string $file |
|
| 40 | - * @param int $reuseExisting |
|
| 41 | - * @param int $parentId |
|
| 42 | - * @param array|null $cacheData existing data in the cache for the file to be scanned |
|
| 43 | - * @return array an array of metadata of the scanned file |
|
| 44 | - */ |
|
| 45 | - public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true) { |
|
| 46 | - return array(); |
|
| 47 | - } |
|
| 36 | + /** |
|
| 37 | + * scan a single file and store it in the cache |
|
| 38 | + * |
|
| 39 | + * @param string $file |
|
| 40 | + * @param int $reuseExisting |
|
| 41 | + * @param int $parentId |
|
| 42 | + * @param array|null $cacheData existing data in the cache for the file to be scanned |
|
| 43 | + * @return array an array of metadata of the scanned file |
|
| 44 | + */ |
|
| 45 | + public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true) { |
|
| 46 | + return array(); |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * scan a folder and all it's children |
|
| 51 | - * |
|
| 52 | - * @param string $path |
|
| 53 | - * @param bool $recursive |
|
| 54 | - * @param int $reuse |
|
| 55 | - * @return array with the meta data of the scanned file or folder |
|
| 56 | - */ |
|
| 57 | - public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true) { |
|
| 58 | - return array(); |
|
| 59 | - } |
|
| 49 | + /** |
|
| 50 | + * scan a folder and all it's children |
|
| 51 | + * |
|
| 52 | + * @param string $path |
|
| 53 | + * @param bool $recursive |
|
| 54 | + * @param int $reuse |
|
| 55 | + * @return array with the meta data of the scanned file or folder |
|
| 56 | + */ |
|
| 57 | + public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true) { |
|
| 58 | + return array(); |
|
| 59 | + } |
|
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * scan all the files and folders in a folder |
|
| 63 | - * |
|
| 64 | - * @param string $path |
|
| 65 | - * @param bool $recursive |
|
| 66 | - * @param int $reuse |
|
| 67 | - * @param array $folderData existing cache data for the folder to be scanned |
|
| 68 | - * @return int the size of the scanned folder or -1 if the size is unknown at this stage |
|
| 69 | - */ |
|
| 70 | - protected function scanChildren($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $folderData = null, $lock = true) { |
|
| 71 | - return 0; |
|
| 72 | - } |
|
| 61 | + /** |
|
| 62 | + * scan all the files and folders in a folder |
|
| 63 | + * |
|
| 64 | + * @param string $path |
|
| 65 | + * @param bool $recursive |
|
| 66 | + * @param int $reuse |
|
| 67 | + * @param array $folderData existing cache data for the folder to be scanned |
|
| 68 | + * @return int the size of the scanned folder or -1 if the size is unknown at this stage |
|
| 69 | + */ |
|
| 70 | + protected function scanChildren($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $folderData = null, $lock = true) { |
|
| 71 | + return 0; |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * walk over any folders that are not fully scanned yet and scan them |
|
| 76 | - */ |
|
| 77 | - public function backgroundScan() { |
|
| 78 | - //noop |
|
| 79 | - } |
|
| 74 | + /** |
|
| 75 | + * walk over any folders that are not fully scanned yet and scan them |
|
| 76 | + */ |
|
| 77 | + public function backgroundScan() { |
|
| 78 | + //noop |
|
| 79 | + } |
|
| 80 | 80 | } |
@@ -31,25 +31,25 @@ |
||
| 31 | 31 | * Map a user to a bucket. |
| 32 | 32 | */ |
| 33 | 33 | class Mapper { |
| 34 | - /** @var IUser */ |
|
| 35 | - private $user; |
|
| 34 | + /** @var IUser */ |
|
| 35 | + private $user; |
|
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * Mapper constructor. |
|
| 39 | - * |
|
| 40 | - * @param IUser $user |
|
| 41 | - */ |
|
| 42 | - public function __construct(IUser $user) { |
|
| 43 | - $this->user = $user; |
|
| 44 | - } |
|
| 37 | + /** |
|
| 38 | + * Mapper constructor. |
|
| 39 | + * |
|
| 40 | + * @param IUser $user |
|
| 41 | + */ |
|
| 42 | + public function __construct(IUser $user) { |
|
| 43 | + $this->user = $user; |
|
| 44 | + } |
|
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @param int $numBuckets |
|
| 48 | - * @return string |
|
| 49 | - */ |
|
| 50 | - public function getBucket($numBuckets = 64) { |
|
| 51 | - $hash = md5($this->user->getUID()); |
|
| 52 | - $num = hexdec(substr($hash, 0, 4)); |
|
| 53 | - return (string)($num % $numBuckets); |
|
| 54 | - } |
|
| 46 | + /** |
|
| 47 | + * @param int $numBuckets |
|
| 48 | + * @return string |
|
| 49 | + */ |
|
| 50 | + public function getBucket($numBuckets = 64) { |
|
| 51 | + $hash = md5($this->user->getUID()); |
|
| 52 | + $num = hexdec(substr($hash, 0, 4)); |
|
| 53 | + return (string)($num % $numBuckets); |
|
| 54 | + } |
|
| 55 | 55 | } |
@@ -25,38 +25,38 @@ |
||
| 25 | 25 | namespace OC\Files\Type; |
| 26 | 26 | |
| 27 | 27 | class TemplateManager { |
| 28 | - protected $templates = array(); |
|
| 28 | + protected $templates = array(); |
|
| 29 | 29 | |
| 30 | - public function registerTemplate($mimetype, $path) { |
|
| 31 | - $this->templates[$mimetype] = $path; |
|
| 32 | - } |
|
| 30 | + public function registerTemplate($mimetype, $path) { |
|
| 31 | + $this->templates[$mimetype] = $path; |
|
| 32 | + } |
|
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * get the path of the template for a mimetype |
|
| 36 | - * |
|
| 37 | - * @param string $mimetype |
|
| 38 | - * @return string|null |
|
| 39 | - */ |
|
| 40 | - public function getTemplatePath($mimetype) { |
|
| 41 | - if (isset($this->templates[$mimetype])) { |
|
| 42 | - return $this->templates[$mimetype]; |
|
| 43 | - } else { |
|
| 44 | - return null; |
|
| 45 | - } |
|
| 46 | - } |
|
| 34 | + /** |
|
| 35 | + * get the path of the template for a mimetype |
|
| 36 | + * |
|
| 37 | + * @param string $mimetype |
|
| 38 | + * @return string|null |
|
| 39 | + */ |
|
| 40 | + public function getTemplatePath($mimetype) { |
|
| 41 | + if (isset($this->templates[$mimetype])) { |
|
| 42 | + return $this->templates[$mimetype]; |
|
| 43 | + } else { |
|
| 44 | + return null; |
|
| 45 | + } |
|
| 46 | + } |
|
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * get the template content for a mimetype |
|
| 50 | - * |
|
| 51 | - * @param string $mimetype |
|
| 52 | - * @return string |
|
| 53 | - */ |
|
| 54 | - public function getTemplate($mimetype) { |
|
| 55 | - $path = $this->getTemplatePath($mimetype); |
|
| 56 | - if ($path) { |
|
| 57 | - return file_get_contents($path); |
|
| 58 | - } else { |
|
| 59 | - return ''; |
|
| 60 | - } |
|
| 61 | - } |
|
| 48 | + /** |
|
| 49 | + * get the template content for a mimetype |
|
| 50 | + * |
|
| 51 | + * @param string $mimetype |
|
| 52 | + * @return string |
|
| 53 | + */ |
|
| 54 | + public function getTemplate($mimetype) { |
|
| 55 | + $path = $this->getTemplatePath($mimetype); |
|
| 56 | + if ($path) { |
|
| 57 | + return file_get_contents($path); |
|
| 58 | + } else { |
|
| 59 | + return ''; |
|
| 60 | + } |
|
| 61 | + } |
|
| 62 | 62 | } |
@@ -30,58 +30,58 @@ |
||
| 30 | 30 | |
| 31 | 31 | class SimpleFolder implements ISimpleFolder { |
| 32 | 32 | |
| 33 | - /** @var Folder */ |
|
| 34 | - private $folder; |
|
| 33 | + /** @var Folder */ |
|
| 34 | + private $folder; |
|
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * Folder constructor. |
|
| 38 | - * |
|
| 39 | - * @param Folder $folder |
|
| 40 | - */ |
|
| 41 | - public function __construct(Folder $folder) { |
|
| 42 | - $this->folder = $folder; |
|
| 43 | - } |
|
| 36 | + /** |
|
| 37 | + * Folder constructor. |
|
| 38 | + * |
|
| 39 | + * @param Folder $folder |
|
| 40 | + */ |
|
| 41 | + public function __construct(Folder $folder) { |
|
| 42 | + $this->folder = $folder; |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - public function getName() { |
|
| 46 | - return $this->folder->getName(); |
|
| 47 | - } |
|
| 45 | + public function getName() { |
|
| 46 | + return $this->folder->getName(); |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | - public function getDirectoryListing() { |
|
| 50 | - $listing = $this->folder->getDirectoryListing(); |
|
| 49 | + public function getDirectoryListing() { |
|
| 50 | + $listing = $this->folder->getDirectoryListing(); |
|
| 51 | 51 | |
| 52 | - $fileListing = array_map(function(Node $file) { |
|
| 53 | - if ($file instanceof File) { |
|
| 54 | - return new SimpleFile($file); |
|
| 55 | - } |
|
| 56 | - return null; |
|
| 57 | - }, $listing); |
|
| 52 | + $fileListing = array_map(function(Node $file) { |
|
| 53 | + if ($file instanceof File) { |
|
| 54 | + return new SimpleFile($file); |
|
| 55 | + } |
|
| 56 | + return null; |
|
| 57 | + }, $listing); |
|
| 58 | 58 | |
| 59 | - $fileListing = array_filter($fileListing); |
|
| 59 | + $fileListing = array_filter($fileListing); |
|
| 60 | 60 | |
| 61 | - return array_values($fileListing); |
|
| 62 | - } |
|
| 61 | + return array_values($fileListing); |
|
| 62 | + } |
|
| 63 | 63 | |
| 64 | - public function delete() { |
|
| 65 | - $this->folder->delete(); |
|
| 66 | - } |
|
| 64 | + public function delete() { |
|
| 65 | + $this->folder->delete(); |
|
| 66 | + } |
|
| 67 | 67 | |
| 68 | - public function fileExists($name) { |
|
| 69 | - return $this->folder->nodeExists($name); |
|
| 70 | - } |
|
| 68 | + public function fileExists($name) { |
|
| 69 | + return $this->folder->nodeExists($name); |
|
| 70 | + } |
|
| 71 | 71 | |
| 72 | - public function getFile($name) { |
|
| 73 | - $file = $this->folder->get($name); |
|
| 72 | + public function getFile($name) { |
|
| 73 | + $file = $this->folder->get($name); |
|
| 74 | 74 | |
| 75 | - if (!($file instanceof File)) { |
|
| 76 | - throw new NotFoundException(); |
|
| 77 | - } |
|
| 75 | + if (!($file instanceof File)) { |
|
| 76 | + throw new NotFoundException(); |
|
| 77 | + } |
|
| 78 | 78 | |
| 79 | - return new SimpleFile($file); |
|
| 80 | - } |
|
| 79 | + return new SimpleFile($file); |
|
| 80 | + } |
|
| 81 | 81 | |
| 82 | - public function newFile($name) { |
|
| 83 | - $file = $this->folder->newFile($name); |
|
| 82 | + public function newFile($name) { |
|
| 83 | + $file = $this->folder->newFile($name); |
|
| 84 | 84 | |
| 85 | - return new SimpleFile($file); |
|
| 86 | - } |
|
| 85 | + return new SimpleFile($file); |
|
| 86 | + } |
|
| 87 | 87 | } |
@@ -31,78 +31,78 @@ |
||
| 31 | 31 | * Specialized version of Local storage for home directory usage |
| 32 | 32 | */ |
| 33 | 33 | class Home extends Local implements \OCP\Files\IHomeStorage { |
| 34 | - /** |
|
| 35 | - * @var string |
|
| 36 | - */ |
|
| 37 | - protected $id; |
|
| 34 | + /** |
|
| 35 | + * @var string |
|
| 36 | + */ |
|
| 37 | + protected $id; |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var \OC\User\User $user |
|
| 41 | - */ |
|
| 42 | - protected $user; |
|
| 39 | + /** |
|
| 40 | + * @var \OC\User\User $user |
|
| 41 | + */ |
|
| 42 | + protected $user; |
|
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * Construct a Home storage instance |
|
| 46 | - * @param array $arguments array with "user" containing the |
|
| 47 | - * storage owner |
|
| 48 | - */ |
|
| 49 | - public function __construct($arguments) { |
|
| 50 | - $this->user = $arguments['user']; |
|
| 51 | - $datadir = $this->user->getHome(); |
|
| 52 | - $this->id = 'home::' . $this->user->getUID(); |
|
| 44 | + /** |
|
| 45 | + * Construct a Home storage instance |
|
| 46 | + * @param array $arguments array with "user" containing the |
|
| 47 | + * storage owner |
|
| 48 | + */ |
|
| 49 | + public function __construct($arguments) { |
|
| 50 | + $this->user = $arguments['user']; |
|
| 51 | + $datadir = $this->user->getHome(); |
|
| 52 | + $this->id = 'home::' . $this->user->getUID(); |
|
| 53 | 53 | |
| 54 | - parent::__construct(array('datadir' => $datadir)); |
|
| 55 | - } |
|
| 54 | + parent::__construct(array('datadir' => $datadir)); |
|
| 55 | + } |
|
| 56 | 56 | |
| 57 | - public function getId() { |
|
| 58 | - return $this->id; |
|
| 59 | - } |
|
| 57 | + public function getId() { |
|
| 58 | + return $this->id; |
|
| 59 | + } |
|
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * @return \OC\Files\Cache\HomeCache |
|
| 63 | - */ |
|
| 64 | - public function getCache($path = '', $storage = null) { |
|
| 65 | - if (!$storage) { |
|
| 66 | - $storage = $this; |
|
| 67 | - } |
|
| 68 | - if (!isset($this->cache)) { |
|
| 69 | - $this->cache = new \OC\Files\Cache\HomeCache($storage); |
|
| 70 | - } |
|
| 71 | - return $this->cache; |
|
| 72 | - } |
|
| 61 | + /** |
|
| 62 | + * @return \OC\Files\Cache\HomeCache |
|
| 63 | + */ |
|
| 64 | + public function getCache($path = '', $storage = null) { |
|
| 65 | + if (!$storage) { |
|
| 66 | + $storage = $this; |
|
| 67 | + } |
|
| 68 | + if (!isset($this->cache)) { |
|
| 69 | + $this->cache = new \OC\Files\Cache\HomeCache($storage); |
|
| 70 | + } |
|
| 71 | + return $this->cache; |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * get a propagator instance for the cache |
|
| 76 | - * |
|
| 77 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
| 78 | - * @return \OC\Files\Cache\Propagator |
|
| 79 | - */ |
|
| 80 | - public function getPropagator($storage = null) { |
|
| 81 | - if (!$storage) { |
|
| 82 | - $storage = $this; |
|
| 83 | - } |
|
| 84 | - if (!isset($this->propagator)) { |
|
| 85 | - $this->propagator = new HomePropagator($storage, \OC::$server->getDatabaseConnection()); |
|
| 86 | - } |
|
| 87 | - return $this->propagator; |
|
| 88 | - } |
|
| 74 | + /** |
|
| 75 | + * get a propagator instance for the cache |
|
| 76 | + * |
|
| 77 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
| 78 | + * @return \OC\Files\Cache\Propagator |
|
| 79 | + */ |
|
| 80 | + public function getPropagator($storage = null) { |
|
| 81 | + if (!$storage) { |
|
| 82 | + $storage = $this; |
|
| 83 | + } |
|
| 84 | + if (!isset($this->propagator)) { |
|
| 85 | + $this->propagator = new HomePropagator($storage, \OC::$server->getDatabaseConnection()); |
|
| 86 | + } |
|
| 87 | + return $this->propagator; |
|
| 88 | + } |
|
| 89 | 89 | |
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * Returns the owner of this home storage |
|
| 93 | - * @return \OC\User\User owner of this home storage |
|
| 94 | - */ |
|
| 95 | - public function getUser() { |
|
| 96 | - return $this->user; |
|
| 97 | - } |
|
| 91 | + /** |
|
| 92 | + * Returns the owner of this home storage |
|
| 93 | + * @return \OC\User\User owner of this home storage |
|
| 94 | + */ |
|
| 95 | + public function getUser() { |
|
| 96 | + return $this->user; |
|
| 97 | + } |
|
| 98 | 98 | |
| 99 | - /** |
|
| 100 | - * get the owner of a path |
|
| 101 | - * |
|
| 102 | - * @param string $path The path to get the owner |
|
| 103 | - * @return string uid or false |
|
| 104 | - */ |
|
| 105 | - public function getOwner($path) { |
|
| 106 | - return $this->user->getUID(); |
|
| 107 | - } |
|
| 99 | + /** |
|
| 100 | + * get the owner of a path |
|
| 101 | + * |
|
| 102 | + * @param string $path The path to get the owner |
|
| 103 | + * @return string uid or false |
|
| 104 | + */ |
|
| 105 | + public function getOwner($path) { |
|
| 106 | + return $this->user->getUID(); |
|
| 107 | + } |
|
| 108 | 108 | } |
@@ -29,20 +29,20 @@ |
||
| 29 | 29 | * local storage backend in temporary folder for testing purpose |
| 30 | 30 | */ |
| 31 | 31 | class Temporary extends Local{ |
| 32 | - public function __construct($arguments = null) { |
|
| 33 | - parent::__construct(array('datadir' => \OC::$server->getTempManager()->getTemporaryFolder())); |
|
| 34 | - } |
|
| 32 | + public function __construct($arguments = null) { |
|
| 33 | + parent::__construct(array('datadir' => \OC::$server->getTempManager()->getTemporaryFolder())); |
|
| 34 | + } |
|
| 35 | 35 | |
| 36 | - public function cleanUp() { |
|
| 37 | - \OC_Helper::rmdirr($this->datadir); |
|
| 38 | - } |
|
| 36 | + public function cleanUp() { |
|
| 37 | + \OC_Helper::rmdirr($this->datadir); |
|
| 38 | + } |
|
| 39 | 39 | |
| 40 | - public function __destruct() { |
|
| 41 | - parent::__destruct(); |
|
| 42 | - $this->cleanUp(); |
|
| 43 | - } |
|
| 40 | + public function __destruct() { |
|
| 41 | + parent::__destruct(); |
|
| 42 | + $this->cleanUp(); |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - public function getDataDir() { |
|
| 46 | - return $this->datadir; |
|
| 47 | - } |
|
| 45 | + public function getDataDir() { |
|
| 46 | + return $this->datadir; |
|
| 47 | + } |
|
| 48 | 48 | } |
@@ -32,90 +32,90 @@ |
||
| 32 | 32 | */ |
| 33 | 33 | interface Storage extends \OCP\Files\Storage { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * get a cache instance for the storage |
|
| 37 | - * |
|
| 38 | - * @param string $path |
|
| 39 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the cache |
|
| 40 | - * @return \OC\Files\Cache\Cache |
|
| 41 | - */ |
|
| 42 | - public function getCache($path = '', $storage = null); |
|
| 35 | + /** |
|
| 36 | + * get a cache instance for the storage |
|
| 37 | + * |
|
| 38 | + * @param string $path |
|
| 39 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the cache |
|
| 40 | + * @return \OC\Files\Cache\Cache |
|
| 41 | + */ |
|
| 42 | + public function getCache($path = '', $storage = null); |
|
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * get a scanner instance for the storage |
|
| 46 | - * |
|
| 47 | - * @param string $path |
|
| 48 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner |
|
| 49 | - * @return \OC\Files\Cache\Scanner |
|
| 50 | - */ |
|
| 51 | - public function getScanner($path = '', $storage = null); |
|
| 44 | + /** |
|
| 45 | + * get a scanner instance for the storage |
|
| 46 | + * |
|
| 47 | + * @param string $path |
|
| 48 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner |
|
| 49 | + * @return \OC\Files\Cache\Scanner |
|
| 50 | + */ |
|
| 51 | + public function getScanner($path = '', $storage = null); |
|
| 52 | 52 | |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * get the user id of the owner of a file or folder |
|
| 56 | - * |
|
| 57 | - * @param string $path |
|
| 58 | - * @return string |
|
| 59 | - */ |
|
| 60 | - public function getOwner($path); |
|
| 54 | + /** |
|
| 55 | + * get the user id of the owner of a file or folder |
|
| 56 | + * |
|
| 57 | + * @param string $path |
|
| 58 | + * @return string |
|
| 59 | + */ |
|
| 60 | + public function getOwner($path); |
|
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * get a watcher instance for the cache |
|
| 64 | - * |
|
| 65 | - * @param string $path |
|
| 66 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
| 67 | - * @return \OC\Files\Cache\Watcher |
|
| 68 | - */ |
|
| 69 | - public function getWatcher($path = '', $storage = null); |
|
| 62 | + /** |
|
| 63 | + * get a watcher instance for the cache |
|
| 64 | + * |
|
| 65 | + * @param string $path |
|
| 66 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
| 67 | + * @return \OC\Files\Cache\Watcher |
|
| 68 | + */ |
|
| 69 | + public function getWatcher($path = '', $storage = null); |
|
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * get a propagator instance for the cache |
|
| 73 | - * |
|
| 74 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
| 75 | - * @return \OC\Files\Cache\Propagator |
|
| 76 | - */ |
|
| 77 | - public function getPropagator($storage = null); |
|
| 71 | + /** |
|
| 72 | + * get a propagator instance for the cache |
|
| 73 | + * |
|
| 74 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
| 75 | + * @return \OC\Files\Cache\Propagator |
|
| 76 | + */ |
|
| 77 | + public function getPropagator($storage = null); |
|
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * get a updater instance for the cache |
|
| 81 | - * |
|
| 82 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
| 83 | - * @return \OC\Files\Cache\Updater |
|
| 84 | - */ |
|
| 85 | - public function getUpdater($storage = null); |
|
| 79 | + /** |
|
| 80 | + * get a updater instance for the cache |
|
| 81 | + * |
|
| 82 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher |
|
| 83 | + * @return \OC\Files\Cache\Updater |
|
| 84 | + */ |
|
| 85 | + public function getUpdater($storage = null); |
|
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * @return \OC\Files\Cache\Storage |
|
| 89 | - */ |
|
| 90 | - public function getStorageCache(); |
|
| 87 | + /** |
|
| 88 | + * @return \OC\Files\Cache\Storage |
|
| 89 | + */ |
|
| 90 | + public function getStorageCache(); |
|
| 91 | 91 | |
| 92 | - /** |
|
| 93 | - * @param string $path |
|
| 94 | - * @return array |
|
| 95 | - */ |
|
| 96 | - public function getMetaData($path); |
|
| 92 | + /** |
|
| 93 | + * @param string $path |
|
| 94 | + * @return array |
|
| 95 | + */ |
|
| 96 | + public function getMetaData($path); |
|
| 97 | 97 | |
| 98 | - /** |
|
| 99 | - * @param string $path The path of the file to acquire the lock for |
|
| 100 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
| 101 | - * @param \OCP\Lock\ILockingProvider $provider |
|
| 102 | - * @throws \OCP\Lock\LockedException |
|
| 103 | - */ |
|
| 104 | - public function acquireLock($path, $type, ILockingProvider $provider); |
|
| 98 | + /** |
|
| 99 | + * @param string $path The path of the file to acquire the lock for |
|
| 100 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
| 101 | + * @param \OCP\Lock\ILockingProvider $provider |
|
| 102 | + * @throws \OCP\Lock\LockedException |
|
| 103 | + */ |
|
| 104 | + public function acquireLock($path, $type, ILockingProvider $provider); |
|
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * @param string $path The path of the file to release the lock for |
|
| 108 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
| 109 | - * @param \OCP\Lock\ILockingProvider $provider |
|
| 110 | - * @throws \OCP\Lock\LockedException |
|
| 111 | - */ |
|
| 112 | - public function releaseLock($path, $type, ILockingProvider $provider); |
|
| 106 | + /** |
|
| 107 | + * @param string $path The path of the file to release the lock for |
|
| 108 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
| 109 | + * @param \OCP\Lock\ILockingProvider $provider |
|
| 110 | + * @throws \OCP\Lock\LockedException |
|
| 111 | + */ |
|
| 112 | + public function releaseLock($path, $type, ILockingProvider $provider); |
|
| 113 | 113 | |
| 114 | - /** |
|
| 115 | - * @param string $path The path of the file to change the lock for |
|
| 116 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
| 117 | - * @param \OCP\Lock\ILockingProvider $provider |
|
| 118 | - * @throws \OCP\Lock\LockedException |
|
| 119 | - */ |
|
| 120 | - public function changeLock($path, $type, ILockingProvider $provider); |
|
| 114 | + /** |
|
| 115 | + * @param string $path The path of the file to change the lock for |
|
| 116 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
| 117 | + * @param \OCP\Lock\ILockingProvider $provider |
|
| 118 | + * @throws \OCP\Lock\LockedException |
|
| 119 | + */ |
|
| 120 | + public function changeLock($path, $type, ILockingProvider $provider); |
|
| 121 | 121 | } |
@@ -37,45 +37,45 @@ |
||
| 37 | 37 | */ |
| 38 | 38 | trait LocalTempFileTrait { |
| 39 | 39 | |
| 40 | - /** @var string[] */ |
|
| 41 | - protected $cachedFiles = []; |
|
| 40 | + /** @var string[] */ |
|
| 41 | + protected $cachedFiles = []; |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * @param string $path |
|
| 45 | - * @return string |
|
| 46 | - */ |
|
| 47 | - protected function getCachedFile($path) { |
|
| 48 | - if (!isset($this->cachedFiles[$path])) { |
|
| 49 | - $this->cachedFiles[$path] = $this->toTmpFile($path); |
|
| 50 | - } |
|
| 51 | - return $this->cachedFiles[$path]; |
|
| 52 | - } |
|
| 43 | + /** |
|
| 44 | + * @param string $path |
|
| 45 | + * @return string |
|
| 46 | + */ |
|
| 47 | + protected function getCachedFile($path) { |
|
| 48 | + if (!isset($this->cachedFiles[$path])) { |
|
| 49 | + $this->cachedFiles[$path] = $this->toTmpFile($path); |
|
| 50 | + } |
|
| 51 | + return $this->cachedFiles[$path]; |
|
| 52 | + } |
|
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * @param string $path |
|
| 56 | - */ |
|
| 57 | - protected function removeCachedFile($path) { |
|
| 58 | - unset($this->cachedFiles[$path]); |
|
| 59 | - } |
|
| 54 | + /** |
|
| 55 | + * @param string $path |
|
| 56 | + */ |
|
| 57 | + protected function removeCachedFile($path) { |
|
| 58 | + unset($this->cachedFiles[$path]); |
|
| 59 | + } |
|
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * @param string $path |
|
| 63 | - * @return string |
|
| 64 | - */ |
|
| 65 | - protected function toTmpFile($path) { //no longer in the storage api, still useful here |
|
| 66 | - $source = $this->fopen($path, 'r'); |
|
| 67 | - if (!$source) { |
|
| 68 | - return false; |
|
| 69 | - } |
|
| 70 | - if ($pos = strrpos($path, '.')) { |
|
| 71 | - $extension = substr($path, $pos); |
|
| 72 | - } else { |
|
| 73 | - $extension = ''; |
|
| 74 | - } |
|
| 75 | - $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($extension); |
|
| 76 | - $target = fopen($tmpFile, 'w'); |
|
| 77 | - \OC_Helper::streamCopy($source, $target); |
|
| 78 | - fclose($target); |
|
| 79 | - return $tmpFile; |
|
| 80 | - } |
|
| 61 | + /** |
|
| 62 | + * @param string $path |
|
| 63 | + * @return string |
|
| 64 | + */ |
|
| 65 | + protected function toTmpFile($path) { //no longer in the storage api, still useful here |
|
| 66 | + $source = $this->fopen($path, 'r'); |
|
| 67 | + if (!$source) { |
|
| 68 | + return false; |
|
| 69 | + } |
|
| 70 | + if ($pos = strrpos($path, '.')) { |
|
| 71 | + $extension = substr($path, $pos); |
|
| 72 | + } else { |
|
| 73 | + $extension = ''; |
|
| 74 | + } |
|
| 75 | + $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($extension); |
|
| 76 | + $target = fopen($tmpFile, 'w'); |
|
| 77 | + \OC_Helper::streamCopy($source, $target); |
|
| 78 | + fclose($target); |
|
| 79 | + return $tmpFile; |
|
| 80 | + } |
|
| 81 | 81 | } |
@@ -29,80 +29,80 @@ |
||
| 29 | 29 | use OCP\Files\Storage\IStorageFactory; |
| 30 | 30 | |
| 31 | 31 | class StorageFactory implements IStorageFactory { |
| 32 | - /** |
|
| 33 | - * @var array[] [$name=>['priority'=>$priority, 'wrapper'=>$callable] $storageWrappers |
|
| 34 | - */ |
|
| 35 | - private $storageWrappers = []; |
|
| 32 | + /** |
|
| 33 | + * @var array[] [$name=>['priority'=>$priority, 'wrapper'=>$callable] $storageWrappers |
|
| 34 | + */ |
|
| 35 | + private $storageWrappers = []; |
|
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * allow modifier storage behaviour by adding wrappers around storages |
|
| 39 | - * |
|
| 40 | - * $callback should be a function of type (string $mountPoint, Storage $storage) => Storage |
|
| 41 | - * |
|
| 42 | - * @param string $wrapperName name of the wrapper |
|
| 43 | - * @param callable $callback callback |
|
| 44 | - * @param int $priority wrappers with the lower priority are applied last (meaning they get called first) |
|
| 45 | - * @param \OCP\Files\Mount\IMountPoint[] $existingMounts existing mount points to apply the wrapper to |
|
| 46 | - * @return bool true if the wrapper was added, false if there was already a wrapper with this |
|
| 47 | - * name registered |
|
| 48 | - */ |
|
| 49 | - public function addStorageWrapper($wrapperName, $callback, $priority = 50, $existingMounts = []) { |
|
| 50 | - if (isset($this->storageWrappers[$wrapperName])) { |
|
| 51 | - return false; |
|
| 52 | - } |
|
| 37 | + /** |
|
| 38 | + * allow modifier storage behaviour by adding wrappers around storages |
|
| 39 | + * |
|
| 40 | + * $callback should be a function of type (string $mountPoint, Storage $storage) => Storage |
|
| 41 | + * |
|
| 42 | + * @param string $wrapperName name of the wrapper |
|
| 43 | + * @param callable $callback callback |
|
| 44 | + * @param int $priority wrappers with the lower priority are applied last (meaning they get called first) |
|
| 45 | + * @param \OCP\Files\Mount\IMountPoint[] $existingMounts existing mount points to apply the wrapper to |
|
| 46 | + * @return bool true if the wrapper was added, false if there was already a wrapper with this |
|
| 47 | + * name registered |
|
| 48 | + */ |
|
| 49 | + public function addStorageWrapper($wrapperName, $callback, $priority = 50, $existingMounts = []) { |
|
| 50 | + if (isset($this->storageWrappers[$wrapperName])) { |
|
| 51 | + return false; |
|
| 52 | + } |
|
| 53 | 53 | |
| 54 | - // apply to existing mounts before registering it to prevent applying it double in MountPoint::createStorage |
|
| 55 | - foreach ($existingMounts as $mount) { |
|
| 56 | - $mount->wrapStorage($callback); |
|
| 57 | - } |
|
| 54 | + // apply to existing mounts before registering it to prevent applying it double in MountPoint::createStorage |
|
| 55 | + foreach ($existingMounts as $mount) { |
|
| 56 | + $mount->wrapStorage($callback); |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - $this->storageWrappers[$wrapperName] = ['wrapper' => $callback, 'priority' => $priority]; |
|
| 60 | - return true; |
|
| 61 | - } |
|
| 59 | + $this->storageWrappers[$wrapperName] = ['wrapper' => $callback, 'priority' => $priority]; |
|
| 60 | + return true; |
|
| 61 | + } |
|
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * Remove a storage wrapper by name. |
|
| 65 | - * Note: internal method only to be used for cleanup |
|
| 66 | - * |
|
| 67 | - * @param string $wrapperName name of the wrapper |
|
| 68 | - * @internal |
|
| 69 | - */ |
|
| 70 | - public function removeStorageWrapper($wrapperName) { |
|
| 71 | - unset($this->storageWrappers[$wrapperName]); |
|
| 72 | - } |
|
| 63 | + /** |
|
| 64 | + * Remove a storage wrapper by name. |
|
| 65 | + * Note: internal method only to be used for cleanup |
|
| 66 | + * |
|
| 67 | + * @param string $wrapperName name of the wrapper |
|
| 68 | + * @internal |
|
| 69 | + */ |
|
| 70 | + public function removeStorageWrapper($wrapperName) { |
|
| 71 | + unset($this->storageWrappers[$wrapperName]); |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * Create an instance of a storage and apply the registered storage wrappers |
|
| 76 | - * |
|
| 77 | - * @param \OCP\Files\Mount\IMountPoint $mountPoint |
|
| 78 | - * @param string $class |
|
| 79 | - * @param array $arguments |
|
| 80 | - * @return \OCP\Files\Storage |
|
| 81 | - */ |
|
| 82 | - public function getInstance(IMountPoint $mountPoint, $class, $arguments) { |
|
| 83 | - return $this->wrap($mountPoint, new $class($arguments)); |
|
| 84 | - } |
|
| 74 | + /** |
|
| 75 | + * Create an instance of a storage and apply the registered storage wrappers |
|
| 76 | + * |
|
| 77 | + * @param \OCP\Files\Mount\IMountPoint $mountPoint |
|
| 78 | + * @param string $class |
|
| 79 | + * @param array $arguments |
|
| 80 | + * @return \OCP\Files\Storage |
|
| 81 | + */ |
|
| 82 | + public function getInstance(IMountPoint $mountPoint, $class, $arguments) { |
|
| 83 | + return $this->wrap($mountPoint, new $class($arguments)); |
|
| 84 | + } |
|
| 85 | 85 | |
| 86 | - /** |
|
| 87 | - * @param \OCP\Files\Mount\IMountPoint $mountPoint |
|
| 88 | - * @param \OCP\Files\Storage $storage |
|
| 89 | - * @return \OCP\Files\Storage |
|
| 90 | - */ |
|
| 91 | - public function wrap(IMountPoint $mountPoint, $storage) { |
|
| 92 | - $wrappers = array_values($this->storageWrappers); |
|
| 93 | - usort($wrappers, function ($a, $b) { |
|
| 94 | - return $b['priority'] - $a['priority']; |
|
| 95 | - }); |
|
| 96 | - /** @var callable[] $wrappers */ |
|
| 97 | - $wrappers = array_map(function ($wrapper) { |
|
| 98 | - return $wrapper['wrapper']; |
|
| 99 | - }, $wrappers); |
|
| 100 | - foreach ($wrappers as $wrapper) { |
|
| 101 | - $storage = $wrapper($mountPoint->getMountPoint(), $storage, $mountPoint); |
|
| 102 | - if (!($storage instanceof \OCP\Files\Storage)) { |
|
| 103 | - throw new \Exception('Invalid result from storage wrapper'); |
|
| 104 | - } |
|
| 105 | - } |
|
| 106 | - return $storage; |
|
| 107 | - } |
|
| 86 | + /** |
|
| 87 | + * @param \OCP\Files\Mount\IMountPoint $mountPoint |
|
| 88 | + * @param \OCP\Files\Storage $storage |
|
| 89 | + * @return \OCP\Files\Storage |
|
| 90 | + */ |
|
| 91 | + public function wrap(IMountPoint $mountPoint, $storage) { |
|
| 92 | + $wrappers = array_values($this->storageWrappers); |
|
| 93 | + usort($wrappers, function ($a, $b) { |
|
| 94 | + return $b['priority'] - $a['priority']; |
|
| 95 | + }); |
|
| 96 | + /** @var callable[] $wrappers */ |
|
| 97 | + $wrappers = array_map(function ($wrapper) { |
|
| 98 | + return $wrapper['wrapper']; |
|
| 99 | + }, $wrappers); |
|
| 100 | + foreach ($wrappers as $wrapper) { |
|
| 101 | + $storage = $wrapper($mountPoint->getMountPoint(), $storage, $mountPoint); |
|
| 102 | + if (!($storage instanceof \OCP\Files\Storage)) { |
|
| 103 | + throw new \Exception('Invalid result from storage wrapper'); |
|
| 104 | + } |
|
| 105 | + } |
|
| 106 | + return $storage; |
|
| 107 | + } |
|
| 108 | 108 | } |