@@ -194,6 +194,9 @@ |
||
| 194 | 194 | return $this->getCache()->getStatus($this->getSourcePath($file)); |
| 195 | 195 | } |
| 196 | 196 | |
| 197 | + /** |
|
| 198 | + * @param ICacheEntry[] $results |
|
| 199 | + */ |
|
| 197 | 200 | private function formatSearchResults($results) { |
| 198 | 201 | $results = array_filter($results, array($this, 'filterCacheEntry')); |
| 199 | 202 | $results = array_values($results); |
@@ -51,7 +51,7 @@ discard block |
||
| 51 | 51 | if ($path === '') { |
| 52 | 52 | return $this->root; |
| 53 | 53 | } else { |
| 54 | - return $this->root . '/' . ltrim($path, '/'); |
|
| 54 | + return $this->root.'/'.ltrim($path, '/'); |
|
| 55 | 55 | } |
| 56 | 56 | } |
| 57 | 57 | |
@@ -66,7 +66,7 @@ discard block |
||
| 66 | 66 | $rootLength = strlen($this->root) + 1; |
| 67 | 67 | if ($path === $this->root) { |
| 68 | 68 | return ''; |
| 69 | - } else if (substr($path, 0, $rootLength) === $this->root . '/') { |
|
| 69 | + } else if (substr($path, 0, $rootLength) === $this->root.'/') { |
|
| 70 | 70 | return substr($path, $rootLength); |
| 71 | 71 | } else { |
| 72 | 72 | return null; |
@@ -86,7 +86,7 @@ discard block |
||
| 86 | 86 | |
| 87 | 87 | protected function filterCacheEntry($entry) { |
| 88 | 88 | $rootLength = strlen($this->root) + 1; |
| 89 | - return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root . '/'); |
|
| 89 | + return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root.'/'); |
|
| 90 | 90 | } |
| 91 | 91 | |
| 92 | 92 | /** |
@@ -34,284 +34,284 @@ |
||
| 34 | 34 | * Jail to a subdirectory of the wrapped cache |
| 35 | 35 | */ |
| 36 | 36 | class CacheJail extends CacheWrapper { |
| 37 | - /** |
|
| 38 | - * @var string |
|
| 39 | - */ |
|
| 40 | - protected $root; |
|
| 37 | + /** |
|
| 38 | + * @var string |
|
| 39 | + */ |
|
| 40 | + protected $root; |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @param \OCP\Files\Cache\ICache $cache |
|
| 44 | - * @param string $root |
|
| 45 | - */ |
|
| 46 | - public function __construct($cache, $root) { |
|
| 47 | - parent::__construct($cache); |
|
| 48 | - $this->root = $root; |
|
| 49 | - } |
|
| 42 | + /** |
|
| 43 | + * @param \OCP\Files\Cache\ICache $cache |
|
| 44 | + * @param string $root |
|
| 45 | + */ |
|
| 46 | + public function __construct($cache, $root) { |
|
| 47 | + parent::__construct($cache); |
|
| 48 | + $this->root = $root; |
|
| 49 | + } |
|
| 50 | 50 | |
| 51 | - protected function getSourcePath($path) { |
|
| 52 | - if ($path === '') { |
|
| 53 | - return $this->root; |
|
| 54 | - } else { |
|
| 55 | - return $this->root . '/' . ltrim($path, '/'); |
|
| 56 | - } |
|
| 57 | - } |
|
| 51 | + protected function getSourcePath($path) { |
|
| 52 | + if ($path === '') { |
|
| 53 | + return $this->root; |
|
| 54 | + } else { |
|
| 55 | + return $this->root . '/' . ltrim($path, '/'); |
|
| 56 | + } |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * @param string $path |
|
| 61 | - * @return null|string the jailed path or null if the path is outside the jail |
|
| 62 | - */ |
|
| 63 | - protected function getJailedPath($path) { |
|
| 64 | - if ($this->root === '') { |
|
| 65 | - return $path; |
|
| 66 | - } |
|
| 67 | - $rootLength = strlen($this->root) + 1; |
|
| 68 | - if ($path === $this->root) { |
|
| 69 | - return ''; |
|
| 70 | - } else if (substr($path, 0, $rootLength) === $this->root . '/') { |
|
| 71 | - return substr($path, $rootLength); |
|
| 72 | - } else { |
|
| 73 | - return null; |
|
| 74 | - } |
|
| 75 | - } |
|
| 59 | + /** |
|
| 60 | + * @param string $path |
|
| 61 | + * @return null|string the jailed path or null if the path is outside the jail |
|
| 62 | + */ |
|
| 63 | + protected function getJailedPath($path) { |
|
| 64 | + if ($this->root === '') { |
|
| 65 | + return $path; |
|
| 66 | + } |
|
| 67 | + $rootLength = strlen($this->root) + 1; |
|
| 68 | + if ($path === $this->root) { |
|
| 69 | + return ''; |
|
| 70 | + } else if (substr($path, 0, $rootLength) === $this->root . '/') { |
|
| 71 | + return substr($path, $rootLength); |
|
| 72 | + } else { |
|
| 73 | + return null; |
|
| 74 | + } |
|
| 75 | + } |
|
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * @param ICacheEntry|array $entry |
|
| 79 | - * @return array |
|
| 80 | - */ |
|
| 81 | - protected function formatCacheEntry($entry) { |
|
| 82 | - if (isset($entry['path'])) { |
|
| 83 | - $entry['path'] = $this->getJailedPath($entry['path']); |
|
| 84 | - } |
|
| 85 | - return $entry; |
|
| 86 | - } |
|
| 77 | + /** |
|
| 78 | + * @param ICacheEntry|array $entry |
|
| 79 | + * @return array |
|
| 80 | + */ |
|
| 81 | + protected function formatCacheEntry($entry) { |
|
| 82 | + if (isset($entry['path'])) { |
|
| 83 | + $entry['path'] = $this->getJailedPath($entry['path']); |
|
| 84 | + } |
|
| 85 | + return $entry; |
|
| 86 | + } |
|
| 87 | 87 | |
| 88 | - protected function filterCacheEntry($entry) { |
|
| 89 | - $rootLength = strlen($this->root) + 1; |
|
| 90 | - return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root . '/'); |
|
| 91 | - } |
|
| 88 | + protected function filterCacheEntry($entry) { |
|
| 89 | + $rootLength = strlen($this->root) + 1; |
|
| 90 | + return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root . '/'); |
|
| 91 | + } |
|
| 92 | 92 | |
| 93 | - /** |
|
| 94 | - * get the stored metadata of a file or folder |
|
| 95 | - * |
|
| 96 | - * @param string /int $file |
|
| 97 | - * @return array|false |
|
| 98 | - */ |
|
| 99 | - public function get($file) { |
|
| 100 | - if (is_string($file) or $file == '') { |
|
| 101 | - $file = $this->getSourcePath($file); |
|
| 102 | - } |
|
| 103 | - return parent::get($file); |
|
| 104 | - } |
|
| 93 | + /** |
|
| 94 | + * get the stored metadata of a file or folder |
|
| 95 | + * |
|
| 96 | + * @param string /int $file |
|
| 97 | + * @return array|false |
|
| 98 | + */ |
|
| 99 | + public function get($file) { |
|
| 100 | + if (is_string($file) or $file == '') { |
|
| 101 | + $file = $this->getSourcePath($file); |
|
| 102 | + } |
|
| 103 | + return parent::get($file); |
|
| 104 | + } |
|
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * insert meta data for a new file or folder |
|
| 108 | - * |
|
| 109 | - * @param string $file |
|
| 110 | - * @param array $data |
|
| 111 | - * |
|
| 112 | - * @return int file id |
|
| 113 | - * @throws \RuntimeException |
|
| 114 | - */ |
|
| 115 | - public function insert($file, array $data) { |
|
| 116 | - return $this->getCache()->insert($this->getSourcePath($file), $data); |
|
| 117 | - } |
|
| 106 | + /** |
|
| 107 | + * insert meta data for a new file or folder |
|
| 108 | + * |
|
| 109 | + * @param string $file |
|
| 110 | + * @param array $data |
|
| 111 | + * |
|
| 112 | + * @return int file id |
|
| 113 | + * @throws \RuntimeException |
|
| 114 | + */ |
|
| 115 | + public function insert($file, array $data) { |
|
| 116 | + return $this->getCache()->insert($this->getSourcePath($file), $data); |
|
| 117 | + } |
|
| 118 | 118 | |
| 119 | - /** |
|
| 120 | - * update the metadata in the cache |
|
| 121 | - * |
|
| 122 | - * @param int $id |
|
| 123 | - * @param array $data |
|
| 124 | - */ |
|
| 125 | - public function update($id, array $data) { |
|
| 126 | - $this->getCache()->update($id, $data); |
|
| 127 | - } |
|
| 119 | + /** |
|
| 120 | + * update the metadata in the cache |
|
| 121 | + * |
|
| 122 | + * @param int $id |
|
| 123 | + * @param array $data |
|
| 124 | + */ |
|
| 125 | + public function update($id, array $data) { |
|
| 126 | + $this->getCache()->update($id, $data); |
|
| 127 | + } |
|
| 128 | 128 | |
| 129 | - /** |
|
| 130 | - * get the file id for a file |
|
| 131 | - * |
|
| 132 | - * @param string $file |
|
| 133 | - * @return int |
|
| 134 | - */ |
|
| 135 | - public function getId($file) { |
|
| 136 | - return $this->getCache()->getId($this->getSourcePath($file)); |
|
| 137 | - } |
|
| 129 | + /** |
|
| 130 | + * get the file id for a file |
|
| 131 | + * |
|
| 132 | + * @param string $file |
|
| 133 | + * @return int |
|
| 134 | + */ |
|
| 135 | + public function getId($file) { |
|
| 136 | + return $this->getCache()->getId($this->getSourcePath($file)); |
|
| 137 | + } |
|
| 138 | 138 | |
| 139 | - /** |
|
| 140 | - * get the id of the parent folder of a file |
|
| 141 | - * |
|
| 142 | - * @param string $file |
|
| 143 | - * @return int |
|
| 144 | - */ |
|
| 145 | - public function getParentId($file) { |
|
| 146 | - return $this->getCache()->getParentId($this->getSourcePath($file)); |
|
| 147 | - } |
|
| 139 | + /** |
|
| 140 | + * get the id of the parent folder of a file |
|
| 141 | + * |
|
| 142 | + * @param string $file |
|
| 143 | + * @return int |
|
| 144 | + */ |
|
| 145 | + public function getParentId($file) { |
|
| 146 | + return $this->getCache()->getParentId($this->getSourcePath($file)); |
|
| 147 | + } |
|
| 148 | 148 | |
| 149 | - /** |
|
| 150 | - * check if a file is available in the cache |
|
| 151 | - * |
|
| 152 | - * @param string $file |
|
| 153 | - * @return bool |
|
| 154 | - */ |
|
| 155 | - public function inCache($file) { |
|
| 156 | - return $this->getCache()->inCache($this->getSourcePath($file)); |
|
| 157 | - } |
|
| 149 | + /** |
|
| 150 | + * check if a file is available in the cache |
|
| 151 | + * |
|
| 152 | + * @param string $file |
|
| 153 | + * @return bool |
|
| 154 | + */ |
|
| 155 | + public function inCache($file) { |
|
| 156 | + return $this->getCache()->inCache($this->getSourcePath($file)); |
|
| 157 | + } |
|
| 158 | 158 | |
| 159 | - /** |
|
| 160 | - * remove a file or folder from the cache |
|
| 161 | - * |
|
| 162 | - * @param string $file |
|
| 163 | - */ |
|
| 164 | - public function remove($file) { |
|
| 165 | - $this->getCache()->remove($this->getSourcePath($file)); |
|
| 166 | - } |
|
| 159 | + /** |
|
| 160 | + * remove a file or folder from the cache |
|
| 161 | + * |
|
| 162 | + * @param string $file |
|
| 163 | + */ |
|
| 164 | + public function remove($file) { |
|
| 165 | + $this->getCache()->remove($this->getSourcePath($file)); |
|
| 166 | + } |
|
| 167 | 167 | |
| 168 | - /** |
|
| 169 | - * Move a file or folder in the cache |
|
| 170 | - * |
|
| 171 | - * @param string $source |
|
| 172 | - * @param string $target |
|
| 173 | - */ |
|
| 174 | - public function move($source, $target) { |
|
| 175 | - $this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target)); |
|
| 176 | - } |
|
| 168 | + /** |
|
| 169 | + * Move a file or folder in the cache |
|
| 170 | + * |
|
| 171 | + * @param string $source |
|
| 172 | + * @param string $target |
|
| 173 | + */ |
|
| 174 | + public function move($source, $target) { |
|
| 175 | + $this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target)); |
|
| 176 | + } |
|
| 177 | 177 | |
| 178 | - /** |
|
| 179 | - * remove all entries for files that are stored on the storage from the cache |
|
| 180 | - */ |
|
| 181 | - public function clear() { |
|
| 182 | - $this->getCache()->remove($this->root); |
|
| 183 | - } |
|
| 178 | + /** |
|
| 179 | + * remove all entries for files that are stored on the storage from the cache |
|
| 180 | + */ |
|
| 181 | + public function clear() { |
|
| 182 | + $this->getCache()->remove($this->root); |
|
| 183 | + } |
|
| 184 | 184 | |
| 185 | - /** |
|
| 186 | - * @param string $file |
|
| 187 | - * |
|
| 188 | - * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE |
|
| 189 | - */ |
|
| 190 | - public function getStatus($file) { |
|
| 191 | - return $this->getCache()->getStatus($this->getSourcePath($file)); |
|
| 192 | - } |
|
| 185 | + /** |
|
| 186 | + * @param string $file |
|
| 187 | + * |
|
| 188 | + * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE |
|
| 189 | + */ |
|
| 190 | + public function getStatus($file) { |
|
| 191 | + return $this->getCache()->getStatus($this->getSourcePath($file)); |
|
| 192 | + } |
|
| 193 | 193 | |
| 194 | - private function formatSearchResults($results) { |
|
| 195 | - $results = array_filter($results, array($this, 'filterCacheEntry')); |
|
| 196 | - $results = array_values($results); |
|
| 197 | - return array_map(array($this, 'formatCacheEntry'), $results); |
|
| 198 | - } |
|
| 194 | + private function formatSearchResults($results) { |
|
| 195 | + $results = array_filter($results, array($this, 'filterCacheEntry')); |
|
| 196 | + $results = array_values($results); |
|
| 197 | + return array_map(array($this, 'formatCacheEntry'), $results); |
|
| 198 | + } |
|
| 199 | 199 | |
| 200 | - /** |
|
| 201 | - * search for files matching $pattern |
|
| 202 | - * |
|
| 203 | - * @param string $pattern |
|
| 204 | - * @return array an array of file data |
|
| 205 | - */ |
|
| 206 | - public function search($pattern) { |
|
| 207 | - $results = $this->getCache()->search($pattern); |
|
| 208 | - return $this->formatSearchResults($results); |
|
| 209 | - } |
|
| 200 | + /** |
|
| 201 | + * search for files matching $pattern |
|
| 202 | + * |
|
| 203 | + * @param string $pattern |
|
| 204 | + * @return array an array of file data |
|
| 205 | + */ |
|
| 206 | + public function search($pattern) { |
|
| 207 | + $results = $this->getCache()->search($pattern); |
|
| 208 | + return $this->formatSearchResults($results); |
|
| 209 | + } |
|
| 210 | 210 | |
| 211 | - /** |
|
| 212 | - * search for files by mimetype |
|
| 213 | - * |
|
| 214 | - * @param string $mimetype |
|
| 215 | - * @return array |
|
| 216 | - */ |
|
| 217 | - public function searchByMime($mimetype) { |
|
| 218 | - $results = $this->getCache()->searchByMime($mimetype); |
|
| 219 | - return $this->formatSearchResults($results); |
|
| 220 | - } |
|
| 211 | + /** |
|
| 212 | + * search for files by mimetype |
|
| 213 | + * |
|
| 214 | + * @param string $mimetype |
|
| 215 | + * @return array |
|
| 216 | + */ |
|
| 217 | + public function searchByMime($mimetype) { |
|
| 218 | + $results = $this->getCache()->searchByMime($mimetype); |
|
| 219 | + return $this->formatSearchResults($results); |
|
| 220 | + } |
|
| 221 | 221 | |
| 222 | - public function searchQuery(ISearchQuery $query) { |
|
| 223 | - $results = $this->getCache()->searchQuery($query); |
|
| 224 | - return $this->formatSearchResults($results); |
|
| 225 | - } |
|
| 222 | + public function searchQuery(ISearchQuery $query) { |
|
| 223 | + $results = $this->getCache()->searchQuery($query); |
|
| 224 | + return $this->formatSearchResults($results); |
|
| 225 | + } |
|
| 226 | 226 | |
| 227 | - /** |
|
| 228 | - * search for files by mimetype |
|
| 229 | - * |
|
| 230 | - * @param string|int $tag name or tag id |
|
| 231 | - * @param string $userId owner of the tags |
|
| 232 | - * @return array |
|
| 233 | - */ |
|
| 234 | - public function searchByTag($tag, $userId) { |
|
| 235 | - $results = $this->getCache()->searchByTag($tag, $userId); |
|
| 236 | - return $this->formatSearchResults($results); |
|
| 237 | - } |
|
| 227 | + /** |
|
| 228 | + * search for files by mimetype |
|
| 229 | + * |
|
| 230 | + * @param string|int $tag name or tag id |
|
| 231 | + * @param string $userId owner of the tags |
|
| 232 | + * @return array |
|
| 233 | + */ |
|
| 234 | + public function searchByTag($tag, $userId) { |
|
| 235 | + $results = $this->getCache()->searchByTag($tag, $userId); |
|
| 236 | + return $this->formatSearchResults($results); |
|
| 237 | + } |
|
| 238 | 238 | |
| 239 | - /** |
|
| 240 | - * update the folder size and the size of all parent folders |
|
| 241 | - * |
|
| 242 | - * @param string|boolean $path |
|
| 243 | - * @param array $data (optional) meta data of the folder |
|
| 244 | - */ |
|
| 245 | - public function correctFolderSize($path, $data = null) { |
|
| 246 | - if ($this->getCache() instanceof Cache) { |
|
| 247 | - $this->getCache()->correctFolderSize($this->getSourcePath($path), $data); |
|
| 248 | - } |
|
| 249 | - } |
|
| 239 | + /** |
|
| 240 | + * update the folder size and the size of all parent folders |
|
| 241 | + * |
|
| 242 | + * @param string|boolean $path |
|
| 243 | + * @param array $data (optional) meta data of the folder |
|
| 244 | + */ |
|
| 245 | + public function correctFolderSize($path, $data = null) { |
|
| 246 | + if ($this->getCache() instanceof Cache) { |
|
| 247 | + $this->getCache()->correctFolderSize($this->getSourcePath($path), $data); |
|
| 248 | + } |
|
| 249 | + } |
|
| 250 | 250 | |
| 251 | - /** |
|
| 252 | - * get the size of a folder and set it in the cache |
|
| 253 | - * |
|
| 254 | - * @param string $path |
|
| 255 | - * @param array $entry (optional) meta data of the folder |
|
| 256 | - * @return int |
|
| 257 | - */ |
|
| 258 | - public function calculateFolderSize($path, $entry = null) { |
|
| 259 | - if ($this->getCache() instanceof Cache) { |
|
| 260 | - return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry); |
|
| 261 | - } else { |
|
| 262 | - return 0; |
|
| 263 | - } |
|
| 251 | + /** |
|
| 252 | + * get the size of a folder and set it in the cache |
|
| 253 | + * |
|
| 254 | + * @param string $path |
|
| 255 | + * @param array $entry (optional) meta data of the folder |
|
| 256 | + * @return int |
|
| 257 | + */ |
|
| 258 | + public function calculateFolderSize($path, $entry = null) { |
|
| 259 | + if ($this->getCache() instanceof Cache) { |
|
| 260 | + return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry); |
|
| 261 | + } else { |
|
| 262 | + return 0; |
|
| 263 | + } |
|
| 264 | 264 | |
| 265 | - } |
|
| 265 | + } |
|
| 266 | 266 | |
| 267 | - /** |
|
| 268 | - * get all file ids on the files on the storage |
|
| 269 | - * |
|
| 270 | - * @return int[] |
|
| 271 | - */ |
|
| 272 | - public function getAll() { |
|
| 273 | - // not supported |
|
| 274 | - return array(); |
|
| 275 | - } |
|
| 267 | + /** |
|
| 268 | + * get all file ids on the files on the storage |
|
| 269 | + * |
|
| 270 | + * @return int[] |
|
| 271 | + */ |
|
| 272 | + public function getAll() { |
|
| 273 | + // not supported |
|
| 274 | + return array(); |
|
| 275 | + } |
|
| 276 | 276 | |
| 277 | - /** |
|
| 278 | - * find a folder in the cache which has not been fully scanned |
|
| 279 | - * |
|
| 280 | - * If multiply incomplete folders are in the cache, the one with the highest id will be returned, |
|
| 281 | - * use the one with the highest id gives the best result with the background scanner, since that is most |
|
| 282 | - * likely the folder where we stopped scanning previously |
|
| 283 | - * |
|
| 284 | - * @return string|bool the path of the folder or false when no folder matched |
|
| 285 | - */ |
|
| 286 | - public function getIncomplete() { |
|
| 287 | - // not supported |
|
| 288 | - return false; |
|
| 289 | - } |
|
| 277 | + /** |
|
| 278 | + * find a folder in the cache which has not been fully scanned |
|
| 279 | + * |
|
| 280 | + * If multiply incomplete folders are in the cache, the one with the highest id will be returned, |
|
| 281 | + * use the one with the highest id gives the best result with the background scanner, since that is most |
|
| 282 | + * likely the folder where we stopped scanning previously |
|
| 283 | + * |
|
| 284 | + * @return string|bool the path of the folder or false when no folder matched |
|
| 285 | + */ |
|
| 286 | + public function getIncomplete() { |
|
| 287 | + // not supported |
|
| 288 | + return false; |
|
| 289 | + } |
|
| 290 | 290 | |
| 291 | - /** |
|
| 292 | - * get the path of a file on this storage by it's id |
|
| 293 | - * |
|
| 294 | - * @param int $id |
|
| 295 | - * @return string|null |
|
| 296 | - */ |
|
| 297 | - public function getPathById($id) { |
|
| 298 | - $path = $this->getCache()->getPathById($id); |
|
| 299 | - return $this->getJailedPath($path); |
|
| 300 | - } |
|
| 291 | + /** |
|
| 292 | + * get the path of a file on this storage by it's id |
|
| 293 | + * |
|
| 294 | + * @param int $id |
|
| 295 | + * @return string|null |
|
| 296 | + */ |
|
| 297 | + public function getPathById($id) { |
|
| 298 | + $path = $this->getCache()->getPathById($id); |
|
| 299 | + return $this->getJailedPath($path); |
|
| 300 | + } |
|
| 301 | 301 | |
| 302 | - /** |
|
| 303 | - * Move a file or folder in the cache |
|
| 304 | - * |
|
| 305 | - * Note that this should make sure the entries are removed from the source cache |
|
| 306 | - * |
|
| 307 | - * @param \OCP\Files\Cache\ICache $sourceCache |
|
| 308 | - * @param string $sourcePath |
|
| 309 | - * @param string $targetPath |
|
| 310 | - */ |
|
| 311 | - public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) { |
|
| 312 | - if ($sourceCache === $this) { |
|
| 313 | - return $this->move($sourcePath, $targetPath); |
|
| 314 | - } |
|
| 315 | - return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath)); |
|
| 316 | - } |
|
| 302 | + /** |
|
| 303 | + * Move a file or folder in the cache |
|
| 304 | + * |
|
| 305 | + * Note that this should make sure the entries are removed from the source cache |
|
| 306 | + * |
|
| 307 | + * @param \OCP\Files\Cache\ICache $sourceCache |
|
| 308 | + * @param string $sourcePath |
|
| 309 | + * @param string $targetPath |
|
| 310 | + */ |
|
| 311 | + public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) { |
|
| 312 | + if ($sourceCache === $this) { |
|
| 313 | + return $this->move($sourcePath, $targetPath); |
|
| 314 | + } |
|
| 315 | + return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath)); |
|
| 316 | + } |
|
| 317 | 317 | } |
@@ -32,7 +32,6 @@ |
||
| 32 | 32 | |
| 33 | 33 | use OCP\Files\Cache\ICacheEntry; |
| 34 | 34 | use OCP\Files\Mount\IMountPoint; |
| 35 | -use OCP\Files\Storage\IStorage; |
|
| 36 | 35 | use OCP\Files\IHomeStorage; |
| 37 | 36 | use OCP\IUser; |
| 38 | 37 | |
@@ -37,354 +37,354 @@ |
||
| 37 | 37 | use OCP\IUser; |
| 38 | 38 | |
| 39 | 39 | class FileInfo implements \OCP\Files\FileInfo, \ArrayAccess { |
| 40 | - /** |
|
| 41 | - * @var array $data |
|
| 42 | - */ |
|
| 43 | - private $data; |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * @var string $path |
|
| 47 | - */ |
|
| 48 | - private $path; |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * @var \OC\Files\Storage\Storage $storage |
|
| 52 | - */ |
|
| 53 | - private $storage; |
|
| 54 | - |
|
| 55 | - /** |
|
| 56 | - * @var string $internalPath |
|
| 57 | - */ |
|
| 58 | - private $internalPath; |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * @var \OCP\Files\Mount\IMountPoint |
|
| 62 | - */ |
|
| 63 | - private $mount; |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * @var IUser |
|
| 67 | - */ |
|
| 68 | - private $owner; |
|
| 69 | - |
|
| 70 | - /** |
|
| 71 | - * @var string[] |
|
| 72 | - */ |
|
| 73 | - private $childEtags = []; |
|
| 74 | - |
|
| 75 | - /** |
|
| 76 | - * @var IMountPoint[] |
|
| 77 | - */ |
|
| 78 | - private $subMounts = []; |
|
| 79 | - |
|
| 80 | - private $subMountsUsed = false; |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * @param string|boolean $path |
|
| 84 | - * @param Storage\Storage $storage |
|
| 85 | - * @param string $internalPath |
|
| 86 | - * @param array|ICacheEntry $data |
|
| 87 | - * @param \OCP\Files\Mount\IMountPoint $mount |
|
| 88 | - * @param \OCP\IUser|null $owner |
|
| 89 | - */ |
|
| 90 | - public function __construct($path, $storage, $internalPath, $data, $mount, $owner= null) { |
|
| 91 | - $this->path = $path; |
|
| 92 | - $this->storage = $storage; |
|
| 93 | - $this->internalPath = $internalPath; |
|
| 94 | - $this->data = $data; |
|
| 95 | - $this->mount = $mount; |
|
| 96 | - $this->owner = $owner; |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - public function offsetSet($offset, $value) { |
|
| 100 | - $this->data[$offset] = $value; |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - public function offsetExists($offset) { |
|
| 104 | - return isset($this->data[$offset]); |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - public function offsetUnset($offset) { |
|
| 108 | - unset($this->data[$offset]); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - public function offsetGet($offset) { |
|
| 112 | - if ($offset === 'type') { |
|
| 113 | - return $this->getType(); |
|
| 114 | - } else if ($offset === 'etag') { |
|
| 115 | - return $this->getEtag(); |
|
| 116 | - } else if ($offset === 'size') { |
|
| 117 | - return $this->getSize(); |
|
| 118 | - } else if ($offset === 'mtime') { |
|
| 119 | - return $this->getMTime(); |
|
| 120 | - } elseif ($offset === 'permissions') { |
|
| 121 | - return $this->getPermissions(); |
|
| 122 | - } elseif (isset($this->data[$offset])) { |
|
| 123 | - return $this->data[$offset]; |
|
| 124 | - } else { |
|
| 125 | - return null; |
|
| 126 | - } |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * @return string |
|
| 131 | - */ |
|
| 132 | - public function getPath() { |
|
| 133 | - return $this->path; |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * @return \OCP\Files\Storage |
|
| 138 | - */ |
|
| 139 | - public function getStorage() { |
|
| 140 | - return $this->storage; |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - /** |
|
| 144 | - * @return string |
|
| 145 | - */ |
|
| 146 | - public function getInternalPath() { |
|
| 147 | - return $this->internalPath; |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * @return int |
|
| 152 | - */ |
|
| 153 | - public function getId() { |
|
| 154 | - return $this->data['fileid']; |
|
| 155 | - } |
|
| 156 | - |
|
| 157 | - /** |
|
| 158 | - * @return string |
|
| 159 | - */ |
|
| 160 | - public function getMimetype() { |
|
| 161 | - return $this->data['mimetype']; |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * @return string |
|
| 166 | - */ |
|
| 167 | - public function getMimePart() { |
|
| 168 | - return $this->data['mimepart']; |
|
| 169 | - } |
|
| 170 | - |
|
| 171 | - /** |
|
| 172 | - * @return string |
|
| 173 | - */ |
|
| 174 | - public function getName() { |
|
| 175 | - return basename($this->getPath()); |
|
| 176 | - } |
|
| 177 | - |
|
| 178 | - /** |
|
| 179 | - * @return string |
|
| 180 | - */ |
|
| 181 | - public function getEtag() { |
|
| 182 | - $this->updateEntryfromSubMounts(); |
|
| 183 | - if (count($this->childEtags) > 0) { |
|
| 184 | - $combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags); |
|
| 185 | - return md5($combinedEtag); |
|
| 186 | - } else { |
|
| 187 | - return $this->data['etag']; |
|
| 188 | - } |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - /** |
|
| 192 | - * @return int |
|
| 193 | - */ |
|
| 194 | - public function getSize() { |
|
| 195 | - $this->updateEntryfromSubMounts(); |
|
| 196 | - return isset($this->data['size']) ? $this->data['size'] : 0; |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - /** |
|
| 200 | - * @return int |
|
| 201 | - */ |
|
| 202 | - public function getMTime() { |
|
| 203 | - $this->updateEntryfromSubMounts(); |
|
| 204 | - return $this->data['mtime']; |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - /** |
|
| 208 | - * @return bool |
|
| 209 | - */ |
|
| 210 | - public function isEncrypted() { |
|
| 211 | - return $this->data['encrypted']; |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * Return the currently version used for the HMAC in the encryption app |
|
| 216 | - * |
|
| 217 | - * @return int |
|
| 218 | - */ |
|
| 219 | - public function getEncryptedVersion() { |
|
| 220 | - return isset($this->data['encryptedVersion']) ? (int) $this->data['encryptedVersion'] : 1; |
|
| 221 | - } |
|
| 222 | - |
|
| 223 | - /** |
|
| 224 | - * @return int |
|
| 225 | - */ |
|
| 226 | - public function getPermissions() { |
|
| 227 | - $perms = $this->data['permissions']; |
|
| 228 | - if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) { |
|
| 229 | - $perms = $perms & ~\OCP\Constants::PERMISSION_SHARE; |
|
| 230 | - } |
|
| 231 | - return $perms; |
|
| 232 | - } |
|
| 233 | - |
|
| 234 | - /** |
|
| 235 | - * @return \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER |
|
| 236 | - */ |
|
| 237 | - public function getType() { |
|
| 238 | - if (!isset($this->data['type'])) { |
|
| 239 | - $this->data['type'] = ($this->getMimetype() === 'httpd/unix-directory') ? self::TYPE_FOLDER : self::TYPE_FILE; |
|
| 240 | - } |
|
| 241 | - return $this->data['type']; |
|
| 242 | - } |
|
| 243 | - |
|
| 244 | - public function getData() { |
|
| 245 | - return $this->data; |
|
| 246 | - } |
|
| 247 | - |
|
| 248 | - /** |
|
| 249 | - * @param int $permissions |
|
| 250 | - * @return bool |
|
| 251 | - */ |
|
| 252 | - protected function checkPermissions($permissions) { |
|
| 253 | - return ($this->getPermissions() & $permissions) === $permissions; |
|
| 254 | - } |
|
| 255 | - |
|
| 256 | - /** |
|
| 257 | - * @return bool |
|
| 258 | - */ |
|
| 259 | - public function isReadable() { |
|
| 260 | - return $this->checkPermissions(\OCP\Constants::PERMISSION_READ); |
|
| 261 | - } |
|
| 262 | - |
|
| 263 | - /** |
|
| 264 | - * @return bool |
|
| 265 | - */ |
|
| 266 | - public function isUpdateable() { |
|
| 267 | - return $this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE); |
|
| 268 | - } |
|
| 269 | - |
|
| 270 | - /** |
|
| 271 | - * Check whether new files or folders can be created inside this folder |
|
| 272 | - * |
|
| 273 | - * @return bool |
|
| 274 | - */ |
|
| 275 | - public function isCreatable() { |
|
| 276 | - return $this->checkPermissions(\OCP\Constants::PERMISSION_CREATE); |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - /** |
|
| 280 | - * @return bool |
|
| 281 | - */ |
|
| 282 | - public function isDeletable() { |
|
| 283 | - return $this->checkPermissions(\OCP\Constants::PERMISSION_DELETE); |
|
| 284 | - } |
|
| 285 | - |
|
| 286 | - /** |
|
| 287 | - * @return bool |
|
| 288 | - */ |
|
| 289 | - public function isShareable() { |
|
| 290 | - return $this->checkPermissions(\OCP\Constants::PERMISSION_SHARE); |
|
| 291 | - } |
|
| 292 | - |
|
| 293 | - /** |
|
| 294 | - * Check if a file or folder is shared |
|
| 295 | - * |
|
| 296 | - * @return bool |
|
| 297 | - */ |
|
| 298 | - public function isShared() { |
|
| 299 | - $sid = $this->getStorage()->getId(); |
|
| 300 | - if (!is_null($sid)) { |
|
| 301 | - $sid = explode(':', $sid); |
|
| 302 | - return ($sid[0] === 'shared'); |
|
| 303 | - } |
|
| 304 | - |
|
| 305 | - return false; |
|
| 306 | - } |
|
| 307 | - |
|
| 308 | - public function isMounted() { |
|
| 309 | - $storage = $this->getStorage(); |
|
| 310 | - if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) { |
|
| 311 | - return false; |
|
| 312 | - } |
|
| 313 | - $sid = $storage->getId(); |
|
| 314 | - if (!is_null($sid)) { |
|
| 315 | - $sid = explode(':', $sid); |
|
| 316 | - return ($sid[0] !== 'home' and $sid[0] !== 'shared'); |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - return false; |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - /** |
|
| 323 | - * Get the mountpoint the file belongs to |
|
| 324 | - * |
|
| 325 | - * @return \OCP\Files\Mount\IMountPoint |
|
| 326 | - */ |
|
| 327 | - public function getMountPoint() { |
|
| 328 | - return $this->mount; |
|
| 329 | - } |
|
| 330 | - |
|
| 331 | - /** |
|
| 332 | - * Get the owner of the file |
|
| 333 | - * |
|
| 334 | - * @return \OCP\IUser |
|
| 335 | - */ |
|
| 336 | - public function getOwner() { |
|
| 337 | - return $this->owner; |
|
| 338 | - } |
|
| 339 | - |
|
| 340 | - /** |
|
| 341 | - * @param IMountPoint[] $mounts |
|
| 342 | - */ |
|
| 343 | - public function setSubMounts(array $mounts) { |
|
| 344 | - $this->subMounts = $mounts; |
|
| 345 | - } |
|
| 346 | - |
|
| 347 | - private function updateEntryfromSubMounts() { |
|
| 348 | - if ($this->subMountsUsed) { |
|
| 349 | - return; |
|
| 350 | - } |
|
| 351 | - $this->subMountsUsed = true; |
|
| 352 | - foreach ($this->subMounts as $mount) { |
|
| 353 | - $subStorage = $mount->getStorage(); |
|
| 354 | - if ($subStorage) { |
|
| 355 | - $subCache = $subStorage->getCache(''); |
|
| 356 | - $rootEntry = $subCache->get(''); |
|
| 357 | - $this->addSubEntry($rootEntry, $mount->getMountPoint()); |
|
| 358 | - } |
|
| 359 | - } |
|
| 360 | - } |
|
| 361 | - |
|
| 362 | - /** |
|
| 363 | - * Add a cache entry which is the child of this folder |
|
| 364 | - * |
|
| 365 | - * Sets the size, etag and size to for cross-storage childs |
|
| 366 | - * |
|
| 367 | - * @param array|ICacheEntry $data cache entry for the child |
|
| 368 | - * @param string $entryPath full path of the child entry |
|
| 369 | - */ |
|
| 370 | - public function addSubEntry($data, $entryPath) { |
|
| 371 | - $this->data['size'] += isset($data['size']) ? $data['size'] : 0; |
|
| 372 | - if (isset($data['mtime'])) { |
|
| 373 | - $this->data['mtime'] = max($this->data['mtime'], $data['mtime']); |
|
| 374 | - } |
|
| 375 | - if (isset($data['etag'])) { |
|
| 376 | - // prefix the etag with the relative path of the subentry to propagate etag on mount moves |
|
| 377 | - $relativeEntryPath = substr($entryPath, strlen($this->getPath())); |
|
| 378 | - // attach the permissions to propagate etag on permision changes of submounts |
|
| 379 | - $permissions = isset($data['permissions']) ? $data['permissions'] : 0; |
|
| 380 | - $this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions; |
|
| 381 | - } |
|
| 382 | - } |
|
| 383 | - |
|
| 384 | - /** |
|
| 385 | - * @inheritdoc |
|
| 386 | - */ |
|
| 387 | - public function getChecksum() { |
|
| 388 | - return $this->data['checksum']; |
|
| 389 | - } |
|
| 40 | + /** |
|
| 41 | + * @var array $data |
|
| 42 | + */ |
|
| 43 | + private $data; |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * @var string $path |
|
| 47 | + */ |
|
| 48 | + private $path; |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * @var \OC\Files\Storage\Storage $storage |
|
| 52 | + */ |
|
| 53 | + private $storage; |
|
| 54 | + |
|
| 55 | + /** |
|
| 56 | + * @var string $internalPath |
|
| 57 | + */ |
|
| 58 | + private $internalPath; |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * @var \OCP\Files\Mount\IMountPoint |
|
| 62 | + */ |
|
| 63 | + private $mount; |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * @var IUser |
|
| 67 | + */ |
|
| 68 | + private $owner; |
|
| 69 | + |
|
| 70 | + /** |
|
| 71 | + * @var string[] |
|
| 72 | + */ |
|
| 73 | + private $childEtags = []; |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * @var IMountPoint[] |
|
| 77 | + */ |
|
| 78 | + private $subMounts = []; |
|
| 79 | + |
|
| 80 | + private $subMountsUsed = false; |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * @param string|boolean $path |
|
| 84 | + * @param Storage\Storage $storage |
|
| 85 | + * @param string $internalPath |
|
| 86 | + * @param array|ICacheEntry $data |
|
| 87 | + * @param \OCP\Files\Mount\IMountPoint $mount |
|
| 88 | + * @param \OCP\IUser|null $owner |
|
| 89 | + */ |
|
| 90 | + public function __construct($path, $storage, $internalPath, $data, $mount, $owner= null) { |
|
| 91 | + $this->path = $path; |
|
| 92 | + $this->storage = $storage; |
|
| 93 | + $this->internalPath = $internalPath; |
|
| 94 | + $this->data = $data; |
|
| 95 | + $this->mount = $mount; |
|
| 96 | + $this->owner = $owner; |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + public function offsetSet($offset, $value) { |
|
| 100 | + $this->data[$offset] = $value; |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + public function offsetExists($offset) { |
|
| 104 | + return isset($this->data[$offset]); |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + public function offsetUnset($offset) { |
|
| 108 | + unset($this->data[$offset]); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + public function offsetGet($offset) { |
|
| 112 | + if ($offset === 'type') { |
|
| 113 | + return $this->getType(); |
|
| 114 | + } else if ($offset === 'etag') { |
|
| 115 | + return $this->getEtag(); |
|
| 116 | + } else if ($offset === 'size') { |
|
| 117 | + return $this->getSize(); |
|
| 118 | + } else if ($offset === 'mtime') { |
|
| 119 | + return $this->getMTime(); |
|
| 120 | + } elseif ($offset === 'permissions') { |
|
| 121 | + return $this->getPermissions(); |
|
| 122 | + } elseif (isset($this->data[$offset])) { |
|
| 123 | + return $this->data[$offset]; |
|
| 124 | + } else { |
|
| 125 | + return null; |
|
| 126 | + } |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * @return string |
|
| 131 | + */ |
|
| 132 | + public function getPath() { |
|
| 133 | + return $this->path; |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * @return \OCP\Files\Storage |
|
| 138 | + */ |
|
| 139 | + public function getStorage() { |
|
| 140 | + return $this->storage; |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + /** |
|
| 144 | + * @return string |
|
| 145 | + */ |
|
| 146 | + public function getInternalPath() { |
|
| 147 | + return $this->internalPath; |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * @return int |
|
| 152 | + */ |
|
| 153 | + public function getId() { |
|
| 154 | + return $this->data['fileid']; |
|
| 155 | + } |
|
| 156 | + |
|
| 157 | + /** |
|
| 158 | + * @return string |
|
| 159 | + */ |
|
| 160 | + public function getMimetype() { |
|
| 161 | + return $this->data['mimetype']; |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * @return string |
|
| 166 | + */ |
|
| 167 | + public function getMimePart() { |
|
| 168 | + return $this->data['mimepart']; |
|
| 169 | + } |
|
| 170 | + |
|
| 171 | + /** |
|
| 172 | + * @return string |
|
| 173 | + */ |
|
| 174 | + public function getName() { |
|
| 175 | + return basename($this->getPath()); |
|
| 176 | + } |
|
| 177 | + |
|
| 178 | + /** |
|
| 179 | + * @return string |
|
| 180 | + */ |
|
| 181 | + public function getEtag() { |
|
| 182 | + $this->updateEntryfromSubMounts(); |
|
| 183 | + if (count($this->childEtags) > 0) { |
|
| 184 | + $combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags); |
|
| 185 | + return md5($combinedEtag); |
|
| 186 | + } else { |
|
| 187 | + return $this->data['etag']; |
|
| 188 | + } |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + /** |
|
| 192 | + * @return int |
|
| 193 | + */ |
|
| 194 | + public function getSize() { |
|
| 195 | + $this->updateEntryfromSubMounts(); |
|
| 196 | + return isset($this->data['size']) ? $this->data['size'] : 0; |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + /** |
|
| 200 | + * @return int |
|
| 201 | + */ |
|
| 202 | + public function getMTime() { |
|
| 203 | + $this->updateEntryfromSubMounts(); |
|
| 204 | + return $this->data['mtime']; |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + /** |
|
| 208 | + * @return bool |
|
| 209 | + */ |
|
| 210 | + public function isEncrypted() { |
|
| 211 | + return $this->data['encrypted']; |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * Return the currently version used for the HMAC in the encryption app |
|
| 216 | + * |
|
| 217 | + * @return int |
|
| 218 | + */ |
|
| 219 | + public function getEncryptedVersion() { |
|
| 220 | + return isset($this->data['encryptedVersion']) ? (int) $this->data['encryptedVersion'] : 1; |
|
| 221 | + } |
|
| 222 | + |
|
| 223 | + /** |
|
| 224 | + * @return int |
|
| 225 | + */ |
|
| 226 | + public function getPermissions() { |
|
| 227 | + $perms = $this->data['permissions']; |
|
| 228 | + if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) { |
|
| 229 | + $perms = $perms & ~\OCP\Constants::PERMISSION_SHARE; |
|
| 230 | + } |
|
| 231 | + return $perms; |
|
| 232 | + } |
|
| 233 | + |
|
| 234 | + /** |
|
| 235 | + * @return \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER |
|
| 236 | + */ |
|
| 237 | + public function getType() { |
|
| 238 | + if (!isset($this->data['type'])) { |
|
| 239 | + $this->data['type'] = ($this->getMimetype() === 'httpd/unix-directory') ? self::TYPE_FOLDER : self::TYPE_FILE; |
|
| 240 | + } |
|
| 241 | + return $this->data['type']; |
|
| 242 | + } |
|
| 243 | + |
|
| 244 | + public function getData() { |
|
| 245 | + return $this->data; |
|
| 246 | + } |
|
| 247 | + |
|
| 248 | + /** |
|
| 249 | + * @param int $permissions |
|
| 250 | + * @return bool |
|
| 251 | + */ |
|
| 252 | + protected function checkPermissions($permissions) { |
|
| 253 | + return ($this->getPermissions() & $permissions) === $permissions; |
|
| 254 | + } |
|
| 255 | + |
|
| 256 | + /** |
|
| 257 | + * @return bool |
|
| 258 | + */ |
|
| 259 | + public function isReadable() { |
|
| 260 | + return $this->checkPermissions(\OCP\Constants::PERMISSION_READ); |
|
| 261 | + } |
|
| 262 | + |
|
| 263 | + /** |
|
| 264 | + * @return bool |
|
| 265 | + */ |
|
| 266 | + public function isUpdateable() { |
|
| 267 | + return $this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE); |
|
| 268 | + } |
|
| 269 | + |
|
| 270 | + /** |
|
| 271 | + * Check whether new files or folders can be created inside this folder |
|
| 272 | + * |
|
| 273 | + * @return bool |
|
| 274 | + */ |
|
| 275 | + public function isCreatable() { |
|
| 276 | + return $this->checkPermissions(\OCP\Constants::PERMISSION_CREATE); |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + /** |
|
| 280 | + * @return bool |
|
| 281 | + */ |
|
| 282 | + public function isDeletable() { |
|
| 283 | + return $this->checkPermissions(\OCP\Constants::PERMISSION_DELETE); |
|
| 284 | + } |
|
| 285 | + |
|
| 286 | + /** |
|
| 287 | + * @return bool |
|
| 288 | + */ |
|
| 289 | + public function isShareable() { |
|
| 290 | + return $this->checkPermissions(\OCP\Constants::PERMISSION_SHARE); |
|
| 291 | + } |
|
| 292 | + |
|
| 293 | + /** |
|
| 294 | + * Check if a file or folder is shared |
|
| 295 | + * |
|
| 296 | + * @return bool |
|
| 297 | + */ |
|
| 298 | + public function isShared() { |
|
| 299 | + $sid = $this->getStorage()->getId(); |
|
| 300 | + if (!is_null($sid)) { |
|
| 301 | + $sid = explode(':', $sid); |
|
| 302 | + return ($sid[0] === 'shared'); |
|
| 303 | + } |
|
| 304 | + |
|
| 305 | + return false; |
|
| 306 | + } |
|
| 307 | + |
|
| 308 | + public function isMounted() { |
|
| 309 | + $storage = $this->getStorage(); |
|
| 310 | + if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) { |
|
| 311 | + return false; |
|
| 312 | + } |
|
| 313 | + $sid = $storage->getId(); |
|
| 314 | + if (!is_null($sid)) { |
|
| 315 | + $sid = explode(':', $sid); |
|
| 316 | + return ($sid[0] !== 'home' and $sid[0] !== 'shared'); |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + return false; |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + /** |
|
| 323 | + * Get the mountpoint the file belongs to |
|
| 324 | + * |
|
| 325 | + * @return \OCP\Files\Mount\IMountPoint |
|
| 326 | + */ |
|
| 327 | + public function getMountPoint() { |
|
| 328 | + return $this->mount; |
|
| 329 | + } |
|
| 330 | + |
|
| 331 | + /** |
|
| 332 | + * Get the owner of the file |
|
| 333 | + * |
|
| 334 | + * @return \OCP\IUser |
|
| 335 | + */ |
|
| 336 | + public function getOwner() { |
|
| 337 | + return $this->owner; |
|
| 338 | + } |
|
| 339 | + |
|
| 340 | + /** |
|
| 341 | + * @param IMountPoint[] $mounts |
|
| 342 | + */ |
|
| 343 | + public function setSubMounts(array $mounts) { |
|
| 344 | + $this->subMounts = $mounts; |
|
| 345 | + } |
|
| 346 | + |
|
| 347 | + private function updateEntryfromSubMounts() { |
|
| 348 | + if ($this->subMountsUsed) { |
|
| 349 | + return; |
|
| 350 | + } |
|
| 351 | + $this->subMountsUsed = true; |
|
| 352 | + foreach ($this->subMounts as $mount) { |
|
| 353 | + $subStorage = $mount->getStorage(); |
|
| 354 | + if ($subStorage) { |
|
| 355 | + $subCache = $subStorage->getCache(''); |
|
| 356 | + $rootEntry = $subCache->get(''); |
|
| 357 | + $this->addSubEntry($rootEntry, $mount->getMountPoint()); |
|
| 358 | + } |
|
| 359 | + } |
|
| 360 | + } |
|
| 361 | + |
|
| 362 | + /** |
|
| 363 | + * Add a cache entry which is the child of this folder |
|
| 364 | + * |
|
| 365 | + * Sets the size, etag and size to for cross-storage childs |
|
| 366 | + * |
|
| 367 | + * @param array|ICacheEntry $data cache entry for the child |
|
| 368 | + * @param string $entryPath full path of the child entry |
|
| 369 | + */ |
|
| 370 | + public function addSubEntry($data, $entryPath) { |
|
| 371 | + $this->data['size'] += isset($data['size']) ? $data['size'] : 0; |
|
| 372 | + if (isset($data['mtime'])) { |
|
| 373 | + $this->data['mtime'] = max($this->data['mtime'], $data['mtime']); |
|
| 374 | + } |
|
| 375 | + if (isset($data['etag'])) { |
|
| 376 | + // prefix the etag with the relative path of the subentry to propagate etag on mount moves |
|
| 377 | + $relativeEntryPath = substr($entryPath, strlen($this->getPath())); |
|
| 378 | + // attach the permissions to propagate etag on permision changes of submounts |
|
| 379 | + $permissions = isset($data['permissions']) ? $data['permissions'] : 0; |
|
| 380 | + $this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions; |
|
| 381 | + } |
|
| 382 | + } |
|
| 383 | + |
|
| 384 | + /** |
|
| 385 | + * @inheritdoc |
|
| 386 | + */ |
|
| 387 | + public function getChecksum() { |
|
| 388 | + return $this->data['checksum']; |
|
| 389 | + } |
|
| 390 | 390 | } |
@@ -87,7 +87,7 @@ discard block |
||
| 87 | 87 | * @param \OCP\Files\Mount\IMountPoint $mount |
| 88 | 88 | * @param \OCP\IUser|null $owner |
| 89 | 89 | */ |
| 90 | - public function __construct($path, $storage, $internalPath, $data, $mount, $owner= null) { |
|
| 90 | + public function __construct($path, $storage, $internalPath, $data, $mount, $owner = null) { |
|
| 91 | 91 | $this->path = $path; |
| 92 | 92 | $this->storage = $storage; |
| 93 | 93 | $this->internalPath = $internalPath; |
@@ -181,7 +181,7 @@ discard block |
||
| 181 | 181 | public function getEtag() { |
| 182 | 182 | $this->updateEntryfromSubMounts(); |
| 183 | 183 | if (count($this->childEtags) > 0) { |
| 184 | - $combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags); |
|
| 184 | + $combinedEtag = $this->data['etag'].'::'.implode('::', $this->childEtags); |
|
| 185 | 185 | return md5($combinedEtag); |
| 186 | 186 | } else { |
| 187 | 187 | return $this->data['etag']; |
@@ -377,7 +377,7 @@ discard block |
||
| 377 | 377 | $relativeEntryPath = substr($entryPath, strlen($this->getPath())); |
| 378 | 378 | // attach the permissions to propagate etag on permision changes of submounts |
| 379 | 379 | $permissions = isset($data['permissions']) ? $data['permissions'] : 0; |
| 380 | - $this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions; |
|
| 380 | + $this->childEtags[] = $relativeEntryPath.'/'.$data['etag'].$permissions; |
|
| 381 | 381 | } |
| 382 | 382 | } |
| 383 | 383 | |
@@ -156,7 +156,7 @@ |
||
| 156 | 156 | /** |
| 157 | 157 | * @param string $gid |
| 158 | 158 | * @param string $displayName |
| 159 | - * @return \OCP\IGroup |
|
| 159 | + * @return null|Group |
|
| 160 | 160 | */ |
| 161 | 161 | protected function getGroupObject($gid, $displayName = null) { |
| 162 | 162 | $backends = array(); |
@@ -55,308 +55,308 @@ |
||
| 55 | 55 | * @package OC\Group |
| 56 | 56 | */ |
| 57 | 57 | class Manager extends PublicEmitter implements IGroupManager { |
| 58 | - /** |
|
| 59 | - * @var GroupInterface[] $backends |
|
| 60 | - */ |
|
| 61 | - private $backends = array(); |
|
| 58 | + /** |
|
| 59 | + * @var GroupInterface[] $backends |
|
| 60 | + */ |
|
| 61 | + private $backends = array(); |
|
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * @var \OC\User\Manager $userManager |
|
| 65 | - */ |
|
| 66 | - private $userManager; |
|
| 63 | + /** |
|
| 64 | + * @var \OC\User\Manager $userManager |
|
| 65 | + */ |
|
| 66 | + private $userManager; |
|
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * @var \OC\Group\Group[] |
|
| 70 | - */ |
|
| 71 | - private $cachedGroups = array(); |
|
| 68 | + /** |
|
| 69 | + * @var \OC\Group\Group[] |
|
| 70 | + */ |
|
| 71 | + private $cachedGroups = array(); |
|
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * @var \OC\Group\Group[] |
|
| 75 | - */ |
|
| 76 | - private $cachedUserGroups = array(); |
|
| 73 | + /** |
|
| 74 | + * @var \OC\Group\Group[] |
|
| 75 | + */ |
|
| 76 | + private $cachedUserGroups = array(); |
|
| 77 | 77 | |
| 78 | - /** @var \OC\SubAdmin */ |
|
| 79 | - private $subAdmin = null; |
|
| 78 | + /** @var \OC\SubAdmin */ |
|
| 79 | + private $subAdmin = null; |
|
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * @param \OC\User\Manager $userManager |
|
| 83 | - */ |
|
| 84 | - public function __construct(\OC\User\Manager $userManager) { |
|
| 85 | - $this->userManager = $userManager; |
|
| 86 | - $cachedGroups = & $this->cachedGroups; |
|
| 87 | - $cachedUserGroups = & $this->cachedUserGroups; |
|
| 88 | - $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
| 89 | - /** |
|
| 90 | - * @var \OC\Group\Group $group |
|
| 91 | - */ |
|
| 92 | - unset($cachedGroups[$group->getGID()]); |
|
| 93 | - $cachedUserGroups = array(); |
|
| 94 | - }); |
|
| 95 | - $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) { |
|
| 96 | - /** |
|
| 97 | - * @var \OC\Group\Group $group |
|
| 98 | - */ |
|
| 99 | - $cachedUserGroups = array(); |
|
| 100 | - }); |
|
| 101 | - $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) { |
|
| 102 | - /** |
|
| 103 | - * @var \OC\Group\Group $group |
|
| 104 | - */ |
|
| 105 | - $cachedUserGroups = array(); |
|
| 106 | - }); |
|
| 107 | - } |
|
| 81 | + /** |
|
| 82 | + * @param \OC\User\Manager $userManager |
|
| 83 | + */ |
|
| 84 | + public function __construct(\OC\User\Manager $userManager) { |
|
| 85 | + $this->userManager = $userManager; |
|
| 86 | + $cachedGroups = & $this->cachedGroups; |
|
| 87 | + $cachedUserGroups = & $this->cachedUserGroups; |
|
| 88 | + $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
| 89 | + /** |
|
| 90 | + * @var \OC\Group\Group $group |
|
| 91 | + */ |
|
| 92 | + unset($cachedGroups[$group->getGID()]); |
|
| 93 | + $cachedUserGroups = array(); |
|
| 94 | + }); |
|
| 95 | + $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) { |
|
| 96 | + /** |
|
| 97 | + * @var \OC\Group\Group $group |
|
| 98 | + */ |
|
| 99 | + $cachedUserGroups = array(); |
|
| 100 | + }); |
|
| 101 | + $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) { |
|
| 102 | + /** |
|
| 103 | + * @var \OC\Group\Group $group |
|
| 104 | + */ |
|
| 105 | + $cachedUserGroups = array(); |
|
| 106 | + }); |
|
| 107 | + } |
|
| 108 | 108 | |
| 109 | - /** |
|
| 110 | - * Checks whether a given backend is used |
|
| 111 | - * |
|
| 112 | - * @param string $backendClass Full classname including complete namespace |
|
| 113 | - * @return bool |
|
| 114 | - */ |
|
| 115 | - public function isBackendUsed($backendClass) { |
|
| 116 | - $backendClass = strtolower(ltrim($backendClass, '\\')); |
|
| 109 | + /** |
|
| 110 | + * Checks whether a given backend is used |
|
| 111 | + * |
|
| 112 | + * @param string $backendClass Full classname including complete namespace |
|
| 113 | + * @return bool |
|
| 114 | + */ |
|
| 115 | + public function isBackendUsed($backendClass) { |
|
| 116 | + $backendClass = strtolower(ltrim($backendClass, '\\')); |
|
| 117 | 117 | |
| 118 | - foreach ($this->backends as $backend) { |
|
| 119 | - if (strtolower(get_class($backend)) === $backendClass) { |
|
| 120 | - return true; |
|
| 121 | - } |
|
| 122 | - } |
|
| 118 | + foreach ($this->backends as $backend) { |
|
| 119 | + if (strtolower(get_class($backend)) === $backendClass) { |
|
| 120 | + return true; |
|
| 121 | + } |
|
| 122 | + } |
|
| 123 | 123 | |
| 124 | - return false; |
|
| 125 | - } |
|
| 124 | + return false; |
|
| 125 | + } |
|
| 126 | 126 | |
| 127 | - /** |
|
| 128 | - * @param \OCP\GroupInterface $backend |
|
| 129 | - */ |
|
| 130 | - public function addBackend($backend) { |
|
| 131 | - $this->backends[] = $backend; |
|
| 132 | - $this->clearCaches(); |
|
| 133 | - } |
|
| 127 | + /** |
|
| 128 | + * @param \OCP\GroupInterface $backend |
|
| 129 | + */ |
|
| 130 | + public function addBackend($backend) { |
|
| 131 | + $this->backends[] = $backend; |
|
| 132 | + $this->clearCaches(); |
|
| 133 | + } |
|
| 134 | 134 | |
| 135 | - public function clearBackends() { |
|
| 136 | - $this->backends = array(); |
|
| 137 | - $this->clearCaches(); |
|
| 138 | - } |
|
| 135 | + public function clearBackends() { |
|
| 136 | + $this->backends = array(); |
|
| 137 | + $this->clearCaches(); |
|
| 138 | + } |
|
| 139 | 139 | |
| 140 | - protected function clearCaches() { |
|
| 141 | - $this->cachedGroups = array(); |
|
| 142 | - $this->cachedUserGroups = array(); |
|
| 143 | - } |
|
| 140 | + protected function clearCaches() { |
|
| 141 | + $this->cachedGroups = array(); |
|
| 142 | + $this->cachedUserGroups = array(); |
|
| 143 | + } |
|
| 144 | 144 | |
| 145 | - /** |
|
| 146 | - * @param string $gid |
|
| 147 | - * @return \OC\Group\Group |
|
| 148 | - */ |
|
| 149 | - public function get($gid) { |
|
| 150 | - if (isset($this->cachedGroups[$gid])) { |
|
| 151 | - return $this->cachedGroups[$gid]; |
|
| 152 | - } |
|
| 153 | - return $this->getGroupObject($gid); |
|
| 154 | - } |
|
| 145 | + /** |
|
| 146 | + * @param string $gid |
|
| 147 | + * @return \OC\Group\Group |
|
| 148 | + */ |
|
| 149 | + public function get($gid) { |
|
| 150 | + if (isset($this->cachedGroups[$gid])) { |
|
| 151 | + return $this->cachedGroups[$gid]; |
|
| 152 | + } |
|
| 153 | + return $this->getGroupObject($gid); |
|
| 154 | + } |
|
| 155 | 155 | |
| 156 | - /** |
|
| 157 | - * @param string $gid |
|
| 158 | - * @param string $displayName |
|
| 159 | - * @return \OCP\IGroup |
|
| 160 | - */ |
|
| 161 | - protected function getGroupObject($gid, $displayName = null) { |
|
| 162 | - $backends = array(); |
|
| 163 | - foreach ($this->backends as $backend) { |
|
| 164 | - if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) { |
|
| 165 | - $groupData = $backend->getGroupDetails($gid); |
|
| 166 | - if (is_array($groupData)) { |
|
| 167 | - // take the display name from the first backend that has a non-null one |
|
| 168 | - if (is_null($displayName) && isset($groupData['displayName'])) { |
|
| 169 | - $displayName = $groupData['displayName']; |
|
| 170 | - } |
|
| 171 | - $backends[] = $backend; |
|
| 172 | - } |
|
| 173 | - } else if ($backend->groupExists($gid)) { |
|
| 174 | - $backends[] = $backend; |
|
| 175 | - } |
|
| 176 | - } |
|
| 177 | - if (count($backends) === 0) { |
|
| 178 | - return null; |
|
| 179 | - } |
|
| 180 | - $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName); |
|
| 181 | - return $this->cachedGroups[$gid]; |
|
| 182 | - } |
|
| 156 | + /** |
|
| 157 | + * @param string $gid |
|
| 158 | + * @param string $displayName |
|
| 159 | + * @return \OCP\IGroup |
|
| 160 | + */ |
|
| 161 | + protected function getGroupObject($gid, $displayName = null) { |
|
| 162 | + $backends = array(); |
|
| 163 | + foreach ($this->backends as $backend) { |
|
| 164 | + if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) { |
|
| 165 | + $groupData = $backend->getGroupDetails($gid); |
|
| 166 | + if (is_array($groupData)) { |
|
| 167 | + // take the display name from the first backend that has a non-null one |
|
| 168 | + if (is_null($displayName) && isset($groupData['displayName'])) { |
|
| 169 | + $displayName = $groupData['displayName']; |
|
| 170 | + } |
|
| 171 | + $backends[] = $backend; |
|
| 172 | + } |
|
| 173 | + } else if ($backend->groupExists($gid)) { |
|
| 174 | + $backends[] = $backend; |
|
| 175 | + } |
|
| 176 | + } |
|
| 177 | + if (count($backends) === 0) { |
|
| 178 | + return null; |
|
| 179 | + } |
|
| 180 | + $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName); |
|
| 181 | + return $this->cachedGroups[$gid]; |
|
| 182 | + } |
|
| 183 | 183 | |
| 184 | - /** |
|
| 185 | - * @param string $gid |
|
| 186 | - * @return bool |
|
| 187 | - */ |
|
| 188 | - public function groupExists($gid) { |
|
| 189 | - return !is_null($this->get($gid)); |
|
| 190 | - } |
|
| 184 | + /** |
|
| 185 | + * @param string $gid |
|
| 186 | + * @return bool |
|
| 187 | + */ |
|
| 188 | + public function groupExists($gid) { |
|
| 189 | + return !is_null($this->get($gid)); |
|
| 190 | + } |
|
| 191 | 191 | |
| 192 | - /** |
|
| 193 | - * @param string $gid |
|
| 194 | - * @return \OC\Group\Group |
|
| 195 | - */ |
|
| 196 | - public function createGroup($gid) { |
|
| 197 | - if ($gid === '' || is_null($gid)) { |
|
| 198 | - return false; |
|
| 199 | - } else if ($group = $this->get($gid)) { |
|
| 200 | - return $group; |
|
| 201 | - } else { |
|
| 202 | - $this->emit('\OC\Group', 'preCreate', array($gid)); |
|
| 203 | - foreach ($this->backends as $backend) { |
|
| 204 | - if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) { |
|
| 205 | - $backend->createGroup($gid); |
|
| 206 | - $group = $this->getGroupObject($gid); |
|
| 207 | - $this->emit('\OC\Group', 'postCreate', array($group)); |
|
| 208 | - return $group; |
|
| 209 | - } |
|
| 210 | - } |
|
| 211 | - return null; |
|
| 212 | - } |
|
| 213 | - } |
|
| 192 | + /** |
|
| 193 | + * @param string $gid |
|
| 194 | + * @return \OC\Group\Group |
|
| 195 | + */ |
|
| 196 | + public function createGroup($gid) { |
|
| 197 | + if ($gid === '' || is_null($gid)) { |
|
| 198 | + return false; |
|
| 199 | + } else if ($group = $this->get($gid)) { |
|
| 200 | + return $group; |
|
| 201 | + } else { |
|
| 202 | + $this->emit('\OC\Group', 'preCreate', array($gid)); |
|
| 203 | + foreach ($this->backends as $backend) { |
|
| 204 | + if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) { |
|
| 205 | + $backend->createGroup($gid); |
|
| 206 | + $group = $this->getGroupObject($gid); |
|
| 207 | + $this->emit('\OC\Group', 'postCreate', array($group)); |
|
| 208 | + return $group; |
|
| 209 | + } |
|
| 210 | + } |
|
| 211 | + return null; |
|
| 212 | + } |
|
| 213 | + } |
|
| 214 | 214 | |
| 215 | - /** |
|
| 216 | - * @param string $search |
|
| 217 | - * @param int $limit |
|
| 218 | - * @param int $offset |
|
| 219 | - * @return \OC\Group\Group[] |
|
| 220 | - */ |
|
| 221 | - public function search($search, $limit = null, $offset = null) { |
|
| 222 | - $groups = array(); |
|
| 223 | - foreach ($this->backends as $backend) { |
|
| 224 | - $groupIds = $backend->getGroups($search, $limit, $offset); |
|
| 225 | - foreach ($groupIds as $groupId) { |
|
| 226 | - $groups[$groupId] = $this->get($groupId); |
|
| 227 | - } |
|
| 228 | - if (!is_null($limit) and $limit <= 0) { |
|
| 229 | - return array_values($groups); |
|
| 230 | - } |
|
| 231 | - } |
|
| 232 | - return array_values($groups); |
|
| 233 | - } |
|
| 215 | + /** |
|
| 216 | + * @param string $search |
|
| 217 | + * @param int $limit |
|
| 218 | + * @param int $offset |
|
| 219 | + * @return \OC\Group\Group[] |
|
| 220 | + */ |
|
| 221 | + public function search($search, $limit = null, $offset = null) { |
|
| 222 | + $groups = array(); |
|
| 223 | + foreach ($this->backends as $backend) { |
|
| 224 | + $groupIds = $backend->getGroups($search, $limit, $offset); |
|
| 225 | + foreach ($groupIds as $groupId) { |
|
| 226 | + $groups[$groupId] = $this->get($groupId); |
|
| 227 | + } |
|
| 228 | + if (!is_null($limit) and $limit <= 0) { |
|
| 229 | + return array_values($groups); |
|
| 230 | + } |
|
| 231 | + } |
|
| 232 | + return array_values($groups); |
|
| 233 | + } |
|
| 234 | 234 | |
| 235 | - /** |
|
| 236 | - * @param \OC\User\User|null $user |
|
| 237 | - * @return \OC\Group\Group[] |
|
| 238 | - */ |
|
| 239 | - public function getUserGroups($user) { |
|
| 240 | - if (is_null($user)) { |
|
| 241 | - return []; |
|
| 242 | - } |
|
| 243 | - return $this->getUserIdGroups($user->getUID()); |
|
| 244 | - } |
|
| 235 | + /** |
|
| 236 | + * @param \OC\User\User|null $user |
|
| 237 | + * @return \OC\Group\Group[] |
|
| 238 | + */ |
|
| 239 | + public function getUserGroups($user) { |
|
| 240 | + if (is_null($user)) { |
|
| 241 | + return []; |
|
| 242 | + } |
|
| 243 | + return $this->getUserIdGroups($user->getUID()); |
|
| 244 | + } |
|
| 245 | 245 | |
| 246 | - /** |
|
| 247 | - * @param string $uid the user id |
|
| 248 | - * @return \OC\Group\Group[] |
|
| 249 | - */ |
|
| 250 | - public function getUserIdGroups($uid) { |
|
| 251 | - if (isset($this->cachedUserGroups[$uid])) { |
|
| 252 | - return $this->cachedUserGroups[$uid]; |
|
| 253 | - } |
|
| 254 | - $groups = array(); |
|
| 255 | - foreach ($this->backends as $backend) { |
|
| 256 | - $groupIds = $backend->getUserGroups($uid); |
|
| 257 | - if (is_array($groupIds)) { |
|
| 258 | - foreach ($groupIds as $groupId) { |
|
| 259 | - $groups[$groupId] = $this->get($groupId); |
|
| 260 | - } |
|
| 261 | - } |
|
| 262 | - } |
|
| 263 | - $this->cachedUserGroups[$uid] = $groups; |
|
| 264 | - return $this->cachedUserGroups[$uid]; |
|
| 265 | - } |
|
| 246 | + /** |
|
| 247 | + * @param string $uid the user id |
|
| 248 | + * @return \OC\Group\Group[] |
|
| 249 | + */ |
|
| 250 | + public function getUserIdGroups($uid) { |
|
| 251 | + if (isset($this->cachedUserGroups[$uid])) { |
|
| 252 | + return $this->cachedUserGroups[$uid]; |
|
| 253 | + } |
|
| 254 | + $groups = array(); |
|
| 255 | + foreach ($this->backends as $backend) { |
|
| 256 | + $groupIds = $backend->getUserGroups($uid); |
|
| 257 | + if (is_array($groupIds)) { |
|
| 258 | + foreach ($groupIds as $groupId) { |
|
| 259 | + $groups[$groupId] = $this->get($groupId); |
|
| 260 | + } |
|
| 261 | + } |
|
| 262 | + } |
|
| 263 | + $this->cachedUserGroups[$uid] = $groups; |
|
| 264 | + return $this->cachedUserGroups[$uid]; |
|
| 265 | + } |
|
| 266 | 266 | |
| 267 | - /** |
|
| 268 | - * Checks if a userId is in the admin group |
|
| 269 | - * @param string $userId |
|
| 270 | - * @return bool if admin |
|
| 271 | - */ |
|
| 272 | - public function isAdmin($userId) { |
|
| 273 | - return $this->isInGroup($userId, 'admin'); |
|
| 274 | - } |
|
| 267 | + /** |
|
| 268 | + * Checks if a userId is in the admin group |
|
| 269 | + * @param string $userId |
|
| 270 | + * @return bool if admin |
|
| 271 | + */ |
|
| 272 | + public function isAdmin($userId) { |
|
| 273 | + return $this->isInGroup($userId, 'admin'); |
|
| 274 | + } |
|
| 275 | 275 | |
| 276 | - /** |
|
| 277 | - * Checks if a userId is in a group |
|
| 278 | - * @param string $userId |
|
| 279 | - * @param string $group |
|
| 280 | - * @return bool if in group |
|
| 281 | - */ |
|
| 282 | - public function isInGroup($userId, $group) { |
|
| 283 | - return array_key_exists($group, $this->getUserIdGroups($userId)); |
|
| 284 | - } |
|
| 276 | + /** |
|
| 277 | + * Checks if a userId is in a group |
|
| 278 | + * @param string $userId |
|
| 279 | + * @param string $group |
|
| 280 | + * @return bool if in group |
|
| 281 | + */ |
|
| 282 | + public function isInGroup($userId, $group) { |
|
| 283 | + return array_key_exists($group, $this->getUserIdGroups($userId)); |
|
| 284 | + } |
|
| 285 | 285 | |
| 286 | - /** |
|
| 287 | - * get a list of group ids for a user |
|
| 288 | - * @param \OC\User\User $user |
|
| 289 | - * @return array with group ids |
|
| 290 | - */ |
|
| 291 | - public function getUserGroupIds($user) { |
|
| 292 | - return array_map(function($value) { |
|
| 293 | - return (string) $value; |
|
| 294 | - }, array_keys($this->getUserGroups($user))); |
|
| 295 | - } |
|
| 286 | + /** |
|
| 287 | + * get a list of group ids for a user |
|
| 288 | + * @param \OC\User\User $user |
|
| 289 | + * @return array with group ids |
|
| 290 | + */ |
|
| 291 | + public function getUserGroupIds($user) { |
|
| 292 | + return array_map(function($value) { |
|
| 293 | + return (string) $value; |
|
| 294 | + }, array_keys($this->getUserGroups($user))); |
|
| 295 | + } |
|
| 296 | 296 | |
| 297 | - /** |
|
| 298 | - * get a list of all display names in a group |
|
| 299 | - * @param string $gid |
|
| 300 | - * @param string $search |
|
| 301 | - * @param int $limit |
|
| 302 | - * @param int $offset |
|
| 303 | - * @return array an array of display names (value) and user ids (key) |
|
| 304 | - */ |
|
| 305 | - public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
|
| 306 | - $group = $this->get($gid); |
|
| 307 | - if(is_null($group)) { |
|
| 308 | - return array(); |
|
| 309 | - } |
|
| 297 | + /** |
|
| 298 | + * get a list of all display names in a group |
|
| 299 | + * @param string $gid |
|
| 300 | + * @param string $search |
|
| 301 | + * @param int $limit |
|
| 302 | + * @param int $offset |
|
| 303 | + * @return array an array of display names (value) and user ids (key) |
|
| 304 | + */ |
|
| 305 | + public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
|
| 306 | + $group = $this->get($gid); |
|
| 307 | + if(is_null($group)) { |
|
| 308 | + return array(); |
|
| 309 | + } |
|
| 310 | 310 | |
| 311 | - $search = trim($search); |
|
| 312 | - $groupUsers = array(); |
|
| 311 | + $search = trim($search); |
|
| 312 | + $groupUsers = array(); |
|
| 313 | 313 | |
| 314 | - if(!empty($search)) { |
|
| 315 | - // only user backends have the capability to do a complex search for users |
|
| 316 | - $searchOffset = 0; |
|
| 317 | - $searchLimit = $limit * 100; |
|
| 318 | - if($limit === -1) { |
|
| 319 | - $searchLimit = 500; |
|
| 320 | - } |
|
| 314 | + if(!empty($search)) { |
|
| 315 | + // only user backends have the capability to do a complex search for users |
|
| 316 | + $searchOffset = 0; |
|
| 317 | + $searchLimit = $limit * 100; |
|
| 318 | + if($limit === -1) { |
|
| 319 | + $searchLimit = 500; |
|
| 320 | + } |
|
| 321 | 321 | |
| 322 | - do { |
|
| 323 | - $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset); |
|
| 324 | - foreach($filteredUsers as $filteredUser) { |
|
| 325 | - if($group->inGroup($filteredUser)) { |
|
| 326 | - $groupUsers[]= $filteredUser; |
|
| 327 | - } |
|
| 328 | - } |
|
| 329 | - $searchOffset += $searchLimit; |
|
| 330 | - } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit); |
|
| 322 | + do { |
|
| 323 | + $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset); |
|
| 324 | + foreach($filteredUsers as $filteredUser) { |
|
| 325 | + if($group->inGroup($filteredUser)) { |
|
| 326 | + $groupUsers[]= $filteredUser; |
|
| 327 | + } |
|
| 328 | + } |
|
| 329 | + $searchOffset += $searchLimit; |
|
| 330 | + } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit); |
|
| 331 | 331 | |
| 332 | - if($limit === -1) { |
|
| 333 | - $groupUsers = array_slice($groupUsers, $offset); |
|
| 334 | - } else { |
|
| 335 | - $groupUsers = array_slice($groupUsers, $offset, $limit); |
|
| 336 | - } |
|
| 337 | - } else { |
|
| 338 | - $groupUsers = $group->searchUsers('', $limit, $offset); |
|
| 339 | - } |
|
| 332 | + if($limit === -1) { |
|
| 333 | + $groupUsers = array_slice($groupUsers, $offset); |
|
| 334 | + } else { |
|
| 335 | + $groupUsers = array_slice($groupUsers, $offset, $limit); |
|
| 336 | + } |
|
| 337 | + } else { |
|
| 338 | + $groupUsers = $group->searchUsers('', $limit, $offset); |
|
| 339 | + } |
|
| 340 | 340 | |
| 341 | - $matchingUsers = array(); |
|
| 342 | - foreach($groupUsers as $groupUser) { |
|
| 343 | - $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName(); |
|
| 344 | - } |
|
| 345 | - return $matchingUsers; |
|
| 346 | - } |
|
| 341 | + $matchingUsers = array(); |
|
| 342 | + foreach($groupUsers as $groupUser) { |
|
| 343 | + $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName(); |
|
| 344 | + } |
|
| 345 | + return $matchingUsers; |
|
| 346 | + } |
|
| 347 | 347 | |
| 348 | - /** |
|
| 349 | - * @return \OC\SubAdmin |
|
| 350 | - */ |
|
| 351 | - public function getSubAdmin() { |
|
| 352 | - if (!$this->subAdmin) { |
|
| 353 | - $this->subAdmin = new \OC\SubAdmin( |
|
| 354 | - $this->userManager, |
|
| 355 | - $this, |
|
| 356 | - \OC::$server->getDatabaseConnection() |
|
| 357 | - ); |
|
| 358 | - } |
|
| 348 | + /** |
|
| 349 | + * @return \OC\SubAdmin |
|
| 350 | + */ |
|
| 351 | + public function getSubAdmin() { |
|
| 352 | + if (!$this->subAdmin) { |
|
| 353 | + $this->subAdmin = new \OC\SubAdmin( |
|
| 354 | + $this->userManager, |
|
| 355 | + $this, |
|
| 356 | + \OC::$server->getDatabaseConnection() |
|
| 357 | + ); |
|
| 358 | + } |
|
| 359 | 359 | |
| 360 | - return $this->subAdmin; |
|
| 361 | - } |
|
| 360 | + return $this->subAdmin; |
|
| 361 | + } |
|
| 362 | 362 | } |
@@ -85,20 +85,20 @@ discard block |
||
| 85 | 85 | $this->userManager = $userManager; |
| 86 | 86 | $cachedGroups = & $this->cachedGroups; |
| 87 | 87 | $cachedUserGroups = & $this->cachedUserGroups; |
| 88 | - $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
| 88 | + $this->listen('\OC\Group', 'postDelete', function($group) use (&$cachedGroups, &$cachedUserGroups) { |
|
| 89 | 89 | /** |
| 90 | 90 | * @var \OC\Group\Group $group |
| 91 | 91 | */ |
| 92 | 92 | unset($cachedGroups[$group->getGID()]); |
| 93 | 93 | $cachedUserGroups = array(); |
| 94 | 94 | }); |
| 95 | - $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) { |
|
| 95 | + $this->listen('\OC\Group', 'postAddUser', function($group) use (&$cachedUserGroups) { |
|
| 96 | 96 | /** |
| 97 | 97 | * @var \OC\Group\Group $group |
| 98 | 98 | */ |
| 99 | 99 | $cachedUserGroups = array(); |
| 100 | 100 | }); |
| 101 | - $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) { |
|
| 101 | + $this->listen('\OC\Group', 'postRemoveUser', function($group) use (&$cachedUserGroups) { |
|
| 102 | 102 | /** |
| 103 | 103 | * @var \OC\Group\Group $group |
| 104 | 104 | */ |
@@ -304,32 +304,32 @@ discard block |
||
| 304 | 304 | */ |
| 305 | 305 | public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
| 306 | 306 | $group = $this->get($gid); |
| 307 | - if(is_null($group)) { |
|
| 307 | + if (is_null($group)) { |
|
| 308 | 308 | return array(); |
| 309 | 309 | } |
| 310 | 310 | |
| 311 | 311 | $search = trim($search); |
| 312 | 312 | $groupUsers = array(); |
| 313 | 313 | |
| 314 | - if(!empty($search)) { |
|
| 314 | + if (!empty($search)) { |
|
| 315 | 315 | // only user backends have the capability to do a complex search for users |
| 316 | 316 | $searchOffset = 0; |
| 317 | 317 | $searchLimit = $limit * 100; |
| 318 | - if($limit === -1) { |
|
| 318 | + if ($limit === -1) { |
|
| 319 | 319 | $searchLimit = 500; |
| 320 | 320 | } |
| 321 | 321 | |
| 322 | 322 | do { |
| 323 | 323 | $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset); |
| 324 | - foreach($filteredUsers as $filteredUser) { |
|
| 325 | - if($group->inGroup($filteredUser)) { |
|
| 326 | - $groupUsers[]= $filteredUser; |
|
| 324 | + foreach ($filteredUsers as $filteredUser) { |
|
| 325 | + if ($group->inGroup($filteredUser)) { |
|
| 326 | + $groupUsers[] = $filteredUser; |
|
| 327 | 327 | } |
| 328 | 328 | } |
| 329 | 329 | $searchOffset += $searchLimit; |
| 330 | - } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit); |
|
| 330 | + } while (count($groupUsers) < $searchLimit + $offset && count($filteredUsers) >= $searchLimit); |
|
| 331 | 331 | |
| 332 | - if($limit === -1) { |
|
| 332 | + if ($limit === -1) { |
|
| 333 | 333 | $groupUsers = array_slice($groupUsers, $offset); |
| 334 | 334 | } else { |
| 335 | 335 | $groupUsers = array_slice($groupUsers, $offset, $limit); |
@@ -339,7 +339,7 @@ discard block |
||
| 339 | 339 | } |
| 340 | 340 | |
| 341 | 341 | $matchingUsers = array(); |
| 342 | - foreach($groupUsers as $groupUser) { |
|
| 342 | + foreach ($groupUsers as $groupUser) { |
|
| 343 | 343 | $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName(); |
| 344 | 344 | } |
| 345 | 345 | return $matchingUsers; |
@@ -183,7 +183,7 @@ discard block |
||
| 183 | 183 | * make preview_icon available as a simple function |
| 184 | 184 | * Returns the path to the preview of the image. |
| 185 | 185 | * @param string $path path of file |
| 186 | - * @return link to the preview |
|
| 186 | + * @return string to the preview |
|
| 187 | 187 | */ |
| 188 | 188 | function preview_icon( $path ) { |
| 189 | 189 | return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]); |
@@ -191,6 +191,7 @@ discard block |
||
| 191 | 191 | |
| 192 | 192 | /** |
| 193 | 193 | * @param string $path |
| 194 | + * @param string $token |
|
| 194 | 195 | */ |
| 195 | 196 | function publicPreview_icon ( $path, $token ) { |
| 196 | 197 | return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]); |
@@ -34,7 +34,7 @@ discard block |
||
| 34 | 34 | * @param string $string the string which will be escaped and printed |
| 35 | 35 | */ |
| 36 | 36 | function p($string) { |
| 37 | - print(\OCP\Util::sanitizeHTML($string)); |
|
| 37 | + print(\OCP\Util::sanitizeHTML($string)); |
|
| 38 | 38 | } |
| 39 | 39 | |
| 40 | 40 | /** |
@@ -43,7 +43,7 @@ discard block |
||
| 43 | 43 | * @param string|array $string the string which will be printed as it is |
| 44 | 44 | */ |
| 45 | 45 | function print_unescaped($string) { |
| 46 | - print($string); |
|
| 46 | + print($string); |
|
| 47 | 47 | } |
| 48 | 48 | |
| 49 | 49 | /** |
@@ -53,13 +53,13 @@ discard block |
||
| 53 | 53 | * if an array is given it will add all scripts |
| 54 | 54 | */ |
| 55 | 55 | function script($app, $file = null) { |
| 56 | - if(is_array($file)) { |
|
| 57 | - foreach($file as $f) { |
|
| 58 | - OC_Util::addScript($app, $f); |
|
| 59 | - } |
|
| 60 | - } else { |
|
| 61 | - OC_Util::addScript($app, $file); |
|
| 62 | - } |
|
| 56 | + if(is_array($file)) { |
|
| 57 | + foreach($file as $f) { |
|
| 58 | + OC_Util::addScript($app, $f); |
|
| 59 | + } |
|
| 60 | + } else { |
|
| 61 | + OC_Util::addScript($app, $file); |
|
| 62 | + } |
|
| 63 | 63 | } |
| 64 | 64 | |
| 65 | 65 | /** |
@@ -69,13 +69,13 @@ discard block |
||
| 69 | 69 | * if an array is given it will add all scripts |
| 70 | 70 | */ |
| 71 | 71 | function vendor_script($app, $file = null) { |
| 72 | - if(is_array($file)) { |
|
| 73 | - foreach($file as $f) { |
|
| 74 | - OC_Util::addVendorScript($app, $f); |
|
| 75 | - } |
|
| 76 | - } else { |
|
| 77 | - OC_Util::addVendorScript($app, $file); |
|
| 78 | - } |
|
| 72 | + if(is_array($file)) { |
|
| 73 | + foreach($file as $f) { |
|
| 74 | + OC_Util::addVendorScript($app, $f); |
|
| 75 | + } |
|
| 76 | + } else { |
|
| 77 | + OC_Util::addVendorScript($app, $file); |
|
| 78 | + } |
|
| 79 | 79 | } |
| 80 | 80 | |
| 81 | 81 | /** |
@@ -85,13 +85,13 @@ discard block |
||
| 85 | 85 | * if an array is given it will add all styles |
| 86 | 86 | */ |
| 87 | 87 | function style($app, $file = null) { |
| 88 | - if(is_array($file)) { |
|
| 89 | - foreach($file as $f) { |
|
| 90 | - OC_Util::addStyle($app, $f); |
|
| 91 | - } |
|
| 92 | - } else { |
|
| 93 | - OC_Util::addStyle($app, $file); |
|
| 94 | - } |
|
| 88 | + if(is_array($file)) { |
|
| 89 | + foreach($file as $f) { |
|
| 90 | + OC_Util::addStyle($app, $f); |
|
| 91 | + } |
|
| 92 | + } else { |
|
| 93 | + OC_Util::addStyle($app, $file); |
|
| 94 | + } |
|
| 95 | 95 | } |
| 96 | 96 | |
| 97 | 97 | /** |
@@ -101,13 +101,13 @@ discard block |
||
| 101 | 101 | * if an array is given it will add all styles |
| 102 | 102 | */ |
| 103 | 103 | function vendor_style($app, $file = null) { |
| 104 | - if(is_array($file)) { |
|
| 105 | - foreach($file as $f) { |
|
| 106 | - OC_Util::addVendorStyle($app, $f); |
|
| 107 | - } |
|
| 108 | - } else { |
|
| 109 | - OC_Util::addVendorStyle($app, $file); |
|
| 110 | - } |
|
| 104 | + if(is_array($file)) { |
|
| 105 | + foreach($file as $f) { |
|
| 106 | + OC_Util::addVendorStyle($app, $f); |
|
| 107 | + } |
|
| 108 | + } else { |
|
| 109 | + OC_Util::addVendorStyle($app, $file); |
|
| 110 | + } |
|
| 111 | 111 | } |
| 112 | 112 | |
| 113 | 113 | /** |
@@ -116,7 +116,7 @@ discard block |
||
| 116 | 116 | * if an array is given it will add all styles |
| 117 | 117 | */ |
| 118 | 118 | function translation($app) { |
| 119 | - OC_Util::addTranslations($app); |
|
| 119 | + OC_Util::addTranslations($app); |
|
| 120 | 120 | } |
| 121 | 121 | |
| 122 | 122 | /** |
@@ -126,15 +126,15 @@ discard block |
||
| 126 | 126 | * if an array is given it will add all components |
| 127 | 127 | */ |
| 128 | 128 | function component($app, $file) { |
| 129 | - if(is_array($file)) { |
|
| 130 | - foreach($file as $f) { |
|
| 131 | - $url = link_to($app, 'component/' . $f . '.html'); |
|
| 132 | - OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url)); |
|
| 133 | - } |
|
| 134 | - } else { |
|
| 135 | - $url = link_to($app, 'component/' . $file . '.html'); |
|
| 136 | - OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url)); |
|
| 137 | - } |
|
| 129 | + if(is_array($file)) { |
|
| 130 | + foreach($file as $f) { |
|
| 131 | + $url = link_to($app, 'component/' . $f . '.html'); |
|
| 132 | + OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url)); |
|
| 133 | + } |
|
| 134 | + } else { |
|
| 135 | + $url = link_to($app, 'component/' . $file . '.html'); |
|
| 136 | + OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url)); |
|
| 137 | + } |
|
| 138 | 138 | } |
| 139 | 139 | |
| 140 | 140 | /** |
@@ -147,7 +147,7 @@ discard block |
||
| 147 | 147 | * For further information have a look at \OCP\IURLGenerator::linkTo |
| 148 | 148 | */ |
| 149 | 149 | function link_to( $app, $file, $args = array() ) { |
| 150 | - return \OC::$server->getURLGenerator()->linkTo($app, $file, $args); |
|
| 150 | + return \OC::$server->getURLGenerator()->linkTo($app, $file, $args); |
|
| 151 | 151 | } |
| 152 | 152 | |
| 153 | 153 | /** |
@@ -155,7 +155,7 @@ discard block |
||
| 155 | 155 | * @return string url to the online documentation |
| 156 | 156 | */ |
| 157 | 157 | function link_to_docs($key) { |
| 158 | - return \OC::$server->getURLGenerator()->linkToDocs($key); |
|
| 158 | + return \OC::$server->getURLGenerator()->linkToDocs($key); |
|
| 159 | 159 | } |
| 160 | 160 | |
| 161 | 161 | /** |
@@ -167,7 +167,7 @@ discard block |
||
| 167 | 167 | * For further information have a look at \OCP\IURLGenerator::imagePath |
| 168 | 168 | */ |
| 169 | 169 | function image_path( $app, $image ) { |
| 170 | - return \OC::$server->getURLGenerator()->imagePath( $app, $image ); |
|
| 170 | + return \OC::$server->getURLGenerator()->imagePath( $app, $image ); |
|
| 171 | 171 | } |
| 172 | 172 | |
| 173 | 173 | /** |
@@ -176,7 +176,7 @@ discard block |
||
| 176 | 176 | * @return string link to the image |
| 177 | 177 | */ |
| 178 | 178 | function mimetype_icon( $mimetype ) { |
| 179 | - return \OC::$server->getMimeTypeDetector()->mimeTypeIcon( $mimetype ); |
|
| 179 | + return \OC::$server->getMimeTypeDetector()->mimeTypeIcon( $mimetype ); |
|
| 180 | 180 | } |
| 181 | 181 | |
| 182 | 182 | /** |
@@ -186,14 +186,14 @@ discard block |
||
| 186 | 186 | * @return link to the preview |
| 187 | 187 | */ |
| 188 | 188 | function preview_icon( $path ) { |
| 189 | - return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]); |
|
| 189 | + return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]); |
|
| 190 | 190 | } |
| 191 | 191 | |
| 192 | 192 | /** |
| 193 | 193 | * @param string $path |
| 194 | 194 | */ |
| 195 | 195 | function publicPreview_icon ( $path, $token ) { |
| 196 | - return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]); |
|
| 196 | + return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]); |
|
| 197 | 197 | } |
| 198 | 198 | |
| 199 | 199 | /** |
@@ -204,7 +204,7 @@ discard block |
||
| 204 | 204 | * For further information have a look at OC_Helper::humanFileSize |
| 205 | 205 | */ |
| 206 | 206 | function human_file_size( $bytes ) { |
| 207 | - return OC_Helper::humanFileSize( $bytes ); |
|
| 207 | + return OC_Helper::humanFileSize( $bytes ); |
|
| 208 | 208 | } |
| 209 | 209 | |
| 210 | 210 | /** |
@@ -213,9 +213,9 @@ discard block |
||
| 213 | 213 | * @return $timestamp without time value |
| 214 | 214 | */ |
| 215 | 215 | function strip_time($timestamp){ |
| 216 | - $date = new \DateTime("@{$timestamp}"); |
|
| 217 | - $date->setTime(0, 0, 0); |
|
| 218 | - return intval($date->format('U')); |
|
| 216 | + $date = new \DateTime("@{$timestamp}"); |
|
| 217 | + $date->setTime(0, 0, 0); |
|
| 218 | + return intval($date->format('U')); |
|
| 219 | 219 | } |
| 220 | 220 | |
| 221 | 221 | /** |
@@ -227,39 +227,39 @@ discard block |
||
| 227 | 227 | * @return string timestamp |
| 228 | 228 | */ |
| 229 | 229 | function relative_modified_date($timestamp, $fromTime = null, $dateOnly = false) { |
| 230 | - /** @var \OC\DateTimeFormatter $formatter */ |
|
| 231 | - $formatter = \OC::$server->query('DateTimeFormatter'); |
|
| 230 | + /** @var \OC\DateTimeFormatter $formatter */ |
|
| 231 | + $formatter = \OC::$server->query('DateTimeFormatter'); |
|
| 232 | 232 | |
| 233 | - if ($dateOnly){ |
|
| 234 | - return $formatter->formatDateSpan($timestamp, $fromTime); |
|
| 235 | - } |
|
| 236 | - return $formatter->formatTimeSpan($timestamp, $fromTime); |
|
| 233 | + if ($dateOnly){ |
|
| 234 | + return $formatter->formatDateSpan($timestamp, $fromTime); |
|
| 235 | + } |
|
| 236 | + return $formatter->formatTimeSpan($timestamp, $fromTime); |
|
| 237 | 237 | } |
| 238 | 238 | |
| 239 | 239 | function html_select_options($options, $selected, $params=array()) { |
| 240 | - if (!is_array($selected)) { |
|
| 241 | - $selected=array($selected); |
|
| 242 | - } |
|
| 243 | - if (isset($params['combine']) && $params['combine']) { |
|
| 244 | - $options = array_combine($options, $options); |
|
| 245 | - } |
|
| 246 | - $value_name = $label_name = false; |
|
| 247 | - if (isset($params['value'])) { |
|
| 248 | - $value_name = $params['value']; |
|
| 249 | - } |
|
| 250 | - if (isset($params['label'])) { |
|
| 251 | - $label_name = $params['label']; |
|
| 252 | - } |
|
| 253 | - $html = ''; |
|
| 254 | - foreach($options as $value => $label) { |
|
| 255 | - if ($value_name && is_array($label)) { |
|
| 256 | - $value = $label[$value_name]; |
|
| 257 | - } |
|
| 258 | - if ($label_name && is_array($label)) { |
|
| 259 | - $label = $label[$label_name]; |
|
| 260 | - } |
|
| 261 | - $select = in_array($value, $selected) ? ' selected="selected"' : ''; |
|
| 262 | - $html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n"; |
|
| 263 | - } |
|
| 264 | - return $html; |
|
| 240 | + if (!is_array($selected)) { |
|
| 241 | + $selected=array($selected); |
|
| 242 | + } |
|
| 243 | + if (isset($params['combine']) && $params['combine']) { |
|
| 244 | + $options = array_combine($options, $options); |
|
| 245 | + } |
|
| 246 | + $value_name = $label_name = false; |
|
| 247 | + if (isset($params['value'])) { |
|
| 248 | + $value_name = $params['value']; |
|
| 249 | + } |
|
| 250 | + if (isset($params['label'])) { |
|
| 251 | + $label_name = $params['label']; |
|
| 252 | + } |
|
| 253 | + $html = ''; |
|
| 254 | + foreach($options as $value => $label) { |
|
| 255 | + if ($value_name && is_array($label)) { |
|
| 256 | + $value = $label[$value_name]; |
|
| 257 | + } |
|
| 258 | + if ($label_name && is_array($label)) { |
|
| 259 | + $label = $label[$label_name]; |
|
| 260 | + } |
|
| 261 | + $select = in_array($value, $selected) ? ' selected="selected"' : ''; |
|
| 262 | + $html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n"; |
|
| 263 | + } |
|
| 264 | + return $html; |
|
| 265 | 265 | } |
@@ -53,8 +53,8 @@ discard block |
||
| 53 | 53 | * if an array is given it will add all scripts |
| 54 | 54 | */ |
| 55 | 55 | function script($app, $file = null) { |
| 56 | - if(is_array($file)) { |
|
| 57 | - foreach($file as $f) { |
|
| 56 | + if (is_array($file)) { |
|
| 57 | + foreach ($file as $f) { |
|
| 58 | 58 | OC_Util::addScript($app, $f); |
| 59 | 59 | } |
| 60 | 60 | } else { |
@@ -69,8 +69,8 @@ discard block |
||
| 69 | 69 | * if an array is given it will add all scripts |
| 70 | 70 | */ |
| 71 | 71 | function vendor_script($app, $file = null) { |
| 72 | - if(is_array($file)) { |
|
| 73 | - foreach($file as $f) { |
|
| 72 | + if (is_array($file)) { |
|
| 73 | + foreach ($file as $f) { |
|
| 74 | 74 | OC_Util::addVendorScript($app, $f); |
| 75 | 75 | } |
| 76 | 76 | } else { |
@@ -85,8 +85,8 @@ discard block |
||
| 85 | 85 | * if an array is given it will add all styles |
| 86 | 86 | */ |
| 87 | 87 | function style($app, $file = null) { |
| 88 | - if(is_array($file)) { |
|
| 89 | - foreach($file as $f) { |
|
| 88 | + if (is_array($file)) { |
|
| 89 | + foreach ($file as $f) { |
|
| 90 | 90 | OC_Util::addStyle($app, $f); |
| 91 | 91 | } |
| 92 | 92 | } else { |
@@ -101,8 +101,8 @@ discard block |
||
| 101 | 101 | * if an array is given it will add all styles |
| 102 | 102 | */ |
| 103 | 103 | function vendor_style($app, $file = null) { |
| 104 | - if(is_array($file)) { |
|
| 105 | - foreach($file as $f) { |
|
| 104 | + if (is_array($file)) { |
|
| 105 | + foreach ($file as $f) { |
|
| 106 | 106 | OC_Util::addVendorStyle($app, $f); |
| 107 | 107 | } |
| 108 | 108 | } else { |
@@ -126,13 +126,13 @@ discard block |
||
| 126 | 126 | * if an array is given it will add all components |
| 127 | 127 | */ |
| 128 | 128 | function component($app, $file) { |
| 129 | - if(is_array($file)) { |
|
| 130 | - foreach($file as $f) { |
|
| 131 | - $url = link_to($app, 'component/' . $f . '.html'); |
|
| 129 | + if (is_array($file)) { |
|
| 130 | + foreach ($file as $f) { |
|
| 131 | + $url = link_to($app, 'component/'.$f.'.html'); |
|
| 132 | 132 | OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url)); |
| 133 | 133 | } |
| 134 | 134 | } else { |
| 135 | - $url = link_to($app, 'component/' . $file . '.html'); |
|
| 135 | + $url = link_to($app, 'component/'.$file.'.html'); |
|
| 136 | 136 | OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url)); |
| 137 | 137 | } |
| 138 | 138 | } |
@@ -146,7 +146,7 @@ discard block |
||
| 146 | 146 | * |
| 147 | 147 | * For further information have a look at \OCP\IURLGenerator::linkTo |
| 148 | 148 | */ |
| 149 | -function link_to( $app, $file, $args = array() ) { |
|
| 149 | +function link_to($app, $file, $args = array()) { |
|
| 150 | 150 | return \OC::$server->getURLGenerator()->linkTo($app, $file, $args); |
| 151 | 151 | } |
| 152 | 152 | |
@@ -166,8 +166,8 @@ discard block |
||
| 166 | 166 | * |
| 167 | 167 | * For further information have a look at \OCP\IURLGenerator::imagePath |
| 168 | 168 | */ |
| 169 | -function image_path( $app, $image ) { |
|
| 170 | - return \OC::$server->getURLGenerator()->imagePath( $app, $image ); |
|
| 169 | +function image_path($app, $image) { |
|
| 170 | + return \OC::$server->getURLGenerator()->imagePath($app, $image); |
|
| 171 | 171 | } |
| 172 | 172 | |
| 173 | 173 | /** |
@@ -175,8 +175,8 @@ discard block |
||
| 175 | 175 | * @param string $mimetype mimetype |
| 176 | 176 | * @return string link to the image |
| 177 | 177 | */ |
| 178 | -function mimetype_icon( $mimetype ) { |
|
| 179 | - return \OC::$server->getMimeTypeDetector()->mimeTypeIcon( $mimetype ); |
|
| 178 | +function mimetype_icon($mimetype) { |
|
| 179 | + return \OC::$server->getMimeTypeDetector()->mimeTypeIcon($mimetype); |
|
| 180 | 180 | } |
| 181 | 181 | |
| 182 | 182 | /** |
@@ -185,14 +185,14 @@ discard block |
||
| 185 | 185 | * @param string $path path of file |
| 186 | 186 | * @return link to the preview |
| 187 | 187 | */ |
| 188 | -function preview_icon( $path ) { |
|
| 188 | +function preview_icon($path) { |
|
| 189 | 189 | return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]); |
| 190 | 190 | } |
| 191 | 191 | |
| 192 | 192 | /** |
| 193 | 193 | * @param string $path |
| 194 | 194 | */ |
| 195 | -function publicPreview_icon ( $path, $token ) { |
|
| 195 | +function publicPreview_icon($path, $token) { |
|
| 196 | 196 | return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]); |
| 197 | 197 | } |
| 198 | 198 | |
@@ -203,8 +203,8 @@ discard block |
||
| 203 | 203 | * |
| 204 | 204 | * For further information have a look at OC_Helper::humanFileSize |
| 205 | 205 | */ |
| 206 | -function human_file_size( $bytes ) { |
|
| 207 | - return OC_Helper::humanFileSize( $bytes ); |
|
| 206 | +function human_file_size($bytes) { |
|
| 207 | + return OC_Helper::humanFileSize($bytes); |
|
| 208 | 208 | } |
| 209 | 209 | |
| 210 | 210 | /** |
@@ -212,7 +212,7 @@ discard block |
||
| 212 | 212 | * @param int $timestamp UNIX timestamp to strip |
| 213 | 213 | * @return $timestamp without time value |
| 214 | 214 | */ |
| 215 | -function strip_time($timestamp){ |
|
| 215 | +function strip_time($timestamp) { |
|
| 216 | 216 | $date = new \DateTime("@{$timestamp}"); |
| 217 | 217 | $date->setTime(0, 0, 0); |
| 218 | 218 | return intval($date->format('U')); |
@@ -230,15 +230,15 @@ discard block |
||
| 230 | 230 | /** @var \OC\DateTimeFormatter $formatter */ |
| 231 | 231 | $formatter = \OC::$server->query('DateTimeFormatter'); |
| 232 | 232 | |
| 233 | - if ($dateOnly){ |
|
| 233 | + if ($dateOnly) { |
|
| 234 | 234 | return $formatter->formatDateSpan($timestamp, $fromTime); |
| 235 | 235 | } |
| 236 | 236 | return $formatter->formatTimeSpan($timestamp, $fromTime); |
| 237 | 237 | } |
| 238 | 238 | |
| 239 | -function html_select_options($options, $selected, $params=array()) { |
|
| 239 | +function html_select_options($options, $selected, $params = array()) { |
|
| 240 | 240 | if (!is_array($selected)) { |
| 241 | - $selected=array($selected); |
|
| 241 | + $selected = array($selected); |
|
| 242 | 242 | } |
| 243 | 243 | if (isset($params['combine']) && $params['combine']) { |
| 244 | 244 | $options = array_combine($options, $options); |
@@ -251,7 +251,7 @@ discard block |
||
| 251 | 251 | $label_name = $params['label']; |
| 252 | 252 | } |
| 253 | 253 | $html = ''; |
| 254 | - foreach($options as $value => $label) { |
|
| 254 | + foreach ($options as $value => $label) { |
|
| 255 | 255 | if ($value_name && is_array($label)) { |
| 256 | 256 | $value = $label[$value_name]; |
| 257 | 257 | } |
@@ -259,7 +259,7 @@ discard block |
||
| 259 | 259 | $label = $label[$label_name]; |
| 260 | 260 | } |
| 261 | 261 | $select = in_array($value, $selected) ? ' selected="selected"' : ''; |
| 262 | - $html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n"; |
|
| 262 | + $html .= '<option value="'.\OCP\Util::sanitizeHTML($value).'"'.$select.'>'.\OCP\Util::sanitizeHTML($label).'</option>'."\n"; |
|
| 263 | 263 | } |
| 264 | 264 | return $html; |
| 265 | 265 | } |
@@ -65,7 +65,7 @@ |
||
| 65 | 65 | * Set a value in the cache if it's not already stored |
| 66 | 66 | * |
| 67 | 67 | * @param string $key |
| 68 | - * @param mixed $value |
|
| 68 | + * @param integer $value |
|
| 69 | 69 | * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
| 70 | 70 | * @return bool |
| 71 | 71 | */ |
@@ -30,140 +30,140 @@ |
||
| 30 | 30 | use OCP\IMemcache; |
| 31 | 31 | |
| 32 | 32 | class APCu extends Cache implements IMemcache { |
| 33 | - use CASTrait { |
|
| 34 | - cas as casEmulated; |
|
| 35 | - } |
|
| 33 | + use CASTrait { |
|
| 34 | + cas as casEmulated; |
|
| 35 | + } |
|
| 36 | 36 | |
| 37 | - use CADTrait; |
|
| 37 | + use CADTrait; |
|
| 38 | 38 | |
| 39 | - public function get($key) { |
|
| 40 | - $result = apcu_fetch($this->getPrefix() . $key, $success); |
|
| 41 | - if (!$success) { |
|
| 42 | - return null; |
|
| 43 | - } |
|
| 44 | - return $result; |
|
| 45 | - } |
|
| 39 | + public function get($key) { |
|
| 40 | + $result = apcu_fetch($this->getPrefix() . $key, $success); |
|
| 41 | + if (!$success) { |
|
| 42 | + return null; |
|
| 43 | + } |
|
| 44 | + return $result; |
|
| 45 | + } |
|
| 46 | 46 | |
| 47 | - public function set($key, $value, $ttl = 0) { |
|
| 48 | - return apcu_store($this->getPrefix() . $key, $value, $ttl); |
|
| 49 | - } |
|
| 47 | + public function set($key, $value, $ttl = 0) { |
|
| 48 | + return apcu_store($this->getPrefix() . $key, $value, $ttl); |
|
| 49 | + } |
|
| 50 | 50 | |
| 51 | - public function hasKey($key) { |
|
| 52 | - return apcu_exists($this->getPrefix() . $key); |
|
| 53 | - } |
|
| 51 | + public function hasKey($key) { |
|
| 52 | + return apcu_exists($this->getPrefix() . $key); |
|
| 53 | + } |
|
| 54 | 54 | |
| 55 | - public function remove($key) { |
|
| 56 | - return apcu_delete($this->getPrefix() . $key); |
|
| 57 | - } |
|
| 55 | + public function remove($key) { |
|
| 56 | + return apcu_delete($this->getPrefix() . $key); |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - public function clear($prefix = '') { |
|
| 60 | - $ns = $this->getPrefix() . $prefix; |
|
| 61 | - $ns = preg_quote($ns, '/'); |
|
| 62 | - if(class_exists('\APCIterator')) { |
|
| 63 | - $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY); |
|
| 64 | - } else { |
|
| 65 | - $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY); |
|
| 66 | - } |
|
| 67 | - return apcu_delete($iter); |
|
| 68 | - } |
|
| 59 | + public function clear($prefix = '') { |
|
| 60 | + $ns = $this->getPrefix() . $prefix; |
|
| 61 | + $ns = preg_quote($ns, '/'); |
|
| 62 | + if(class_exists('\APCIterator')) { |
|
| 63 | + $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY); |
|
| 64 | + } else { |
|
| 65 | + $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY); |
|
| 66 | + } |
|
| 67 | + return apcu_delete($iter); |
|
| 68 | + } |
|
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * Set a value in the cache if it's not already stored |
|
| 72 | - * |
|
| 73 | - * @param string $key |
|
| 74 | - * @param mixed $value |
|
| 75 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
| 76 | - * @return bool |
|
| 77 | - */ |
|
| 78 | - public function add($key, $value, $ttl = 0) { |
|
| 79 | - return apcu_add($this->getPrefix() . $key, $value, $ttl); |
|
| 80 | - } |
|
| 70 | + /** |
|
| 71 | + * Set a value in the cache if it's not already stored |
|
| 72 | + * |
|
| 73 | + * @param string $key |
|
| 74 | + * @param mixed $value |
|
| 75 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
| 76 | + * @return bool |
|
| 77 | + */ |
|
| 78 | + public function add($key, $value, $ttl = 0) { |
|
| 79 | + return apcu_add($this->getPrefix() . $key, $value, $ttl); |
|
| 80 | + } |
|
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Increase a stored number |
|
| 84 | - * |
|
| 85 | - * @param string $key |
|
| 86 | - * @param int $step |
|
| 87 | - * @return int | bool |
|
| 88 | - */ |
|
| 89 | - public function inc($key, $step = 1) { |
|
| 90 | - $this->add($key, 0); |
|
| 91 | - /** |
|
| 92 | - * TODO - hack around a PHP 7 specific issue in APCu |
|
| 93 | - * |
|
| 94 | - * on PHP 7 the apcu_inc method on a non-existing object will increment |
|
| 95 | - * "0" and result in "1" as value - therefore we check for existence |
|
| 96 | - * first |
|
| 97 | - * |
|
| 98 | - * on PHP 5.6 this is not the case |
|
| 99 | - * |
|
| 100 | - * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
| 101 | - * for details |
|
| 102 | - */ |
|
| 103 | - return apcu_exists($this->getPrefix() . $key) |
|
| 104 | - ? apcu_inc($this->getPrefix() . $key, $step) |
|
| 105 | - : false; |
|
| 106 | - } |
|
| 82 | + /** |
|
| 83 | + * Increase a stored number |
|
| 84 | + * |
|
| 85 | + * @param string $key |
|
| 86 | + * @param int $step |
|
| 87 | + * @return int | bool |
|
| 88 | + */ |
|
| 89 | + public function inc($key, $step = 1) { |
|
| 90 | + $this->add($key, 0); |
|
| 91 | + /** |
|
| 92 | + * TODO - hack around a PHP 7 specific issue in APCu |
|
| 93 | + * |
|
| 94 | + * on PHP 7 the apcu_inc method on a non-existing object will increment |
|
| 95 | + * "0" and result in "1" as value - therefore we check for existence |
|
| 96 | + * first |
|
| 97 | + * |
|
| 98 | + * on PHP 5.6 this is not the case |
|
| 99 | + * |
|
| 100 | + * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
| 101 | + * for details |
|
| 102 | + */ |
|
| 103 | + return apcu_exists($this->getPrefix() . $key) |
|
| 104 | + ? apcu_inc($this->getPrefix() . $key, $step) |
|
| 105 | + : false; |
|
| 106 | + } |
|
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * Decrease a stored number |
|
| 110 | - * |
|
| 111 | - * @param string $key |
|
| 112 | - * @param int $step |
|
| 113 | - * @return int | bool |
|
| 114 | - */ |
|
| 115 | - public function dec($key, $step = 1) { |
|
| 116 | - /** |
|
| 117 | - * TODO - hack around a PHP 7 specific issue in APCu |
|
| 118 | - * |
|
| 119 | - * on PHP 7 the apcu_dec method on a non-existing object will decrement |
|
| 120 | - * "0" and result in "-1" as value - therefore we check for existence |
|
| 121 | - * first |
|
| 122 | - * |
|
| 123 | - * on PHP 5.6 this is not the case |
|
| 124 | - * |
|
| 125 | - * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
| 126 | - * for details |
|
| 127 | - */ |
|
| 128 | - return apcu_exists($this->getPrefix() . $key) |
|
| 129 | - ? apcu_dec($this->getPrefix() . $key, $step) |
|
| 130 | - : false; |
|
| 131 | - } |
|
| 108 | + /** |
|
| 109 | + * Decrease a stored number |
|
| 110 | + * |
|
| 111 | + * @param string $key |
|
| 112 | + * @param int $step |
|
| 113 | + * @return int | bool |
|
| 114 | + */ |
|
| 115 | + public function dec($key, $step = 1) { |
|
| 116 | + /** |
|
| 117 | + * TODO - hack around a PHP 7 specific issue in APCu |
|
| 118 | + * |
|
| 119 | + * on PHP 7 the apcu_dec method on a non-existing object will decrement |
|
| 120 | + * "0" and result in "-1" as value - therefore we check for existence |
|
| 121 | + * first |
|
| 122 | + * |
|
| 123 | + * on PHP 5.6 this is not the case |
|
| 124 | + * |
|
| 125 | + * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
|
| 126 | + * for details |
|
| 127 | + */ |
|
| 128 | + return apcu_exists($this->getPrefix() . $key) |
|
| 129 | + ? apcu_dec($this->getPrefix() . $key, $step) |
|
| 130 | + : false; |
|
| 131 | + } |
|
| 132 | 132 | |
| 133 | - /** |
|
| 134 | - * Compare and set |
|
| 135 | - * |
|
| 136 | - * @param string $key |
|
| 137 | - * @param mixed $old |
|
| 138 | - * @param mixed $new |
|
| 139 | - * @return bool |
|
| 140 | - */ |
|
| 141 | - public function cas($key, $old, $new) { |
|
| 142 | - // apc only does cas for ints |
|
| 143 | - if (is_int($old) and is_int($new)) { |
|
| 144 | - return apcu_cas($this->getPrefix() . $key, $old, $new); |
|
| 145 | - } else { |
|
| 146 | - return $this->casEmulated($key, $old, $new); |
|
| 147 | - } |
|
| 148 | - } |
|
| 133 | + /** |
|
| 134 | + * Compare and set |
|
| 135 | + * |
|
| 136 | + * @param string $key |
|
| 137 | + * @param mixed $old |
|
| 138 | + * @param mixed $new |
|
| 139 | + * @return bool |
|
| 140 | + */ |
|
| 141 | + public function cas($key, $old, $new) { |
|
| 142 | + // apc only does cas for ints |
|
| 143 | + if (is_int($old) and is_int($new)) { |
|
| 144 | + return apcu_cas($this->getPrefix() . $key, $old, $new); |
|
| 145 | + } else { |
|
| 146 | + return $this->casEmulated($key, $old, $new); |
|
| 147 | + } |
|
| 148 | + } |
|
| 149 | 149 | |
| 150 | - /** |
|
| 151 | - * @return bool |
|
| 152 | - */ |
|
| 153 | - static public function isAvailable() { |
|
| 154 | - if (!extension_loaded('apcu')) { |
|
| 155 | - return false; |
|
| 156 | - } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) { |
|
| 157 | - return false; |
|
| 158 | - } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) { |
|
| 159 | - return false; |
|
| 160 | - } elseif ( |
|
| 161 | - version_compare(phpversion('apc'), '4.0.6') === -1 && |
|
| 162 | - version_compare(phpversion('apcu'), '5.1.0') === -1 |
|
| 163 | - ) { |
|
| 164 | - return false; |
|
| 165 | - } else { |
|
| 166 | - return true; |
|
| 167 | - } |
|
| 168 | - } |
|
| 150 | + /** |
|
| 151 | + * @return bool |
|
| 152 | + */ |
|
| 153 | + static public function isAvailable() { |
|
| 154 | + if (!extension_loaded('apcu')) { |
|
| 155 | + return false; |
|
| 156 | + } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) { |
|
| 157 | + return false; |
|
| 158 | + } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) { |
|
| 159 | + return false; |
|
| 160 | + } elseif ( |
|
| 161 | + version_compare(phpversion('apc'), '4.0.6') === -1 && |
|
| 162 | + version_compare(phpversion('apcu'), '5.1.0') === -1 |
|
| 163 | + ) { |
|
| 164 | + return false; |
|
| 165 | + } else { |
|
| 166 | + return true; |
|
| 167 | + } |
|
| 168 | + } |
|
| 169 | 169 | } |
@@ -37,7 +37,7 @@ discard block |
||
| 37 | 37 | use CADTrait; |
| 38 | 38 | |
| 39 | 39 | public function get($key) { |
| 40 | - $result = apcu_fetch($this->getPrefix() . $key, $success); |
|
| 40 | + $result = apcu_fetch($this->getPrefix().$key, $success); |
|
| 41 | 41 | if (!$success) { |
| 42 | 42 | return null; |
| 43 | 43 | } |
@@ -45,24 +45,24 @@ discard block |
||
| 45 | 45 | } |
| 46 | 46 | |
| 47 | 47 | public function set($key, $value, $ttl = 0) { |
| 48 | - return apcu_store($this->getPrefix() . $key, $value, $ttl); |
|
| 48 | + return apcu_store($this->getPrefix().$key, $value, $ttl); |
|
| 49 | 49 | } |
| 50 | 50 | |
| 51 | 51 | public function hasKey($key) { |
| 52 | - return apcu_exists($this->getPrefix() . $key); |
|
| 52 | + return apcu_exists($this->getPrefix().$key); |
|
| 53 | 53 | } |
| 54 | 54 | |
| 55 | 55 | public function remove($key) { |
| 56 | - return apcu_delete($this->getPrefix() . $key); |
|
| 56 | + return apcu_delete($this->getPrefix().$key); |
|
| 57 | 57 | } |
| 58 | 58 | |
| 59 | 59 | public function clear($prefix = '') { |
| 60 | - $ns = $this->getPrefix() . $prefix; |
|
| 60 | + $ns = $this->getPrefix().$prefix; |
|
| 61 | 61 | $ns = preg_quote($ns, '/'); |
| 62 | - if(class_exists('\APCIterator')) { |
|
| 63 | - $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY); |
|
| 62 | + if (class_exists('\APCIterator')) { |
|
| 63 | + $iter = new \APCIterator('user', '/^'.$ns.'/', APC_ITER_KEY); |
|
| 64 | 64 | } else { |
| 65 | - $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY); |
|
| 65 | + $iter = new \APCUIterator('/^'.$ns.'/', APC_ITER_KEY); |
|
| 66 | 66 | } |
| 67 | 67 | return apcu_delete($iter); |
| 68 | 68 | } |
@@ -76,7 +76,7 @@ discard block |
||
| 76 | 76 | * @return bool |
| 77 | 77 | */ |
| 78 | 78 | public function add($key, $value, $ttl = 0) { |
| 79 | - return apcu_add($this->getPrefix() . $key, $value, $ttl); |
|
| 79 | + return apcu_add($this->getPrefix().$key, $value, $ttl); |
|
| 80 | 80 | } |
| 81 | 81 | |
| 82 | 82 | /** |
@@ -100,8 +100,8 @@ discard block |
||
| 100 | 100 | * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
| 101 | 101 | * for details |
| 102 | 102 | */ |
| 103 | - return apcu_exists($this->getPrefix() . $key) |
|
| 104 | - ? apcu_inc($this->getPrefix() . $key, $step) |
|
| 103 | + return apcu_exists($this->getPrefix().$key) |
|
| 104 | + ? apcu_inc($this->getPrefix().$key, $step) |
|
| 105 | 105 | : false; |
| 106 | 106 | } |
| 107 | 107 | |
@@ -125,8 +125,8 @@ discard block |
||
| 125 | 125 | * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221 |
| 126 | 126 | * for details |
| 127 | 127 | */ |
| 128 | - return apcu_exists($this->getPrefix() . $key) |
|
| 129 | - ? apcu_dec($this->getPrefix() . $key, $step) |
|
| 128 | + return apcu_exists($this->getPrefix().$key) |
|
| 129 | + ? apcu_dec($this->getPrefix().$key, $step) |
|
| 130 | 130 | : false; |
| 131 | 131 | } |
| 132 | 132 | |
@@ -141,7 +141,7 @@ discard block |
||
| 141 | 141 | public function cas($key, $old, $new) { |
| 142 | 142 | // apc only does cas for ints |
| 143 | 143 | if (is_int($old) and is_int($new)) { |
| 144 | - return apcu_cas($this->getPrefix() . $key, $old, $new); |
|
| 144 | + return apcu_cas($this->getPrefix().$key, $old, $new); |
|
| 145 | 145 | } else { |
| 146 | 146 | return $this->casEmulated($key, $old, $new); |
| 147 | 147 | } |
@@ -65,7 +65,7 @@ |
||
| 65 | 65 | * Set a value in the cache if it's not already stored |
| 66 | 66 | * |
| 67 | 67 | * @param string $key |
| 68 | - * @param mixed $value |
|
| 68 | + * @param integer $value |
|
| 69 | 69 | * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
| 70 | 70 | * @return bool |
| 71 | 71 | */ |
@@ -27,133 +27,133 @@ |
||
| 27 | 27 | use OCP\IMemcache; |
| 28 | 28 | |
| 29 | 29 | class ArrayCache extends Cache implements IMemcache { |
| 30 | - /** @var array Array with the cached data */ |
|
| 31 | - protected $cachedData = array(); |
|
| 30 | + /** @var array Array with the cached data */ |
|
| 31 | + protected $cachedData = array(); |
|
| 32 | 32 | |
| 33 | - use CADTrait; |
|
| 33 | + use CADTrait; |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * {@inheritDoc} |
|
| 37 | - */ |
|
| 38 | - public function get($key) { |
|
| 39 | - if ($this->hasKey($key)) { |
|
| 40 | - return $this->cachedData[$key]; |
|
| 41 | - } |
|
| 42 | - return null; |
|
| 43 | - } |
|
| 35 | + /** |
|
| 36 | + * {@inheritDoc} |
|
| 37 | + */ |
|
| 38 | + public function get($key) { |
|
| 39 | + if ($this->hasKey($key)) { |
|
| 40 | + return $this->cachedData[$key]; |
|
| 41 | + } |
|
| 42 | + return null; |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * {@inheritDoc} |
|
| 47 | - */ |
|
| 48 | - public function set($key, $value, $ttl = 0) { |
|
| 49 | - $this->cachedData[$key] = $value; |
|
| 50 | - return true; |
|
| 51 | - } |
|
| 45 | + /** |
|
| 46 | + * {@inheritDoc} |
|
| 47 | + */ |
|
| 48 | + public function set($key, $value, $ttl = 0) { |
|
| 49 | + $this->cachedData[$key] = $value; |
|
| 50 | + return true; |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * {@inheritDoc} |
|
| 55 | - */ |
|
| 56 | - public function hasKey($key) { |
|
| 57 | - return isset($this->cachedData[$key]); |
|
| 58 | - } |
|
| 53 | + /** |
|
| 54 | + * {@inheritDoc} |
|
| 55 | + */ |
|
| 56 | + public function hasKey($key) { |
|
| 57 | + return isset($this->cachedData[$key]); |
|
| 58 | + } |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * {@inheritDoc} |
|
| 62 | - */ |
|
| 63 | - public function remove($key) { |
|
| 64 | - unset($this->cachedData[$key]); |
|
| 65 | - return true; |
|
| 66 | - } |
|
| 60 | + /** |
|
| 61 | + * {@inheritDoc} |
|
| 62 | + */ |
|
| 63 | + public function remove($key) { |
|
| 64 | + unset($this->cachedData[$key]); |
|
| 65 | + return true; |
|
| 66 | + } |
|
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * {@inheritDoc} |
|
| 70 | - */ |
|
| 71 | - public function clear($prefix = '') { |
|
| 72 | - if ($prefix === '') { |
|
| 73 | - $this->cachedData = []; |
|
| 74 | - return true; |
|
| 75 | - } |
|
| 68 | + /** |
|
| 69 | + * {@inheritDoc} |
|
| 70 | + */ |
|
| 71 | + public function clear($prefix = '') { |
|
| 72 | + if ($prefix === '') { |
|
| 73 | + $this->cachedData = []; |
|
| 74 | + return true; |
|
| 75 | + } |
|
| 76 | 76 | |
| 77 | - foreach ($this->cachedData as $key => $value) { |
|
| 78 | - if (strpos($key, $prefix) === 0) { |
|
| 79 | - $this->remove($key); |
|
| 80 | - } |
|
| 81 | - } |
|
| 82 | - return true; |
|
| 83 | - } |
|
| 77 | + foreach ($this->cachedData as $key => $value) { |
|
| 78 | + if (strpos($key, $prefix) === 0) { |
|
| 79 | + $this->remove($key); |
|
| 80 | + } |
|
| 81 | + } |
|
| 82 | + return true; |
|
| 83 | + } |
|
| 84 | 84 | |
| 85 | - /** |
|
| 86 | - * Set a value in the cache if it's not already stored |
|
| 87 | - * |
|
| 88 | - * @param string $key |
|
| 89 | - * @param mixed $value |
|
| 90 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
| 91 | - * @return bool |
|
| 92 | - */ |
|
| 93 | - public function add($key, $value, $ttl = 0) { |
|
| 94 | - // since this cache is not shared race conditions aren't an issue |
|
| 95 | - if ($this->hasKey($key)) { |
|
| 96 | - return false; |
|
| 97 | - } else { |
|
| 98 | - return $this->set($key, $value, $ttl); |
|
| 99 | - } |
|
| 100 | - } |
|
| 85 | + /** |
|
| 86 | + * Set a value in the cache if it's not already stored |
|
| 87 | + * |
|
| 88 | + * @param string $key |
|
| 89 | + * @param mixed $value |
|
| 90 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
| 91 | + * @return bool |
|
| 92 | + */ |
|
| 93 | + public function add($key, $value, $ttl = 0) { |
|
| 94 | + // since this cache is not shared race conditions aren't an issue |
|
| 95 | + if ($this->hasKey($key)) { |
|
| 96 | + return false; |
|
| 97 | + } else { |
|
| 98 | + return $this->set($key, $value, $ttl); |
|
| 99 | + } |
|
| 100 | + } |
|
| 101 | 101 | |
| 102 | - /** |
|
| 103 | - * Increase a stored number |
|
| 104 | - * |
|
| 105 | - * @param string $key |
|
| 106 | - * @param int $step |
|
| 107 | - * @return int | bool |
|
| 108 | - */ |
|
| 109 | - public function inc($key, $step = 1) { |
|
| 110 | - $oldValue = $this->get($key); |
|
| 111 | - if (is_int($oldValue)) { |
|
| 112 | - $this->set($key, $oldValue + $step); |
|
| 113 | - return $oldValue + $step; |
|
| 114 | - } else { |
|
| 115 | - $success = $this->add($key, $step); |
|
| 116 | - return ($success) ? $step : false; |
|
| 117 | - } |
|
| 118 | - } |
|
| 102 | + /** |
|
| 103 | + * Increase a stored number |
|
| 104 | + * |
|
| 105 | + * @param string $key |
|
| 106 | + * @param int $step |
|
| 107 | + * @return int | bool |
|
| 108 | + */ |
|
| 109 | + public function inc($key, $step = 1) { |
|
| 110 | + $oldValue = $this->get($key); |
|
| 111 | + if (is_int($oldValue)) { |
|
| 112 | + $this->set($key, $oldValue + $step); |
|
| 113 | + return $oldValue + $step; |
|
| 114 | + } else { |
|
| 115 | + $success = $this->add($key, $step); |
|
| 116 | + return ($success) ? $step : false; |
|
| 117 | + } |
|
| 118 | + } |
|
| 119 | 119 | |
| 120 | - /** |
|
| 121 | - * Decrease a stored number |
|
| 122 | - * |
|
| 123 | - * @param string $key |
|
| 124 | - * @param int $step |
|
| 125 | - * @return int | bool |
|
| 126 | - */ |
|
| 127 | - public function dec($key, $step = 1) { |
|
| 128 | - $oldValue = $this->get($key); |
|
| 129 | - if (is_int($oldValue)) { |
|
| 130 | - $this->set($key, $oldValue - $step); |
|
| 131 | - return $oldValue - $step; |
|
| 132 | - } else { |
|
| 133 | - return false; |
|
| 134 | - } |
|
| 135 | - } |
|
| 120 | + /** |
|
| 121 | + * Decrease a stored number |
|
| 122 | + * |
|
| 123 | + * @param string $key |
|
| 124 | + * @param int $step |
|
| 125 | + * @return int | bool |
|
| 126 | + */ |
|
| 127 | + public function dec($key, $step = 1) { |
|
| 128 | + $oldValue = $this->get($key); |
|
| 129 | + if (is_int($oldValue)) { |
|
| 130 | + $this->set($key, $oldValue - $step); |
|
| 131 | + return $oldValue - $step; |
|
| 132 | + } else { |
|
| 133 | + return false; |
|
| 134 | + } |
|
| 135 | + } |
|
| 136 | 136 | |
| 137 | - /** |
|
| 138 | - * Compare and set |
|
| 139 | - * |
|
| 140 | - * @param string $key |
|
| 141 | - * @param mixed $old |
|
| 142 | - * @param mixed $new |
|
| 143 | - * @return bool |
|
| 144 | - */ |
|
| 145 | - public function cas($key, $old, $new) { |
|
| 146 | - if ($this->get($key) === $old) { |
|
| 147 | - return $this->set($key, $new); |
|
| 148 | - } else { |
|
| 149 | - return false; |
|
| 150 | - } |
|
| 151 | - } |
|
| 137 | + /** |
|
| 138 | + * Compare and set |
|
| 139 | + * |
|
| 140 | + * @param string $key |
|
| 141 | + * @param mixed $old |
|
| 142 | + * @param mixed $new |
|
| 143 | + * @return bool |
|
| 144 | + */ |
|
| 145 | + public function cas($key, $old, $new) { |
|
| 146 | + if ($this->get($key) === $old) { |
|
| 147 | + return $this->set($key, $new); |
|
| 148 | + } else { |
|
| 149 | + return false; |
|
| 150 | + } |
|
| 151 | + } |
|
| 152 | 152 | |
| 153 | - /** |
|
| 154 | - * {@inheritDoc} |
|
| 155 | - */ |
|
| 156 | - static public function isAvailable() { |
|
| 157 | - return true; |
|
| 158 | - } |
|
| 153 | + /** |
|
| 154 | + * {@inheritDoc} |
|
| 155 | + */ |
|
| 156 | + static public function isAvailable() { |
|
| 157 | + return true; |
|
| 158 | + } |
|
| 159 | 159 | } |
@@ -311,7 +311,7 @@ discard block |
||
| 311 | 311 | * @param OC\Security\Bruteforce\Throttler $throttler |
| 312 | 312 | * @throws LoginException |
| 313 | 313 | * @throws PasswordLoginForbiddenException |
| 314 | - * @return boolean |
|
| 314 | + * @return boolean|null |
|
| 315 | 315 | */ |
| 316 | 316 | public function logClientIn($user, |
| 317 | 317 | $password, |
@@ -361,6 +361,9 @@ discard block |
||
| 361 | 361 | return $this->config->getSystemValue('token_auth_enforced', false); |
| 362 | 362 | } |
| 363 | 363 | |
| 364 | + /** |
|
| 365 | + * @param string $username |
|
| 366 | + */ |
|
| 364 | 367 | protected function isTwoFactorEnforced($username) { |
| 365 | 368 | Util::emitHook( |
| 366 | 369 | '\OCA\Files_Sharing\API\Server2Server', |
@@ -75,788 +75,788 @@ |
||
| 75 | 75 | */ |
| 76 | 76 | class Session implements IUserSession, Emitter { |
| 77 | 77 | |
| 78 | - /** @var IUserManager $manager */ |
|
| 79 | - private $manager; |
|
| 80 | - |
|
| 81 | - /** @var ISession $session */ |
|
| 82 | - private $session; |
|
| 83 | - |
|
| 84 | - /** @var ITimeFactory */ |
|
| 85 | - private $timeFacory; |
|
| 86 | - |
|
| 87 | - /** @var IProvider */ |
|
| 88 | - private $tokenProvider; |
|
| 89 | - |
|
| 90 | - /** @var IConfig */ |
|
| 91 | - private $config; |
|
| 92 | - |
|
| 93 | - /** @var User $activeUser */ |
|
| 94 | - protected $activeUser; |
|
| 95 | - |
|
| 96 | - /** @var ISecureRandom */ |
|
| 97 | - private $random; |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * @param IUserManager $manager |
|
| 101 | - * @param ISession $session |
|
| 102 | - * @param ITimeFactory $timeFacory |
|
| 103 | - * @param IProvider $tokenProvider |
|
| 104 | - * @param IConfig $config |
|
| 105 | - * @param ISecureRandom $random |
|
| 106 | - */ |
|
| 107 | - public function __construct(IUserManager $manager, |
|
| 108 | - ISession $session, |
|
| 109 | - ITimeFactory $timeFacory, |
|
| 110 | - $tokenProvider, |
|
| 111 | - IConfig $config, |
|
| 112 | - ISecureRandom $random) { |
|
| 113 | - $this->manager = $manager; |
|
| 114 | - $this->session = $session; |
|
| 115 | - $this->timeFacory = $timeFacory; |
|
| 116 | - $this->tokenProvider = $tokenProvider; |
|
| 117 | - $this->config = $config; |
|
| 118 | - $this->random = $random; |
|
| 119 | - } |
|
| 120 | - |
|
| 121 | - /** |
|
| 122 | - * @param IProvider $provider |
|
| 123 | - */ |
|
| 124 | - public function setTokenProvider(IProvider $provider) { |
|
| 125 | - $this->tokenProvider = $provider; |
|
| 126 | - } |
|
| 127 | - |
|
| 128 | - /** |
|
| 129 | - * @param string $scope |
|
| 130 | - * @param string $method |
|
| 131 | - * @param callable $callback |
|
| 132 | - */ |
|
| 133 | - public function listen($scope, $method, callable $callback) { |
|
| 134 | - $this->manager->listen($scope, $method, $callback); |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - /** |
|
| 138 | - * @param string $scope optional |
|
| 139 | - * @param string $method optional |
|
| 140 | - * @param callable $callback optional |
|
| 141 | - */ |
|
| 142 | - public function removeListener($scope = null, $method = null, callable $callback = null) { |
|
| 143 | - $this->manager->removeListener($scope, $method, $callback); |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - /** |
|
| 147 | - * get the manager object |
|
| 148 | - * |
|
| 149 | - * @return Manager |
|
| 150 | - */ |
|
| 151 | - public function getManager() { |
|
| 152 | - return $this->manager; |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - /** |
|
| 156 | - * get the session object |
|
| 157 | - * |
|
| 158 | - * @return ISession |
|
| 159 | - */ |
|
| 160 | - public function getSession() { |
|
| 161 | - return $this->session; |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * set the session object |
|
| 166 | - * |
|
| 167 | - * @param ISession $session |
|
| 168 | - */ |
|
| 169 | - public function setSession(ISession $session) { |
|
| 170 | - if ($this->session instanceof ISession) { |
|
| 171 | - $this->session->close(); |
|
| 172 | - } |
|
| 173 | - $this->session = $session; |
|
| 174 | - $this->activeUser = null; |
|
| 175 | - } |
|
| 176 | - |
|
| 177 | - /** |
|
| 178 | - * set the currently active user |
|
| 179 | - * |
|
| 180 | - * @param IUser|null $user |
|
| 181 | - */ |
|
| 182 | - public function setUser($user) { |
|
| 183 | - if (is_null($user)) { |
|
| 184 | - $this->session->remove('user_id'); |
|
| 185 | - } else { |
|
| 186 | - $this->session->set('user_id', $user->getUID()); |
|
| 187 | - } |
|
| 188 | - $this->activeUser = $user; |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - /** |
|
| 192 | - * get the current active user |
|
| 193 | - * |
|
| 194 | - * @return IUser|null Current user, otherwise null |
|
| 195 | - */ |
|
| 196 | - public function getUser() { |
|
| 197 | - // FIXME: This is a quick'n dirty work-around for the incognito mode as |
|
| 198 | - // described at https://github.com/owncloud/core/pull/12912#issuecomment-67391155 |
|
| 199 | - if (OC_User::isIncognitoMode()) { |
|
| 200 | - return null; |
|
| 201 | - } |
|
| 202 | - if (is_null($this->activeUser)) { |
|
| 203 | - $uid = $this->session->get('user_id'); |
|
| 204 | - if (is_null($uid)) { |
|
| 205 | - return null; |
|
| 206 | - } |
|
| 207 | - $this->activeUser = $this->manager->get($uid); |
|
| 208 | - if (is_null($this->activeUser)) { |
|
| 209 | - return null; |
|
| 210 | - } |
|
| 211 | - $this->validateSession(); |
|
| 212 | - } |
|
| 213 | - return $this->activeUser; |
|
| 214 | - } |
|
| 215 | - |
|
| 216 | - /** |
|
| 217 | - * Validate whether the current session is valid |
|
| 218 | - * |
|
| 219 | - * - For token-authenticated clients, the token validity is checked |
|
| 220 | - * - For browsers, the session token validity is checked |
|
| 221 | - */ |
|
| 222 | - protected function validateSession() { |
|
| 223 | - $token = null; |
|
| 224 | - $appPassword = $this->session->get('app_password'); |
|
| 225 | - |
|
| 226 | - if (is_null($appPassword)) { |
|
| 227 | - try { |
|
| 228 | - $token = $this->session->getId(); |
|
| 229 | - } catch (SessionNotAvailableException $ex) { |
|
| 230 | - return; |
|
| 231 | - } |
|
| 232 | - } else { |
|
| 233 | - $token = $appPassword; |
|
| 234 | - } |
|
| 235 | - |
|
| 236 | - if (!$this->validateToken($token)) { |
|
| 237 | - // Session was invalidated |
|
| 238 | - $this->logout(); |
|
| 239 | - } |
|
| 240 | - } |
|
| 241 | - |
|
| 242 | - /** |
|
| 243 | - * Checks whether the user is logged in |
|
| 244 | - * |
|
| 245 | - * @return bool if logged in |
|
| 246 | - */ |
|
| 247 | - public function isLoggedIn() { |
|
| 248 | - $user = $this->getUser(); |
|
| 249 | - if (is_null($user)) { |
|
| 250 | - return false; |
|
| 251 | - } |
|
| 252 | - |
|
| 253 | - return $user->isEnabled(); |
|
| 254 | - } |
|
| 255 | - |
|
| 256 | - /** |
|
| 257 | - * set the login name |
|
| 258 | - * |
|
| 259 | - * @param string|null $loginName for the logged in user |
|
| 260 | - */ |
|
| 261 | - public function setLoginName($loginName) { |
|
| 262 | - if (is_null($loginName)) { |
|
| 263 | - $this->session->remove('loginname'); |
|
| 264 | - } else { |
|
| 265 | - $this->session->set('loginname', $loginName); |
|
| 266 | - } |
|
| 267 | - } |
|
| 268 | - |
|
| 269 | - /** |
|
| 270 | - * get the login name of the current user |
|
| 271 | - * |
|
| 272 | - * @return string |
|
| 273 | - */ |
|
| 274 | - public function getLoginName() { |
|
| 275 | - if ($this->activeUser) { |
|
| 276 | - return $this->session->get('loginname'); |
|
| 277 | - } else { |
|
| 278 | - $uid = $this->session->get('user_id'); |
|
| 279 | - if ($uid) { |
|
| 280 | - $this->activeUser = $this->manager->get($uid); |
|
| 281 | - return $this->session->get('loginname'); |
|
| 282 | - } else { |
|
| 283 | - return null; |
|
| 284 | - } |
|
| 285 | - } |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * set the token id |
|
| 290 | - * |
|
| 291 | - * @param int|null $token that was used to log in |
|
| 292 | - */ |
|
| 293 | - protected function setToken($token) { |
|
| 294 | - if ($token === null) { |
|
| 295 | - $this->session->remove('token-id'); |
|
| 296 | - } else { |
|
| 297 | - $this->session->set('token-id', $token); |
|
| 298 | - } |
|
| 299 | - } |
|
| 300 | - |
|
| 301 | - /** |
|
| 302 | - * try to log in with the provided credentials |
|
| 303 | - * |
|
| 304 | - * @param string $uid |
|
| 305 | - * @param string $password |
|
| 306 | - * @return boolean|null |
|
| 307 | - * @throws LoginException |
|
| 308 | - */ |
|
| 309 | - public function login($uid, $password) { |
|
| 310 | - $this->session->regenerateId(); |
|
| 311 | - if ($this->validateToken($password, $uid)) { |
|
| 312 | - return $this->loginWithToken($password); |
|
| 313 | - } |
|
| 314 | - return $this->loginWithPassword($uid, $password); |
|
| 315 | - } |
|
| 316 | - |
|
| 317 | - /** |
|
| 318 | - * Tries to log in a client |
|
| 319 | - * |
|
| 320 | - * Checks token auth enforced |
|
| 321 | - * Checks 2FA enabled |
|
| 322 | - * |
|
| 323 | - * @param string $user |
|
| 324 | - * @param string $password |
|
| 325 | - * @param IRequest $request |
|
| 326 | - * @param OC\Security\Bruteforce\Throttler $throttler |
|
| 327 | - * @throws LoginException |
|
| 328 | - * @throws PasswordLoginForbiddenException |
|
| 329 | - * @return boolean |
|
| 330 | - */ |
|
| 331 | - public function logClientIn($user, |
|
| 332 | - $password, |
|
| 333 | - IRequest $request, |
|
| 334 | - OC\Security\Bruteforce\Throttler $throttler) { |
|
| 335 | - $currentDelay = $throttler->sleepDelay($request->getRemoteAddress(), 'login'); |
|
| 336 | - |
|
| 337 | - if ($this->manager instanceof PublicEmitter) { |
|
| 338 | - $this->manager->emit('\OC\User', 'preLogin', array($user, $password)); |
|
| 339 | - } |
|
| 340 | - |
|
| 341 | - $isTokenPassword = $this->isTokenPassword($password); |
|
| 342 | - if (!$isTokenPassword && $this->isTokenAuthEnforced()) { |
|
| 343 | - throw new PasswordLoginForbiddenException(); |
|
| 344 | - } |
|
| 345 | - if (!$isTokenPassword && $this->isTwoFactorEnforced($user)) { |
|
| 346 | - throw new PasswordLoginForbiddenException(); |
|
| 347 | - } |
|
| 348 | - if (!$this->login($user, $password) ) { |
|
| 349 | - $users = $this->manager->getByEmail($user); |
|
| 350 | - if (count($users) === 1) { |
|
| 351 | - return $this->login($users[0]->getUID(), $password); |
|
| 352 | - } |
|
| 353 | - |
|
| 354 | - $throttler->registerAttempt('login', $request->getRemoteAddress(), ['uid' => $user]); |
|
| 355 | - if($currentDelay === 0) { |
|
| 356 | - $throttler->sleepDelay($request->getRemoteAddress(), 'login'); |
|
| 357 | - } |
|
| 358 | - return false; |
|
| 359 | - } |
|
| 360 | - |
|
| 361 | - if ($isTokenPassword) { |
|
| 362 | - $this->session->set('app_password', $password); |
|
| 363 | - } else if($this->supportsCookies($request)) { |
|
| 364 | - // Password login, but cookies supported -> create (browser) session token |
|
| 365 | - $this->createSessionToken($request, $this->getUser()->getUID(), $user, $password); |
|
| 366 | - } |
|
| 367 | - |
|
| 368 | - return true; |
|
| 369 | - } |
|
| 370 | - |
|
| 371 | - protected function supportsCookies(IRequest $request) { |
|
| 372 | - if (!is_null($request->getCookie('cookie_test'))) { |
|
| 373 | - return true; |
|
| 374 | - } |
|
| 375 | - setcookie('cookie_test', 'test', $this->timeFacory->getTime() + 3600); |
|
| 376 | - return false; |
|
| 377 | - } |
|
| 378 | - |
|
| 379 | - private function isTokenAuthEnforced() { |
|
| 380 | - return $this->config->getSystemValue('token_auth_enforced', false); |
|
| 381 | - } |
|
| 382 | - |
|
| 383 | - protected function isTwoFactorEnforced($username) { |
|
| 384 | - Util::emitHook( |
|
| 385 | - '\OCA\Files_Sharing\API\Server2Server', |
|
| 386 | - 'preLoginNameUsedAsUserName', |
|
| 387 | - array('uid' => &$username) |
|
| 388 | - ); |
|
| 389 | - $user = $this->manager->get($username); |
|
| 390 | - if (is_null($user)) { |
|
| 391 | - $users = $this->manager->getByEmail($username); |
|
| 392 | - if (empty($users)) { |
|
| 393 | - return false; |
|
| 394 | - } |
|
| 395 | - if (count($users) !== 1) { |
|
| 396 | - return true; |
|
| 397 | - } |
|
| 398 | - $user = $users[0]; |
|
| 399 | - } |
|
| 400 | - // DI not possible due to cyclic dependencies :'-/ |
|
| 401 | - return OC::$server->getTwoFactorAuthManager()->isTwoFactorAuthenticated($user); |
|
| 402 | - } |
|
| 403 | - |
|
| 404 | - /** |
|
| 405 | - * Check if the given 'password' is actually a device token |
|
| 406 | - * |
|
| 407 | - * @param string $password |
|
| 408 | - * @return boolean |
|
| 409 | - */ |
|
| 410 | - public function isTokenPassword($password) { |
|
| 411 | - try { |
|
| 412 | - $this->tokenProvider->getToken($password); |
|
| 413 | - return true; |
|
| 414 | - } catch (InvalidTokenException $ex) { |
|
| 415 | - return false; |
|
| 416 | - } |
|
| 417 | - } |
|
| 418 | - |
|
| 419 | - protected function prepareUserLogin($firstTimeLogin) { |
|
| 420 | - // TODO: mock/inject/use non-static |
|
| 421 | - // Refresh the token |
|
| 422 | - \OC::$server->getCsrfTokenManager()->refreshToken(); |
|
| 423 | - //we need to pass the user name, which may differ from login name |
|
| 424 | - $user = $this->getUser()->getUID(); |
|
| 425 | - OC_Util::setupFS($user); |
|
| 426 | - |
|
| 427 | - if ($firstTimeLogin) { |
|
| 428 | - // TODO: lock necessary? |
|
| 429 | - //trigger creation of user home and /files folder |
|
| 430 | - $userFolder = \OC::$server->getUserFolder($user); |
|
| 431 | - |
|
| 432 | - // copy skeleton |
|
| 433 | - \OC_Util::copySkeleton($user, $userFolder); |
|
| 434 | - |
|
| 435 | - // trigger any other initialization |
|
| 436 | - \OC::$server->getEventDispatcher()->dispatch(IUser::class . '::firstLogin', new GenericEvent($this->getUser())); |
|
| 437 | - } |
|
| 438 | - } |
|
| 439 | - |
|
| 440 | - /** |
|
| 441 | - * Tries to login the user with HTTP Basic Authentication |
|
| 442 | - * |
|
| 443 | - * @todo do not allow basic auth if the user is 2FA enforced |
|
| 444 | - * @param IRequest $request |
|
| 445 | - * @param OC\Security\Bruteforce\Throttler $throttler |
|
| 446 | - * @return boolean if the login was successful |
|
| 447 | - */ |
|
| 448 | - public function tryBasicAuthLogin(IRequest $request, |
|
| 449 | - OC\Security\Bruteforce\Throttler $throttler) { |
|
| 450 | - if (!empty($request->server['PHP_AUTH_USER']) && !empty($request->server['PHP_AUTH_PW'])) { |
|
| 451 | - try { |
|
| 452 | - if ($this->logClientIn($request->server['PHP_AUTH_USER'], $request->server['PHP_AUTH_PW'], $request, $throttler)) { |
|
| 453 | - /** |
|
| 454 | - * Add DAV authenticated. This should in an ideal world not be |
|
| 455 | - * necessary but the iOS App reads cookies from anywhere instead |
|
| 456 | - * only the DAV endpoint. |
|
| 457 | - * This makes sure that the cookies will be valid for the whole scope |
|
| 458 | - * @see https://github.com/owncloud/core/issues/22893 |
|
| 459 | - */ |
|
| 460 | - $this->session->set( |
|
| 461 | - Auth::DAV_AUTHENTICATED, $this->getUser()->getUID() |
|
| 462 | - ); |
|
| 463 | - |
|
| 464 | - // Set the last-password-confirm session to make the sudo mode work |
|
| 465 | - $this->session->set('last-password-confirm', $this->timeFacory->getTime()); |
|
| 466 | - |
|
| 467 | - return true; |
|
| 468 | - } |
|
| 469 | - } catch (PasswordLoginForbiddenException $ex) { |
|
| 470 | - // Nothing to do |
|
| 471 | - } |
|
| 472 | - } |
|
| 473 | - return false; |
|
| 474 | - } |
|
| 475 | - |
|
| 476 | - /** |
|
| 477 | - * Log an user in via login name and password |
|
| 478 | - * |
|
| 479 | - * @param string $uid |
|
| 480 | - * @param string $password |
|
| 481 | - * @return boolean |
|
| 482 | - * @throws LoginException if an app canceld the login process or the user is not enabled |
|
| 483 | - */ |
|
| 484 | - private function loginWithPassword($uid, $password) { |
|
| 485 | - $user = $this->manager->checkPassword($uid, $password); |
|
| 486 | - if ($user === false) { |
|
| 487 | - // Password check failed |
|
| 488 | - return false; |
|
| 489 | - } |
|
| 490 | - |
|
| 491 | - if ($user->isEnabled()) { |
|
| 492 | - $this->setUser($user); |
|
| 493 | - $this->setLoginName($uid); |
|
| 494 | - $this->setToken(null); |
|
| 495 | - $firstTimeLogin = $user->updateLastLoginTimestamp(); |
|
| 496 | - $this->manager->emit('\OC\User', 'postLogin', [$user, $password]); |
|
| 497 | - if ($this->isLoggedIn()) { |
|
| 498 | - $this->prepareUserLogin($firstTimeLogin); |
|
| 499 | - return true; |
|
| 500 | - } else { |
|
| 501 | - // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
|
| 502 | - $message = \OC::$server->getL10N('lib')->t('Login canceled by app'); |
|
| 503 | - throw new LoginException($message); |
|
| 504 | - } |
|
| 505 | - } else { |
|
| 506 | - // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
|
| 507 | - $message = \OC::$server->getL10N('lib')->t('User disabled'); |
|
| 508 | - throw new LoginException($message); |
|
| 509 | - } |
|
| 510 | - } |
|
| 511 | - |
|
| 512 | - /** |
|
| 513 | - * Log an user in with a given token (id) |
|
| 514 | - * |
|
| 515 | - * @param string $token |
|
| 516 | - * @return boolean |
|
| 517 | - * @throws LoginException if an app canceled the login process or the user is not enabled |
|
| 518 | - */ |
|
| 519 | - private function loginWithToken($token) { |
|
| 520 | - try { |
|
| 521 | - $dbToken = $this->tokenProvider->getToken($token); |
|
| 522 | - } catch (InvalidTokenException $ex) { |
|
| 523 | - return false; |
|
| 524 | - } |
|
| 525 | - $uid = $dbToken->getUID(); |
|
| 526 | - |
|
| 527 | - // When logging in with token, the password must be decrypted first before passing to login hook |
|
| 528 | - $password = ''; |
|
| 529 | - try { |
|
| 530 | - $password = $this->tokenProvider->getPassword($dbToken, $token); |
|
| 531 | - } catch (PasswordlessTokenException $ex) { |
|
| 532 | - // Ignore and use empty string instead |
|
| 533 | - } |
|
| 534 | - |
|
| 535 | - $user = $this->manager->get($uid); |
|
| 536 | - if (is_null($user)) { |
|
| 537 | - // user does not exist |
|
| 538 | - return false; |
|
| 539 | - } |
|
| 540 | - if (!$user->isEnabled()) { |
|
| 541 | - // disabled users can not log in |
|
| 542 | - // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
|
| 543 | - $message = \OC::$server->getL10N('lib')->t('User disabled'); |
|
| 544 | - throw new LoginException($message); |
|
| 545 | - } |
|
| 546 | - |
|
| 547 | - //login |
|
| 548 | - $this->setUser($user); |
|
| 549 | - $this->setLoginName($dbToken->getLoginName()); |
|
| 550 | - $this->setToken($dbToken->getId()); |
|
| 551 | - \OC::$server->getLockdownManager()->setToken($dbToken); |
|
| 552 | - $this->manager->emit('\OC\User', 'postLogin', array($user, $password)); |
|
| 553 | - |
|
| 554 | - if ($this->isLoggedIn()) { |
|
| 555 | - $this->prepareUserLogin(false); // token login cant be the first |
|
| 556 | - } else { |
|
| 557 | - // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
|
| 558 | - $message = \OC::$server->getL10N('lib')->t('Login canceled by app'); |
|
| 559 | - throw new LoginException($message); |
|
| 560 | - } |
|
| 561 | - |
|
| 562 | - return true; |
|
| 563 | - } |
|
| 564 | - |
|
| 565 | - /** |
|
| 566 | - * Create a new session token for the given user credentials |
|
| 567 | - * |
|
| 568 | - * @param IRequest $request |
|
| 569 | - * @param string $uid user UID |
|
| 570 | - * @param string $loginName login name |
|
| 571 | - * @param string $password |
|
| 572 | - * @param int $remember |
|
| 573 | - * @return boolean |
|
| 574 | - */ |
|
| 575 | - public function createSessionToken(IRequest $request, $uid, $loginName, $password = null, $remember = IToken::DO_NOT_REMEMBER) { |
|
| 576 | - if (is_null($this->manager->get($uid))) { |
|
| 577 | - // User does not exist |
|
| 578 | - return false; |
|
| 579 | - } |
|
| 580 | - $name = isset($request->server['HTTP_USER_AGENT']) ? $request->server['HTTP_USER_AGENT'] : 'unknown browser'; |
|
| 581 | - try { |
|
| 582 | - $sessionId = $this->session->getId(); |
|
| 583 | - $pwd = $this->getPassword($password); |
|
| 584 | - $this->tokenProvider->generateToken($sessionId, $uid, $loginName, $pwd, $name, IToken::TEMPORARY_TOKEN, $remember); |
|
| 585 | - return true; |
|
| 586 | - } catch (SessionNotAvailableException $ex) { |
|
| 587 | - // This can happen with OCC, where a memory session is used |
|
| 588 | - // if a memory session is used, we shouldn't create a session token anyway |
|
| 589 | - return false; |
|
| 590 | - } |
|
| 591 | - } |
|
| 592 | - |
|
| 593 | - /** |
|
| 594 | - * Checks if the given password is a token. |
|
| 595 | - * If yes, the password is extracted from the token. |
|
| 596 | - * If no, the same password is returned. |
|
| 597 | - * |
|
| 598 | - * @param string $password either the login password or a device token |
|
| 599 | - * @return string|null the password or null if none was set in the token |
|
| 600 | - */ |
|
| 601 | - private function getPassword($password) { |
|
| 602 | - if (is_null($password)) { |
|
| 603 | - // This is surely no token ;-) |
|
| 604 | - return null; |
|
| 605 | - } |
|
| 606 | - try { |
|
| 607 | - $token = $this->tokenProvider->getToken($password); |
|
| 608 | - try { |
|
| 609 | - return $this->tokenProvider->getPassword($token, $password); |
|
| 610 | - } catch (PasswordlessTokenException $ex) { |
|
| 611 | - return null; |
|
| 612 | - } |
|
| 613 | - } catch (InvalidTokenException $ex) { |
|
| 614 | - return $password; |
|
| 615 | - } |
|
| 616 | - } |
|
| 617 | - |
|
| 618 | - /** |
|
| 619 | - * @param IToken $dbToken |
|
| 620 | - * @param string $token |
|
| 621 | - * @return boolean |
|
| 622 | - */ |
|
| 623 | - private function checkTokenCredentials(IToken $dbToken, $token) { |
|
| 624 | - // Check whether login credentials are still valid and the user was not disabled |
|
| 625 | - // This check is performed each 5 minutes |
|
| 626 | - $lastCheck = $dbToken->getLastCheck() ? : 0; |
|
| 627 | - $now = $this->timeFacory->getTime(); |
|
| 628 | - if ($lastCheck > ($now - 60 * 5)) { |
|
| 629 | - // Checked performed recently, nothing to do now |
|
| 630 | - return true; |
|
| 631 | - } |
|
| 632 | - |
|
| 633 | - try { |
|
| 634 | - $pwd = $this->tokenProvider->getPassword($dbToken, $token); |
|
| 635 | - } catch (InvalidTokenException $ex) { |
|
| 636 | - // An invalid token password was used -> log user out |
|
| 637 | - return false; |
|
| 638 | - } catch (PasswordlessTokenException $ex) { |
|
| 639 | - // Token has no password |
|
| 640 | - |
|
| 641 | - if (!is_null($this->activeUser) && !$this->activeUser->isEnabled()) { |
|
| 642 | - $this->tokenProvider->invalidateToken($token); |
|
| 643 | - return false; |
|
| 644 | - } |
|
| 645 | - |
|
| 646 | - $dbToken->setLastCheck($now); |
|
| 647 | - return true; |
|
| 648 | - } |
|
| 649 | - |
|
| 650 | - if ($this->manager->checkPassword($dbToken->getLoginName(), $pwd) === false |
|
| 651 | - || (!is_null($this->activeUser) && !$this->activeUser->isEnabled())) { |
|
| 652 | - $this->tokenProvider->invalidateToken($token); |
|
| 653 | - // Password has changed or user was disabled -> log user out |
|
| 654 | - return false; |
|
| 655 | - } |
|
| 656 | - $dbToken->setLastCheck($now); |
|
| 657 | - return true; |
|
| 658 | - } |
|
| 659 | - |
|
| 660 | - /** |
|
| 661 | - * Check if the given token exists and performs password/user-enabled checks |
|
| 662 | - * |
|
| 663 | - * Invalidates the token if checks fail |
|
| 664 | - * |
|
| 665 | - * @param string $token |
|
| 666 | - * @param string $user login name |
|
| 667 | - * @return boolean |
|
| 668 | - */ |
|
| 669 | - private function validateToken($token, $user = null) { |
|
| 670 | - try { |
|
| 671 | - $dbToken = $this->tokenProvider->getToken($token); |
|
| 672 | - } catch (InvalidTokenException $ex) { |
|
| 673 | - return false; |
|
| 674 | - } |
|
| 675 | - |
|
| 676 | - // Check if login names match |
|
| 677 | - if (!is_null($user) && $dbToken->getLoginName() !== $user) { |
|
| 678 | - // TODO: this makes it imposssible to use different login names on browser and client |
|
| 679 | - // e.g. login by e-mail '[email protected]' on browser for generating the token will not |
|
| 680 | - // allow to use the client token with the login name 'user'. |
|
| 681 | - return false; |
|
| 682 | - } |
|
| 683 | - |
|
| 684 | - if (!$this->checkTokenCredentials($dbToken, $token)) { |
|
| 685 | - return false; |
|
| 686 | - } |
|
| 687 | - |
|
| 688 | - $this->tokenProvider->updateTokenActivity($dbToken); |
|
| 689 | - |
|
| 690 | - return true; |
|
| 691 | - } |
|
| 692 | - |
|
| 693 | - /** |
|
| 694 | - * Tries to login the user with auth token header |
|
| 695 | - * |
|
| 696 | - * @param IRequest $request |
|
| 697 | - * @todo check remember me cookie |
|
| 698 | - * @return boolean |
|
| 699 | - */ |
|
| 700 | - public function tryTokenLogin(IRequest $request) { |
|
| 701 | - $authHeader = $request->getHeader('Authorization'); |
|
| 702 | - if (strpos($authHeader, 'token ') === false) { |
|
| 703 | - // No auth header, let's try session id |
|
| 704 | - try { |
|
| 705 | - $token = $this->session->getId(); |
|
| 706 | - } catch (SessionNotAvailableException $ex) { |
|
| 707 | - return false; |
|
| 708 | - } |
|
| 709 | - } else { |
|
| 710 | - $token = substr($authHeader, 6); |
|
| 711 | - } |
|
| 712 | - |
|
| 713 | - if (!$this->loginWithToken($token)) { |
|
| 714 | - return false; |
|
| 715 | - } |
|
| 716 | - if(!$this->validateToken($token)) { |
|
| 717 | - return false; |
|
| 718 | - } |
|
| 719 | - return true; |
|
| 720 | - } |
|
| 721 | - |
|
| 722 | - /** |
|
| 723 | - * perform login using the magic cookie (remember login) |
|
| 724 | - * |
|
| 725 | - * @param string $uid the username |
|
| 726 | - * @param string $currentToken |
|
| 727 | - * @param string $oldSessionId |
|
| 728 | - * @return bool |
|
| 729 | - */ |
|
| 730 | - public function loginWithCookie($uid, $currentToken, $oldSessionId) { |
|
| 731 | - $this->session->regenerateId(); |
|
| 732 | - $this->manager->emit('\OC\User', 'preRememberedLogin', array($uid)); |
|
| 733 | - $user = $this->manager->get($uid); |
|
| 734 | - if (is_null($user)) { |
|
| 735 | - // user does not exist |
|
| 736 | - return false; |
|
| 737 | - } |
|
| 738 | - |
|
| 739 | - // get stored tokens |
|
| 740 | - $tokens = $this->config->getUserKeys($uid, 'login_token'); |
|
| 741 | - // test cookies token against stored tokens |
|
| 742 | - if (!in_array($currentToken, $tokens, true)) { |
|
| 743 | - return false; |
|
| 744 | - } |
|
| 745 | - // replace successfully used token with a new one |
|
| 746 | - $this->config->deleteUserValue($uid, 'login_token', $currentToken); |
|
| 747 | - $newToken = $this->random->generate(32); |
|
| 748 | - $this->config->setUserValue($uid, 'login_token', $newToken, $this->timeFacory->getTime()); |
|
| 749 | - |
|
| 750 | - try { |
|
| 751 | - $sessionId = $this->session->getId(); |
|
| 752 | - $this->tokenProvider->renewSessionToken($oldSessionId, $sessionId); |
|
| 753 | - } catch (SessionNotAvailableException $ex) { |
|
| 754 | - return false; |
|
| 755 | - } catch (InvalidTokenException $ex) { |
|
| 756 | - \OC::$server->getLogger()->warning('Renewing session token failed', ['app' => 'core']); |
|
| 757 | - return false; |
|
| 758 | - } |
|
| 759 | - |
|
| 760 | - $this->setMagicInCookie($user->getUID(), $newToken); |
|
| 761 | - $token = $this->tokenProvider->getToken($sessionId); |
|
| 762 | - |
|
| 763 | - //login |
|
| 764 | - $this->setUser($user); |
|
| 765 | - $this->setLoginName($token->getLoginName()); |
|
| 766 | - $this->setToken($token->getId()); |
|
| 767 | - $user->updateLastLoginTimestamp(); |
|
| 768 | - $this->manager->emit('\OC\User', 'postRememberedLogin', [$user]); |
|
| 769 | - return true; |
|
| 770 | - } |
|
| 771 | - |
|
| 772 | - /** |
|
| 773 | - * @param IUser $user |
|
| 774 | - */ |
|
| 775 | - public function createRememberMeToken(IUser $user) { |
|
| 776 | - $token = $this->random->generate(32); |
|
| 777 | - $this->config->setUserValue($user->getUID(), 'login_token', $token, $this->timeFacory->getTime()); |
|
| 778 | - $this->setMagicInCookie($user->getUID(), $token); |
|
| 779 | - } |
|
| 780 | - |
|
| 781 | - /** |
|
| 782 | - * logout the user from the session |
|
| 783 | - */ |
|
| 784 | - public function logout() { |
|
| 785 | - $this->manager->emit('\OC\User', 'logout'); |
|
| 786 | - $user = $this->getUser(); |
|
| 787 | - if (!is_null($user)) { |
|
| 788 | - try { |
|
| 789 | - $this->tokenProvider->invalidateToken($this->session->getId()); |
|
| 790 | - } catch (SessionNotAvailableException $ex) { |
|
| 791 | - |
|
| 792 | - } |
|
| 793 | - } |
|
| 794 | - $this->setUser(null); |
|
| 795 | - $this->setLoginName(null); |
|
| 796 | - $this->setToken(null); |
|
| 797 | - $this->unsetMagicInCookie(); |
|
| 798 | - $this->session->clear(); |
|
| 799 | - } |
|
| 800 | - |
|
| 801 | - /** |
|
| 802 | - * Set cookie value to use in next page load |
|
| 803 | - * |
|
| 804 | - * @param string $username username to be set |
|
| 805 | - * @param string $token |
|
| 806 | - */ |
|
| 807 | - public function setMagicInCookie($username, $token) { |
|
| 808 | - $secureCookie = OC::$server->getRequest()->getServerProtocol() === 'https'; |
|
| 809 | - $webRoot = \OC::$WEBROOT; |
|
| 810 | - if ($webRoot === '') { |
|
| 811 | - $webRoot = '/'; |
|
| 812 | - } |
|
| 813 | - |
|
| 814 | - $expires = $this->timeFacory->getTime() + $this->config->getSystemValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15); |
|
| 815 | - setcookie('nc_username', $username, $expires, $webRoot, '', $secureCookie, true); |
|
| 816 | - setcookie('nc_token', $token, $expires, $webRoot, '', $secureCookie, true); |
|
| 817 | - try { |
|
| 818 | - setcookie('nc_session_id', $this->session->getId(), $expires, $webRoot, '', $secureCookie, true); |
|
| 819 | - } catch (SessionNotAvailableException $ex) { |
|
| 820 | - // ignore |
|
| 821 | - } |
|
| 822 | - } |
|
| 823 | - |
|
| 824 | - /** |
|
| 825 | - * Remove cookie for "remember username" |
|
| 826 | - */ |
|
| 827 | - public function unsetMagicInCookie() { |
|
| 828 | - //TODO: DI for cookies and IRequest |
|
| 829 | - $secureCookie = OC::$server->getRequest()->getServerProtocol() === 'https'; |
|
| 830 | - |
|
| 831 | - unset($_COOKIE['nc_username']); //TODO: DI |
|
| 832 | - unset($_COOKIE['nc_token']); |
|
| 833 | - unset($_COOKIE['nc_session_id']); |
|
| 834 | - setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true); |
|
| 835 | - setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true); |
|
| 836 | - setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true); |
|
| 837 | - // old cookies might be stored under /webroot/ instead of /webroot |
|
| 838 | - // and Firefox doesn't like it! |
|
| 839 | - setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true); |
|
| 840 | - setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true); |
|
| 841 | - setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true); |
|
| 842 | - } |
|
| 843 | - |
|
| 844 | - /** |
|
| 845 | - * Update password of the browser session token if there is one |
|
| 846 | - * |
|
| 847 | - * @param string $password |
|
| 848 | - */ |
|
| 849 | - public function updateSessionTokenPassword($password) { |
|
| 850 | - try { |
|
| 851 | - $sessionId = $this->session->getId(); |
|
| 852 | - $token = $this->tokenProvider->getToken($sessionId); |
|
| 853 | - $this->tokenProvider->setPassword($token, $sessionId, $password); |
|
| 854 | - } catch (SessionNotAvailableException $ex) { |
|
| 855 | - // Nothing to do |
|
| 856 | - } catch (InvalidTokenException $ex) { |
|
| 857 | - // Nothing to do |
|
| 858 | - } |
|
| 859 | - } |
|
| 78 | + /** @var IUserManager $manager */ |
|
| 79 | + private $manager; |
|
| 80 | + |
|
| 81 | + /** @var ISession $session */ |
|
| 82 | + private $session; |
|
| 83 | + |
|
| 84 | + /** @var ITimeFactory */ |
|
| 85 | + private $timeFacory; |
|
| 86 | + |
|
| 87 | + /** @var IProvider */ |
|
| 88 | + private $tokenProvider; |
|
| 89 | + |
|
| 90 | + /** @var IConfig */ |
|
| 91 | + private $config; |
|
| 92 | + |
|
| 93 | + /** @var User $activeUser */ |
|
| 94 | + protected $activeUser; |
|
| 95 | + |
|
| 96 | + /** @var ISecureRandom */ |
|
| 97 | + private $random; |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * @param IUserManager $manager |
|
| 101 | + * @param ISession $session |
|
| 102 | + * @param ITimeFactory $timeFacory |
|
| 103 | + * @param IProvider $tokenProvider |
|
| 104 | + * @param IConfig $config |
|
| 105 | + * @param ISecureRandom $random |
|
| 106 | + */ |
|
| 107 | + public function __construct(IUserManager $manager, |
|
| 108 | + ISession $session, |
|
| 109 | + ITimeFactory $timeFacory, |
|
| 110 | + $tokenProvider, |
|
| 111 | + IConfig $config, |
|
| 112 | + ISecureRandom $random) { |
|
| 113 | + $this->manager = $manager; |
|
| 114 | + $this->session = $session; |
|
| 115 | + $this->timeFacory = $timeFacory; |
|
| 116 | + $this->tokenProvider = $tokenProvider; |
|
| 117 | + $this->config = $config; |
|
| 118 | + $this->random = $random; |
|
| 119 | + } |
|
| 120 | + |
|
| 121 | + /** |
|
| 122 | + * @param IProvider $provider |
|
| 123 | + */ |
|
| 124 | + public function setTokenProvider(IProvider $provider) { |
|
| 125 | + $this->tokenProvider = $provider; |
|
| 126 | + } |
|
| 127 | + |
|
| 128 | + /** |
|
| 129 | + * @param string $scope |
|
| 130 | + * @param string $method |
|
| 131 | + * @param callable $callback |
|
| 132 | + */ |
|
| 133 | + public function listen($scope, $method, callable $callback) { |
|
| 134 | + $this->manager->listen($scope, $method, $callback); |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + /** |
|
| 138 | + * @param string $scope optional |
|
| 139 | + * @param string $method optional |
|
| 140 | + * @param callable $callback optional |
|
| 141 | + */ |
|
| 142 | + public function removeListener($scope = null, $method = null, callable $callback = null) { |
|
| 143 | + $this->manager->removeListener($scope, $method, $callback); |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + /** |
|
| 147 | + * get the manager object |
|
| 148 | + * |
|
| 149 | + * @return Manager |
|
| 150 | + */ |
|
| 151 | + public function getManager() { |
|
| 152 | + return $this->manager; |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + /** |
|
| 156 | + * get the session object |
|
| 157 | + * |
|
| 158 | + * @return ISession |
|
| 159 | + */ |
|
| 160 | + public function getSession() { |
|
| 161 | + return $this->session; |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * set the session object |
|
| 166 | + * |
|
| 167 | + * @param ISession $session |
|
| 168 | + */ |
|
| 169 | + public function setSession(ISession $session) { |
|
| 170 | + if ($this->session instanceof ISession) { |
|
| 171 | + $this->session->close(); |
|
| 172 | + } |
|
| 173 | + $this->session = $session; |
|
| 174 | + $this->activeUser = null; |
|
| 175 | + } |
|
| 176 | + |
|
| 177 | + /** |
|
| 178 | + * set the currently active user |
|
| 179 | + * |
|
| 180 | + * @param IUser|null $user |
|
| 181 | + */ |
|
| 182 | + public function setUser($user) { |
|
| 183 | + if (is_null($user)) { |
|
| 184 | + $this->session->remove('user_id'); |
|
| 185 | + } else { |
|
| 186 | + $this->session->set('user_id', $user->getUID()); |
|
| 187 | + } |
|
| 188 | + $this->activeUser = $user; |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + /** |
|
| 192 | + * get the current active user |
|
| 193 | + * |
|
| 194 | + * @return IUser|null Current user, otherwise null |
|
| 195 | + */ |
|
| 196 | + public function getUser() { |
|
| 197 | + // FIXME: This is a quick'n dirty work-around for the incognito mode as |
|
| 198 | + // described at https://github.com/owncloud/core/pull/12912#issuecomment-67391155 |
|
| 199 | + if (OC_User::isIncognitoMode()) { |
|
| 200 | + return null; |
|
| 201 | + } |
|
| 202 | + if (is_null($this->activeUser)) { |
|
| 203 | + $uid = $this->session->get('user_id'); |
|
| 204 | + if (is_null($uid)) { |
|
| 205 | + return null; |
|
| 206 | + } |
|
| 207 | + $this->activeUser = $this->manager->get($uid); |
|
| 208 | + if (is_null($this->activeUser)) { |
|
| 209 | + return null; |
|
| 210 | + } |
|
| 211 | + $this->validateSession(); |
|
| 212 | + } |
|
| 213 | + return $this->activeUser; |
|
| 214 | + } |
|
| 215 | + |
|
| 216 | + /** |
|
| 217 | + * Validate whether the current session is valid |
|
| 218 | + * |
|
| 219 | + * - For token-authenticated clients, the token validity is checked |
|
| 220 | + * - For browsers, the session token validity is checked |
|
| 221 | + */ |
|
| 222 | + protected function validateSession() { |
|
| 223 | + $token = null; |
|
| 224 | + $appPassword = $this->session->get('app_password'); |
|
| 225 | + |
|
| 226 | + if (is_null($appPassword)) { |
|
| 227 | + try { |
|
| 228 | + $token = $this->session->getId(); |
|
| 229 | + } catch (SessionNotAvailableException $ex) { |
|
| 230 | + return; |
|
| 231 | + } |
|
| 232 | + } else { |
|
| 233 | + $token = $appPassword; |
|
| 234 | + } |
|
| 235 | + |
|
| 236 | + if (!$this->validateToken($token)) { |
|
| 237 | + // Session was invalidated |
|
| 238 | + $this->logout(); |
|
| 239 | + } |
|
| 240 | + } |
|
| 241 | + |
|
| 242 | + /** |
|
| 243 | + * Checks whether the user is logged in |
|
| 244 | + * |
|
| 245 | + * @return bool if logged in |
|
| 246 | + */ |
|
| 247 | + public function isLoggedIn() { |
|
| 248 | + $user = $this->getUser(); |
|
| 249 | + if (is_null($user)) { |
|
| 250 | + return false; |
|
| 251 | + } |
|
| 252 | + |
|
| 253 | + return $user->isEnabled(); |
|
| 254 | + } |
|
| 255 | + |
|
| 256 | + /** |
|
| 257 | + * set the login name |
|
| 258 | + * |
|
| 259 | + * @param string|null $loginName for the logged in user |
|
| 260 | + */ |
|
| 261 | + public function setLoginName($loginName) { |
|
| 262 | + if (is_null($loginName)) { |
|
| 263 | + $this->session->remove('loginname'); |
|
| 264 | + } else { |
|
| 265 | + $this->session->set('loginname', $loginName); |
|
| 266 | + } |
|
| 267 | + } |
|
| 268 | + |
|
| 269 | + /** |
|
| 270 | + * get the login name of the current user |
|
| 271 | + * |
|
| 272 | + * @return string |
|
| 273 | + */ |
|
| 274 | + public function getLoginName() { |
|
| 275 | + if ($this->activeUser) { |
|
| 276 | + return $this->session->get('loginname'); |
|
| 277 | + } else { |
|
| 278 | + $uid = $this->session->get('user_id'); |
|
| 279 | + if ($uid) { |
|
| 280 | + $this->activeUser = $this->manager->get($uid); |
|
| 281 | + return $this->session->get('loginname'); |
|
| 282 | + } else { |
|
| 283 | + return null; |
|
| 284 | + } |
|
| 285 | + } |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * set the token id |
|
| 290 | + * |
|
| 291 | + * @param int|null $token that was used to log in |
|
| 292 | + */ |
|
| 293 | + protected function setToken($token) { |
|
| 294 | + if ($token === null) { |
|
| 295 | + $this->session->remove('token-id'); |
|
| 296 | + } else { |
|
| 297 | + $this->session->set('token-id', $token); |
|
| 298 | + } |
|
| 299 | + } |
|
| 300 | + |
|
| 301 | + /** |
|
| 302 | + * try to log in with the provided credentials |
|
| 303 | + * |
|
| 304 | + * @param string $uid |
|
| 305 | + * @param string $password |
|
| 306 | + * @return boolean|null |
|
| 307 | + * @throws LoginException |
|
| 308 | + */ |
|
| 309 | + public function login($uid, $password) { |
|
| 310 | + $this->session->regenerateId(); |
|
| 311 | + if ($this->validateToken($password, $uid)) { |
|
| 312 | + return $this->loginWithToken($password); |
|
| 313 | + } |
|
| 314 | + return $this->loginWithPassword($uid, $password); |
|
| 315 | + } |
|
| 316 | + |
|
| 317 | + /** |
|
| 318 | + * Tries to log in a client |
|
| 319 | + * |
|
| 320 | + * Checks token auth enforced |
|
| 321 | + * Checks 2FA enabled |
|
| 322 | + * |
|
| 323 | + * @param string $user |
|
| 324 | + * @param string $password |
|
| 325 | + * @param IRequest $request |
|
| 326 | + * @param OC\Security\Bruteforce\Throttler $throttler |
|
| 327 | + * @throws LoginException |
|
| 328 | + * @throws PasswordLoginForbiddenException |
|
| 329 | + * @return boolean |
|
| 330 | + */ |
|
| 331 | + public function logClientIn($user, |
|
| 332 | + $password, |
|
| 333 | + IRequest $request, |
|
| 334 | + OC\Security\Bruteforce\Throttler $throttler) { |
|
| 335 | + $currentDelay = $throttler->sleepDelay($request->getRemoteAddress(), 'login'); |
|
| 336 | + |
|
| 337 | + if ($this->manager instanceof PublicEmitter) { |
|
| 338 | + $this->manager->emit('\OC\User', 'preLogin', array($user, $password)); |
|
| 339 | + } |
|
| 340 | + |
|
| 341 | + $isTokenPassword = $this->isTokenPassword($password); |
|
| 342 | + if (!$isTokenPassword && $this->isTokenAuthEnforced()) { |
|
| 343 | + throw new PasswordLoginForbiddenException(); |
|
| 344 | + } |
|
| 345 | + if (!$isTokenPassword && $this->isTwoFactorEnforced($user)) { |
|
| 346 | + throw new PasswordLoginForbiddenException(); |
|
| 347 | + } |
|
| 348 | + if (!$this->login($user, $password) ) { |
|
| 349 | + $users = $this->manager->getByEmail($user); |
|
| 350 | + if (count($users) === 1) { |
|
| 351 | + return $this->login($users[0]->getUID(), $password); |
|
| 352 | + } |
|
| 353 | + |
|
| 354 | + $throttler->registerAttempt('login', $request->getRemoteAddress(), ['uid' => $user]); |
|
| 355 | + if($currentDelay === 0) { |
|
| 356 | + $throttler->sleepDelay($request->getRemoteAddress(), 'login'); |
|
| 357 | + } |
|
| 358 | + return false; |
|
| 359 | + } |
|
| 360 | + |
|
| 361 | + if ($isTokenPassword) { |
|
| 362 | + $this->session->set('app_password', $password); |
|
| 363 | + } else if($this->supportsCookies($request)) { |
|
| 364 | + // Password login, but cookies supported -> create (browser) session token |
|
| 365 | + $this->createSessionToken($request, $this->getUser()->getUID(), $user, $password); |
|
| 366 | + } |
|
| 367 | + |
|
| 368 | + return true; |
|
| 369 | + } |
|
| 370 | + |
|
| 371 | + protected function supportsCookies(IRequest $request) { |
|
| 372 | + if (!is_null($request->getCookie('cookie_test'))) { |
|
| 373 | + return true; |
|
| 374 | + } |
|
| 375 | + setcookie('cookie_test', 'test', $this->timeFacory->getTime() + 3600); |
|
| 376 | + return false; |
|
| 377 | + } |
|
| 378 | + |
|
| 379 | + private function isTokenAuthEnforced() { |
|
| 380 | + return $this->config->getSystemValue('token_auth_enforced', false); |
|
| 381 | + } |
|
| 382 | + |
|
| 383 | + protected function isTwoFactorEnforced($username) { |
|
| 384 | + Util::emitHook( |
|
| 385 | + '\OCA\Files_Sharing\API\Server2Server', |
|
| 386 | + 'preLoginNameUsedAsUserName', |
|
| 387 | + array('uid' => &$username) |
|
| 388 | + ); |
|
| 389 | + $user = $this->manager->get($username); |
|
| 390 | + if (is_null($user)) { |
|
| 391 | + $users = $this->manager->getByEmail($username); |
|
| 392 | + if (empty($users)) { |
|
| 393 | + return false; |
|
| 394 | + } |
|
| 395 | + if (count($users) !== 1) { |
|
| 396 | + return true; |
|
| 397 | + } |
|
| 398 | + $user = $users[0]; |
|
| 399 | + } |
|
| 400 | + // DI not possible due to cyclic dependencies :'-/ |
|
| 401 | + return OC::$server->getTwoFactorAuthManager()->isTwoFactorAuthenticated($user); |
|
| 402 | + } |
|
| 403 | + |
|
| 404 | + /** |
|
| 405 | + * Check if the given 'password' is actually a device token |
|
| 406 | + * |
|
| 407 | + * @param string $password |
|
| 408 | + * @return boolean |
|
| 409 | + */ |
|
| 410 | + public function isTokenPassword($password) { |
|
| 411 | + try { |
|
| 412 | + $this->tokenProvider->getToken($password); |
|
| 413 | + return true; |
|
| 414 | + } catch (InvalidTokenException $ex) { |
|
| 415 | + return false; |
|
| 416 | + } |
|
| 417 | + } |
|
| 418 | + |
|
| 419 | + protected function prepareUserLogin($firstTimeLogin) { |
|
| 420 | + // TODO: mock/inject/use non-static |
|
| 421 | + // Refresh the token |
|
| 422 | + \OC::$server->getCsrfTokenManager()->refreshToken(); |
|
| 423 | + //we need to pass the user name, which may differ from login name |
|
| 424 | + $user = $this->getUser()->getUID(); |
|
| 425 | + OC_Util::setupFS($user); |
|
| 426 | + |
|
| 427 | + if ($firstTimeLogin) { |
|
| 428 | + // TODO: lock necessary? |
|
| 429 | + //trigger creation of user home and /files folder |
|
| 430 | + $userFolder = \OC::$server->getUserFolder($user); |
|
| 431 | + |
|
| 432 | + // copy skeleton |
|
| 433 | + \OC_Util::copySkeleton($user, $userFolder); |
|
| 434 | + |
|
| 435 | + // trigger any other initialization |
|
| 436 | + \OC::$server->getEventDispatcher()->dispatch(IUser::class . '::firstLogin', new GenericEvent($this->getUser())); |
|
| 437 | + } |
|
| 438 | + } |
|
| 439 | + |
|
| 440 | + /** |
|
| 441 | + * Tries to login the user with HTTP Basic Authentication |
|
| 442 | + * |
|
| 443 | + * @todo do not allow basic auth if the user is 2FA enforced |
|
| 444 | + * @param IRequest $request |
|
| 445 | + * @param OC\Security\Bruteforce\Throttler $throttler |
|
| 446 | + * @return boolean if the login was successful |
|
| 447 | + */ |
|
| 448 | + public function tryBasicAuthLogin(IRequest $request, |
|
| 449 | + OC\Security\Bruteforce\Throttler $throttler) { |
|
| 450 | + if (!empty($request->server['PHP_AUTH_USER']) && !empty($request->server['PHP_AUTH_PW'])) { |
|
| 451 | + try { |
|
| 452 | + if ($this->logClientIn($request->server['PHP_AUTH_USER'], $request->server['PHP_AUTH_PW'], $request, $throttler)) { |
|
| 453 | + /** |
|
| 454 | + * Add DAV authenticated. This should in an ideal world not be |
|
| 455 | + * necessary but the iOS App reads cookies from anywhere instead |
|
| 456 | + * only the DAV endpoint. |
|
| 457 | + * This makes sure that the cookies will be valid for the whole scope |
|
| 458 | + * @see https://github.com/owncloud/core/issues/22893 |
|
| 459 | + */ |
|
| 460 | + $this->session->set( |
|
| 461 | + Auth::DAV_AUTHENTICATED, $this->getUser()->getUID() |
|
| 462 | + ); |
|
| 463 | + |
|
| 464 | + // Set the last-password-confirm session to make the sudo mode work |
|
| 465 | + $this->session->set('last-password-confirm', $this->timeFacory->getTime()); |
|
| 466 | + |
|
| 467 | + return true; |
|
| 468 | + } |
|
| 469 | + } catch (PasswordLoginForbiddenException $ex) { |
|
| 470 | + // Nothing to do |
|
| 471 | + } |
|
| 472 | + } |
|
| 473 | + return false; |
|
| 474 | + } |
|
| 475 | + |
|
| 476 | + /** |
|
| 477 | + * Log an user in via login name and password |
|
| 478 | + * |
|
| 479 | + * @param string $uid |
|
| 480 | + * @param string $password |
|
| 481 | + * @return boolean |
|
| 482 | + * @throws LoginException if an app canceld the login process or the user is not enabled |
|
| 483 | + */ |
|
| 484 | + private function loginWithPassword($uid, $password) { |
|
| 485 | + $user = $this->manager->checkPassword($uid, $password); |
|
| 486 | + if ($user === false) { |
|
| 487 | + // Password check failed |
|
| 488 | + return false; |
|
| 489 | + } |
|
| 490 | + |
|
| 491 | + if ($user->isEnabled()) { |
|
| 492 | + $this->setUser($user); |
|
| 493 | + $this->setLoginName($uid); |
|
| 494 | + $this->setToken(null); |
|
| 495 | + $firstTimeLogin = $user->updateLastLoginTimestamp(); |
|
| 496 | + $this->manager->emit('\OC\User', 'postLogin', [$user, $password]); |
|
| 497 | + if ($this->isLoggedIn()) { |
|
| 498 | + $this->prepareUserLogin($firstTimeLogin); |
|
| 499 | + return true; |
|
| 500 | + } else { |
|
| 501 | + // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
|
| 502 | + $message = \OC::$server->getL10N('lib')->t('Login canceled by app'); |
|
| 503 | + throw new LoginException($message); |
|
| 504 | + } |
|
| 505 | + } else { |
|
| 506 | + // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
|
| 507 | + $message = \OC::$server->getL10N('lib')->t('User disabled'); |
|
| 508 | + throw new LoginException($message); |
|
| 509 | + } |
|
| 510 | + } |
|
| 511 | + |
|
| 512 | + /** |
|
| 513 | + * Log an user in with a given token (id) |
|
| 514 | + * |
|
| 515 | + * @param string $token |
|
| 516 | + * @return boolean |
|
| 517 | + * @throws LoginException if an app canceled the login process or the user is not enabled |
|
| 518 | + */ |
|
| 519 | + private function loginWithToken($token) { |
|
| 520 | + try { |
|
| 521 | + $dbToken = $this->tokenProvider->getToken($token); |
|
| 522 | + } catch (InvalidTokenException $ex) { |
|
| 523 | + return false; |
|
| 524 | + } |
|
| 525 | + $uid = $dbToken->getUID(); |
|
| 526 | + |
|
| 527 | + // When logging in with token, the password must be decrypted first before passing to login hook |
|
| 528 | + $password = ''; |
|
| 529 | + try { |
|
| 530 | + $password = $this->tokenProvider->getPassword($dbToken, $token); |
|
| 531 | + } catch (PasswordlessTokenException $ex) { |
|
| 532 | + // Ignore and use empty string instead |
|
| 533 | + } |
|
| 534 | + |
|
| 535 | + $user = $this->manager->get($uid); |
|
| 536 | + if (is_null($user)) { |
|
| 537 | + // user does not exist |
|
| 538 | + return false; |
|
| 539 | + } |
|
| 540 | + if (!$user->isEnabled()) { |
|
| 541 | + // disabled users can not log in |
|
| 542 | + // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
|
| 543 | + $message = \OC::$server->getL10N('lib')->t('User disabled'); |
|
| 544 | + throw new LoginException($message); |
|
| 545 | + } |
|
| 546 | + |
|
| 547 | + //login |
|
| 548 | + $this->setUser($user); |
|
| 549 | + $this->setLoginName($dbToken->getLoginName()); |
|
| 550 | + $this->setToken($dbToken->getId()); |
|
| 551 | + \OC::$server->getLockdownManager()->setToken($dbToken); |
|
| 552 | + $this->manager->emit('\OC\User', 'postLogin', array($user, $password)); |
|
| 553 | + |
|
| 554 | + if ($this->isLoggedIn()) { |
|
| 555 | + $this->prepareUserLogin(false); // token login cant be the first |
|
| 556 | + } else { |
|
| 557 | + // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory |
|
| 558 | + $message = \OC::$server->getL10N('lib')->t('Login canceled by app'); |
|
| 559 | + throw new LoginException($message); |
|
| 560 | + } |
|
| 561 | + |
|
| 562 | + return true; |
|
| 563 | + } |
|
| 564 | + |
|
| 565 | + /** |
|
| 566 | + * Create a new session token for the given user credentials |
|
| 567 | + * |
|
| 568 | + * @param IRequest $request |
|
| 569 | + * @param string $uid user UID |
|
| 570 | + * @param string $loginName login name |
|
| 571 | + * @param string $password |
|
| 572 | + * @param int $remember |
|
| 573 | + * @return boolean |
|
| 574 | + */ |
|
| 575 | + public function createSessionToken(IRequest $request, $uid, $loginName, $password = null, $remember = IToken::DO_NOT_REMEMBER) { |
|
| 576 | + if (is_null($this->manager->get($uid))) { |
|
| 577 | + // User does not exist |
|
| 578 | + return false; |
|
| 579 | + } |
|
| 580 | + $name = isset($request->server['HTTP_USER_AGENT']) ? $request->server['HTTP_USER_AGENT'] : 'unknown browser'; |
|
| 581 | + try { |
|
| 582 | + $sessionId = $this->session->getId(); |
|
| 583 | + $pwd = $this->getPassword($password); |
|
| 584 | + $this->tokenProvider->generateToken($sessionId, $uid, $loginName, $pwd, $name, IToken::TEMPORARY_TOKEN, $remember); |
|
| 585 | + return true; |
|
| 586 | + } catch (SessionNotAvailableException $ex) { |
|
| 587 | + // This can happen with OCC, where a memory session is used |
|
| 588 | + // if a memory session is used, we shouldn't create a session token anyway |
|
| 589 | + return false; |
|
| 590 | + } |
|
| 591 | + } |
|
| 592 | + |
|
| 593 | + /** |
|
| 594 | + * Checks if the given password is a token. |
|
| 595 | + * If yes, the password is extracted from the token. |
|
| 596 | + * If no, the same password is returned. |
|
| 597 | + * |
|
| 598 | + * @param string $password either the login password or a device token |
|
| 599 | + * @return string|null the password or null if none was set in the token |
|
| 600 | + */ |
|
| 601 | + private function getPassword($password) { |
|
| 602 | + if (is_null($password)) { |
|
| 603 | + // This is surely no token ;-) |
|
| 604 | + return null; |
|
| 605 | + } |
|
| 606 | + try { |
|
| 607 | + $token = $this->tokenProvider->getToken($password); |
|
| 608 | + try { |
|
| 609 | + return $this->tokenProvider->getPassword($token, $password); |
|
| 610 | + } catch (PasswordlessTokenException $ex) { |
|
| 611 | + return null; |
|
| 612 | + } |
|
| 613 | + } catch (InvalidTokenException $ex) { |
|
| 614 | + return $password; |
|
| 615 | + } |
|
| 616 | + } |
|
| 617 | + |
|
| 618 | + /** |
|
| 619 | + * @param IToken $dbToken |
|
| 620 | + * @param string $token |
|
| 621 | + * @return boolean |
|
| 622 | + */ |
|
| 623 | + private function checkTokenCredentials(IToken $dbToken, $token) { |
|
| 624 | + // Check whether login credentials are still valid and the user was not disabled |
|
| 625 | + // This check is performed each 5 minutes |
|
| 626 | + $lastCheck = $dbToken->getLastCheck() ? : 0; |
|
| 627 | + $now = $this->timeFacory->getTime(); |
|
| 628 | + if ($lastCheck > ($now - 60 * 5)) { |
|
| 629 | + // Checked performed recently, nothing to do now |
|
| 630 | + return true; |
|
| 631 | + } |
|
| 632 | + |
|
| 633 | + try { |
|
| 634 | + $pwd = $this->tokenProvider->getPassword($dbToken, $token); |
|
| 635 | + } catch (InvalidTokenException $ex) { |
|
| 636 | + // An invalid token password was used -> log user out |
|
| 637 | + return false; |
|
| 638 | + } catch (PasswordlessTokenException $ex) { |
|
| 639 | + // Token has no password |
|
| 640 | + |
|
| 641 | + if (!is_null($this->activeUser) && !$this->activeUser->isEnabled()) { |
|
| 642 | + $this->tokenProvider->invalidateToken($token); |
|
| 643 | + return false; |
|
| 644 | + } |
|
| 645 | + |
|
| 646 | + $dbToken->setLastCheck($now); |
|
| 647 | + return true; |
|
| 648 | + } |
|
| 649 | + |
|
| 650 | + if ($this->manager->checkPassword($dbToken->getLoginName(), $pwd) === false |
|
| 651 | + || (!is_null($this->activeUser) && !$this->activeUser->isEnabled())) { |
|
| 652 | + $this->tokenProvider->invalidateToken($token); |
|
| 653 | + // Password has changed or user was disabled -> log user out |
|
| 654 | + return false; |
|
| 655 | + } |
|
| 656 | + $dbToken->setLastCheck($now); |
|
| 657 | + return true; |
|
| 658 | + } |
|
| 659 | + |
|
| 660 | + /** |
|
| 661 | + * Check if the given token exists and performs password/user-enabled checks |
|
| 662 | + * |
|
| 663 | + * Invalidates the token if checks fail |
|
| 664 | + * |
|
| 665 | + * @param string $token |
|
| 666 | + * @param string $user login name |
|
| 667 | + * @return boolean |
|
| 668 | + */ |
|
| 669 | + private function validateToken($token, $user = null) { |
|
| 670 | + try { |
|
| 671 | + $dbToken = $this->tokenProvider->getToken($token); |
|
| 672 | + } catch (InvalidTokenException $ex) { |
|
| 673 | + return false; |
|
| 674 | + } |
|
| 675 | + |
|
| 676 | + // Check if login names match |
|
| 677 | + if (!is_null($user) && $dbToken->getLoginName() !== $user) { |
|
| 678 | + // TODO: this makes it imposssible to use different login names on browser and client |
|
| 679 | + // e.g. login by e-mail '[email protected]' on browser for generating the token will not |
|
| 680 | + // allow to use the client token with the login name 'user'. |
|
| 681 | + return false; |
|
| 682 | + } |
|
| 683 | + |
|
| 684 | + if (!$this->checkTokenCredentials($dbToken, $token)) { |
|
| 685 | + return false; |
|
| 686 | + } |
|
| 687 | + |
|
| 688 | + $this->tokenProvider->updateTokenActivity($dbToken); |
|
| 689 | + |
|
| 690 | + return true; |
|
| 691 | + } |
|
| 692 | + |
|
| 693 | + /** |
|
| 694 | + * Tries to login the user with auth token header |
|
| 695 | + * |
|
| 696 | + * @param IRequest $request |
|
| 697 | + * @todo check remember me cookie |
|
| 698 | + * @return boolean |
|
| 699 | + */ |
|
| 700 | + public function tryTokenLogin(IRequest $request) { |
|
| 701 | + $authHeader = $request->getHeader('Authorization'); |
|
| 702 | + if (strpos($authHeader, 'token ') === false) { |
|
| 703 | + // No auth header, let's try session id |
|
| 704 | + try { |
|
| 705 | + $token = $this->session->getId(); |
|
| 706 | + } catch (SessionNotAvailableException $ex) { |
|
| 707 | + return false; |
|
| 708 | + } |
|
| 709 | + } else { |
|
| 710 | + $token = substr($authHeader, 6); |
|
| 711 | + } |
|
| 712 | + |
|
| 713 | + if (!$this->loginWithToken($token)) { |
|
| 714 | + return false; |
|
| 715 | + } |
|
| 716 | + if(!$this->validateToken($token)) { |
|
| 717 | + return false; |
|
| 718 | + } |
|
| 719 | + return true; |
|
| 720 | + } |
|
| 721 | + |
|
| 722 | + /** |
|
| 723 | + * perform login using the magic cookie (remember login) |
|
| 724 | + * |
|
| 725 | + * @param string $uid the username |
|
| 726 | + * @param string $currentToken |
|
| 727 | + * @param string $oldSessionId |
|
| 728 | + * @return bool |
|
| 729 | + */ |
|
| 730 | + public function loginWithCookie($uid, $currentToken, $oldSessionId) { |
|
| 731 | + $this->session->regenerateId(); |
|
| 732 | + $this->manager->emit('\OC\User', 'preRememberedLogin', array($uid)); |
|
| 733 | + $user = $this->manager->get($uid); |
|
| 734 | + if (is_null($user)) { |
|
| 735 | + // user does not exist |
|
| 736 | + return false; |
|
| 737 | + } |
|
| 738 | + |
|
| 739 | + // get stored tokens |
|
| 740 | + $tokens = $this->config->getUserKeys($uid, 'login_token'); |
|
| 741 | + // test cookies token against stored tokens |
|
| 742 | + if (!in_array($currentToken, $tokens, true)) { |
|
| 743 | + return false; |
|
| 744 | + } |
|
| 745 | + // replace successfully used token with a new one |
|
| 746 | + $this->config->deleteUserValue($uid, 'login_token', $currentToken); |
|
| 747 | + $newToken = $this->random->generate(32); |
|
| 748 | + $this->config->setUserValue($uid, 'login_token', $newToken, $this->timeFacory->getTime()); |
|
| 749 | + |
|
| 750 | + try { |
|
| 751 | + $sessionId = $this->session->getId(); |
|
| 752 | + $this->tokenProvider->renewSessionToken($oldSessionId, $sessionId); |
|
| 753 | + } catch (SessionNotAvailableException $ex) { |
|
| 754 | + return false; |
|
| 755 | + } catch (InvalidTokenException $ex) { |
|
| 756 | + \OC::$server->getLogger()->warning('Renewing session token failed', ['app' => 'core']); |
|
| 757 | + return false; |
|
| 758 | + } |
|
| 759 | + |
|
| 760 | + $this->setMagicInCookie($user->getUID(), $newToken); |
|
| 761 | + $token = $this->tokenProvider->getToken($sessionId); |
|
| 762 | + |
|
| 763 | + //login |
|
| 764 | + $this->setUser($user); |
|
| 765 | + $this->setLoginName($token->getLoginName()); |
|
| 766 | + $this->setToken($token->getId()); |
|
| 767 | + $user->updateLastLoginTimestamp(); |
|
| 768 | + $this->manager->emit('\OC\User', 'postRememberedLogin', [$user]); |
|
| 769 | + return true; |
|
| 770 | + } |
|
| 771 | + |
|
| 772 | + /** |
|
| 773 | + * @param IUser $user |
|
| 774 | + */ |
|
| 775 | + public function createRememberMeToken(IUser $user) { |
|
| 776 | + $token = $this->random->generate(32); |
|
| 777 | + $this->config->setUserValue($user->getUID(), 'login_token', $token, $this->timeFacory->getTime()); |
|
| 778 | + $this->setMagicInCookie($user->getUID(), $token); |
|
| 779 | + } |
|
| 780 | + |
|
| 781 | + /** |
|
| 782 | + * logout the user from the session |
|
| 783 | + */ |
|
| 784 | + public function logout() { |
|
| 785 | + $this->manager->emit('\OC\User', 'logout'); |
|
| 786 | + $user = $this->getUser(); |
|
| 787 | + if (!is_null($user)) { |
|
| 788 | + try { |
|
| 789 | + $this->tokenProvider->invalidateToken($this->session->getId()); |
|
| 790 | + } catch (SessionNotAvailableException $ex) { |
|
| 791 | + |
|
| 792 | + } |
|
| 793 | + } |
|
| 794 | + $this->setUser(null); |
|
| 795 | + $this->setLoginName(null); |
|
| 796 | + $this->setToken(null); |
|
| 797 | + $this->unsetMagicInCookie(); |
|
| 798 | + $this->session->clear(); |
|
| 799 | + } |
|
| 800 | + |
|
| 801 | + /** |
|
| 802 | + * Set cookie value to use in next page load |
|
| 803 | + * |
|
| 804 | + * @param string $username username to be set |
|
| 805 | + * @param string $token |
|
| 806 | + */ |
|
| 807 | + public function setMagicInCookie($username, $token) { |
|
| 808 | + $secureCookie = OC::$server->getRequest()->getServerProtocol() === 'https'; |
|
| 809 | + $webRoot = \OC::$WEBROOT; |
|
| 810 | + if ($webRoot === '') { |
|
| 811 | + $webRoot = '/'; |
|
| 812 | + } |
|
| 813 | + |
|
| 814 | + $expires = $this->timeFacory->getTime() + $this->config->getSystemValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15); |
|
| 815 | + setcookie('nc_username', $username, $expires, $webRoot, '', $secureCookie, true); |
|
| 816 | + setcookie('nc_token', $token, $expires, $webRoot, '', $secureCookie, true); |
|
| 817 | + try { |
|
| 818 | + setcookie('nc_session_id', $this->session->getId(), $expires, $webRoot, '', $secureCookie, true); |
|
| 819 | + } catch (SessionNotAvailableException $ex) { |
|
| 820 | + // ignore |
|
| 821 | + } |
|
| 822 | + } |
|
| 823 | + |
|
| 824 | + /** |
|
| 825 | + * Remove cookie for "remember username" |
|
| 826 | + */ |
|
| 827 | + public function unsetMagicInCookie() { |
|
| 828 | + //TODO: DI for cookies and IRequest |
|
| 829 | + $secureCookie = OC::$server->getRequest()->getServerProtocol() === 'https'; |
|
| 830 | + |
|
| 831 | + unset($_COOKIE['nc_username']); //TODO: DI |
|
| 832 | + unset($_COOKIE['nc_token']); |
|
| 833 | + unset($_COOKIE['nc_session_id']); |
|
| 834 | + setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true); |
|
| 835 | + setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true); |
|
| 836 | + setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true); |
|
| 837 | + // old cookies might be stored under /webroot/ instead of /webroot |
|
| 838 | + // and Firefox doesn't like it! |
|
| 839 | + setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true); |
|
| 840 | + setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true); |
|
| 841 | + setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true); |
|
| 842 | + } |
|
| 843 | + |
|
| 844 | + /** |
|
| 845 | + * Update password of the browser session token if there is one |
|
| 846 | + * |
|
| 847 | + * @param string $password |
|
| 848 | + */ |
|
| 849 | + public function updateSessionTokenPassword($password) { |
|
| 850 | + try { |
|
| 851 | + $sessionId = $this->session->getId(); |
|
| 852 | + $token = $this->tokenProvider->getToken($sessionId); |
|
| 853 | + $this->tokenProvider->setPassword($token, $sessionId, $password); |
|
| 854 | + } catch (SessionNotAvailableException $ex) { |
|
| 855 | + // Nothing to do |
|
| 856 | + } catch (InvalidTokenException $ex) { |
|
| 857 | + // Nothing to do |
|
| 858 | + } |
|
| 859 | + } |
|
| 860 | 860 | |
| 861 | 861 | |
| 862 | 862 | } |
@@ -345,14 +345,14 @@ discard block |
||
| 345 | 345 | if (!$isTokenPassword && $this->isTwoFactorEnforced($user)) { |
| 346 | 346 | throw new PasswordLoginForbiddenException(); |
| 347 | 347 | } |
| 348 | - if (!$this->login($user, $password) ) { |
|
| 348 | + if (!$this->login($user, $password)) { |
|
| 349 | 349 | $users = $this->manager->getByEmail($user); |
| 350 | 350 | if (count($users) === 1) { |
| 351 | 351 | return $this->login($users[0]->getUID(), $password); |
| 352 | 352 | } |
| 353 | 353 | |
| 354 | 354 | $throttler->registerAttempt('login', $request->getRemoteAddress(), ['uid' => $user]); |
| 355 | - if($currentDelay === 0) { |
|
| 355 | + if ($currentDelay === 0) { |
|
| 356 | 356 | $throttler->sleepDelay($request->getRemoteAddress(), 'login'); |
| 357 | 357 | } |
| 358 | 358 | return false; |
@@ -360,7 +360,7 @@ discard block |
||
| 360 | 360 | |
| 361 | 361 | if ($isTokenPassword) { |
| 362 | 362 | $this->session->set('app_password', $password); |
| 363 | - } else if($this->supportsCookies($request)) { |
|
| 363 | + } else if ($this->supportsCookies($request)) { |
|
| 364 | 364 | // Password login, but cookies supported -> create (browser) session token |
| 365 | 365 | $this->createSessionToken($request, $this->getUser()->getUID(), $user, $password); |
| 366 | 366 | } |
@@ -433,7 +433,7 @@ discard block |
||
| 433 | 433 | \OC_Util::copySkeleton($user, $userFolder); |
| 434 | 434 | |
| 435 | 435 | // trigger any other initialization |
| 436 | - \OC::$server->getEventDispatcher()->dispatch(IUser::class . '::firstLogin', new GenericEvent($this->getUser())); |
|
| 436 | + \OC::$server->getEventDispatcher()->dispatch(IUser::class.'::firstLogin', new GenericEvent($this->getUser())); |
|
| 437 | 437 | } |
| 438 | 438 | } |
| 439 | 439 | |
@@ -623,7 +623,7 @@ discard block |
||
| 623 | 623 | private function checkTokenCredentials(IToken $dbToken, $token) { |
| 624 | 624 | // Check whether login credentials are still valid and the user was not disabled |
| 625 | 625 | // This check is performed each 5 minutes |
| 626 | - $lastCheck = $dbToken->getLastCheck() ? : 0; |
|
| 626 | + $lastCheck = $dbToken->getLastCheck() ?: 0; |
|
| 627 | 627 | $now = $this->timeFacory->getTime(); |
| 628 | 628 | if ($lastCheck > ($now - 60 * 5)) { |
| 629 | 629 | // Checked performed recently, nothing to do now |
@@ -713,7 +713,7 @@ discard block |
||
| 713 | 713 | if (!$this->loginWithToken($token)) { |
| 714 | 714 | return false; |
| 715 | 715 | } |
| 716 | - if(!$this->validateToken($token)) { |
|
| 716 | + if (!$this->validateToken($token)) { |
|
| 717 | 717 | return false; |
| 718 | 718 | } |
| 719 | 719 | return true; |
@@ -836,9 +836,9 @@ discard block |
||
| 836 | 836 | setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true); |
| 837 | 837 | // old cookies might be stored under /webroot/ instead of /webroot |
| 838 | 838 | // and Firefox doesn't like it! |
| 839 | - setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true); |
|
| 840 | - setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true); |
|
| 841 | - setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true); |
|
| 839 | + setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT.'/', '', $secureCookie, true); |
|
| 840 | + setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT.'/', '', $secureCookie, true); |
|
| 841 | + setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT.'/', '', $secureCookie, true); |
|
| 842 | 842 | } |
| 843 | 843 | |
| 844 | 844 | /** |
@@ -104,6 +104,10 @@ |
||
| 104 | 104 | } |
| 105 | 105 | } |
| 106 | 106 | |
| 107 | + /** |
|
| 108 | + * @param string $href |
|
| 109 | + * @param string $path |
|
| 110 | + */ |
|
| 107 | 111 | public function getPropertyDefinitionsForScope($href, $path) { |
| 108 | 112 | // all valid scopes support the same schema |
| 109 | 113 | |
@@ -149,7 +149,7 @@ discard block |
||
| 149 | 149 | /** @var Folder $folder $results */ |
| 150 | 150 | $results = $folder->search($query); |
| 151 | 151 | |
| 152 | - return array_map(function (Node $node) { |
|
| 152 | + return array_map(function(Node $node) { |
|
| 153 | 153 | if ($node instanceof Folder) { |
| 154 | 154 | return new SearchResult(new \OCA\DAV\Connector\Sabre\Directory($this->view, $node, $this->tree, $this->shareManager), $this->getHrefForNode($node)); |
| 155 | 155 | } else { |
@@ -163,8 +163,8 @@ discard block |
||
| 163 | 163 | * @return string |
| 164 | 164 | */ |
| 165 | 165 | private function getHrefForNode(Node $node) { |
| 166 | - $base = '/files/' . $this->user->getUID(); |
|
| 167 | - return $base . $this->view->getRelativePath($node->getPath()); |
|
| 166 | + $base = '/files/'.$this->user->getUID(); |
|
| 167 | + return $base.$this->view->getRelativePath($node->getPath()); |
|
| 168 | 168 | } |
| 169 | 169 | |
| 170 | 170 | /** |
@@ -204,19 +204,19 @@ discard block |
||
| 204 | 204 | case Operator::OPERATION_LESS_THAN: |
| 205 | 205 | case Operator::OPERATION_IS_LIKE: |
| 206 | 206 | if (count($operator->arguments) !== 2) { |
| 207 | - throw new \InvalidArgumentException('Invalid number of arguments for ' . $trimmedType . ' operation'); |
|
| 207 | + throw new \InvalidArgumentException('Invalid number of arguments for '.$trimmedType.' operation'); |
|
| 208 | 208 | } |
| 209 | 209 | if (gettype($operator->arguments[0]) !== 'string') { |
| 210 | - throw new \InvalidArgumentException('Invalid argument 1 for ' . $trimmedType . ' operation, expected property'); |
|
| 210 | + throw new \InvalidArgumentException('Invalid argument 1 for '.$trimmedType.' operation, expected property'); |
|
| 211 | 211 | } |
| 212 | 212 | if (!($operator->arguments[1] instanceof Literal)) { |
| 213 | - throw new \InvalidArgumentException('Invalid argument 2 for ' . $trimmedType . ' operation, expected literal'); |
|
| 213 | + throw new \InvalidArgumentException('Invalid argument 2 for '.$trimmedType.' operation, expected literal'); |
|
| 214 | 214 | } |
| 215 | 215 | return new SearchComparison($trimmedType, $this->mapPropertyNameToCollumn($operator->arguments[0]), $this->castValue($operator->arguments[0], $operator->arguments[1]->value)); |
| 216 | 216 | case Operator::OPERATION_IS_COLLECTION: |
| 217 | 217 | return new SearchComparison('eq', 'mimetype', ICacheEntry::DIRECTORY_MIMETYPE); |
| 218 | 218 | default: |
| 219 | - throw new \InvalidArgumentException('Unsupported operation ' . $trimmedType. ' (' . $operator->type . ')'); |
|
| 219 | + throw new \InvalidArgumentException('Unsupported operation '.$trimmedType.' ('.$operator->type.')'); |
|
| 220 | 220 | } |
| 221 | 221 | } |
| 222 | 222 | |
@@ -242,7 +242,7 @@ discard block |
||
| 242 | 242 | case FilesPlugin::SIZE_PROPERTYNAME: |
| 243 | 243 | return 'size'; |
| 244 | 244 | default: |
| 245 | - throw new \InvalidArgumentException('Unsupported property for search or order: ' . $propertyName); |
|
| 245 | + throw new \InvalidArgumentException('Unsupported property for search or order: '.$propertyName); |
|
| 246 | 246 | } |
| 247 | 247 | } |
| 248 | 248 | |
@@ -48,218 +48,218 @@ |
||
| 48 | 48 | use SearchDAV\XML\Order; |
| 49 | 49 | |
| 50 | 50 | class FileSearchBackend implements ISearchBackend { |
| 51 | - /** @var Tree */ |
|
| 52 | - private $tree; |
|
| 51 | + /** @var Tree */ |
|
| 52 | + private $tree; |
|
| 53 | 53 | |
| 54 | - /** @var IUser */ |
|
| 55 | - private $user; |
|
| 54 | + /** @var IUser */ |
|
| 55 | + private $user; |
|
| 56 | 56 | |
| 57 | - /** @var IRootFolder */ |
|
| 58 | - private $rootFolder; |
|
| 57 | + /** @var IRootFolder */ |
|
| 58 | + private $rootFolder; |
|
| 59 | 59 | |
| 60 | - /** @var IManager */ |
|
| 61 | - private $shareManager; |
|
| 60 | + /** @var IManager */ |
|
| 61 | + private $shareManager; |
|
| 62 | 62 | |
| 63 | - /** @var View */ |
|
| 64 | - private $view; |
|
| 63 | + /** @var View */ |
|
| 64 | + private $view; |
|
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * FileSearchBackend constructor. |
|
| 68 | - * |
|
| 69 | - * @param Tree $tree |
|
| 70 | - * @param IUser $user |
|
| 71 | - * @param IRootFolder $rootFolder |
|
| 72 | - * @param IManager $shareManager |
|
| 73 | - * @param View $view |
|
| 74 | - * @internal param IRootFolder $rootFolder |
|
| 75 | - */ |
|
| 76 | - public function __construct(Tree $tree, IUser $user, IRootFolder $rootFolder, IManager $shareManager, View $view) { |
|
| 77 | - $this->tree = $tree; |
|
| 78 | - $this->user = $user; |
|
| 79 | - $this->rootFolder = $rootFolder; |
|
| 80 | - $this->shareManager = $shareManager; |
|
| 81 | - $this->view = $view; |
|
| 82 | - } |
|
| 66 | + /** |
|
| 67 | + * FileSearchBackend constructor. |
|
| 68 | + * |
|
| 69 | + * @param Tree $tree |
|
| 70 | + * @param IUser $user |
|
| 71 | + * @param IRootFolder $rootFolder |
|
| 72 | + * @param IManager $shareManager |
|
| 73 | + * @param View $view |
|
| 74 | + * @internal param IRootFolder $rootFolder |
|
| 75 | + */ |
|
| 76 | + public function __construct(Tree $tree, IUser $user, IRootFolder $rootFolder, IManager $shareManager, View $view) { |
|
| 77 | + $this->tree = $tree; |
|
| 78 | + $this->user = $user; |
|
| 79 | + $this->rootFolder = $rootFolder; |
|
| 80 | + $this->shareManager = $shareManager; |
|
| 81 | + $this->view = $view; |
|
| 82 | + } |
|
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Search endpoint will be remote.php/dav |
|
| 86 | - * |
|
| 87 | - * @return string |
|
| 88 | - */ |
|
| 89 | - public function getArbiterPath() { |
|
| 90 | - return ''; |
|
| 91 | - } |
|
| 84 | + /** |
|
| 85 | + * Search endpoint will be remote.php/dav |
|
| 86 | + * |
|
| 87 | + * @return string |
|
| 88 | + */ |
|
| 89 | + public function getArbiterPath() { |
|
| 90 | + return ''; |
|
| 91 | + } |
|
| 92 | 92 | |
| 93 | - public function isValidScope($href, $depth, $path) { |
|
| 94 | - // only allow scopes inside the dav server |
|
| 95 | - if (is_null($path)) { |
|
| 96 | - return false; |
|
| 97 | - } |
|
| 93 | + public function isValidScope($href, $depth, $path) { |
|
| 94 | + // only allow scopes inside the dav server |
|
| 95 | + if (is_null($path)) { |
|
| 96 | + return false; |
|
| 97 | + } |
|
| 98 | 98 | |
| 99 | - try { |
|
| 100 | - $node = $this->tree->getNodeForPath($path); |
|
| 101 | - return $node instanceof Directory; |
|
| 102 | - } catch (NotFound $e) { |
|
| 103 | - return false; |
|
| 104 | - } |
|
| 105 | - } |
|
| 99 | + try { |
|
| 100 | + $node = $this->tree->getNodeForPath($path); |
|
| 101 | + return $node instanceof Directory; |
|
| 102 | + } catch (NotFound $e) { |
|
| 103 | + return false; |
|
| 104 | + } |
|
| 105 | + } |
|
| 106 | 106 | |
| 107 | - public function getPropertyDefinitionsForScope($href, $path) { |
|
| 108 | - // all valid scopes support the same schema |
|
| 107 | + public function getPropertyDefinitionsForScope($href, $path) { |
|
| 108 | + // all valid scopes support the same schema |
|
| 109 | 109 | |
| 110 | - //todo dynamically load all propfind properties that are supported |
|
| 111 | - return [ |
|
| 112 | - // queryable properties |
|
| 113 | - new SearchPropertyDefinition('{DAV:}displayname', true, false, true), |
|
| 114 | - new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true), |
|
| 115 | - new SearchPropertyDefinition('{DAV:}getlastmodifed', true, true, true, SearchPropertyDefinition::DATATYPE_DATETIME), |
|
| 116 | - new SearchPropertyDefinition(FilesPlugin::SIZE_PROPERTYNAME, true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), |
|
| 110 | + //todo dynamically load all propfind properties that are supported |
|
| 111 | + return [ |
|
| 112 | + // queryable properties |
|
| 113 | + new SearchPropertyDefinition('{DAV:}displayname', true, false, true), |
|
| 114 | + new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true), |
|
| 115 | + new SearchPropertyDefinition('{DAV:}getlastmodifed', true, true, true, SearchPropertyDefinition::DATATYPE_DATETIME), |
|
| 116 | + new SearchPropertyDefinition(FilesPlugin::SIZE_PROPERTYNAME, true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), |
|
| 117 | 117 | |
| 118 | - // select only properties |
|
| 119 | - new SearchPropertyDefinition('{DAV:}resourcetype', false, true, false), |
|
| 120 | - new SearchPropertyDefinition('{DAV:}getcontentlength', false, true, false), |
|
| 121 | - new SearchPropertyDefinition(FilesPlugin::CHECKSUMS_PROPERTYNAME, false, true, false), |
|
| 122 | - new SearchPropertyDefinition(FilesPlugin::PERMISSIONS_PROPERTYNAME, false, true, false), |
|
| 123 | - new SearchPropertyDefinition(FilesPlugin::GETETAG_PROPERTYNAME, false, true, false), |
|
| 124 | - new SearchPropertyDefinition(FilesPlugin::OWNER_ID_PROPERTYNAME, false, true, false), |
|
| 125 | - new SearchPropertyDefinition(FilesPlugin::OWNER_DISPLAY_NAME_PROPERTYNAME, false, true, false), |
|
| 126 | - new SearchPropertyDefinition(FilesPlugin::DATA_FINGERPRINT_PROPERTYNAME, false, true, false), |
|
| 127 | - new SearchPropertyDefinition(FilesPlugin::HAS_PREVIEW_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_BOOLEAN), |
|
| 128 | - new SearchPropertyDefinition(FilesPlugin::INTERNAL_FILEID_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), |
|
| 129 | - new SearchPropertyDefinition(FilesPlugin::FILEID_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), |
|
| 130 | - ]; |
|
| 131 | - } |
|
| 118 | + // select only properties |
|
| 119 | + new SearchPropertyDefinition('{DAV:}resourcetype', false, true, false), |
|
| 120 | + new SearchPropertyDefinition('{DAV:}getcontentlength', false, true, false), |
|
| 121 | + new SearchPropertyDefinition(FilesPlugin::CHECKSUMS_PROPERTYNAME, false, true, false), |
|
| 122 | + new SearchPropertyDefinition(FilesPlugin::PERMISSIONS_PROPERTYNAME, false, true, false), |
|
| 123 | + new SearchPropertyDefinition(FilesPlugin::GETETAG_PROPERTYNAME, false, true, false), |
|
| 124 | + new SearchPropertyDefinition(FilesPlugin::OWNER_ID_PROPERTYNAME, false, true, false), |
|
| 125 | + new SearchPropertyDefinition(FilesPlugin::OWNER_DISPLAY_NAME_PROPERTYNAME, false, true, false), |
|
| 126 | + new SearchPropertyDefinition(FilesPlugin::DATA_FINGERPRINT_PROPERTYNAME, false, true, false), |
|
| 127 | + new SearchPropertyDefinition(FilesPlugin::HAS_PREVIEW_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_BOOLEAN), |
|
| 128 | + new SearchPropertyDefinition(FilesPlugin::INTERNAL_FILEID_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), |
|
| 129 | + new SearchPropertyDefinition(FilesPlugin::FILEID_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), |
|
| 130 | + ]; |
|
| 131 | + } |
|
| 132 | 132 | |
| 133 | - /** |
|
| 134 | - * @param BasicSearch $search |
|
| 135 | - * @return SearchResult[] |
|
| 136 | - */ |
|
| 137 | - public function search(BasicSearch $search) { |
|
| 138 | - if (count($search->from) !== 1) { |
|
| 139 | - throw new \InvalidArgumentException('Searching more than one folder is not supported'); |
|
| 140 | - } |
|
| 141 | - $query = $this->transformQuery($search); |
|
| 142 | - $scope = $search->from[0]; |
|
| 143 | - if ($scope->path === null) { |
|
| 144 | - throw new \InvalidArgumentException('Using uri\'s as scope is not supported, please use a path relative to the search arbiter instead'); |
|
| 145 | - } |
|
| 146 | - $node = $this->tree->getNodeForPath($scope->path); |
|
| 147 | - if (!$node instanceof Directory) { |
|
| 148 | - throw new \InvalidArgumentException('Search is only supported on directories'); |
|
| 149 | - } |
|
| 133 | + /** |
|
| 134 | + * @param BasicSearch $search |
|
| 135 | + * @return SearchResult[] |
|
| 136 | + */ |
|
| 137 | + public function search(BasicSearch $search) { |
|
| 138 | + if (count($search->from) !== 1) { |
|
| 139 | + throw new \InvalidArgumentException('Searching more than one folder is not supported'); |
|
| 140 | + } |
|
| 141 | + $query = $this->transformQuery($search); |
|
| 142 | + $scope = $search->from[0]; |
|
| 143 | + if ($scope->path === null) { |
|
| 144 | + throw new \InvalidArgumentException('Using uri\'s as scope is not supported, please use a path relative to the search arbiter instead'); |
|
| 145 | + } |
|
| 146 | + $node = $this->tree->getNodeForPath($scope->path); |
|
| 147 | + if (!$node instanceof Directory) { |
|
| 148 | + throw new \InvalidArgumentException('Search is only supported on directories'); |
|
| 149 | + } |
|
| 150 | 150 | |
| 151 | - $fileInfo = $node->getFileInfo(); |
|
| 152 | - $folder = $this->rootFolder->get($fileInfo->getPath()); |
|
| 153 | - /** @var Folder $folder $results */ |
|
| 154 | - $results = $folder->search($query); |
|
| 151 | + $fileInfo = $node->getFileInfo(); |
|
| 152 | + $folder = $this->rootFolder->get($fileInfo->getPath()); |
|
| 153 | + /** @var Folder $folder $results */ |
|
| 154 | + $results = $folder->search($query); |
|
| 155 | 155 | |
| 156 | - return array_map(function (Node $node) { |
|
| 157 | - if ($node instanceof Folder) { |
|
| 158 | - return new SearchResult(new \OCA\DAV\Connector\Sabre\Directory($this->view, $node, $this->tree, $this->shareManager), $this->getHrefForNode($node)); |
|
| 159 | - } else { |
|
| 160 | - return new SearchResult(new \OCA\DAV\Connector\Sabre\File($this->view, $node, $this->shareManager), $this->getHrefForNode($node)); |
|
| 161 | - } |
|
| 162 | - }, $results); |
|
| 163 | - } |
|
| 156 | + return array_map(function (Node $node) { |
|
| 157 | + if ($node instanceof Folder) { |
|
| 158 | + return new SearchResult(new \OCA\DAV\Connector\Sabre\Directory($this->view, $node, $this->tree, $this->shareManager), $this->getHrefForNode($node)); |
|
| 159 | + } else { |
|
| 160 | + return new SearchResult(new \OCA\DAV\Connector\Sabre\File($this->view, $node, $this->shareManager), $this->getHrefForNode($node)); |
|
| 161 | + } |
|
| 162 | + }, $results); |
|
| 163 | + } |
|
| 164 | 164 | |
| 165 | - /** |
|
| 166 | - * @param Node $node |
|
| 167 | - * @return string |
|
| 168 | - */ |
|
| 169 | - private function getHrefForNode(Node $node) { |
|
| 170 | - $base = '/files/' . $this->user->getUID(); |
|
| 171 | - return $base . $this->view->getRelativePath($node->getPath()); |
|
| 172 | - } |
|
| 165 | + /** |
|
| 166 | + * @param Node $node |
|
| 167 | + * @return string |
|
| 168 | + */ |
|
| 169 | + private function getHrefForNode(Node $node) { |
|
| 170 | + $base = '/files/' . $this->user->getUID(); |
|
| 171 | + return $base . $this->view->getRelativePath($node->getPath()); |
|
| 172 | + } |
|
| 173 | 173 | |
| 174 | - /** |
|
| 175 | - * @param BasicSearch $query |
|
| 176 | - * @return ISearchQuery |
|
| 177 | - */ |
|
| 178 | - private function transformQuery(BasicSearch $query) { |
|
| 179 | - // TODO offset, limit |
|
| 180 | - $orders = array_map([$this, 'mapSearchOrder'], $query->orderBy); |
|
| 181 | - return new SearchQuery($this->transformSearchOperation($query->where), 0, 0, $orders); |
|
| 182 | - } |
|
| 174 | + /** |
|
| 175 | + * @param BasicSearch $query |
|
| 176 | + * @return ISearchQuery |
|
| 177 | + */ |
|
| 178 | + private function transformQuery(BasicSearch $query) { |
|
| 179 | + // TODO offset, limit |
|
| 180 | + $orders = array_map([$this, 'mapSearchOrder'], $query->orderBy); |
|
| 181 | + return new SearchQuery($this->transformSearchOperation($query->where), 0, 0, $orders); |
|
| 182 | + } |
|
| 183 | 183 | |
| 184 | - /** |
|
| 185 | - * @param Order $order |
|
| 186 | - * @return ISearchOrder |
|
| 187 | - */ |
|
| 188 | - private function mapSearchOrder(Order $order) { |
|
| 189 | - return new SearchOrder($order->order === Order::ASC ? ISearchOrder::DIRECTION_ASCENDING : ISearchOrder::DIRECTION_DESCENDING, $this->mapPropertyNameToCollumn($order->property)); |
|
| 190 | - } |
|
| 184 | + /** |
|
| 185 | + * @param Order $order |
|
| 186 | + * @return ISearchOrder |
|
| 187 | + */ |
|
| 188 | + private function mapSearchOrder(Order $order) { |
|
| 189 | + return new SearchOrder($order->order === Order::ASC ? ISearchOrder::DIRECTION_ASCENDING : ISearchOrder::DIRECTION_DESCENDING, $this->mapPropertyNameToCollumn($order->property)); |
|
| 190 | + } |
|
| 191 | 191 | |
| 192 | - /** |
|
| 193 | - * @param Operator $operator |
|
| 194 | - * @return ISearchOperator |
|
| 195 | - */ |
|
| 196 | - private function transformSearchOperation(Operator $operator) { |
|
| 197 | - list(, $trimmedType) = explode('}', $operator->type); |
|
| 198 | - switch ($operator->type) { |
|
| 199 | - case Operator::OPERATION_AND: |
|
| 200 | - case Operator::OPERATION_OR: |
|
| 201 | - case Operator::OPERATION_NOT: |
|
| 202 | - $arguments = array_map([$this, 'transformSearchOperation'], $operator->arguments); |
|
| 203 | - return new SearchBinaryOperator($trimmedType, $arguments); |
|
| 204 | - case Operator::OPERATION_EQUAL: |
|
| 205 | - case Operator::OPERATION_GREATER_OR_EQUAL_THAN: |
|
| 206 | - case Operator::OPERATION_GREATER_THAN: |
|
| 207 | - case Operator::OPERATION_LESS_OR_EQUAL_THAN: |
|
| 208 | - case Operator::OPERATION_LESS_THAN: |
|
| 209 | - case Operator::OPERATION_IS_LIKE: |
|
| 210 | - if (count($operator->arguments) !== 2) { |
|
| 211 | - throw new \InvalidArgumentException('Invalid number of arguments for ' . $trimmedType . ' operation'); |
|
| 212 | - } |
|
| 213 | - if (gettype($operator->arguments[0]) !== 'string') { |
|
| 214 | - throw new \InvalidArgumentException('Invalid argument 1 for ' . $trimmedType . ' operation, expected property'); |
|
| 215 | - } |
|
| 216 | - if (!($operator->arguments[1] instanceof Literal)) { |
|
| 217 | - throw new \InvalidArgumentException('Invalid argument 2 for ' . $trimmedType . ' operation, expected literal'); |
|
| 218 | - } |
|
| 219 | - return new SearchComparison($trimmedType, $this->mapPropertyNameToCollumn($operator->arguments[0]), $this->castValue($operator->arguments[0], $operator->arguments[1]->value)); |
|
| 220 | - case Operator::OPERATION_IS_COLLECTION: |
|
| 221 | - return new SearchComparison('eq', 'mimetype', ICacheEntry::DIRECTORY_MIMETYPE); |
|
| 222 | - default: |
|
| 223 | - throw new \InvalidArgumentException('Unsupported operation ' . $trimmedType. ' (' . $operator->type . ')'); |
|
| 224 | - } |
|
| 225 | - } |
|
| 192 | + /** |
|
| 193 | + * @param Operator $operator |
|
| 194 | + * @return ISearchOperator |
|
| 195 | + */ |
|
| 196 | + private function transformSearchOperation(Operator $operator) { |
|
| 197 | + list(, $trimmedType) = explode('}', $operator->type); |
|
| 198 | + switch ($operator->type) { |
|
| 199 | + case Operator::OPERATION_AND: |
|
| 200 | + case Operator::OPERATION_OR: |
|
| 201 | + case Operator::OPERATION_NOT: |
|
| 202 | + $arguments = array_map([$this, 'transformSearchOperation'], $operator->arguments); |
|
| 203 | + return new SearchBinaryOperator($trimmedType, $arguments); |
|
| 204 | + case Operator::OPERATION_EQUAL: |
|
| 205 | + case Operator::OPERATION_GREATER_OR_EQUAL_THAN: |
|
| 206 | + case Operator::OPERATION_GREATER_THAN: |
|
| 207 | + case Operator::OPERATION_LESS_OR_EQUAL_THAN: |
|
| 208 | + case Operator::OPERATION_LESS_THAN: |
|
| 209 | + case Operator::OPERATION_IS_LIKE: |
|
| 210 | + if (count($operator->arguments) !== 2) { |
|
| 211 | + throw new \InvalidArgumentException('Invalid number of arguments for ' . $trimmedType . ' operation'); |
|
| 212 | + } |
|
| 213 | + if (gettype($operator->arguments[0]) !== 'string') { |
|
| 214 | + throw new \InvalidArgumentException('Invalid argument 1 for ' . $trimmedType . ' operation, expected property'); |
|
| 215 | + } |
|
| 216 | + if (!($operator->arguments[1] instanceof Literal)) { |
|
| 217 | + throw new \InvalidArgumentException('Invalid argument 2 for ' . $trimmedType . ' operation, expected literal'); |
|
| 218 | + } |
|
| 219 | + return new SearchComparison($trimmedType, $this->mapPropertyNameToCollumn($operator->arguments[0]), $this->castValue($operator->arguments[0], $operator->arguments[1]->value)); |
|
| 220 | + case Operator::OPERATION_IS_COLLECTION: |
|
| 221 | + return new SearchComparison('eq', 'mimetype', ICacheEntry::DIRECTORY_MIMETYPE); |
|
| 222 | + default: |
|
| 223 | + throw new \InvalidArgumentException('Unsupported operation ' . $trimmedType. ' (' . $operator->type . ')'); |
|
| 224 | + } |
|
| 225 | + } |
|
| 226 | 226 | |
| 227 | - /** |
|
| 228 | - * @param string $propertyName |
|
| 229 | - * @return string |
|
| 230 | - */ |
|
| 231 | - private function mapPropertyNameToCollumn($propertyName) { |
|
| 232 | - switch ($propertyName) { |
|
| 233 | - case '{DAV:}displayname': |
|
| 234 | - return 'name'; |
|
| 235 | - case '{DAV:}getcontenttype': |
|
| 236 | - return 'mimetype'; |
|
| 237 | - case '{DAV:}getlastmodifed': |
|
| 238 | - return 'mtime'; |
|
| 239 | - case FilesPlugin::SIZE_PROPERTYNAME: |
|
| 240 | - return 'size'; |
|
| 241 | - default: |
|
| 242 | - throw new \InvalidArgumentException('Unsupported property for search or order: ' . $propertyName); |
|
| 243 | - } |
|
| 244 | - } |
|
| 227 | + /** |
|
| 228 | + * @param string $propertyName |
|
| 229 | + * @return string |
|
| 230 | + */ |
|
| 231 | + private function mapPropertyNameToCollumn($propertyName) { |
|
| 232 | + switch ($propertyName) { |
|
| 233 | + case '{DAV:}displayname': |
|
| 234 | + return 'name'; |
|
| 235 | + case '{DAV:}getcontenttype': |
|
| 236 | + return 'mimetype'; |
|
| 237 | + case '{DAV:}getlastmodifed': |
|
| 238 | + return 'mtime'; |
|
| 239 | + case FilesPlugin::SIZE_PROPERTYNAME: |
|
| 240 | + return 'size'; |
|
| 241 | + default: |
|
| 242 | + throw new \InvalidArgumentException('Unsupported property for search or order: ' . $propertyName); |
|
| 243 | + } |
|
| 244 | + } |
|
| 245 | 245 | |
| 246 | - private function castValue($propertyName, $value) { |
|
| 247 | - $allProps = $this->getPropertyDefinitionsForScope('', ''); |
|
| 248 | - foreach ($allProps as $prop) { |
|
| 249 | - if ($prop->name === $propertyName) { |
|
| 250 | - $dataType = $prop->dataType; |
|
| 251 | - switch ($dataType) { |
|
| 252 | - case SearchPropertyDefinition::DATATYPE_BOOLEAN: |
|
| 253 | - return $value === 'yes'; |
|
| 254 | - case SearchPropertyDefinition::DATATYPE_DECIMAL: |
|
| 255 | - case SearchPropertyDefinition::DATATYPE_INTEGER: |
|
| 256 | - case SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER: |
|
| 257 | - return 0 + $value; |
|
| 258 | - default: |
|
| 259 | - return $value; |
|
| 260 | - } |
|
| 261 | - } |
|
| 262 | - } |
|
| 263 | - return $value; |
|
| 264 | - } |
|
| 246 | + private function castValue($propertyName, $value) { |
|
| 247 | + $allProps = $this->getPropertyDefinitionsForScope('', ''); |
|
| 248 | + foreach ($allProps as $prop) { |
|
| 249 | + if ($prop->name === $propertyName) { |
|
| 250 | + $dataType = $prop->dataType; |
|
| 251 | + switch ($dataType) { |
|
| 252 | + case SearchPropertyDefinition::DATATYPE_BOOLEAN: |
|
| 253 | + return $value === 'yes'; |
|
| 254 | + case SearchPropertyDefinition::DATATYPE_DECIMAL: |
|
| 255 | + case SearchPropertyDefinition::DATATYPE_INTEGER: |
|
| 256 | + case SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER: |
|
| 257 | + return 0 + $value; |
|
| 258 | + default: |
|
| 259 | + return $value; |
|
| 260 | + } |
|
| 261 | + } |
|
| 262 | + } |
|
| 263 | + return $value; |
|
| 264 | + } |
|
| 265 | 265 | } |
@@ -420,6 +420,9 @@ discard block |
||
| 420 | 420 | } |
| 421 | 421 | } |
| 422 | 422 | |
| 423 | + /** |
|
| 424 | + * @param string $path |
|
| 425 | + */ |
|
| 423 | 426 | private function getParentPath($path) { |
| 424 | 427 | $parent = dirname($path); |
| 425 | 428 | if ($parent === '.') { |
@@ -598,7 +601,7 @@ discard block |
||
| 598 | 601 | * search for files matching $pattern |
| 599 | 602 | * |
| 600 | 603 | * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%') |
| 601 | - * @return ICacheEntry[] an array of cache entries where the name matches the search pattern |
|
| 604 | + * @return CacheEntry[] an array of cache entries where the name matches the search pattern |
|
| 602 | 605 | */ |
| 603 | 606 | public function search($pattern) { |
| 604 | 607 | // normalize pattern |
@@ -639,7 +642,7 @@ discard block |
||
| 639 | 642 | * |
| 640 | 643 | * @param string $mimetype either a full mimetype to search ('text/plain') or only the first part of a mimetype ('image') |
| 641 | 644 | * where it will search for all mimetypes in the group ('image/*') |
| 642 | - * @return ICacheEntry[] an array of cache entries where the mimetype matches the search |
|
| 645 | + * @return CacheEntry[] an array of cache entries where the mimetype matches the search |
|
| 643 | 646 | */ |
| 644 | 647 | public function searchByMime($mimetype) { |
| 645 | 648 | if (strpos($mimetype, '/')) { |
@@ -161,21 +161,21 @@ discard block |
||
| 161 | 161 | */ |
| 162 | 162 | public static function cacheEntryFromData($data, IMimeTypeLoader $mimetypeLoader) { |
| 163 | 163 | //fix types |
| 164 | - $data['fileid'] = (int)$data['fileid']; |
|
| 165 | - $data['parent'] = (int)$data['parent']; |
|
| 164 | + $data['fileid'] = (int) $data['fileid']; |
|
| 165 | + $data['parent'] = (int) $data['parent']; |
|
| 166 | 166 | $data['size'] = 0 + $data['size']; |
| 167 | - $data['mtime'] = (int)$data['mtime']; |
|
| 168 | - $data['storage_mtime'] = (int)$data['storage_mtime']; |
|
| 169 | - $data['encryptedVersion'] = (int)$data['encrypted']; |
|
| 170 | - $data['encrypted'] = (bool)$data['encrypted']; |
|
| 167 | + $data['mtime'] = (int) $data['mtime']; |
|
| 168 | + $data['storage_mtime'] = (int) $data['storage_mtime']; |
|
| 169 | + $data['encryptedVersion'] = (int) $data['encrypted']; |
|
| 170 | + $data['encrypted'] = (bool) $data['encrypted']; |
|
| 171 | 171 | $data['storage_id'] = $data['storage']; |
| 172 | - $data['storage'] = (int)$data['storage']; |
|
| 172 | + $data['storage'] = (int) $data['storage']; |
|
| 173 | 173 | $data['mimetype'] = $mimetypeLoader->getMimetypeById($data['mimetype']); |
| 174 | 174 | $data['mimepart'] = $mimetypeLoader->getMimetypeById($data['mimepart']); |
| 175 | 175 | if ($data['storage_mtime'] == 0) { |
| 176 | 176 | $data['storage_mtime'] = $data['mtime']; |
| 177 | 177 | } |
| 178 | - $data['permissions'] = (int)$data['permissions']; |
|
| 178 | + $data['permissions'] = (int) $data['permissions']; |
|
| 179 | 179 | return new CacheEntry($data); |
| 180 | 180 | } |
| 181 | 181 | |
@@ -203,8 +203,8 @@ discard block |
||
| 203 | 203 | FROM `*PREFIX*filecache` WHERE `parent` = ? ORDER BY `name` ASC'; |
| 204 | 204 | $result = $this->connection->executeQuery($sql, [$fileId]); |
| 205 | 205 | $files = $result->fetchAll(); |
| 206 | - return array_map(function (array $data) { |
|
| 207 | - return self::cacheEntryFromData($data, $this->mimetypeLoader);; |
|
| 206 | + return array_map(function(array $data) { |
|
| 207 | + return self::cacheEntryFromData($data, $this->mimetypeLoader); ; |
|
| 208 | 208 | }, $files); |
| 209 | 209 | } else { |
| 210 | 210 | return array(); |
@@ -263,7 +263,7 @@ discard block |
||
| 263 | 263 | $queryParts[] = '`storage`'; |
| 264 | 264 | $params[] = $this->getNumericStorageId(); |
| 265 | 265 | |
| 266 | - $queryParts = array_map(function ($item) { |
|
| 266 | + $queryParts = array_map(function($item) { |
|
| 267 | 267 | return trim($item, "`"); |
| 268 | 268 | }, $queryParts); |
| 269 | 269 | $values = array_combine($queryParts, $params); |
@@ -272,7 +272,7 @@ discard block |
||
| 272 | 272 | 'path_hash', |
| 273 | 273 | ]) |
| 274 | 274 | ) { |
| 275 | - return (int)$this->connection->lastInsertId('*PREFIX*filecache'); |
|
| 275 | + return (int) $this->connection->lastInsertId('*PREFIX*filecache'); |
|
| 276 | 276 | } |
| 277 | 277 | |
| 278 | 278 | // The file was created in the mean time |
@@ -310,10 +310,10 @@ discard block |
||
| 310 | 310 | |
| 311 | 311 | // don't update if the data we try to set is the same as the one in the record |
| 312 | 312 | // some databases (Postgres) don't like superfluous updates |
| 313 | - $sql = 'UPDATE `*PREFIX*filecache` SET ' . implode(' = ?, ', $queryParts) . '=? ' . |
|
| 314 | - 'WHERE (' . |
|
| 315 | - implode(' <> ? OR ', $queryParts) . ' <> ? OR ' . |
|
| 316 | - implode(' IS NULL OR ', $queryParts) . ' IS NULL' . |
|
| 313 | + $sql = 'UPDATE `*PREFIX*filecache` SET '.implode(' = ?, ', $queryParts).'=? '. |
|
| 314 | + 'WHERE ('. |
|
| 315 | + implode(' <> ? OR ', $queryParts).' <> ? OR '. |
|
| 316 | + implode(' IS NULL OR ', $queryParts).' IS NULL'. |
|
| 317 | 317 | ') AND `fileid` = ? '; |
| 318 | 318 | $this->connection->executeQuery($sql, $params); |
| 319 | 319 | |
@@ -364,7 +364,7 @@ discard block |
||
| 364 | 364 | } |
| 365 | 365 | } |
| 366 | 366 | $params[] = $value; |
| 367 | - $queryParts[] = '`' . $name . '`'; |
|
| 367 | + $queryParts[] = '`'.$name.'`'; |
|
| 368 | 368 | } |
| 369 | 369 | } |
| 370 | 370 | return array($queryParts, $params); |
@@ -406,7 +406,7 @@ discard block |
||
| 406 | 406 | return -1; |
| 407 | 407 | } else { |
| 408 | 408 | $parent = $this->getParentPath($file); |
| 409 | - return (int)$this->getId($parent); |
|
| 409 | + return (int) $this->getId($parent); |
|
| 410 | 410 | } |
| 411 | 411 | } |
| 412 | 412 | |
@@ -452,7 +452,7 @@ discard block |
||
| 452 | 452 | */ |
| 453 | 453 | private function getSubFolders($entry) { |
| 454 | 454 | $children = $this->getFolderContentsById($entry['fileid']); |
| 455 | - return array_filter($children, function ($child) { |
|
| 455 | + return array_filter($children, function($child) { |
|
| 456 | 456 | return $child['mimetype'] === 'httpd/unix-directory'; |
| 457 | 457 | }); |
| 458 | 458 | } |
@@ -519,14 +519,14 @@ discard block |
||
| 519 | 519 | if ($sourceData['mimetype'] === 'httpd/unix-directory') { |
| 520 | 520 | //find all child entries |
| 521 | 521 | $sql = 'SELECT `path`, `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path` LIKE ?'; |
| 522 | - $result = $this->connection->executeQuery($sql, [$sourceStorageId, $this->connection->escapeLikeParameter($sourcePath) . '/%']); |
|
| 522 | + $result = $this->connection->executeQuery($sql, [$sourceStorageId, $this->connection->escapeLikeParameter($sourcePath).'/%']); |
|
| 523 | 523 | $childEntries = $result->fetchAll(); |
| 524 | 524 | $sourceLength = strlen($sourcePath); |
| 525 | 525 | $this->connection->beginTransaction(); |
| 526 | 526 | $query = $this->connection->prepare('UPDATE `*PREFIX*filecache` SET `storage` = ?, `path` = ?, `path_hash` = ? WHERE `fileid` = ?'); |
| 527 | 527 | |
| 528 | 528 | foreach ($childEntries as $child) { |
| 529 | - $newTargetPath = $targetPath . substr($child['path'], $sourceLength); |
|
| 529 | + $newTargetPath = $targetPath.substr($child['path'], $sourceLength); |
|
| 530 | 530 | $query->execute([$targetStorageId, $newTargetPath, md5($newTargetPath), $child['fileid']]); |
| 531 | 531 | } |
| 532 | 532 | $this->connection->executeQuery($moveSql, [$targetStorageId, $targetPath, md5($targetPath), basename($targetPath), $newParentId, $sourceId]); |
@@ -570,7 +570,7 @@ discard block |
||
| 570 | 570 | $sql = 'SELECT `size` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path_hash` = ?'; |
| 571 | 571 | $result = $this->connection->executeQuery($sql, array($this->getNumericStorageId(), $pathHash)); |
| 572 | 572 | if ($row = $result->fetch()) { |
| 573 | - if ((int)$row['size'] === -1) { |
|
| 573 | + if ((int) $row['size'] === -1) { |
|
| 574 | 574 | return self::SHALLOW; |
| 575 | 575 | } else { |
| 576 | 576 | return self::COMPLETE; |
@@ -615,7 +615,7 @@ discard block |
||
| 615 | 615 | private function searchResultToCacheEntries(Statement $result) { |
| 616 | 616 | $files = $result->fetchAll(); |
| 617 | 617 | |
| 618 | - return array_map(function (array $data) { |
|
| 618 | + return array_map(function(array $data) { |
|
| 619 | 619 | return self::cacheEntryFromData($data, $this->mimetypeLoader); |
| 620 | 620 | }, $files); |
| 621 | 621 | } |
@@ -634,7 +634,7 @@ discard block |
||
| 634 | 634 | $where = '`mimepart` = ?'; |
| 635 | 635 | } |
| 636 | 636 | $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `storage_mtime`, `mtime`, `encrypted`, `etag`, `permissions`, `checksum` |
| 637 | - FROM `*PREFIX*filecache` WHERE ' . $where . ' AND `storage` = ?'; |
|
| 637 | + FROM `*PREFIX*filecache` WHERE ' . $where.' AND `storage` = ?'; |
|
| 638 | 638 | $mimetype = $this->mimetypeLoader->getId($mimetype); |
| 639 | 639 | $result = $this->connection->executeQuery($sql, array($mimetype, $this->getNumericStorageId())); |
| 640 | 640 | |
@@ -670,20 +670,20 @@ discard block |
||
| 670 | 670 | * @return ICacheEntry[] file data |
| 671 | 671 | */ |
| 672 | 672 | public function searchByTag($tag, $userId) { |
| 673 | - $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, ' . |
|
| 674 | - '`mimetype`, `mimepart`, `size`, `mtime`, `storage_mtime`, ' . |
|
| 675 | - '`encrypted`, `etag`, `permissions`, `checksum` ' . |
|
| 676 | - 'FROM `*PREFIX*filecache` `file`, ' . |
|
| 677 | - '`*PREFIX*vcategory_to_object` `tagmap`, ' . |
|
| 678 | - '`*PREFIX*vcategory` `tag` ' . |
|
| 673 | + $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, '. |
|
| 674 | + '`mimetype`, `mimepart`, `size`, `mtime`, `storage_mtime`, '. |
|
| 675 | + '`encrypted`, `etag`, `permissions`, `checksum` '. |
|
| 676 | + 'FROM `*PREFIX*filecache` `file`, '. |
|
| 677 | + '`*PREFIX*vcategory_to_object` `tagmap`, '. |
|
| 678 | + '`*PREFIX*vcategory` `tag` '. |
|
| 679 | 679 | // JOIN filecache to vcategory_to_object |
| 680 | - 'WHERE `file`.`fileid` = `tagmap`.`objid` ' . |
|
| 680 | + 'WHERE `file`.`fileid` = `tagmap`.`objid` '. |
|
| 681 | 681 | // JOIN vcategory_to_object to vcategory |
| 682 | - 'AND `tagmap`.`type` = `tag`.`type` ' . |
|
| 683 | - 'AND `tagmap`.`categoryid` = `tag`.`id` ' . |
|
| 682 | + 'AND `tagmap`.`type` = `tag`.`type` '. |
|
| 683 | + 'AND `tagmap`.`categoryid` = `tag`.`id` '. |
|
| 684 | 684 | // conditions |
| 685 | - 'AND `file`.`storage` = ? ' . |
|
| 686 | - 'AND `tag`.`type` = \'files\' ' . |
|
| 685 | + 'AND `file`.`storage` = ? '. |
|
| 686 | + 'AND `tag`.`type` = \'files\' '. |
|
| 687 | 687 | 'AND `tag`.`uid` = ? '; |
| 688 | 688 | if (is_int($tag)) { |
| 689 | 689 | $sql .= 'AND `tag`.`id` = ? '; |
@@ -701,7 +701,7 @@ discard block |
||
| 701 | 701 | |
| 702 | 702 | $files = $result->fetchAll(); |
| 703 | 703 | |
| 704 | - return array_map(function (array $data) { |
|
| 704 | + return array_map(function(array $data) { |
|
| 705 | 705 | return self::cacheEntryFromData($data, $this->mimetypeLoader); |
| 706 | 706 | }, $files); |
| 707 | 707 | } |
@@ -737,8 +737,8 @@ discard block |
||
| 737 | 737 | } |
| 738 | 738 | if (isset($entry['mimetype']) && $entry['mimetype'] === 'httpd/unix-directory') { |
| 739 | 739 | $id = $entry['fileid']; |
| 740 | - $sql = 'SELECT SUM(`size`) AS f1, MIN(`size`) AS f2 ' . |
|
| 741 | - 'FROM `*PREFIX*filecache` ' . |
|
| 740 | + $sql = 'SELECT SUM(`size`) AS f1, MIN(`size`) AS f2 '. |
|
| 741 | + 'FROM `*PREFIX*filecache` '. |
|
| 742 | 742 | 'WHERE `parent` = ? AND `storage` = ?'; |
| 743 | 743 | $result = $this->connection->executeQuery($sql, array($id, $this->getNumericStorageId())); |
| 744 | 744 | if ($row = $result->fetch()) { |
@@ -54,807 +54,807 @@ |
||
| 54 | 54 | * - ChangePropagator: updates the mtime and etags of parent folders whenever a change to the cache is made to the cache by the updater |
| 55 | 55 | */ |
| 56 | 56 | class Cache implements ICache { |
| 57 | - use MoveFromCacheTrait { |
|
| 58 | - MoveFromCacheTrait::moveFromCache as moveFromCacheFallback; |
|
| 59 | - } |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * @var array partial data for the cache |
|
| 63 | - */ |
|
| 64 | - protected $partial = array(); |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * @var string |
|
| 68 | - */ |
|
| 69 | - protected $storageId; |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * @var Storage $storageCache |
|
| 73 | - */ |
|
| 74 | - protected $storageCache; |
|
| 75 | - |
|
| 76 | - /** @var IMimeTypeLoader */ |
|
| 77 | - protected $mimetypeLoader; |
|
| 78 | - |
|
| 79 | - /** |
|
| 80 | - * @var IDBConnection |
|
| 81 | - */ |
|
| 82 | - protected $connection; |
|
| 83 | - |
|
| 84 | - /** @var QuerySearchHelper */ |
|
| 85 | - protected $querySearchHelper; |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * @param \OC\Files\Storage\Storage|string $storage |
|
| 89 | - */ |
|
| 90 | - public function __construct($storage) { |
|
| 91 | - if ($storage instanceof \OC\Files\Storage\Storage) { |
|
| 92 | - $this->storageId = $storage->getId(); |
|
| 93 | - } else { |
|
| 94 | - $this->storageId = $storage; |
|
| 95 | - } |
|
| 96 | - if (strlen($this->storageId) > 64) { |
|
| 97 | - $this->storageId = md5($this->storageId); |
|
| 98 | - } |
|
| 99 | - |
|
| 100 | - $this->storageCache = new Storage($storage); |
|
| 101 | - $this->mimetypeLoader = \OC::$server->getMimeTypeLoader(); |
|
| 102 | - $this->connection = \OC::$server->getDatabaseConnection(); |
|
| 103 | - $this->querySearchHelper = new QuerySearchHelper($this->mimetypeLoader); |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * Get the numeric storage id for this cache's storage |
|
| 108 | - * |
|
| 109 | - * @return int |
|
| 110 | - */ |
|
| 111 | - public function getNumericStorageId() { |
|
| 112 | - return $this->storageCache->getNumericId(); |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * get the stored metadata of a file or folder |
|
| 117 | - * |
|
| 118 | - * @param string | int $file either the path of a file or folder or the file id for a file or folder |
|
| 119 | - * @return ICacheEntry|false the cache entry as array of false if the file is not found in the cache |
|
| 120 | - */ |
|
| 121 | - public function get($file) { |
|
| 122 | - if (is_string($file) or $file == '') { |
|
| 123 | - // normalize file |
|
| 124 | - $file = $this->normalize($file); |
|
| 125 | - |
|
| 126 | - $where = 'WHERE `storage` = ? AND `path_hash` = ?'; |
|
| 127 | - $params = array($this->getNumericStorageId(), md5($file)); |
|
| 128 | - } else { //file id |
|
| 129 | - $where = 'WHERE `fileid` = ?'; |
|
| 130 | - $params = array($file); |
|
| 131 | - } |
|
| 132 | - $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`, |
|
| 57 | + use MoveFromCacheTrait { |
|
| 58 | + MoveFromCacheTrait::moveFromCache as moveFromCacheFallback; |
|
| 59 | + } |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * @var array partial data for the cache |
|
| 63 | + */ |
|
| 64 | + protected $partial = array(); |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * @var string |
|
| 68 | + */ |
|
| 69 | + protected $storageId; |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * @var Storage $storageCache |
|
| 73 | + */ |
|
| 74 | + protected $storageCache; |
|
| 75 | + |
|
| 76 | + /** @var IMimeTypeLoader */ |
|
| 77 | + protected $mimetypeLoader; |
|
| 78 | + |
|
| 79 | + /** |
|
| 80 | + * @var IDBConnection |
|
| 81 | + */ |
|
| 82 | + protected $connection; |
|
| 83 | + |
|
| 84 | + /** @var QuerySearchHelper */ |
|
| 85 | + protected $querySearchHelper; |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * @param \OC\Files\Storage\Storage|string $storage |
|
| 89 | + */ |
|
| 90 | + public function __construct($storage) { |
|
| 91 | + if ($storage instanceof \OC\Files\Storage\Storage) { |
|
| 92 | + $this->storageId = $storage->getId(); |
|
| 93 | + } else { |
|
| 94 | + $this->storageId = $storage; |
|
| 95 | + } |
|
| 96 | + if (strlen($this->storageId) > 64) { |
|
| 97 | + $this->storageId = md5($this->storageId); |
|
| 98 | + } |
|
| 99 | + |
|
| 100 | + $this->storageCache = new Storage($storage); |
|
| 101 | + $this->mimetypeLoader = \OC::$server->getMimeTypeLoader(); |
|
| 102 | + $this->connection = \OC::$server->getDatabaseConnection(); |
|
| 103 | + $this->querySearchHelper = new QuerySearchHelper($this->mimetypeLoader); |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * Get the numeric storage id for this cache's storage |
|
| 108 | + * |
|
| 109 | + * @return int |
|
| 110 | + */ |
|
| 111 | + public function getNumericStorageId() { |
|
| 112 | + return $this->storageCache->getNumericId(); |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * get the stored metadata of a file or folder |
|
| 117 | + * |
|
| 118 | + * @param string | int $file either the path of a file or folder or the file id for a file or folder |
|
| 119 | + * @return ICacheEntry|false the cache entry as array of false if the file is not found in the cache |
|
| 120 | + */ |
|
| 121 | + public function get($file) { |
|
| 122 | + if (is_string($file) or $file == '') { |
|
| 123 | + // normalize file |
|
| 124 | + $file = $this->normalize($file); |
|
| 125 | + |
|
| 126 | + $where = 'WHERE `storage` = ? AND `path_hash` = ?'; |
|
| 127 | + $params = array($this->getNumericStorageId(), md5($file)); |
|
| 128 | + } else { //file id |
|
| 129 | + $where = 'WHERE `fileid` = ?'; |
|
| 130 | + $params = array($file); |
|
| 131 | + } |
|
| 132 | + $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`, |
|
| 133 | 133 | `storage_mtime`, `encrypted`, `etag`, `permissions`, `checksum` |
| 134 | 134 | FROM `*PREFIX*filecache` ' . $where; |
| 135 | - $result = $this->connection->executeQuery($sql, $params); |
|
| 136 | - $data = $result->fetch(); |
|
| 137 | - |
|
| 138 | - //FIXME hide this HACK in the next database layer, or just use doctrine and get rid of MDB2 and PDO |
|
| 139 | - //PDO returns false, MDB2 returns null, oracle always uses MDB2, so convert null to false |
|
| 140 | - if ($data === null) { |
|
| 141 | - $data = false; |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - //merge partial data |
|
| 145 | - if (!$data and is_string($file)) { |
|
| 146 | - if (isset($this->partial[$file])) { |
|
| 147 | - $data = $this->partial[$file]; |
|
| 148 | - } |
|
| 149 | - return $data; |
|
| 150 | - } else { |
|
| 151 | - return self::cacheEntryFromData($data, $this->mimetypeLoader); |
|
| 152 | - } |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - /** |
|
| 156 | - * Create a CacheEntry from database row |
|
| 157 | - * |
|
| 158 | - * @param array $data |
|
| 159 | - * @param IMimeTypeLoader $mimetypeLoader |
|
| 160 | - * @return CacheEntry |
|
| 161 | - */ |
|
| 162 | - public static function cacheEntryFromData($data, IMimeTypeLoader $mimetypeLoader) { |
|
| 163 | - //fix types |
|
| 164 | - $data['fileid'] = (int)$data['fileid']; |
|
| 165 | - $data['parent'] = (int)$data['parent']; |
|
| 166 | - $data['size'] = 0 + $data['size']; |
|
| 167 | - $data['mtime'] = (int)$data['mtime']; |
|
| 168 | - $data['storage_mtime'] = (int)$data['storage_mtime']; |
|
| 169 | - $data['encryptedVersion'] = (int)$data['encrypted']; |
|
| 170 | - $data['encrypted'] = (bool)$data['encrypted']; |
|
| 171 | - $data['storage_id'] = $data['storage']; |
|
| 172 | - $data['storage'] = (int)$data['storage']; |
|
| 173 | - $data['mimetype'] = $mimetypeLoader->getMimetypeById($data['mimetype']); |
|
| 174 | - $data['mimepart'] = $mimetypeLoader->getMimetypeById($data['mimepart']); |
|
| 175 | - if ($data['storage_mtime'] == 0) { |
|
| 176 | - $data['storage_mtime'] = $data['mtime']; |
|
| 177 | - } |
|
| 178 | - $data['permissions'] = (int)$data['permissions']; |
|
| 179 | - return new CacheEntry($data); |
|
| 180 | - } |
|
| 181 | - |
|
| 182 | - /** |
|
| 183 | - * get the metadata of all files stored in $folder |
|
| 184 | - * |
|
| 185 | - * @param string $folder |
|
| 186 | - * @return ICacheEntry[] |
|
| 187 | - */ |
|
| 188 | - public function getFolderContents($folder) { |
|
| 189 | - $fileId = $this->getId($folder); |
|
| 190 | - return $this->getFolderContentsById($fileId); |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - /** |
|
| 194 | - * get the metadata of all files stored in $folder |
|
| 195 | - * |
|
| 196 | - * @param int $fileId the file id of the folder |
|
| 197 | - * @return ICacheEntry[] |
|
| 198 | - */ |
|
| 199 | - public function getFolderContentsById($fileId) { |
|
| 200 | - if ($fileId > -1) { |
|
| 201 | - $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`, |
|
| 135 | + $result = $this->connection->executeQuery($sql, $params); |
|
| 136 | + $data = $result->fetch(); |
|
| 137 | + |
|
| 138 | + //FIXME hide this HACK in the next database layer, or just use doctrine and get rid of MDB2 and PDO |
|
| 139 | + //PDO returns false, MDB2 returns null, oracle always uses MDB2, so convert null to false |
|
| 140 | + if ($data === null) { |
|
| 141 | + $data = false; |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + //merge partial data |
|
| 145 | + if (!$data and is_string($file)) { |
|
| 146 | + if (isset($this->partial[$file])) { |
|
| 147 | + $data = $this->partial[$file]; |
|
| 148 | + } |
|
| 149 | + return $data; |
|
| 150 | + } else { |
|
| 151 | + return self::cacheEntryFromData($data, $this->mimetypeLoader); |
|
| 152 | + } |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + /** |
|
| 156 | + * Create a CacheEntry from database row |
|
| 157 | + * |
|
| 158 | + * @param array $data |
|
| 159 | + * @param IMimeTypeLoader $mimetypeLoader |
|
| 160 | + * @return CacheEntry |
|
| 161 | + */ |
|
| 162 | + public static function cacheEntryFromData($data, IMimeTypeLoader $mimetypeLoader) { |
|
| 163 | + //fix types |
|
| 164 | + $data['fileid'] = (int)$data['fileid']; |
|
| 165 | + $data['parent'] = (int)$data['parent']; |
|
| 166 | + $data['size'] = 0 + $data['size']; |
|
| 167 | + $data['mtime'] = (int)$data['mtime']; |
|
| 168 | + $data['storage_mtime'] = (int)$data['storage_mtime']; |
|
| 169 | + $data['encryptedVersion'] = (int)$data['encrypted']; |
|
| 170 | + $data['encrypted'] = (bool)$data['encrypted']; |
|
| 171 | + $data['storage_id'] = $data['storage']; |
|
| 172 | + $data['storage'] = (int)$data['storage']; |
|
| 173 | + $data['mimetype'] = $mimetypeLoader->getMimetypeById($data['mimetype']); |
|
| 174 | + $data['mimepart'] = $mimetypeLoader->getMimetypeById($data['mimepart']); |
|
| 175 | + if ($data['storage_mtime'] == 0) { |
|
| 176 | + $data['storage_mtime'] = $data['mtime']; |
|
| 177 | + } |
|
| 178 | + $data['permissions'] = (int)$data['permissions']; |
|
| 179 | + return new CacheEntry($data); |
|
| 180 | + } |
|
| 181 | + |
|
| 182 | + /** |
|
| 183 | + * get the metadata of all files stored in $folder |
|
| 184 | + * |
|
| 185 | + * @param string $folder |
|
| 186 | + * @return ICacheEntry[] |
|
| 187 | + */ |
|
| 188 | + public function getFolderContents($folder) { |
|
| 189 | + $fileId = $this->getId($folder); |
|
| 190 | + return $this->getFolderContentsById($fileId); |
|
| 191 | + } |
|
| 192 | + |
|
| 193 | + /** |
|
| 194 | + * get the metadata of all files stored in $folder |
|
| 195 | + * |
|
| 196 | + * @param int $fileId the file id of the folder |
|
| 197 | + * @return ICacheEntry[] |
|
| 198 | + */ |
|
| 199 | + public function getFolderContentsById($fileId) { |
|
| 200 | + if ($fileId > -1) { |
|
| 201 | + $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`, |
|
| 202 | 202 | `storage_mtime`, `encrypted`, `etag`, `permissions`, `checksum` |
| 203 | 203 | FROM `*PREFIX*filecache` WHERE `parent` = ? ORDER BY `name` ASC'; |
| 204 | - $result = $this->connection->executeQuery($sql, [$fileId]); |
|
| 205 | - $files = $result->fetchAll(); |
|
| 206 | - return array_map(function (array $data) { |
|
| 207 | - return self::cacheEntryFromData($data, $this->mimetypeLoader);; |
|
| 208 | - }, $files); |
|
| 209 | - } else { |
|
| 210 | - return array(); |
|
| 211 | - } |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * insert or update meta data for a file or folder |
|
| 216 | - * |
|
| 217 | - * @param string $file |
|
| 218 | - * @param array $data |
|
| 219 | - * |
|
| 220 | - * @return int file id |
|
| 221 | - * @throws \RuntimeException |
|
| 222 | - */ |
|
| 223 | - public function put($file, array $data) { |
|
| 224 | - if (($id = $this->getId($file)) > -1) { |
|
| 225 | - $this->update($id, $data); |
|
| 226 | - return $id; |
|
| 227 | - } else { |
|
| 228 | - return $this->insert($file, $data); |
|
| 229 | - } |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - /** |
|
| 233 | - * insert meta data for a new file or folder |
|
| 234 | - * |
|
| 235 | - * @param string $file |
|
| 236 | - * @param array $data |
|
| 237 | - * |
|
| 238 | - * @return int file id |
|
| 239 | - * @throws \RuntimeException |
|
| 240 | - */ |
|
| 241 | - public function insert($file, array $data) { |
|
| 242 | - // normalize file |
|
| 243 | - $file = $this->normalize($file); |
|
| 244 | - |
|
| 245 | - if (isset($this->partial[$file])) { //add any saved partial data |
|
| 246 | - $data = array_merge($this->partial[$file], $data); |
|
| 247 | - unset($this->partial[$file]); |
|
| 248 | - } |
|
| 249 | - |
|
| 250 | - $requiredFields = array('size', 'mtime', 'mimetype'); |
|
| 251 | - foreach ($requiredFields as $field) { |
|
| 252 | - if (!isset($data[$field])) { //data not complete save as partial and return |
|
| 253 | - $this->partial[$file] = $data; |
|
| 254 | - return -1; |
|
| 255 | - } |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - $data['path'] = $file; |
|
| 259 | - $data['parent'] = $this->getParentId($file); |
|
| 260 | - $data['name'] = \OC_Util::basename($file); |
|
| 261 | - |
|
| 262 | - list($queryParts, $params) = $this->buildParts($data); |
|
| 263 | - $queryParts[] = '`storage`'; |
|
| 264 | - $params[] = $this->getNumericStorageId(); |
|
| 265 | - |
|
| 266 | - $queryParts = array_map(function ($item) { |
|
| 267 | - return trim($item, "`"); |
|
| 268 | - }, $queryParts); |
|
| 269 | - $values = array_combine($queryParts, $params); |
|
| 270 | - if (\OC::$server->getDatabaseConnection()->insertIfNotExist('*PREFIX*filecache', $values, [ |
|
| 271 | - 'storage', |
|
| 272 | - 'path_hash', |
|
| 273 | - ]) |
|
| 274 | - ) { |
|
| 275 | - return (int)$this->connection->lastInsertId('*PREFIX*filecache'); |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - // The file was created in the mean time |
|
| 279 | - if (($id = $this->getId($file)) > -1) { |
|
| 280 | - $this->update($id, $data); |
|
| 281 | - return $id; |
|
| 282 | - } else { |
|
| 283 | - throw new \RuntimeException('File entry could not be inserted with insertIfNotExist() but could also not be selected with getId() in order to perform an update. Please try again.'); |
|
| 284 | - } |
|
| 285 | - } |
|
| 286 | - |
|
| 287 | - /** |
|
| 288 | - * update the metadata of an existing file or folder in the cache |
|
| 289 | - * |
|
| 290 | - * @param int $id the fileid of the existing file or folder |
|
| 291 | - * @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 |
|
| 292 | - */ |
|
| 293 | - public function update($id, array $data) { |
|
| 294 | - |
|
| 295 | - if (isset($data['path'])) { |
|
| 296 | - // normalize path |
|
| 297 | - $data['path'] = $this->normalize($data['path']); |
|
| 298 | - } |
|
| 299 | - |
|
| 300 | - if (isset($data['name'])) { |
|
| 301 | - // normalize path |
|
| 302 | - $data['name'] = $this->normalize($data['name']); |
|
| 303 | - } |
|
| 304 | - |
|
| 305 | - list($queryParts, $params) = $this->buildParts($data); |
|
| 306 | - // duplicate $params because we need the parts twice in the SQL statement |
|
| 307 | - // once for the SET part, once in the WHERE clause |
|
| 308 | - $params = array_merge($params, $params); |
|
| 309 | - $params[] = $id; |
|
| 310 | - |
|
| 311 | - // don't update if the data we try to set is the same as the one in the record |
|
| 312 | - // some databases (Postgres) don't like superfluous updates |
|
| 313 | - $sql = 'UPDATE `*PREFIX*filecache` SET ' . implode(' = ?, ', $queryParts) . '=? ' . |
|
| 314 | - 'WHERE (' . |
|
| 315 | - implode(' <> ? OR ', $queryParts) . ' <> ? OR ' . |
|
| 316 | - implode(' IS NULL OR ', $queryParts) . ' IS NULL' . |
|
| 317 | - ') AND `fileid` = ? '; |
|
| 318 | - $this->connection->executeQuery($sql, $params); |
|
| 319 | - |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - /** |
|
| 323 | - * extract query parts and params array from data array |
|
| 324 | - * |
|
| 325 | - * @param array $data |
|
| 326 | - * @return array [$queryParts, $params] |
|
| 327 | - * $queryParts: string[], the (escaped) column names to be set in the query |
|
| 328 | - * $params: mixed[], the new values for the columns, to be passed as params to the query |
|
| 329 | - */ |
|
| 330 | - protected function buildParts(array $data) { |
|
| 331 | - $fields = array( |
|
| 332 | - 'path', 'parent', 'name', 'mimetype', 'size', 'mtime', 'storage_mtime', 'encrypted', |
|
| 333 | - 'etag', 'permissions', 'checksum'); |
|
| 334 | - |
|
| 335 | - $doNotCopyStorageMTime = false; |
|
| 336 | - if (array_key_exists('mtime', $data) && $data['mtime'] === null) { |
|
| 337 | - // this horrific magic tells it to not copy storage_mtime to mtime |
|
| 338 | - unset($data['mtime']); |
|
| 339 | - $doNotCopyStorageMTime = true; |
|
| 340 | - } |
|
| 341 | - |
|
| 342 | - $params = array(); |
|
| 343 | - $queryParts = array(); |
|
| 344 | - foreach ($data as $name => $value) { |
|
| 345 | - if (array_search($name, $fields) !== false) { |
|
| 346 | - if ($name === 'path') { |
|
| 347 | - $params[] = md5($value); |
|
| 348 | - $queryParts[] = '`path_hash`'; |
|
| 349 | - } elseif ($name === 'mimetype') { |
|
| 350 | - $params[] = $this->mimetypeLoader->getId(substr($value, 0, strpos($value, '/'))); |
|
| 351 | - $queryParts[] = '`mimepart`'; |
|
| 352 | - $value = $this->mimetypeLoader->getId($value); |
|
| 353 | - } elseif ($name === 'storage_mtime') { |
|
| 354 | - if (!$doNotCopyStorageMTime && !isset($data['mtime'])) { |
|
| 355 | - $params[] = $value; |
|
| 356 | - $queryParts[] = '`mtime`'; |
|
| 357 | - } |
|
| 358 | - } elseif ($name === 'encrypted') { |
|
| 359 | - if (isset($data['encryptedVersion'])) { |
|
| 360 | - $value = $data['encryptedVersion']; |
|
| 361 | - } else { |
|
| 362 | - // Boolean to integer conversion |
|
| 363 | - $value = $value ? 1 : 0; |
|
| 364 | - } |
|
| 365 | - } |
|
| 366 | - $params[] = $value; |
|
| 367 | - $queryParts[] = '`' . $name . '`'; |
|
| 368 | - } |
|
| 369 | - } |
|
| 370 | - return array($queryParts, $params); |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - /** |
|
| 374 | - * get the file id for a file |
|
| 375 | - * |
|
| 376 | - * 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 |
|
| 377 | - * |
|
| 378 | - * File ids are easiest way for apps to store references to a file since unlike paths they are not affected by renames or sharing |
|
| 379 | - * |
|
| 380 | - * @param string $file |
|
| 381 | - * @return int |
|
| 382 | - */ |
|
| 383 | - public function getId($file) { |
|
| 384 | - // normalize file |
|
| 385 | - $file = $this->normalize($file); |
|
| 386 | - |
|
| 387 | - $pathHash = md5($file); |
|
| 388 | - |
|
| 389 | - $sql = 'SELECT `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path_hash` = ?'; |
|
| 390 | - $result = $this->connection->executeQuery($sql, array($this->getNumericStorageId(), $pathHash)); |
|
| 391 | - if ($row = $result->fetch()) { |
|
| 392 | - return $row['fileid']; |
|
| 393 | - } else { |
|
| 394 | - return -1; |
|
| 395 | - } |
|
| 396 | - } |
|
| 397 | - |
|
| 398 | - /** |
|
| 399 | - * get the id of the parent folder of a file |
|
| 400 | - * |
|
| 401 | - * @param string $file |
|
| 402 | - * @return int |
|
| 403 | - */ |
|
| 404 | - public function getParentId($file) { |
|
| 405 | - if ($file === '') { |
|
| 406 | - return -1; |
|
| 407 | - } else { |
|
| 408 | - $parent = $this->getParentPath($file); |
|
| 409 | - return (int)$this->getId($parent); |
|
| 410 | - } |
|
| 411 | - } |
|
| 412 | - |
|
| 413 | - private function getParentPath($path) { |
|
| 414 | - $parent = dirname($path); |
|
| 415 | - if ($parent === '.') { |
|
| 416 | - $parent = ''; |
|
| 417 | - } |
|
| 418 | - return $parent; |
|
| 419 | - } |
|
| 420 | - |
|
| 421 | - /** |
|
| 422 | - * check if a file is available in the cache |
|
| 423 | - * |
|
| 424 | - * @param string $file |
|
| 425 | - * @return bool |
|
| 426 | - */ |
|
| 427 | - public function inCache($file) { |
|
| 428 | - return $this->getId($file) != -1; |
|
| 429 | - } |
|
| 430 | - |
|
| 431 | - /** |
|
| 432 | - * remove a file or folder from the cache |
|
| 433 | - * |
|
| 434 | - * when removing a folder from the cache all files and folders inside the folder will be removed as well |
|
| 435 | - * |
|
| 436 | - * @param string $file |
|
| 437 | - */ |
|
| 438 | - public function remove($file) { |
|
| 439 | - $entry = $this->get($file); |
|
| 440 | - $sql = 'DELETE FROM `*PREFIX*filecache` WHERE `fileid` = ?'; |
|
| 441 | - $this->connection->executeQuery($sql, array($entry['fileid'])); |
|
| 442 | - if ($entry['mimetype'] === 'httpd/unix-directory') { |
|
| 443 | - $this->removeChildren($entry); |
|
| 444 | - } |
|
| 445 | - } |
|
| 446 | - |
|
| 447 | - /** |
|
| 448 | - * Get all sub folders of a folder |
|
| 449 | - * |
|
| 450 | - * @param array $entry the cache entry of the folder to get the subfolders for |
|
| 451 | - * @return array[] the cache entries for the subfolders |
|
| 452 | - */ |
|
| 453 | - private function getSubFolders($entry) { |
|
| 454 | - $children = $this->getFolderContentsById($entry['fileid']); |
|
| 455 | - return array_filter($children, function ($child) { |
|
| 456 | - return $child['mimetype'] === 'httpd/unix-directory'; |
|
| 457 | - }); |
|
| 458 | - } |
|
| 459 | - |
|
| 460 | - /** |
|
| 461 | - * Recursively remove all children of a folder |
|
| 462 | - * |
|
| 463 | - * @param array $entry the cache entry of the folder to remove the children of |
|
| 464 | - * @throws \OC\DatabaseException |
|
| 465 | - */ |
|
| 466 | - private function removeChildren($entry) { |
|
| 467 | - $subFolders = $this->getSubFolders($entry); |
|
| 468 | - foreach ($subFolders as $folder) { |
|
| 469 | - $this->removeChildren($folder); |
|
| 470 | - } |
|
| 471 | - $sql = 'DELETE FROM `*PREFIX*filecache` WHERE `parent` = ?'; |
|
| 472 | - $this->connection->executeQuery($sql, array($entry['fileid'])); |
|
| 473 | - } |
|
| 474 | - |
|
| 475 | - /** |
|
| 476 | - * Move a file or folder in the cache |
|
| 477 | - * |
|
| 478 | - * @param string $source |
|
| 479 | - * @param string $target |
|
| 480 | - */ |
|
| 481 | - public function move($source, $target) { |
|
| 482 | - $this->moveFromCache($this, $source, $target); |
|
| 483 | - } |
|
| 484 | - |
|
| 485 | - /** |
|
| 486 | - * Get the storage id and path needed for a move |
|
| 487 | - * |
|
| 488 | - * @param string $path |
|
| 489 | - * @return array [$storageId, $internalPath] |
|
| 490 | - */ |
|
| 491 | - protected function getMoveInfo($path) { |
|
| 492 | - return [$this->getNumericStorageId(), $path]; |
|
| 493 | - } |
|
| 494 | - |
|
| 495 | - /** |
|
| 496 | - * Move a file or folder in the cache |
|
| 497 | - * |
|
| 498 | - * @param \OCP\Files\Cache\ICache $sourceCache |
|
| 499 | - * @param string $sourcePath |
|
| 500 | - * @param string $targetPath |
|
| 501 | - * @throws \OC\DatabaseException |
|
| 502 | - */ |
|
| 503 | - public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath) { |
|
| 504 | - if ($sourceCache instanceof Cache) { |
|
| 505 | - // normalize source and target |
|
| 506 | - $sourcePath = $this->normalize($sourcePath); |
|
| 507 | - $targetPath = $this->normalize($targetPath); |
|
| 508 | - |
|
| 509 | - $sourceData = $sourceCache->get($sourcePath); |
|
| 510 | - $sourceId = $sourceData['fileid']; |
|
| 511 | - $newParentId = $this->getParentId($targetPath); |
|
| 512 | - |
|
| 513 | - list($sourceStorageId, $sourcePath) = $sourceCache->getMoveInfo($sourcePath); |
|
| 514 | - list($targetStorageId, $targetPath) = $this->getMoveInfo($targetPath); |
|
| 515 | - |
|
| 516 | - // sql for final update |
|
| 517 | - $moveSql = 'UPDATE `*PREFIX*filecache` SET `storage` = ?, `path` = ?, `path_hash` = ?, `name` = ?, `parent` =? WHERE `fileid` = ?'; |
|
| 518 | - |
|
| 519 | - if ($sourceData['mimetype'] === 'httpd/unix-directory') { |
|
| 520 | - //find all child entries |
|
| 521 | - $sql = 'SELECT `path`, `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path` LIKE ?'; |
|
| 522 | - $result = $this->connection->executeQuery($sql, [$sourceStorageId, $this->connection->escapeLikeParameter($sourcePath) . '/%']); |
|
| 523 | - $childEntries = $result->fetchAll(); |
|
| 524 | - $sourceLength = strlen($sourcePath); |
|
| 525 | - $this->connection->beginTransaction(); |
|
| 526 | - $query = $this->connection->prepare('UPDATE `*PREFIX*filecache` SET `storage` = ?, `path` = ?, `path_hash` = ? WHERE `fileid` = ?'); |
|
| 527 | - |
|
| 528 | - foreach ($childEntries as $child) { |
|
| 529 | - $newTargetPath = $targetPath . substr($child['path'], $sourceLength); |
|
| 530 | - $query->execute([$targetStorageId, $newTargetPath, md5($newTargetPath), $child['fileid']]); |
|
| 531 | - } |
|
| 532 | - $this->connection->executeQuery($moveSql, [$targetStorageId, $targetPath, md5($targetPath), basename($targetPath), $newParentId, $sourceId]); |
|
| 533 | - $this->connection->commit(); |
|
| 534 | - } else { |
|
| 535 | - $this->connection->executeQuery($moveSql, [$targetStorageId, $targetPath, md5($targetPath), basename($targetPath), $newParentId, $sourceId]); |
|
| 536 | - } |
|
| 537 | - } else { |
|
| 538 | - $this->moveFromCacheFallback($sourceCache, $sourcePath, $targetPath); |
|
| 539 | - } |
|
| 540 | - } |
|
| 541 | - |
|
| 542 | - /** |
|
| 543 | - * remove all entries for files that are stored on the storage from the cache |
|
| 544 | - */ |
|
| 545 | - public function clear() { |
|
| 546 | - $sql = 'DELETE FROM `*PREFIX*filecache` WHERE `storage` = ?'; |
|
| 547 | - $this->connection->executeQuery($sql, array($this->getNumericStorageId())); |
|
| 548 | - |
|
| 549 | - $sql = 'DELETE FROM `*PREFIX*storages` WHERE `id` = ?'; |
|
| 550 | - $this->connection->executeQuery($sql, array($this->storageId)); |
|
| 551 | - } |
|
| 552 | - |
|
| 553 | - /** |
|
| 554 | - * Get the scan status of a file |
|
| 555 | - * |
|
| 556 | - * - Cache::NOT_FOUND: File is not in the cache |
|
| 557 | - * - Cache::PARTIAL: File is not stored in the cache but some incomplete data is known |
|
| 558 | - * - Cache::SHALLOW: The folder and it's direct children are in the cache but not all sub folders are fully scanned |
|
| 559 | - * - Cache::COMPLETE: The file or folder, with all it's children) are fully scanned |
|
| 560 | - * |
|
| 561 | - * @param string $file |
|
| 562 | - * |
|
| 563 | - * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE |
|
| 564 | - */ |
|
| 565 | - public function getStatus($file) { |
|
| 566 | - // normalize file |
|
| 567 | - $file = $this->normalize($file); |
|
| 568 | - |
|
| 569 | - $pathHash = md5($file); |
|
| 570 | - $sql = 'SELECT `size` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path_hash` = ?'; |
|
| 571 | - $result = $this->connection->executeQuery($sql, array($this->getNumericStorageId(), $pathHash)); |
|
| 572 | - if ($row = $result->fetch()) { |
|
| 573 | - if ((int)$row['size'] === -1) { |
|
| 574 | - return self::SHALLOW; |
|
| 575 | - } else { |
|
| 576 | - return self::COMPLETE; |
|
| 577 | - } |
|
| 578 | - } else { |
|
| 579 | - if (isset($this->partial[$file])) { |
|
| 580 | - return self::PARTIAL; |
|
| 581 | - } else { |
|
| 582 | - return self::NOT_FOUND; |
|
| 583 | - } |
|
| 584 | - } |
|
| 585 | - } |
|
| 586 | - |
|
| 587 | - /** |
|
| 588 | - * search for files matching $pattern |
|
| 589 | - * |
|
| 590 | - * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%') |
|
| 591 | - * @return ICacheEntry[] an array of cache entries where the name matches the search pattern |
|
| 592 | - */ |
|
| 593 | - public function search($pattern) { |
|
| 594 | - // normalize pattern |
|
| 595 | - $pattern = $this->normalize($pattern); |
|
| 596 | - |
|
| 597 | - |
|
| 598 | - $sql = ' |
|
| 204 | + $result = $this->connection->executeQuery($sql, [$fileId]); |
|
| 205 | + $files = $result->fetchAll(); |
|
| 206 | + return array_map(function (array $data) { |
|
| 207 | + return self::cacheEntryFromData($data, $this->mimetypeLoader);; |
|
| 208 | + }, $files); |
|
| 209 | + } else { |
|
| 210 | + return array(); |
|
| 211 | + } |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * insert or update meta data for a file or folder |
|
| 216 | + * |
|
| 217 | + * @param string $file |
|
| 218 | + * @param array $data |
|
| 219 | + * |
|
| 220 | + * @return int file id |
|
| 221 | + * @throws \RuntimeException |
|
| 222 | + */ |
|
| 223 | + public function put($file, array $data) { |
|
| 224 | + if (($id = $this->getId($file)) > -1) { |
|
| 225 | + $this->update($id, $data); |
|
| 226 | + return $id; |
|
| 227 | + } else { |
|
| 228 | + return $this->insert($file, $data); |
|
| 229 | + } |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + /** |
|
| 233 | + * insert meta data for a new file or folder |
|
| 234 | + * |
|
| 235 | + * @param string $file |
|
| 236 | + * @param array $data |
|
| 237 | + * |
|
| 238 | + * @return int file id |
|
| 239 | + * @throws \RuntimeException |
|
| 240 | + */ |
|
| 241 | + public function insert($file, array $data) { |
|
| 242 | + // normalize file |
|
| 243 | + $file = $this->normalize($file); |
|
| 244 | + |
|
| 245 | + if (isset($this->partial[$file])) { //add any saved partial data |
|
| 246 | + $data = array_merge($this->partial[$file], $data); |
|
| 247 | + unset($this->partial[$file]); |
|
| 248 | + } |
|
| 249 | + |
|
| 250 | + $requiredFields = array('size', 'mtime', 'mimetype'); |
|
| 251 | + foreach ($requiredFields as $field) { |
|
| 252 | + if (!isset($data[$field])) { //data not complete save as partial and return |
|
| 253 | + $this->partial[$file] = $data; |
|
| 254 | + return -1; |
|
| 255 | + } |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + $data['path'] = $file; |
|
| 259 | + $data['parent'] = $this->getParentId($file); |
|
| 260 | + $data['name'] = \OC_Util::basename($file); |
|
| 261 | + |
|
| 262 | + list($queryParts, $params) = $this->buildParts($data); |
|
| 263 | + $queryParts[] = '`storage`'; |
|
| 264 | + $params[] = $this->getNumericStorageId(); |
|
| 265 | + |
|
| 266 | + $queryParts = array_map(function ($item) { |
|
| 267 | + return trim($item, "`"); |
|
| 268 | + }, $queryParts); |
|
| 269 | + $values = array_combine($queryParts, $params); |
|
| 270 | + if (\OC::$server->getDatabaseConnection()->insertIfNotExist('*PREFIX*filecache', $values, [ |
|
| 271 | + 'storage', |
|
| 272 | + 'path_hash', |
|
| 273 | + ]) |
|
| 274 | + ) { |
|
| 275 | + return (int)$this->connection->lastInsertId('*PREFIX*filecache'); |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + // The file was created in the mean time |
|
| 279 | + if (($id = $this->getId($file)) > -1) { |
|
| 280 | + $this->update($id, $data); |
|
| 281 | + return $id; |
|
| 282 | + } else { |
|
| 283 | + throw new \RuntimeException('File entry could not be inserted with insertIfNotExist() but could also not be selected with getId() in order to perform an update. Please try again.'); |
|
| 284 | + } |
|
| 285 | + } |
|
| 286 | + |
|
| 287 | + /** |
|
| 288 | + * update the metadata of an existing file or folder in the cache |
|
| 289 | + * |
|
| 290 | + * @param int $id the fileid of the existing file or folder |
|
| 291 | + * @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 |
|
| 292 | + */ |
|
| 293 | + public function update($id, array $data) { |
|
| 294 | + |
|
| 295 | + if (isset($data['path'])) { |
|
| 296 | + // normalize path |
|
| 297 | + $data['path'] = $this->normalize($data['path']); |
|
| 298 | + } |
|
| 299 | + |
|
| 300 | + if (isset($data['name'])) { |
|
| 301 | + // normalize path |
|
| 302 | + $data['name'] = $this->normalize($data['name']); |
|
| 303 | + } |
|
| 304 | + |
|
| 305 | + list($queryParts, $params) = $this->buildParts($data); |
|
| 306 | + // duplicate $params because we need the parts twice in the SQL statement |
|
| 307 | + // once for the SET part, once in the WHERE clause |
|
| 308 | + $params = array_merge($params, $params); |
|
| 309 | + $params[] = $id; |
|
| 310 | + |
|
| 311 | + // don't update if the data we try to set is the same as the one in the record |
|
| 312 | + // some databases (Postgres) don't like superfluous updates |
|
| 313 | + $sql = 'UPDATE `*PREFIX*filecache` SET ' . implode(' = ?, ', $queryParts) . '=? ' . |
|
| 314 | + 'WHERE (' . |
|
| 315 | + implode(' <> ? OR ', $queryParts) . ' <> ? OR ' . |
|
| 316 | + implode(' IS NULL OR ', $queryParts) . ' IS NULL' . |
|
| 317 | + ') AND `fileid` = ? '; |
|
| 318 | + $this->connection->executeQuery($sql, $params); |
|
| 319 | + |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + /** |
|
| 323 | + * extract query parts and params array from data array |
|
| 324 | + * |
|
| 325 | + * @param array $data |
|
| 326 | + * @return array [$queryParts, $params] |
|
| 327 | + * $queryParts: string[], the (escaped) column names to be set in the query |
|
| 328 | + * $params: mixed[], the new values for the columns, to be passed as params to the query |
|
| 329 | + */ |
|
| 330 | + protected function buildParts(array $data) { |
|
| 331 | + $fields = array( |
|
| 332 | + 'path', 'parent', 'name', 'mimetype', 'size', 'mtime', 'storage_mtime', 'encrypted', |
|
| 333 | + 'etag', 'permissions', 'checksum'); |
|
| 334 | + |
|
| 335 | + $doNotCopyStorageMTime = false; |
|
| 336 | + if (array_key_exists('mtime', $data) && $data['mtime'] === null) { |
|
| 337 | + // this horrific magic tells it to not copy storage_mtime to mtime |
|
| 338 | + unset($data['mtime']); |
|
| 339 | + $doNotCopyStorageMTime = true; |
|
| 340 | + } |
|
| 341 | + |
|
| 342 | + $params = array(); |
|
| 343 | + $queryParts = array(); |
|
| 344 | + foreach ($data as $name => $value) { |
|
| 345 | + if (array_search($name, $fields) !== false) { |
|
| 346 | + if ($name === 'path') { |
|
| 347 | + $params[] = md5($value); |
|
| 348 | + $queryParts[] = '`path_hash`'; |
|
| 349 | + } elseif ($name === 'mimetype') { |
|
| 350 | + $params[] = $this->mimetypeLoader->getId(substr($value, 0, strpos($value, '/'))); |
|
| 351 | + $queryParts[] = '`mimepart`'; |
|
| 352 | + $value = $this->mimetypeLoader->getId($value); |
|
| 353 | + } elseif ($name === 'storage_mtime') { |
|
| 354 | + if (!$doNotCopyStorageMTime && !isset($data['mtime'])) { |
|
| 355 | + $params[] = $value; |
|
| 356 | + $queryParts[] = '`mtime`'; |
|
| 357 | + } |
|
| 358 | + } elseif ($name === 'encrypted') { |
|
| 359 | + if (isset($data['encryptedVersion'])) { |
|
| 360 | + $value = $data['encryptedVersion']; |
|
| 361 | + } else { |
|
| 362 | + // Boolean to integer conversion |
|
| 363 | + $value = $value ? 1 : 0; |
|
| 364 | + } |
|
| 365 | + } |
|
| 366 | + $params[] = $value; |
|
| 367 | + $queryParts[] = '`' . $name . '`'; |
|
| 368 | + } |
|
| 369 | + } |
|
| 370 | + return array($queryParts, $params); |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + /** |
|
| 374 | + * get the file id for a file |
|
| 375 | + * |
|
| 376 | + * 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 |
|
| 377 | + * |
|
| 378 | + * File ids are easiest way for apps to store references to a file since unlike paths they are not affected by renames or sharing |
|
| 379 | + * |
|
| 380 | + * @param string $file |
|
| 381 | + * @return int |
|
| 382 | + */ |
|
| 383 | + public function getId($file) { |
|
| 384 | + // normalize file |
|
| 385 | + $file = $this->normalize($file); |
|
| 386 | + |
|
| 387 | + $pathHash = md5($file); |
|
| 388 | + |
|
| 389 | + $sql = 'SELECT `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path_hash` = ?'; |
|
| 390 | + $result = $this->connection->executeQuery($sql, array($this->getNumericStorageId(), $pathHash)); |
|
| 391 | + if ($row = $result->fetch()) { |
|
| 392 | + return $row['fileid']; |
|
| 393 | + } else { |
|
| 394 | + return -1; |
|
| 395 | + } |
|
| 396 | + } |
|
| 397 | + |
|
| 398 | + /** |
|
| 399 | + * get the id of the parent folder of a file |
|
| 400 | + * |
|
| 401 | + * @param string $file |
|
| 402 | + * @return int |
|
| 403 | + */ |
|
| 404 | + public function getParentId($file) { |
|
| 405 | + if ($file === '') { |
|
| 406 | + return -1; |
|
| 407 | + } else { |
|
| 408 | + $parent = $this->getParentPath($file); |
|
| 409 | + return (int)$this->getId($parent); |
|
| 410 | + } |
|
| 411 | + } |
|
| 412 | + |
|
| 413 | + private function getParentPath($path) { |
|
| 414 | + $parent = dirname($path); |
|
| 415 | + if ($parent === '.') { |
|
| 416 | + $parent = ''; |
|
| 417 | + } |
|
| 418 | + return $parent; |
|
| 419 | + } |
|
| 420 | + |
|
| 421 | + /** |
|
| 422 | + * check if a file is available in the cache |
|
| 423 | + * |
|
| 424 | + * @param string $file |
|
| 425 | + * @return bool |
|
| 426 | + */ |
|
| 427 | + public function inCache($file) { |
|
| 428 | + return $this->getId($file) != -1; |
|
| 429 | + } |
|
| 430 | + |
|
| 431 | + /** |
|
| 432 | + * remove a file or folder from the cache |
|
| 433 | + * |
|
| 434 | + * when removing a folder from the cache all files and folders inside the folder will be removed as well |
|
| 435 | + * |
|
| 436 | + * @param string $file |
|
| 437 | + */ |
|
| 438 | + public function remove($file) { |
|
| 439 | + $entry = $this->get($file); |
|
| 440 | + $sql = 'DELETE FROM `*PREFIX*filecache` WHERE `fileid` = ?'; |
|
| 441 | + $this->connection->executeQuery($sql, array($entry['fileid'])); |
|
| 442 | + if ($entry['mimetype'] === 'httpd/unix-directory') { |
|
| 443 | + $this->removeChildren($entry); |
|
| 444 | + } |
|
| 445 | + } |
|
| 446 | + |
|
| 447 | + /** |
|
| 448 | + * Get all sub folders of a folder |
|
| 449 | + * |
|
| 450 | + * @param array $entry the cache entry of the folder to get the subfolders for |
|
| 451 | + * @return array[] the cache entries for the subfolders |
|
| 452 | + */ |
|
| 453 | + private function getSubFolders($entry) { |
|
| 454 | + $children = $this->getFolderContentsById($entry['fileid']); |
|
| 455 | + return array_filter($children, function ($child) { |
|
| 456 | + return $child['mimetype'] === 'httpd/unix-directory'; |
|
| 457 | + }); |
|
| 458 | + } |
|
| 459 | + |
|
| 460 | + /** |
|
| 461 | + * Recursively remove all children of a folder |
|
| 462 | + * |
|
| 463 | + * @param array $entry the cache entry of the folder to remove the children of |
|
| 464 | + * @throws \OC\DatabaseException |
|
| 465 | + */ |
|
| 466 | + private function removeChildren($entry) { |
|
| 467 | + $subFolders = $this->getSubFolders($entry); |
|
| 468 | + foreach ($subFolders as $folder) { |
|
| 469 | + $this->removeChildren($folder); |
|
| 470 | + } |
|
| 471 | + $sql = 'DELETE FROM `*PREFIX*filecache` WHERE `parent` = ?'; |
|
| 472 | + $this->connection->executeQuery($sql, array($entry['fileid'])); |
|
| 473 | + } |
|
| 474 | + |
|
| 475 | + /** |
|
| 476 | + * Move a file or folder in the cache |
|
| 477 | + * |
|
| 478 | + * @param string $source |
|
| 479 | + * @param string $target |
|
| 480 | + */ |
|
| 481 | + public function move($source, $target) { |
|
| 482 | + $this->moveFromCache($this, $source, $target); |
|
| 483 | + } |
|
| 484 | + |
|
| 485 | + /** |
|
| 486 | + * Get the storage id and path needed for a move |
|
| 487 | + * |
|
| 488 | + * @param string $path |
|
| 489 | + * @return array [$storageId, $internalPath] |
|
| 490 | + */ |
|
| 491 | + protected function getMoveInfo($path) { |
|
| 492 | + return [$this->getNumericStorageId(), $path]; |
|
| 493 | + } |
|
| 494 | + |
|
| 495 | + /** |
|
| 496 | + * Move a file or folder in the cache |
|
| 497 | + * |
|
| 498 | + * @param \OCP\Files\Cache\ICache $sourceCache |
|
| 499 | + * @param string $sourcePath |
|
| 500 | + * @param string $targetPath |
|
| 501 | + * @throws \OC\DatabaseException |
|
| 502 | + */ |
|
| 503 | + public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath) { |
|
| 504 | + if ($sourceCache instanceof Cache) { |
|
| 505 | + // normalize source and target |
|
| 506 | + $sourcePath = $this->normalize($sourcePath); |
|
| 507 | + $targetPath = $this->normalize($targetPath); |
|
| 508 | + |
|
| 509 | + $sourceData = $sourceCache->get($sourcePath); |
|
| 510 | + $sourceId = $sourceData['fileid']; |
|
| 511 | + $newParentId = $this->getParentId($targetPath); |
|
| 512 | + |
|
| 513 | + list($sourceStorageId, $sourcePath) = $sourceCache->getMoveInfo($sourcePath); |
|
| 514 | + list($targetStorageId, $targetPath) = $this->getMoveInfo($targetPath); |
|
| 515 | + |
|
| 516 | + // sql for final update |
|
| 517 | + $moveSql = 'UPDATE `*PREFIX*filecache` SET `storage` = ?, `path` = ?, `path_hash` = ?, `name` = ?, `parent` =? WHERE `fileid` = ?'; |
|
| 518 | + |
|
| 519 | + if ($sourceData['mimetype'] === 'httpd/unix-directory') { |
|
| 520 | + //find all child entries |
|
| 521 | + $sql = 'SELECT `path`, `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path` LIKE ?'; |
|
| 522 | + $result = $this->connection->executeQuery($sql, [$sourceStorageId, $this->connection->escapeLikeParameter($sourcePath) . '/%']); |
|
| 523 | + $childEntries = $result->fetchAll(); |
|
| 524 | + $sourceLength = strlen($sourcePath); |
|
| 525 | + $this->connection->beginTransaction(); |
|
| 526 | + $query = $this->connection->prepare('UPDATE `*PREFIX*filecache` SET `storage` = ?, `path` = ?, `path_hash` = ? WHERE `fileid` = ?'); |
|
| 527 | + |
|
| 528 | + foreach ($childEntries as $child) { |
|
| 529 | + $newTargetPath = $targetPath . substr($child['path'], $sourceLength); |
|
| 530 | + $query->execute([$targetStorageId, $newTargetPath, md5($newTargetPath), $child['fileid']]); |
|
| 531 | + } |
|
| 532 | + $this->connection->executeQuery($moveSql, [$targetStorageId, $targetPath, md5($targetPath), basename($targetPath), $newParentId, $sourceId]); |
|
| 533 | + $this->connection->commit(); |
|
| 534 | + } else { |
|
| 535 | + $this->connection->executeQuery($moveSql, [$targetStorageId, $targetPath, md5($targetPath), basename($targetPath), $newParentId, $sourceId]); |
|
| 536 | + } |
|
| 537 | + } else { |
|
| 538 | + $this->moveFromCacheFallback($sourceCache, $sourcePath, $targetPath); |
|
| 539 | + } |
|
| 540 | + } |
|
| 541 | + |
|
| 542 | + /** |
|
| 543 | + * remove all entries for files that are stored on the storage from the cache |
|
| 544 | + */ |
|
| 545 | + public function clear() { |
|
| 546 | + $sql = 'DELETE FROM `*PREFIX*filecache` WHERE `storage` = ?'; |
|
| 547 | + $this->connection->executeQuery($sql, array($this->getNumericStorageId())); |
|
| 548 | + |
|
| 549 | + $sql = 'DELETE FROM `*PREFIX*storages` WHERE `id` = ?'; |
|
| 550 | + $this->connection->executeQuery($sql, array($this->storageId)); |
|
| 551 | + } |
|
| 552 | + |
|
| 553 | + /** |
|
| 554 | + * Get the scan status of a file |
|
| 555 | + * |
|
| 556 | + * - Cache::NOT_FOUND: File is not in the cache |
|
| 557 | + * - Cache::PARTIAL: File is not stored in the cache but some incomplete data is known |
|
| 558 | + * - Cache::SHALLOW: The folder and it's direct children are in the cache but not all sub folders are fully scanned |
|
| 559 | + * - Cache::COMPLETE: The file or folder, with all it's children) are fully scanned |
|
| 560 | + * |
|
| 561 | + * @param string $file |
|
| 562 | + * |
|
| 563 | + * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE |
|
| 564 | + */ |
|
| 565 | + public function getStatus($file) { |
|
| 566 | + // normalize file |
|
| 567 | + $file = $this->normalize($file); |
|
| 568 | + |
|
| 569 | + $pathHash = md5($file); |
|
| 570 | + $sql = 'SELECT `size` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path_hash` = ?'; |
|
| 571 | + $result = $this->connection->executeQuery($sql, array($this->getNumericStorageId(), $pathHash)); |
|
| 572 | + if ($row = $result->fetch()) { |
|
| 573 | + if ((int)$row['size'] === -1) { |
|
| 574 | + return self::SHALLOW; |
|
| 575 | + } else { |
|
| 576 | + return self::COMPLETE; |
|
| 577 | + } |
|
| 578 | + } else { |
|
| 579 | + if (isset($this->partial[$file])) { |
|
| 580 | + return self::PARTIAL; |
|
| 581 | + } else { |
|
| 582 | + return self::NOT_FOUND; |
|
| 583 | + } |
|
| 584 | + } |
|
| 585 | + } |
|
| 586 | + |
|
| 587 | + /** |
|
| 588 | + * search for files matching $pattern |
|
| 589 | + * |
|
| 590 | + * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%') |
|
| 591 | + * @return ICacheEntry[] an array of cache entries where the name matches the search pattern |
|
| 592 | + */ |
|
| 593 | + public function search($pattern) { |
|
| 594 | + // normalize pattern |
|
| 595 | + $pattern = $this->normalize($pattern); |
|
| 596 | + |
|
| 597 | + |
|
| 598 | + $sql = ' |
|
| 599 | 599 | SELECT `fileid`, `storage`, `path`, `parent`, `name`, |
| 600 | 600 | `mimetype`, `storage_mtime`, `mimepart`, `size`, `mtime`, |
| 601 | 601 | `encrypted`, `etag`, `permissions`, `checksum` |
| 602 | 602 | FROM `*PREFIX*filecache` |
| 603 | 603 | WHERE `storage` = ? AND `name` ILIKE ?'; |
| 604 | - $result = $this->connection->executeQuery($sql, |
|
| 605 | - [$this->getNumericStorageId(), $pattern] |
|
| 606 | - ); |
|
| 607 | - |
|
| 608 | - return $this->searchResultToCacheEntries($result); |
|
| 609 | - } |
|
| 610 | - |
|
| 611 | - /** |
|
| 612 | - * @param Statement $result |
|
| 613 | - * @return CacheEntry[] |
|
| 614 | - */ |
|
| 615 | - private function searchResultToCacheEntries(Statement $result) { |
|
| 616 | - $files = $result->fetchAll(); |
|
| 617 | - |
|
| 618 | - return array_map(function (array $data) { |
|
| 619 | - return self::cacheEntryFromData($data, $this->mimetypeLoader); |
|
| 620 | - }, $files); |
|
| 621 | - } |
|
| 622 | - |
|
| 623 | - /** |
|
| 624 | - * search for files by mimetype |
|
| 625 | - * |
|
| 626 | - * @param string $mimetype either a full mimetype to search ('text/plain') or only the first part of a mimetype ('image') |
|
| 627 | - * where it will search for all mimetypes in the group ('image/*') |
|
| 628 | - * @return ICacheEntry[] an array of cache entries where the mimetype matches the search |
|
| 629 | - */ |
|
| 630 | - public function searchByMime($mimetype) { |
|
| 631 | - if (strpos($mimetype, '/')) { |
|
| 632 | - $where = '`mimetype` = ?'; |
|
| 633 | - } else { |
|
| 634 | - $where = '`mimepart` = ?'; |
|
| 635 | - } |
|
| 636 | - $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `storage_mtime`, `mtime`, `encrypted`, `etag`, `permissions`, `checksum` |
|
| 604 | + $result = $this->connection->executeQuery($sql, |
|
| 605 | + [$this->getNumericStorageId(), $pattern] |
|
| 606 | + ); |
|
| 607 | + |
|
| 608 | + return $this->searchResultToCacheEntries($result); |
|
| 609 | + } |
|
| 610 | + |
|
| 611 | + /** |
|
| 612 | + * @param Statement $result |
|
| 613 | + * @return CacheEntry[] |
|
| 614 | + */ |
|
| 615 | + private function searchResultToCacheEntries(Statement $result) { |
|
| 616 | + $files = $result->fetchAll(); |
|
| 617 | + |
|
| 618 | + return array_map(function (array $data) { |
|
| 619 | + return self::cacheEntryFromData($data, $this->mimetypeLoader); |
|
| 620 | + }, $files); |
|
| 621 | + } |
|
| 622 | + |
|
| 623 | + /** |
|
| 624 | + * search for files by mimetype |
|
| 625 | + * |
|
| 626 | + * @param string $mimetype either a full mimetype to search ('text/plain') or only the first part of a mimetype ('image') |
|
| 627 | + * where it will search for all mimetypes in the group ('image/*') |
|
| 628 | + * @return ICacheEntry[] an array of cache entries where the mimetype matches the search |
|
| 629 | + */ |
|
| 630 | + public function searchByMime($mimetype) { |
|
| 631 | + if (strpos($mimetype, '/')) { |
|
| 632 | + $where = '`mimetype` = ?'; |
|
| 633 | + } else { |
|
| 634 | + $where = '`mimepart` = ?'; |
|
| 635 | + } |
|
| 636 | + $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `storage_mtime`, `mtime`, `encrypted`, `etag`, `permissions`, `checksum` |
|
| 637 | 637 | FROM `*PREFIX*filecache` WHERE ' . $where . ' AND `storage` = ?'; |
| 638 | - $mimetype = $this->mimetypeLoader->getId($mimetype); |
|
| 639 | - $result = $this->connection->executeQuery($sql, array($mimetype, $this->getNumericStorageId())); |
|
| 640 | - |
|
| 641 | - return $this->searchResultToCacheEntries($result); |
|
| 642 | - } |
|
| 643 | - |
|
| 644 | - public function searchQuery(ISearchQuery $searchQuery) { |
|
| 645 | - $builder = \OC::$server->getDatabaseConnection()->getQueryBuilder(); |
|
| 646 | - |
|
| 647 | - $query = $builder->select(['fileid', 'storage', 'path', 'parent', 'name', 'mimetype', 'mimepart', 'size', 'mtime', 'storage_mtime', 'encrypted', 'etag', 'permissions', 'checksum']) |
|
| 648 | - ->from('filecache') |
|
| 649 | - ->where($builder->expr()->eq('storage', $builder->createNamedParameter($this->getNumericStorageId()))) |
|
| 650 | - ->andWhere($this->querySearchHelper->searchOperatorToDBExpr($builder, $searchQuery->getSearchOperation())); |
|
| 651 | - |
|
| 652 | - if ($searchQuery->getLimit()) { |
|
| 653 | - $query->setMaxResults($searchQuery->getLimit()); |
|
| 654 | - } |
|
| 655 | - if ($searchQuery->getOffset()) { |
|
| 656 | - $query->setFirstResult($searchQuery->getOffset()); |
|
| 657 | - } |
|
| 658 | - |
|
| 659 | - $result = $query->execute(); |
|
| 660 | - return $this->searchResultToCacheEntries($result); |
|
| 661 | - } |
|
| 662 | - |
|
| 663 | - /** |
|
| 664 | - * Search for files by tag of a given users. |
|
| 665 | - * |
|
| 666 | - * Note that every user can tag files differently. |
|
| 667 | - * |
|
| 668 | - * @param string|int $tag name or tag id |
|
| 669 | - * @param string $userId owner of the tags |
|
| 670 | - * @return ICacheEntry[] file data |
|
| 671 | - */ |
|
| 672 | - public function searchByTag($tag, $userId) { |
|
| 673 | - $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, ' . |
|
| 674 | - '`mimetype`, `mimepart`, `size`, `mtime`, `storage_mtime`, ' . |
|
| 675 | - '`encrypted`, `etag`, `permissions`, `checksum` ' . |
|
| 676 | - 'FROM `*PREFIX*filecache` `file`, ' . |
|
| 677 | - '`*PREFIX*vcategory_to_object` `tagmap`, ' . |
|
| 678 | - '`*PREFIX*vcategory` `tag` ' . |
|
| 679 | - // JOIN filecache to vcategory_to_object |
|
| 680 | - 'WHERE `file`.`fileid` = `tagmap`.`objid` ' . |
|
| 681 | - // JOIN vcategory_to_object to vcategory |
|
| 682 | - 'AND `tagmap`.`type` = `tag`.`type` ' . |
|
| 683 | - 'AND `tagmap`.`categoryid` = `tag`.`id` ' . |
|
| 684 | - // conditions |
|
| 685 | - 'AND `file`.`storage` = ? ' . |
|
| 686 | - 'AND `tag`.`type` = \'files\' ' . |
|
| 687 | - 'AND `tag`.`uid` = ? '; |
|
| 688 | - if (is_int($tag)) { |
|
| 689 | - $sql .= 'AND `tag`.`id` = ? '; |
|
| 690 | - } else { |
|
| 691 | - $sql .= 'AND `tag`.`category` = ? '; |
|
| 692 | - } |
|
| 693 | - $result = $this->connection->executeQuery( |
|
| 694 | - $sql, |
|
| 695 | - [ |
|
| 696 | - $this->getNumericStorageId(), |
|
| 697 | - $userId, |
|
| 698 | - $tag |
|
| 699 | - ] |
|
| 700 | - ); |
|
| 701 | - |
|
| 702 | - $files = $result->fetchAll(); |
|
| 703 | - |
|
| 704 | - return array_map(function (array $data) { |
|
| 705 | - return self::cacheEntryFromData($data, $this->mimetypeLoader); |
|
| 706 | - }, $files); |
|
| 707 | - } |
|
| 708 | - |
|
| 709 | - /** |
|
| 710 | - * Re-calculate the folder size and the size of all parent folders |
|
| 711 | - * |
|
| 712 | - * @param string|boolean $path |
|
| 713 | - * @param array $data (optional) meta data of the folder |
|
| 714 | - */ |
|
| 715 | - public function correctFolderSize($path, $data = null) { |
|
| 716 | - $this->calculateFolderSize($path, $data); |
|
| 717 | - if ($path !== '') { |
|
| 718 | - $parent = dirname($path); |
|
| 719 | - if ($parent === '.' or $parent === '/') { |
|
| 720 | - $parent = ''; |
|
| 721 | - } |
|
| 722 | - $this->correctFolderSize($parent); |
|
| 723 | - } |
|
| 724 | - } |
|
| 725 | - |
|
| 726 | - /** |
|
| 727 | - * calculate the size of a folder and set it in the cache |
|
| 728 | - * |
|
| 729 | - * @param string $path |
|
| 730 | - * @param array $entry (optional) meta data of the folder |
|
| 731 | - * @return int |
|
| 732 | - */ |
|
| 733 | - public function calculateFolderSize($path, $entry = null) { |
|
| 734 | - $totalSize = 0; |
|
| 735 | - if (is_null($entry) or !isset($entry['fileid'])) { |
|
| 736 | - $entry = $this->get($path); |
|
| 737 | - } |
|
| 738 | - if (isset($entry['mimetype']) && $entry['mimetype'] === 'httpd/unix-directory') { |
|
| 739 | - $id = $entry['fileid']; |
|
| 740 | - $sql = 'SELECT SUM(`size`) AS f1, MIN(`size`) AS f2 ' . |
|
| 741 | - 'FROM `*PREFIX*filecache` ' . |
|
| 742 | - 'WHERE `parent` = ? AND `storage` = ?'; |
|
| 743 | - $result = $this->connection->executeQuery($sql, array($id, $this->getNumericStorageId())); |
|
| 744 | - if ($row = $result->fetch()) { |
|
| 745 | - $result->closeCursor(); |
|
| 746 | - list($sum, $min) = array_values($row); |
|
| 747 | - $sum = 0 + $sum; |
|
| 748 | - $min = 0 + $min; |
|
| 749 | - if ($min === -1) { |
|
| 750 | - $totalSize = $min; |
|
| 751 | - } else { |
|
| 752 | - $totalSize = $sum; |
|
| 753 | - } |
|
| 754 | - $update = array(); |
|
| 755 | - if ($entry['size'] !== $totalSize) { |
|
| 756 | - $update['size'] = $totalSize; |
|
| 757 | - } |
|
| 758 | - if (count($update) > 0) { |
|
| 759 | - $this->update($id, $update); |
|
| 760 | - } |
|
| 761 | - } else { |
|
| 762 | - $result->closeCursor(); |
|
| 763 | - } |
|
| 764 | - } |
|
| 765 | - return $totalSize; |
|
| 766 | - } |
|
| 767 | - |
|
| 768 | - /** |
|
| 769 | - * get all file ids on the files on the storage |
|
| 770 | - * |
|
| 771 | - * @return int[] |
|
| 772 | - */ |
|
| 773 | - public function getAll() { |
|
| 774 | - $sql = 'SELECT `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ?'; |
|
| 775 | - $result = $this->connection->executeQuery($sql, array($this->getNumericStorageId())); |
|
| 776 | - $ids = array(); |
|
| 777 | - while ($row = $result->fetch()) { |
|
| 778 | - $ids[] = $row['fileid']; |
|
| 779 | - } |
|
| 780 | - return $ids; |
|
| 781 | - } |
|
| 782 | - |
|
| 783 | - /** |
|
| 784 | - * find a folder in the cache which has not been fully scanned |
|
| 785 | - * |
|
| 786 | - * If multiple incomplete folders are in the cache, the one with the highest id will be returned, |
|
| 787 | - * use the one with the highest id gives the best result with the background scanner, since that is most |
|
| 788 | - * likely the folder where we stopped scanning previously |
|
| 789 | - * |
|
| 790 | - * @return string|bool the path of the folder or false when no folder matched |
|
| 791 | - */ |
|
| 792 | - public function getIncomplete() { |
|
| 793 | - $query = $this->connection->prepare('SELECT `path` FROM `*PREFIX*filecache`' |
|
| 794 | - . ' WHERE `storage` = ? AND `size` = -1 ORDER BY `fileid` DESC', 1); |
|
| 795 | - $query->execute([$this->getNumericStorageId()]); |
|
| 796 | - if ($row = $query->fetch()) { |
|
| 797 | - return $row['path']; |
|
| 798 | - } else { |
|
| 799 | - return false; |
|
| 800 | - } |
|
| 801 | - } |
|
| 802 | - |
|
| 803 | - /** |
|
| 804 | - * get the path of a file on this storage by it's file id |
|
| 805 | - * |
|
| 806 | - * @param int $id the file id of the file or folder to search |
|
| 807 | - * @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 |
|
| 808 | - */ |
|
| 809 | - public function getPathById($id) { |
|
| 810 | - $sql = 'SELECT `path` FROM `*PREFIX*filecache` WHERE `fileid` = ? AND `storage` = ?'; |
|
| 811 | - $result = $this->connection->executeQuery($sql, array($id, $this->getNumericStorageId())); |
|
| 812 | - if ($row = $result->fetch()) { |
|
| 813 | - // Oracle stores empty strings as null... |
|
| 814 | - if ($row['path'] === null) { |
|
| 815 | - return ''; |
|
| 816 | - } |
|
| 817 | - return $row['path']; |
|
| 818 | - } else { |
|
| 819 | - return null; |
|
| 820 | - } |
|
| 821 | - } |
|
| 822 | - |
|
| 823 | - /** |
|
| 824 | - * get the storage id of the storage for a file and the internal path of the file |
|
| 825 | - * unlike getPathById this does not limit the search to files on this storage and |
|
| 826 | - * instead does a global search in the cache table |
|
| 827 | - * |
|
| 828 | - * @param int $id |
|
| 829 | - * @deprecated use getPathById() instead |
|
| 830 | - * @return array first element holding the storage id, second the path |
|
| 831 | - */ |
|
| 832 | - static public function getById($id) { |
|
| 833 | - $connection = \OC::$server->getDatabaseConnection(); |
|
| 834 | - $sql = 'SELECT `storage`, `path` FROM `*PREFIX*filecache` WHERE `fileid` = ?'; |
|
| 835 | - $result = $connection->executeQuery($sql, array($id)); |
|
| 836 | - if ($row = $result->fetch()) { |
|
| 837 | - $numericId = $row['storage']; |
|
| 838 | - $path = $row['path']; |
|
| 839 | - } else { |
|
| 840 | - return null; |
|
| 841 | - } |
|
| 842 | - |
|
| 843 | - if ($id = Storage::getStorageId($numericId)) { |
|
| 844 | - return array($id, $path); |
|
| 845 | - } else { |
|
| 846 | - return null; |
|
| 847 | - } |
|
| 848 | - } |
|
| 849 | - |
|
| 850 | - /** |
|
| 851 | - * normalize the given path |
|
| 852 | - * |
|
| 853 | - * @param string $path |
|
| 854 | - * @return string |
|
| 855 | - */ |
|
| 856 | - public function normalize($path) { |
|
| 857 | - |
|
| 858 | - return trim(\OC_Util::normalizeUnicode($path), '/'); |
|
| 859 | - } |
|
| 638 | + $mimetype = $this->mimetypeLoader->getId($mimetype); |
|
| 639 | + $result = $this->connection->executeQuery($sql, array($mimetype, $this->getNumericStorageId())); |
|
| 640 | + |
|
| 641 | + return $this->searchResultToCacheEntries($result); |
|
| 642 | + } |
|
| 643 | + |
|
| 644 | + public function searchQuery(ISearchQuery $searchQuery) { |
|
| 645 | + $builder = \OC::$server->getDatabaseConnection()->getQueryBuilder(); |
|
| 646 | + |
|
| 647 | + $query = $builder->select(['fileid', 'storage', 'path', 'parent', 'name', 'mimetype', 'mimepart', 'size', 'mtime', 'storage_mtime', 'encrypted', 'etag', 'permissions', 'checksum']) |
|
| 648 | + ->from('filecache') |
|
| 649 | + ->where($builder->expr()->eq('storage', $builder->createNamedParameter($this->getNumericStorageId()))) |
|
| 650 | + ->andWhere($this->querySearchHelper->searchOperatorToDBExpr($builder, $searchQuery->getSearchOperation())); |
|
| 651 | + |
|
| 652 | + if ($searchQuery->getLimit()) { |
|
| 653 | + $query->setMaxResults($searchQuery->getLimit()); |
|
| 654 | + } |
|
| 655 | + if ($searchQuery->getOffset()) { |
|
| 656 | + $query->setFirstResult($searchQuery->getOffset()); |
|
| 657 | + } |
|
| 658 | + |
|
| 659 | + $result = $query->execute(); |
|
| 660 | + return $this->searchResultToCacheEntries($result); |
|
| 661 | + } |
|
| 662 | + |
|
| 663 | + /** |
|
| 664 | + * Search for files by tag of a given users. |
|
| 665 | + * |
|
| 666 | + * Note that every user can tag files differently. |
|
| 667 | + * |
|
| 668 | + * @param string|int $tag name or tag id |
|
| 669 | + * @param string $userId owner of the tags |
|
| 670 | + * @return ICacheEntry[] file data |
|
| 671 | + */ |
|
| 672 | + public function searchByTag($tag, $userId) { |
|
| 673 | + $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, ' . |
|
| 674 | + '`mimetype`, `mimepart`, `size`, `mtime`, `storage_mtime`, ' . |
|
| 675 | + '`encrypted`, `etag`, `permissions`, `checksum` ' . |
|
| 676 | + 'FROM `*PREFIX*filecache` `file`, ' . |
|
| 677 | + '`*PREFIX*vcategory_to_object` `tagmap`, ' . |
|
| 678 | + '`*PREFIX*vcategory` `tag` ' . |
|
| 679 | + // JOIN filecache to vcategory_to_object |
|
| 680 | + 'WHERE `file`.`fileid` = `tagmap`.`objid` ' . |
|
| 681 | + // JOIN vcategory_to_object to vcategory |
|
| 682 | + 'AND `tagmap`.`type` = `tag`.`type` ' . |
|
| 683 | + 'AND `tagmap`.`categoryid` = `tag`.`id` ' . |
|
| 684 | + // conditions |
|
| 685 | + 'AND `file`.`storage` = ? ' . |
|
| 686 | + 'AND `tag`.`type` = \'files\' ' . |
|
| 687 | + 'AND `tag`.`uid` = ? '; |
|
| 688 | + if (is_int($tag)) { |
|
| 689 | + $sql .= 'AND `tag`.`id` = ? '; |
|
| 690 | + } else { |
|
| 691 | + $sql .= 'AND `tag`.`category` = ? '; |
|
| 692 | + } |
|
| 693 | + $result = $this->connection->executeQuery( |
|
| 694 | + $sql, |
|
| 695 | + [ |
|
| 696 | + $this->getNumericStorageId(), |
|
| 697 | + $userId, |
|
| 698 | + $tag |
|
| 699 | + ] |
|
| 700 | + ); |
|
| 701 | + |
|
| 702 | + $files = $result->fetchAll(); |
|
| 703 | + |
|
| 704 | + return array_map(function (array $data) { |
|
| 705 | + return self::cacheEntryFromData($data, $this->mimetypeLoader); |
|
| 706 | + }, $files); |
|
| 707 | + } |
|
| 708 | + |
|
| 709 | + /** |
|
| 710 | + * Re-calculate the folder size and the size of all parent folders |
|
| 711 | + * |
|
| 712 | + * @param string|boolean $path |
|
| 713 | + * @param array $data (optional) meta data of the folder |
|
| 714 | + */ |
|
| 715 | + public function correctFolderSize($path, $data = null) { |
|
| 716 | + $this->calculateFolderSize($path, $data); |
|
| 717 | + if ($path !== '') { |
|
| 718 | + $parent = dirname($path); |
|
| 719 | + if ($parent === '.' or $parent === '/') { |
|
| 720 | + $parent = ''; |
|
| 721 | + } |
|
| 722 | + $this->correctFolderSize($parent); |
|
| 723 | + } |
|
| 724 | + } |
|
| 725 | + |
|
| 726 | + /** |
|
| 727 | + * calculate the size of a folder and set it in the cache |
|
| 728 | + * |
|
| 729 | + * @param string $path |
|
| 730 | + * @param array $entry (optional) meta data of the folder |
|
| 731 | + * @return int |
|
| 732 | + */ |
|
| 733 | + public function calculateFolderSize($path, $entry = null) { |
|
| 734 | + $totalSize = 0; |
|
| 735 | + if (is_null($entry) or !isset($entry['fileid'])) { |
|
| 736 | + $entry = $this->get($path); |
|
| 737 | + } |
|
| 738 | + if (isset($entry['mimetype']) && $entry['mimetype'] === 'httpd/unix-directory') { |
|
| 739 | + $id = $entry['fileid']; |
|
| 740 | + $sql = 'SELECT SUM(`size`) AS f1, MIN(`size`) AS f2 ' . |
|
| 741 | + 'FROM `*PREFIX*filecache` ' . |
|
| 742 | + 'WHERE `parent` = ? AND `storage` = ?'; |
|
| 743 | + $result = $this->connection->executeQuery($sql, array($id, $this->getNumericStorageId())); |
|
| 744 | + if ($row = $result->fetch()) { |
|
| 745 | + $result->closeCursor(); |
|
| 746 | + list($sum, $min) = array_values($row); |
|
| 747 | + $sum = 0 + $sum; |
|
| 748 | + $min = 0 + $min; |
|
| 749 | + if ($min === -1) { |
|
| 750 | + $totalSize = $min; |
|
| 751 | + } else { |
|
| 752 | + $totalSize = $sum; |
|
| 753 | + } |
|
| 754 | + $update = array(); |
|
| 755 | + if ($entry['size'] !== $totalSize) { |
|
| 756 | + $update['size'] = $totalSize; |
|
| 757 | + } |
|
| 758 | + if (count($update) > 0) { |
|
| 759 | + $this->update($id, $update); |
|
| 760 | + } |
|
| 761 | + } else { |
|
| 762 | + $result->closeCursor(); |
|
| 763 | + } |
|
| 764 | + } |
|
| 765 | + return $totalSize; |
|
| 766 | + } |
|
| 767 | + |
|
| 768 | + /** |
|
| 769 | + * get all file ids on the files on the storage |
|
| 770 | + * |
|
| 771 | + * @return int[] |
|
| 772 | + */ |
|
| 773 | + public function getAll() { |
|
| 774 | + $sql = 'SELECT `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ?'; |
|
| 775 | + $result = $this->connection->executeQuery($sql, array($this->getNumericStorageId())); |
|
| 776 | + $ids = array(); |
|
| 777 | + while ($row = $result->fetch()) { |
|
| 778 | + $ids[] = $row['fileid']; |
|
| 779 | + } |
|
| 780 | + return $ids; |
|
| 781 | + } |
|
| 782 | + |
|
| 783 | + /** |
|
| 784 | + * find a folder in the cache which has not been fully scanned |
|
| 785 | + * |
|
| 786 | + * If multiple incomplete folders are in the cache, the one with the highest id will be returned, |
|
| 787 | + * use the one with the highest id gives the best result with the background scanner, since that is most |
|
| 788 | + * likely the folder where we stopped scanning previously |
|
| 789 | + * |
|
| 790 | + * @return string|bool the path of the folder or false when no folder matched |
|
| 791 | + */ |
|
| 792 | + public function getIncomplete() { |
|
| 793 | + $query = $this->connection->prepare('SELECT `path` FROM `*PREFIX*filecache`' |
|
| 794 | + . ' WHERE `storage` = ? AND `size` = -1 ORDER BY `fileid` DESC', 1); |
|
| 795 | + $query->execute([$this->getNumericStorageId()]); |
|
| 796 | + if ($row = $query->fetch()) { |
|
| 797 | + return $row['path']; |
|
| 798 | + } else { |
|
| 799 | + return false; |
|
| 800 | + } |
|
| 801 | + } |
|
| 802 | + |
|
| 803 | + /** |
|
| 804 | + * get the path of a file on this storage by it's file id |
|
| 805 | + * |
|
| 806 | + * @param int $id the file id of the file or folder to search |
|
| 807 | + * @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 |
|
| 808 | + */ |
|
| 809 | + public function getPathById($id) { |
|
| 810 | + $sql = 'SELECT `path` FROM `*PREFIX*filecache` WHERE `fileid` = ? AND `storage` = ?'; |
|
| 811 | + $result = $this->connection->executeQuery($sql, array($id, $this->getNumericStorageId())); |
|
| 812 | + if ($row = $result->fetch()) { |
|
| 813 | + // Oracle stores empty strings as null... |
|
| 814 | + if ($row['path'] === null) { |
|
| 815 | + return ''; |
|
| 816 | + } |
|
| 817 | + return $row['path']; |
|
| 818 | + } else { |
|
| 819 | + return null; |
|
| 820 | + } |
|
| 821 | + } |
|
| 822 | + |
|
| 823 | + /** |
|
| 824 | + * get the storage id of the storage for a file and the internal path of the file |
|
| 825 | + * unlike getPathById this does not limit the search to files on this storage and |
|
| 826 | + * instead does a global search in the cache table |
|
| 827 | + * |
|
| 828 | + * @param int $id |
|
| 829 | + * @deprecated use getPathById() instead |
|
| 830 | + * @return array first element holding the storage id, second the path |
|
| 831 | + */ |
|
| 832 | + static public function getById($id) { |
|
| 833 | + $connection = \OC::$server->getDatabaseConnection(); |
|
| 834 | + $sql = 'SELECT `storage`, `path` FROM `*PREFIX*filecache` WHERE `fileid` = ?'; |
|
| 835 | + $result = $connection->executeQuery($sql, array($id)); |
|
| 836 | + if ($row = $result->fetch()) { |
|
| 837 | + $numericId = $row['storage']; |
|
| 838 | + $path = $row['path']; |
|
| 839 | + } else { |
|
| 840 | + return null; |
|
| 841 | + } |
|
| 842 | + |
|
| 843 | + if ($id = Storage::getStorageId($numericId)) { |
|
| 844 | + return array($id, $path); |
|
| 845 | + } else { |
|
| 846 | + return null; |
|
| 847 | + } |
|
| 848 | + } |
|
| 849 | + |
|
| 850 | + /** |
|
| 851 | + * normalize the given path |
|
| 852 | + * |
|
| 853 | + * @param string $path |
|
| 854 | + * @return string |
|
| 855 | + */ |
|
| 856 | + public function normalize($path) { |
|
| 857 | + |
|
| 858 | + return trim(\OC_Util::normalizeUnicode($path), '/'); |
|
| 859 | + } |
|
| 860 | 860 | } |