@@ -36,27 +36,27 @@ |
||
| 36 | 36 | * @since 7.0.0 |
| 37 | 37 | */ |
| 38 | 38 | class LockNotAcquiredException extends \Exception { |
| 39 | - /** @var string $path The path that could not be locked */ |
|
| 40 | - public $path; |
|
| 39 | + /** @var string $path The path that could not be locked */ |
|
| 40 | + public $path; |
|
| 41 | 41 | |
| 42 | - /** @var integer $lockType The type of the lock that was attempted */ |
|
| 43 | - public $lockType; |
|
| 42 | + /** @var integer $lockType The type of the lock that was attempted */ |
|
| 43 | + public $lockType; |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @since 7.0.0 |
|
| 47 | - */ |
|
| 48 | - public function __construct($path, $lockType, $code = 0, \Exception $previous = null) { |
|
| 49 | - $message = \OC::$server->getL10N('core')->t('Could not obtain lock type %d on "%s".', array($lockType, $path)); |
|
| 50 | - parent::__construct($message, $code, $previous); |
|
| 51 | - } |
|
| 45 | + /** |
|
| 46 | + * @since 7.0.0 |
|
| 47 | + */ |
|
| 48 | + public function __construct($path, $lockType, $code = 0, \Exception $previous = null) { |
|
| 49 | + $message = \OC::$server->getL10N('core')->t('Could not obtain lock type %d on "%s".', array($lockType, $path)); |
|
| 50 | + parent::__construct($message, $code, $previous); |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * custom string representation of object |
|
| 55 | - * |
|
| 56 | - * @return string |
|
| 57 | - * @since 7.0.0 |
|
| 58 | - */ |
|
| 59 | - public function __toString() { |
|
| 60 | - return __CLASS__ . ": [{$this->code}]: {$this->message}\n"; |
|
| 61 | - } |
|
| 53 | + /** |
|
| 54 | + * custom string representation of object |
|
| 55 | + * |
|
| 56 | + * @return string |
|
| 57 | + * @since 7.0.0 |
|
| 58 | + */ |
|
| 59 | + public function __toString() { |
|
| 60 | + return __CLASS__ . ": [{$this->code}]: {$this->message}\n"; |
|
| 61 | + } |
|
| 62 | 62 | } |
@@ -57,6 +57,6 @@ |
||
| 57 | 57 | * @since 7.0.0 |
| 58 | 58 | */ |
| 59 | 59 | public function __toString() { |
| 60 | - return __CLASS__ . ": [{$this->code}]: {$this->message}\n"; |
|
| 60 | + return __CLASS__.": [{$this->code}]: {$this->message}\n"; |
|
| 61 | 61 | } |
| 62 | 62 | } |
@@ -30,25 +30,25 @@ |
||
| 30 | 30 | * @since 8.0.0 |
| 31 | 31 | */ |
| 32 | 32 | interface IStorageFactory { |
| 33 | - /** |
|
| 34 | - * allow modifier storage behaviour by adding wrappers around storages |
|
| 35 | - * |
|
| 36 | - * $callback should be a function of type (string $mountPoint, Storage $storage) => Storage |
|
| 37 | - * |
|
| 38 | - * @param string $wrapperName |
|
| 39 | - * @param callable $callback |
|
| 40 | - * @return bool true if the wrapper was added, false if there was already a wrapper with this |
|
| 41 | - * name registered |
|
| 42 | - * @since 8.0.0 |
|
| 43 | - */ |
|
| 44 | - public function addStorageWrapper($wrapperName, $callback); |
|
| 33 | + /** |
|
| 34 | + * allow modifier storage behaviour by adding wrappers around storages |
|
| 35 | + * |
|
| 36 | + * $callback should be a function of type (string $mountPoint, Storage $storage) => Storage |
|
| 37 | + * |
|
| 38 | + * @param string $wrapperName |
|
| 39 | + * @param callable $callback |
|
| 40 | + * @return bool true if the wrapper was added, false if there was already a wrapper with this |
|
| 41 | + * name registered |
|
| 42 | + * @since 8.0.0 |
|
| 43 | + */ |
|
| 44 | + public function addStorageWrapper($wrapperName, $callback); |
|
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @param \OCP\Files\Mount\IMountPoint $mountPoint |
|
| 48 | - * @param string $class |
|
| 49 | - * @param array $arguments |
|
| 50 | - * @return \OCP\Files\Storage |
|
| 51 | - * @since 8.0.0 |
|
| 52 | - */ |
|
| 53 | - public function getInstance(IMountPoint $mountPoint, $class, $arguments); |
|
| 46 | + /** |
|
| 47 | + * @param \OCP\Files\Mount\IMountPoint $mountPoint |
|
| 48 | + * @param string $class |
|
| 49 | + * @param array $arguments |
|
| 50 | + * @return \OCP\Files\Storage |
|
| 51 | + * @since 8.0.0 |
|
| 52 | + */ |
|
| 53 | + public function getInstance(IMountPoint $mountPoint, $class, $arguments); |
|
| 54 | 54 | } |
@@ -40,241 +40,241 @@ |
||
| 40 | 40 | * @since 6.0.0 - extends FileInfo was added in 8.0.0 |
| 41 | 41 | */ |
| 42 | 42 | interface Node extends FileInfo { |
| 43 | - /** |
|
| 44 | - * Move the file or folder to a new location |
|
| 45 | - * |
|
| 46 | - * @param string $targetPath the absolute target path |
|
| 47 | - * @throws \OCP\Files\NotPermittedException |
|
| 48 | - * @return \OCP\Files\Node |
|
| 49 | - * @since 6.0.0 |
|
| 50 | - */ |
|
| 51 | - public function move($targetPath); |
|
| 43 | + /** |
|
| 44 | + * Move the file or folder to a new location |
|
| 45 | + * |
|
| 46 | + * @param string $targetPath the absolute target path |
|
| 47 | + * @throws \OCP\Files\NotPermittedException |
|
| 48 | + * @return \OCP\Files\Node |
|
| 49 | + * @since 6.0.0 |
|
| 50 | + */ |
|
| 51 | + public function move($targetPath); |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Delete the file or folder |
|
| 55 | - * @return void |
|
| 56 | - * @since 6.0.0 |
|
| 57 | - */ |
|
| 58 | - public function delete(); |
|
| 53 | + /** |
|
| 54 | + * Delete the file or folder |
|
| 55 | + * @return void |
|
| 56 | + * @since 6.0.0 |
|
| 57 | + */ |
|
| 58 | + public function delete(); |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Cope the file or folder to a new location |
|
| 62 | - * |
|
| 63 | - * @param string $targetPath the absolute target path |
|
| 64 | - * @return \OCP\Files\Node |
|
| 65 | - * @since 6.0.0 |
|
| 66 | - */ |
|
| 67 | - public function copy($targetPath); |
|
| 60 | + /** |
|
| 61 | + * Cope the file or folder to a new location |
|
| 62 | + * |
|
| 63 | + * @param string $targetPath the absolute target path |
|
| 64 | + * @return \OCP\Files\Node |
|
| 65 | + * @since 6.0.0 |
|
| 66 | + */ |
|
| 67 | + public function copy($targetPath); |
|
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * Change the modified date of the file or folder |
|
| 71 | - * If $mtime is omitted the current time will be used |
|
| 72 | - * |
|
| 73 | - * @param int $mtime (optional) modified date as unix timestamp |
|
| 74 | - * @throws \OCP\Files\NotPermittedException |
|
| 75 | - * @return void |
|
| 76 | - * @since 6.0.0 |
|
| 77 | - */ |
|
| 78 | - public function touch($mtime = null); |
|
| 69 | + /** |
|
| 70 | + * Change the modified date of the file or folder |
|
| 71 | + * If $mtime is omitted the current time will be used |
|
| 72 | + * |
|
| 73 | + * @param int $mtime (optional) modified date as unix timestamp |
|
| 74 | + * @throws \OCP\Files\NotPermittedException |
|
| 75 | + * @return void |
|
| 76 | + * @since 6.0.0 |
|
| 77 | + */ |
|
| 78 | + public function touch($mtime = null); |
|
| 79 | 79 | |
| 80 | - /** |
|
| 81 | - * Get the storage backend the file or folder is stored on |
|
| 82 | - * |
|
| 83 | - * @return \OCP\Files\Storage |
|
| 84 | - * @throws \OCP\Files\NotFoundException |
|
| 85 | - * @since 6.0.0 |
|
| 86 | - */ |
|
| 87 | - public function getStorage(); |
|
| 80 | + /** |
|
| 81 | + * Get the storage backend the file or folder is stored on |
|
| 82 | + * |
|
| 83 | + * @return \OCP\Files\Storage |
|
| 84 | + * @throws \OCP\Files\NotFoundException |
|
| 85 | + * @since 6.0.0 |
|
| 86 | + */ |
|
| 87 | + public function getStorage(); |
|
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Get the full path of the file or folder |
|
| 91 | - * |
|
| 92 | - * @return string |
|
| 93 | - * @since 6.0.0 |
|
| 94 | - */ |
|
| 95 | - public function getPath(); |
|
| 89 | + /** |
|
| 90 | + * Get the full path of the file or folder |
|
| 91 | + * |
|
| 92 | + * @return string |
|
| 93 | + * @since 6.0.0 |
|
| 94 | + */ |
|
| 95 | + public function getPath(); |
|
| 96 | 96 | |
| 97 | - /** |
|
| 98 | - * Get the path of the file or folder relative to the mountpoint of it's storage |
|
| 99 | - * |
|
| 100 | - * @return string |
|
| 101 | - * @since 6.0.0 |
|
| 102 | - */ |
|
| 103 | - public function getInternalPath(); |
|
| 97 | + /** |
|
| 98 | + * Get the path of the file or folder relative to the mountpoint of it's storage |
|
| 99 | + * |
|
| 100 | + * @return string |
|
| 101 | + * @since 6.0.0 |
|
| 102 | + */ |
|
| 103 | + public function getInternalPath(); |
|
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * Get the internal file id for the file or folder |
|
| 107 | - * |
|
| 108 | - * @return int |
|
| 109 | - * @throws InvalidPathException |
|
| 110 | - * @throws NotFoundException |
|
| 111 | - * @since 6.0.0 |
|
| 112 | - */ |
|
| 113 | - public function getId(); |
|
| 105 | + /** |
|
| 106 | + * Get the internal file id for the file or folder |
|
| 107 | + * |
|
| 108 | + * @return int |
|
| 109 | + * @throws InvalidPathException |
|
| 110 | + * @throws NotFoundException |
|
| 111 | + * @since 6.0.0 |
|
| 112 | + */ |
|
| 113 | + public function getId(); |
|
| 114 | 114 | |
| 115 | - /** |
|
| 116 | - * Get metadata of the file or folder |
|
| 117 | - * The returned array contains the following values: |
|
| 118 | - * - mtime |
|
| 119 | - * - size |
|
| 120 | - * |
|
| 121 | - * @return array |
|
| 122 | - * @since 6.0.0 |
|
| 123 | - */ |
|
| 124 | - public function stat(); |
|
| 115 | + /** |
|
| 116 | + * Get metadata of the file or folder |
|
| 117 | + * The returned array contains the following values: |
|
| 118 | + * - mtime |
|
| 119 | + * - size |
|
| 120 | + * |
|
| 121 | + * @return array |
|
| 122 | + * @since 6.0.0 |
|
| 123 | + */ |
|
| 124 | + public function stat(); |
|
| 125 | 125 | |
| 126 | - /** |
|
| 127 | - * Get the modified date of the file or folder as unix timestamp |
|
| 128 | - * |
|
| 129 | - * @return int |
|
| 130 | - * @throws InvalidPathException |
|
| 131 | - * @throws NotFoundException |
|
| 132 | - * @since 6.0.0 |
|
| 133 | - */ |
|
| 134 | - public function getMTime(); |
|
| 126 | + /** |
|
| 127 | + * Get the modified date of the file or folder as unix timestamp |
|
| 128 | + * |
|
| 129 | + * @return int |
|
| 130 | + * @throws InvalidPathException |
|
| 131 | + * @throws NotFoundException |
|
| 132 | + * @since 6.0.0 |
|
| 133 | + */ |
|
| 134 | + public function getMTime(); |
|
| 135 | 135 | |
| 136 | - /** |
|
| 137 | - * Get the size of the file or folder in bytes |
|
| 138 | - * |
|
| 139 | - * @return int |
|
| 140 | - * @throws InvalidPathException |
|
| 141 | - * @throws NotFoundException |
|
| 142 | - * @since 6.0.0 |
|
| 143 | - */ |
|
| 144 | - public function getSize(); |
|
| 136 | + /** |
|
| 137 | + * Get the size of the file or folder in bytes |
|
| 138 | + * |
|
| 139 | + * @return int |
|
| 140 | + * @throws InvalidPathException |
|
| 141 | + * @throws NotFoundException |
|
| 142 | + * @since 6.0.0 |
|
| 143 | + */ |
|
| 144 | + public function getSize(); |
|
| 145 | 145 | |
| 146 | - /** |
|
| 147 | - * Get the Etag of the file or folder |
|
| 148 | - * The Etag is an string id used to detect changes to a file or folder, |
|
| 149 | - * every time the file or folder is changed the Etag will change to |
|
| 150 | - * |
|
| 151 | - * @return string |
|
| 152 | - * @throws InvalidPathException |
|
| 153 | - * @throws NotFoundException |
|
| 154 | - * @since 6.0.0 |
|
| 155 | - */ |
|
| 156 | - public function getEtag(); |
|
| 146 | + /** |
|
| 147 | + * Get the Etag of the file or folder |
|
| 148 | + * The Etag is an string id used to detect changes to a file or folder, |
|
| 149 | + * every time the file or folder is changed the Etag will change to |
|
| 150 | + * |
|
| 151 | + * @return string |
|
| 152 | + * @throws InvalidPathException |
|
| 153 | + * @throws NotFoundException |
|
| 154 | + * @since 6.0.0 |
|
| 155 | + */ |
|
| 156 | + public function getEtag(); |
|
| 157 | 157 | |
| 158 | 158 | |
| 159 | - /** |
|
| 160 | - * Get the permissions of the file or folder as a combination of one or more of the following constants: |
|
| 161 | - * - \OCP\Constants::PERMISSION_READ |
|
| 162 | - * - \OCP\Constants::PERMISSION_UPDATE |
|
| 163 | - * - \OCP\Constants::PERMISSION_CREATE |
|
| 164 | - * - \OCP\Constants::PERMISSION_DELETE |
|
| 165 | - * - \OCP\Constants::PERMISSION_SHARE |
|
| 166 | - * |
|
| 167 | - * @return int |
|
| 168 | - * @throws InvalidPathException |
|
| 169 | - * @throws NotFoundException |
|
| 170 | - * @since 6.0.0 - namespace of constants has changed in 8.0.0 |
|
| 171 | - */ |
|
| 172 | - public function getPermissions(); |
|
| 159 | + /** |
|
| 160 | + * Get the permissions of the file or folder as a combination of one or more of the following constants: |
|
| 161 | + * - \OCP\Constants::PERMISSION_READ |
|
| 162 | + * - \OCP\Constants::PERMISSION_UPDATE |
|
| 163 | + * - \OCP\Constants::PERMISSION_CREATE |
|
| 164 | + * - \OCP\Constants::PERMISSION_DELETE |
|
| 165 | + * - \OCP\Constants::PERMISSION_SHARE |
|
| 166 | + * |
|
| 167 | + * @return int |
|
| 168 | + * @throws InvalidPathException |
|
| 169 | + * @throws NotFoundException |
|
| 170 | + * @since 6.0.0 - namespace of constants has changed in 8.0.0 |
|
| 171 | + */ |
|
| 172 | + public function getPermissions(); |
|
| 173 | 173 | |
| 174 | - /** |
|
| 175 | - * Check if the file or folder is readable |
|
| 176 | - * |
|
| 177 | - * @return bool |
|
| 178 | - * @throws InvalidPathException |
|
| 179 | - * @throws NotFoundException |
|
| 180 | - * @since 6.0.0 |
|
| 181 | - */ |
|
| 182 | - public function isReadable(); |
|
| 174 | + /** |
|
| 175 | + * Check if the file or folder is readable |
|
| 176 | + * |
|
| 177 | + * @return bool |
|
| 178 | + * @throws InvalidPathException |
|
| 179 | + * @throws NotFoundException |
|
| 180 | + * @since 6.0.0 |
|
| 181 | + */ |
|
| 182 | + public function isReadable(); |
|
| 183 | 183 | |
| 184 | - /** |
|
| 185 | - * Check if the file or folder is writable |
|
| 186 | - * |
|
| 187 | - * @return bool |
|
| 188 | - * @throws InvalidPathException |
|
| 189 | - * @throws NotFoundException |
|
| 190 | - * @since 6.0.0 |
|
| 191 | - */ |
|
| 192 | - public function isUpdateable(); |
|
| 184 | + /** |
|
| 185 | + * Check if the file or folder is writable |
|
| 186 | + * |
|
| 187 | + * @return bool |
|
| 188 | + * @throws InvalidPathException |
|
| 189 | + * @throws NotFoundException |
|
| 190 | + * @since 6.0.0 |
|
| 191 | + */ |
|
| 192 | + public function isUpdateable(); |
|
| 193 | 193 | |
| 194 | - /** |
|
| 195 | - * Check if the file or folder is deletable |
|
| 196 | - * |
|
| 197 | - * @return bool |
|
| 198 | - * @throws InvalidPathException |
|
| 199 | - * @throws NotFoundException |
|
| 200 | - * @since 6.0.0 |
|
| 201 | - */ |
|
| 202 | - public function isDeletable(); |
|
| 194 | + /** |
|
| 195 | + * Check if the file or folder is deletable |
|
| 196 | + * |
|
| 197 | + * @return bool |
|
| 198 | + * @throws InvalidPathException |
|
| 199 | + * @throws NotFoundException |
|
| 200 | + * @since 6.0.0 |
|
| 201 | + */ |
|
| 202 | + public function isDeletable(); |
|
| 203 | 203 | |
| 204 | - /** |
|
| 205 | - * Check if the file or folder is shareable |
|
| 206 | - * |
|
| 207 | - * @return bool |
|
| 208 | - * @throws InvalidPathException |
|
| 209 | - * @throws NotFoundException |
|
| 210 | - * @since 6.0.0 |
|
| 211 | - */ |
|
| 212 | - public function isShareable(); |
|
| 204 | + /** |
|
| 205 | + * Check if the file or folder is shareable |
|
| 206 | + * |
|
| 207 | + * @return bool |
|
| 208 | + * @throws InvalidPathException |
|
| 209 | + * @throws NotFoundException |
|
| 210 | + * @since 6.0.0 |
|
| 211 | + */ |
|
| 212 | + public function isShareable(); |
|
| 213 | 213 | |
| 214 | - /** |
|
| 215 | - * Get the parent folder of the file or folder |
|
| 216 | - * |
|
| 217 | - * @return Folder |
|
| 218 | - * @since 6.0.0 |
|
| 219 | - */ |
|
| 220 | - public function getParent(); |
|
| 214 | + /** |
|
| 215 | + * Get the parent folder of the file or folder |
|
| 216 | + * |
|
| 217 | + * @return Folder |
|
| 218 | + * @since 6.0.0 |
|
| 219 | + */ |
|
| 220 | + public function getParent(); |
|
| 221 | 221 | |
| 222 | - /** |
|
| 223 | - * Get the filename of the file or folder |
|
| 224 | - * |
|
| 225 | - * @return string |
|
| 226 | - * @since 6.0.0 |
|
| 227 | - */ |
|
| 228 | - public function getName(); |
|
| 222 | + /** |
|
| 223 | + * Get the filename of the file or folder |
|
| 224 | + * |
|
| 225 | + * @return string |
|
| 226 | + * @since 6.0.0 |
|
| 227 | + */ |
|
| 228 | + public function getName(); |
|
| 229 | 229 | |
| 230 | - /** |
|
| 231 | - * Acquire a lock on this file or folder. |
|
| 232 | - * |
|
| 233 | - * A shared (read) lock will prevent any exclusive (write) locks from being created but any number of shared locks |
|
| 234 | - * can be active at the same time. |
|
| 235 | - * An exclusive lock will prevent any other lock from being created (both shared and exclusive). |
|
| 236 | - * |
|
| 237 | - * A locked exception will be thrown if any conflicting lock already exists |
|
| 238 | - * |
|
| 239 | - * Note that this uses mandatory locking, if you acquire an exclusive lock on a file it will block *all* |
|
| 240 | - * other operations for that file, even within the same php process. |
|
| 241 | - * |
|
| 242 | - * Acquiring any lock on a file will also create a shared lock on all parent folders of that file. |
|
| 243 | - * |
|
| 244 | - * Note that in most cases you won't need to manually manage the locks for any files you're working with, |
|
| 245 | - * any filesystem operation will automatically acquire the relevant locks for that operation. |
|
| 246 | - * |
|
| 247 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
| 248 | - * @throws \OCP\Lock\LockedException |
|
| 249 | - * @since 9.1.0 |
|
| 250 | - */ |
|
| 251 | - public function lock($type); |
|
| 230 | + /** |
|
| 231 | + * Acquire a lock on this file or folder. |
|
| 232 | + * |
|
| 233 | + * A shared (read) lock will prevent any exclusive (write) locks from being created but any number of shared locks |
|
| 234 | + * can be active at the same time. |
|
| 235 | + * An exclusive lock will prevent any other lock from being created (both shared and exclusive). |
|
| 236 | + * |
|
| 237 | + * A locked exception will be thrown if any conflicting lock already exists |
|
| 238 | + * |
|
| 239 | + * Note that this uses mandatory locking, if you acquire an exclusive lock on a file it will block *all* |
|
| 240 | + * other operations for that file, even within the same php process. |
|
| 241 | + * |
|
| 242 | + * Acquiring any lock on a file will also create a shared lock on all parent folders of that file. |
|
| 243 | + * |
|
| 244 | + * Note that in most cases you won't need to manually manage the locks for any files you're working with, |
|
| 245 | + * any filesystem operation will automatically acquire the relevant locks for that operation. |
|
| 246 | + * |
|
| 247 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
| 248 | + * @throws \OCP\Lock\LockedException |
|
| 249 | + * @since 9.1.0 |
|
| 250 | + */ |
|
| 251 | + public function lock($type); |
|
| 252 | 252 | |
| 253 | - /** |
|
| 254 | - * Check the type of an existing lock. |
|
| 255 | - * |
|
| 256 | - * A shared lock can be changed to an exclusive lock is there is exactly one shared lock on the file, |
|
| 257 | - * an exclusive lock can always be changed to a shared lock since there can only be one exclusive lock int he first place. |
|
| 258 | - * |
|
| 259 | - * A locked exception will be thrown when these preconditions are not met. |
|
| 260 | - * Note that this is also the case if no existing lock exists for the file. |
|
| 261 | - * |
|
| 262 | - * @param int $targetType \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
| 263 | - * @throws \OCP\Lock\LockedException |
|
| 264 | - * @since 9.1.0 |
|
| 265 | - */ |
|
| 266 | - public function changeLock($targetType); |
|
| 253 | + /** |
|
| 254 | + * Check the type of an existing lock. |
|
| 255 | + * |
|
| 256 | + * A shared lock can be changed to an exclusive lock is there is exactly one shared lock on the file, |
|
| 257 | + * an exclusive lock can always be changed to a shared lock since there can only be one exclusive lock int he first place. |
|
| 258 | + * |
|
| 259 | + * A locked exception will be thrown when these preconditions are not met. |
|
| 260 | + * Note that this is also the case if no existing lock exists for the file. |
|
| 261 | + * |
|
| 262 | + * @param int $targetType \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
| 263 | + * @throws \OCP\Lock\LockedException |
|
| 264 | + * @since 9.1.0 |
|
| 265 | + */ |
|
| 266 | + public function changeLock($targetType); |
|
| 267 | 267 | |
| 268 | - /** |
|
| 269 | - * Release an existing lock. |
|
| 270 | - * |
|
| 271 | - * This will also free up the shared locks on any parent folder that were automatically acquired when locking the file. |
|
| 272 | - * |
|
| 273 | - * Note that this method will not give any sort of error when trying to free a lock that doesn't exist. |
|
| 274 | - * |
|
| 275 | - * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
| 276 | - * @throws \OCP\Lock\LockedException |
|
| 277 | - * @since 9.1.0 |
|
| 278 | - */ |
|
| 279 | - public function unlock($type); |
|
| 268 | + /** |
|
| 269 | + * Release an existing lock. |
|
| 270 | + * |
|
| 271 | + * This will also free up the shared locks on any parent folder that were automatically acquired when locking the file. |
|
| 272 | + * |
|
| 273 | + * Note that this method will not give any sort of error when trying to free a lock that doesn't exist. |
|
| 274 | + * |
|
| 275 | + * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE |
|
| 276 | + * @throws \OCP\Lock\LockedException |
|
| 277 | + * @since 9.1.0 |
|
| 278 | + */ |
|
| 279 | + public function unlock($type); |
|
| 280 | 280 | } |
@@ -34,13 +34,13 @@ |
||
| 34 | 34 | */ |
| 35 | 35 | interface IRootFolder extends Folder, Emitter { |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * Returns a view to user's files folder |
|
| 39 | - * |
|
| 40 | - * @param String $userId user ID |
|
| 41 | - * @return \OCP\Files\Folder |
|
| 42 | - * @since 8.2.0 |
|
| 43 | - */ |
|
| 44 | - public function getUserFolder($userId); |
|
| 37 | + /** |
|
| 38 | + * Returns a view to user's files folder |
|
| 39 | + * |
|
| 40 | + * @param String $userId user ID |
|
| 41 | + * @return \OCP\Files\Folder |
|
| 42 | + * @since 8.2.0 |
|
| 43 | + */ |
|
| 44 | + public function getUserFolder($userId); |
|
| 45 | 45 | } |
| 46 | 46 | |
@@ -30,47 +30,47 @@ |
||
| 30 | 30 | * @since 9.0.0 |
| 31 | 31 | */ |
| 32 | 32 | interface IUpdater { |
| 33 | - /** |
|
| 34 | - * Get the propagator for etags and mtime for the view the updater works on |
|
| 35 | - * |
|
| 36 | - * @return IPropagator |
|
| 37 | - * @since 9.0.0 |
|
| 38 | - */ |
|
| 39 | - public function getPropagator(); |
|
| 33 | + /** |
|
| 34 | + * Get the propagator for etags and mtime for the view the updater works on |
|
| 35 | + * |
|
| 36 | + * @return IPropagator |
|
| 37 | + * @since 9.0.0 |
|
| 38 | + */ |
|
| 39 | + public function getPropagator(); |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Propagate etag and mtime changes for the parent folders of $path up to the root of the filesystem |
|
| 43 | - * |
|
| 44 | - * @param string $path the path of the file to propagate the changes for |
|
| 45 | - * @param int|null $time the timestamp to set as mtime for the parent folders, if left out the current time is used |
|
| 46 | - * @since 9.0.0 |
|
| 47 | - */ |
|
| 48 | - public function propagate($path, $time = null); |
|
| 41 | + /** |
|
| 42 | + * Propagate etag and mtime changes for the parent folders of $path up to the root of the filesystem |
|
| 43 | + * |
|
| 44 | + * @param string $path the path of the file to propagate the changes for |
|
| 45 | + * @param int|null $time the timestamp to set as mtime for the parent folders, if left out the current time is used |
|
| 46 | + * @since 9.0.0 |
|
| 47 | + */ |
|
| 48 | + public function propagate($path, $time = null); |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * Update the cache for $path and update the size, etag and mtime of the parent folders |
|
| 52 | - * |
|
| 53 | - * @param string $path |
|
| 54 | - * @param int $time |
|
| 55 | - * @since 9.0.0 |
|
| 56 | - */ |
|
| 57 | - public function update($path, $time = null); |
|
| 50 | + /** |
|
| 51 | + * Update the cache for $path and update the size, etag and mtime of the parent folders |
|
| 52 | + * |
|
| 53 | + * @param string $path |
|
| 54 | + * @param int $time |
|
| 55 | + * @since 9.0.0 |
|
| 56 | + */ |
|
| 57 | + public function update($path, $time = null); |
|
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * Remove $path from the cache and update the size, etag and mtime of the parent folders |
|
| 61 | - * |
|
| 62 | - * @param string $path |
|
| 63 | - * @since 9.0.0 |
|
| 64 | - */ |
|
| 65 | - public function remove($path); |
|
| 59 | + /** |
|
| 60 | + * Remove $path from the cache and update the size, etag and mtime of the parent folders |
|
| 61 | + * |
|
| 62 | + * @param string $path |
|
| 63 | + * @since 9.0.0 |
|
| 64 | + */ |
|
| 65 | + public function remove($path); |
|
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * Rename a file or folder in the cache and update the size, etag and mtime of the parent folders |
|
| 69 | - * |
|
| 70 | - * @param IStorage $sourceStorage |
|
| 71 | - * @param string $source |
|
| 72 | - * @param string $target |
|
| 73 | - * @since 9.0.0 |
|
| 74 | - */ |
|
| 75 | - public function renameFromStorage(IStorage $sourceStorage, $source, $target); |
|
| 67 | + /** |
|
| 68 | + * Rename a file or folder in the cache and update the size, etag and mtime of the parent folders |
|
| 69 | + * |
|
| 70 | + * @param IStorage $sourceStorage |
|
| 71 | + * @param string $source |
|
| 72 | + * @param string $target |
|
| 73 | + * @since 9.0.0 |
|
| 74 | + */ |
|
| 75 | + public function renameFromStorage(IStorage $sourceStorage, $source, $target); |
|
| 76 | 76 | } |
@@ -28,108 +28,108 @@ |
||
| 28 | 28 | * @since 9.0.0 |
| 29 | 29 | */ |
| 30 | 30 | interface ICacheEntry { |
| 31 | - const DIRECTORY_MIMETYPE = 'httpd/unix-directory'; |
|
| 31 | + const DIRECTORY_MIMETYPE = 'httpd/unix-directory'; |
|
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * Get the numeric id of a file |
|
| 35 | - * |
|
| 36 | - * @return int |
|
| 37 | - * @since 9.0.0 |
|
| 38 | - */ |
|
| 39 | - public function getId(); |
|
| 33 | + /** |
|
| 34 | + * Get the numeric id of a file |
|
| 35 | + * |
|
| 36 | + * @return int |
|
| 37 | + * @since 9.0.0 |
|
| 38 | + */ |
|
| 39 | + public function getId(); |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Get the numeric id for the storage |
|
| 43 | - * |
|
| 44 | - * @return int |
|
| 45 | - * @since 9.0.0 |
|
| 46 | - */ |
|
| 47 | - public function getStorageId(); |
|
| 41 | + /** |
|
| 42 | + * Get the numeric id for the storage |
|
| 43 | + * |
|
| 44 | + * @return int |
|
| 45 | + * @since 9.0.0 |
|
| 46 | + */ |
|
| 47 | + public function getStorageId(); |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * Get the path of the file relative to the storage root |
|
| 51 | - * |
|
| 52 | - * @return string |
|
| 53 | - * @since 9.0.0 |
|
| 54 | - */ |
|
| 55 | - public function getPath(); |
|
| 49 | + /** |
|
| 50 | + * Get the path of the file relative to the storage root |
|
| 51 | + * |
|
| 52 | + * @return string |
|
| 53 | + * @since 9.0.0 |
|
| 54 | + */ |
|
| 55 | + public function getPath(); |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Get the file name |
|
| 59 | - * |
|
| 60 | - * @return string |
|
| 61 | - * @since 9.0.0 |
|
| 62 | - */ |
|
| 63 | - public function getName(); |
|
| 57 | + /** |
|
| 58 | + * Get the file name |
|
| 59 | + * |
|
| 60 | + * @return string |
|
| 61 | + * @since 9.0.0 |
|
| 62 | + */ |
|
| 63 | + public function getName(); |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * Get the full mimetype |
|
| 67 | - * |
|
| 68 | - * @return string |
|
| 69 | - * @since 9.0.0 |
|
| 70 | - */ |
|
| 71 | - public function getMimeType(); |
|
| 65 | + /** |
|
| 66 | + * Get the full mimetype |
|
| 67 | + * |
|
| 68 | + * @return string |
|
| 69 | + * @since 9.0.0 |
|
| 70 | + */ |
|
| 71 | + public function getMimeType(); |
|
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * Get the first part of the mimetype |
|
| 75 | - * |
|
| 76 | - * @return string |
|
| 77 | - * @since 9.0.0 |
|
| 78 | - */ |
|
| 79 | - public function getMimePart(); |
|
| 73 | + /** |
|
| 74 | + * Get the first part of the mimetype |
|
| 75 | + * |
|
| 76 | + * @return string |
|
| 77 | + * @since 9.0.0 |
|
| 78 | + */ |
|
| 79 | + public function getMimePart(); |
|
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * Get the file size in bytes |
|
| 83 | - * |
|
| 84 | - * @return int |
|
| 85 | - * @since 9.0.0 |
|
| 86 | - */ |
|
| 87 | - public function getSize(); |
|
| 81 | + /** |
|
| 82 | + * Get the file size in bytes |
|
| 83 | + * |
|
| 84 | + * @return int |
|
| 85 | + * @since 9.0.0 |
|
| 86 | + */ |
|
| 87 | + public function getSize(); |
|
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Get the last modified date as unix timestamp |
|
| 91 | - * |
|
| 92 | - * @return int |
|
| 93 | - * @since 9.0.0 |
|
| 94 | - */ |
|
| 95 | - public function getMTime(); |
|
| 89 | + /** |
|
| 90 | + * Get the last modified date as unix timestamp |
|
| 91 | + * |
|
| 92 | + * @return int |
|
| 93 | + * @since 9.0.0 |
|
| 94 | + */ |
|
| 95 | + public function getMTime(); |
|
| 96 | 96 | |
| 97 | - /** |
|
| 98 | - * Get the last modified date on the storage as unix timestamp |
|
| 99 | - * |
|
| 100 | - * Note that when a file is updated we also update the mtime of all parent folders to make it visible to the user which folder has had updates most recently |
|
| 101 | - * This can differ from the mtime on the underlying storage which usually only changes when a direct child is added, removed or renamed |
|
| 102 | - * |
|
| 103 | - * @return int |
|
| 104 | - * @since 9.0.0 |
|
| 105 | - */ |
|
| 106 | - public function getStorageMTime(); |
|
| 97 | + /** |
|
| 98 | + * Get the last modified date on the storage as unix timestamp |
|
| 99 | + * |
|
| 100 | + * Note that when a file is updated we also update the mtime of all parent folders to make it visible to the user which folder has had updates most recently |
|
| 101 | + * This can differ from the mtime on the underlying storage which usually only changes when a direct child is added, removed or renamed |
|
| 102 | + * |
|
| 103 | + * @return int |
|
| 104 | + * @since 9.0.0 |
|
| 105 | + */ |
|
| 106 | + public function getStorageMTime(); |
|
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * Get the etag for the file |
|
| 110 | - * |
|
| 111 | - * An etag is used for change detection of files and folders, an etag of a file changes whenever the content of the file changes |
|
| 112 | - * Etag for folders change whenever a file in the folder has changed |
|
| 113 | - * |
|
| 114 | - * @return string |
|
| 115 | - * @since 9.0.0 |
|
| 116 | - */ |
|
| 117 | - public function getEtag(); |
|
| 108 | + /** |
|
| 109 | + * Get the etag for the file |
|
| 110 | + * |
|
| 111 | + * An etag is used for change detection of files and folders, an etag of a file changes whenever the content of the file changes |
|
| 112 | + * Etag for folders change whenever a file in the folder has changed |
|
| 113 | + * |
|
| 114 | + * @return string |
|
| 115 | + * @since 9.0.0 |
|
| 116 | + */ |
|
| 117 | + public function getEtag(); |
|
| 118 | 118 | |
| 119 | - /** |
|
| 120 | - * Get the permissions for the file stored as bitwise combination of \OCP\PERMISSION_READ, \OCP\PERMISSION_CREATE |
|
| 121 | - * \OCP\PERMISSION_UPDATE, \OCP\PERMISSION_DELETE and \OCP\PERMISSION_SHARE |
|
| 122 | - * |
|
| 123 | - * @return int |
|
| 124 | - * @since 9.0.0 |
|
| 125 | - */ |
|
| 126 | - public function getPermissions(); |
|
| 119 | + /** |
|
| 120 | + * Get the permissions for the file stored as bitwise combination of \OCP\PERMISSION_READ, \OCP\PERMISSION_CREATE |
|
| 121 | + * \OCP\PERMISSION_UPDATE, \OCP\PERMISSION_DELETE and \OCP\PERMISSION_SHARE |
|
| 122 | + * |
|
| 123 | + * @return int |
|
| 124 | + * @since 9.0.0 |
|
| 125 | + */ |
|
| 126 | + public function getPermissions(); |
|
| 127 | 127 | |
| 128 | - /** |
|
| 129 | - * Check if the file is encrypted |
|
| 130 | - * |
|
| 131 | - * @return bool |
|
| 132 | - * @since 9.0.0 |
|
| 133 | - */ |
|
| 134 | - public function isEncrypted(); |
|
| 128 | + /** |
|
| 129 | + * Check if the file is encrypted |
|
| 130 | + * |
|
| 131 | + * @return bool |
|
| 132 | + * @since 9.0.0 |
|
| 133 | + */ |
|
| 134 | + public function isEncrypted(); |
|
| 135 | 135 | } |
@@ -28,56 +28,56 @@ |
||
| 28 | 28 | * @since 9.0.0 |
| 29 | 29 | */ |
| 30 | 30 | interface IWatcher { |
| 31 | - const CHECK_NEVER = 0; // never check the underlying filesystem for updates |
|
| 32 | - const CHECK_ONCE = 1; // check the underlying filesystem for updates once every request for each file |
|
| 33 | - const CHECK_ALWAYS = 2; // always check the underlying filesystem for updates |
|
| 31 | + const CHECK_NEVER = 0; // never check the underlying filesystem for updates |
|
| 32 | + const CHECK_ONCE = 1; // check the underlying filesystem for updates once every request for each file |
|
| 33 | + const CHECK_ALWAYS = 2; // always check the underlying filesystem for updates |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @param int $policy either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS |
|
| 37 | - * @since 9.0.0 |
|
| 38 | - */ |
|
| 39 | - public function setPolicy($policy); |
|
| 35 | + /** |
|
| 36 | + * @param int $policy either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS |
|
| 37 | + * @since 9.0.0 |
|
| 38 | + */ |
|
| 39 | + public function setPolicy($policy); |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @return int either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS |
|
| 43 | - * @since 9.0.0 |
|
| 44 | - */ |
|
| 45 | - public function getPolicy(); |
|
| 41 | + /** |
|
| 42 | + * @return int either IWatcher::CHECK_NEVER, IWatcher::CHECK_ONCE, IWatcher::CHECK_ALWAYS |
|
| 43 | + * @since 9.0.0 |
|
| 44 | + */ |
|
| 45 | + public function getPolicy(); |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * check $path for updates and update if needed |
|
| 49 | - * |
|
| 50 | - * @param string $path |
|
| 51 | - * @param ICacheEntry|null $cachedEntry |
|
| 52 | - * @return boolean true if path was updated |
|
| 53 | - * @since 9.0.0 |
|
| 54 | - */ |
|
| 55 | - public function checkUpdate($path, $cachedEntry = null); |
|
| 47 | + /** |
|
| 48 | + * check $path for updates and update if needed |
|
| 49 | + * |
|
| 50 | + * @param string $path |
|
| 51 | + * @param ICacheEntry|null $cachedEntry |
|
| 52 | + * @return boolean true if path was updated |
|
| 53 | + * @since 9.0.0 |
|
| 54 | + */ |
|
| 55 | + public function checkUpdate($path, $cachedEntry = null); |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Update the cache for changes to $path |
|
| 59 | - * |
|
| 60 | - * @param string $path |
|
| 61 | - * @param ICacheEntry $cachedData |
|
| 62 | - * @since 9.0.0 |
|
| 63 | - */ |
|
| 64 | - public function update($path, $cachedData); |
|
| 57 | + /** |
|
| 58 | + * Update the cache for changes to $path |
|
| 59 | + * |
|
| 60 | + * @param string $path |
|
| 61 | + * @param ICacheEntry $cachedData |
|
| 62 | + * @since 9.0.0 |
|
| 63 | + */ |
|
| 64 | + public function update($path, $cachedData); |
|
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Check if the cache for $path needs to be updated |
|
| 68 | - * |
|
| 69 | - * @param string $path |
|
| 70 | - * @param ICacheEntry $cachedData |
|
| 71 | - * @return bool |
|
| 72 | - * @since 9.0.0 |
|
| 73 | - */ |
|
| 74 | - public function needsUpdate($path, $cachedData); |
|
| 66 | + /** |
|
| 67 | + * Check if the cache for $path needs to be updated |
|
| 68 | + * |
|
| 69 | + * @param string $path |
|
| 70 | + * @param ICacheEntry $cachedData |
|
| 71 | + * @return bool |
|
| 72 | + * @since 9.0.0 |
|
| 73 | + */ |
|
| 74 | + public function needsUpdate($path, $cachedData); |
|
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * remove deleted files in $path from the cache |
|
| 78 | - * |
|
| 79 | - * @param string $path |
|
| 80 | - * @since 9.0.0 |
|
| 81 | - */ |
|
| 82 | - public function cleanFolder($path); |
|
| 76 | + /** |
|
| 77 | + * remove deleted files in $path from the cache |
|
| 78 | + * |
|
| 79 | + * @param string $path |
|
| 80 | + * @since 9.0.0 |
|
| 81 | + */ |
|
| 82 | + public function cleanFolder($path); |
|
| 83 | 83 | } |
@@ -35,223 +35,223 @@ |
||
| 35 | 35 | * @since 9.0.0 |
| 36 | 36 | */ |
| 37 | 37 | interface ICache { |
| 38 | - const NOT_FOUND = 0; |
|
| 39 | - const PARTIAL = 1; //only partial data available, file not cached in the database |
|
| 40 | - const SHALLOW = 2; //folder in cache, but not all child files are completely scanned |
|
| 41 | - const COMPLETE = 3; |
|
| 38 | + const NOT_FOUND = 0; |
|
| 39 | + const PARTIAL = 1; //only partial data available, file not cached in the database |
|
| 40 | + const SHALLOW = 2; //folder in cache, but not all child files are completely scanned |
|
| 41 | + const COMPLETE = 3; |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Get the numeric storage id for this cache's storage |
|
| 45 | - * |
|
| 46 | - * @return int |
|
| 47 | - * @since 9.0.0 |
|
| 48 | - */ |
|
| 49 | - public function getNumericStorageId(); |
|
| 43 | + /** |
|
| 44 | + * Get the numeric storage id for this cache's storage |
|
| 45 | + * |
|
| 46 | + * @return int |
|
| 47 | + * @since 9.0.0 |
|
| 48 | + */ |
|
| 49 | + public function getNumericStorageId(); |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * get the stored metadata of a file or folder |
|
| 53 | - * |
|
| 54 | - * @param string | int $file either the path of a file or folder or the file id for a file or folder |
|
| 55 | - * @return ICacheEntry|false the cache entry or false if the file is not found in the cache |
|
| 56 | - * @since 9.0.0 |
|
| 57 | - */ |
|
| 58 | - public function get($file); |
|
| 51 | + /** |
|
| 52 | + * get the stored metadata of a file or folder |
|
| 53 | + * |
|
| 54 | + * @param string | int $file either the path of a file or folder or the file id for a file or folder |
|
| 55 | + * @return ICacheEntry|false the cache entry or false if the file is not found in the cache |
|
| 56 | + * @since 9.0.0 |
|
| 57 | + */ |
|
| 58 | + public function get($file); |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * get the metadata of all files stored in $folder |
|
| 62 | - * |
|
| 63 | - * Only returns files one level deep, no recursion |
|
| 64 | - * |
|
| 65 | - * @param string $folder |
|
| 66 | - * @return ICacheEntry[] |
|
| 67 | - * @since 9.0.0 |
|
| 68 | - */ |
|
| 69 | - public function getFolderContents($folder); |
|
| 60 | + /** |
|
| 61 | + * get the metadata of all files stored in $folder |
|
| 62 | + * |
|
| 63 | + * Only returns files one level deep, no recursion |
|
| 64 | + * |
|
| 65 | + * @param string $folder |
|
| 66 | + * @return ICacheEntry[] |
|
| 67 | + * @since 9.0.0 |
|
| 68 | + */ |
|
| 69 | + public function getFolderContents($folder); |
|
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * get the metadata of all files stored in $folder |
|
| 73 | - * |
|
| 74 | - * Only returns files one level deep, no recursion |
|
| 75 | - * |
|
| 76 | - * @param int $fileId the file id of the folder |
|
| 77 | - * @return ICacheEntry[] |
|
| 78 | - * @since 9.0.0 |
|
| 79 | - */ |
|
| 80 | - public function getFolderContentsById($fileId); |
|
| 71 | + /** |
|
| 72 | + * get the metadata of all files stored in $folder |
|
| 73 | + * |
|
| 74 | + * Only returns files one level deep, no recursion |
|
| 75 | + * |
|
| 76 | + * @param int $fileId the file id of the folder |
|
| 77 | + * @return ICacheEntry[] |
|
| 78 | + * @since 9.0.0 |
|
| 79 | + */ |
|
| 80 | + public function getFolderContentsById($fileId); |
|
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * store meta data for a file or folder |
|
| 84 | - * This will automatically call either insert or update depending on if the file exists |
|
| 85 | - * |
|
| 86 | - * @param string $file |
|
| 87 | - * @param array $data |
|
| 88 | - * |
|
| 89 | - * @return int file id |
|
| 90 | - * @throws \RuntimeException |
|
| 91 | - * @since 9.0.0 |
|
| 92 | - */ |
|
| 93 | - public function put($file, array $data); |
|
| 82 | + /** |
|
| 83 | + * store meta data for a file or folder |
|
| 84 | + * This will automatically call either insert or update depending on if the file exists |
|
| 85 | + * |
|
| 86 | + * @param string $file |
|
| 87 | + * @param array $data |
|
| 88 | + * |
|
| 89 | + * @return int file id |
|
| 90 | + * @throws \RuntimeException |
|
| 91 | + * @since 9.0.0 |
|
| 92 | + */ |
|
| 93 | + public function put($file, array $data); |
|
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * insert meta data for a new file or folder |
|
| 97 | - * |
|
| 98 | - * @param string $file |
|
| 99 | - * @param array $data |
|
| 100 | - * |
|
| 101 | - * @return int file id |
|
| 102 | - * @throws \RuntimeException |
|
| 103 | - * @since 9.0.0 |
|
| 104 | - */ |
|
| 105 | - public function insert($file, array $data); |
|
| 95 | + /** |
|
| 96 | + * insert meta data for a new file or folder |
|
| 97 | + * |
|
| 98 | + * @param string $file |
|
| 99 | + * @param array $data |
|
| 100 | + * |
|
| 101 | + * @return int file id |
|
| 102 | + * @throws \RuntimeException |
|
| 103 | + * @since 9.0.0 |
|
| 104 | + */ |
|
| 105 | + public function insert($file, array $data); |
|
| 106 | 106 | |
| 107 | - /** |
|
| 108 | - * update the metadata of an existing file or folder in the cache |
|
| 109 | - * |
|
| 110 | - * @param int $id the fileid of the existing file or folder |
|
| 111 | - * @param array $data [$key => $value] the metadata to update, only the fields provided in the array will be updated, non-provided values will remain unchanged |
|
| 112 | - * @since 9.0.0 |
|
| 113 | - */ |
|
| 114 | - public function update($id, array $data); |
|
| 107 | + /** |
|
| 108 | + * update the metadata of an existing file or folder in the cache |
|
| 109 | + * |
|
| 110 | + * @param int $id the fileid of the existing file or folder |
|
| 111 | + * @param array $data [$key => $value] the metadata to update, only the fields provided in the array will be updated, non-provided values will remain unchanged |
|
| 112 | + * @since 9.0.0 |
|
| 113 | + */ |
|
| 114 | + public function update($id, array $data); |
|
| 115 | 115 | |
| 116 | - /** |
|
| 117 | - * get the file id for a file |
|
| 118 | - * |
|
| 119 | - * A file id is a numeric id for a file or folder that's unique within an owncloud instance which stays the same for the lifetime of a file |
|
| 120 | - * |
|
| 121 | - * File ids are easiest way for apps to store references to a file since unlike paths they are not affected by renames or sharing |
|
| 122 | - * |
|
| 123 | - * @param string $file |
|
| 124 | - * @return int |
|
| 125 | - * @since 9.0.0 |
|
| 126 | - */ |
|
| 127 | - public function getId($file); |
|
| 116 | + /** |
|
| 117 | + * get the file id for a file |
|
| 118 | + * |
|
| 119 | + * A file id is a numeric id for a file or folder that's unique within an owncloud instance which stays the same for the lifetime of a file |
|
| 120 | + * |
|
| 121 | + * File ids are easiest way for apps to store references to a file since unlike paths they are not affected by renames or sharing |
|
| 122 | + * |
|
| 123 | + * @param string $file |
|
| 124 | + * @return int |
|
| 125 | + * @since 9.0.0 |
|
| 126 | + */ |
|
| 127 | + public function getId($file); |
|
| 128 | 128 | |
| 129 | - /** |
|
| 130 | - * get the id of the parent folder of a file |
|
| 131 | - * |
|
| 132 | - * @param string $file |
|
| 133 | - * @return int |
|
| 134 | - * @since 9.0.0 |
|
| 135 | - */ |
|
| 136 | - public function getParentId($file); |
|
| 129 | + /** |
|
| 130 | + * get the id of the parent folder of a file |
|
| 131 | + * |
|
| 132 | + * @param string $file |
|
| 133 | + * @return int |
|
| 134 | + * @since 9.0.0 |
|
| 135 | + */ |
|
| 136 | + public function getParentId($file); |
|
| 137 | 137 | |
| 138 | - /** |
|
| 139 | - * check if a file is available in the cache |
|
| 140 | - * |
|
| 141 | - * @param string $file |
|
| 142 | - * @return bool |
|
| 143 | - * @since 9.0.0 |
|
| 144 | - */ |
|
| 145 | - public function inCache($file); |
|
| 138 | + /** |
|
| 139 | + * check if a file is available in the cache |
|
| 140 | + * |
|
| 141 | + * @param string $file |
|
| 142 | + * @return bool |
|
| 143 | + * @since 9.0.0 |
|
| 144 | + */ |
|
| 145 | + public function inCache($file); |
|
| 146 | 146 | |
| 147 | - /** |
|
| 148 | - * remove a file or folder from the cache |
|
| 149 | - * |
|
| 150 | - * when removing a folder from the cache all files and folders inside the folder will be removed as well |
|
| 151 | - * |
|
| 152 | - * @param string $file |
|
| 153 | - * @since 9.0.0 |
|
| 154 | - */ |
|
| 155 | - public function remove($file); |
|
| 147 | + /** |
|
| 148 | + * remove a file or folder from the cache |
|
| 149 | + * |
|
| 150 | + * when removing a folder from the cache all files and folders inside the folder will be removed as well |
|
| 151 | + * |
|
| 152 | + * @param string $file |
|
| 153 | + * @since 9.0.0 |
|
| 154 | + */ |
|
| 155 | + public function remove($file); |
|
| 156 | 156 | |
| 157 | - /** |
|
| 158 | - * Move a file or folder in the cache |
|
| 159 | - * |
|
| 160 | - * @param string $source |
|
| 161 | - * @param string $target |
|
| 162 | - * @since 9.0.0 |
|
| 163 | - */ |
|
| 164 | - public function move($source, $target); |
|
| 157 | + /** |
|
| 158 | + * Move a file or folder in the cache |
|
| 159 | + * |
|
| 160 | + * @param string $source |
|
| 161 | + * @param string $target |
|
| 162 | + * @since 9.0.0 |
|
| 163 | + */ |
|
| 164 | + public function move($source, $target); |
|
| 165 | 165 | |
| 166 | - /** |
|
| 167 | - * Move a file or folder in the cache |
|
| 168 | - * |
|
| 169 | - * Note that this should make sure the entries are removed from the source cache |
|
| 170 | - * |
|
| 171 | - * @param \OCP\Files\Cache\ICache $sourceCache |
|
| 172 | - * @param string $sourcePath |
|
| 173 | - * @param string $targetPath |
|
| 174 | - * @throws \OC\DatabaseException |
|
| 175 | - * @since 9.0.0 |
|
| 176 | - */ |
|
| 177 | - public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath); |
|
| 166 | + /** |
|
| 167 | + * Move a file or folder in the cache |
|
| 168 | + * |
|
| 169 | + * Note that this should make sure the entries are removed from the source cache |
|
| 170 | + * |
|
| 171 | + * @param \OCP\Files\Cache\ICache $sourceCache |
|
| 172 | + * @param string $sourcePath |
|
| 173 | + * @param string $targetPath |
|
| 174 | + * @throws \OC\DatabaseException |
|
| 175 | + * @since 9.0.0 |
|
| 176 | + */ |
|
| 177 | + public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath); |
|
| 178 | 178 | |
| 179 | - /** |
|
| 180 | - * Get the scan status of a file |
|
| 181 | - * |
|
| 182 | - * - ICache::NOT_FOUND: File is not in the cache |
|
| 183 | - * - ICache::PARTIAL: File is not stored in the cache but some incomplete data is known |
|
| 184 | - * - ICache::SHALLOW: The folder and it's direct children are in the cache but not all sub folders are fully scanned |
|
| 185 | - * - ICache::COMPLETE: The file or folder, with all it's children) are fully scanned |
|
| 186 | - * |
|
| 187 | - * @param string $file |
|
| 188 | - * |
|
| 189 | - * @return int ICache::NOT_FOUND, ICache::PARTIAL, ICache::SHALLOW or ICache::COMPLETE |
|
| 190 | - * @since 9.0.0 |
|
| 191 | - */ |
|
| 192 | - public function getStatus($file); |
|
| 179 | + /** |
|
| 180 | + * Get the scan status of a file |
|
| 181 | + * |
|
| 182 | + * - ICache::NOT_FOUND: File is not in the cache |
|
| 183 | + * - ICache::PARTIAL: File is not stored in the cache but some incomplete data is known |
|
| 184 | + * - ICache::SHALLOW: The folder and it's direct children are in the cache but not all sub folders are fully scanned |
|
| 185 | + * - ICache::COMPLETE: The file or folder, with all it's children) are fully scanned |
|
| 186 | + * |
|
| 187 | + * @param string $file |
|
| 188 | + * |
|
| 189 | + * @return int ICache::NOT_FOUND, ICache::PARTIAL, ICache::SHALLOW or ICache::COMPLETE |
|
| 190 | + * @since 9.0.0 |
|
| 191 | + */ |
|
| 192 | + public function getStatus($file); |
|
| 193 | 193 | |
| 194 | - /** |
|
| 195 | - * search for files matching $pattern, files are matched if their filename matches the search pattern |
|
| 196 | - * |
|
| 197 | - * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%') |
|
| 198 | - * @return ICacheEntry[] an array of cache entries where the name matches the search pattern |
|
| 199 | - * @since 9.0.0 |
|
| 200 | - * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this |
|
| 201 | - */ |
|
| 202 | - public function search($pattern); |
|
| 194 | + /** |
|
| 195 | + * search for files matching $pattern, files are matched if their filename matches the search pattern |
|
| 196 | + * |
|
| 197 | + * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%') |
|
| 198 | + * @return ICacheEntry[] an array of cache entries where the name matches the search pattern |
|
| 199 | + * @since 9.0.0 |
|
| 200 | + * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this |
|
| 201 | + */ |
|
| 202 | + public function search($pattern); |
|
| 203 | 203 | |
| 204 | - /** |
|
| 205 | - * search for files by mimetype |
|
| 206 | - * |
|
| 207 | - * @param string $mimetype either a full mimetype to search ('text/plain') or only the first part of a mimetype ('image') |
|
| 208 | - * where it will search for all mimetypes in the group ('image/*') |
|
| 209 | - * @return ICacheEntry[] an array of cache entries where the mimetype matches the search |
|
| 210 | - * @since 9.0.0 |
|
| 211 | - * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this |
|
| 212 | - */ |
|
| 213 | - public function searchByMime($mimetype); |
|
| 204 | + /** |
|
| 205 | + * search for files by mimetype |
|
| 206 | + * |
|
| 207 | + * @param string $mimetype either a full mimetype to search ('text/plain') or only the first part of a mimetype ('image') |
|
| 208 | + * where it will search for all mimetypes in the group ('image/*') |
|
| 209 | + * @return ICacheEntry[] an array of cache entries where the mimetype matches the search |
|
| 210 | + * @since 9.0.0 |
|
| 211 | + * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this |
|
| 212 | + */ |
|
| 213 | + public function searchByMime($mimetype); |
|
| 214 | 214 | |
| 215 | - /** |
|
| 216 | - * Search for files by tag of a given users. |
|
| 217 | - * |
|
| 218 | - * Note that every user can tag files differently. |
|
| 219 | - * |
|
| 220 | - * @param string|int $tag name or tag id |
|
| 221 | - * @param string $userId owner of the tags |
|
| 222 | - * @return ICacheEntry[] file data |
|
| 223 | - * @since 9.0.0 |
|
| 224 | - * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this |
|
| 225 | - */ |
|
| 226 | - public function searchByTag($tag, $userId); |
|
| 215 | + /** |
|
| 216 | + * Search for files by tag of a given users. |
|
| 217 | + * |
|
| 218 | + * Note that every user can tag files differently. |
|
| 219 | + * |
|
| 220 | + * @param string|int $tag name or tag id |
|
| 221 | + * @param string $userId owner of the tags |
|
| 222 | + * @return ICacheEntry[] file data |
|
| 223 | + * @since 9.0.0 |
|
| 224 | + * @deprecated 9.0.0 due to lack of pagination, not all backends might implement this |
|
| 225 | + */ |
|
| 226 | + public function searchByTag($tag, $userId); |
|
| 227 | 227 | |
| 228 | - /** |
|
| 229 | - * find a folder in the cache which has not been fully scanned |
|
| 230 | - * |
|
| 231 | - * If multiple incomplete folders are in the cache, the one with the highest id will be returned, |
|
| 232 | - * use the one with the highest id gives the best result with the background scanner, since that is most |
|
| 233 | - * likely the folder where we stopped scanning previously |
|
| 234 | - * |
|
| 235 | - * @return string|bool the path of the folder or false when no folder matched |
|
| 236 | - * @since 9.0.0 |
|
| 237 | - */ |
|
| 238 | - public function getIncomplete(); |
|
| 228 | + /** |
|
| 229 | + * find a folder in the cache which has not been fully scanned |
|
| 230 | + * |
|
| 231 | + * If multiple incomplete folders are in the cache, the one with the highest id will be returned, |
|
| 232 | + * use the one with the highest id gives the best result with the background scanner, since that is most |
|
| 233 | + * likely the folder where we stopped scanning previously |
|
| 234 | + * |
|
| 235 | + * @return string|bool the path of the folder or false when no folder matched |
|
| 236 | + * @since 9.0.0 |
|
| 237 | + */ |
|
| 238 | + public function getIncomplete(); |
|
| 239 | 239 | |
| 240 | - /** |
|
| 241 | - * get the path of a file on this storage by it's file id |
|
| 242 | - * |
|
| 243 | - * @param int $id the file id of the file or folder to search |
|
| 244 | - * @return string|null the path of the file (relative to the storage) or null if a file with the given id does not exists within this cache |
|
| 245 | - * @since 9.0.0 |
|
| 246 | - */ |
|
| 247 | - public function getPathById($id); |
|
| 240 | + /** |
|
| 241 | + * get the path of a file on this storage by it's file id |
|
| 242 | + * |
|
| 243 | + * @param int $id the file id of the file or folder to search |
|
| 244 | + * @return string|null the path of the file (relative to the storage) or null if a file with the given id does not exists within this cache |
|
| 245 | + * @since 9.0.0 |
|
| 246 | + */ |
|
| 247 | + public function getPathById($id); |
|
| 248 | 248 | |
| 249 | - /** |
|
| 250 | - * normalize the given path for usage in the cache |
|
| 251 | - * |
|
| 252 | - * @param string $path |
|
| 253 | - * @return string |
|
| 254 | - * @since 9.0.0 |
|
| 255 | - */ |
|
| 256 | - public function normalize($path); |
|
| 249 | + /** |
|
| 250 | + * normalize the given path for usage in the cache |
|
| 251 | + * |
|
| 252 | + * @param string $path |
|
| 253 | + * @return string |
|
| 254 | + * @since 9.0.0 |
|
| 255 | + */ |
|
| 256 | + public function normalize($path); |
|
| 257 | 257 | } |
@@ -28,29 +28,29 @@ |
||
| 28 | 28 | * @since 9.0.0 |
| 29 | 29 | */ |
| 30 | 30 | interface IPropagator { |
| 31 | - /** |
|
| 32 | - * Mark the beginning of a propagation batch |
|
| 33 | - * |
|
| 34 | - * Note that not all cache setups support propagation in which case this will be a noop |
|
| 35 | - * |
|
| 36 | - * Batching for cache setups that do support it has to be explicit since the cache state is not fully consistent |
|
| 37 | - * before the batch is committed. |
|
| 38 | - * |
|
| 39 | - * @since 9.1.0 |
|
| 40 | - */ |
|
| 41 | - public function beginBatch(); |
|
| 31 | + /** |
|
| 32 | + * Mark the beginning of a propagation batch |
|
| 33 | + * |
|
| 34 | + * Note that not all cache setups support propagation in which case this will be a noop |
|
| 35 | + * |
|
| 36 | + * Batching for cache setups that do support it has to be explicit since the cache state is not fully consistent |
|
| 37 | + * before the batch is committed. |
|
| 38 | + * |
|
| 39 | + * @since 9.1.0 |
|
| 40 | + */ |
|
| 41 | + public function beginBatch(); |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Commit the active propagation batch |
|
| 45 | - * |
|
| 46 | - * @since 9.1.0 |
|
| 47 | - */ |
|
| 48 | - public function commitBatch(); |
|
| 43 | + /** |
|
| 44 | + * Commit the active propagation batch |
|
| 45 | + * |
|
| 46 | + * @since 9.1.0 |
|
| 47 | + */ |
|
| 48 | + public function commitBatch(); |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * @param string $internalPath |
|
| 52 | - * @param int $time |
|
| 53 | - * @since 9.0.0 |
|
| 54 | - */ |
|
| 55 | - public function propagateChange($internalPath, $time); |
|
| 50 | + /** |
|
| 51 | + * @param string $internalPath |
|
| 52 | + * @param int $time |
|
| 53 | + * @since 9.0.0 |
|
| 54 | + */ |
|
| 55 | + public function propagateChange($internalPath, $time); |
|
| 56 | 56 | } |