@@ -110,7 +110,7 @@ |
||
110 | 110 | * check if it is a file located in data/user/files only files in the |
111 | 111 | * 'files' directory should be moved to the trash |
112 | 112 | * |
113 | - * @param $path |
|
113 | + * @param string $path |
|
114 | 114 | * @return bool |
115 | 115 | */ |
116 | 116 | protected function shouldMoveToTrash($path){ |
@@ -34,244 +34,244 @@ |
||
34 | 34 | |
35 | 35 | class Storage extends Wrapper { |
36 | 36 | |
37 | - private $mountPoint; |
|
38 | - // remember already deleted files to avoid infinite loops if the trash bin |
|
39 | - // move files across storages |
|
40 | - private $deletedFiles = array(); |
|
41 | - |
|
42 | - /** |
|
43 | - * Disable trash logic |
|
44 | - * |
|
45 | - * @var bool |
|
46 | - */ |
|
47 | - private static $disableTrash = false; |
|
48 | - |
|
49 | - /** |
|
50 | - * remember which file/folder was moved out of s shared folder |
|
51 | - * in this case we want to add a copy to the owners trash bin |
|
52 | - * |
|
53 | - * @var array |
|
54 | - */ |
|
55 | - private static $moveOutOfSharedFolder = []; |
|
56 | - |
|
57 | - /** @var IUserManager */ |
|
58 | - private $userManager; |
|
59 | - |
|
60 | - /** @var ILogger */ |
|
61 | - private $logger; |
|
62 | - |
|
63 | - /** |
|
64 | - * Storage constructor. |
|
65 | - * |
|
66 | - * @param array $parameters |
|
67 | - * @param IUserManager|null $userManager |
|
68 | - */ |
|
69 | - public function __construct($parameters, |
|
70 | - IUserManager $userManager = null, |
|
71 | - ILogger $logger = null) { |
|
72 | - $this->mountPoint = $parameters['mountPoint']; |
|
73 | - $this->userManager = $userManager; |
|
74 | - $this->logger = $logger; |
|
75 | - parent::__construct($parameters); |
|
76 | - } |
|
77 | - |
|
78 | - /** |
|
79 | - * @internal |
|
80 | - */ |
|
81 | - public static function preRenameHook($params) { |
|
82 | - // in cross-storage cases, a rename is a copy + unlink, |
|
83 | - // that last unlink must not go to trash, only exception: |
|
84 | - // if the file was moved from a shared storage to a local folder, |
|
85 | - // in this case the owner should get a copy in his trash bin so that |
|
86 | - // they can restore the files again |
|
87 | - |
|
88 | - $oldPath = $params['oldpath']; |
|
89 | - $newPath = dirname($params['newpath']); |
|
90 | - $currentUser = \OC::$server->getUserSession()->getUser(); |
|
91 | - |
|
92 | - $fileMovedOutOfSharedFolder = false; |
|
93 | - |
|
94 | - try { |
|
95 | - if ($currentUser) { |
|
96 | - $currentUserId = $currentUser->getUID(); |
|
97 | - |
|
98 | - $view = new View($currentUserId . '/files'); |
|
99 | - $fileInfo = $view->getFileInfo($oldPath); |
|
100 | - if ($fileInfo) { |
|
101 | - $sourceStorage = $fileInfo->getStorage(); |
|
102 | - $sourceOwner = $view->getOwner($oldPath); |
|
103 | - $targetOwner = $view->getOwner($newPath); |
|
104 | - |
|
105 | - if ($sourceOwner !== $targetOwner |
|
106 | - && $sourceStorage->instanceOfStorage('OCA\Files_Sharing\SharedStorage') |
|
107 | - ) { |
|
108 | - $fileMovedOutOfSharedFolder = true; |
|
109 | - } |
|
110 | - } |
|
111 | - } |
|
112 | - } catch (\Exception $e) { |
|
113 | - // do nothing, in this case we just disable the trashbin and continue |
|
114 | - $logger = \OC::$server->getLogger(); |
|
115 | - $logger->debug('Trashbin storage could not check if a file was moved out of a shared folder: ' . $e->getMessage()); |
|
116 | - } |
|
117 | - |
|
118 | - if($fileMovedOutOfSharedFolder) { |
|
119 | - self::$moveOutOfSharedFolder['/' . $currentUserId . '/files' . $oldPath] = true; |
|
120 | - } else { |
|
121 | - self::$disableTrash = true; |
|
122 | - } |
|
123 | - |
|
124 | - } |
|
125 | - |
|
126 | - /** |
|
127 | - * @internal |
|
128 | - */ |
|
129 | - public static function postRenameHook($params) { |
|
130 | - self::$disableTrash = false; |
|
131 | - } |
|
132 | - |
|
133 | - /** |
|
134 | - * Rename path1 to path2 by calling the wrapped storage. |
|
135 | - * |
|
136 | - * @param string $path1 first path |
|
137 | - * @param string $path2 second path |
|
138 | - * @return bool |
|
139 | - */ |
|
140 | - public function rename($path1, $path2) { |
|
141 | - $result = $this->storage->rename($path1, $path2); |
|
142 | - if ($result === false) { |
|
143 | - // when rename failed, the post_rename hook isn't triggered, |
|
144 | - // but we still want to reenable the trash logic |
|
145 | - self::$disableTrash = false; |
|
146 | - } |
|
147 | - return $result; |
|
148 | - } |
|
149 | - |
|
150 | - /** |
|
151 | - * Deletes the given file by moving it into the trashbin. |
|
152 | - * |
|
153 | - * @param string $path path of file or folder to delete |
|
154 | - * |
|
155 | - * @return bool true if the operation succeeded, false otherwise |
|
156 | - */ |
|
157 | - public function unlink($path) { |
|
158 | - try { |
|
159 | - if (isset(self::$moveOutOfSharedFolder[$this->mountPoint . $path])) { |
|
160 | - $result = $this->doDelete($path, 'unlink', true); |
|
161 | - unset(self::$moveOutOfSharedFolder[$this->mountPoint . $path]); |
|
162 | - } else { |
|
163 | - $result = $this->doDelete($path, 'unlink'); |
|
164 | - } |
|
165 | - } catch (GenericEncryptionException $e) { |
|
166 | - // in case of a encryption exception we delete the file right away |
|
167 | - $this->logger->info( |
|
168 | - "Can't move file" . $path . |
|
169 | - "to the trash bin, therefore it was deleted right away"); |
|
170 | - |
|
171 | - $result = $this->storage->unlink($path); |
|
172 | - } |
|
173 | - |
|
174 | - return $result; |
|
175 | - } |
|
176 | - |
|
177 | - /** |
|
178 | - * Deletes the given folder by moving it into the trashbin. |
|
179 | - * |
|
180 | - * @param string $path path of folder to delete |
|
181 | - * |
|
182 | - * @return bool true if the operation succeeded, false otherwise |
|
183 | - */ |
|
184 | - public function rmdir($path) { |
|
185 | - if (isset(self::$moveOutOfSharedFolder[$this->mountPoint . $path])) { |
|
186 | - $result = $this->doDelete($path, 'rmdir', true); |
|
187 | - unset(self::$moveOutOfSharedFolder[$this->mountPoint . $path]); |
|
188 | - } else { |
|
189 | - $result = $this->doDelete($path, 'rmdir'); |
|
190 | - } |
|
191 | - |
|
192 | - return $result; |
|
193 | - } |
|
194 | - |
|
195 | - /** |
|
196 | - * check if it is a file located in data/user/files only files in the |
|
197 | - * 'files' directory should be moved to the trash |
|
198 | - * |
|
199 | - * @param $path |
|
200 | - * @return bool |
|
201 | - */ |
|
202 | - protected function shouldMoveToTrash($path){ |
|
203 | - $normalized = Filesystem::normalizePath($this->mountPoint . '/' . $path); |
|
204 | - $parts = explode('/', $normalized); |
|
205 | - if (count($parts) < 4) { |
|
206 | - return false; |
|
207 | - } |
|
208 | - |
|
209 | - if ($this->userManager->userExists($parts[1]) && $parts[2] == 'files') { |
|
210 | - return true; |
|
211 | - } |
|
212 | - |
|
213 | - return false; |
|
214 | - } |
|
215 | - |
|
216 | - /** |
|
217 | - * Run the delete operation with the given method |
|
218 | - * |
|
219 | - * @param string $path path of file or folder to delete |
|
220 | - * @param string $method either "unlink" or "rmdir" |
|
221 | - * @param bool $ownerOnly delete for owner only (if file gets moved out of a shared folder) |
|
222 | - * |
|
223 | - * @return bool true if the operation succeeded, false otherwise |
|
224 | - */ |
|
225 | - private function doDelete($path, $method, $ownerOnly = false) { |
|
226 | - if (self::$disableTrash |
|
227 | - || !\OC_App::isEnabled('files_trashbin') |
|
228 | - || (pathinfo($path, PATHINFO_EXTENSION) === 'part') |
|
229 | - || $this->shouldMoveToTrash($path) === false |
|
230 | - ) { |
|
231 | - return call_user_func_array([$this->storage, $method], [$path]); |
|
232 | - } |
|
233 | - |
|
234 | - // check permissions before we continue, this is especially important for |
|
235 | - // shared files |
|
236 | - if (!$this->isDeletable($path)) { |
|
237 | - return false; |
|
238 | - } |
|
239 | - |
|
240 | - $normalized = Filesystem::normalizePath($this->mountPoint . '/' . $path, true, false, true); |
|
241 | - $result = true; |
|
242 | - $view = Filesystem::getView(); |
|
243 | - if (!isset($this->deletedFiles[$normalized]) && $view instanceof View) { |
|
244 | - $this->deletedFiles[$normalized] = $normalized; |
|
245 | - if ($filesPath = $view->getRelativePath($normalized)) { |
|
246 | - $filesPath = trim($filesPath, '/'); |
|
247 | - $result = \OCA\Files_Trashbin\Trashbin::move2trash($filesPath, $ownerOnly); |
|
248 | - // in cross-storage cases the file will be copied |
|
249 | - // but not deleted, so we delete it here |
|
250 | - if ($result) { |
|
251 | - call_user_func_array([$this->storage, $method], [$path]); |
|
252 | - } |
|
253 | - } else { |
|
254 | - $result = call_user_func_array([$this->storage, $method], [$path]); |
|
255 | - } |
|
256 | - unset($this->deletedFiles[$normalized]); |
|
257 | - } else if ($this->storage->file_exists($path)) { |
|
258 | - $result = call_user_func_array([$this->storage, $method], [$path]); |
|
259 | - } |
|
260 | - |
|
261 | - return $result; |
|
262 | - } |
|
263 | - |
|
264 | - /** |
|
265 | - * Setup the storate wrapper callback |
|
266 | - */ |
|
267 | - public static function setupStorage() { |
|
268 | - \OC\Files\Filesystem::addStorageWrapper('oc_trashbin', function ($mountPoint, $storage) { |
|
269 | - return new \OCA\Files_Trashbin\Storage( |
|
270 | - array('storage' => $storage, 'mountPoint' => $mountPoint), |
|
271 | - \OC::$server->getUserManager(), |
|
272 | - \OC::$server->getLogger() |
|
273 | - ); |
|
274 | - }, 1); |
|
275 | - } |
|
37 | + private $mountPoint; |
|
38 | + // remember already deleted files to avoid infinite loops if the trash bin |
|
39 | + // move files across storages |
|
40 | + private $deletedFiles = array(); |
|
41 | + |
|
42 | + /** |
|
43 | + * Disable trash logic |
|
44 | + * |
|
45 | + * @var bool |
|
46 | + */ |
|
47 | + private static $disableTrash = false; |
|
48 | + |
|
49 | + /** |
|
50 | + * remember which file/folder was moved out of s shared folder |
|
51 | + * in this case we want to add a copy to the owners trash bin |
|
52 | + * |
|
53 | + * @var array |
|
54 | + */ |
|
55 | + private static $moveOutOfSharedFolder = []; |
|
56 | + |
|
57 | + /** @var IUserManager */ |
|
58 | + private $userManager; |
|
59 | + |
|
60 | + /** @var ILogger */ |
|
61 | + private $logger; |
|
62 | + |
|
63 | + /** |
|
64 | + * Storage constructor. |
|
65 | + * |
|
66 | + * @param array $parameters |
|
67 | + * @param IUserManager|null $userManager |
|
68 | + */ |
|
69 | + public function __construct($parameters, |
|
70 | + IUserManager $userManager = null, |
|
71 | + ILogger $logger = null) { |
|
72 | + $this->mountPoint = $parameters['mountPoint']; |
|
73 | + $this->userManager = $userManager; |
|
74 | + $this->logger = $logger; |
|
75 | + parent::__construct($parameters); |
|
76 | + } |
|
77 | + |
|
78 | + /** |
|
79 | + * @internal |
|
80 | + */ |
|
81 | + public static function preRenameHook($params) { |
|
82 | + // in cross-storage cases, a rename is a copy + unlink, |
|
83 | + // that last unlink must not go to trash, only exception: |
|
84 | + // if the file was moved from a shared storage to a local folder, |
|
85 | + // in this case the owner should get a copy in his trash bin so that |
|
86 | + // they can restore the files again |
|
87 | + |
|
88 | + $oldPath = $params['oldpath']; |
|
89 | + $newPath = dirname($params['newpath']); |
|
90 | + $currentUser = \OC::$server->getUserSession()->getUser(); |
|
91 | + |
|
92 | + $fileMovedOutOfSharedFolder = false; |
|
93 | + |
|
94 | + try { |
|
95 | + if ($currentUser) { |
|
96 | + $currentUserId = $currentUser->getUID(); |
|
97 | + |
|
98 | + $view = new View($currentUserId . '/files'); |
|
99 | + $fileInfo = $view->getFileInfo($oldPath); |
|
100 | + if ($fileInfo) { |
|
101 | + $sourceStorage = $fileInfo->getStorage(); |
|
102 | + $sourceOwner = $view->getOwner($oldPath); |
|
103 | + $targetOwner = $view->getOwner($newPath); |
|
104 | + |
|
105 | + if ($sourceOwner !== $targetOwner |
|
106 | + && $sourceStorage->instanceOfStorage('OCA\Files_Sharing\SharedStorage') |
|
107 | + ) { |
|
108 | + $fileMovedOutOfSharedFolder = true; |
|
109 | + } |
|
110 | + } |
|
111 | + } |
|
112 | + } catch (\Exception $e) { |
|
113 | + // do nothing, in this case we just disable the trashbin and continue |
|
114 | + $logger = \OC::$server->getLogger(); |
|
115 | + $logger->debug('Trashbin storage could not check if a file was moved out of a shared folder: ' . $e->getMessage()); |
|
116 | + } |
|
117 | + |
|
118 | + if($fileMovedOutOfSharedFolder) { |
|
119 | + self::$moveOutOfSharedFolder['/' . $currentUserId . '/files' . $oldPath] = true; |
|
120 | + } else { |
|
121 | + self::$disableTrash = true; |
|
122 | + } |
|
123 | + |
|
124 | + } |
|
125 | + |
|
126 | + /** |
|
127 | + * @internal |
|
128 | + */ |
|
129 | + public static function postRenameHook($params) { |
|
130 | + self::$disableTrash = false; |
|
131 | + } |
|
132 | + |
|
133 | + /** |
|
134 | + * Rename path1 to path2 by calling the wrapped storage. |
|
135 | + * |
|
136 | + * @param string $path1 first path |
|
137 | + * @param string $path2 second path |
|
138 | + * @return bool |
|
139 | + */ |
|
140 | + public function rename($path1, $path2) { |
|
141 | + $result = $this->storage->rename($path1, $path2); |
|
142 | + if ($result === false) { |
|
143 | + // when rename failed, the post_rename hook isn't triggered, |
|
144 | + // but we still want to reenable the trash logic |
|
145 | + self::$disableTrash = false; |
|
146 | + } |
|
147 | + return $result; |
|
148 | + } |
|
149 | + |
|
150 | + /** |
|
151 | + * Deletes the given file by moving it into the trashbin. |
|
152 | + * |
|
153 | + * @param string $path path of file or folder to delete |
|
154 | + * |
|
155 | + * @return bool true if the operation succeeded, false otherwise |
|
156 | + */ |
|
157 | + public function unlink($path) { |
|
158 | + try { |
|
159 | + if (isset(self::$moveOutOfSharedFolder[$this->mountPoint . $path])) { |
|
160 | + $result = $this->doDelete($path, 'unlink', true); |
|
161 | + unset(self::$moveOutOfSharedFolder[$this->mountPoint . $path]); |
|
162 | + } else { |
|
163 | + $result = $this->doDelete($path, 'unlink'); |
|
164 | + } |
|
165 | + } catch (GenericEncryptionException $e) { |
|
166 | + // in case of a encryption exception we delete the file right away |
|
167 | + $this->logger->info( |
|
168 | + "Can't move file" . $path . |
|
169 | + "to the trash bin, therefore it was deleted right away"); |
|
170 | + |
|
171 | + $result = $this->storage->unlink($path); |
|
172 | + } |
|
173 | + |
|
174 | + return $result; |
|
175 | + } |
|
176 | + |
|
177 | + /** |
|
178 | + * Deletes the given folder by moving it into the trashbin. |
|
179 | + * |
|
180 | + * @param string $path path of folder to delete |
|
181 | + * |
|
182 | + * @return bool true if the operation succeeded, false otherwise |
|
183 | + */ |
|
184 | + public function rmdir($path) { |
|
185 | + if (isset(self::$moveOutOfSharedFolder[$this->mountPoint . $path])) { |
|
186 | + $result = $this->doDelete($path, 'rmdir', true); |
|
187 | + unset(self::$moveOutOfSharedFolder[$this->mountPoint . $path]); |
|
188 | + } else { |
|
189 | + $result = $this->doDelete($path, 'rmdir'); |
|
190 | + } |
|
191 | + |
|
192 | + return $result; |
|
193 | + } |
|
194 | + |
|
195 | + /** |
|
196 | + * check if it is a file located in data/user/files only files in the |
|
197 | + * 'files' directory should be moved to the trash |
|
198 | + * |
|
199 | + * @param $path |
|
200 | + * @return bool |
|
201 | + */ |
|
202 | + protected function shouldMoveToTrash($path){ |
|
203 | + $normalized = Filesystem::normalizePath($this->mountPoint . '/' . $path); |
|
204 | + $parts = explode('/', $normalized); |
|
205 | + if (count($parts) < 4) { |
|
206 | + return false; |
|
207 | + } |
|
208 | + |
|
209 | + if ($this->userManager->userExists($parts[1]) && $parts[2] == 'files') { |
|
210 | + return true; |
|
211 | + } |
|
212 | + |
|
213 | + return false; |
|
214 | + } |
|
215 | + |
|
216 | + /** |
|
217 | + * Run the delete operation with the given method |
|
218 | + * |
|
219 | + * @param string $path path of file or folder to delete |
|
220 | + * @param string $method either "unlink" or "rmdir" |
|
221 | + * @param bool $ownerOnly delete for owner only (if file gets moved out of a shared folder) |
|
222 | + * |
|
223 | + * @return bool true if the operation succeeded, false otherwise |
|
224 | + */ |
|
225 | + private function doDelete($path, $method, $ownerOnly = false) { |
|
226 | + if (self::$disableTrash |
|
227 | + || !\OC_App::isEnabled('files_trashbin') |
|
228 | + || (pathinfo($path, PATHINFO_EXTENSION) === 'part') |
|
229 | + || $this->shouldMoveToTrash($path) === false |
|
230 | + ) { |
|
231 | + return call_user_func_array([$this->storage, $method], [$path]); |
|
232 | + } |
|
233 | + |
|
234 | + // check permissions before we continue, this is especially important for |
|
235 | + // shared files |
|
236 | + if (!$this->isDeletable($path)) { |
|
237 | + return false; |
|
238 | + } |
|
239 | + |
|
240 | + $normalized = Filesystem::normalizePath($this->mountPoint . '/' . $path, true, false, true); |
|
241 | + $result = true; |
|
242 | + $view = Filesystem::getView(); |
|
243 | + if (!isset($this->deletedFiles[$normalized]) && $view instanceof View) { |
|
244 | + $this->deletedFiles[$normalized] = $normalized; |
|
245 | + if ($filesPath = $view->getRelativePath($normalized)) { |
|
246 | + $filesPath = trim($filesPath, '/'); |
|
247 | + $result = \OCA\Files_Trashbin\Trashbin::move2trash($filesPath, $ownerOnly); |
|
248 | + // in cross-storage cases the file will be copied |
|
249 | + // but not deleted, so we delete it here |
|
250 | + if ($result) { |
|
251 | + call_user_func_array([$this->storage, $method], [$path]); |
|
252 | + } |
|
253 | + } else { |
|
254 | + $result = call_user_func_array([$this->storage, $method], [$path]); |
|
255 | + } |
|
256 | + unset($this->deletedFiles[$normalized]); |
|
257 | + } else if ($this->storage->file_exists($path)) { |
|
258 | + $result = call_user_func_array([$this->storage, $method], [$path]); |
|
259 | + } |
|
260 | + |
|
261 | + return $result; |
|
262 | + } |
|
263 | + |
|
264 | + /** |
|
265 | + * Setup the storate wrapper callback |
|
266 | + */ |
|
267 | + public static function setupStorage() { |
|
268 | + \OC\Files\Filesystem::addStorageWrapper('oc_trashbin', function ($mountPoint, $storage) { |
|
269 | + return new \OCA\Files_Trashbin\Storage( |
|
270 | + array('storage' => $storage, 'mountPoint' => $mountPoint), |
|
271 | + \OC::$server->getUserManager(), |
|
272 | + \OC::$server->getLogger() |
|
273 | + ); |
|
274 | + }, 1); |
|
275 | + } |
|
276 | 276 | |
277 | 277 | } |
@@ -95,7 +95,7 @@ discard block |
||
95 | 95 | if ($currentUser) { |
96 | 96 | $currentUserId = $currentUser->getUID(); |
97 | 97 | |
98 | - $view = new View($currentUserId . '/files'); |
|
98 | + $view = new View($currentUserId.'/files'); |
|
99 | 99 | $fileInfo = $view->getFileInfo($oldPath); |
100 | 100 | if ($fileInfo) { |
101 | 101 | $sourceStorage = $fileInfo->getStorage(); |
@@ -112,11 +112,11 @@ discard block |
||
112 | 112 | } catch (\Exception $e) { |
113 | 113 | // do nothing, in this case we just disable the trashbin and continue |
114 | 114 | $logger = \OC::$server->getLogger(); |
115 | - $logger->debug('Trashbin storage could not check if a file was moved out of a shared folder: ' . $e->getMessage()); |
|
115 | + $logger->debug('Trashbin storage could not check if a file was moved out of a shared folder: '.$e->getMessage()); |
|
116 | 116 | } |
117 | 117 | |
118 | - if($fileMovedOutOfSharedFolder) { |
|
119 | - self::$moveOutOfSharedFolder['/' . $currentUserId . '/files' . $oldPath] = true; |
|
118 | + if ($fileMovedOutOfSharedFolder) { |
|
119 | + self::$moveOutOfSharedFolder['/'.$currentUserId.'/files'.$oldPath] = true; |
|
120 | 120 | } else { |
121 | 121 | self::$disableTrash = true; |
122 | 122 | } |
@@ -156,16 +156,16 @@ discard block |
||
156 | 156 | */ |
157 | 157 | public function unlink($path) { |
158 | 158 | try { |
159 | - if (isset(self::$moveOutOfSharedFolder[$this->mountPoint . $path])) { |
|
159 | + if (isset(self::$moveOutOfSharedFolder[$this->mountPoint.$path])) { |
|
160 | 160 | $result = $this->doDelete($path, 'unlink', true); |
161 | - unset(self::$moveOutOfSharedFolder[$this->mountPoint . $path]); |
|
161 | + unset(self::$moveOutOfSharedFolder[$this->mountPoint.$path]); |
|
162 | 162 | } else { |
163 | 163 | $result = $this->doDelete($path, 'unlink'); |
164 | 164 | } |
165 | 165 | } catch (GenericEncryptionException $e) { |
166 | 166 | // in case of a encryption exception we delete the file right away |
167 | 167 | $this->logger->info( |
168 | - "Can't move file" . $path . |
|
168 | + "Can't move file".$path. |
|
169 | 169 | "to the trash bin, therefore it was deleted right away"); |
170 | 170 | |
171 | 171 | $result = $this->storage->unlink($path); |
@@ -182,9 +182,9 @@ discard block |
||
182 | 182 | * @return bool true if the operation succeeded, false otherwise |
183 | 183 | */ |
184 | 184 | public function rmdir($path) { |
185 | - if (isset(self::$moveOutOfSharedFolder[$this->mountPoint . $path])) { |
|
185 | + if (isset(self::$moveOutOfSharedFolder[$this->mountPoint.$path])) { |
|
186 | 186 | $result = $this->doDelete($path, 'rmdir', true); |
187 | - unset(self::$moveOutOfSharedFolder[$this->mountPoint . $path]); |
|
187 | + unset(self::$moveOutOfSharedFolder[$this->mountPoint.$path]); |
|
188 | 188 | } else { |
189 | 189 | $result = $this->doDelete($path, 'rmdir'); |
190 | 190 | } |
@@ -199,8 +199,8 @@ discard block |
||
199 | 199 | * @param $path |
200 | 200 | * @return bool |
201 | 201 | */ |
202 | - protected function shouldMoveToTrash($path){ |
|
203 | - $normalized = Filesystem::normalizePath($this->mountPoint . '/' . $path); |
|
202 | + protected function shouldMoveToTrash($path) { |
|
203 | + $normalized = Filesystem::normalizePath($this->mountPoint.'/'.$path); |
|
204 | 204 | $parts = explode('/', $normalized); |
205 | 205 | if (count($parts) < 4) { |
206 | 206 | return false; |
@@ -237,7 +237,7 @@ discard block |
||
237 | 237 | return false; |
238 | 238 | } |
239 | 239 | |
240 | - $normalized = Filesystem::normalizePath($this->mountPoint . '/' . $path, true, false, true); |
|
240 | + $normalized = Filesystem::normalizePath($this->mountPoint.'/'.$path, true, false, true); |
|
241 | 241 | $result = true; |
242 | 242 | $view = Filesystem::getView(); |
243 | 243 | if (!isset($this->deletedFiles[$normalized]) && $view instanceof View) { |
@@ -265,7 +265,7 @@ discard block |
||
265 | 265 | * Setup the storate wrapper callback |
266 | 266 | */ |
267 | 267 | public static function setupStorage() { |
268 | - \OC\Files\Filesystem::addStorageWrapper('oc_trashbin', function ($mountPoint, $storage) { |
|
268 | + \OC\Files\Filesystem::addStorageWrapper('oc_trashbin', function($mountPoint, $storage) { |
|
269 | 269 | return new \OCA\Files_Trashbin\Storage( |
270 | 270 | array('storage' => $storage, 'mountPoint' => $mountPoint), |
271 | 271 | \OC::$server->getUserManager(), |
@@ -671,7 +671,7 @@ discard block |
||
671 | 671 | * if the size limit for the trash bin is reached, we delete the oldest |
672 | 672 | * files in the trash bin until we meet the limit again |
673 | 673 | * |
674 | - * @param array $files |
|
674 | + * @param \OCP\Files\FileInfo[] $files |
|
675 | 675 | * @param string $user |
676 | 676 | * @param int $availableSpace available disc space |
677 | 677 | * @return int size of deleted files |
@@ -699,7 +699,7 @@ discard block |
||
699 | 699 | /** |
700 | 700 | * delete files older then max storage time |
701 | 701 | * |
702 | - * @param array $files list of files sorted by mtime |
|
702 | + * @param \OCP\Files\FileInfo[] $files list of files sorted by mtime |
|
703 | 703 | * @param string $user |
704 | 704 | * @return integer[] size of deleted files and number of deleted files |
705 | 705 | */ |
@@ -47,941 +47,941 @@ |
||
47 | 47 | |
48 | 48 | class Trashbin { |
49 | 49 | |
50 | - // unit: percentage; 50% of available disk space/quota |
|
51 | - const DEFAULTMAXSIZE = 50; |
|
52 | - |
|
53 | - /** |
|
54 | - * Whether versions have already be rescanned during this PHP request |
|
55 | - * |
|
56 | - * @var bool |
|
57 | - */ |
|
58 | - private static $scannedVersions = false; |
|
59 | - |
|
60 | - /** |
|
61 | - * Ensure we don't need to scan the file during the move to trash |
|
62 | - * by triggering the scan in the pre-hook |
|
63 | - * |
|
64 | - * @param array $params |
|
65 | - */ |
|
66 | - public static function ensureFileScannedHook($params) { |
|
67 | - try { |
|
68 | - self::getUidAndFilename($params['path']); |
|
69 | - } catch (NotFoundException $e) { |
|
70 | - // nothing to scan for non existing files |
|
71 | - } |
|
72 | - } |
|
73 | - |
|
74 | - /** |
|
75 | - * get the UID of the owner of the file and the path to the file relative to |
|
76 | - * owners files folder |
|
77 | - * |
|
78 | - * @param string $filename |
|
79 | - * @return array |
|
80 | - * @throws \OC\User\NoUserException |
|
81 | - */ |
|
82 | - public static function getUidAndFilename($filename) { |
|
83 | - $uid = Filesystem::getOwner($filename); |
|
84 | - $userManager = \OC::$server->getUserManager(); |
|
85 | - // if the user with the UID doesn't exists, e.g. because the UID points |
|
86 | - // to a remote user with a federated cloud ID we use the current logged-in |
|
87 | - // user. We need a valid local user to move the file to the right trash bin |
|
88 | - if (!$userManager->userExists($uid)) { |
|
89 | - $uid = User::getUser(); |
|
90 | - } |
|
91 | - if (!$uid) { |
|
92 | - // no owner, usually because of share link from ext storage |
|
93 | - return [null, null]; |
|
94 | - } |
|
95 | - Filesystem::initMountPoints($uid); |
|
96 | - if ($uid != User::getUser()) { |
|
97 | - $info = Filesystem::getFileInfo($filename); |
|
98 | - $ownerView = new View('/' . $uid . '/files'); |
|
99 | - try { |
|
100 | - $filename = $ownerView->getPath($info['fileid']); |
|
101 | - } catch (NotFoundException $e) { |
|
102 | - $filename = null; |
|
103 | - } |
|
104 | - } |
|
105 | - return [$uid, $filename]; |
|
106 | - } |
|
107 | - |
|
108 | - /** |
|
109 | - * get original location of files for user |
|
110 | - * |
|
111 | - * @param string $user |
|
112 | - * @return array (filename => array (timestamp => original location)) |
|
113 | - */ |
|
114 | - public static function getLocations($user) { |
|
115 | - $query = \OC_DB::prepare('SELECT `id`, `timestamp`, `location`' |
|
116 | - . ' FROM `*PREFIX*files_trash` WHERE `user`=?'); |
|
117 | - $result = $query->execute(array($user)); |
|
118 | - $array = array(); |
|
119 | - while ($row = $result->fetchRow()) { |
|
120 | - if (isset($array[$row['id']])) { |
|
121 | - $array[$row['id']][$row['timestamp']] = $row['location']; |
|
122 | - } else { |
|
123 | - $array[$row['id']] = array($row['timestamp'] => $row['location']); |
|
124 | - } |
|
125 | - } |
|
126 | - return $array; |
|
127 | - } |
|
128 | - |
|
129 | - /** |
|
130 | - * get original location of file |
|
131 | - * |
|
132 | - * @param string $user |
|
133 | - * @param string $filename |
|
134 | - * @param string $timestamp |
|
135 | - * @return string original location |
|
136 | - */ |
|
137 | - public static function getLocation($user, $filename, $timestamp) { |
|
138 | - $query = \OC_DB::prepare('SELECT `location` FROM `*PREFIX*files_trash`' |
|
139 | - . ' WHERE `user`=? AND `id`=? AND `timestamp`=?'); |
|
140 | - $result = $query->execute(array($user, $filename, $timestamp))->fetchAll(); |
|
141 | - if (isset($result[0]['location'])) { |
|
142 | - return $result[0]['location']; |
|
143 | - } else { |
|
144 | - return false; |
|
145 | - } |
|
146 | - } |
|
147 | - |
|
148 | - private static function setUpTrash($user) { |
|
149 | - $view = new View('/' . $user); |
|
150 | - if (!$view->is_dir('files_trashbin')) { |
|
151 | - $view->mkdir('files_trashbin'); |
|
152 | - } |
|
153 | - if (!$view->is_dir('files_trashbin/files')) { |
|
154 | - $view->mkdir('files_trashbin/files'); |
|
155 | - } |
|
156 | - if (!$view->is_dir('files_trashbin/versions')) { |
|
157 | - $view->mkdir('files_trashbin/versions'); |
|
158 | - } |
|
159 | - if (!$view->is_dir('files_trashbin/keys')) { |
|
160 | - $view->mkdir('files_trashbin/keys'); |
|
161 | - } |
|
162 | - } |
|
163 | - |
|
164 | - |
|
165 | - /** |
|
166 | - * copy file to owners trash |
|
167 | - * |
|
168 | - * @param string $sourcePath |
|
169 | - * @param string $owner |
|
170 | - * @param string $targetPath |
|
171 | - * @param $user |
|
172 | - * @param integer $timestamp |
|
173 | - */ |
|
174 | - private static function copyFilesToUser($sourcePath, $owner, $targetPath, $user, $timestamp) { |
|
175 | - self::setUpTrash($owner); |
|
176 | - |
|
177 | - $targetFilename = basename($targetPath); |
|
178 | - $targetLocation = dirname($targetPath); |
|
179 | - |
|
180 | - $sourceFilename = basename($sourcePath); |
|
181 | - |
|
182 | - $view = new View('/'); |
|
183 | - |
|
184 | - $target = $user . '/files_trashbin/files/' . $targetFilename . '.d' . $timestamp; |
|
185 | - $source = $owner . '/files_trashbin/files/' . $sourceFilename . '.d' . $timestamp; |
|
186 | - self::copy_recursive($source, $target, $view); |
|
187 | - |
|
188 | - |
|
189 | - if ($view->file_exists($target)) { |
|
190 | - $query = \OC_DB::prepare("INSERT INTO `*PREFIX*files_trash` (`id`,`timestamp`,`location`,`user`) VALUES (?,?,?,?)"); |
|
191 | - $result = $query->execute(array($targetFilename, $timestamp, $targetLocation, $user)); |
|
192 | - if (!$result) { |
|
193 | - \OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated for the files owner', \OCP\Util::ERROR); |
|
194 | - } |
|
195 | - } |
|
196 | - } |
|
197 | - |
|
198 | - |
|
199 | - /** |
|
200 | - * move file to the trash bin |
|
201 | - * |
|
202 | - * @param string $file_path path to the deleted file/directory relative to the files root directory |
|
203 | - * @param bool $ownerOnly delete for owner only (if file gets moved out of a shared folder) |
|
204 | - * |
|
205 | - * @return bool |
|
206 | - */ |
|
207 | - public static function move2trash($file_path, $ownerOnly = false) { |
|
208 | - // get the user for which the filesystem is setup |
|
209 | - $root = Filesystem::getRoot(); |
|
210 | - list(, $user) = explode('/', $root); |
|
211 | - list($owner, $ownerPath) = self::getUidAndFilename($file_path); |
|
212 | - |
|
213 | - // if no owner found (ex: ext storage + share link), will use the current user's trashbin then |
|
214 | - if (is_null($owner)) { |
|
215 | - $owner = $user; |
|
216 | - $ownerPath = $file_path; |
|
217 | - } |
|
218 | - |
|
219 | - $ownerView = new View('/' . $owner); |
|
220 | - // file has been deleted in between |
|
221 | - if (is_null($ownerPath) || $ownerPath === '' || !$ownerView->file_exists('/files/' . $ownerPath)) { |
|
222 | - return true; |
|
223 | - } |
|
224 | - |
|
225 | - self::setUpTrash($user); |
|
226 | - if ($owner !== $user) { |
|
227 | - // also setup for owner |
|
228 | - self::setUpTrash($owner); |
|
229 | - } |
|
230 | - |
|
231 | - $path_parts = pathinfo($ownerPath); |
|
232 | - |
|
233 | - $filename = $path_parts['basename']; |
|
234 | - $location = $path_parts['dirname']; |
|
235 | - $timestamp = time(); |
|
236 | - |
|
237 | - // disable proxy to prevent recursive calls |
|
238 | - $trashPath = '/files_trashbin/files/' . $filename . '.d' . $timestamp; |
|
239 | - |
|
240 | - /** @var \OC\Files\Storage\Storage $trashStorage */ |
|
241 | - list($trashStorage, $trashInternalPath) = $ownerView->resolvePath($trashPath); |
|
242 | - /** @var \OC\Files\Storage\Storage $sourceStorage */ |
|
243 | - list($sourceStorage, $sourceInternalPath) = $ownerView->resolvePath('/files/' . $ownerPath); |
|
244 | - try { |
|
245 | - $moveSuccessful = true; |
|
246 | - if ($trashStorage->file_exists($trashInternalPath)) { |
|
247 | - $trashStorage->unlink($trashInternalPath); |
|
248 | - } |
|
249 | - $trashStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath); |
|
250 | - } catch (\OCA\Files_Trashbin\Exceptions\CopyRecursiveException $e) { |
|
251 | - $moveSuccessful = false; |
|
252 | - if ($trashStorage->file_exists($trashInternalPath)) { |
|
253 | - $trashStorage->unlink($trashInternalPath); |
|
254 | - } |
|
255 | - \OCP\Util::writeLog('files_trashbin', 'Couldn\'t move ' . $file_path . ' to the trash bin', \OCP\Util::ERROR); |
|
256 | - } |
|
257 | - |
|
258 | - if ($sourceStorage->file_exists($sourceInternalPath)) { // failed to delete the original file, abort |
|
259 | - if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
260 | - $sourceStorage->rmdir($sourceInternalPath); |
|
261 | - } else { |
|
262 | - $sourceStorage->unlink($sourceInternalPath); |
|
263 | - } |
|
264 | - return false; |
|
265 | - } |
|
266 | - |
|
267 | - $trashStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath); |
|
268 | - |
|
269 | - if ($moveSuccessful) { |
|
270 | - $query = \OC_DB::prepare("INSERT INTO `*PREFIX*files_trash` (`id`,`timestamp`,`location`,`user`) VALUES (?,?,?,?)"); |
|
271 | - $result = $query->execute(array($filename, $timestamp, $location, $owner)); |
|
272 | - if (!$result) { |
|
273 | - \OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated', \OCP\Util::ERROR); |
|
274 | - } |
|
275 | - \OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_moveToTrash', array('filePath' => Filesystem::normalizePath($file_path), |
|
276 | - 'trashPath' => Filesystem::normalizePath($filename . '.d' . $timestamp))); |
|
277 | - |
|
278 | - self::retainVersions($filename, $owner, $ownerPath, $timestamp); |
|
279 | - |
|
280 | - // if owner !== user we need to also add a copy to the users trash |
|
281 | - if ($user !== $owner && $ownerOnly === false) { |
|
282 | - self::copyFilesToUser($ownerPath, $owner, $file_path, $user, $timestamp); |
|
283 | - } |
|
284 | - } |
|
285 | - |
|
286 | - self::scheduleExpire($user); |
|
287 | - |
|
288 | - // if owner !== user we also need to update the owners trash size |
|
289 | - if ($owner !== $user) { |
|
290 | - self::scheduleExpire($owner); |
|
291 | - } |
|
292 | - |
|
293 | - return $moveSuccessful; |
|
294 | - } |
|
295 | - |
|
296 | - /** |
|
297 | - * Move file versions to trash so that they can be restored later |
|
298 | - * |
|
299 | - * @param string $filename of deleted file |
|
300 | - * @param string $owner owner user id |
|
301 | - * @param string $ownerPath path relative to the owner's home storage |
|
302 | - * @param integer $timestamp when the file was deleted |
|
303 | - */ |
|
304 | - private static function retainVersions($filename, $owner, $ownerPath, $timestamp) { |
|
305 | - if (\OCP\App::isEnabled('files_versions') && !empty($ownerPath)) { |
|
306 | - |
|
307 | - $user = User::getUser(); |
|
308 | - $rootView = new View('/'); |
|
309 | - |
|
310 | - if ($rootView->is_dir($owner . '/files_versions/' . $ownerPath)) { |
|
311 | - if ($owner !== $user) { |
|
312 | - self::copy_recursive($owner . '/files_versions/' . $ownerPath, $owner . '/files_trashbin/versions/' . basename($ownerPath) . '.d' . $timestamp, $rootView); |
|
313 | - } |
|
314 | - self::move($rootView, $owner . '/files_versions/' . $ownerPath, $user . '/files_trashbin/versions/' . $filename . '.d' . $timestamp); |
|
315 | - } else if ($versions = \OCA\Files_Versions\Storage::getVersions($owner, $ownerPath)) { |
|
316 | - |
|
317 | - foreach ($versions as $v) { |
|
318 | - if ($owner !== $user) { |
|
319 | - self::copy($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $owner . '/files_trashbin/versions/' . $v['name'] . '.v' . $v['version'] . '.d' . $timestamp); |
|
320 | - } |
|
321 | - self::move($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $user . '/files_trashbin/versions/' . $filename . '.v' . $v['version'] . '.d' . $timestamp); |
|
322 | - } |
|
323 | - } |
|
324 | - } |
|
325 | - } |
|
326 | - |
|
327 | - /** |
|
328 | - * Move a file or folder on storage level |
|
329 | - * |
|
330 | - * @param View $view |
|
331 | - * @param string $source |
|
332 | - * @param string $target |
|
333 | - * @return bool |
|
334 | - */ |
|
335 | - private static function move(View $view, $source, $target) { |
|
336 | - /** @var \OC\Files\Storage\Storage $sourceStorage */ |
|
337 | - list($sourceStorage, $sourceInternalPath) = $view->resolvePath($source); |
|
338 | - /** @var \OC\Files\Storage\Storage $targetStorage */ |
|
339 | - list($targetStorage, $targetInternalPath) = $view->resolvePath($target); |
|
340 | - /** @var \OC\Files\Storage\Storage $ownerTrashStorage */ |
|
341 | - |
|
342 | - $result = $targetStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
|
343 | - if ($result) { |
|
344 | - $targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
|
345 | - } |
|
346 | - return $result; |
|
347 | - } |
|
348 | - |
|
349 | - /** |
|
350 | - * Copy a file or folder on storage level |
|
351 | - * |
|
352 | - * @param View $view |
|
353 | - * @param string $source |
|
354 | - * @param string $target |
|
355 | - * @return bool |
|
356 | - */ |
|
357 | - private static function copy(View $view, $source, $target) { |
|
358 | - /** @var \OC\Files\Storage\Storage $sourceStorage */ |
|
359 | - list($sourceStorage, $sourceInternalPath) = $view->resolvePath($source); |
|
360 | - /** @var \OC\Files\Storage\Storage $targetStorage */ |
|
361 | - list($targetStorage, $targetInternalPath) = $view->resolvePath($target); |
|
362 | - /** @var \OC\Files\Storage\Storage $ownerTrashStorage */ |
|
363 | - |
|
364 | - $result = $targetStorage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
|
365 | - if ($result) { |
|
366 | - $targetStorage->getUpdater()->update($targetInternalPath); |
|
367 | - } |
|
368 | - return $result; |
|
369 | - } |
|
370 | - |
|
371 | - /** |
|
372 | - * Restore a file or folder from trash bin |
|
373 | - * |
|
374 | - * @param string $file path to the deleted file/folder relative to "files_trashbin/files/", |
|
375 | - * including the timestamp suffix ".d12345678" |
|
376 | - * @param string $filename name of the file/folder |
|
377 | - * @param int $timestamp time when the file/folder was deleted |
|
378 | - * |
|
379 | - * @return bool true on success, false otherwise |
|
380 | - */ |
|
381 | - public static function restore($file, $filename, $timestamp) { |
|
382 | - $user = User::getUser(); |
|
383 | - $view = new View('/' . $user); |
|
384 | - |
|
385 | - $location = ''; |
|
386 | - if ($timestamp) { |
|
387 | - $location = self::getLocation($user, $filename, $timestamp); |
|
388 | - if ($location === false) { |
|
389 | - \OCP\Util::writeLog('files_trashbin', 'trash bin database inconsistent! ($user: ' . $user . ' $filename: ' . $filename . ', $timestamp: ' . $timestamp . ')', \OCP\Util::ERROR); |
|
390 | - } else { |
|
391 | - // if location no longer exists, restore file in the root directory |
|
392 | - if ($location !== '/' && |
|
393 | - (!$view->is_dir('files/' . $location) || |
|
394 | - !$view->isCreatable('files/' . $location)) |
|
395 | - ) { |
|
396 | - $location = ''; |
|
397 | - } |
|
398 | - } |
|
399 | - } |
|
400 | - |
|
401 | - // we need a extension in case a file/dir with the same name already exists |
|
402 | - $uniqueFilename = self::getUniqueFilename($location, $filename, $view); |
|
403 | - |
|
404 | - $source = Filesystem::normalizePath('files_trashbin/files/' . $file); |
|
405 | - $target = Filesystem::normalizePath('files/' . $location . '/' . $uniqueFilename); |
|
406 | - if (!$view->file_exists($source)) { |
|
407 | - return false; |
|
408 | - } |
|
409 | - $mtime = $view->filemtime($source); |
|
410 | - |
|
411 | - // restore file |
|
412 | - $restoreResult = $view->rename($source, $target); |
|
413 | - |
|
414 | - // handle the restore result |
|
415 | - if ($restoreResult) { |
|
416 | - $fakeRoot = $view->getRoot(); |
|
417 | - $view->chroot('/' . $user . '/files'); |
|
418 | - $view->touch('/' . $location . '/' . $uniqueFilename, $mtime); |
|
419 | - $view->chroot($fakeRoot); |
|
420 | - \OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', array('filePath' => Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename), |
|
421 | - 'trashPath' => Filesystem::normalizePath($file))); |
|
422 | - |
|
423 | - self::restoreVersions($view, $file, $filename, $uniqueFilename, $location, $timestamp); |
|
424 | - |
|
425 | - if ($timestamp) { |
|
426 | - $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?'); |
|
427 | - $query->execute(array($user, $filename, $timestamp)); |
|
428 | - } |
|
429 | - |
|
430 | - return true; |
|
431 | - } |
|
432 | - |
|
433 | - return false; |
|
434 | - } |
|
435 | - |
|
436 | - /** |
|
437 | - * restore versions from trash bin |
|
438 | - * |
|
439 | - * @param View $view file view |
|
440 | - * @param string $file complete path to file |
|
441 | - * @param string $filename name of file once it was deleted |
|
442 | - * @param string $uniqueFilename new file name to restore the file without overwriting existing files |
|
443 | - * @param string $location location if file |
|
444 | - * @param int $timestamp deletion time |
|
445 | - * @return false|null |
|
446 | - */ |
|
447 | - private static function restoreVersions(View $view, $file, $filename, $uniqueFilename, $location, $timestamp) { |
|
448 | - |
|
449 | - if (\OCP\App::isEnabled('files_versions')) { |
|
450 | - |
|
451 | - $user = User::getUser(); |
|
452 | - $rootView = new View('/'); |
|
453 | - |
|
454 | - $target = Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename); |
|
455 | - |
|
456 | - list($owner, $ownerPath) = self::getUidAndFilename($target); |
|
457 | - |
|
458 | - // file has been deleted in between |
|
459 | - if (empty($ownerPath)) { |
|
460 | - return false; |
|
461 | - } |
|
462 | - |
|
463 | - if ($timestamp) { |
|
464 | - $versionedFile = $filename; |
|
465 | - } else { |
|
466 | - $versionedFile = $file; |
|
467 | - } |
|
468 | - |
|
469 | - if ($view->is_dir('/files_trashbin/versions/' . $file)) { |
|
470 | - $rootView->rename(Filesystem::normalizePath($user . '/files_trashbin/versions/' . $file), Filesystem::normalizePath($owner . '/files_versions/' . $ownerPath)); |
|
471 | - } else if ($versions = self::getVersionsFromTrash($versionedFile, $timestamp, $user)) { |
|
472 | - foreach ($versions as $v) { |
|
473 | - if ($timestamp) { |
|
474 | - $rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v . '.d' . $timestamp, $owner . '/files_versions/' . $ownerPath . '.v' . $v); |
|
475 | - } else { |
|
476 | - $rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v, $owner . '/files_versions/' . $ownerPath . '.v' . $v); |
|
477 | - } |
|
478 | - } |
|
479 | - } |
|
480 | - } |
|
481 | - } |
|
482 | - |
|
483 | - /** |
|
484 | - * delete all files from the trash |
|
485 | - */ |
|
486 | - public static function deleteAll() { |
|
487 | - $user = User::getUser(); |
|
488 | - $view = new View('/' . $user); |
|
489 | - $fileInfos = $view->getDirectoryContent('files_trashbin/files'); |
|
490 | - |
|
491 | - // Array to store the relative path in (after the file is deleted, the view won't be able to relativise the path anymore) |
|
492 | - $filePaths = array(); |
|
493 | - foreach($fileInfos as $fileInfo){ |
|
494 | - $filePaths[] = $view->getRelativePath($fileInfo->getPath()); |
|
495 | - } |
|
496 | - unset($fileInfos); // save memory |
|
497 | - |
|
498 | - // Bulk PreDelete-Hook |
|
499 | - \OC_Hook::emit('\OCP\Trashbin', 'preDeleteAll', array('paths' => $filePaths)); |
|
500 | - |
|
501 | - // Single-File Hooks |
|
502 | - foreach($filePaths as $path){ |
|
503 | - self::emitTrashbinPreDelete($path); |
|
504 | - } |
|
505 | - |
|
506 | - // actual file deletion |
|
507 | - $view->deleteAll('files_trashbin'); |
|
508 | - $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=?'); |
|
509 | - $query->execute(array($user)); |
|
510 | - |
|
511 | - // Bulk PostDelete-Hook |
|
512 | - \OC_Hook::emit('\OCP\Trashbin', 'deleteAll', array('paths' => $filePaths)); |
|
513 | - |
|
514 | - // Single-File Hooks |
|
515 | - foreach($filePaths as $path){ |
|
516 | - self::emitTrashbinPostDelete($path); |
|
517 | - } |
|
518 | - |
|
519 | - $view->mkdir('files_trashbin'); |
|
520 | - $view->mkdir('files_trashbin/files'); |
|
521 | - |
|
522 | - return true; |
|
523 | - } |
|
524 | - |
|
525 | - /** |
|
526 | - * wrapper function to emit the 'preDelete' hook of \OCP\Trashbin before a file is deleted |
|
527 | - * @param string $path |
|
528 | - */ |
|
529 | - protected static function emitTrashbinPreDelete($path){ |
|
530 | - \OC_Hook::emit('\OCP\Trashbin', 'preDelete', array('path' => $path)); |
|
531 | - } |
|
532 | - |
|
533 | - /** |
|
534 | - * wrapper function to emit the 'delete' hook of \OCP\Trashbin after a file has been deleted |
|
535 | - * @param string $path |
|
536 | - */ |
|
537 | - protected static function emitTrashbinPostDelete($path){ |
|
538 | - \OC_Hook::emit('\OCP\Trashbin', 'delete', array('path' => $path)); |
|
539 | - } |
|
540 | - |
|
541 | - /** |
|
542 | - * delete file from trash bin permanently |
|
543 | - * |
|
544 | - * @param string $filename path to the file |
|
545 | - * @param string $user |
|
546 | - * @param int $timestamp of deletion time |
|
547 | - * |
|
548 | - * @return int size of deleted files |
|
549 | - */ |
|
550 | - public static function delete($filename, $user, $timestamp = null) { |
|
551 | - $view = new View('/' . $user); |
|
552 | - $size = 0; |
|
553 | - |
|
554 | - if ($timestamp) { |
|
555 | - $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?'); |
|
556 | - $query->execute(array($user, $filename, $timestamp)); |
|
557 | - $file = $filename . '.d' . $timestamp; |
|
558 | - } else { |
|
559 | - $file = $filename; |
|
560 | - } |
|
561 | - |
|
562 | - $size += self::deleteVersions($view, $file, $filename, $timestamp, $user); |
|
563 | - |
|
564 | - if ($view->is_dir('/files_trashbin/files/' . $file)) { |
|
565 | - $size += self::calculateSize(new View('/' . $user . '/files_trashbin/files/' . $file)); |
|
566 | - } else { |
|
567 | - $size += $view->filesize('/files_trashbin/files/' . $file); |
|
568 | - } |
|
569 | - self::emitTrashbinPreDelete('/files_trashbin/files/' . $file); |
|
570 | - $view->unlink('/files_trashbin/files/' . $file); |
|
571 | - self::emitTrashbinPostDelete('/files_trashbin/files/' . $file); |
|
572 | - |
|
573 | - return $size; |
|
574 | - } |
|
575 | - |
|
576 | - /** |
|
577 | - * @param View $view |
|
578 | - * @param string $file |
|
579 | - * @param string $filename |
|
580 | - * @param integer|null $timestamp |
|
581 | - * @param string $user |
|
582 | - * @return int |
|
583 | - */ |
|
584 | - private static function deleteVersions(View $view, $file, $filename, $timestamp, $user) { |
|
585 | - $size = 0; |
|
586 | - if (\OCP\App::isEnabled('files_versions')) { |
|
587 | - if ($view->is_dir('files_trashbin/versions/' . $file)) { |
|
588 | - $size += self::calculateSize(new View('/' . $user . '/files_trashbin/versions/' . $file)); |
|
589 | - $view->unlink('files_trashbin/versions/' . $file); |
|
590 | - } else if ($versions = self::getVersionsFromTrash($filename, $timestamp, $user)) { |
|
591 | - foreach ($versions as $v) { |
|
592 | - if ($timestamp) { |
|
593 | - $size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp); |
|
594 | - $view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp); |
|
595 | - } else { |
|
596 | - $size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v); |
|
597 | - $view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v); |
|
598 | - } |
|
599 | - } |
|
600 | - } |
|
601 | - } |
|
602 | - return $size; |
|
603 | - } |
|
604 | - |
|
605 | - /** |
|
606 | - * check to see whether a file exists in trashbin |
|
607 | - * |
|
608 | - * @param string $filename path to the file |
|
609 | - * @param int $timestamp of deletion time |
|
610 | - * @return bool true if file exists, otherwise false |
|
611 | - */ |
|
612 | - public static function file_exists($filename, $timestamp = null) { |
|
613 | - $user = User::getUser(); |
|
614 | - $view = new View('/' . $user); |
|
615 | - |
|
616 | - if ($timestamp) { |
|
617 | - $filename = $filename . '.d' . $timestamp; |
|
618 | - } else { |
|
619 | - $filename = $filename; |
|
620 | - } |
|
621 | - |
|
622 | - $target = Filesystem::normalizePath('files_trashbin/files/' . $filename); |
|
623 | - return $view->file_exists($target); |
|
624 | - } |
|
625 | - |
|
626 | - /** |
|
627 | - * deletes used space for trash bin in db if user was deleted |
|
628 | - * |
|
629 | - * @param string $uid id of deleted user |
|
630 | - * @return bool result of db delete operation |
|
631 | - */ |
|
632 | - public static function deleteUser($uid) { |
|
633 | - $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=?'); |
|
634 | - return $query->execute(array($uid)); |
|
635 | - } |
|
636 | - |
|
637 | - /** |
|
638 | - * calculate remaining free space for trash bin |
|
639 | - * |
|
640 | - * @param integer $trashbinSize current size of the trash bin |
|
641 | - * @param string $user |
|
642 | - * @return int available free space for trash bin |
|
643 | - */ |
|
644 | - private static function calculateFreeSpace($trashbinSize, $user) { |
|
645 | - $softQuota = true; |
|
646 | - $userObject = \OC::$server->getUserManager()->get($user); |
|
647 | - if(is_null($userObject)) { |
|
648 | - return 0; |
|
649 | - } |
|
650 | - $quota = $userObject->getQuota(); |
|
651 | - if ($quota === null || $quota === 'none') { |
|
652 | - $quota = Filesystem::free_space('/'); |
|
653 | - $softQuota = false; |
|
654 | - // inf or unknown free space |
|
655 | - if ($quota < 0) { |
|
656 | - $quota = PHP_INT_MAX; |
|
657 | - } |
|
658 | - } else { |
|
659 | - $quota = \OCP\Util::computerFileSize($quota); |
|
660 | - } |
|
661 | - |
|
662 | - // calculate available space for trash bin |
|
663 | - // subtract size of files and current trash bin size from quota |
|
664 | - if ($softQuota) { |
|
665 | - $userFolder = \OC::$server->getUserFolder($user); |
|
666 | - if(is_null($userFolder)) { |
|
667 | - return 0; |
|
668 | - } |
|
669 | - $free = $quota - $userFolder->getSize(); // remaining free space for user |
|
670 | - if ($free > 0) { |
|
671 | - $availableSpace = ($free * self::DEFAULTMAXSIZE / 100) - $trashbinSize; // how much space can be used for versions |
|
672 | - } else { |
|
673 | - $availableSpace = $free - $trashbinSize; |
|
674 | - } |
|
675 | - } else { |
|
676 | - $availableSpace = $quota; |
|
677 | - } |
|
678 | - |
|
679 | - return $availableSpace; |
|
680 | - } |
|
681 | - |
|
682 | - /** |
|
683 | - * resize trash bin if necessary after a new file was added to Nextcloud |
|
684 | - * |
|
685 | - * @param string $user user id |
|
686 | - */ |
|
687 | - public static function resizeTrash($user) { |
|
688 | - |
|
689 | - $size = self::getTrashbinSize($user); |
|
690 | - |
|
691 | - $freeSpace = self::calculateFreeSpace($size, $user); |
|
692 | - |
|
693 | - if ($freeSpace < 0) { |
|
694 | - self::scheduleExpire($user); |
|
695 | - } |
|
696 | - } |
|
697 | - |
|
698 | - /** |
|
699 | - * clean up the trash bin |
|
700 | - * |
|
701 | - * @param string $user |
|
702 | - */ |
|
703 | - public static function expire($user) { |
|
704 | - $trashBinSize = self::getTrashbinSize($user); |
|
705 | - $availableSpace = self::calculateFreeSpace($trashBinSize, $user); |
|
706 | - |
|
707 | - $dirContent = Helper::getTrashFiles('/', $user, 'mtime'); |
|
708 | - |
|
709 | - // delete all files older then $retention_obligation |
|
710 | - list($delSize, $count) = self::deleteExpiredFiles($dirContent, $user); |
|
711 | - |
|
712 | - $availableSpace += $delSize; |
|
713 | - |
|
714 | - // delete files from trash until we meet the trash bin size limit again |
|
715 | - self::deleteFiles(array_slice($dirContent, $count), $user, $availableSpace); |
|
716 | - } |
|
717 | - |
|
718 | - /** |
|
719 | - * @param string $user |
|
720 | - */ |
|
721 | - private static function scheduleExpire($user) { |
|
722 | - // let the admin disable auto expire |
|
723 | - $application = new Application(); |
|
724 | - $expiration = $application->getContainer()->query('Expiration'); |
|
725 | - if ($expiration->isEnabled()) { |
|
726 | - \OC::$server->getCommandBus()->push(new Expire($user)); |
|
727 | - } |
|
728 | - } |
|
729 | - |
|
730 | - /** |
|
731 | - * if the size limit for the trash bin is reached, we delete the oldest |
|
732 | - * files in the trash bin until we meet the limit again |
|
733 | - * |
|
734 | - * @param array $files |
|
735 | - * @param string $user |
|
736 | - * @param int $availableSpace available disc space |
|
737 | - * @return int size of deleted files |
|
738 | - */ |
|
739 | - protected static function deleteFiles($files, $user, $availableSpace) { |
|
740 | - $application = new Application(); |
|
741 | - $expiration = $application->getContainer()->query('Expiration'); |
|
742 | - $size = 0; |
|
743 | - |
|
744 | - if ($availableSpace < 0) { |
|
745 | - foreach ($files as $file) { |
|
746 | - if ($availableSpace < 0 && $expiration->isExpired($file['mtime'], true)) { |
|
747 | - $tmp = self::delete($file['name'], $user, $file['mtime']); |
|
748 | - \OCP\Util::writeLog('files_trashbin', 'remove "' . $file['name'] . '" (' . $tmp . 'B) to meet the limit of trash bin size (50% of available quota)', \OCP\Util::INFO); |
|
749 | - $availableSpace += $tmp; |
|
750 | - $size += $tmp; |
|
751 | - } else { |
|
752 | - break; |
|
753 | - } |
|
754 | - } |
|
755 | - } |
|
756 | - return $size; |
|
757 | - } |
|
758 | - |
|
759 | - /** |
|
760 | - * delete files older then max storage time |
|
761 | - * |
|
762 | - * @param array $files list of files sorted by mtime |
|
763 | - * @param string $user |
|
764 | - * @return integer[] size of deleted files and number of deleted files |
|
765 | - */ |
|
766 | - public static function deleteExpiredFiles($files, $user) { |
|
767 | - $application = new Application(); |
|
768 | - $expiration = $application->getContainer()->query('Expiration'); |
|
769 | - $size = 0; |
|
770 | - $count = 0; |
|
771 | - foreach ($files as $file) { |
|
772 | - $timestamp = $file['mtime']; |
|
773 | - $filename = $file['name']; |
|
774 | - if ($expiration->isExpired($timestamp)) { |
|
775 | - $count++; |
|
776 | - $size += self::delete($filename, $user, $timestamp); |
|
777 | - \OC::$server->getLogger()->info( |
|
778 | - 'Remove "' . $filename . '" from trashbin because it exceeds max retention obligation term.', |
|
779 | - ['app' => 'files_trashbin'] |
|
780 | - ); |
|
781 | - } else { |
|
782 | - break; |
|
783 | - } |
|
784 | - } |
|
785 | - |
|
786 | - return array($size, $count); |
|
787 | - } |
|
788 | - |
|
789 | - /** |
|
790 | - * recursive copy to copy a whole directory |
|
791 | - * |
|
792 | - * @param string $source source path, relative to the users files directory |
|
793 | - * @param string $destination destination path relative to the users root directoy |
|
794 | - * @param View $view file view for the users root directory |
|
795 | - * @return int |
|
796 | - * @throws Exceptions\CopyRecursiveException |
|
797 | - */ |
|
798 | - private static function copy_recursive($source, $destination, View $view) { |
|
799 | - $size = 0; |
|
800 | - if ($view->is_dir($source)) { |
|
801 | - $view->mkdir($destination); |
|
802 | - $view->touch($destination, $view->filemtime($source)); |
|
803 | - foreach ($view->getDirectoryContent($source) as $i) { |
|
804 | - $pathDir = $source . '/' . $i['name']; |
|
805 | - if ($view->is_dir($pathDir)) { |
|
806 | - $size += self::copy_recursive($pathDir, $destination . '/' . $i['name'], $view); |
|
807 | - } else { |
|
808 | - $size += $view->filesize($pathDir); |
|
809 | - $result = $view->copy($pathDir, $destination . '/' . $i['name']); |
|
810 | - if (!$result) { |
|
811 | - throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException(); |
|
812 | - } |
|
813 | - $view->touch($destination . '/' . $i['name'], $view->filemtime($pathDir)); |
|
814 | - } |
|
815 | - } |
|
816 | - } else { |
|
817 | - $size += $view->filesize($source); |
|
818 | - $result = $view->copy($source, $destination); |
|
819 | - if (!$result) { |
|
820 | - throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException(); |
|
821 | - } |
|
822 | - $view->touch($destination, $view->filemtime($source)); |
|
823 | - } |
|
824 | - return $size; |
|
825 | - } |
|
826 | - |
|
827 | - /** |
|
828 | - * find all versions which belong to the file we want to restore |
|
829 | - * |
|
830 | - * @param string $filename name of the file which should be restored |
|
831 | - * @param int $timestamp timestamp when the file was deleted |
|
832 | - * @return array |
|
833 | - */ |
|
834 | - private static function getVersionsFromTrash($filename, $timestamp, $user) { |
|
835 | - $view = new View('/' . $user . '/files_trashbin/versions'); |
|
836 | - $versions = array(); |
|
837 | - |
|
838 | - //force rescan of versions, local storage may not have updated the cache |
|
839 | - if (!self::$scannedVersions) { |
|
840 | - /** @var \OC\Files\Storage\Storage $storage */ |
|
841 | - list($storage,) = $view->resolvePath('/'); |
|
842 | - $storage->getScanner()->scan('files_trashbin/versions'); |
|
843 | - self::$scannedVersions = true; |
|
844 | - } |
|
845 | - |
|
846 | - if ($timestamp) { |
|
847 | - // fetch for old versions |
|
848 | - $matches = $view->searchRaw($filename . '.v%.d' . $timestamp); |
|
849 | - $offset = -strlen($timestamp) - 2; |
|
850 | - } else { |
|
851 | - $matches = $view->searchRaw($filename . '.v%'); |
|
852 | - } |
|
853 | - |
|
854 | - if (is_array($matches)) { |
|
855 | - foreach ($matches as $ma) { |
|
856 | - if ($timestamp) { |
|
857 | - $parts = explode('.v', substr($ma['path'], 0, $offset)); |
|
858 | - $versions[] = (end($parts)); |
|
859 | - } else { |
|
860 | - $parts = explode('.v', $ma); |
|
861 | - $versions[] = (end($parts)); |
|
862 | - } |
|
863 | - } |
|
864 | - } |
|
865 | - return $versions; |
|
866 | - } |
|
867 | - |
|
868 | - /** |
|
869 | - * find unique extension for restored file if a file with the same name already exists |
|
870 | - * |
|
871 | - * @param string $location where the file should be restored |
|
872 | - * @param string $filename name of the file |
|
873 | - * @param View $view filesystem view relative to users root directory |
|
874 | - * @return string with unique extension |
|
875 | - */ |
|
876 | - private static function getUniqueFilename($location, $filename, View $view) { |
|
877 | - $ext = pathinfo($filename, PATHINFO_EXTENSION); |
|
878 | - $name = pathinfo($filename, PATHINFO_FILENAME); |
|
879 | - $l = \OC::$server->getL10N('files_trashbin'); |
|
880 | - |
|
881 | - $location = '/' . trim($location, '/'); |
|
882 | - |
|
883 | - // if extension is not empty we set a dot in front of it |
|
884 | - if ($ext !== '') { |
|
885 | - $ext = '.' . $ext; |
|
886 | - } |
|
887 | - |
|
888 | - if ($view->file_exists('files' . $location . '/' . $filename)) { |
|
889 | - $i = 2; |
|
890 | - $uniqueName = $name . " (" . $l->t("restored") . ")" . $ext; |
|
891 | - while ($view->file_exists('files' . $location . '/' . $uniqueName)) { |
|
892 | - $uniqueName = $name . " (" . $l->t("restored") . " " . $i . ")" . $ext; |
|
893 | - $i++; |
|
894 | - } |
|
895 | - |
|
896 | - return $uniqueName; |
|
897 | - } |
|
898 | - |
|
899 | - return $filename; |
|
900 | - } |
|
901 | - |
|
902 | - /** |
|
903 | - * get the size from a given root folder |
|
904 | - * |
|
905 | - * @param View $view file view on the root folder |
|
906 | - * @return integer size of the folder |
|
907 | - */ |
|
908 | - private static function calculateSize($view) { |
|
909 | - $root = \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . $view->getAbsolutePath(''); |
|
910 | - if (!file_exists($root)) { |
|
911 | - return 0; |
|
912 | - } |
|
913 | - $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($root), \RecursiveIteratorIterator::CHILD_FIRST); |
|
914 | - $size = 0; |
|
915 | - |
|
916 | - /** |
|
917 | - * RecursiveDirectoryIterator on an NFS path isn't iterable with foreach |
|
918 | - * This bug is fixed in PHP 5.5.9 or before |
|
919 | - * See #8376 |
|
920 | - */ |
|
921 | - $iterator->rewind(); |
|
922 | - while ($iterator->valid()) { |
|
923 | - $path = $iterator->current(); |
|
924 | - $relpath = substr($path, strlen($root) - 1); |
|
925 | - if (!$view->is_dir($relpath)) { |
|
926 | - $size += $view->filesize($relpath); |
|
927 | - } |
|
928 | - $iterator->next(); |
|
929 | - } |
|
930 | - return $size; |
|
931 | - } |
|
932 | - |
|
933 | - /** |
|
934 | - * get current size of trash bin from a given user |
|
935 | - * |
|
936 | - * @param string $user user who owns the trash bin |
|
937 | - * @return integer trash bin size |
|
938 | - */ |
|
939 | - private static function getTrashbinSize($user) { |
|
940 | - $view = new View('/' . $user); |
|
941 | - $fileInfo = $view->getFileInfo('/files_trashbin'); |
|
942 | - return isset($fileInfo['size']) ? $fileInfo['size'] : 0; |
|
943 | - } |
|
944 | - |
|
945 | - /** |
|
946 | - * register hooks |
|
947 | - */ |
|
948 | - public static function registerHooks() { |
|
949 | - // create storage wrapper on setup |
|
950 | - \OCP\Util::connectHook('OC_Filesystem', 'preSetup', 'OCA\Files_Trashbin\Storage', 'setupStorage'); |
|
951 | - //Listen to delete user signal |
|
952 | - \OCP\Util::connectHook('OC_User', 'pre_deleteUser', 'OCA\Files_Trashbin\Hooks', 'deleteUser_hook'); |
|
953 | - //Listen to post write hook |
|
954 | - \OCP\Util::connectHook('OC_Filesystem', 'post_write', 'OCA\Files_Trashbin\Hooks', 'post_write_hook'); |
|
955 | - // pre and post-rename, disable trash logic for the copy+unlink case |
|
956 | - \OCP\Util::connectHook('OC_Filesystem', 'delete', 'OCA\Files_Trashbin\Trashbin', 'ensureFileScannedHook'); |
|
957 | - \OCP\Util::connectHook('OC_Filesystem', 'rename', 'OCA\Files_Trashbin\Storage', 'preRenameHook'); |
|
958 | - \OCP\Util::connectHook('OC_Filesystem', 'post_rename', 'OCA\Files_Trashbin\Storage', 'postRenameHook'); |
|
959 | - } |
|
960 | - |
|
961 | - /** |
|
962 | - * check if trash bin is empty for a given user |
|
963 | - * |
|
964 | - * @param string $user |
|
965 | - * @return bool |
|
966 | - */ |
|
967 | - public static function isEmpty($user) { |
|
968 | - |
|
969 | - $view = new View('/' . $user . '/files_trashbin'); |
|
970 | - if ($view->is_dir('/files') && $dh = $view->opendir('/files')) { |
|
971 | - while ($file = readdir($dh)) { |
|
972 | - if (!Filesystem::isIgnoredDir($file)) { |
|
973 | - return false; |
|
974 | - } |
|
975 | - } |
|
976 | - } |
|
977 | - return true; |
|
978 | - } |
|
979 | - |
|
980 | - /** |
|
981 | - * @param $path |
|
982 | - * @return string |
|
983 | - */ |
|
984 | - public static function preview_icon($path) { |
|
985 | - return \OCP\Util::linkToRoute('core_ajax_trashbin_preview', array('x' => 32, 'y' => 32, 'file' => $path)); |
|
986 | - } |
|
50 | + // unit: percentage; 50% of available disk space/quota |
|
51 | + const DEFAULTMAXSIZE = 50; |
|
52 | + |
|
53 | + /** |
|
54 | + * Whether versions have already be rescanned during this PHP request |
|
55 | + * |
|
56 | + * @var bool |
|
57 | + */ |
|
58 | + private static $scannedVersions = false; |
|
59 | + |
|
60 | + /** |
|
61 | + * Ensure we don't need to scan the file during the move to trash |
|
62 | + * by triggering the scan in the pre-hook |
|
63 | + * |
|
64 | + * @param array $params |
|
65 | + */ |
|
66 | + public static function ensureFileScannedHook($params) { |
|
67 | + try { |
|
68 | + self::getUidAndFilename($params['path']); |
|
69 | + } catch (NotFoundException $e) { |
|
70 | + // nothing to scan for non existing files |
|
71 | + } |
|
72 | + } |
|
73 | + |
|
74 | + /** |
|
75 | + * get the UID of the owner of the file and the path to the file relative to |
|
76 | + * owners files folder |
|
77 | + * |
|
78 | + * @param string $filename |
|
79 | + * @return array |
|
80 | + * @throws \OC\User\NoUserException |
|
81 | + */ |
|
82 | + public static function getUidAndFilename($filename) { |
|
83 | + $uid = Filesystem::getOwner($filename); |
|
84 | + $userManager = \OC::$server->getUserManager(); |
|
85 | + // if the user with the UID doesn't exists, e.g. because the UID points |
|
86 | + // to a remote user with a federated cloud ID we use the current logged-in |
|
87 | + // user. We need a valid local user to move the file to the right trash bin |
|
88 | + if (!$userManager->userExists($uid)) { |
|
89 | + $uid = User::getUser(); |
|
90 | + } |
|
91 | + if (!$uid) { |
|
92 | + // no owner, usually because of share link from ext storage |
|
93 | + return [null, null]; |
|
94 | + } |
|
95 | + Filesystem::initMountPoints($uid); |
|
96 | + if ($uid != User::getUser()) { |
|
97 | + $info = Filesystem::getFileInfo($filename); |
|
98 | + $ownerView = new View('/' . $uid . '/files'); |
|
99 | + try { |
|
100 | + $filename = $ownerView->getPath($info['fileid']); |
|
101 | + } catch (NotFoundException $e) { |
|
102 | + $filename = null; |
|
103 | + } |
|
104 | + } |
|
105 | + return [$uid, $filename]; |
|
106 | + } |
|
107 | + |
|
108 | + /** |
|
109 | + * get original location of files for user |
|
110 | + * |
|
111 | + * @param string $user |
|
112 | + * @return array (filename => array (timestamp => original location)) |
|
113 | + */ |
|
114 | + public static function getLocations($user) { |
|
115 | + $query = \OC_DB::prepare('SELECT `id`, `timestamp`, `location`' |
|
116 | + . ' FROM `*PREFIX*files_trash` WHERE `user`=?'); |
|
117 | + $result = $query->execute(array($user)); |
|
118 | + $array = array(); |
|
119 | + while ($row = $result->fetchRow()) { |
|
120 | + if (isset($array[$row['id']])) { |
|
121 | + $array[$row['id']][$row['timestamp']] = $row['location']; |
|
122 | + } else { |
|
123 | + $array[$row['id']] = array($row['timestamp'] => $row['location']); |
|
124 | + } |
|
125 | + } |
|
126 | + return $array; |
|
127 | + } |
|
128 | + |
|
129 | + /** |
|
130 | + * get original location of file |
|
131 | + * |
|
132 | + * @param string $user |
|
133 | + * @param string $filename |
|
134 | + * @param string $timestamp |
|
135 | + * @return string original location |
|
136 | + */ |
|
137 | + public static function getLocation($user, $filename, $timestamp) { |
|
138 | + $query = \OC_DB::prepare('SELECT `location` FROM `*PREFIX*files_trash`' |
|
139 | + . ' WHERE `user`=? AND `id`=? AND `timestamp`=?'); |
|
140 | + $result = $query->execute(array($user, $filename, $timestamp))->fetchAll(); |
|
141 | + if (isset($result[0]['location'])) { |
|
142 | + return $result[0]['location']; |
|
143 | + } else { |
|
144 | + return false; |
|
145 | + } |
|
146 | + } |
|
147 | + |
|
148 | + private static function setUpTrash($user) { |
|
149 | + $view = new View('/' . $user); |
|
150 | + if (!$view->is_dir('files_trashbin')) { |
|
151 | + $view->mkdir('files_trashbin'); |
|
152 | + } |
|
153 | + if (!$view->is_dir('files_trashbin/files')) { |
|
154 | + $view->mkdir('files_trashbin/files'); |
|
155 | + } |
|
156 | + if (!$view->is_dir('files_trashbin/versions')) { |
|
157 | + $view->mkdir('files_trashbin/versions'); |
|
158 | + } |
|
159 | + if (!$view->is_dir('files_trashbin/keys')) { |
|
160 | + $view->mkdir('files_trashbin/keys'); |
|
161 | + } |
|
162 | + } |
|
163 | + |
|
164 | + |
|
165 | + /** |
|
166 | + * copy file to owners trash |
|
167 | + * |
|
168 | + * @param string $sourcePath |
|
169 | + * @param string $owner |
|
170 | + * @param string $targetPath |
|
171 | + * @param $user |
|
172 | + * @param integer $timestamp |
|
173 | + */ |
|
174 | + private static function copyFilesToUser($sourcePath, $owner, $targetPath, $user, $timestamp) { |
|
175 | + self::setUpTrash($owner); |
|
176 | + |
|
177 | + $targetFilename = basename($targetPath); |
|
178 | + $targetLocation = dirname($targetPath); |
|
179 | + |
|
180 | + $sourceFilename = basename($sourcePath); |
|
181 | + |
|
182 | + $view = new View('/'); |
|
183 | + |
|
184 | + $target = $user . '/files_trashbin/files/' . $targetFilename . '.d' . $timestamp; |
|
185 | + $source = $owner . '/files_trashbin/files/' . $sourceFilename . '.d' . $timestamp; |
|
186 | + self::copy_recursive($source, $target, $view); |
|
187 | + |
|
188 | + |
|
189 | + if ($view->file_exists($target)) { |
|
190 | + $query = \OC_DB::prepare("INSERT INTO `*PREFIX*files_trash` (`id`,`timestamp`,`location`,`user`) VALUES (?,?,?,?)"); |
|
191 | + $result = $query->execute(array($targetFilename, $timestamp, $targetLocation, $user)); |
|
192 | + if (!$result) { |
|
193 | + \OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated for the files owner', \OCP\Util::ERROR); |
|
194 | + } |
|
195 | + } |
|
196 | + } |
|
197 | + |
|
198 | + |
|
199 | + /** |
|
200 | + * move file to the trash bin |
|
201 | + * |
|
202 | + * @param string $file_path path to the deleted file/directory relative to the files root directory |
|
203 | + * @param bool $ownerOnly delete for owner only (if file gets moved out of a shared folder) |
|
204 | + * |
|
205 | + * @return bool |
|
206 | + */ |
|
207 | + public static function move2trash($file_path, $ownerOnly = false) { |
|
208 | + // get the user for which the filesystem is setup |
|
209 | + $root = Filesystem::getRoot(); |
|
210 | + list(, $user) = explode('/', $root); |
|
211 | + list($owner, $ownerPath) = self::getUidAndFilename($file_path); |
|
212 | + |
|
213 | + // if no owner found (ex: ext storage + share link), will use the current user's trashbin then |
|
214 | + if (is_null($owner)) { |
|
215 | + $owner = $user; |
|
216 | + $ownerPath = $file_path; |
|
217 | + } |
|
218 | + |
|
219 | + $ownerView = new View('/' . $owner); |
|
220 | + // file has been deleted in between |
|
221 | + if (is_null($ownerPath) || $ownerPath === '' || !$ownerView->file_exists('/files/' . $ownerPath)) { |
|
222 | + return true; |
|
223 | + } |
|
224 | + |
|
225 | + self::setUpTrash($user); |
|
226 | + if ($owner !== $user) { |
|
227 | + // also setup for owner |
|
228 | + self::setUpTrash($owner); |
|
229 | + } |
|
230 | + |
|
231 | + $path_parts = pathinfo($ownerPath); |
|
232 | + |
|
233 | + $filename = $path_parts['basename']; |
|
234 | + $location = $path_parts['dirname']; |
|
235 | + $timestamp = time(); |
|
236 | + |
|
237 | + // disable proxy to prevent recursive calls |
|
238 | + $trashPath = '/files_trashbin/files/' . $filename . '.d' . $timestamp; |
|
239 | + |
|
240 | + /** @var \OC\Files\Storage\Storage $trashStorage */ |
|
241 | + list($trashStorage, $trashInternalPath) = $ownerView->resolvePath($trashPath); |
|
242 | + /** @var \OC\Files\Storage\Storage $sourceStorage */ |
|
243 | + list($sourceStorage, $sourceInternalPath) = $ownerView->resolvePath('/files/' . $ownerPath); |
|
244 | + try { |
|
245 | + $moveSuccessful = true; |
|
246 | + if ($trashStorage->file_exists($trashInternalPath)) { |
|
247 | + $trashStorage->unlink($trashInternalPath); |
|
248 | + } |
|
249 | + $trashStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath); |
|
250 | + } catch (\OCA\Files_Trashbin\Exceptions\CopyRecursiveException $e) { |
|
251 | + $moveSuccessful = false; |
|
252 | + if ($trashStorage->file_exists($trashInternalPath)) { |
|
253 | + $trashStorage->unlink($trashInternalPath); |
|
254 | + } |
|
255 | + \OCP\Util::writeLog('files_trashbin', 'Couldn\'t move ' . $file_path . ' to the trash bin', \OCP\Util::ERROR); |
|
256 | + } |
|
257 | + |
|
258 | + if ($sourceStorage->file_exists($sourceInternalPath)) { // failed to delete the original file, abort |
|
259 | + if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
260 | + $sourceStorage->rmdir($sourceInternalPath); |
|
261 | + } else { |
|
262 | + $sourceStorage->unlink($sourceInternalPath); |
|
263 | + } |
|
264 | + return false; |
|
265 | + } |
|
266 | + |
|
267 | + $trashStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath); |
|
268 | + |
|
269 | + if ($moveSuccessful) { |
|
270 | + $query = \OC_DB::prepare("INSERT INTO `*PREFIX*files_trash` (`id`,`timestamp`,`location`,`user`) VALUES (?,?,?,?)"); |
|
271 | + $result = $query->execute(array($filename, $timestamp, $location, $owner)); |
|
272 | + if (!$result) { |
|
273 | + \OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated', \OCP\Util::ERROR); |
|
274 | + } |
|
275 | + \OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_moveToTrash', array('filePath' => Filesystem::normalizePath($file_path), |
|
276 | + 'trashPath' => Filesystem::normalizePath($filename . '.d' . $timestamp))); |
|
277 | + |
|
278 | + self::retainVersions($filename, $owner, $ownerPath, $timestamp); |
|
279 | + |
|
280 | + // if owner !== user we need to also add a copy to the users trash |
|
281 | + if ($user !== $owner && $ownerOnly === false) { |
|
282 | + self::copyFilesToUser($ownerPath, $owner, $file_path, $user, $timestamp); |
|
283 | + } |
|
284 | + } |
|
285 | + |
|
286 | + self::scheduleExpire($user); |
|
287 | + |
|
288 | + // if owner !== user we also need to update the owners trash size |
|
289 | + if ($owner !== $user) { |
|
290 | + self::scheduleExpire($owner); |
|
291 | + } |
|
292 | + |
|
293 | + return $moveSuccessful; |
|
294 | + } |
|
295 | + |
|
296 | + /** |
|
297 | + * Move file versions to trash so that they can be restored later |
|
298 | + * |
|
299 | + * @param string $filename of deleted file |
|
300 | + * @param string $owner owner user id |
|
301 | + * @param string $ownerPath path relative to the owner's home storage |
|
302 | + * @param integer $timestamp when the file was deleted |
|
303 | + */ |
|
304 | + private static function retainVersions($filename, $owner, $ownerPath, $timestamp) { |
|
305 | + if (\OCP\App::isEnabled('files_versions') && !empty($ownerPath)) { |
|
306 | + |
|
307 | + $user = User::getUser(); |
|
308 | + $rootView = new View('/'); |
|
309 | + |
|
310 | + if ($rootView->is_dir($owner . '/files_versions/' . $ownerPath)) { |
|
311 | + if ($owner !== $user) { |
|
312 | + self::copy_recursive($owner . '/files_versions/' . $ownerPath, $owner . '/files_trashbin/versions/' . basename($ownerPath) . '.d' . $timestamp, $rootView); |
|
313 | + } |
|
314 | + self::move($rootView, $owner . '/files_versions/' . $ownerPath, $user . '/files_trashbin/versions/' . $filename . '.d' . $timestamp); |
|
315 | + } else if ($versions = \OCA\Files_Versions\Storage::getVersions($owner, $ownerPath)) { |
|
316 | + |
|
317 | + foreach ($versions as $v) { |
|
318 | + if ($owner !== $user) { |
|
319 | + self::copy($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $owner . '/files_trashbin/versions/' . $v['name'] . '.v' . $v['version'] . '.d' . $timestamp); |
|
320 | + } |
|
321 | + self::move($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $user . '/files_trashbin/versions/' . $filename . '.v' . $v['version'] . '.d' . $timestamp); |
|
322 | + } |
|
323 | + } |
|
324 | + } |
|
325 | + } |
|
326 | + |
|
327 | + /** |
|
328 | + * Move a file or folder on storage level |
|
329 | + * |
|
330 | + * @param View $view |
|
331 | + * @param string $source |
|
332 | + * @param string $target |
|
333 | + * @return bool |
|
334 | + */ |
|
335 | + private static function move(View $view, $source, $target) { |
|
336 | + /** @var \OC\Files\Storage\Storage $sourceStorage */ |
|
337 | + list($sourceStorage, $sourceInternalPath) = $view->resolvePath($source); |
|
338 | + /** @var \OC\Files\Storage\Storage $targetStorage */ |
|
339 | + list($targetStorage, $targetInternalPath) = $view->resolvePath($target); |
|
340 | + /** @var \OC\Files\Storage\Storage $ownerTrashStorage */ |
|
341 | + |
|
342 | + $result = $targetStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
|
343 | + if ($result) { |
|
344 | + $targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
|
345 | + } |
|
346 | + return $result; |
|
347 | + } |
|
348 | + |
|
349 | + /** |
|
350 | + * Copy a file or folder on storage level |
|
351 | + * |
|
352 | + * @param View $view |
|
353 | + * @param string $source |
|
354 | + * @param string $target |
|
355 | + * @return bool |
|
356 | + */ |
|
357 | + private static function copy(View $view, $source, $target) { |
|
358 | + /** @var \OC\Files\Storage\Storage $sourceStorage */ |
|
359 | + list($sourceStorage, $sourceInternalPath) = $view->resolvePath($source); |
|
360 | + /** @var \OC\Files\Storage\Storage $targetStorage */ |
|
361 | + list($targetStorage, $targetInternalPath) = $view->resolvePath($target); |
|
362 | + /** @var \OC\Files\Storage\Storage $ownerTrashStorage */ |
|
363 | + |
|
364 | + $result = $targetStorage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
|
365 | + if ($result) { |
|
366 | + $targetStorage->getUpdater()->update($targetInternalPath); |
|
367 | + } |
|
368 | + return $result; |
|
369 | + } |
|
370 | + |
|
371 | + /** |
|
372 | + * Restore a file or folder from trash bin |
|
373 | + * |
|
374 | + * @param string $file path to the deleted file/folder relative to "files_trashbin/files/", |
|
375 | + * including the timestamp suffix ".d12345678" |
|
376 | + * @param string $filename name of the file/folder |
|
377 | + * @param int $timestamp time when the file/folder was deleted |
|
378 | + * |
|
379 | + * @return bool true on success, false otherwise |
|
380 | + */ |
|
381 | + public static function restore($file, $filename, $timestamp) { |
|
382 | + $user = User::getUser(); |
|
383 | + $view = new View('/' . $user); |
|
384 | + |
|
385 | + $location = ''; |
|
386 | + if ($timestamp) { |
|
387 | + $location = self::getLocation($user, $filename, $timestamp); |
|
388 | + if ($location === false) { |
|
389 | + \OCP\Util::writeLog('files_trashbin', 'trash bin database inconsistent! ($user: ' . $user . ' $filename: ' . $filename . ', $timestamp: ' . $timestamp . ')', \OCP\Util::ERROR); |
|
390 | + } else { |
|
391 | + // if location no longer exists, restore file in the root directory |
|
392 | + if ($location !== '/' && |
|
393 | + (!$view->is_dir('files/' . $location) || |
|
394 | + !$view->isCreatable('files/' . $location)) |
|
395 | + ) { |
|
396 | + $location = ''; |
|
397 | + } |
|
398 | + } |
|
399 | + } |
|
400 | + |
|
401 | + // we need a extension in case a file/dir with the same name already exists |
|
402 | + $uniqueFilename = self::getUniqueFilename($location, $filename, $view); |
|
403 | + |
|
404 | + $source = Filesystem::normalizePath('files_trashbin/files/' . $file); |
|
405 | + $target = Filesystem::normalizePath('files/' . $location . '/' . $uniqueFilename); |
|
406 | + if (!$view->file_exists($source)) { |
|
407 | + return false; |
|
408 | + } |
|
409 | + $mtime = $view->filemtime($source); |
|
410 | + |
|
411 | + // restore file |
|
412 | + $restoreResult = $view->rename($source, $target); |
|
413 | + |
|
414 | + // handle the restore result |
|
415 | + if ($restoreResult) { |
|
416 | + $fakeRoot = $view->getRoot(); |
|
417 | + $view->chroot('/' . $user . '/files'); |
|
418 | + $view->touch('/' . $location . '/' . $uniqueFilename, $mtime); |
|
419 | + $view->chroot($fakeRoot); |
|
420 | + \OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', array('filePath' => Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename), |
|
421 | + 'trashPath' => Filesystem::normalizePath($file))); |
|
422 | + |
|
423 | + self::restoreVersions($view, $file, $filename, $uniqueFilename, $location, $timestamp); |
|
424 | + |
|
425 | + if ($timestamp) { |
|
426 | + $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?'); |
|
427 | + $query->execute(array($user, $filename, $timestamp)); |
|
428 | + } |
|
429 | + |
|
430 | + return true; |
|
431 | + } |
|
432 | + |
|
433 | + return false; |
|
434 | + } |
|
435 | + |
|
436 | + /** |
|
437 | + * restore versions from trash bin |
|
438 | + * |
|
439 | + * @param View $view file view |
|
440 | + * @param string $file complete path to file |
|
441 | + * @param string $filename name of file once it was deleted |
|
442 | + * @param string $uniqueFilename new file name to restore the file without overwriting existing files |
|
443 | + * @param string $location location if file |
|
444 | + * @param int $timestamp deletion time |
|
445 | + * @return false|null |
|
446 | + */ |
|
447 | + private static function restoreVersions(View $view, $file, $filename, $uniqueFilename, $location, $timestamp) { |
|
448 | + |
|
449 | + if (\OCP\App::isEnabled('files_versions')) { |
|
450 | + |
|
451 | + $user = User::getUser(); |
|
452 | + $rootView = new View('/'); |
|
453 | + |
|
454 | + $target = Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename); |
|
455 | + |
|
456 | + list($owner, $ownerPath) = self::getUidAndFilename($target); |
|
457 | + |
|
458 | + // file has been deleted in between |
|
459 | + if (empty($ownerPath)) { |
|
460 | + return false; |
|
461 | + } |
|
462 | + |
|
463 | + if ($timestamp) { |
|
464 | + $versionedFile = $filename; |
|
465 | + } else { |
|
466 | + $versionedFile = $file; |
|
467 | + } |
|
468 | + |
|
469 | + if ($view->is_dir('/files_trashbin/versions/' . $file)) { |
|
470 | + $rootView->rename(Filesystem::normalizePath($user . '/files_trashbin/versions/' . $file), Filesystem::normalizePath($owner . '/files_versions/' . $ownerPath)); |
|
471 | + } else if ($versions = self::getVersionsFromTrash($versionedFile, $timestamp, $user)) { |
|
472 | + foreach ($versions as $v) { |
|
473 | + if ($timestamp) { |
|
474 | + $rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v . '.d' . $timestamp, $owner . '/files_versions/' . $ownerPath . '.v' . $v); |
|
475 | + } else { |
|
476 | + $rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v, $owner . '/files_versions/' . $ownerPath . '.v' . $v); |
|
477 | + } |
|
478 | + } |
|
479 | + } |
|
480 | + } |
|
481 | + } |
|
482 | + |
|
483 | + /** |
|
484 | + * delete all files from the trash |
|
485 | + */ |
|
486 | + public static function deleteAll() { |
|
487 | + $user = User::getUser(); |
|
488 | + $view = new View('/' . $user); |
|
489 | + $fileInfos = $view->getDirectoryContent('files_trashbin/files'); |
|
490 | + |
|
491 | + // Array to store the relative path in (after the file is deleted, the view won't be able to relativise the path anymore) |
|
492 | + $filePaths = array(); |
|
493 | + foreach($fileInfos as $fileInfo){ |
|
494 | + $filePaths[] = $view->getRelativePath($fileInfo->getPath()); |
|
495 | + } |
|
496 | + unset($fileInfos); // save memory |
|
497 | + |
|
498 | + // Bulk PreDelete-Hook |
|
499 | + \OC_Hook::emit('\OCP\Trashbin', 'preDeleteAll', array('paths' => $filePaths)); |
|
500 | + |
|
501 | + // Single-File Hooks |
|
502 | + foreach($filePaths as $path){ |
|
503 | + self::emitTrashbinPreDelete($path); |
|
504 | + } |
|
505 | + |
|
506 | + // actual file deletion |
|
507 | + $view->deleteAll('files_trashbin'); |
|
508 | + $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=?'); |
|
509 | + $query->execute(array($user)); |
|
510 | + |
|
511 | + // Bulk PostDelete-Hook |
|
512 | + \OC_Hook::emit('\OCP\Trashbin', 'deleteAll', array('paths' => $filePaths)); |
|
513 | + |
|
514 | + // Single-File Hooks |
|
515 | + foreach($filePaths as $path){ |
|
516 | + self::emitTrashbinPostDelete($path); |
|
517 | + } |
|
518 | + |
|
519 | + $view->mkdir('files_trashbin'); |
|
520 | + $view->mkdir('files_trashbin/files'); |
|
521 | + |
|
522 | + return true; |
|
523 | + } |
|
524 | + |
|
525 | + /** |
|
526 | + * wrapper function to emit the 'preDelete' hook of \OCP\Trashbin before a file is deleted |
|
527 | + * @param string $path |
|
528 | + */ |
|
529 | + protected static function emitTrashbinPreDelete($path){ |
|
530 | + \OC_Hook::emit('\OCP\Trashbin', 'preDelete', array('path' => $path)); |
|
531 | + } |
|
532 | + |
|
533 | + /** |
|
534 | + * wrapper function to emit the 'delete' hook of \OCP\Trashbin after a file has been deleted |
|
535 | + * @param string $path |
|
536 | + */ |
|
537 | + protected static function emitTrashbinPostDelete($path){ |
|
538 | + \OC_Hook::emit('\OCP\Trashbin', 'delete', array('path' => $path)); |
|
539 | + } |
|
540 | + |
|
541 | + /** |
|
542 | + * delete file from trash bin permanently |
|
543 | + * |
|
544 | + * @param string $filename path to the file |
|
545 | + * @param string $user |
|
546 | + * @param int $timestamp of deletion time |
|
547 | + * |
|
548 | + * @return int size of deleted files |
|
549 | + */ |
|
550 | + public static function delete($filename, $user, $timestamp = null) { |
|
551 | + $view = new View('/' . $user); |
|
552 | + $size = 0; |
|
553 | + |
|
554 | + if ($timestamp) { |
|
555 | + $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?'); |
|
556 | + $query->execute(array($user, $filename, $timestamp)); |
|
557 | + $file = $filename . '.d' . $timestamp; |
|
558 | + } else { |
|
559 | + $file = $filename; |
|
560 | + } |
|
561 | + |
|
562 | + $size += self::deleteVersions($view, $file, $filename, $timestamp, $user); |
|
563 | + |
|
564 | + if ($view->is_dir('/files_trashbin/files/' . $file)) { |
|
565 | + $size += self::calculateSize(new View('/' . $user . '/files_trashbin/files/' . $file)); |
|
566 | + } else { |
|
567 | + $size += $view->filesize('/files_trashbin/files/' . $file); |
|
568 | + } |
|
569 | + self::emitTrashbinPreDelete('/files_trashbin/files/' . $file); |
|
570 | + $view->unlink('/files_trashbin/files/' . $file); |
|
571 | + self::emitTrashbinPostDelete('/files_trashbin/files/' . $file); |
|
572 | + |
|
573 | + return $size; |
|
574 | + } |
|
575 | + |
|
576 | + /** |
|
577 | + * @param View $view |
|
578 | + * @param string $file |
|
579 | + * @param string $filename |
|
580 | + * @param integer|null $timestamp |
|
581 | + * @param string $user |
|
582 | + * @return int |
|
583 | + */ |
|
584 | + private static function deleteVersions(View $view, $file, $filename, $timestamp, $user) { |
|
585 | + $size = 0; |
|
586 | + if (\OCP\App::isEnabled('files_versions')) { |
|
587 | + if ($view->is_dir('files_trashbin/versions/' . $file)) { |
|
588 | + $size += self::calculateSize(new View('/' . $user . '/files_trashbin/versions/' . $file)); |
|
589 | + $view->unlink('files_trashbin/versions/' . $file); |
|
590 | + } else if ($versions = self::getVersionsFromTrash($filename, $timestamp, $user)) { |
|
591 | + foreach ($versions as $v) { |
|
592 | + if ($timestamp) { |
|
593 | + $size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp); |
|
594 | + $view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp); |
|
595 | + } else { |
|
596 | + $size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v); |
|
597 | + $view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v); |
|
598 | + } |
|
599 | + } |
|
600 | + } |
|
601 | + } |
|
602 | + return $size; |
|
603 | + } |
|
604 | + |
|
605 | + /** |
|
606 | + * check to see whether a file exists in trashbin |
|
607 | + * |
|
608 | + * @param string $filename path to the file |
|
609 | + * @param int $timestamp of deletion time |
|
610 | + * @return bool true if file exists, otherwise false |
|
611 | + */ |
|
612 | + public static function file_exists($filename, $timestamp = null) { |
|
613 | + $user = User::getUser(); |
|
614 | + $view = new View('/' . $user); |
|
615 | + |
|
616 | + if ($timestamp) { |
|
617 | + $filename = $filename . '.d' . $timestamp; |
|
618 | + } else { |
|
619 | + $filename = $filename; |
|
620 | + } |
|
621 | + |
|
622 | + $target = Filesystem::normalizePath('files_trashbin/files/' . $filename); |
|
623 | + return $view->file_exists($target); |
|
624 | + } |
|
625 | + |
|
626 | + /** |
|
627 | + * deletes used space for trash bin in db if user was deleted |
|
628 | + * |
|
629 | + * @param string $uid id of deleted user |
|
630 | + * @return bool result of db delete operation |
|
631 | + */ |
|
632 | + public static function deleteUser($uid) { |
|
633 | + $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=?'); |
|
634 | + return $query->execute(array($uid)); |
|
635 | + } |
|
636 | + |
|
637 | + /** |
|
638 | + * calculate remaining free space for trash bin |
|
639 | + * |
|
640 | + * @param integer $trashbinSize current size of the trash bin |
|
641 | + * @param string $user |
|
642 | + * @return int available free space for trash bin |
|
643 | + */ |
|
644 | + private static function calculateFreeSpace($trashbinSize, $user) { |
|
645 | + $softQuota = true; |
|
646 | + $userObject = \OC::$server->getUserManager()->get($user); |
|
647 | + if(is_null($userObject)) { |
|
648 | + return 0; |
|
649 | + } |
|
650 | + $quota = $userObject->getQuota(); |
|
651 | + if ($quota === null || $quota === 'none') { |
|
652 | + $quota = Filesystem::free_space('/'); |
|
653 | + $softQuota = false; |
|
654 | + // inf or unknown free space |
|
655 | + if ($quota < 0) { |
|
656 | + $quota = PHP_INT_MAX; |
|
657 | + } |
|
658 | + } else { |
|
659 | + $quota = \OCP\Util::computerFileSize($quota); |
|
660 | + } |
|
661 | + |
|
662 | + // calculate available space for trash bin |
|
663 | + // subtract size of files and current trash bin size from quota |
|
664 | + if ($softQuota) { |
|
665 | + $userFolder = \OC::$server->getUserFolder($user); |
|
666 | + if(is_null($userFolder)) { |
|
667 | + return 0; |
|
668 | + } |
|
669 | + $free = $quota - $userFolder->getSize(); // remaining free space for user |
|
670 | + if ($free > 0) { |
|
671 | + $availableSpace = ($free * self::DEFAULTMAXSIZE / 100) - $trashbinSize; // how much space can be used for versions |
|
672 | + } else { |
|
673 | + $availableSpace = $free - $trashbinSize; |
|
674 | + } |
|
675 | + } else { |
|
676 | + $availableSpace = $quota; |
|
677 | + } |
|
678 | + |
|
679 | + return $availableSpace; |
|
680 | + } |
|
681 | + |
|
682 | + /** |
|
683 | + * resize trash bin if necessary after a new file was added to Nextcloud |
|
684 | + * |
|
685 | + * @param string $user user id |
|
686 | + */ |
|
687 | + public static function resizeTrash($user) { |
|
688 | + |
|
689 | + $size = self::getTrashbinSize($user); |
|
690 | + |
|
691 | + $freeSpace = self::calculateFreeSpace($size, $user); |
|
692 | + |
|
693 | + if ($freeSpace < 0) { |
|
694 | + self::scheduleExpire($user); |
|
695 | + } |
|
696 | + } |
|
697 | + |
|
698 | + /** |
|
699 | + * clean up the trash bin |
|
700 | + * |
|
701 | + * @param string $user |
|
702 | + */ |
|
703 | + public static function expire($user) { |
|
704 | + $trashBinSize = self::getTrashbinSize($user); |
|
705 | + $availableSpace = self::calculateFreeSpace($trashBinSize, $user); |
|
706 | + |
|
707 | + $dirContent = Helper::getTrashFiles('/', $user, 'mtime'); |
|
708 | + |
|
709 | + // delete all files older then $retention_obligation |
|
710 | + list($delSize, $count) = self::deleteExpiredFiles($dirContent, $user); |
|
711 | + |
|
712 | + $availableSpace += $delSize; |
|
713 | + |
|
714 | + // delete files from trash until we meet the trash bin size limit again |
|
715 | + self::deleteFiles(array_slice($dirContent, $count), $user, $availableSpace); |
|
716 | + } |
|
717 | + |
|
718 | + /** |
|
719 | + * @param string $user |
|
720 | + */ |
|
721 | + private static function scheduleExpire($user) { |
|
722 | + // let the admin disable auto expire |
|
723 | + $application = new Application(); |
|
724 | + $expiration = $application->getContainer()->query('Expiration'); |
|
725 | + if ($expiration->isEnabled()) { |
|
726 | + \OC::$server->getCommandBus()->push(new Expire($user)); |
|
727 | + } |
|
728 | + } |
|
729 | + |
|
730 | + /** |
|
731 | + * if the size limit for the trash bin is reached, we delete the oldest |
|
732 | + * files in the trash bin until we meet the limit again |
|
733 | + * |
|
734 | + * @param array $files |
|
735 | + * @param string $user |
|
736 | + * @param int $availableSpace available disc space |
|
737 | + * @return int size of deleted files |
|
738 | + */ |
|
739 | + protected static function deleteFiles($files, $user, $availableSpace) { |
|
740 | + $application = new Application(); |
|
741 | + $expiration = $application->getContainer()->query('Expiration'); |
|
742 | + $size = 0; |
|
743 | + |
|
744 | + if ($availableSpace < 0) { |
|
745 | + foreach ($files as $file) { |
|
746 | + if ($availableSpace < 0 && $expiration->isExpired($file['mtime'], true)) { |
|
747 | + $tmp = self::delete($file['name'], $user, $file['mtime']); |
|
748 | + \OCP\Util::writeLog('files_trashbin', 'remove "' . $file['name'] . '" (' . $tmp . 'B) to meet the limit of trash bin size (50% of available quota)', \OCP\Util::INFO); |
|
749 | + $availableSpace += $tmp; |
|
750 | + $size += $tmp; |
|
751 | + } else { |
|
752 | + break; |
|
753 | + } |
|
754 | + } |
|
755 | + } |
|
756 | + return $size; |
|
757 | + } |
|
758 | + |
|
759 | + /** |
|
760 | + * delete files older then max storage time |
|
761 | + * |
|
762 | + * @param array $files list of files sorted by mtime |
|
763 | + * @param string $user |
|
764 | + * @return integer[] size of deleted files and number of deleted files |
|
765 | + */ |
|
766 | + public static function deleteExpiredFiles($files, $user) { |
|
767 | + $application = new Application(); |
|
768 | + $expiration = $application->getContainer()->query('Expiration'); |
|
769 | + $size = 0; |
|
770 | + $count = 0; |
|
771 | + foreach ($files as $file) { |
|
772 | + $timestamp = $file['mtime']; |
|
773 | + $filename = $file['name']; |
|
774 | + if ($expiration->isExpired($timestamp)) { |
|
775 | + $count++; |
|
776 | + $size += self::delete($filename, $user, $timestamp); |
|
777 | + \OC::$server->getLogger()->info( |
|
778 | + 'Remove "' . $filename . '" from trashbin because it exceeds max retention obligation term.', |
|
779 | + ['app' => 'files_trashbin'] |
|
780 | + ); |
|
781 | + } else { |
|
782 | + break; |
|
783 | + } |
|
784 | + } |
|
785 | + |
|
786 | + return array($size, $count); |
|
787 | + } |
|
788 | + |
|
789 | + /** |
|
790 | + * recursive copy to copy a whole directory |
|
791 | + * |
|
792 | + * @param string $source source path, relative to the users files directory |
|
793 | + * @param string $destination destination path relative to the users root directoy |
|
794 | + * @param View $view file view for the users root directory |
|
795 | + * @return int |
|
796 | + * @throws Exceptions\CopyRecursiveException |
|
797 | + */ |
|
798 | + private static function copy_recursive($source, $destination, View $view) { |
|
799 | + $size = 0; |
|
800 | + if ($view->is_dir($source)) { |
|
801 | + $view->mkdir($destination); |
|
802 | + $view->touch($destination, $view->filemtime($source)); |
|
803 | + foreach ($view->getDirectoryContent($source) as $i) { |
|
804 | + $pathDir = $source . '/' . $i['name']; |
|
805 | + if ($view->is_dir($pathDir)) { |
|
806 | + $size += self::copy_recursive($pathDir, $destination . '/' . $i['name'], $view); |
|
807 | + } else { |
|
808 | + $size += $view->filesize($pathDir); |
|
809 | + $result = $view->copy($pathDir, $destination . '/' . $i['name']); |
|
810 | + if (!$result) { |
|
811 | + throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException(); |
|
812 | + } |
|
813 | + $view->touch($destination . '/' . $i['name'], $view->filemtime($pathDir)); |
|
814 | + } |
|
815 | + } |
|
816 | + } else { |
|
817 | + $size += $view->filesize($source); |
|
818 | + $result = $view->copy($source, $destination); |
|
819 | + if (!$result) { |
|
820 | + throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException(); |
|
821 | + } |
|
822 | + $view->touch($destination, $view->filemtime($source)); |
|
823 | + } |
|
824 | + return $size; |
|
825 | + } |
|
826 | + |
|
827 | + /** |
|
828 | + * find all versions which belong to the file we want to restore |
|
829 | + * |
|
830 | + * @param string $filename name of the file which should be restored |
|
831 | + * @param int $timestamp timestamp when the file was deleted |
|
832 | + * @return array |
|
833 | + */ |
|
834 | + private static function getVersionsFromTrash($filename, $timestamp, $user) { |
|
835 | + $view = new View('/' . $user . '/files_trashbin/versions'); |
|
836 | + $versions = array(); |
|
837 | + |
|
838 | + //force rescan of versions, local storage may not have updated the cache |
|
839 | + if (!self::$scannedVersions) { |
|
840 | + /** @var \OC\Files\Storage\Storage $storage */ |
|
841 | + list($storage,) = $view->resolvePath('/'); |
|
842 | + $storage->getScanner()->scan('files_trashbin/versions'); |
|
843 | + self::$scannedVersions = true; |
|
844 | + } |
|
845 | + |
|
846 | + if ($timestamp) { |
|
847 | + // fetch for old versions |
|
848 | + $matches = $view->searchRaw($filename . '.v%.d' . $timestamp); |
|
849 | + $offset = -strlen($timestamp) - 2; |
|
850 | + } else { |
|
851 | + $matches = $view->searchRaw($filename . '.v%'); |
|
852 | + } |
|
853 | + |
|
854 | + if (is_array($matches)) { |
|
855 | + foreach ($matches as $ma) { |
|
856 | + if ($timestamp) { |
|
857 | + $parts = explode('.v', substr($ma['path'], 0, $offset)); |
|
858 | + $versions[] = (end($parts)); |
|
859 | + } else { |
|
860 | + $parts = explode('.v', $ma); |
|
861 | + $versions[] = (end($parts)); |
|
862 | + } |
|
863 | + } |
|
864 | + } |
|
865 | + return $versions; |
|
866 | + } |
|
867 | + |
|
868 | + /** |
|
869 | + * find unique extension for restored file if a file with the same name already exists |
|
870 | + * |
|
871 | + * @param string $location where the file should be restored |
|
872 | + * @param string $filename name of the file |
|
873 | + * @param View $view filesystem view relative to users root directory |
|
874 | + * @return string with unique extension |
|
875 | + */ |
|
876 | + private static function getUniqueFilename($location, $filename, View $view) { |
|
877 | + $ext = pathinfo($filename, PATHINFO_EXTENSION); |
|
878 | + $name = pathinfo($filename, PATHINFO_FILENAME); |
|
879 | + $l = \OC::$server->getL10N('files_trashbin'); |
|
880 | + |
|
881 | + $location = '/' . trim($location, '/'); |
|
882 | + |
|
883 | + // if extension is not empty we set a dot in front of it |
|
884 | + if ($ext !== '') { |
|
885 | + $ext = '.' . $ext; |
|
886 | + } |
|
887 | + |
|
888 | + if ($view->file_exists('files' . $location . '/' . $filename)) { |
|
889 | + $i = 2; |
|
890 | + $uniqueName = $name . " (" . $l->t("restored") . ")" . $ext; |
|
891 | + while ($view->file_exists('files' . $location . '/' . $uniqueName)) { |
|
892 | + $uniqueName = $name . " (" . $l->t("restored") . " " . $i . ")" . $ext; |
|
893 | + $i++; |
|
894 | + } |
|
895 | + |
|
896 | + return $uniqueName; |
|
897 | + } |
|
898 | + |
|
899 | + return $filename; |
|
900 | + } |
|
901 | + |
|
902 | + /** |
|
903 | + * get the size from a given root folder |
|
904 | + * |
|
905 | + * @param View $view file view on the root folder |
|
906 | + * @return integer size of the folder |
|
907 | + */ |
|
908 | + private static function calculateSize($view) { |
|
909 | + $root = \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . $view->getAbsolutePath(''); |
|
910 | + if (!file_exists($root)) { |
|
911 | + return 0; |
|
912 | + } |
|
913 | + $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($root), \RecursiveIteratorIterator::CHILD_FIRST); |
|
914 | + $size = 0; |
|
915 | + |
|
916 | + /** |
|
917 | + * RecursiveDirectoryIterator on an NFS path isn't iterable with foreach |
|
918 | + * This bug is fixed in PHP 5.5.9 or before |
|
919 | + * See #8376 |
|
920 | + */ |
|
921 | + $iterator->rewind(); |
|
922 | + while ($iterator->valid()) { |
|
923 | + $path = $iterator->current(); |
|
924 | + $relpath = substr($path, strlen($root) - 1); |
|
925 | + if (!$view->is_dir($relpath)) { |
|
926 | + $size += $view->filesize($relpath); |
|
927 | + } |
|
928 | + $iterator->next(); |
|
929 | + } |
|
930 | + return $size; |
|
931 | + } |
|
932 | + |
|
933 | + /** |
|
934 | + * get current size of trash bin from a given user |
|
935 | + * |
|
936 | + * @param string $user user who owns the trash bin |
|
937 | + * @return integer trash bin size |
|
938 | + */ |
|
939 | + private static function getTrashbinSize($user) { |
|
940 | + $view = new View('/' . $user); |
|
941 | + $fileInfo = $view->getFileInfo('/files_trashbin'); |
|
942 | + return isset($fileInfo['size']) ? $fileInfo['size'] : 0; |
|
943 | + } |
|
944 | + |
|
945 | + /** |
|
946 | + * register hooks |
|
947 | + */ |
|
948 | + public static function registerHooks() { |
|
949 | + // create storage wrapper on setup |
|
950 | + \OCP\Util::connectHook('OC_Filesystem', 'preSetup', 'OCA\Files_Trashbin\Storage', 'setupStorage'); |
|
951 | + //Listen to delete user signal |
|
952 | + \OCP\Util::connectHook('OC_User', 'pre_deleteUser', 'OCA\Files_Trashbin\Hooks', 'deleteUser_hook'); |
|
953 | + //Listen to post write hook |
|
954 | + \OCP\Util::connectHook('OC_Filesystem', 'post_write', 'OCA\Files_Trashbin\Hooks', 'post_write_hook'); |
|
955 | + // pre and post-rename, disable trash logic for the copy+unlink case |
|
956 | + \OCP\Util::connectHook('OC_Filesystem', 'delete', 'OCA\Files_Trashbin\Trashbin', 'ensureFileScannedHook'); |
|
957 | + \OCP\Util::connectHook('OC_Filesystem', 'rename', 'OCA\Files_Trashbin\Storage', 'preRenameHook'); |
|
958 | + \OCP\Util::connectHook('OC_Filesystem', 'post_rename', 'OCA\Files_Trashbin\Storage', 'postRenameHook'); |
|
959 | + } |
|
960 | + |
|
961 | + /** |
|
962 | + * check if trash bin is empty for a given user |
|
963 | + * |
|
964 | + * @param string $user |
|
965 | + * @return bool |
|
966 | + */ |
|
967 | + public static function isEmpty($user) { |
|
968 | + |
|
969 | + $view = new View('/' . $user . '/files_trashbin'); |
|
970 | + if ($view->is_dir('/files') && $dh = $view->opendir('/files')) { |
|
971 | + while ($file = readdir($dh)) { |
|
972 | + if (!Filesystem::isIgnoredDir($file)) { |
|
973 | + return false; |
|
974 | + } |
|
975 | + } |
|
976 | + } |
|
977 | + return true; |
|
978 | + } |
|
979 | + |
|
980 | + /** |
|
981 | + * @param $path |
|
982 | + * @return string |
|
983 | + */ |
|
984 | + public static function preview_icon($path) { |
|
985 | + return \OCP\Util::linkToRoute('core_ajax_trashbin_preview', array('x' => 32, 'y' => 32, 'file' => $path)); |
|
986 | + } |
|
987 | 987 | } |
@@ -95,7 +95,7 @@ discard block |
||
95 | 95 | Filesystem::initMountPoints($uid); |
96 | 96 | if ($uid != User::getUser()) { |
97 | 97 | $info = Filesystem::getFileInfo($filename); |
98 | - $ownerView = new View('/' . $uid . '/files'); |
|
98 | + $ownerView = new View('/'.$uid.'/files'); |
|
99 | 99 | try { |
100 | 100 | $filename = $ownerView->getPath($info['fileid']); |
101 | 101 | } catch (NotFoundException $e) { |
@@ -146,7 +146,7 @@ discard block |
||
146 | 146 | } |
147 | 147 | |
148 | 148 | private static function setUpTrash($user) { |
149 | - $view = new View('/' . $user); |
|
149 | + $view = new View('/'.$user); |
|
150 | 150 | if (!$view->is_dir('files_trashbin')) { |
151 | 151 | $view->mkdir('files_trashbin'); |
152 | 152 | } |
@@ -181,8 +181,8 @@ discard block |
||
181 | 181 | |
182 | 182 | $view = new View('/'); |
183 | 183 | |
184 | - $target = $user . '/files_trashbin/files/' . $targetFilename . '.d' . $timestamp; |
|
185 | - $source = $owner . '/files_trashbin/files/' . $sourceFilename . '.d' . $timestamp; |
|
184 | + $target = $user.'/files_trashbin/files/'.$targetFilename.'.d'.$timestamp; |
|
185 | + $source = $owner.'/files_trashbin/files/'.$sourceFilename.'.d'.$timestamp; |
|
186 | 186 | self::copy_recursive($source, $target, $view); |
187 | 187 | |
188 | 188 | |
@@ -216,9 +216,9 @@ discard block |
||
216 | 216 | $ownerPath = $file_path; |
217 | 217 | } |
218 | 218 | |
219 | - $ownerView = new View('/' . $owner); |
|
219 | + $ownerView = new View('/'.$owner); |
|
220 | 220 | // file has been deleted in between |
221 | - if (is_null($ownerPath) || $ownerPath === '' || !$ownerView->file_exists('/files/' . $ownerPath)) { |
|
221 | + if (is_null($ownerPath) || $ownerPath === '' || !$ownerView->file_exists('/files/'.$ownerPath)) { |
|
222 | 222 | return true; |
223 | 223 | } |
224 | 224 | |
@@ -235,12 +235,12 @@ discard block |
||
235 | 235 | $timestamp = time(); |
236 | 236 | |
237 | 237 | // disable proxy to prevent recursive calls |
238 | - $trashPath = '/files_trashbin/files/' . $filename . '.d' . $timestamp; |
|
238 | + $trashPath = '/files_trashbin/files/'.$filename.'.d'.$timestamp; |
|
239 | 239 | |
240 | 240 | /** @var \OC\Files\Storage\Storage $trashStorage */ |
241 | 241 | list($trashStorage, $trashInternalPath) = $ownerView->resolvePath($trashPath); |
242 | 242 | /** @var \OC\Files\Storage\Storage $sourceStorage */ |
243 | - list($sourceStorage, $sourceInternalPath) = $ownerView->resolvePath('/files/' . $ownerPath); |
|
243 | + list($sourceStorage, $sourceInternalPath) = $ownerView->resolvePath('/files/'.$ownerPath); |
|
244 | 244 | try { |
245 | 245 | $moveSuccessful = true; |
246 | 246 | if ($trashStorage->file_exists($trashInternalPath)) { |
@@ -252,7 +252,7 @@ discard block |
||
252 | 252 | if ($trashStorage->file_exists($trashInternalPath)) { |
253 | 253 | $trashStorage->unlink($trashInternalPath); |
254 | 254 | } |
255 | - \OCP\Util::writeLog('files_trashbin', 'Couldn\'t move ' . $file_path . ' to the trash bin', \OCP\Util::ERROR); |
|
255 | + \OCP\Util::writeLog('files_trashbin', 'Couldn\'t move '.$file_path.' to the trash bin', \OCP\Util::ERROR); |
|
256 | 256 | } |
257 | 257 | |
258 | 258 | if ($sourceStorage->file_exists($sourceInternalPath)) { // failed to delete the original file, abort |
@@ -273,7 +273,7 @@ discard block |
||
273 | 273 | \OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated', \OCP\Util::ERROR); |
274 | 274 | } |
275 | 275 | \OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_moveToTrash', array('filePath' => Filesystem::normalizePath($file_path), |
276 | - 'trashPath' => Filesystem::normalizePath($filename . '.d' . $timestamp))); |
|
276 | + 'trashPath' => Filesystem::normalizePath($filename.'.d'.$timestamp))); |
|
277 | 277 | |
278 | 278 | self::retainVersions($filename, $owner, $ownerPath, $timestamp); |
279 | 279 | |
@@ -307,18 +307,18 @@ discard block |
||
307 | 307 | $user = User::getUser(); |
308 | 308 | $rootView = new View('/'); |
309 | 309 | |
310 | - if ($rootView->is_dir($owner . '/files_versions/' . $ownerPath)) { |
|
310 | + if ($rootView->is_dir($owner.'/files_versions/'.$ownerPath)) { |
|
311 | 311 | if ($owner !== $user) { |
312 | - self::copy_recursive($owner . '/files_versions/' . $ownerPath, $owner . '/files_trashbin/versions/' . basename($ownerPath) . '.d' . $timestamp, $rootView); |
|
312 | + self::copy_recursive($owner.'/files_versions/'.$ownerPath, $owner.'/files_trashbin/versions/'.basename($ownerPath).'.d'.$timestamp, $rootView); |
|
313 | 313 | } |
314 | - self::move($rootView, $owner . '/files_versions/' . $ownerPath, $user . '/files_trashbin/versions/' . $filename . '.d' . $timestamp); |
|
314 | + self::move($rootView, $owner.'/files_versions/'.$ownerPath, $user.'/files_trashbin/versions/'.$filename.'.d'.$timestamp); |
|
315 | 315 | } else if ($versions = \OCA\Files_Versions\Storage::getVersions($owner, $ownerPath)) { |
316 | 316 | |
317 | 317 | foreach ($versions as $v) { |
318 | 318 | if ($owner !== $user) { |
319 | - self::copy($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $owner . '/files_trashbin/versions/' . $v['name'] . '.v' . $v['version'] . '.d' . $timestamp); |
|
319 | + self::copy($rootView, $owner.'/files_versions'.$v['path'].'.v'.$v['version'], $owner.'/files_trashbin/versions/'.$v['name'].'.v'.$v['version'].'.d'.$timestamp); |
|
320 | 320 | } |
321 | - self::move($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $user . '/files_trashbin/versions/' . $filename . '.v' . $v['version'] . '.d' . $timestamp); |
|
321 | + self::move($rootView, $owner.'/files_versions'.$v['path'].'.v'.$v['version'], $user.'/files_trashbin/versions/'.$filename.'.v'.$v['version'].'.d'.$timestamp); |
|
322 | 322 | } |
323 | 323 | } |
324 | 324 | } |
@@ -380,18 +380,18 @@ discard block |
||
380 | 380 | */ |
381 | 381 | public static function restore($file, $filename, $timestamp) { |
382 | 382 | $user = User::getUser(); |
383 | - $view = new View('/' . $user); |
|
383 | + $view = new View('/'.$user); |
|
384 | 384 | |
385 | 385 | $location = ''; |
386 | 386 | if ($timestamp) { |
387 | 387 | $location = self::getLocation($user, $filename, $timestamp); |
388 | 388 | if ($location === false) { |
389 | - \OCP\Util::writeLog('files_trashbin', 'trash bin database inconsistent! ($user: ' . $user . ' $filename: ' . $filename . ', $timestamp: ' . $timestamp . ')', \OCP\Util::ERROR); |
|
389 | + \OCP\Util::writeLog('files_trashbin', 'trash bin database inconsistent! ($user: '.$user.' $filename: '.$filename.', $timestamp: '.$timestamp.')', \OCP\Util::ERROR); |
|
390 | 390 | } else { |
391 | 391 | // if location no longer exists, restore file in the root directory |
392 | 392 | if ($location !== '/' && |
393 | - (!$view->is_dir('files/' . $location) || |
|
394 | - !$view->isCreatable('files/' . $location)) |
|
393 | + (!$view->is_dir('files/'.$location) || |
|
394 | + !$view->isCreatable('files/'.$location)) |
|
395 | 395 | ) { |
396 | 396 | $location = ''; |
397 | 397 | } |
@@ -401,8 +401,8 @@ discard block |
||
401 | 401 | // we need a extension in case a file/dir with the same name already exists |
402 | 402 | $uniqueFilename = self::getUniqueFilename($location, $filename, $view); |
403 | 403 | |
404 | - $source = Filesystem::normalizePath('files_trashbin/files/' . $file); |
|
405 | - $target = Filesystem::normalizePath('files/' . $location . '/' . $uniqueFilename); |
|
404 | + $source = Filesystem::normalizePath('files_trashbin/files/'.$file); |
|
405 | + $target = Filesystem::normalizePath('files/'.$location.'/'.$uniqueFilename); |
|
406 | 406 | if (!$view->file_exists($source)) { |
407 | 407 | return false; |
408 | 408 | } |
@@ -414,10 +414,10 @@ discard block |
||
414 | 414 | // handle the restore result |
415 | 415 | if ($restoreResult) { |
416 | 416 | $fakeRoot = $view->getRoot(); |
417 | - $view->chroot('/' . $user . '/files'); |
|
418 | - $view->touch('/' . $location . '/' . $uniqueFilename, $mtime); |
|
417 | + $view->chroot('/'.$user.'/files'); |
|
418 | + $view->touch('/'.$location.'/'.$uniqueFilename, $mtime); |
|
419 | 419 | $view->chroot($fakeRoot); |
420 | - \OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', array('filePath' => Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename), |
|
420 | + \OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', array('filePath' => Filesystem::normalizePath('/'.$location.'/'.$uniqueFilename), |
|
421 | 421 | 'trashPath' => Filesystem::normalizePath($file))); |
422 | 422 | |
423 | 423 | self::restoreVersions($view, $file, $filename, $uniqueFilename, $location, $timestamp); |
@@ -451,7 +451,7 @@ discard block |
||
451 | 451 | $user = User::getUser(); |
452 | 452 | $rootView = new View('/'); |
453 | 453 | |
454 | - $target = Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename); |
|
454 | + $target = Filesystem::normalizePath('/'.$location.'/'.$uniqueFilename); |
|
455 | 455 | |
456 | 456 | list($owner, $ownerPath) = self::getUidAndFilename($target); |
457 | 457 | |
@@ -466,14 +466,14 @@ discard block |
||
466 | 466 | $versionedFile = $file; |
467 | 467 | } |
468 | 468 | |
469 | - if ($view->is_dir('/files_trashbin/versions/' . $file)) { |
|
470 | - $rootView->rename(Filesystem::normalizePath($user . '/files_trashbin/versions/' . $file), Filesystem::normalizePath($owner . '/files_versions/' . $ownerPath)); |
|
469 | + if ($view->is_dir('/files_trashbin/versions/'.$file)) { |
|
470 | + $rootView->rename(Filesystem::normalizePath($user.'/files_trashbin/versions/'.$file), Filesystem::normalizePath($owner.'/files_versions/'.$ownerPath)); |
|
471 | 471 | } else if ($versions = self::getVersionsFromTrash($versionedFile, $timestamp, $user)) { |
472 | 472 | foreach ($versions as $v) { |
473 | 473 | if ($timestamp) { |
474 | - $rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v . '.d' . $timestamp, $owner . '/files_versions/' . $ownerPath . '.v' . $v); |
|
474 | + $rootView->rename($user.'/files_trashbin/versions/'.$versionedFile.'.v'.$v.'.d'.$timestamp, $owner.'/files_versions/'.$ownerPath.'.v'.$v); |
|
475 | 475 | } else { |
476 | - $rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v, $owner . '/files_versions/' . $ownerPath . '.v' . $v); |
|
476 | + $rootView->rename($user.'/files_trashbin/versions/'.$versionedFile.'.v'.$v, $owner.'/files_versions/'.$ownerPath.'.v'.$v); |
|
477 | 477 | } |
478 | 478 | } |
479 | 479 | } |
@@ -485,12 +485,12 @@ discard block |
||
485 | 485 | */ |
486 | 486 | public static function deleteAll() { |
487 | 487 | $user = User::getUser(); |
488 | - $view = new View('/' . $user); |
|
488 | + $view = new View('/'.$user); |
|
489 | 489 | $fileInfos = $view->getDirectoryContent('files_trashbin/files'); |
490 | 490 | |
491 | 491 | // Array to store the relative path in (after the file is deleted, the view won't be able to relativise the path anymore) |
492 | 492 | $filePaths = array(); |
493 | - foreach($fileInfos as $fileInfo){ |
|
493 | + foreach ($fileInfos as $fileInfo) { |
|
494 | 494 | $filePaths[] = $view->getRelativePath($fileInfo->getPath()); |
495 | 495 | } |
496 | 496 | unset($fileInfos); // save memory |
@@ -499,7 +499,7 @@ discard block |
||
499 | 499 | \OC_Hook::emit('\OCP\Trashbin', 'preDeleteAll', array('paths' => $filePaths)); |
500 | 500 | |
501 | 501 | // Single-File Hooks |
502 | - foreach($filePaths as $path){ |
|
502 | + foreach ($filePaths as $path) { |
|
503 | 503 | self::emitTrashbinPreDelete($path); |
504 | 504 | } |
505 | 505 | |
@@ -512,7 +512,7 @@ discard block |
||
512 | 512 | \OC_Hook::emit('\OCP\Trashbin', 'deleteAll', array('paths' => $filePaths)); |
513 | 513 | |
514 | 514 | // Single-File Hooks |
515 | - foreach($filePaths as $path){ |
|
515 | + foreach ($filePaths as $path) { |
|
516 | 516 | self::emitTrashbinPostDelete($path); |
517 | 517 | } |
518 | 518 | |
@@ -526,7 +526,7 @@ discard block |
||
526 | 526 | * wrapper function to emit the 'preDelete' hook of \OCP\Trashbin before a file is deleted |
527 | 527 | * @param string $path |
528 | 528 | */ |
529 | - protected static function emitTrashbinPreDelete($path){ |
|
529 | + protected static function emitTrashbinPreDelete($path) { |
|
530 | 530 | \OC_Hook::emit('\OCP\Trashbin', 'preDelete', array('path' => $path)); |
531 | 531 | } |
532 | 532 | |
@@ -534,7 +534,7 @@ discard block |
||
534 | 534 | * wrapper function to emit the 'delete' hook of \OCP\Trashbin after a file has been deleted |
535 | 535 | * @param string $path |
536 | 536 | */ |
537 | - protected static function emitTrashbinPostDelete($path){ |
|
537 | + protected static function emitTrashbinPostDelete($path) { |
|
538 | 538 | \OC_Hook::emit('\OCP\Trashbin', 'delete', array('path' => $path)); |
539 | 539 | } |
540 | 540 | |
@@ -548,27 +548,27 @@ discard block |
||
548 | 548 | * @return int size of deleted files |
549 | 549 | */ |
550 | 550 | public static function delete($filename, $user, $timestamp = null) { |
551 | - $view = new View('/' . $user); |
|
551 | + $view = new View('/'.$user); |
|
552 | 552 | $size = 0; |
553 | 553 | |
554 | 554 | if ($timestamp) { |
555 | 555 | $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?'); |
556 | 556 | $query->execute(array($user, $filename, $timestamp)); |
557 | - $file = $filename . '.d' . $timestamp; |
|
557 | + $file = $filename.'.d'.$timestamp; |
|
558 | 558 | } else { |
559 | 559 | $file = $filename; |
560 | 560 | } |
561 | 561 | |
562 | 562 | $size += self::deleteVersions($view, $file, $filename, $timestamp, $user); |
563 | 563 | |
564 | - if ($view->is_dir('/files_trashbin/files/' . $file)) { |
|
565 | - $size += self::calculateSize(new View('/' . $user . '/files_trashbin/files/' . $file)); |
|
564 | + if ($view->is_dir('/files_trashbin/files/'.$file)) { |
|
565 | + $size += self::calculateSize(new View('/'.$user.'/files_trashbin/files/'.$file)); |
|
566 | 566 | } else { |
567 | - $size += $view->filesize('/files_trashbin/files/' . $file); |
|
567 | + $size += $view->filesize('/files_trashbin/files/'.$file); |
|
568 | 568 | } |
569 | - self::emitTrashbinPreDelete('/files_trashbin/files/' . $file); |
|
570 | - $view->unlink('/files_trashbin/files/' . $file); |
|
571 | - self::emitTrashbinPostDelete('/files_trashbin/files/' . $file); |
|
569 | + self::emitTrashbinPreDelete('/files_trashbin/files/'.$file); |
|
570 | + $view->unlink('/files_trashbin/files/'.$file); |
|
571 | + self::emitTrashbinPostDelete('/files_trashbin/files/'.$file); |
|
572 | 572 | |
573 | 573 | return $size; |
574 | 574 | } |
@@ -584,17 +584,17 @@ discard block |
||
584 | 584 | private static function deleteVersions(View $view, $file, $filename, $timestamp, $user) { |
585 | 585 | $size = 0; |
586 | 586 | if (\OCP\App::isEnabled('files_versions')) { |
587 | - if ($view->is_dir('files_trashbin/versions/' . $file)) { |
|
588 | - $size += self::calculateSize(new View('/' . $user . '/files_trashbin/versions/' . $file)); |
|
589 | - $view->unlink('files_trashbin/versions/' . $file); |
|
587 | + if ($view->is_dir('files_trashbin/versions/'.$file)) { |
|
588 | + $size += self::calculateSize(new View('/'.$user.'/files_trashbin/versions/'.$file)); |
|
589 | + $view->unlink('files_trashbin/versions/'.$file); |
|
590 | 590 | } else if ($versions = self::getVersionsFromTrash($filename, $timestamp, $user)) { |
591 | 591 | foreach ($versions as $v) { |
592 | 592 | if ($timestamp) { |
593 | - $size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp); |
|
594 | - $view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp); |
|
593 | + $size += $view->filesize('/files_trashbin/versions/'.$filename.'.v'.$v.'.d'.$timestamp); |
|
594 | + $view->unlink('/files_trashbin/versions/'.$filename.'.v'.$v.'.d'.$timestamp); |
|
595 | 595 | } else { |
596 | - $size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v); |
|
597 | - $view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v); |
|
596 | + $size += $view->filesize('/files_trashbin/versions/'.$filename.'.v'.$v); |
|
597 | + $view->unlink('/files_trashbin/versions/'.$filename.'.v'.$v); |
|
598 | 598 | } |
599 | 599 | } |
600 | 600 | } |
@@ -611,15 +611,15 @@ discard block |
||
611 | 611 | */ |
612 | 612 | public static function file_exists($filename, $timestamp = null) { |
613 | 613 | $user = User::getUser(); |
614 | - $view = new View('/' . $user); |
|
614 | + $view = new View('/'.$user); |
|
615 | 615 | |
616 | 616 | if ($timestamp) { |
617 | - $filename = $filename . '.d' . $timestamp; |
|
617 | + $filename = $filename.'.d'.$timestamp; |
|
618 | 618 | } else { |
619 | 619 | $filename = $filename; |
620 | 620 | } |
621 | 621 | |
622 | - $target = Filesystem::normalizePath('files_trashbin/files/' . $filename); |
|
622 | + $target = Filesystem::normalizePath('files_trashbin/files/'.$filename); |
|
623 | 623 | return $view->file_exists($target); |
624 | 624 | } |
625 | 625 | |
@@ -644,7 +644,7 @@ discard block |
||
644 | 644 | private static function calculateFreeSpace($trashbinSize, $user) { |
645 | 645 | $softQuota = true; |
646 | 646 | $userObject = \OC::$server->getUserManager()->get($user); |
647 | - if(is_null($userObject)) { |
|
647 | + if (is_null($userObject)) { |
|
648 | 648 | return 0; |
649 | 649 | } |
650 | 650 | $quota = $userObject->getQuota(); |
@@ -663,7 +663,7 @@ discard block |
||
663 | 663 | // subtract size of files and current trash bin size from quota |
664 | 664 | if ($softQuota) { |
665 | 665 | $userFolder = \OC::$server->getUserFolder($user); |
666 | - if(is_null($userFolder)) { |
|
666 | + if (is_null($userFolder)) { |
|
667 | 667 | return 0; |
668 | 668 | } |
669 | 669 | $free = $quota - $userFolder->getSize(); // remaining free space for user |
@@ -745,7 +745,7 @@ discard block |
||
745 | 745 | foreach ($files as $file) { |
746 | 746 | if ($availableSpace < 0 && $expiration->isExpired($file['mtime'], true)) { |
747 | 747 | $tmp = self::delete($file['name'], $user, $file['mtime']); |
748 | - \OCP\Util::writeLog('files_trashbin', 'remove "' . $file['name'] . '" (' . $tmp . 'B) to meet the limit of trash bin size (50% of available quota)', \OCP\Util::INFO); |
|
748 | + \OCP\Util::writeLog('files_trashbin', 'remove "'.$file['name'].'" ('.$tmp.'B) to meet the limit of trash bin size (50% of available quota)', \OCP\Util::INFO); |
|
749 | 749 | $availableSpace += $tmp; |
750 | 750 | $size += $tmp; |
751 | 751 | } else { |
@@ -775,7 +775,7 @@ discard block |
||
775 | 775 | $count++; |
776 | 776 | $size += self::delete($filename, $user, $timestamp); |
777 | 777 | \OC::$server->getLogger()->info( |
778 | - 'Remove "' . $filename . '" from trashbin because it exceeds max retention obligation term.', |
|
778 | + 'Remove "'.$filename.'" from trashbin because it exceeds max retention obligation term.', |
|
779 | 779 | ['app' => 'files_trashbin'] |
780 | 780 | ); |
781 | 781 | } else { |
@@ -801,16 +801,16 @@ discard block |
||
801 | 801 | $view->mkdir($destination); |
802 | 802 | $view->touch($destination, $view->filemtime($source)); |
803 | 803 | foreach ($view->getDirectoryContent($source) as $i) { |
804 | - $pathDir = $source . '/' . $i['name']; |
|
804 | + $pathDir = $source.'/'.$i['name']; |
|
805 | 805 | if ($view->is_dir($pathDir)) { |
806 | - $size += self::copy_recursive($pathDir, $destination . '/' . $i['name'], $view); |
|
806 | + $size += self::copy_recursive($pathDir, $destination.'/'.$i['name'], $view); |
|
807 | 807 | } else { |
808 | 808 | $size += $view->filesize($pathDir); |
809 | - $result = $view->copy($pathDir, $destination . '/' . $i['name']); |
|
809 | + $result = $view->copy($pathDir, $destination.'/'.$i['name']); |
|
810 | 810 | if (!$result) { |
811 | 811 | throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException(); |
812 | 812 | } |
813 | - $view->touch($destination . '/' . $i['name'], $view->filemtime($pathDir)); |
|
813 | + $view->touch($destination.'/'.$i['name'], $view->filemtime($pathDir)); |
|
814 | 814 | } |
815 | 815 | } |
816 | 816 | } else { |
@@ -832,7 +832,7 @@ discard block |
||
832 | 832 | * @return array |
833 | 833 | */ |
834 | 834 | private static function getVersionsFromTrash($filename, $timestamp, $user) { |
835 | - $view = new View('/' . $user . '/files_trashbin/versions'); |
|
835 | + $view = new View('/'.$user.'/files_trashbin/versions'); |
|
836 | 836 | $versions = array(); |
837 | 837 | |
838 | 838 | //force rescan of versions, local storage may not have updated the cache |
@@ -845,10 +845,10 @@ discard block |
||
845 | 845 | |
846 | 846 | if ($timestamp) { |
847 | 847 | // fetch for old versions |
848 | - $matches = $view->searchRaw($filename . '.v%.d' . $timestamp); |
|
848 | + $matches = $view->searchRaw($filename.'.v%.d'.$timestamp); |
|
849 | 849 | $offset = -strlen($timestamp) - 2; |
850 | 850 | } else { |
851 | - $matches = $view->searchRaw($filename . '.v%'); |
|
851 | + $matches = $view->searchRaw($filename.'.v%'); |
|
852 | 852 | } |
853 | 853 | |
854 | 854 | if (is_array($matches)) { |
@@ -878,18 +878,18 @@ discard block |
||
878 | 878 | $name = pathinfo($filename, PATHINFO_FILENAME); |
879 | 879 | $l = \OC::$server->getL10N('files_trashbin'); |
880 | 880 | |
881 | - $location = '/' . trim($location, '/'); |
|
881 | + $location = '/'.trim($location, '/'); |
|
882 | 882 | |
883 | 883 | // if extension is not empty we set a dot in front of it |
884 | 884 | if ($ext !== '') { |
885 | - $ext = '.' . $ext; |
|
885 | + $ext = '.'.$ext; |
|
886 | 886 | } |
887 | 887 | |
888 | - if ($view->file_exists('files' . $location . '/' . $filename)) { |
|
888 | + if ($view->file_exists('files'.$location.'/'.$filename)) { |
|
889 | 889 | $i = 2; |
890 | - $uniqueName = $name . " (" . $l->t("restored") . ")" . $ext; |
|
891 | - while ($view->file_exists('files' . $location . '/' . $uniqueName)) { |
|
892 | - $uniqueName = $name . " (" . $l->t("restored") . " " . $i . ")" . $ext; |
|
890 | + $uniqueName = $name." (".$l->t("restored").")".$ext; |
|
891 | + while ($view->file_exists('files'.$location.'/'.$uniqueName)) { |
|
892 | + $uniqueName = $name." (".$l->t("restored")." ".$i.")".$ext; |
|
893 | 893 | $i++; |
894 | 894 | } |
895 | 895 | |
@@ -906,7 +906,7 @@ discard block |
||
906 | 906 | * @return integer size of the folder |
907 | 907 | */ |
908 | 908 | private static function calculateSize($view) { |
909 | - $root = \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . $view->getAbsolutePath(''); |
|
909 | + $root = \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data').$view->getAbsolutePath(''); |
|
910 | 910 | if (!file_exists($root)) { |
911 | 911 | return 0; |
912 | 912 | } |
@@ -937,7 +937,7 @@ discard block |
||
937 | 937 | * @return integer trash bin size |
938 | 938 | */ |
939 | 939 | private static function getTrashbinSize($user) { |
940 | - $view = new View('/' . $user); |
|
940 | + $view = new View('/'.$user); |
|
941 | 941 | $fileInfo = $view->getFileInfo('/files_trashbin'); |
942 | 942 | return isset($fileInfo['size']) ? $fileInfo['size'] : 0; |
943 | 943 | } |
@@ -966,7 +966,7 @@ discard block |
||
966 | 966 | */ |
967 | 967 | public static function isEmpty($user) { |
968 | 968 | |
969 | - $view = new View('/' . $user . '/files_trashbin'); |
|
969 | + $view = new View('/'.$user.'/files_trashbin'); |
|
970 | 970 | if ($view->is_dir('/files') && $dh = $view->opendir('/files')) { |
971 | 971 | while ($file = readdir($dh)) { |
972 | 972 | if (!Filesystem::isIgnoredDir($file)) { |
@@ -80,7 +80,7 @@ |
||
80 | 80 | |
81 | 81 | /** |
82 | 82 | * @param array $parameters |
83 | - * @return int |
|
83 | + * @return string |
|
84 | 84 | */ |
85 | 85 | protected function getPath($parameters) { |
86 | 86 | $node = \OC::$server->getRootFolder() |
@@ -35,194 +35,194 @@ |
||
35 | 35 | |
36 | 36 | class Provisioning { |
37 | 37 | |
38 | - /** @var ILockingProvider */ |
|
39 | - protected $lockingProvider; |
|
40 | - |
|
41 | - /** @var IDBConnection */ |
|
42 | - protected $connection; |
|
43 | - |
|
44 | - /** @var IConfig */ |
|
45 | - protected $config; |
|
46 | - |
|
47 | - /** @var IRequest */ |
|
48 | - protected $request; |
|
49 | - |
|
50 | - /** |
|
51 | - * @param ILockingProvider $lockingProvider |
|
52 | - * @param IDBConnection $connection |
|
53 | - * @param IConfig $config |
|
54 | - * @param IRequest $request |
|
55 | - */ |
|
56 | - public function __construct(ILockingProvider $lockingProvider, IDBConnection $connection, IConfig $config, IRequest $request) { |
|
57 | - $this->lockingProvider = $lockingProvider; |
|
58 | - $this->connection = $connection; |
|
59 | - $this->config = $config; |
|
60 | - $this->request = $request; |
|
61 | - } |
|
62 | - |
|
63 | - /** |
|
64 | - * @return ILockingProvider |
|
65 | - */ |
|
66 | - protected function getLockingProvider() { |
|
67 | - if ($this->lockingProvider instanceof DBLockingProvider) { |
|
68 | - return \OC::$server->query('OCA\Testing\Locking\FakeDBLockingProvider'); |
|
69 | - } else { |
|
70 | - throw new \RuntimeException('Lock provisioning is only possible using the DBLockingProvider'); |
|
71 | - } |
|
72 | - } |
|
73 | - |
|
74 | - /** |
|
75 | - * @param array $parameters |
|
76 | - * @return int |
|
77 | - */ |
|
78 | - protected function getType($parameters) { |
|
79 | - return isset($parameters['type']) ? (int) $parameters['type'] : 0; |
|
80 | - } |
|
81 | - |
|
82 | - /** |
|
83 | - * @param array $parameters |
|
84 | - * @return int |
|
85 | - */ |
|
86 | - protected function getPath($parameters) { |
|
87 | - $node = \OC::$server->getRootFolder() |
|
88 | - ->getUserFolder($parameters['user']) |
|
89 | - ->get($this->request->getParam('path')); |
|
90 | - return 'files/' . md5($node->getStorage()->getId() . '::' . trim($node->getInternalPath(), '/')); |
|
91 | - } |
|
92 | - |
|
93 | - /** |
|
94 | - * @return \OC_OCS_Result |
|
95 | - */ |
|
96 | - public function isLockingEnabled() { |
|
97 | - try { |
|
98 | - $this->getLockingProvider(); |
|
99 | - return new \OC_OCS_Result(null, 100); |
|
100 | - } catch (\RuntimeException $e) { |
|
101 | - return new \OC_OCS_Result(null, Http::STATUS_NOT_IMPLEMENTED, $e->getMessage()); |
|
102 | - } |
|
103 | - } |
|
104 | - |
|
105 | - /** |
|
106 | - * @param array $parameters |
|
107 | - * @return \OC_OCS_Result |
|
108 | - */ |
|
109 | - public function acquireLock(array $parameters) { |
|
110 | - try { |
|
111 | - $path = $this->getPath($parameters); |
|
112 | - } catch (NoUserException $e) { |
|
113 | - return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'User not found'); |
|
114 | - } catch (NotFoundException $e) { |
|
115 | - return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'Path not found'); |
|
116 | - } |
|
117 | - $type = $this->getType($parameters); |
|
118 | - |
|
119 | - $lockingProvider = $this->getLockingProvider(); |
|
120 | - |
|
121 | - try { |
|
122 | - $lockingProvider->acquireLock($path, $type); |
|
123 | - $this->config->setAppValue('testing', 'locking_' . $path, $type); |
|
124 | - return new \OC_OCS_Result(null, 100); |
|
125 | - } catch (LockedException $e) { |
|
126 | - return new \OC_OCS_Result(null, Http::STATUS_LOCKED); |
|
127 | - } |
|
128 | - } |
|
129 | - |
|
130 | - /** |
|
131 | - * @param array $parameters |
|
132 | - * @return \OC_OCS_Result |
|
133 | - */ |
|
134 | - public function changeLock(array $parameters) { |
|
135 | - try { |
|
136 | - $path = $this->getPath($parameters); |
|
137 | - } catch (NoUserException $e) { |
|
138 | - return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'User not found'); |
|
139 | - } catch (NotFoundException $e) { |
|
140 | - return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'Path not found'); |
|
141 | - } |
|
142 | - $type = $this->getType($parameters); |
|
143 | - |
|
144 | - $lockingProvider = $this->getLockingProvider(); |
|
145 | - |
|
146 | - try { |
|
147 | - $lockingProvider->changeLock($path, $type); |
|
148 | - $this->config->setAppValue('testing', 'locking_' . $path, $type); |
|
149 | - return new \OC_OCS_Result(null, 100); |
|
150 | - } catch (LockedException $e) { |
|
151 | - return new \OC_OCS_Result(null, Http::STATUS_LOCKED); |
|
152 | - } |
|
153 | - } |
|
154 | - |
|
155 | - /** |
|
156 | - * @param array $parameters |
|
157 | - * @return \OC_OCS_Result |
|
158 | - */ |
|
159 | - public function releaseLock(array $parameters) { |
|
160 | - try { |
|
161 | - $path = $this->getPath($parameters); |
|
162 | - } catch (NoUserException $e) { |
|
163 | - return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'User not found'); |
|
164 | - } catch (NotFoundException $e) { |
|
165 | - return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'Path not found'); |
|
166 | - } |
|
167 | - $type = $this->getType($parameters); |
|
168 | - |
|
169 | - $lockingProvider = $this->getLockingProvider(); |
|
170 | - |
|
171 | - try { |
|
172 | - $lockingProvider->releaseLock($path, $type); |
|
173 | - $this->config->deleteAppValue('testing', 'locking_' . $path); |
|
174 | - return new \OC_OCS_Result(null, 100); |
|
175 | - } catch (LockedException $e) { |
|
176 | - return new \OC_OCS_Result(null, Http::STATUS_LOCKED); |
|
177 | - } |
|
178 | - } |
|
179 | - |
|
180 | - /** |
|
181 | - * @param array $parameters |
|
182 | - * @return \OC_OCS_Result |
|
183 | - */ |
|
184 | - public function isLocked(array $parameters) { |
|
185 | - try { |
|
186 | - $path = $this->getPath($parameters); |
|
187 | - } catch (NoUserException $e) { |
|
188 | - return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'User not found'); |
|
189 | - } catch (NotFoundException $e) { |
|
190 | - return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'Path not found'); |
|
191 | - } |
|
192 | - $type = $this->getType($parameters); |
|
193 | - |
|
194 | - $lockingProvider = $this->getLockingProvider(); |
|
195 | - |
|
196 | - if ($lockingProvider->isLocked($path, $type)) { |
|
197 | - return new \OC_OCS_Result(null, 100); |
|
198 | - } |
|
199 | - |
|
200 | - return new \OC_OCS_Result(null, Http::STATUS_LOCKED); |
|
201 | - } |
|
202 | - |
|
203 | - /** |
|
204 | - * @param array $parameters |
|
205 | - * @return \OC_OCS_Result |
|
206 | - */ |
|
207 | - public function releaseAll(array $parameters) { |
|
208 | - $type = $this->getType($parameters); |
|
209 | - |
|
210 | - $lockingProvider = $this->getLockingProvider(); |
|
211 | - |
|
212 | - foreach ($this->config->getAppKeys('testing') as $lock) { |
|
213 | - if (strpos($lock, 'locking_') === 0) { |
|
214 | - $path = substr($lock, strlen('locking_')); |
|
215 | - |
|
216 | - if ($type === ILockingProvider::LOCK_EXCLUSIVE && $this->config->getAppValue('testing', $lock) == ILockingProvider::LOCK_EXCLUSIVE) { |
|
217 | - $lockingProvider->releaseLock($path, $this->config->getAppValue('testing', $lock)); |
|
218 | - } else if ($type === ILockingProvider::LOCK_SHARED && $this->config->getAppValue('testing', $lock) == ILockingProvider::LOCK_SHARED) { |
|
219 | - $lockingProvider->releaseLock($path, $this->config->getAppValue('testing', $lock)); |
|
220 | - } else { |
|
221 | - $lockingProvider->releaseLock($path, $this->config->getAppValue('testing', $lock)); |
|
222 | - } |
|
223 | - } |
|
224 | - } |
|
225 | - |
|
226 | - return new \OC_OCS_Result(null, 100); |
|
227 | - } |
|
38 | + /** @var ILockingProvider */ |
|
39 | + protected $lockingProvider; |
|
40 | + |
|
41 | + /** @var IDBConnection */ |
|
42 | + protected $connection; |
|
43 | + |
|
44 | + /** @var IConfig */ |
|
45 | + protected $config; |
|
46 | + |
|
47 | + /** @var IRequest */ |
|
48 | + protected $request; |
|
49 | + |
|
50 | + /** |
|
51 | + * @param ILockingProvider $lockingProvider |
|
52 | + * @param IDBConnection $connection |
|
53 | + * @param IConfig $config |
|
54 | + * @param IRequest $request |
|
55 | + */ |
|
56 | + public function __construct(ILockingProvider $lockingProvider, IDBConnection $connection, IConfig $config, IRequest $request) { |
|
57 | + $this->lockingProvider = $lockingProvider; |
|
58 | + $this->connection = $connection; |
|
59 | + $this->config = $config; |
|
60 | + $this->request = $request; |
|
61 | + } |
|
62 | + |
|
63 | + /** |
|
64 | + * @return ILockingProvider |
|
65 | + */ |
|
66 | + protected function getLockingProvider() { |
|
67 | + if ($this->lockingProvider instanceof DBLockingProvider) { |
|
68 | + return \OC::$server->query('OCA\Testing\Locking\FakeDBLockingProvider'); |
|
69 | + } else { |
|
70 | + throw new \RuntimeException('Lock provisioning is only possible using the DBLockingProvider'); |
|
71 | + } |
|
72 | + } |
|
73 | + |
|
74 | + /** |
|
75 | + * @param array $parameters |
|
76 | + * @return int |
|
77 | + */ |
|
78 | + protected function getType($parameters) { |
|
79 | + return isset($parameters['type']) ? (int) $parameters['type'] : 0; |
|
80 | + } |
|
81 | + |
|
82 | + /** |
|
83 | + * @param array $parameters |
|
84 | + * @return int |
|
85 | + */ |
|
86 | + protected function getPath($parameters) { |
|
87 | + $node = \OC::$server->getRootFolder() |
|
88 | + ->getUserFolder($parameters['user']) |
|
89 | + ->get($this->request->getParam('path')); |
|
90 | + return 'files/' . md5($node->getStorage()->getId() . '::' . trim($node->getInternalPath(), '/')); |
|
91 | + } |
|
92 | + |
|
93 | + /** |
|
94 | + * @return \OC_OCS_Result |
|
95 | + */ |
|
96 | + public function isLockingEnabled() { |
|
97 | + try { |
|
98 | + $this->getLockingProvider(); |
|
99 | + return new \OC_OCS_Result(null, 100); |
|
100 | + } catch (\RuntimeException $e) { |
|
101 | + return new \OC_OCS_Result(null, Http::STATUS_NOT_IMPLEMENTED, $e->getMessage()); |
|
102 | + } |
|
103 | + } |
|
104 | + |
|
105 | + /** |
|
106 | + * @param array $parameters |
|
107 | + * @return \OC_OCS_Result |
|
108 | + */ |
|
109 | + public function acquireLock(array $parameters) { |
|
110 | + try { |
|
111 | + $path = $this->getPath($parameters); |
|
112 | + } catch (NoUserException $e) { |
|
113 | + return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'User not found'); |
|
114 | + } catch (NotFoundException $e) { |
|
115 | + return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'Path not found'); |
|
116 | + } |
|
117 | + $type = $this->getType($parameters); |
|
118 | + |
|
119 | + $lockingProvider = $this->getLockingProvider(); |
|
120 | + |
|
121 | + try { |
|
122 | + $lockingProvider->acquireLock($path, $type); |
|
123 | + $this->config->setAppValue('testing', 'locking_' . $path, $type); |
|
124 | + return new \OC_OCS_Result(null, 100); |
|
125 | + } catch (LockedException $e) { |
|
126 | + return new \OC_OCS_Result(null, Http::STATUS_LOCKED); |
|
127 | + } |
|
128 | + } |
|
129 | + |
|
130 | + /** |
|
131 | + * @param array $parameters |
|
132 | + * @return \OC_OCS_Result |
|
133 | + */ |
|
134 | + public function changeLock(array $parameters) { |
|
135 | + try { |
|
136 | + $path = $this->getPath($parameters); |
|
137 | + } catch (NoUserException $e) { |
|
138 | + return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'User not found'); |
|
139 | + } catch (NotFoundException $e) { |
|
140 | + return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'Path not found'); |
|
141 | + } |
|
142 | + $type = $this->getType($parameters); |
|
143 | + |
|
144 | + $lockingProvider = $this->getLockingProvider(); |
|
145 | + |
|
146 | + try { |
|
147 | + $lockingProvider->changeLock($path, $type); |
|
148 | + $this->config->setAppValue('testing', 'locking_' . $path, $type); |
|
149 | + return new \OC_OCS_Result(null, 100); |
|
150 | + } catch (LockedException $e) { |
|
151 | + return new \OC_OCS_Result(null, Http::STATUS_LOCKED); |
|
152 | + } |
|
153 | + } |
|
154 | + |
|
155 | + /** |
|
156 | + * @param array $parameters |
|
157 | + * @return \OC_OCS_Result |
|
158 | + */ |
|
159 | + public function releaseLock(array $parameters) { |
|
160 | + try { |
|
161 | + $path = $this->getPath($parameters); |
|
162 | + } catch (NoUserException $e) { |
|
163 | + return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'User not found'); |
|
164 | + } catch (NotFoundException $e) { |
|
165 | + return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'Path not found'); |
|
166 | + } |
|
167 | + $type = $this->getType($parameters); |
|
168 | + |
|
169 | + $lockingProvider = $this->getLockingProvider(); |
|
170 | + |
|
171 | + try { |
|
172 | + $lockingProvider->releaseLock($path, $type); |
|
173 | + $this->config->deleteAppValue('testing', 'locking_' . $path); |
|
174 | + return new \OC_OCS_Result(null, 100); |
|
175 | + } catch (LockedException $e) { |
|
176 | + return new \OC_OCS_Result(null, Http::STATUS_LOCKED); |
|
177 | + } |
|
178 | + } |
|
179 | + |
|
180 | + /** |
|
181 | + * @param array $parameters |
|
182 | + * @return \OC_OCS_Result |
|
183 | + */ |
|
184 | + public function isLocked(array $parameters) { |
|
185 | + try { |
|
186 | + $path = $this->getPath($parameters); |
|
187 | + } catch (NoUserException $e) { |
|
188 | + return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'User not found'); |
|
189 | + } catch (NotFoundException $e) { |
|
190 | + return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'Path not found'); |
|
191 | + } |
|
192 | + $type = $this->getType($parameters); |
|
193 | + |
|
194 | + $lockingProvider = $this->getLockingProvider(); |
|
195 | + |
|
196 | + if ($lockingProvider->isLocked($path, $type)) { |
|
197 | + return new \OC_OCS_Result(null, 100); |
|
198 | + } |
|
199 | + |
|
200 | + return new \OC_OCS_Result(null, Http::STATUS_LOCKED); |
|
201 | + } |
|
202 | + |
|
203 | + /** |
|
204 | + * @param array $parameters |
|
205 | + * @return \OC_OCS_Result |
|
206 | + */ |
|
207 | + public function releaseAll(array $parameters) { |
|
208 | + $type = $this->getType($parameters); |
|
209 | + |
|
210 | + $lockingProvider = $this->getLockingProvider(); |
|
211 | + |
|
212 | + foreach ($this->config->getAppKeys('testing') as $lock) { |
|
213 | + if (strpos($lock, 'locking_') === 0) { |
|
214 | + $path = substr($lock, strlen('locking_')); |
|
215 | + |
|
216 | + if ($type === ILockingProvider::LOCK_EXCLUSIVE && $this->config->getAppValue('testing', $lock) == ILockingProvider::LOCK_EXCLUSIVE) { |
|
217 | + $lockingProvider->releaseLock($path, $this->config->getAppValue('testing', $lock)); |
|
218 | + } else if ($type === ILockingProvider::LOCK_SHARED && $this->config->getAppValue('testing', $lock) == ILockingProvider::LOCK_SHARED) { |
|
219 | + $lockingProvider->releaseLock($path, $this->config->getAppValue('testing', $lock)); |
|
220 | + } else { |
|
221 | + $lockingProvider->releaseLock($path, $this->config->getAppValue('testing', $lock)); |
|
222 | + } |
|
223 | + } |
|
224 | + } |
|
225 | + |
|
226 | + return new \OC_OCS_Result(null, 100); |
|
227 | + } |
|
228 | 228 | } |
@@ -87,7 +87,7 @@ discard block |
||
87 | 87 | $node = \OC::$server->getRootFolder() |
88 | 88 | ->getUserFolder($parameters['user']) |
89 | 89 | ->get($this->request->getParam('path')); |
90 | - return 'files/' . md5($node->getStorage()->getId() . '::' . trim($node->getInternalPath(), '/')); |
|
90 | + return 'files/'.md5($node->getStorage()->getId().'::'.trim($node->getInternalPath(), '/')); |
|
91 | 91 | } |
92 | 92 | |
93 | 93 | /** |
@@ -120,7 +120,7 @@ discard block |
||
120 | 120 | |
121 | 121 | try { |
122 | 122 | $lockingProvider->acquireLock($path, $type); |
123 | - $this->config->setAppValue('testing', 'locking_' . $path, $type); |
|
123 | + $this->config->setAppValue('testing', 'locking_'.$path, $type); |
|
124 | 124 | return new \OC_OCS_Result(null, 100); |
125 | 125 | } catch (LockedException $e) { |
126 | 126 | return new \OC_OCS_Result(null, Http::STATUS_LOCKED); |
@@ -145,7 +145,7 @@ discard block |
||
145 | 145 | |
146 | 146 | try { |
147 | 147 | $lockingProvider->changeLock($path, $type); |
148 | - $this->config->setAppValue('testing', 'locking_' . $path, $type); |
|
148 | + $this->config->setAppValue('testing', 'locking_'.$path, $type); |
|
149 | 149 | return new \OC_OCS_Result(null, 100); |
150 | 150 | } catch (LockedException $e) { |
151 | 151 | return new \OC_OCS_Result(null, Http::STATUS_LOCKED); |
@@ -170,7 +170,7 @@ discard block |
||
170 | 170 | |
171 | 171 | try { |
172 | 172 | $lockingProvider->releaseLock($path, $type); |
173 | - $this->config->deleteAppValue('testing', 'locking_' . $path); |
|
173 | + $this->config->deleteAppValue('testing', 'locking_'.$path); |
|
174 | 174 | return new \OC_OCS_Result(null, 100); |
175 | 175 | } catch (LockedException $e) { |
176 | 176 | return new \OC_OCS_Result(null, Http::STATUS_LOCKED); |
@@ -102,6 +102,9 @@ |
||
102 | 102 | return \OC_App::getAppVersions(); |
103 | 103 | } |
104 | 104 | |
105 | + /** |
|
106 | + * @param string $appId |
|
107 | + */ |
|
105 | 108 | protected function getAppInfo($appId) { |
106 | 109 | return \OC_App::getAppInfo($appId); |
107 | 110 | } |
@@ -91,7 +91,7 @@ discard block |
||
91 | 91 | $notification->setParsedSubject($l->t('Update to %1$s is available.', [$parameters['version']])); |
92 | 92 | |
93 | 93 | if ($this->isAdmin()) { |
94 | - $notification->setLink($this->url->linkToRouteAbsolute('settings.AdminSettings.index') . '#updater'); |
|
94 | + $notification->setLink($this->url->linkToRouteAbsolute('settings.AdminSettings.index').'#updater'); |
|
95 | 95 | } |
96 | 96 | } else { |
97 | 97 | $appInfo = $this->getAppInfo($notification->getObjectType()); |
@@ -111,7 +111,7 @@ discard block |
||
111 | 111 | ]); |
112 | 112 | |
113 | 113 | if ($this->isAdmin()) { |
114 | - $notification->setLink($this->url->linkToRouteAbsolute('settings.AppSettings.viewApps') . '#app-' . $notification->getObjectType()); |
|
114 | + $notification->setLink($this->url->linkToRouteAbsolute('settings.AppSettings.viewApps').'#app-'.$notification->getObjectType()); |
|
115 | 115 | } |
116 | 116 | } |
117 | 117 |
@@ -36,141 +36,141 @@ |
||
36 | 36 | |
37 | 37 | class Notifier implements INotifier { |
38 | 38 | |
39 | - /** @var IURLGenerator */ |
|
40 | - protected $url; |
|
41 | - |
|
42 | - /** @var IConfig */ |
|
43 | - protected $config; |
|
44 | - |
|
45 | - /** @var IManager */ |
|
46 | - protected $notificationManager; |
|
47 | - |
|
48 | - /** @var IFactory */ |
|
49 | - protected $l10NFactory; |
|
50 | - |
|
51 | - /** @var IUserSession */ |
|
52 | - protected $userSession; |
|
53 | - |
|
54 | - /** @var IGroupManager */ |
|
55 | - protected $groupManager; |
|
56 | - |
|
57 | - /** @var string[] */ |
|
58 | - protected $appVersions; |
|
59 | - |
|
60 | - /** |
|
61 | - * Notifier constructor. |
|
62 | - * |
|
63 | - * @param IURLGenerator $url |
|
64 | - * @param IConfig $config |
|
65 | - * @param IManager $notificationManager |
|
66 | - * @param IFactory $l10NFactory |
|
67 | - * @param IUserSession $userSession |
|
68 | - * @param IGroupManager $groupManager |
|
69 | - */ |
|
70 | - public function __construct(IURLGenerator $url, IConfig $config, IManager $notificationManager, IFactory $l10NFactory, IUserSession $userSession, IGroupManager $groupManager) { |
|
71 | - $this->url = $url; |
|
72 | - $this->notificationManager = $notificationManager; |
|
73 | - $this->config = $config; |
|
74 | - $this->l10NFactory = $l10NFactory; |
|
75 | - $this->userSession = $userSession; |
|
76 | - $this->groupManager = $groupManager; |
|
77 | - $this->appVersions = $this->getAppVersions(); |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * @param INotification $notification |
|
82 | - * @param string $languageCode The code of the language that should be used to prepare the notification |
|
83 | - * @return INotification |
|
84 | - * @throws \InvalidArgumentException When the notification was not prepared by a notifier |
|
85 | - * @since 9.0.0 |
|
86 | - */ |
|
87 | - public function prepare(INotification $notification, $languageCode) { |
|
88 | - if ($notification->getApp() !== 'updatenotification') { |
|
89 | - throw new \InvalidArgumentException(); |
|
90 | - } |
|
91 | - |
|
92 | - $l = $this->l10NFactory->get('updatenotification', $languageCode); |
|
93 | - if ($notification->getSubject() === 'connection_error') { |
|
94 | - $errors = (int) $this->config->getAppValue('updatenotification', 'update_check_errors', 0); |
|
95 | - if ($errors === 0) { |
|
96 | - $this->notificationManager->markProcessed($notification); |
|
97 | - throw new \InvalidArgumentException(); |
|
98 | - } |
|
99 | - |
|
100 | - $notification->setParsedSubject($l->t('The update server could not be reached since %d days to check for new updates.', [$errors])) |
|
101 | - ->setParsedMessage($l->t('Please check the Nextcloud and server log files for errors.')); |
|
102 | - } elseif ($notification->getObjectType() === 'core') { |
|
103 | - $this->updateAlreadyInstalledCheck($notification, $this->getCoreVersions()); |
|
104 | - |
|
105 | - $parameters = $notification->getSubjectParameters(); |
|
106 | - $notification->setParsedSubject($l->t('Update to %1$s is available.', [$parameters['version']])); |
|
107 | - |
|
108 | - if ($this->isAdmin()) { |
|
109 | - $notification->setLink($this->url->linkToRouteAbsolute('settings.AdminSettings.index') . '#updater'); |
|
110 | - } |
|
111 | - } else { |
|
112 | - $appInfo = $this->getAppInfo($notification->getObjectType()); |
|
113 | - $appName = ($appInfo === null) ? $notification->getObjectType() : $appInfo['name']; |
|
114 | - |
|
115 | - if (isset($this->appVersions[$notification->getObjectType()])) { |
|
116 | - $this->updateAlreadyInstalledCheck($notification, $this->appVersions[$notification->getObjectType()]); |
|
117 | - } |
|
118 | - |
|
119 | - $notification->setParsedSubject($l->t('Update for %1$s to version %2$s is available.', [$appName, $notification->getObjectId()])) |
|
120 | - ->setRichSubject($l->t('Update for {app} to version %s is available.', $notification->getObjectId()), [ |
|
121 | - 'app' => [ |
|
122 | - 'type' => 'app', |
|
123 | - 'id' => $notification->getObjectType(), |
|
124 | - 'name' => $appName, |
|
125 | - ] |
|
126 | - ]); |
|
127 | - |
|
128 | - if ($this->isAdmin()) { |
|
129 | - $notification->setLink($this->url->linkToRouteAbsolute('settings.AppSettings.viewApps') . '#app-' . $notification->getObjectType()); |
|
130 | - } |
|
131 | - } |
|
132 | - |
|
133 | - $notification->setIcon($this->url->getAbsoluteURL($this->url->imagePath('updatenotification', 'notification.svg'))); |
|
134 | - |
|
135 | - return $notification; |
|
136 | - } |
|
137 | - |
|
138 | - /** |
|
139 | - * Remove the notification and prevent rendering, when the update is installed |
|
140 | - * |
|
141 | - * @param INotification $notification |
|
142 | - * @param string $installedVersion |
|
143 | - * @throws \InvalidArgumentException When the update is already installed |
|
144 | - */ |
|
145 | - protected function updateAlreadyInstalledCheck(INotification $notification, $installedVersion) { |
|
146 | - if (version_compare($notification->getObjectId(), $installedVersion, '<=')) { |
|
147 | - $this->notificationManager->markProcessed($notification); |
|
148 | - throw new \InvalidArgumentException(); |
|
149 | - } |
|
150 | - } |
|
151 | - |
|
152 | - /** |
|
153 | - * @return bool |
|
154 | - */ |
|
155 | - protected function isAdmin() { |
|
156 | - $user = $this->userSession->getUser(); |
|
157 | - |
|
158 | - if ($user instanceof IUser) { |
|
159 | - return $this->groupManager->isAdmin($user->getUID()); |
|
160 | - } |
|
161 | - |
|
162 | - return false; |
|
163 | - } |
|
164 | - |
|
165 | - protected function getCoreVersions() { |
|
166 | - return implode('.', \OCP\Util::getVersion()); |
|
167 | - } |
|
168 | - |
|
169 | - protected function getAppVersions() { |
|
170 | - return \OC_App::getAppVersions(); |
|
171 | - } |
|
172 | - |
|
173 | - protected function getAppInfo($appId) { |
|
174 | - return \OC_App::getAppInfo($appId); |
|
175 | - } |
|
39 | + /** @var IURLGenerator */ |
|
40 | + protected $url; |
|
41 | + |
|
42 | + /** @var IConfig */ |
|
43 | + protected $config; |
|
44 | + |
|
45 | + /** @var IManager */ |
|
46 | + protected $notificationManager; |
|
47 | + |
|
48 | + /** @var IFactory */ |
|
49 | + protected $l10NFactory; |
|
50 | + |
|
51 | + /** @var IUserSession */ |
|
52 | + protected $userSession; |
|
53 | + |
|
54 | + /** @var IGroupManager */ |
|
55 | + protected $groupManager; |
|
56 | + |
|
57 | + /** @var string[] */ |
|
58 | + protected $appVersions; |
|
59 | + |
|
60 | + /** |
|
61 | + * Notifier constructor. |
|
62 | + * |
|
63 | + * @param IURLGenerator $url |
|
64 | + * @param IConfig $config |
|
65 | + * @param IManager $notificationManager |
|
66 | + * @param IFactory $l10NFactory |
|
67 | + * @param IUserSession $userSession |
|
68 | + * @param IGroupManager $groupManager |
|
69 | + */ |
|
70 | + public function __construct(IURLGenerator $url, IConfig $config, IManager $notificationManager, IFactory $l10NFactory, IUserSession $userSession, IGroupManager $groupManager) { |
|
71 | + $this->url = $url; |
|
72 | + $this->notificationManager = $notificationManager; |
|
73 | + $this->config = $config; |
|
74 | + $this->l10NFactory = $l10NFactory; |
|
75 | + $this->userSession = $userSession; |
|
76 | + $this->groupManager = $groupManager; |
|
77 | + $this->appVersions = $this->getAppVersions(); |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * @param INotification $notification |
|
82 | + * @param string $languageCode The code of the language that should be used to prepare the notification |
|
83 | + * @return INotification |
|
84 | + * @throws \InvalidArgumentException When the notification was not prepared by a notifier |
|
85 | + * @since 9.0.0 |
|
86 | + */ |
|
87 | + public function prepare(INotification $notification, $languageCode) { |
|
88 | + if ($notification->getApp() !== 'updatenotification') { |
|
89 | + throw new \InvalidArgumentException(); |
|
90 | + } |
|
91 | + |
|
92 | + $l = $this->l10NFactory->get('updatenotification', $languageCode); |
|
93 | + if ($notification->getSubject() === 'connection_error') { |
|
94 | + $errors = (int) $this->config->getAppValue('updatenotification', 'update_check_errors', 0); |
|
95 | + if ($errors === 0) { |
|
96 | + $this->notificationManager->markProcessed($notification); |
|
97 | + throw new \InvalidArgumentException(); |
|
98 | + } |
|
99 | + |
|
100 | + $notification->setParsedSubject($l->t('The update server could not be reached since %d days to check for new updates.', [$errors])) |
|
101 | + ->setParsedMessage($l->t('Please check the Nextcloud and server log files for errors.')); |
|
102 | + } elseif ($notification->getObjectType() === 'core') { |
|
103 | + $this->updateAlreadyInstalledCheck($notification, $this->getCoreVersions()); |
|
104 | + |
|
105 | + $parameters = $notification->getSubjectParameters(); |
|
106 | + $notification->setParsedSubject($l->t('Update to %1$s is available.', [$parameters['version']])); |
|
107 | + |
|
108 | + if ($this->isAdmin()) { |
|
109 | + $notification->setLink($this->url->linkToRouteAbsolute('settings.AdminSettings.index') . '#updater'); |
|
110 | + } |
|
111 | + } else { |
|
112 | + $appInfo = $this->getAppInfo($notification->getObjectType()); |
|
113 | + $appName = ($appInfo === null) ? $notification->getObjectType() : $appInfo['name']; |
|
114 | + |
|
115 | + if (isset($this->appVersions[$notification->getObjectType()])) { |
|
116 | + $this->updateAlreadyInstalledCheck($notification, $this->appVersions[$notification->getObjectType()]); |
|
117 | + } |
|
118 | + |
|
119 | + $notification->setParsedSubject($l->t('Update for %1$s to version %2$s is available.', [$appName, $notification->getObjectId()])) |
|
120 | + ->setRichSubject($l->t('Update for {app} to version %s is available.', $notification->getObjectId()), [ |
|
121 | + 'app' => [ |
|
122 | + 'type' => 'app', |
|
123 | + 'id' => $notification->getObjectType(), |
|
124 | + 'name' => $appName, |
|
125 | + ] |
|
126 | + ]); |
|
127 | + |
|
128 | + if ($this->isAdmin()) { |
|
129 | + $notification->setLink($this->url->linkToRouteAbsolute('settings.AppSettings.viewApps') . '#app-' . $notification->getObjectType()); |
|
130 | + } |
|
131 | + } |
|
132 | + |
|
133 | + $notification->setIcon($this->url->getAbsoluteURL($this->url->imagePath('updatenotification', 'notification.svg'))); |
|
134 | + |
|
135 | + return $notification; |
|
136 | + } |
|
137 | + |
|
138 | + /** |
|
139 | + * Remove the notification and prevent rendering, when the update is installed |
|
140 | + * |
|
141 | + * @param INotification $notification |
|
142 | + * @param string $installedVersion |
|
143 | + * @throws \InvalidArgumentException When the update is already installed |
|
144 | + */ |
|
145 | + protected function updateAlreadyInstalledCheck(INotification $notification, $installedVersion) { |
|
146 | + if (version_compare($notification->getObjectId(), $installedVersion, '<=')) { |
|
147 | + $this->notificationManager->markProcessed($notification); |
|
148 | + throw new \InvalidArgumentException(); |
|
149 | + } |
|
150 | + } |
|
151 | + |
|
152 | + /** |
|
153 | + * @return bool |
|
154 | + */ |
|
155 | + protected function isAdmin() { |
|
156 | + $user = $this->userSession->getUser(); |
|
157 | + |
|
158 | + if ($user instanceof IUser) { |
|
159 | + return $this->groupManager->isAdmin($user->getUID()); |
|
160 | + } |
|
161 | + |
|
162 | + return false; |
|
163 | + } |
|
164 | + |
|
165 | + protected function getCoreVersions() { |
|
166 | + return implode('.', \OCP\Util::getVersion()); |
|
167 | + } |
|
168 | + |
|
169 | + protected function getAppVersions() { |
|
170 | + return \OC_App::getAppVersions(); |
|
171 | + } |
|
172 | + |
|
173 | + protected function getAppInfo($appId) { |
|
174 | + return \OC_App::getAppInfo($appId); |
|
175 | + } |
|
176 | 176 | } |
@@ -74,8 +74,6 @@ |
||
74 | 74 | /** |
75 | 75 | * save the configuration value as provided |
76 | 76 | * @param string $configID |
77 | - * @param string $configKey |
|
78 | - * @param string $configValue |
|
79 | 77 | */ |
80 | 78 | protected function setValue($configID, $key, $value) { |
81 | 79 | $configHolder = new Configuration($configID); |
@@ -34,53 +34,53 @@ |
||
34 | 34 | |
35 | 35 | class SetConfig extends Command { |
36 | 36 | |
37 | - protected function configure() { |
|
38 | - $this |
|
39 | - ->setName('ldap:set-config') |
|
40 | - ->setDescription('modifies an LDAP configuration') |
|
41 | - ->addArgument( |
|
42 | - 'configID', |
|
43 | - InputArgument::REQUIRED, |
|
44 | - 'the configuration ID' |
|
45 | - ) |
|
46 | - ->addArgument( |
|
47 | - 'configKey', |
|
48 | - InputArgument::REQUIRED, |
|
49 | - 'the configuration key' |
|
50 | - ) |
|
51 | - ->addArgument( |
|
52 | - 'configValue', |
|
53 | - InputArgument::REQUIRED, |
|
54 | - 'the new configuration value' |
|
55 | - ) |
|
56 | - ; |
|
57 | - } |
|
37 | + protected function configure() { |
|
38 | + $this |
|
39 | + ->setName('ldap:set-config') |
|
40 | + ->setDescription('modifies an LDAP configuration') |
|
41 | + ->addArgument( |
|
42 | + 'configID', |
|
43 | + InputArgument::REQUIRED, |
|
44 | + 'the configuration ID' |
|
45 | + ) |
|
46 | + ->addArgument( |
|
47 | + 'configKey', |
|
48 | + InputArgument::REQUIRED, |
|
49 | + 'the configuration key' |
|
50 | + ) |
|
51 | + ->addArgument( |
|
52 | + 'configValue', |
|
53 | + InputArgument::REQUIRED, |
|
54 | + 'the new configuration value' |
|
55 | + ) |
|
56 | + ; |
|
57 | + } |
|
58 | 58 | |
59 | - protected function execute(InputInterface $input, OutputInterface $output) { |
|
60 | - $helper = new Helper(\OC::$server->getConfig()); |
|
61 | - $availableConfigs = $helper->getServerConfigurationPrefixes(); |
|
62 | - $configID = $input->getArgument('configID'); |
|
63 | - if(!in_array($configID, $availableConfigs)) { |
|
64 | - $output->writeln("Invalid configID"); |
|
65 | - return; |
|
66 | - } |
|
59 | + protected function execute(InputInterface $input, OutputInterface $output) { |
|
60 | + $helper = new Helper(\OC::$server->getConfig()); |
|
61 | + $availableConfigs = $helper->getServerConfigurationPrefixes(); |
|
62 | + $configID = $input->getArgument('configID'); |
|
63 | + if(!in_array($configID, $availableConfigs)) { |
|
64 | + $output->writeln("Invalid configID"); |
|
65 | + return; |
|
66 | + } |
|
67 | 67 | |
68 | - $this->setValue( |
|
69 | - $configID, |
|
70 | - $input->getArgument('configKey'), |
|
71 | - $input->getArgument('configValue') |
|
72 | - ); |
|
73 | - } |
|
68 | + $this->setValue( |
|
69 | + $configID, |
|
70 | + $input->getArgument('configKey'), |
|
71 | + $input->getArgument('configValue') |
|
72 | + ); |
|
73 | + } |
|
74 | 74 | |
75 | - /** |
|
76 | - * save the configuration value as provided |
|
77 | - * @param string $configID |
|
78 | - * @param string $configKey |
|
79 | - * @param string $configValue |
|
80 | - */ |
|
81 | - protected function setValue($configID, $key, $value) { |
|
82 | - $configHolder = new Configuration($configID); |
|
83 | - $configHolder->$key = $value; |
|
84 | - $configHolder->saveConfiguration(); |
|
85 | - } |
|
75 | + /** |
|
76 | + * save the configuration value as provided |
|
77 | + * @param string $configID |
|
78 | + * @param string $configKey |
|
79 | + * @param string $configValue |
|
80 | + */ |
|
81 | + protected function setValue($configID, $key, $value) { |
|
82 | + $configHolder = new Configuration($configID); |
|
83 | + $configHolder->$key = $value; |
|
84 | + $configHolder->saveConfiguration(); |
|
85 | + } |
|
86 | 86 | } |
@@ -60,7 +60,7 @@ |
||
60 | 60 | $helper = new Helper(\OC::$server->getConfig()); |
61 | 61 | $availableConfigs = $helper->getServerConfigurationPrefixes(); |
62 | 62 | $configID = $input->getArgument('configID'); |
63 | - if(!in_array($configID, $availableConfigs)) { |
|
63 | + if (!in_array($configID, $availableConfigs)) { |
|
64 | 64 | $output->writeln("Invalid configID"); |
65 | 65 | return; |
66 | 66 | } |
@@ -77,7 +77,7 @@ |
||
77 | 77 | } |
78 | 78 | |
79 | 79 | /** |
80 | - * @return int |
|
80 | + * @return string |
|
81 | 81 | */ |
82 | 82 | static private function getRefreshInterval() { |
83 | 83 | //defaults to every hour |
@@ -45,14 +45,14 @@ discard block |
||
45 | 45 | |
46 | 46 | static private $groupBE; |
47 | 47 | |
48 | - public function __construct(){ |
|
48 | + public function __construct() { |
|
49 | 49 | $this->interval = self::getRefreshInterval(); |
50 | 50 | } |
51 | 51 | |
52 | 52 | /** |
53 | 53 | * @param mixed $argument |
54 | 54 | */ |
55 | - public function run($argument){ |
|
55 | + public function run($argument) { |
|
56 | 56 | self::updateGroups(); |
57 | 57 | } |
58 | 58 | |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | $knownGroups = array_keys(self::getKnownGroups()); |
63 | 63 | $actualGroups = self::getGroupBE()->getGroups(); |
64 | 64 | |
65 | - if(empty($actualGroups) && empty($knownGroups)) { |
|
65 | + if (empty($actualGroups) && empty($knownGroups)) { |
|
66 | 66 | \OCP\Util::writeLog('user_ldap', |
67 | 67 | 'bgJ "updateGroups" – groups do not seem to be configured properly, aborting.', |
68 | 68 | \OCP\Util::INFO); |
@@ -94,26 +94,26 @@ discard block |
||
94 | 94 | SET `owncloudusers` = ? |
95 | 95 | WHERE `owncloudname` = ? |
96 | 96 | '); |
97 | - foreach($groups as $group) { |
|
97 | + foreach ($groups as $group) { |
|
98 | 98 | //we assume, that self::$groupsFromDB has been retrieved already |
99 | 99 | $knownUsers = unserialize(self::$groupsFromDB[$group]['owncloudusers']); |
100 | 100 | $actualUsers = self::getGroupBE()->usersInGroup($group); |
101 | 101 | $hasChanged = false; |
102 | - foreach(array_diff($knownUsers, $actualUsers) as $removedUser) { |
|
102 | + foreach (array_diff($knownUsers, $actualUsers) as $removedUser) { |
|
103 | 103 | \OCP\Util::emitHook('OC_User', 'post_removeFromGroup', array('uid' => $removedUser, 'gid' => $group)); |
104 | 104 | \OCP\Util::writeLog('user_ldap', |
105 | 105 | 'bgJ "updateGroups" – "'.$removedUser.'" removed from "'.$group.'".', |
106 | 106 | \OCP\Util::INFO); |
107 | 107 | $hasChanged = true; |
108 | 108 | } |
109 | - foreach(array_diff($actualUsers, $knownUsers) as $addedUser) { |
|
109 | + foreach (array_diff($actualUsers, $knownUsers) as $addedUser) { |
|
110 | 110 | \OCP\Util::emitHook('OC_User', 'post_addToGroup', array('uid' => $addedUser, 'gid' => $group)); |
111 | 111 | \OCP\Util::writeLog('user_ldap', |
112 | 112 | 'bgJ "updateGroups" – "'.$addedUser.'" added to "'.$group.'".', |
113 | 113 | \OCP\Util::INFO); |
114 | 114 | $hasChanged = true; |
115 | 115 | } |
116 | - if($hasChanged) { |
|
116 | + if ($hasChanged) { |
|
117 | 117 | $query->execute(array(serialize($actualUsers), $group)); |
118 | 118 | } |
119 | 119 | } |
@@ -132,7 +132,7 @@ discard block |
||
132 | 132 | INTO `*PREFIX*ldap_group_members` (`owncloudname`, `owncloudusers`) |
133 | 133 | VALUES (?, ?) |
134 | 134 | '); |
135 | - foreach($createdGroups as $createdGroup) { |
|
135 | + foreach ($createdGroups as $createdGroup) { |
|
136 | 136 | \OCP\Util::writeLog('user_ldap', |
137 | 137 | 'bgJ "updateGroups" – new group "'.$createdGroup.'" found.', |
138 | 138 | \OCP\Util::INFO); |
@@ -154,7 +154,7 @@ discard block |
||
154 | 154 | FROM `*PREFIX*ldap_group_members` |
155 | 155 | WHERE `owncloudname` = ? |
156 | 156 | '); |
157 | - foreach($removedGroups as $removedGroup) { |
|
157 | + foreach ($removedGroups as $removedGroup) { |
|
158 | 158 | \OCP\Util::writeLog('user_ldap', |
159 | 159 | 'bgJ "updateGroups" – group "'.$removedGroup.'" was removed.', |
160 | 160 | \OCP\Util::INFO); |
@@ -169,13 +169,13 @@ discard block |
||
169 | 169 | * @return \OCA\User_LDAP\Group_LDAP|\OCA\User_LDAP\Group_Proxy |
170 | 170 | */ |
171 | 171 | static private function getGroupBE() { |
172 | - if(!is_null(self::$groupBE)) { |
|
172 | + if (!is_null(self::$groupBE)) { |
|
173 | 173 | return self::$groupBE; |
174 | 174 | } |
175 | 175 | $helper = new Helper(\OC::$server->getConfig()); |
176 | 176 | $configPrefixes = $helper->getServerConfigurationPrefixes(true); |
177 | 177 | $ldapWrapper = new LDAP(); |
178 | - if(count($configPrefixes) === 1) { |
|
178 | + if (count($configPrefixes) === 1) { |
|
179 | 179 | //avoid the proxy when there is only one LDAP server configured |
180 | 180 | $dbc = \OC::$server->getDatabaseConnection(); |
181 | 181 | $userManager = new Manager( |
@@ -204,7 +204,7 @@ discard block |
||
204 | 204 | * @return array |
205 | 205 | */ |
206 | 206 | static private function getKnownGroups() { |
207 | - if(is_array(self::$groupsFromDB)) { |
|
207 | + if (is_array(self::$groupsFromDB)) { |
|
208 | 208 | return self::$groupsFromDB; |
209 | 209 | } |
210 | 210 | $query = \OCP\DB::prepare(' |
@@ -213,7 +213,7 @@ discard block |
||
213 | 213 | '); |
214 | 214 | $result = $query->execute()->fetchAll(); |
215 | 215 | self::$groupsFromDB = array(); |
216 | - foreach($result as $dataset) { |
|
216 | + foreach ($result as $dataset) { |
|
217 | 217 | self::$groupsFromDB[$dataset['owncloudname']] = $dataset; |
218 | 218 | } |
219 | 219 |
@@ -41,183 +41,183 @@ |
||
41 | 41 | use OCA\User_LDAP\User\Manager; |
42 | 42 | |
43 | 43 | class UpdateGroups extends \OC\BackgroundJob\TimedJob { |
44 | - static private $groupsFromDB; |
|
45 | - |
|
46 | - static private $groupBE; |
|
47 | - |
|
48 | - public function __construct(){ |
|
49 | - $this->interval = self::getRefreshInterval(); |
|
50 | - } |
|
51 | - |
|
52 | - /** |
|
53 | - * @param mixed $argument |
|
54 | - */ |
|
55 | - public function run($argument){ |
|
56 | - self::updateGroups(); |
|
57 | - } |
|
58 | - |
|
59 | - static public function updateGroups() { |
|
60 | - \OCP\Util::writeLog('user_ldap', 'Run background job "updateGroups"', \OCP\Util::DEBUG); |
|
61 | - |
|
62 | - $knownGroups = array_keys(self::getKnownGroups()); |
|
63 | - $actualGroups = self::getGroupBE()->getGroups(); |
|
64 | - |
|
65 | - if(empty($actualGroups) && empty($knownGroups)) { |
|
66 | - \OCP\Util::writeLog('user_ldap', |
|
67 | - 'bgJ "updateGroups" – groups do not seem to be configured properly, aborting.', |
|
68 | - \OCP\Util::INFO); |
|
69 | - return; |
|
70 | - } |
|
71 | - |
|
72 | - self::handleKnownGroups(array_intersect($actualGroups, $knownGroups)); |
|
73 | - self::handleCreatedGroups(array_diff($actualGroups, $knownGroups)); |
|
74 | - self::handleRemovedGroups(array_diff($knownGroups, $actualGroups)); |
|
75 | - |
|
76 | - \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Finished.', \OCP\Util::DEBUG); |
|
77 | - } |
|
78 | - |
|
79 | - /** |
|
80 | - * @return int |
|
81 | - */ |
|
82 | - static private function getRefreshInterval() { |
|
83 | - //defaults to every hour |
|
84 | - return \OCP\Config::getAppValue('user_ldap', 'bgjRefreshInterval', 3600); |
|
85 | - } |
|
86 | - |
|
87 | - /** |
|
88 | - * @param string[] $groups |
|
89 | - */ |
|
90 | - static private function handleKnownGroups($groups) { |
|
91 | - \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Dealing with known Groups.', \OCP\Util::DEBUG); |
|
92 | - $query = \OCP\DB::prepare(' |
|
44 | + static private $groupsFromDB; |
|
45 | + |
|
46 | + static private $groupBE; |
|
47 | + |
|
48 | + public function __construct(){ |
|
49 | + $this->interval = self::getRefreshInterval(); |
|
50 | + } |
|
51 | + |
|
52 | + /** |
|
53 | + * @param mixed $argument |
|
54 | + */ |
|
55 | + public function run($argument){ |
|
56 | + self::updateGroups(); |
|
57 | + } |
|
58 | + |
|
59 | + static public function updateGroups() { |
|
60 | + \OCP\Util::writeLog('user_ldap', 'Run background job "updateGroups"', \OCP\Util::DEBUG); |
|
61 | + |
|
62 | + $knownGroups = array_keys(self::getKnownGroups()); |
|
63 | + $actualGroups = self::getGroupBE()->getGroups(); |
|
64 | + |
|
65 | + if(empty($actualGroups) && empty($knownGroups)) { |
|
66 | + \OCP\Util::writeLog('user_ldap', |
|
67 | + 'bgJ "updateGroups" – groups do not seem to be configured properly, aborting.', |
|
68 | + \OCP\Util::INFO); |
|
69 | + return; |
|
70 | + } |
|
71 | + |
|
72 | + self::handleKnownGroups(array_intersect($actualGroups, $knownGroups)); |
|
73 | + self::handleCreatedGroups(array_diff($actualGroups, $knownGroups)); |
|
74 | + self::handleRemovedGroups(array_diff($knownGroups, $actualGroups)); |
|
75 | + |
|
76 | + \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Finished.', \OCP\Util::DEBUG); |
|
77 | + } |
|
78 | + |
|
79 | + /** |
|
80 | + * @return int |
|
81 | + */ |
|
82 | + static private function getRefreshInterval() { |
|
83 | + //defaults to every hour |
|
84 | + return \OCP\Config::getAppValue('user_ldap', 'bgjRefreshInterval', 3600); |
|
85 | + } |
|
86 | + |
|
87 | + /** |
|
88 | + * @param string[] $groups |
|
89 | + */ |
|
90 | + static private function handleKnownGroups($groups) { |
|
91 | + \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Dealing with known Groups.', \OCP\Util::DEBUG); |
|
92 | + $query = \OCP\DB::prepare(' |
|
93 | 93 | UPDATE `*PREFIX*ldap_group_members` |
94 | 94 | SET `owncloudusers` = ? |
95 | 95 | WHERE `owncloudname` = ? |
96 | 96 | '); |
97 | - foreach($groups as $group) { |
|
98 | - //we assume, that self::$groupsFromDB has been retrieved already |
|
99 | - $knownUsers = unserialize(self::$groupsFromDB[$group]['owncloudusers']); |
|
100 | - $actualUsers = self::getGroupBE()->usersInGroup($group); |
|
101 | - $hasChanged = false; |
|
102 | - foreach(array_diff($knownUsers, $actualUsers) as $removedUser) { |
|
103 | - \OCP\Util::emitHook('OC_User', 'post_removeFromGroup', array('uid' => $removedUser, 'gid' => $group)); |
|
104 | - \OCP\Util::writeLog('user_ldap', |
|
105 | - 'bgJ "updateGroups" – "'.$removedUser.'" removed from "'.$group.'".', |
|
106 | - \OCP\Util::INFO); |
|
107 | - $hasChanged = true; |
|
108 | - } |
|
109 | - foreach(array_diff($actualUsers, $knownUsers) as $addedUser) { |
|
110 | - \OCP\Util::emitHook('OC_User', 'post_addToGroup', array('uid' => $addedUser, 'gid' => $group)); |
|
111 | - \OCP\Util::writeLog('user_ldap', |
|
112 | - 'bgJ "updateGroups" – "'.$addedUser.'" added to "'.$group.'".', |
|
113 | - \OCP\Util::INFO); |
|
114 | - $hasChanged = true; |
|
115 | - } |
|
116 | - if($hasChanged) { |
|
117 | - $query->execute(array(serialize($actualUsers), $group)); |
|
118 | - } |
|
119 | - } |
|
120 | - \OCP\Util::writeLog('user_ldap', |
|
121 | - 'bgJ "updateGroups" – FINISHED dealing with known Groups.', |
|
122 | - \OCP\Util::DEBUG); |
|
123 | - } |
|
124 | - |
|
125 | - /** |
|
126 | - * @param string[] $createdGroups |
|
127 | - */ |
|
128 | - static private function handleCreatedGroups($createdGroups) { |
|
129 | - \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with created Groups.', \OCP\Util::DEBUG); |
|
130 | - $query = \OCP\DB::prepare(' |
|
97 | + foreach($groups as $group) { |
|
98 | + //we assume, that self::$groupsFromDB has been retrieved already |
|
99 | + $knownUsers = unserialize(self::$groupsFromDB[$group]['owncloudusers']); |
|
100 | + $actualUsers = self::getGroupBE()->usersInGroup($group); |
|
101 | + $hasChanged = false; |
|
102 | + foreach(array_diff($knownUsers, $actualUsers) as $removedUser) { |
|
103 | + \OCP\Util::emitHook('OC_User', 'post_removeFromGroup', array('uid' => $removedUser, 'gid' => $group)); |
|
104 | + \OCP\Util::writeLog('user_ldap', |
|
105 | + 'bgJ "updateGroups" – "'.$removedUser.'" removed from "'.$group.'".', |
|
106 | + \OCP\Util::INFO); |
|
107 | + $hasChanged = true; |
|
108 | + } |
|
109 | + foreach(array_diff($actualUsers, $knownUsers) as $addedUser) { |
|
110 | + \OCP\Util::emitHook('OC_User', 'post_addToGroup', array('uid' => $addedUser, 'gid' => $group)); |
|
111 | + \OCP\Util::writeLog('user_ldap', |
|
112 | + 'bgJ "updateGroups" – "'.$addedUser.'" added to "'.$group.'".', |
|
113 | + \OCP\Util::INFO); |
|
114 | + $hasChanged = true; |
|
115 | + } |
|
116 | + if($hasChanged) { |
|
117 | + $query->execute(array(serialize($actualUsers), $group)); |
|
118 | + } |
|
119 | + } |
|
120 | + \OCP\Util::writeLog('user_ldap', |
|
121 | + 'bgJ "updateGroups" – FINISHED dealing with known Groups.', |
|
122 | + \OCP\Util::DEBUG); |
|
123 | + } |
|
124 | + |
|
125 | + /** |
|
126 | + * @param string[] $createdGroups |
|
127 | + */ |
|
128 | + static private function handleCreatedGroups($createdGroups) { |
|
129 | + \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with created Groups.', \OCP\Util::DEBUG); |
|
130 | + $query = \OCP\DB::prepare(' |
|
131 | 131 | INSERT |
132 | 132 | INTO `*PREFIX*ldap_group_members` (`owncloudname`, `owncloudusers`) |
133 | 133 | VALUES (?, ?) |
134 | 134 | '); |
135 | - foreach($createdGroups as $createdGroup) { |
|
136 | - \OCP\Util::writeLog('user_ldap', |
|
137 | - 'bgJ "updateGroups" – new group "'.$createdGroup.'" found.', |
|
138 | - \OCP\Util::INFO); |
|
139 | - $users = serialize(self::getGroupBE()->usersInGroup($createdGroup)); |
|
140 | - $query->execute(array($createdGroup, $users)); |
|
141 | - } |
|
142 | - \OCP\Util::writeLog('user_ldap', |
|
143 | - 'bgJ "updateGroups" – FINISHED dealing with created Groups.', |
|
144 | - \OCP\Util::DEBUG); |
|
145 | - } |
|
146 | - |
|
147 | - /** |
|
148 | - * @param string[] $removedGroups |
|
149 | - */ |
|
150 | - static private function handleRemovedGroups($removedGroups) { |
|
151 | - \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with removed groups.', \OCP\Util::DEBUG); |
|
152 | - $query = \OCP\DB::prepare(' |
|
135 | + foreach($createdGroups as $createdGroup) { |
|
136 | + \OCP\Util::writeLog('user_ldap', |
|
137 | + 'bgJ "updateGroups" – new group "'.$createdGroup.'" found.', |
|
138 | + \OCP\Util::INFO); |
|
139 | + $users = serialize(self::getGroupBE()->usersInGroup($createdGroup)); |
|
140 | + $query->execute(array($createdGroup, $users)); |
|
141 | + } |
|
142 | + \OCP\Util::writeLog('user_ldap', |
|
143 | + 'bgJ "updateGroups" – FINISHED dealing with created Groups.', |
|
144 | + \OCP\Util::DEBUG); |
|
145 | + } |
|
146 | + |
|
147 | + /** |
|
148 | + * @param string[] $removedGroups |
|
149 | + */ |
|
150 | + static private function handleRemovedGroups($removedGroups) { |
|
151 | + \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with removed groups.', \OCP\Util::DEBUG); |
|
152 | + $query = \OCP\DB::prepare(' |
|
153 | 153 | DELETE |
154 | 154 | FROM `*PREFIX*ldap_group_members` |
155 | 155 | WHERE `owncloudname` = ? |
156 | 156 | '); |
157 | - foreach($removedGroups as $removedGroup) { |
|
158 | - \OCP\Util::writeLog('user_ldap', |
|
159 | - 'bgJ "updateGroups" – group "'.$removedGroup.'" was removed.', |
|
160 | - \OCP\Util::INFO); |
|
161 | - $query->execute(array($removedGroup)); |
|
162 | - } |
|
163 | - \OCP\Util::writeLog('user_ldap', |
|
164 | - 'bgJ "updateGroups" – FINISHED dealing with removed groups.', |
|
165 | - \OCP\Util::DEBUG); |
|
166 | - } |
|
167 | - |
|
168 | - /** |
|
169 | - * @return \OCA\User_LDAP\Group_LDAP|\OCA\User_LDAP\Group_Proxy |
|
170 | - */ |
|
171 | - static private function getGroupBE() { |
|
172 | - if(!is_null(self::$groupBE)) { |
|
173 | - return self::$groupBE; |
|
174 | - } |
|
175 | - $helper = new Helper(\OC::$server->getConfig()); |
|
176 | - $configPrefixes = $helper->getServerConfigurationPrefixes(true); |
|
177 | - $ldapWrapper = new LDAP(); |
|
178 | - if(count($configPrefixes) === 1) { |
|
179 | - //avoid the proxy when there is only one LDAP server configured |
|
180 | - $dbc = \OC::$server->getDatabaseConnection(); |
|
181 | - $userManager = new Manager( |
|
182 | - \OC::$server->getConfig(), |
|
183 | - new FilesystemHelper(), |
|
184 | - new LogWrapper(), |
|
185 | - \OC::$server->getAvatarManager(), |
|
186 | - new \OCP\Image(), |
|
187 | - $dbc, |
|
188 | - \OC::$server->getUserManager(), |
|
189 | - \OC::$server->getNotificationManager()); |
|
190 | - $connector = new Connection($ldapWrapper, $configPrefixes[0]); |
|
191 | - $ldapAccess = new Access($connector, $ldapWrapper, $userManager, $helper); |
|
192 | - $groupMapper = new GroupMapping($dbc); |
|
193 | - $userMapper = new UserMapping($dbc); |
|
194 | - $ldapAccess->setGroupMapper($groupMapper); |
|
195 | - $ldapAccess->setUserMapper($userMapper); |
|
196 | - self::$groupBE = new \OCA\User_LDAP\Group_LDAP($ldapAccess); |
|
197 | - } else { |
|
198 | - self::$groupBE = new \OCA\User_LDAP\Group_Proxy($configPrefixes, $ldapWrapper); |
|
199 | - } |
|
200 | - |
|
201 | - return self::$groupBE; |
|
202 | - } |
|
203 | - |
|
204 | - /** |
|
205 | - * @return array |
|
206 | - */ |
|
207 | - static private function getKnownGroups() { |
|
208 | - if(is_array(self::$groupsFromDB)) { |
|
209 | - return self::$groupsFromDB; |
|
210 | - } |
|
211 | - $query = \OCP\DB::prepare(' |
|
157 | + foreach($removedGroups as $removedGroup) { |
|
158 | + \OCP\Util::writeLog('user_ldap', |
|
159 | + 'bgJ "updateGroups" – group "'.$removedGroup.'" was removed.', |
|
160 | + \OCP\Util::INFO); |
|
161 | + $query->execute(array($removedGroup)); |
|
162 | + } |
|
163 | + \OCP\Util::writeLog('user_ldap', |
|
164 | + 'bgJ "updateGroups" – FINISHED dealing with removed groups.', |
|
165 | + \OCP\Util::DEBUG); |
|
166 | + } |
|
167 | + |
|
168 | + /** |
|
169 | + * @return \OCA\User_LDAP\Group_LDAP|\OCA\User_LDAP\Group_Proxy |
|
170 | + */ |
|
171 | + static private function getGroupBE() { |
|
172 | + if(!is_null(self::$groupBE)) { |
|
173 | + return self::$groupBE; |
|
174 | + } |
|
175 | + $helper = new Helper(\OC::$server->getConfig()); |
|
176 | + $configPrefixes = $helper->getServerConfigurationPrefixes(true); |
|
177 | + $ldapWrapper = new LDAP(); |
|
178 | + if(count($configPrefixes) === 1) { |
|
179 | + //avoid the proxy when there is only one LDAP server configured |
|
180 | + $dbc = \OC::$server->getDatabaseConnection(); |
|
181 | + $userManager = new Manager( |
|
182 | + \OC::$server->getConfig(), |
|
183 | + new FilesystemHelper(), |
|
184 | + new LogWrapper(), |
|
185 | + \OC::$server->getAvatarManager(), |
|
186 | + new \OCP\Image(), |
|
187 | + $dbc, |
|
188 | + \OC::$server->getUserManager(), |
|
189 | + \OC::$server->getNotificationManager()); |
|
190 | + $connector = new Connection($ldapWrapper, $configPrefixes[0]); |
|
191 | + $ldapAccess = new Access($connector, $ldapWrapper, $userManager, $helper); |
|
192 | + $groupMapper = new GroupMapping($dbc); |
|
193 | + $userMapper = new UserMapping($dbc); |
|
194 | + $ldapAccess->setGroupMapper($groupMapper); |
|
195 | + $ldapAccess->setUserMapper($userMapper); |
|
196 | + self::$groupBE = new \OCA\User_LDAP\Group_LDAP($ldapAccess); |
|
197 | + } else { |
|
198 | + self::$groupBE = new \OCA\User_LDAP\Group_Proxy($configPrefixes, $ldapWrapper); |
|
199 | + } |
|
200 | + |
|
201 | + return self::$groupBE; |
|
202 | + } |
|
203 | + |
|
204 | + /** |
|
205 | + * @return array |
|
206 | + */ |
|
207 | + static private function getKnownGroups() { |
|
208 | + if(is_array(self::$groupsFromDB)) { |
|
209 | + return self::$groupsFromDB; |
|
210 | + } |
|
211 | + $query = \OCP\DB::prepare(' |
|
212 | 212 | SELECT `owncloudname`, `owncloudusers` |
213 | 213 | FROM `*PREFIX*ldap_group_members` |
214 | 214 | '); |
215 | - $result = $query->execute()->fetchAll(); |
|
216 | - self::$groupsFromDB = array(); |
|
217 | - foreach($result as $dataset) { |
|
218 | - self::$groupsFromDB[$dataset['owncloudname']] = $dataset; |
|
219 | - } |
|
220 | - |
|
221 | - return self::$groupsFromDB; |
|
222 | - } |
|
215 | + $result = $query->execute()->fetchAll(); |
|
216 | + self::$groupsFromDB = array(); |
|
217 | + foreach($result as $dataset) { |
|
218 | + self::$groupsFromDB[$dataset['owncloudname']] = $dataset; |
|
219 | + } |
|
220 | + |
|
221 | + return self::$groupsFromDB; |
|
222 | + } |
|
223 | 223 | } |
@@ -112,7 +112,7 @@ |
||
112 | 112 | * Looks up a system wide defined value |
113 | 113 | * |
114 | 114 | * @param string $key the key of the value, under which it was saved |
115 | - * @param mixed $default the default value to be returned if the value isn't set |
|
115 | + * @param string $default the default value to be returned if the value isn't set |
|
116 | 116 | * @return mixed the value or $default |
117 | 117 | */ |
118 | 118 | public function getSystemValue($key, $default = '') { |
@@ -37,427 +37,427 @@ |
||
37 | 37 | * Class to combine all the configuration options ownCloud offers |
38 | 38 | */ |
39 | 39 | class AllConfig implements \OCP\IConfig { |
40 | - /** @var SystemConfig */ |
|
41 | - private $systemConfig; |
|
42 | - |
|
43 | - /** @var IDBConnection */ |
|
44 | - private $connection; |
|
45 | - |
|
46 | - /** |
|
47 | - * 3 dimensional array with the following structure: |
|
48 | - * [ $userId => |
|
49 | - * [ $appId => |
|
50 | - * [ $key => $value ] |
|
51 | - * ] |
|
52 | - * ] |
|
53 | - * |
|
54 | - * database table: preferences |
|
55 | - * |
|
56 | - * methods that use this: |
|
57 | - * - setUserValue |
|
58 | - * - getUserValue |
|
59 | - * - getUserKeys |
|
60 | - * - deleteUserValue |
|
61 | - * - deleteAllUserValues |
|
62 | - * - deleteAppFromAllUsers |
|
63 | - * |
|
64 | - * @var CappedMemoryCache $userCache |
|
65 | - */ |
|
66 | - private $userCache; |
|
67 | - |
|
68 | - /** |
|
69 | - * @param SystemConfig $systemConfig |
|
70 | - */ |
|
71 | - public function __construct(SystemConfig $systemConfig) { |
|
72 | - $this->userCache = new CappedMemoryCache(); |
|
73 | - $this->systemConfig = $systemConfig; |
|
74 | - } |
|
75 | - |
|
76 | - /** |
|
77 | - * TODO - FIXME This fixes an issue with base.php that cause cyclic |
|
78 | - * dependencies, especially with autoconfig setup |
|
79 | - * |
|
80 | - * Replace this by properly injected database connection. Currently the |
|
81 | - * base.php triggers the getDatabaseConnection too early which causes in |
|
82 | - * autoconfig setup case a too early distributed database connection and |
|
83 | - * the autoconfig then needs to reinit all already initialized dependencies |
|
84 | - * that use the database connection. |
|
85 | - * |
|
86 | - * otherwise a SQLite database is created in the wrong directory |
|
87 | - * because the database connection was created with an uninitialized config |
|
88 | - */ |
|
89 | - private function fixDIInit() { |
|
90 | - if($this->connection === null) { |
|
91 | - $this->connection = \OC::$server->getDatabaseConnection(); |
|
92 | - } |
|
93 | - } |
|
94 | - |
|
95 | - /** |
|
96 | - * Sets and deletes system wide values |
|
97 | - * |
|
98 | - * @param array $configs Associative array with `key => value` pairs |
|
99 | - * If value is null, the config key will be deleted |
|
100 | - */ |
|
101 | - public function setSystemValues(array $configs) { |
|
102 | - $this->systemConfig->setValues($configs); |
|
103 | - } |
|
104 | - |
|
105 | - /** |
|
106 | - * Sets a new system wide value |
|
107 | - * |
|
108 | - * @param string $key the key of the value, under which will be saved |
|
109 | - * @param mixed $value the value that should be stored |
|
110 | - */ |
|
111 | - public function setSystemValue($key, $value) { |
|
112 | - $this->systemConfig->setValue($key, $value); |
|
113 | - } |
|
114 | - |
|
115 | - /** |
|
116 | - * Looks up a system wide defined value |
|
117 | - * |
|
118 | - * @param string $key the key of the value, under which it was saved |
|
119 | - * @param mixed $default the default value to be returned if the value isn't set |
|
120 | - * @return mixed the value or $default |
|
121 | - */ |
|
122 | - public function getSystemValue($key, $default = '') { |
|
123 | - return $this->systemConfig->getValue($key, $default); |
|
124 | - } |
|
125 | - |
|
126 | - /** |
|
127 | - * Looks up a system wide defined value and filters out sensitive data |
|
128 | - * |
|
129 | - * @param string $key the key of the value, under which it was saved |
|
130 | - * @param mixed $default the default value to be returned if the value isn't set |
|
131 | - * @return mixed the value or $default |
|
132 | - */ |
|
133 | - public function getFilteredSystemValue($key, $default = '') { |
|
134 | - return $this->systemConfig->getFilteredValue($key, $default); |
|
135 | - } |
|
136 | - |
|
137 | - /** |
|
138 | - * Delete a system wide defined value |
|
139 | - * |
|
140 | - * @param string $key the key of the value, under which it was saved |
|
141 | - */ |
|
142 | - public function deleteSystemValue($key) { |
|
143 | - $this->systemConfig->deleteValue($key); |
|
144 | - } |
|
145 | - |
|
146 | - /** |
|
147 | - * Get all keys stored for an app |
|
148 | - * |
|
149 | - * @param string $appName the appName that we stored the value under |
|
150 | - * @return string[] the keys stored for the app |
|
151 | - */ |
|
152 | - public function getAppKeys($appName) { |
|
153 | - return \OC::$server->getAppConfig()->getKeys($appName); |
|
154 | - } |
|
155 | - |
|
156 | - /** |
|
157 | - * Writes a new app wide value |
|
158 | - * |
|
159 | - * @param string $appName the appName that we want to store the value under |
|
160 | - * @param string $key the key of the value, under which will be saved |
|
161 | - * @param string|float|int $value the value that should be stored |
|
162 | - */ |
|
163 | - public function setAppValue($appName, $key, $value) { |
|
164 | - \OC::$server->getAppConfig()->setValue($appName, $key, $value); |
|
165 | - } |
|
166 | - |
|
167 | - /** |
|
168 | - * Looks up an app wide defined value |
|
169 | - * |
|
170 | - * @param string $appName the appName that we stored the value under |
|
171 | - * @param string $key the key of the value, under which it was saved |
|
172 | - * @param string $default the default value to be returned if the value isn't set |
|
173 | - * @return string the saved value |
|
174 | - */ |
|
175 | - public function getAppValue($appName, $key, $default = '') { |
|
176 | - return \OC::$server->getAppConfig()->getValue($appName, $key, $default); |
|
177 | - } |
|
178 | - |
|
179 | - /** |
|
180 | - * Delete an app wide defined value |
|
181 | - * |
|
182 | - * @param string $appName the appName that we stored the value under |
|
183 | - * @param string $key the key of the value, under which it was saved |
|
184 | - */ |
|
185 | - public function deleteAppValue($appName, $key) { |
|
186 | - \OC::$server->getAppConfig()->deleteKey($appName, $key); |
|
187 | - } |
|
188 | - |
|
189 | - /** |
|
190 | - * Removes all keys in appconfig belonging to the app |
|
191 | - * |
|
192 | - * @param string $appName the appName the configs are stored under |
|
193 | - */ |
|
194 | - public function deleteAppValues($appName) { |
|
195 | - \OC::$server->getAppConfig()->deleteApp($appName); |
|
196 | - } |
|
197 | - |
|
198 | - |
|
199 | - /** |
|
200 | - * Set a user defined value |
|
201 | - * |
|
202 | - * @param string $userId the userId of the user that we want to store the value under |
|
203 | - * @param string $appName the appName that we want to store the value under |
|
204 | - * @param string $key the key under which the value is being stored |
|
205 | - * @param string|float|int $value the value that you want to store |
|
206 | - * @param string $preCondition only update if the config value was previously the value passed as $preCondition |
|
207 | - * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met |
|
208 | - * @throws \UnexpectedValueException when trying to store an unexpected value |
|
209 | - */ |
|
210 | - public function setUserValue($userId, $appName, $key, $value, $preCondition = null) { |
|
211 | - if (!is_int($value) && !is_float($value) && !is_string($value)) { |
|
212 | - throw new \UnexpectedValueException('Only integers, floats and strings are allowed as value'); |
|
213 | - } |
|
214 | - |
|
215 | - // TODO - FIXME |
|
216 | - $this->fixDIInit(); |
|
217 | - |
|
218 | - $prevValue = $this->getUserValue($userId, $appName, $key, null); |
|
219 | - |
|
220 | - if ($prevValue !== null) { |
|
221 | - if ($prevValue === (string)$value) { |
|
222 | - return; |
|
223 | - } else if ($preCondition !== null && $prevValue !== (string)$preCondition) { |
|
224 | - throw new PreConditionNotMetException(); |
|
225 | - } else { |
|
226 | - $qb = $this->connection->getQueryBuilder(); |
|
227 | - $qb->update('preferences') |
|
228 | - ->set('configvalue', $qb->createNamedParameter($value)) |
|
229 | - ->where($qb->expr()->eq('userid', $qb->createNamedParameter($userId))) |
|
230 | - ->andWhere($qb->expr()->eq('appid', $qb->createNamedParameter($appName))) |
|
231 | - ->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key))); |
|
232 | - $qb->execute(); |
|
233 | - |
|
234 | - $this->userCache[$userId][$appName][$key] = $value; |
|
235 | - return; |
|
236 | - } |
|
237 | - } |
|
238 | - |
|
239 | - $preconditionArray = []; |
|
240 | - if (isset($preCondition)) { |
|
241 | - $preconditionArray = [ |
|
242 | - 'configvalue' => $preCondition, |
|
243 | - ]; |
|
244 | - } |
|
245 | - |
|
246 | - $this->connection->setValues('preferences', [ |
|
247 | - 'userid' => $userId, |
|
248 | - 'appid' => $appName, |
|
249 | - 'configkey' => $key, |
|
250 | - ], [ |
|
251 | - 'configvalue' => $value, |
|
252 | - ], $preconditionArray); |
|
253 | - |
|
254 | - // only add to the cache if we already loaded data for the user |
|
255 | - if (isset($this->userCache[$userId])) { |
|
256 | - if (!isset($this->userCache[$userId][$appName])) { |
|
257 | - $this->userCache[$userId][$appName] = array(); |
|
258 | - } |
|
259 | - $this->userCache[$userId][$appName][$key] = $value; |
|
260 | - } |
|
261 | - } |
|
262 | - |
|
263 | - /** |
|
264 | - * Getting a user defined value |
|
265 | - * |
|
266 | - * @param string $userId the userId of the user that we want to store the value under |
|
267 | - * @param string $appName the appName that we stored the value under |
|
268 | - * @param string $key the key under which the value is being stored |
|
269 | - * @param mixed $default the default value to be returned if the value isn't set |
|
270 | - * @return string |
|
271 | - */ |
|
272 | - public function getUserValue($userId, $appName, $key, $default = '') { |
|
273 | - $data = $this->getUserValues($userId); |
|
274 | - if (isset($data[$appName]) and isset($data[$appName][$key])) { |
|
275 | - return $data[$appName][$key]; |
|
276 | - } else { |
|
277 | - return $default; |
|
278 | - } |
|
279 | - } |
|
280 | - |
|
281 | - /** |
|
282 | - * Get the keys of all stored by an app for the user |
|
283 | - * |
|
284 | - * @param string $userId the userId of the user that we want to store the value under |
|
285 | - * @param string $appName the appName that we stored the value under |
|
286 | - * @return string[] |
|
287 | - */ |
|
288 | - public function getUserKeys($userId, $appName) { |
|
289 | - $data = $this->getUserValues($userId); |
|
290 | - if (isset($data[$appName])) { |
|
291 | - return array_keys($data[$appName]); |
|
292 | - } else { |
|
293 | - return array(); |
|
294 | - } |
|
295 | - } |
|
296 | - |
|
297 | - /** |
|
298 | - * Delete a user value |
|
299 | - * |
|
300 | - * @param string $userId the userId of the user that we want to store the value under |
|
301 | - * @param string $appName the appName that we stored the value under |
|
302 | - * @param string $key the key under which the value is being stored |
|
303 | - */ |
|
304 | - public function deleteUserValue($userId, $appName, $key) { |
|
305 | - // TODO - FIXME |
|
306 | - $this->fixDIInit(); |
|
307 | - |
|
308 | - $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
309 | - 'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'; |
|
310 | - $this->connection->executeUpdate($sql, array($userId, $appName, $key)); |
|
311 | - |
|
312 | - if (isset($this->userCache[$userId]) and isset($this->userCache[$userId][$appName])) { |
|
313 | - unset($this->userCache[$userId][$appName][$key]); |
|
314 | - } |
|
315 | - } |
|
316 | - |
|
317 | - /** |
|
318 | - * Delete all user values |
|
319 | - * |
|
320 | - * @param string $userId the userId of the user that we want to remove all values from |
|
321 | - */ |
|
322 | - public function deleteAllUserValues($userId) { |
|
323 | - // TODO - FIXME |
|
324 | - $this->fixDIInit(); |
|
325 | - |
|
326 | - $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
327 | - 'WHERE `userid` = ?'; |
|
328 | - $this->connection->executeUpdate($sql, array($userId)); |
|
329 | - |
|
330 | - unset($this->userCache[$userId]); |
|
331 | - } |
|
332 | - |
|
333 | - /** |
|
334 | - * Delete all user related values of one app |
|
335 | - * |
|
336 | - * @param string $appName the appName of the app that we want to remove all values from |
|
337 | - */ |
|
338 | - public function deleteAppFromAllUsers($appName) { |
|
339 | - // TODO - FIXME |
|
340 | - $this->fixDIInit(); |
|
341 | - |
|
342 | - $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
343 | - 'WHERE `appid` = ?'; |
|
344 | - $this->connection->executeUpdate($sql, array($appName)); |
|
345 | - |
|
346 | - foreach ($this->userCache as &$userCache) { |
|
347 | - unset($userCache[$appName]); |
|
348 | - } |
|
349 | - } |
|
350 | - |
|
351 | - /** |
|
352 | - * Returns all user configs sorted by app of one user |
|
353 | - * |
|
354 | - * @param string $userId the user ID to get the app configs from |
|
355 | - * @return array[] - 2 dimensional array with the following structure: |
|
356 | - * [ $appId => |
|
357 | - * [ $key => $value ] |
|
358 | - * ] |
|
359 | - */ |
|
360 | - private function getUserValues($userId) { |
|
361 | - if (isset($this->userCache[$userId])) { |
|
362 | - return $this->userCache[$userId]; |
|
363 | - } |
|
364 | - if ($userId === null || $userId === '') { |
|
365 | - $this->userCache[$userId]=array(); |
|
366 | - return $this->userCache[$userId]; |
|
367 | - } |
|
368 | - |
|
369 | - // TODO - FIXME |
|
370 | - $this->fixDIInit(); |
|
371 | - |
|
372 | - $data = array(); |
|
373 | - $query = 'SELECT `appid`, `configkey`, `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ?'; |
|
374 | - $result = $this->connection->executeQuery($query, array($userId)); |
|
375 | - while ($row = $result->fetch()) { |
|
376 | - $appId = $row['appid']; |
|
377 | - if (!isset($data[$appId])) { |
|
378 | - $data[$appId] = array(); |
|
379 | - } |
|
380 | - $data[$appId][$row['configkey']] = $row['configvalue']; |
|
381 | - } |
|
382 | - $this->userCache[$userId] = $data; |
|
383 | - return $data; |
|
384 | - } |
|
385 | - |
|
386 | - /** |
|
387 | - * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs. |
|
388 | - * |
|
389 | - * @param string $appName app to get the value for |
|
390 | - * @param string $key the key to get the value for |
|
391 | - * @param array $userIds the user IDs to fetch the values for |
|
392 | - * @return array Mapped values: userId => value |
|
393 | - */ |
|
394 | - public function getUserValueForUsers($appName, $key, $userIds) { |
|
395 | - // TODO - FIXME |
|
396 | - $this->fixDIInit(); |
|
397 | - |
|
398 | - if (empty($userIds) || !is_array($userIds)) { |
|
399 | - return array(); |
|
400 | - } |
|
401 | - |
|
402 | - $chunkedUsers = array_chunk($userIds, 50, true); |
|
403 | - $placeholders50 = implode(',', array_fill(0, 50, '?')); |
|
404 | - |
|
405 | - $userValues = array(); |
|
406 | - foreach ($chunkedUsers as $chunk) { |
|
407 | - $queryParams = $chunk; |
|
408 | - // create [$app, $key, $chunkedUsers] |
|
409 | - array_unshift($queryParams, $key); |
|
410 | - array_unshift($queryParams, $appName); |
|
411 | - |
|
412 | - $placeholders = (sizeof($chunk) == 50) ? $placeholders50 : implode(',', array_fill(0, sizeof($chunk), '?')); |
|
413 | - |
|
414 | - $query = 'SELECT `userid`, `configvalue` ' . |
|
415 | - 'FROM `*PREFIX*preferences` ' . |
|
416 | - 'WHERE `appid` = ? AND `configkey` = ? ' . |
|
417 | - 'AND `userid` IN (' . $placeholders . ')'; |
|
418 | - $result = $this->connection->executeQuery($query, $queryParams); |
|
419 | - |
|
420 | - while ($row = $result->fetch()) { |
|
421 | - $userValues[$row['userid']] = $row['configvalue']; |
|
422 | - } |
|
423 | - } |
|
424 | - |
|
425 | - return $userValues; |
|
426 | - } |
|
427 | - |
|
428 | - /** |
|
429 | - * Determines the users that have the given value set for a specific app-key-pair |
|
430 | - * |
|
431 | - * @param string $appName the app to get the user for |
|
432 | - * @param string $key the key to get the user for |
|
433 | - * @param string $value the value to get the user for |
|
434 | - * @return array of user IDs |
|
435 | - */ |
|
436 | - public function getUsersForUserValue($appName, $key, $value) { |
|
437 | - // TODO - FIXME |
|
438 | - $this->fixDIInit(); |
|
439 | - |
|
440 | - $sql = 'SELECT `userid` FROM `*PREFIX*preferences` ' . |
|
441 | - 'WHERE `appid` = ? AND `configkey` = ? '; |
|
442 | - |
|
443 | - if($this->getSystemValue('dbtype', 'sqlite') === 'oci') { |
|
444 | - //oracle hack: need to explicitly cast CLOB to CHAR for comparison |
|
445 | - $sql .= 'AND to_char(`configvalue`) = ?'; |
|
446 | - } else { |
|
447 | - $sql .= 'AND `configvalue` = ?'; |
|
448 | - } |
|
449 | - |
|
450 | - $result = $this->connection->executeQuery($sql, array($appName, $key, $value)); |
|
451 | - |
|
452 | - $userIDs = array(); |
|
453 | - while ($row = $result->fetch()) { |
|
454 | - $userIDs[] = $row['userid']; |
|
455 | - } |
|
456 | - |
|
457 | - return $userIDs; |
|
458 | - } |
|
459 | - |
|
460 | - public function getSystemConfig() { |
|
461 | - return $this->systemConfig; |
|
462 | - } |
|
40 | + /** @var SystemConfig */ |
|
41 | + private $systemConfig; |
|
42 | + |
|
43 | + /** @var IDBConnection */ |
|
44 | + private $connection; |
|
45 | + |
|
46 | + /** |
|
47 | + * 3 dimensional array with the following structure: |
|
48 | + * [ $userId => |
|
49 | + * [ $appId => |
|
50 | + * [ $key => $value ] |
|
51 | + * ] |
|
52 | + * ] |
|
53 | + * |
|
54 | + * database table: preferences |
|
55 | + * |
|
56 | + * methods that use this: |
|
57 | + * - setUserValue |
|
58 | + * - getUserValue |
|
59 | + * - getUserKeys |
|
60 | + * - deleteUserValue |
|
61 | + * - deleteAllUserValues |
|
62 | + * - deleteAppFromAllUsers |
|
63 | + * |
|
64 | + * @var CappedMemoryCache $userCache |
|
65 | + */ |
|
66 | + private $userCache; |
|
67 | + |
|
68 | + /** |
|
69 | + * @param SystemConfig $systemConfig |
|
70 | + */ |
|
71 | + public function __construct(SystemConfig $systemConfig) { |
|
72 | + $this->userCache = new CappedMemoryCache(); |
|
73 | + $this->systemConfig = $systemConfig; |
|
74 | + } |
|
75 | + |
|
76 | + /** |
|
77 | + * TODO - FIXME This fixes an issue with base.php that cause cyclic |
|
78 | + * dependencies, especially with autoconfig setup |
|
79 | + * |
|
80 | + * Replace this by properly injected database connection. Currently the |
|
81 | + * base.php triggers the getDatabaseConnection too early which causes in |
|
82 | + * autoconfig setup case a too early distributed database connection and |
|
83 | + * the autoconfig then needs to reinit all already initialized dependencies |
|
84 | + * that use the database connection. |
|
85 | + * |
|
86 | + * otherwise a SQLite database is created in the wrong directory |
|
87 | + * because the database connection was created with an uninitialized config |
|
88 | + */ |
|
89 | + private function fixDIInit() { |
|
90 | + if($this->connection === null) { |
|
91 | + $this->connection = \OC::$server->getDatabaseConnection(); |
|
92 | + } |
|
93 | + } |
|
94 | + |
|
95 | + /** |
|
96 | + * Sets and deletes system wide values |
|
97 | + * |
|
98 | + * @param array $configs Associative array with `key => value` pairs |
|
99 | + * If value is null, the config key will be deleted |
|
100 | + */ |
|
101 | + public function setSystemValues(array $configs) { |
|
102 | + $this->systemConfig->setValues($configs); |
|
103 | + } |
|
104 | + |
|
105 | + /** |
|
106 | + * Sets a new system wide value |
|
107 | + * |
|
108 | + * @param string $key the key of the value, under which will be saved |
|
109 | + * @param mixed $value the value that should be stored |
|
110 | + */ |
|
111 | + public function setSystemValue($key, $value) { |
|
112 | + $this->systemConfig->setValue($key, $value); |
|
113 | + } |
|
114 | + |
|
115 | + /** |
|
116 | + * Looks up a system wide defined value |
|
117 | + * |
|
118 | + * @param string $key the key of the value, under which it was saved |
|
119 | + * @param mixed $default the default value to be returned if the value isn't set |
|
120 | + * @return mixed the value or $default |
|
121 | + */ |
|
122 | + public function getSystemValue($key, $default = '') { |
|
123 | + return $this->systemConfig->getValue($key, $default); |
|
124 | + } |
|
125 | + |
|
126 | + /** |
|
127 | + * Looks up a system wide defined value and filters out sensitive data |
|
128 | + * |
|
129 | + * @param string $key the key of the value, under which it was saved |
|
130 | + * @param mixed $default the default value to be returned if the value isn't set |
|
131 | + * @return mixed the value or $default |
|
132 | + */ |
|
133 | + public function getFilteredSystemValue($key, $default = '') { |
|
134 | + return $this->systemConfig->getFilteredValue($key, $default); |
|
135 | + } |
|
136 | + |
|
137 | + /** |
|
138 | + * Delete a system wide defined value |
|
139 | + * |
|
140 | + * @param string $key the key of the value, under which it was saved |
|
141 | + */ |
|
142 | + public function deleteSystemValue($key) { |
|
143 | + $this->systemConfig->deleteValue($key); |
|
144 | + } |
|
145 | + |
|
146 | + /** |
|
147 | + * Get all keys stored for an app |
|
148 | + * |
|
149 | + * @param string $appName the appName that we stored the value under |
|
150 | + * @return string[] the keys stored for the app |
|
151 | + */ |
|
152 | + public function getAppKeys($appName) { |
|
153 | + return \OC::$server->getAppConfig()->getKeys($appName); |
|
154 | + } |
|
155 | + |
|
156 | + /** |
|
157 | + * Writes a new app wide value |
|
158 | + * |
|
159 | + * @param string $appName the appName that we want to store the value under |
|
160 | + * @param string $key the key of the value, under which will be saved |
|
161 | + * @param string|float|int $value the value that should be stored |
|
162 | + */ |
|
163 | + public function setAppValue($appName, $key, $value) { |
|
164 | + \OC::$server->getAppConfig()->setValue($appName, $key, $value); |
|
165 | + } |
|
166 | + |
|
167 | + /** |
|
168 | + * Looks up an app wide defined value |
|
169 | + * |
|
170 | + * @param string $appName the appName that we stored the value under |
|
171 | + * @param string $key the key of the value, under which it was saved |
|
172 | + * @param string $default the default value to be returned if the value isn't set |
|
173 | + * @return string the saved value |
|
174 | + */ |
|
175 | + public function getAppValue($appName, $key, $default = '') { |
|
176 | + return \OC::$server->getAppConfig()->getValue($appName, $key, $default); |
|
177 | + } |
|
178 | + |
|
179 | + /** |
|
180 | + * Delete an app wide defined value |
|
181 | + * |
|
182 | + * @param string $appName the appName that we stored the value under |
|
183 | + * @param string $key the key of the value, under which it was saved |
|
184 | + */ |
|
185 | + public function deleteAppValue($appName, $key) { |
|
186 | + \OC::$server->getAppConfig()->deleteKey($appName, $key); |
|
187 | + } |
|
188 | + |
|
189 | + /** |
|
190 | + * Removes all keys in appconfig belonging to the app |
|
191 | + * |
|
192 | + * @param string $appName the appName the configs are stored under |
|
193 | + */ |
|
194 | + public function deleteAppValues($appName) { |
|
195 | + \OC::$server->getAppConfig()->deleteApp($appName); |
|
196 | + } |
|
197 | + |
|
198 | + |
|
199 | + /** |
|
200 | + * Set a user defined value |
|
201 | + * |
|
202 | + * @param string $userId the userId of the user that we want to store the value under |
|
203 | + * @param string $appName the appName that we want to store the value under |
|
204 | + * @param string $key the key under which the value is being stored |
|
205 | + * @param string|float|int $value the value that you want to store |
|
206 | + * @param string $preCondition only update if the config value was previously the value passed as $preCondition |
|
207 | + * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met |
|
208 | + * @throws \UnexpectedValueException when trying to store an unexpected value |
|
209 | + */ |
|
210 | + public function setUserValue($userId, $appName, $key, $value, $preCondition = null) { |
|
211 | + if (!is_int($value) && !is_float($value) && !is_string($value)) { |
|
212 | + throw new \UnexpectedValueException('Only integers, floats and strings are allowed as value'); |
|
213 | + } |
|
214 | + |
|
215 | + // TODO - FIXME |
|
216 | + $this->fixDIInit(); |
|
217 | + |
|
218 | + $prevValue = $this->getUserValue($userId, $appName, $key, null); |
|
219 | + |
|
220 | + if ($prevValue !== null) { |
|
221 | + if ($prevValue === (string)$value) { |
|
222 | + return; |
|
223 | + } else if ($preCondition !== null && $prevValue !== (string)$preCondition) { |
|
224 | + throw new PreConditionNotMetException(); |
|
225 | + } else { |
|
226 | + $qb = $this->connection->getQueryBuilder(); |
|
227 | + $qb->update('preferences') |
|
228 | + ->set('configvalue', $qb->createNamedParameter($value)) |
|
229 | + ->where($qb->expr()->eq('userid', $qb->createNamedParameter($userId))) |
|
230 | + ->andWhere($qb->expr()->eq('appid', $qb->createNamedParameter($appName))) |
|
231 | + ->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key))); |
|
232 | + $qb->execute(); |
|
233 | + |
|
234 | + $this->userCache[$userId][$appName][$key] = $value; |
|
235 | + return; |
|
236 | + } |
|
237 | + } |
|
238 | + |
|
239 | + $preconditionArray = []; |
|
240 | + if (isset($preCondition)) { |
|
241 | + $preconditionArray = [ |
|
242 | + 'configvalue' => $preCondition, |
|
243 | + ]; |
|
244 | + } |
|
245 | + |
|
246 | + $this->connection->setValues('preferences', [ |
|
247 | + 'userid' => $userId, |
|
248 | + 'appid' => $appName, |
|
249 | + 'configkey' => $key, |
|
250 | + ], [ |
|
251 | + 'configvalue' => $value, |
|
252 | + ], $preconditionArray); |
|
253 | + |
|
254 | + // only add to the cache if we already loaded data for the user |
|
255 | + if (isset($this->userCache[$userId])) { |
|
256 | + if (!isset($this->userCache[$userId][$appName])) { |
|
257 | + $this->userCache[$userId][$appName] = array(); |
|
258 | + } |
|
259 | + $this->userCache[$userId][$appName][$key] = $value; |
|
260 | + } |
|
261 | + } |
|
262 | + |
|
263 | + /** |
|
264 | + * Getting a user defined value |
|
265 | + * |
|
266 | + * @param string $userId the userId of the user that we want to store the value under |
|
267 | + * @param string $appName the appName that we stored the value under |
|
268 | + * @param string $key the key under which the value is being stored |
|
269 | + * @param mixed $default the default value to be returned if the value isn't set |
|
270 | + * @return string |
|
271 | + */ |
|
272 | + public function getUserValue($userId, $appName, $key, $default = '') { |
|
273 | + $data = $this->getUserValues($userId); |
|
274 | + if (isset($data[$appName]) and isset($data[$appName][$key])) { |
|
275 | + return $data[$appName][$key]; |
|
276 | + } else { |
|
277 | + return $default; |
|
278 | + } |
|
279 | + } |
|
280 | + |
|
281 | + /** |
|
282 | + * Get the keys of all stored by an app for the user |
|
283 | + * |
|
284 | + * @param string $userId the userId of the user that we want to store the value under |
|
285 | + * @param string $appName the appName that we stored the value under |
|
286 | + * @return string[] |
|
287 | + */ |
|
288 | + public function getUserKeys($userId, $appName) { |
|
289 | + $data = $this->getUserValues($userId); |
|
290 | + if (isset($data[$appName])) { |
|
291 | + return array_keys($data[$appName]); |
|
292 | + } else { |
|
293 | + return array(); |
|
294 | + } |
|
295 | + } |
|
296 | + |
|
297 | + /** |
|
298 | + * Delete a user value |
|
299 | + * |
|
300 | + * @param string $userId the userId of the user that we want to store the value under |
|
301 | + * @param string $appName the appName that we stored the value under |
|
302 | + * @param string $key the key under which the value is being stored |
|
303 | + */ |
|
304 | + public function deleteUserValue($userId, $appName, $key) { |
|
305 | + // TODO - FIXME |
|
306 | + $this->fixDIInit(); |
|
307 | + |
|
308 | + $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
309 | + 'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'; |
|
310 | + $this->connection->executeUpdate($sql, array($userId, $appName, $key)); |
|
311 | + |
|
312 | + if (isset($this->userCache[$userId]) and isset($this->userCache[$userId][$appName])) { |
|
313 | + unset($this->userCache[$userId][$appName][$key]); |
|
314 | + } |
|
315 | + } |
|
316 | + |
|
317 | + /** |
|
318 | + * Delete all user values |
|
319 | + * |
|
320 | + * @param string $userId the userId of the user that we want to remove all values from |
|
321 | + */ |
|
322 | + public function deleteAllUserValues($userId) { |
|
323 | + // TODO - FIXME |
|
324 | + $this->fixDIInit(); |
|
325 | + |
|
326 | + $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
327 | + 'WHERE `userid` = ?'; |
|
328 | + $this->connection->executeUpdate($sql, array($userId)); |
|
329 | + |
|
330 | + unset($this->userCache[$userId]); |
|
331 | + } |
|
332 | + |
|
333 | + /** |
|
334 | + * Delete all user related values of one app |
|
335 | + * |
|
336 | + * @param string $appName the appName of the app that we want to remove all values from |
|
337 | + */ |
|
338 | + public function deleteAppFromAllUsers($appName) { |
|
339 | + // TODO - FIXME |
|
340 | + $this->fixDIInit(); |
|
341 | + |
|
342 | + $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
343 | + 'WHERE `appid` = ?'; |
|
344 | + $this->connection->executeUpdate($sql, array($appName)); |
|
345 | + |
|
346 | + foreach ($this->userCache as &$userCache) { |
|
347 | + unset($userCache[$appName]); |
|
348 | + } |
|
349 | + } |
|
350 | + |
|
351 | + /** |
|
352 | + * Returns all user configs sorted by app of one user |
|
353 | + * |
|
354 | + * @param string $userId the user ID to get the app configs from |
|
355 | + * @return array[] - 2 dimensional array with the following structure: |
|
356 | + * [ $appId => |
|
357 | + * [ $key => $value ] |
|
358 | + * ] |
|
359 | + */ |
|
360 | + private function getUserValues($userId) { |
|
361 | + if (isset($this->userCache[$userId])) { |
|
362 | + return $this->userCache[$userId]; |
|
363 | + } |
|
364 | + if ($userId === null || $userId === '') { |
|
365 | + $this->userCache[$userId]=array(); |
|
366 | + return $this->userCache[$userId]; |
|
367 | + } |
|
368 | + |
|
369 | + // TODO - FIXME |
|
370 | + $this->fixDIInit(); |
|
371 | + |
|
372 | + $data = array(); |
|
373 | + $query = 'SELECT `appid`, `configkey`, `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ?'; |
|
374 | + $result = $this->connection->executeQuery($query, array($userId)); |
|
375 | + while ($row = $result->fetch()) { |
|
376 | + $appId = $row['appid']; |
|
377 | + if (!isset($data[$appId])) { |
|
378 | + $data[$appId] = array(); |
|
379 | + } |
|
380 | + $data[$appId][$row['configkey']] = $row['configvalue']; |
|
381 | + } |
|
382 | + $this->userCache[$userId] = $data; |
|
383 | + return $data; |
|
384 | + } |
|
385 | + |
|
386 | + /** |
|
387 | + * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs. |
|
388 | + * |
|
389 | + * @param string $appName app to get the value for |
|
390 | + * @param string $key the key to get the value for |
|
391 | + * @param array $userIds the user IDs to fetch the values for |
|
392 | + * @return array Mapped values: userId => value |
|
393 | + */ |
|
394 | + public function getUserValueForUsers($appName, $key, $userIds) { |
|
395 | + // TODO - FIXME |
|
396 | + $this->fixDIInit(); |
|
397 | + |
|
398 | + if (empty($userIds) || !is_array($userIds)) { |
|
399 | + return array(); |
|
400 | + } |
|
401 | + |
|
402 | + $chunkedUsers = array_chunk($userIds, 50, true); |
|
403 | + $placeholders50 = implode(',', array_fill(0, 50, '?')); |
|
404 | + |
|
405 | + $userValues = array(); |
|
406 | + foreach ($chunkedUsers as $chunk) { |
|
407 | + $queryParams = $chunk; |
|
408 | + // create [$app, $key, $chunkedUsers] |
|
409 | + array_unshift($queryParams, $key); |
|
410 | + array_unshift($queryParams, $appName); |
|
411 | + |
|
412 | + $placeholders = (sizeof($chunk) == 50) ? $placeholders50 : implode(',', array_fill(0, sizeof($chunk), '?')); |
|
413 | + |
|
414 | + $query = 'SELECT `userid`, `configvalue` ' . |
|
415 | + 'FROM `*PREFIX*preferences` ' . |
|
416 | + 'WHERE `appid` = ? AND `configkey` = ? ' . |
|
417 | + 'AND `userid` IN (' . $placeholders . ')'; |
|
418 | + $result = $this->connection->executeQuery($query, $queryParams); |
|
419 | + |
|
420 | + while ($row = $result->fetch()) { |
|
421 | + $userValues[$row['userid']] = $row['configvalue']; |
|
422 | + } |
|
423 | + } |
|
424 | + |
|
425 | + return $userValues; |
|
426 | + } |
|
427 | + |
|
428 | + /** |
|
429 | + * Determines the users that have the given value set for a specific app-key-pair |
|
430 | + * |
|
431 | + * @param string $appName the app to get the user for |
|
432 | + * @param string $key the key to get the user for |
|
433 | + * @param string $value the value to get the user for |
|
434 | + * @return array of user IDs |
|
435 | + */ |
|
436 | + public function getUsersForUserValue($appName, $key, $value) { |
|
437 | + // TODO - FIXME |
|
438 | + $this->fixDIInit(); |
|
439 | + |
|
440 | + $sql = 'SELECT `userid` FROM `*PREFIX*preferences` ' . |
|
441 | + 'WHERE `appid` = ? AND `configkey` = ? '; |
|
442 | + |
|
443 | + if($this->getSystemValue('dbtype', 'sqlite') === 'oci') { |
|
444 | + //oracle hack: need to explicitly cast CLOB to CHAR for comparison |
|
445 | + $sql .= 'AND to_char(`configvalue`) = ?'; |
|
446 | + } else { |
|
447 | + $sql .= 'AND `configvalue` = ?'; |
|
448 | + } |
|
449 | + |
|
450 | + $result = $this->connection->executeQuery($sql, array($appName, $key, $value)); |
|
451 | + |
|
452 | + $userIDs = array(); |
|
453 | + while ($row = $result->fetch()) { |
|
454 | + $userIDs[] = $row['userid']; |
|
455 | + } |
|
456 | + |
|
457 | + return $userIDs; |
|
458 | + } |
|
459 | + |
|
460 | + public function getSystemConfig() { |
|
461 | + return $this->systemConfig; |
|
462 | + } |
|
463 | 463 | } |
@@ -87,7 +87,7 @@ discard block |
||
87 | 87 | * because the database connection was created with an uninitialized config |
88 | 88 | */ |
89 | 89 | private function fixDIInit() { |
90 | - if($this->connection === null) { |
|
90 | + if ($this->connection === null) { |
|
91 | 91 | $this->connection = \OC::$server->getDatabaseConnection(); |
92 | 92 | } |
93 | 93 | } |
@@ -218,9 +218,9 @@ discard block |
||
218 | 218 | $prevValue = $this->getUserValue($userId, $appName, $key, null); |
219 | 219 | |
220 | 220 | if ($prevValue !== null) { |
221 | - if ($prevValue === (string)$value) { |
|
221 | + if ($prevValue === (string) $value) { |
|
222 | 222 | return; |
223 | - } else if ($preCondition !== null && $prevValue !== (string)$preCondition) { |
|
223 | + } else if ($preCondition !== null && $prevValue !== (string) $preCondition) { |
|
224 | 224 | throw new PreConditionNotMetException(); |
225 | 225 | } else { |
226 | 226 | $qb = $this->connection->getQueryBuilder(); |
@@ -305,7 +305,7 @@ discard block |
||
305 | 305 | // TODO - FIXME |
306 | 306 | $this->fixDIInit(); |
307 | 307 | |
308 | - $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
308 | + $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
309 | 309 | 'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'; |
310 | 310 | $this->connection->executeUpdate($sql, array($userId, $appName, $key)); |
311 | 311 | |
@@ -323,7 +323,7 @@ discard block |
||
323 | 323 | // TODO - FIXME |
324 | 324 | $this->fixDIInit(); |
325 | 325 | |
326 | - $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
326 | + $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
327 | 327 | 'WHERE `userid` = ?'; |
328 | 328 | $this->connection->executeUpdate($sql, array($userId)); |
329 | 329 | |
@@ -339,7 +339,7 @@ discard block |
||
339 | 339 | // TODO - FIXME |
340 | 340 | $this->fixDIInit(); |
341 | 341 | |
342 | - $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
342 | + $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
343 | 343 | 'WHERE `appid` = ?'; |
344 | 344 | $this->connection->executeUpdate($sql, array($appName)); |
345 | 345 | |
@@ -362,7 +362,7 @@ discard block |
||
362 | 362 | return $this->userCache[$userId]; |
363 | 363 | } |
364 | 364 | if ($userId === null || $userId === '') { |
365 | - $this->userCache[$userId]=array(); |
|
365 | + $this->userCache[$userId] = array(); |
|
366 | 366 | return $this->userCache[$userId]; |
367 | 367 | } |
368 | 368 | |
@@ -409,12 +409,12 @@ discard block |
||
409 | 409 | array_unshift($queryParams, $key); |
410 | 410 | array_unshift($queryParams, $appName); |
411 | 411 | |
412 | - $placeholders = (sizeof($chunk) == 50) ? $placeholders50 : implode(',', array_fill(0, sizeof($chunk), '?')); |
|
412 | + $placeholders = (sizeof($chunk) == 50) ? $placeholders50 : implode(',', array_fill(0, sizeof($chunk), '?')); |
|
413 | 413 | |
414 | - $query = 'SELECT `userid`, `configvalue` ' . |
|
415 | - 'FROM `*PREFIX*preferences` ' . |
|
416 | - 'WHERE `appid` = ? AND `configkey` = ? ' . |
|
417 | - 'AND `userid` IN (' . $placeholders . ')'; |
|
414 | + $query = 'SELECT `userid`, `configvalue` '. |
|
415 | + 'FROM `*PREFIX*preferences` '. |
|
416 | + 'WHERE `appid` = ? AND `configkey` = ? '. |
|
417 | + 'AND `userid` IN ('.$placeholders.')'; |
|
418 | 418 | $result = $this->connection->executeQuery($query, $queryParams); |
419 | 419 | |
420 | 420 | while ($row = $result->fetch()) { |
@@ -437,10 +437,10 @@ discard block |
||
437 | 437 | // TODO - FIXME |
438 | 438 | $this->fixDIInit(); |
439 | 439 | |
440 | - $sql = 'SELECT `userid` FROM `*PREFIX*preferences` ' . |
|
440 | + $sql = 'SELECT `userid` FROM `*PREFIX*preferences` '. |
|
441 | 441 | 'WHERE `appid` = ? AND `configkey` = ? '; |
442 | 442 | |
443 | - if($this->getSystemValue('dbtype', 'sqlite') === 'oci') { |
|
443 | + if ($this->getSystemValue('dbtype', 'sqlite') === 'oci') { |
|
444 | 444 | //oracle hack: need to explicitly cast CLOB to CHAR for comparison |
445 | 445 | $sql .= 'AND to_char(`configvalue`) = ?'; |
446 | 446 | } else { |
@@ -296,6 +296,9 @@ |
||
296 | 296 | } |
297 | 297 | } |
298 | 298 | |
299 | + /** |
|
300 | + * @param string $name |
|
301 | + */ |
|
299 | 302 | private function buildReason($name, $errorCode) { |
300 | 303 | if (isset($this->errorMessages[$errorCode])) { |
301 | 304 | $desc = $this->list->getDescription($errorCode, $name); |
@@ -29,280 +29,280 @@ |
||
29 | 29 | use PhpParser\NodeVisitorAbstract; |
30 | 30 | |
31 | 31 | class NodeVisitor extends NodeVisitorAbstract { |
32 | - /** @var ICheck */ |
|
33 | - protected $list; |
|
34 | - |
|
35 | - /** @var string */ |
|
36 | - protected $blackListDescription; |
|
37 | - /** @var string[] */ |
|
38 | - protected $blackListedClassNames; |
|
39 | - /** @var string[] */ |
|
40 | - protected $blackListedConstants; |
|
41 | - /** @var string[] */ |
|
42 | - protected $blackListedFunctions; |
|
43 | - /** @var string[] */ |
|
44 | - protected $blackListedMethods; |
|
45 | - /** @var bool */ |
|
46 | - protected $checkEqualOperatorUsage; |
|
47 | - /** @var string[] */ |
|
48 | - protected $errorMessages; |
|
49 | - |
|
50 | - /** |
|
51 | - * @param ICheck $list |
|
52 | - */ |
|
53 | - public function __construct(ICheck $list) { |
|
54 | - $this->list = $list; |
|
55 | - |
|
56 | - $this->blackListedClassNames = []; |
|
57 | - foreach ($list->getClasses() as $class => $blackListInfo) { |
|
58 | - if (is_numeric($class) && is_string($blackListInfo)) { |
|
59 | - $class = $blackListInfo; |
|
60 | - $blackListInfo = null; |
|
61 | - } |
|
62 | - |
|
63 | - $class = strtolower($class); |
|
64 | - $this->blackListedClassNames[$class] = $class; |
|
65 | - } |
|
66 | - |
|
67 | - $this->blackListedConstants = []; |
|
68 | - foreach ($list->getConstants() as $constantName => $blackListInfo) { |
|
69 | - $constantName = strtolower($constantName); |
|
70 | - $this->blackListedConstants[$constantName] = $constantName; |
|
71 | - } |
|
72 | - |
|
73 | - $this->blackListedFunctions = []; |
|
74 | - foreach ($list->getFunctions() as $functionName => $blackListInfo) { |
|
75 | - $functionName = strtolower($functionName); |
|
76 | - $this->blackListedFunctions[$functionName] = $functionName; |
|
77 | - } |
|
78 | - |
|
79 | - $this->blackListedMethods = []; |
|
80 | - foreach ($list->getMethods() as $functionName => $blackListInfo) { |
|
81 | - $functionName = strtolower($functionName); |
|
82 | - $this->blackListedMethods[$functionName] = $functionName; |
|
83 | - } |
|
84 | - |
|
85 | - $this->checkEqualOperatorUsage = $list->checkStrongComparisons(); |
|
86 | - |
|
87 | - $this->errorMessages = [ |
|
88 | - CodeChecker::CLASS_EXTENDS_NOT_ALLOWED => "%s class must not be extended", |
|
89 | - CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED => "%s interface must not be implemented", |
|
90 | - CodeChecker::STATIC_CALL_NOT_ALLOWED => "Static method of %s class must not be called", |
|
91 | - CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED => "Constant of %s class must not not be fetched", |
|
92 | - CodeChecker::CLASS_NEW_NOT_ALLOWED => "%s class must not be instantiated", |
|
93 | - CodeChecker::CLASS_USE_NOT_ALLOWED => "%s class must not be imported with a use statement", |
|
94 | - CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED => "Method of %s class must not be called", |
|
95 | - |
|
96 | - CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED => "is discouraged", |
|
97 | - ]; |
|
98 | - } |
|
99 | - |
|
100 | - /** @var array */ |
|
101 | - public $errors = []; |
|
102 | - |
|
103 | - public function enterNode(Node $node) { |
|
104 | - if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) { |
|
105 | - $this->errors[]= [ |
|
106 | - 'disallowedToken' => '==', |
|
107 | - 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
|
108 | - 'line' => $node->getLine(), |
|
109 | - 'reason' => $this->buildReason('==', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED) |
|
110 | - ]; |
|
111 | - } |
|
112 | - if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) { |
|
113 | - $this->errors[]= [ |
|
114 | - 'disallowedToken' => '!=', |
|
115 | - 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
|
116 | - 'line' => $node->getLine(), |
|
117 | - 'reason' => $this->buildReason('!=', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED) |
|
118 | - ]; |
|
119 | - } |
|
120 | - if ($node instanceof Node\Stmt\Class_) { |
|
121 | - if (!is_null($node->extends)) { |
|
122 | - $this->checkBlackList($node->extends->toString(), CodeChecker::CLASS_EXTENDS_NOT_ALLOWED, $node); |
|
123 | - } |
|
124 | - foreach ($node->implements as $implements) { |
|
125 | - $this->checkBlackList($implements->toString(), CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED, $node); |
|
126 | - } |
|
127 | - } |
|
128 | - if ($node instanceof Node\Expr\StaticCall) { |
|
129 | - if (!is_null($node->class)) { |
|
130 | - if ($node->class instanceof Name) { |
|
131 | - $this->checkBlackList($node->class->toString(), CodeChecker::STATIC_CALL_NOT_ALLOWED, $node); |
|
132 | - |
|
133 | - $this->checkBlackListFunction($node->class->toString(), $node->name, $node); |
|
134 | - $this->checkBlackListMethod($node->class->toString(), $node->name, $node); |
|
135 | - } |
|
136 | - |
|
137 | - if ($node->class instanceof Node\Expr\Variable) { |
|
138 | - /** |
|
139 | - * TODO: find a way to detect something like this: |
|
140 | - * $c = "OC_API"; |
|
141 | - * $n = $c::call(); |
|
142 | - */ |
|
143 | - // $this->checkBlackListMethod($node->class->..., $node->name, $node); |
|
144 | - } |
|
145 | - } |
|
146 | - } |
|
147 | - if ($node instanceof Node\Expr\MethodCall) { |
|
148 | - if (!is_null($node->var)) { |
|
149 | - if ($node->var instanceof Node\Expr\Variable) { |
|
150 | - /** |
|
151 | - * TODO: find a way to detect something like this: |
|
152 | - * $c = new OC_API(); |
|
153 | - * $n = $c::call(); |
|
154 | - * $n = $c->call(); |
|
155 | - */ |
|
156 | - // $this->checkBlackListMethod($node->var->..., $node->name, $node); |
|
157 | - } |
|
158 | - } |
|
159 | - } |
|
160 | - if ($node instanceof Node\Expr\ClassConstFetch) { |
|
161 | - if (!is_null($node->class)) { |
|
162 | - if ($node->class instanceof Name) { |
|
163 | - $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, $node); |
|
164 | - } |
|
165 | - if ($node->class instanceof Node\Expr\Variable) { |
|
166 | - /** |
|
167 | - * TODO: find a way to detect something like this: |
|
168 | - * $c = "OC_API"; |
|
169 | - * $n = $i::ADMIN_AUTH; |
|
170 | - */ |
|
171 | - } else { |
|
172 | - $this->checkBlackListConstant($node->class->toString(), $node->name, $node); |
|
173 | - } |
|
174 | - } |
|
175 | - } |
|
176 | - if ($node instanceof Node\Expr\New_) { |
|
177 | - if (!is_null($node->class)) { |
|
178 | - if ($node->class instanceof Name) { |
|
179 | - $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_NEW_NOT_ALLOWED, $node); |
|
180 | - } |
|
181 | - if ($node->class instanceof Node\Expr\Variable) { |
|
182 | - /** |
|
183 | - * TODO: find a way to detect something like this: |
|
184 | - * $c = "OC_API"; |
|
185 | - * $n = new $i; |
|
186 | - */ |
|
187 | - } |
|
188 | - } |
|
189 | - } |
|
190 | - if ($node instanceof Node\Stmt\UseUse) { |
|
191 | - $this->checkBlackList($node->name->toString(), CodeChecker::CLASS_USE_NOT_ALLOWED, $node); |
|
192 | - if ($node->alias) { |
|
193 | - $this->addUseNameToBlackList($node->name->toString(), $node->alias); |
|
194 | - } else { |
|
195 | - $this->addUseNameToBlackList($node->name->toString(), $node->name->getLast()); |
|
196 | - } |
|
197 | - } |
|
198 | - } |
|
199 | - |
|
200 | - /** |
|
201 | - * Check whether an alias was introduced for a namespace of a blacklisted class |
|
202 | - * |
|
203 | - * Example: |
|
204 | - * - Blacklist entry: OCP\AppFramework\IApi |
|
205 | - * - Name: OCP\AppFramework |
|
206 | - * - Alias: OAF |
|
207 | - * => new blacklist entry: OAF\IApi |
|
208 | - * |
|
209 | - * @param string $name |
|
210 | - * @param string $alias |
|
211 | - */ |
|
212 | - private function addUseNameToBlackList($name, $alias) { |
|
213 | - $name = strtolower($name); |
|
214 | - $alias = strtolower($alias); |
|
215 | - |
|
216 | - foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) { |
|
217 | - if (strpos($blackListedClassName, $name . '\\') === 0) { |
|
218 | - $aliasedClassName = str_replace($name, $alias, $blackListedClassName); |
|
219 | - $this->blackListedClassNames[$aliasedClassName] = $blackListedClassName; |
|
220 | - } |
|
221 | - } |
|
222 | - |
|
223 | - foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) { |
|
224 | - if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) { |
|
225 | - $aliasedConstantName = str_replace($name, $alias, $blackListedConstant); |
|
226 | - $this->blackListedConstants[$aliasedConstantName] = $blackListedConstant; |
|
227 | - } |
|
228 | - } |
|
229 | - |
|
230 | - foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) { |
|
231 | - if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) { |
|
232 | - $aliasedFunctionName = str_replace($name, $alias, $blackListedFunction); |
|
233 | - $this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction; |
|
234 | - } |
|
235 | - } |
|
236 | - |
|
237 | - foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) { |
|
238 | - if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) { |
|
239 | - $aliasedMethodName = str_replace($name, $alias, $blackListedMethod); |
|
240 | - $this->blackListedMethods[$aliasedMethodName] = $blackListedMethod; |
|
241 | - } |
|
242 | - } |
|
243 | - } |
|
244 | - |
|
245 | - private function checkBlackList($name, $errorCode, Node $node) { |
|
246 | - $lowerName = strtolower($name); |
|
247 | - |
|
248 | - if (isset($this->blackListedClassNames[$lowerName])) { |
|
249 | - $this->errors[]= [ |
|
250 | - 'disallowedToken' => $name, |
|
251 | - 'errorCode' => $errorCode, |
|
252 | - 'line' => $node->getLine(), |
|
253 | - 'reason' => $this->buildReason($this->blackListedClassNames[$lowerName], $errorCode) |
|
254 | - ]; |
|
255 | - } |
|
256 | - } |
|
257 | - |
|
258 | - private function checkBlackListConstant($class, $constantName, Node $node) { |
|
259 | - $name = $class . '::' . $constantName; |
|
260 | - $lowerName = strtolower($name); |
|
261 | - |
|
262 | - if (isset($this->blackListedConstants[$lowerName])) { |
|
263 | - $this->errors[]= [ |
|
264 | - 'disallowedToken' => $name, |
|
265 | - 'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, |
|
266 | - 'line' => $node->getLine(), |
|
267 | - 'reason' => $this->buildReason($this->blackListedConstants[$lowerName], CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED) |
|
268 | - ]; |
|
269 | - } |
|
270 | - } |
|
271 | - |
|
272 | - private function checkBlackListFunction($class, $functionName, Node $node) { |
|
273 | - $name = $class . '::' . $functionName; |
|
274 | - $lowerName = strtolower($name); |
|
275 | - |
|
276 | - if (isset($this->blackListedFunctions[$lowerName])) { |
|
277 | - $this->errors[]= [ |
|
278 | - 'disallowedToken' => $name, |
|
279 | - 'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED, |
|
280 | - 'line' => $node->getLine(), |
|
281 | - 'reason' => $this->buildReason($this->blackListedFunctions[$lowerName], CodeChecker::STATIC_CALL_NOT_ALLOWED) |
|
282 | - ]; |
|
283 | - } |
|
284 | - } |
|
285 | - |
|
286 | - private function checkBlackListMethod($class, $functionName, Node $node) { |
|
287 | - $name = $class . '::' . $functionName; |
|
288 | - $lowerName = strtolower($name); |
|
289 | - |
|
290 | - if (isset($this->blackListedMethods[$lowerName])) { |
|
291 | - $this->errors[]= [ |
|
292 | - 'disallowedToken' => $name, |
|
293 | - 'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED, |
|
294 | - 'line' => $node->getLine(), |
|
295 | - 'reason' => $this->buildReason($this->blackListedMethods[$lowerName], CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED) |
|
296 | - ]; |
|
297 | - } |
|
298 | - } |
|
299 | - |
|
300 | - private function buildReason($name, $errorCode) { |
|
301 | - if (isset($this->errorMessages[$errorCode])) { |
|
302 | - $desc = $this->list->getDescription($errorCode, $name); |
|
303 | - return sprintf($this->errorMessages[$errorCode], $desc); |
|
304 | - } |
|
305 | - |
|
306 | - return "$name usage not allowed - error: $errorCode"; |
|
307 | - } |
|
32 | + /** @var ICheck */ |
|
33 | + protected $list; |
|
34 | + |
|
35 | + /** @var string */ |
|
36 | + protected $blackListDescription; |
|
37 | + /** @var string[] */ |
|
38 | + protected $blackListedClassNames; |
|
39 | + /** @var string[] */ |
|
40 | + protected $blackListedConstants; |
|
41 | + /** @var string[] */ |
|
42 | + protected $blackListedFunctions; |
|
43 | + /** @var string[] */ |
|
44 | + protected $blackListedMethods; |
|
45 | + /** @var bool */ |
|
46 | + protected $checkEqualOperatorUsage; |
|
47 | + /** @var string[] */ |
|
48 | + protected $errorMessages; |
|
49 | + |
|
50 | + /** |
|
51 | + * @param ICheck $list |
|
52 | + */ |
|
53 | + public function __construct(ICheck $list) { |
|
54 | + $this->list = $list; |
|
55 | + |
|
56 | + $this->blackListedClassNames = []; |
|
57 | + foreach ($list->getClasses() as $class => $blackListInfo) { |
|
58 | + if (is_numeric($class) && is_string($blackListInfo)) { |
|
59 | + $class = $blackListInfo; |
|
60 | + $blackListInfo = null; |
|
61 | + } |
|
62 | + |
|
63 | + $class = strtolower($class); |
|
64 | + $this->blackListedClassNames[$class] = $class; |
|
65 | + } |
|
66 | + |
|
67 | + $this->blackListedConstants = []; |
|
68 | + foreach ($list->getConstants() as $constantName => $blackListInfo) { |
|
69 | + $constantName = strtolower($constantName); |
|
70 | + $this->blackListedConstants[$constantName] = $constantName; |
|
71 | + } |
|
72 | + |
|
73 | + $this->blackListedFunctions = []; |
|
74 | + foreach ($list->getFunctions() as $functionName => $blackListInfo) { |
|
75 | + $functionName = strtolower($functionName); |
|
76 | + $this->blackListedFunctions[$functionName] = $functionName; |
|
77 | + } |
|
78 | + |
|
79 | + $this->blackListedMethods = []; |
|
80 | + foreach ($list->getMethods() as $functionName => $blackListInfo) { |
|
81 | + $functionName = strtolower($functionName); |
|
82 | + $this->blackListedMethods[$functionName] = $functionName; |
|
83 | + } |
|
84 | + |
|
85 | + $this->checkEqualOperatorUsage = $list->checkStrongComparisons(); |
|
86 | + |
|
87 | + $this->errorMessages = [ |
|
88 | + CodeChecker::CLASS_EXTENDS_NOT_ALLOWED => "%s class must not be extended", |
|
89 | + CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED => "%s interface must not be implemented", |
|
90 | + CodeChecker::STATIC_CALL_NOT_ALLOWED => "Static method of %s class must not be called", |
|
91 | + CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED => "Constant of %s class must not not be fetched", |
|
92 | + CodeChecker::CLASS_NEW_NOT_ALLOWED => "%s class must not be instantiated", |
|
93 | + CodeChecker::CLASS_USE_NOT_ALLOWED => "%s class must not be imported with a use statement", |
|
94 | + CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED => "Method of %s class must not be called", |
|
95 | + |
|
96 | + CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED => "is discouraged", |
|
97 | + ]; |
|
98 | + } |
|
99 | + |
|
100 | + /** @var array */ |
|
101 | + public $errors = []; |
|
102 | + |
|
103 | + public function enterNode(Node $node) { |
|
104 | + if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) { |
|
105 | + $this->errors[]= [ |
|
106 | + 'disallowedToken' => '==', |
|
107 | + 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
|
108 | + 'line' => $node->getLine(), |
|
109 | + 'reason' => $this->buildReason('==', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED) |
|
110 | + ]; |
|
111 | + } |
|
112 | + if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) { |
|
113 | + $this->errors[]= [ |
|
114 | + 'disallowedToken' => '!=', |
|
115 | + 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
|
116 | + 'line' => $node->getLine(), |
|
117 | + 'reason' => $this->buildReason('!=', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED) |
|
118 | + ]; |
|
119 | + } |
|
120 | + if ($node instanceof Node\Stmt\Class_) { |
|
121 | + if (!is_null($node->extends)) { |
|
122 | + $this->checkBlackList($node->extends->toString(), CodeChecker::CLASS_EXTENDS_NOT_ALLOWED, $node); |
|
123 | + } |
|
124 | + foreach ($node->implements as $implements) { |
|
125 | + $this->checkBlackList($implements->toString(), CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED, $node); |
|
126 | + } |
|
127 | + } |
|
128 | + if ($node instanceof Node\Expr\StaticCall) { |
|
129 | + if (!is_null($node->class)) { |
|
130 | + if ($node->class instanceof Name) { |
|
131 | + $this->checkBlackList($node->class->toString(), CodeChecker::STATIC_CALL_NOT_ALLOWED, $node); |
|
132 | + |
|
133 | + $this->checkBlackListFunction($node->class->toString(), $node->name, $node); |
|
134 | + $this->checkBlackListMethod($node->class->toString(), $node->name, $node); |
|
135 | + } |
|
136 | + |
|
137 | + if ($node->class instanceof Node\Expr\Variable) { |
|
138 | + /** |
|
139 | + * TODO: find a way to detect something like this: |
|
140 | + * $c = "OC_API"; |
|
141 | + * $n = $c::call(); |
|
142 | + */ |
|
143 | + // $this->checkBlackListMethod($node->class->..., $node->name, $node); |
|
144 | + } |
|
145 | + } |
|
146 | + } |
|
147 | + if ($node instanceof Node\Expr\MethodCall) { |
|
148 | + if (!is_null($node->var)) { |
|
149 | + if ($node->var instanceof Node\Expr\Variable) { |
|
150 | + /** |
|
151 | + * TODO: find a way to detect something like this: |
|
152 | + * $c = new OC_API(); |
|
153 | + * $n = $c::call(); |
|
154 | + * $n = $c->call(); |
|
155 | + */ |
|
156 | + // $this->checkBlackListMethod($node->var->..., $node->name, $node); |
|
157 | + } |
|
158 | + } |
|
159 | + } |
|
160 | + if ($node instanceof Node\Expr\ClassConstFetch) { |
|
161 | + if (!is_null($node->class)) { |
|
162 | + if ($node->class instanceof Name) { |
|
163 | + $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, $node); |
|
164 | + } |
|
165 | + if ($node->class instanceof Node\Expr\Variable) { |
|
166 | + /** |
|
167 | + * TODO: find a way to detect something like this: |
|
168 | + * $c = "OC_API"; |
|
169 | + * $n = $i::ADMIN_AUTH; |
|
170 | + */ |
|
171 | + } else { |
|
172 | + $this->checkBlackListConstant($node->class->toString(), $node->name, $node); |
|
173 | + } |
|
174 | + } |
|
175 | + } |
|
176 | + if ($node instanceof Node\Expr\New_) { |
|
177 | + if (!is_null($node->class)) { |
|
178 | + if ($node->class instanceof Name) { |
|
179 | + $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_NEW_NOT_ALLOWED, $node); |
|
180 | + } |
|
181 | + if ($node->class instanceof Node\Expr\Variable) { |
|
182 | + /** |
|
183 | + * TODO: find a way to detect something like this: |
|
184 | + * $c = "OC_API"; |
|
185 | + * $n = new $i; |
|
186 | + */ |
|
187 | + } |
|
188 | + } |
|
189 | + } |
|
190 | + if ($node instanceof Node\Stmt\UseUse) { |
|
191 | + $this->checkBlackList($node->name->toString(), CodeChecker::CLASS_USE_NOT_ALLOWED, $node); |
|
192 | + if ($node->alias) { |
|
193 | + $this->addUseNameToBlackList($node->name->toString(), $node->alias); |
|
194 | + } else { |
|
195 | + $this->addUseNameToBlackList($node->name->toString(), $node->name->getLast()); |
|
196 | + } |
|
197 | + } |
|
198 | + } |
|
199 | + |
|
200 | + /** |
|
201 | + * Check whether an alias was introduced for a namespace of a blacklisted class |
|
202 | + * |
|
203 | + * Example: |
|
204 | + * - Blacklist entry: OCP\AppFramework\IApi |
|
205 | + * - Name: OCP\AppFramework |
|
206 | + * - Alias: OAF |
|
207 | + * => new blacklist entry: OAF\IApi |
|
208 | + * |
|
209 | + * @param string $name |
|
210 | + * @param string $alias |
|
211 | + */ |
|
212 | + private function addUseNameToBlackList($name, $alias) { |
|
213 | + $name = strtolower($name); |
|
214 | + $alias = strtolower($alias); |
|
215 | + |
|
216 | + foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) { |
|
217 | + if (strpos($blackListedClassName, $name . '\\') === 0) { |
|
218 | + $aliasedClassName = str_replace($name, $alias, $blackListedClassName); |
|
219 | + $this->blackListedClassNames[$aliasedClassName] = $blackListedClassName; |
|
220 | + } |
|
221 | + } |
|
222 | + |
|
223 | + foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) { |
|
224 | + if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) { |
|
225 | + $aliasedConstantName = str_replace($name, $alias, $blackListedConstant); |
|
226 | + $this->blackListedConstants[$aliasedConstantName] = $blackListedConstant; |
|
227 | + } |
|
228 | + } |
|
229 | + |
|
230 | + foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) { |
|
231 | + if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) { |
|
232 | + $aliasedFunctionName = str_replace($name, $alias, $blackListedFunction); |
|
233 | + $this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction; |
|
234 | + } |
|
235 | + } |
|
236 | + |
|
237 | + foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) { |
|
238 | + if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) { |
|
239 | + $aliasedMethodName = str_replace($name, $alias, $blackListedMethod); |
|
240 | + $this->blackListedMethods[$aliasedMethodName] = $blackListedMethod; |
|
241 | + } |
|
242 | + } |
|
243 | + } |
|
244 | + |
|
245 | + private function checkBlackList($name, $errorCode, Node $node) { |
|
246 | + $lowerName = strtolower($name); |
|
247 | + |
|
248 | + if (isset($this->blackListedClassNames[$lowerName])) { |
|
249 | + $this->errors[]= [ |
|
250 | + 'disallowedToken' => $name, |
|
251 | + 'errorCode' => $errorCode, |
|
252 | + 'line' => $node->getLine(), |
|
253 | + 'reason' => $this->buildReason($this->blackListedClassNames[$lowerName], $errorCode) |
|
254 | + ]; |
|
255 | + } |
|
256 | + } |
|
257 | + |
|
258 | + private function checkBlackListConstant($class, $constantName, Node $node) { |
|
259 | + $name = $class . '::' . $constantName; |
|
260 | + $lowerName = strtolower($name); |
|
261 | + |
|
262 | + if (isset($this->blackListedConstants[$lowerName])) { |
|
263 | + $this->errors[]= [ |
|
264 | + 'disallowedToken' => $name, |
|
265 | + 'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, |
|
266 | + 'line' => $node->getLine(), |
|
267 | + 'reason' => $this->buildReason($this->blackListedConstants[$lowerName], CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED) |
|
268 | + ]; |
|
269 | + } |
|
270 | + } |
|
271 | + |
|
272 | + private function checkBlackListFunction($class, $functionName, Node $node) { |
|
273 | + $name = $class . '::' . $functionName; |
|
274 | + $lowerName = strtolower($name); |
|
275 | + |
|
276 | + if (isset($this->blackListedFunctions[$lowerName])) { |
|
277 | + $this->errors[]= [ |
|
278 | + 'disallowedToken' => $name, |
|
279 | + 'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED, |
|
280 | + 'line' => $node->getLine(), |
|
281 | + 'reason' => $this->buildReason($this->blackListedFunctions[$lowerName], CodeChecker::STATIC_CALL_NOT_ALLOWED) |
|
282 | + ]; |
|
283 | + } |
|
284 | + } |
|
285 | + |
|
286 | + private function checkBlackListMethod($class, $functionName, Node $node) { |
|
287 | + $name = $class . '::' . $functionName; |
|
288 | + $lowerName = strtolower($name); |
|
289 | + |
|
290 | + if (isset($this->blackListedMethods[$lowerName])) { |
|
291 | + $this->errors[]= [ |
|
292 | + 'disallowedToken' => $name, |
|
293 | + 'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED, |
|
294 | + 'line' => $node->getLine(), |
|
295 | + 'reason' => $this->buildReason($this->blackListedMethods[$lowerName], CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED) |
|
296 | + ]; |
|
297 | + } |
|
298 | + } |
|
299 | + |
|
300 | + private function buildReason($name, $errorCode) { |
|
301 | + if (isset($this->errorMessages[$errorCode])) { |
|
302 | + $desc = $this->list->getDescription($errorCode, $name); |
|
303 | + return sprintf($this->errorMessages[$errorCode], $desc); |
|
304 | + } |
|
305 | + |
|
306 | + return "$name usage not allowed - error: $errorCode"; |
|
307 | + } |
|
308 | 308 | } |
@@ -102,7 +102,7 @@ discard block |
||
102 | 102 | |
103 | 103 | public function enterNode(Node $node) { |
104 | 104 | if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) { |
105 | - $this->errors[]= [ |
|
105 | + $this->errors[] = [ |
|
106 | 106 | 'disallowedToken' => '==', |
107 | 107 | 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
108 | 108 | 'line' => $node->getLine(), |
@@ -110,7 +110,7 @@ discard block |
||
110 | 110 | ]; |
111 | 111 | } |
112 | 112 | if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) { |
113 | - $this->errors[]= [ |
|
113 | + $this->errors[] = [ |
|
114 | 114 | 'disallowedToken' => '!=', |
115 | 115 | 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
116 | 116 | 'line' => $node->getLine(), |
@@ -214,28 +214,28 @@ discard block |
||
214 | 214 | $alias = strtolower($alias); |
215 | 215 | |
216 | 216 | foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) { |
217 | - if (strpos($blackListedClassName, $name . '\\') === 0) { |
|
217 | + if (strpos($blackListedClassName, $name.'\\') === 0) { |
|
218 | 218 | $aliasedClassName = str_replace($name, $alias, $blackListedClassName); |
219 | 219 | $this->blackListedClassNames[$aliasedClassName] = $blackListedClassName; |
220 | 220 | } |
221 | 221 | } |
222 | 222 | |
223 | 223 | foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) { |
224 | - if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) { |
|
224 | + if (strpos($blackListedConstant, $name.'\\') === 0 || strpos($blackListedConstant, $name.'::') === 0) { |
|
225 | 225 | $aliasedConstantName = str_replace($name, $alias, $blackListedConstant); |
226 | 226 | $this->blackListedConstants[$aliasedConstantName] = $blackListedConstant; |
227 | 227 | } |
228 | 228 | } |
229 | 229 | |
230 | 230 | foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) { |
231 | - if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) { |
|
231 | + if (strpos($blackListedFunction, $name.'\\') === 0 || strpos($blackListedFunction, $name.'::') === 0) { |
|
232 | 232 | $aliasedFunctionName = str_replace($name, $alias, $blackListedFunction); |
233 | 233 | $this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction; |
234 | 234 | } |
235 | 235 | } |
236 | 236 | |
237 | 237 | foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) { |
238 | - if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) { |
|
238 | + if (strpos($blackListedMethod, $name.'\\') === 0 || strpos($blackListedMethod, $name.'::') === 0) { |
|
239 | 239 | $aliasedMethodName = str_replace($name, $alias, $blackListedMethod); |
240 | 240 | $this->blackListedMethods[$aliasedMethodName] = $blackListedMethod; |
241 | 241 | } |
@@ -246,7 +246,7 @@ discard block |
||
246 | 246 | $lowerName = strtolower($name); |
247 | 247 | |
248 | 248 | if (isset($this->blackListedClassNames[$lowerName])) { |
249 | - $this->errors[]= [ |
|
249 | + $this->errors[] = [ |
|
250 | 250 | 'disallowedToken' => $name, |
251 | 251 | 'errorCode' => $errorCode, |
252 | 252 | 'line' => $node->getLine(), |
@@ -256,11 +256,11 @@ discard block |
||
256 | 256 | } |
257 | 257 | |
258 | 258 | private function checkBlackListConstant($class, $constantName, Node $node) { |
259 | - $name = $class . '::' . $constantName; |
|
259 | + $name = $class.'::'.$constantName; |
|
260 | 260 | $lowerName = strtolower($name); |
261 | 261 | |
262 | 262 | if (isset($this->blackListedConstants[$lowerName])) { |
263 | - $this->errors[]= [ |
|
263 | + $this->errors[] = [ |
|
264 | 264 | 'disallowedToken' => $name, |
265 | 265 | 'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, |
266 | 266 | 'line' => $node->getLine(), |
@@ -270,11 +270,11 @@ discard block |
||
270 | 270 | } |
271 | 271 | |
272 | 272 | private function checkBlackListFunction($class, $functionName, Node $node) { |
273 | - $name = $class . '::' . $functionName; |
|
273 | + $name = $class.'::'.$functionName; |
|
274 | 274 | $lowerName = strtolower($name); |
275 | 275 | |
276 | 276 | if (isset($this->blackListedFunctions[$lowerName])) { |
277 | - $this->errors[]= [ |
|
277 | + $this->errors[] = [ |
|
278 | 278 | 'disallowedToken' => $name, |
279 | 279 | 'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED, |
280 | 280 | 'line' => $node->getLine(), |
@@ -284,11 +284,11 @@ discard block |
||
284 | 284 | } |
285 | 285 | |
286 | 286 | private function checkBlackListMethod($class, $functionName, Node $node) { |
287 | - $name = $class . '::' . $functionName; |
|
287 | + $name = $class.'::'.$functionName; |
|
288 | 288 | $lowerName = strtolower($name); |
289 | 289 | |
290 | 290 | if (isset($this->blackListedMethods[$lowerName])) { |
291 | - $this->errors[]= [ |
|
291 | + $this->errors[] = [ |
|
292 | 292 | 'disallowedToken' => $name, |
293 | 293 | 'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED, |
294 | 294 | 'line' => $node->getLine(), |
@@ -110,7 +110,7 @@ |
||
110 | 110 | |
111 | 111 | /** |
112 | 112 | * Gets the correct header |
113 | - * @param Http::CONSTANT $status the constant from the Http class |
|
113 | + * @param integer $status the constant from the Http class |
|
114 | 114 | * @param \DateTime $lastModified formatted last modified date |
115 | 115 | * @param string $ETag the etag |
116 | 116 | * @return string |
@@ -33,121 +33,121 @@ |
||
33 | 33 | |
34 | 34 | class Http extends BaseHttp { |
35 | 35 | |
36 | - private $server; |
|
37 | - private $protocolVersion; |
|
38 | - protected $headers; |
|
39 | - |
|
40 | - /** |
|
41 | - * @param array $server $_SERVER |
|
42 | - * @param string $protocolVersion the http version to use defaults to HTTP/1.1 |
|
43 | - */ |
|
44 | - public function __construct($server, $protocolVersion='HTTP/1.1') { |
|
45 | - $this->server = $server; |
|
46 | - $this->protocolVersion = $protocolVersion; |
|
47 | - |
|
48 | - $this->headers = array( |
|
49 | - self::STATUS_CONTINUE => 'Continue', |
|
50 | - self::STATUS_SWITCHING_PROTOCOLS => 'Switching Protocols', |
|
51 | - self::STATUS_PROCESSING => 'Processing', |
|
52 | - self::STATUS_OK => 'OK', |
|
53 | - self::STATUS_CREATED => 'Created', |
|
54 | - self::STATUS_ACCEPTED => 'Accepted', |
|
55 | - self::STATUS_NON_AUTHORATIVE_INFORMATION => 'Non-Authorative Information', |
|
56 | - self::STATUS_NO_CONTENT => 'No Content', |
|
57 | - self::STATUS_RESET_CONTENT => 'Reset Content', |
|
58 | - self::STATUS_PARTIAL_CONTENT => 'Partial Content', |
|
59 | - self::STATUS_MULTI_STATUS => 'Multi-Status', // RFC 4918 |
|
60 | - self::STATUS_ALREADY_REPORTED => 'Already Reported', // RFC 5842 |
|
61 | - self::STATUS_IM_USED => 'IM Used', // RFC 3229 |
|
62 | - self::STATUS_MULTIPLE_CHOICES => 'Multiple Choices', |
|
63 | - self::STATUS_MOVED_PERMANENTLY => 'Moved Permanently', |
|
64 | - self::STATUS_FOUND => 'Found', |
|
65 | - self::STATUS_SEE_OTHER => 'See Other', |
|
66 | - self::STATUS_NOT_MODIFIED => 'Not Modified', |
|
67 | - self::STATUS_USE_PROXY => 'Use Proxy', |
|
68 | - self::STATUS_RESERVED => 'Reserved', |
|
69 | - self::STATUS_TEMPORARY_REDIRECT => 'Temporary Redirect', |
|
70 | - self::STATUS_BAD_REQUEST => 'Bad request', |
|
71 | - self::STATUS_UNAUTHORIZED => 'Unauthorized', |
|
72 | - self::STATUS_PAYMENT_REQUIRED => 'Payment Required', |
|
73 | - self::STATUS_FORBIDDEN => 'Forbidden', |
|
74 | - self::STATUS_NOT_FOUND => 'Not Found', |
|
75 | - self::STATUS_METHOD_NOT_ALLOWED => 'Method Not Allowed', |
|
76 | - self::STATUS_NOT_ACCEPTABLE => 'Not Acceptable', |
|
77 | - self::STATUS_PROXY_AUTHENTICATION_REQUIRED => 'Proxy Authentication Required', |
|
78 | - self::STATUS_REQUEST_TIMEOUT => 'Request Timeout', |
|
79 | - self::STATUS_CONFLICT => 'Conflict', |
|
80 | - self::STATUS_GONE => 'Gone', |
|
81 | - self::STATUS_LENGTH_REQUIRED => 'Length Required', |
|
82 | - self::STATUS_PRECONDITION_FAILED => 'Precondition failed', |
|
83 | - self::STATUS_REQUEST_ENTITY_TOO_LARGE => 'Request Entity Too Large', |
|
84 | - self::STATUS_REQUEST_URI_TOO_LONG => 'Request-URI Too Long', |
|
85 | - self::STATUS_UNSUPPORTED_MEDIA_TYPE => 'Unsupported Media Type', |
|
86 | - self::STATUS_REQUEST_RANGE_NOT_SATISFIABLE => 'Requested Range Not Satisfiable', |
|
87 | - self::STATUS_EXPECTATION_FAILED => 'Expectation Failed', |
|
88 | - self::STATUS_IM_A_TEAPOT => 'I\'m a teapot', // RFC 2324 |
|
89 | - self::STATUS_UNPROCESSABLE_ENTITY => 'Unprocessable Entity', // RFC 4918 |
|
90 | - self::STATUS_LOCKED => 'Locked', // RFC 4918 |
|
91 | - self::STATUS_FAILED_DEPENDENCY => 'Failed Dependency', // RFC 4918 |
|
92 | - self::STATUS_UPGRADE_REQUIRED => 'Upgrade required', |
|
93 | - self::STATUS_PRECONDITION_REQUIRED => 'Precondition required', // draft-nottingham-http-new-status |
|
94 | - self::STATUS_TOO_MANY_REQUESTS => 'Too Many Requests', // draft-nottingham-http-new-status |
|
95 | - self::STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE => 'Request Header Fields Too Large', // draft-nottingham-http-new-status |
|
96 | - self::STATUS_INTERNAL_SERVER_ERROR => 'Internal Server Error', |
|
97 | - self::STATUS_NOT_IMPLEMENTED => 'Not Implemented', |
|
98 | - self::STATUS_BAD_GATEWAY => 'Bad Gateway', |
|
99 | - self::STATUS_SERVICE_UNAVAILABLE => 'Service Unavailable', |
|
100 | - self::STATUS_GATEWAY_TIMEOUT => 'Gateway Timeout', |
|
101 | - self::STATUS_HTTP_VERSION_NOT_SUPPORTED => 'HTTP Version not supported', |
|
102 | - self::STATUS_VARIANT_ALSO_NEGOTIATES => 'Variant Also Negotiates', |
|
103 | - self::STATUS_INSUFFICIENT_STORAGE => 'Insufficient Storage', // RFC 4918 |
|
104 | - self::STATUS_LOOP_DETECTED => 'Loop Detected', // RFC 5842 |
|
105 | - self::STATUS_BANDWIDTH_LIMIT_EXCEEDED => 'Bandwidth Limit Exceeded', // non-standard |
|
106 | - self::STATUS_NOT_EXTENDED => 'Not extended', |
|
107 | - self::STATUS_NETWORK_AUTHENTICATION_REQUIRED => 'Network Authentication Required', // draft-nottingham-http-new-status |
|
108 | - ); |
|
109 | - } |
|
110 | - |
|
111 | - |
|
112 | - /** |
|
113 | - * Gets the correct header |
|
114 | - * @param Http::CONSTANT $status the constant from the Http class |
|
115 | - * @param \DateTime $lastModified formatted last modified date |
|
116 | - * @param string $ETag the etag |
|
117 | - * @return string |
|
118 | - */ |
|
119 | - public function getStatusHeader($status, \DateTime $lastModified=null, |
|
120 | - $ETag=null) { |
|
121 | - |
|
122 | - if(!is_null($lastModified)) { |
|
123 | - $lastModified = $lastModified->format(\DateTime::RFC2822); |
|
124 | - } |
|
125 | - |
|
126 | - // if etag or lastmodified have not changed, return a not modified |
|
127 | - if ((isset($this->server['HTTP_IF_NONE_MATCH']) |
|
128 | - && trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string)$ETag) |
|
129 | - |
|
130 | - || |
|
131 | - |
|
132 | - (isset($this->server['HTTP_IF_MODIFIED_SINCE']) |
|
133 | - && trim($this->server['HTTP_IF_MODIFIED_SINCE']) === |
|
134 | - $lastModified)) { |
|
135 | - |
|
136 | - $status = self::STATUS_NOT_MODIFIED; |
|
137 | - } |
|
138 | - |
|
139 | - // we have one change currently for the http 1.0 header that differs |
|
140 | - // from 1.1: STATUS_TEMPORARY_REDIRECT should be STATUS_FOUND |
|
141 | - // if this differs any more, we want to create childclasses for this |
|
142 | - if($status === self::STATUS_TEMPORARY_REDIRECT |
|
143 | - && $this->protocolVersion === 'HTTP/1.0') { |
|
144 | - |
|
145 | - $status = self::STATUS_FOUND; |
|
146 | - } |
|
147 | - |
|
148 | - return $this->protocolVersion . ' ' . $status . ' ' . |
|
149 | - $this->headers[$status]; |
|
150 | - } |
|
36 | + private $server; |
|
37 | + private $protocolVersion; |
|
38 | + protected $headers; |
|
39 | + |
|
40 | + /** |
|
41 | + * @param array $server $_SERVER |
|
42 | + * @param string $protocolVersion the http version to use defaults to HTTP/1.1 |
|
43 | + */ |
|
44 | + public function __construct($server, $protocolVersion='HTTP/1.1') { |
|
45 | + $this->server = $server; |
|
46 | + $this->protocolVersion = $protocolVersion; |
|
47 | + |
|
48 | + $this->headers = array( |
|
49 | + self::STATUS_CONTINUE => 'Continue', |
|
50 | + self::STATUS_SWITCHING_PROTOCOLS => 'Switching Protocols', |
|
51 | + self::STATUS_PROCESSING => 'Processing', |
|
52 | + self::STATUS_OK => 'OK', |
|
53 | + self::STATUS_CREATED => 'Created', |
|
54 | + self::STATUS_ACCEPTED => 'Accepted', |
|
55 | + self::STATUS_NON_AUTHORATIVE_INFORMATION => 'Non-Authorative Information', |
|
56 | + self::STATUS_NO_CONTENT => 'No Content', |
|
57 | + self::STATUS_RESET_CONTENT => 'Reset Content', |
|
58 | + self::STATUS_PARTIAL_CONTENT => 'Partial Content', |
|
59 | + self::STATUS_MULTI_STATUS => 'Multi-Status', // RFC 4918 |
|
60 | + self::STATUS_ALREADY_REPORTED => 'Already Reported', // RFC 5842 |
|
61 | + self::STATUS_IM_USED => 'IM Used', // RFC 3229 |
|
62 | + self::STATUS_MULTIPLE_CHOICES => 'Multiple Choices', |
|
63 | + self::STATUS_MOVED_PERMANENTLY => 'Moved Permanently', |
|
64 | + self::STATUS_FOUND => 'Found', |
|
65 | + self::STATUS_SEE_OTHER => 'See Other', |
|
66 | + self::STATUS_NOT_MODIFIED => 'Not Modified', |
|
67 | + self::STATUS_USE_PROXY => 'Use Proxy', |
|
68 | + self::STATUS_RESERVED => 'Reserved', |
|
69 | + self::STATUS_TEMPORARY_REDIRECT => 'Temporary Redirect', |
|
70 | + self::STATUS_BAD_REQUEST => 'Bad request', |
|
71 | + self::STATUS_UNAUTHORIZED => 'Unauthorized', |
|
72 | + self::STATUS_PAYMENT_REQUIRED => 'Payment Required', |
|
73 | + self::STATUS_FORBIDDEN => 'Forbidden', |
|
74 | + self::STATUS_NOT_FOUND => 'Not Found', |
|
75 | + self::STATUS_METHOD_NOT_ALLOWED => 'Method Not Allowed', |
|
76 | + self::STATUS_NOT_ACCEPTABLE => 'Not Acceptable', |
|
77 | + self::STATUS_PROXY_AUTHENTICATION_REQUIRED => 'Proxy Authentication Required', |
|
78 | + self::STATUS_REQUEST_TIMEOUT => 'Request Timeout', |
|
79 | + self::STATUS_CONFLICT => 'Conflict', |
|
80 | + self::STATUS_GONE => 'Gone', |
|
81 | + self::STATUS_LENGTH_REQUIRED => 'Length Required', |
|
82 | + self::STATUS_PRECONDITION_FAILED => 'Precondition failed', |
|
83 | + self::STATUS_REQUEST_ENTITY_TOO_LARGE => 'Request Entity Too Large', |
|
84 | + self::STATUS_REQUEST_URI_TOO_LONG => 'Request-URI Too Long', |
|
85 | + self::STATUS_UNSUPPORTED_MEDIA_TYPE => 'Unsupported Media Type', |
|
86 | + self::STATUS_REQUEST_RANGE_NOT_SATISFIABLE => 'Requested Range Not Satisfiable', |
|
87 | + self::STATUS_EXPECTATION_FAILED => 'Expectation Failed', |
|
88 | + self::STATUS_IM_A_TEAPOT => 'I\'m a teapot', // RFC 2324 |
|
89 | + self::STATUS_UNPROCESSABLE_ENTITY => 'Unprocessable Entity', // RFC 4918 |
|
90 | + self::STATUS_LOCKED => 'Locked', // RFC 4918 |
|
91 | + self::STATUS_FAILED_DEPENDENCY => 'Failed Dependency', // RFC 4918 |
|
92 | + self::STATUS_UPGRADE_REQUIRED => 'Upgrade required', |
|
93 | + self::STATUS_PRECONDITION_REQUIRED => 'Precondition required', // draft-nottingham-http-new-status |
|
94 | + self::STATUS_TOO_MANY_REQUESTS => 'Too Many Requests', // draft-nottingham-http-new-status |
|
95 | + self::STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE => 'Request Header Fields Too Large', // draft-nottingham-http-new-status |
|
96 | + self::STATUS_INTERNAL_SERVER_ERROR => 'Internal Server Error', |
|
97 | + self::STATUS_NOT_IMPLEMENTED => 'Not Implemented', |
|
98 | + self::STATUS_BAD_GATEWAY => 'Bad Gateway', |
|
99 | + self::STATUS_SERVICE_UNAVAILABLE => 'Service Unavailable', |
|
100 | + self::STATUS_GATEWAY_TIMEOUT => 'Gateway Timeout', |
|
101 | + self::STATUS_HTTP_VERSION_NOT_SUPPORTED => 'HTTP Version not supported', |
|
102 | + self::STATUS_VARIANT_ALSO_NEGOTIATES => 'Variant Also Negotiates', |
|
103 | + self::STATUS_INSUFFICIENT_STORAGE => 'Insufficient Storage', // RFC 4918 |
|
104 | + self::STATUS_LOOP_DETECTED => 'Loop Detected', // RFC 5842 |
|
105 | + self::STATUS_BANDWIDTH_LIMIT_EXCEEDED => 'Bandwidth Limit Exceeded', // non-standard |
|
106 | + self::STATUS_NOT_EXTENDED => 'Not extended', |
|
107 | + self::STATUS_NETWORK_AUTHENTICATION_REQUIRED => 'Network Authentication Required', // draft-nottingham-http-new-status |
|
108 | + ); |
|
109 | + } |
|
110 | + |
|
111 | + |
|
112 | + /** |
|
113 | + * Gets the correct header |
|
114 | + * @param Http::CONSTANT $status the constant from the Http class |
|
115 | + * @param \DateTime $lastModified formatted last modified date |
|
116 | + * @param string $ETag the etag |
|
117 | + * @return string |
|
118 | + */ |
|
119 | + public function getStatusHeader($status, \DateTime $lastModified=null, |
|
120 | + $ETag=null) { |
|
121 | + |
|
122 | + if(!is_null($lastModified)) { |
|
123 | + $lastModified = $lastModified->format(\DateTime::RFC2822); |
|
124 | + } |
|
125 | + |
|
126 | + // if etag or lastmodified have not changed, return a not modified |
|
127 | + if ((isset($this->server['HTTP_IF_NONE_MATCH']) |
|
128 | + && trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string)$ETag) |
|
129 | + |
|
130 | + || |
|
131 | + |
|
132 | + (isset($this->server['HTTP_IF_MODIFIED_SINCE']) |
|
133 | + && trim($this->server['HTTP_IF_MODIFIED_SINCE']) === |
|
134 | + $lastModified)) { |
|
135 | + |
|
136 | + $status = self::STATUS_NOT_MODIFIED; |
|
137 | + } |
|
138 | + |
|
139 | + // we have one change currently for the http 1.0 header that differs |
|
140 | + // from 1.1: STATUS_TEMPORARY_REDIRECT should be STATUS_FOUND |
|
141 | + // if this differs any more, we want to create childclasses for this |
|
142 | + if($status === self::STATUS_TEMPORARY_REDIRECT |
|
143 | + && $this->protocolVersion === 'HTTP/1.0') { |
|
144 | + |
|
145 | + $status = self::STATUS_FOUND; |
|
146 | + } |
|
147 | + |
|
148 | + return $this->protocolVersion . ' ' . $status . ' ' . |
|
149 | + $this->headers[$status]; |
|
150 | + } |
|
151 | 151 | |
152 | 152 | |
153 | 153 | } |
@@ -41,7 +41,7 @@ discard block |
||
41 | 41 | * @param array $server $_SERVER |
42 | 42 | * @param string $protocolVersion the http version to use defaults to HTTP/1.1 |
43 | 43 | */ |
44 | - public function __construct($server, $protocolVersion='HTTP/1.1') { |
|
44 | + public function __construct($server, $protocolVersion = 'HTTP/1.1') { |
|
45 | 45 | $this->server = $server; |
46 | 46 | $this->protocolVersion = $protocolVersion; |
47 | 47 | |
@@ -116,16 +116,16 @@ discard block |
||
116 | 116 | * @param string $ETag the etag |
117 | 117 | * @return string |
118 | 118 | */ |
119 | - public function getStatusHeader($status, \DateTime $lastModified=null, |
|
120 | - $ETag=null) { |
|
119 | + public function getStatusHeader($status, \DateTime $lastModified = null, |
|
120 | + $ETag = null) { |
|
121 | 121 | |
122 | - if(!is_null($lastModified)) { |
|
122 | + if (!is_null($lastModified)) { |
|
123 | 123 | $lastModified = $lastModified->format(\DateTime::RFC2822); |
124 | 124 | } |
125 | 125 | |
126 | 126 | // if etag or lastmodified have not changed, return a not modified |
127 | 127 | if ((isset($this->server['HTTP_IF_NONE_MATCH']) |
128 | - && trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string)$ETag) |
|
128 | + && trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string) $ETag) |
|
129 | 129 | |
130 | 130 | || |
131 | 131 | |
@@ -139,13 +139,13 @@ discard block |
||
139 | 139 | // we have one change currently for the http 1.0 header that differs |
140 | 140 | // from 1.1: STATUS_TEMPORARY_REDIRECT should be STATUS_FOUND |
141 | 141 | // if this differs any more, we want to create childclasses for this |
142 | - if($status === self::STATUS_TEMPORARY_REDIRECT |
|
142 | + if ($status === self::STATUS_TEMPORARY_REDIRECT |
|
143 | 143 | && $this->protocolVersion === 'HTTP/1.0') { |
144 | 144 | |
145 | 145 | $status = self::STATUS_FOUND; |
146 | 146 | } |
147 | 147 | |
148 | - return $this->protocolVersion . ' ' . $status . ' ' . |
|
148 | + return $this->protocolVersion.' '.$status.' '. |
|
149 | 149 | $this->headers[$status]; |
150 | 150 | } |
151 | 151 |