Completed
Push — stable12 ( bc3034...83fe65 )
by Morris
12:28
created
apps/files_trashbin/lib/Storage.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -110,7 +110,7 @@
 block discarded – undo
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){
Please login to merge, or discard this patch.
Spacing   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -95,7 +95,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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(),
Please login to merge, or discard this patch.
Indentation   +239 added lines, -239 removed lines patch added patch discarded remove patch
@@ -34,244 +34,244 @@
 block discarded – undo
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 ($parts[2] === 'files' && $this->userManager->userExists($parts[1])) {
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 ($parts[2] === 'files' && $this->userManager->userExists($parts[1])) {
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
 }
Please login to merge, or discard this patch.
apps/files_trashbin/lib/Trashbin.php 3 patches
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -671,7 +671,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 	 */
Please login to merge, or discard this patch.
Indentation   +952 added lines, -952 removed lines patch added patch discarded remove patch
@@ -49,956 +49,956 @@
 block discarded – undo
49 49
 
50 50
 class Trashbin {
51 51
 
52
-	// unit: percentage; 50% of available disk space/quota
53
-	const DEFAULTMAXSIZE = 50;
54
-
55
-	/**
56
-	 * Whether versions have already be rescanned during this PHP request
57
-	 *
58
-	 * @var bool
59
-	 */
60
-	private static $scannedVersions = false;
61
-
62
-	/**
63
-	 * Ensure we don't need to scan the file during the move to trash
64
-	 * by triggering the scan in the pre-hook
65
-	 *
66
-	 * @param array $params
67
-	 */
68
-	public static function ensureFileScannedHook($params) {
69
-		try {
70
-			self::getUidAndFilename($params['path']);
71
-		} catch (NotFoundException $e) {
72
-			// nothing to scan for non existing files
73
-		}
74
-	}
75
-
76
-	/**
77
-	 * get the UID of the owner of the file and the path to the file relative to
78
-	 * owners files folder
79
-	 *
80
-	 * @param string $filename
81
-	 * @return array
82
-	 * @throws \OC\User\NoUserException
83
-	 */
84
-	public static function getUidAndFilename($filename) {
85
-		$uid = Filesystem::getOwner($filename);
86
-		$userManager = \OC::$server->getUserManager();
87
-		// if the user with the UID doesn't exists, e.g. because the UID points
88
-		// to a remote user with a federated cloud ID we use the current logged-in
89
-		// user. We need a valid local user to move the file to the right trash bin
90
-		if (!$userManager->userExists($uid)) {
91
-			$uid = User::getUser();
92
-		}
93
-		if (!$uid) {
94
-			// no owner, usually because of share link from ext storage
95
-			return [null, null];
96
-		}
97
-		Filesystem::initMountPoints($uid);
98
-		if ($uid != User::getUser()) {
99
-			$info = Filesystem::getFileInfo($filename);
100
-			$ownerView = new View('/' . $uid . '/files');
101
-			try {
102
-				$filename = $ownerView->getPath($info['fileid']);
103
-			} catch (NotFoundException $e) {
104
-				$filename = null;
105
-			}
106
-		}
107
-		return [$uid, $filename];
108
-	}
109
-
110
-	/**
111
-	 * get original location of files for user
112
-	 *
113
-	 * @param string $user
114
-	 * @return array (filename => array (timestamp => original location))
115
-	 */
116
-	public static function getLocations($user) {
117
-		$query = \OC_DB::prepare('SELECT `id`, `timestamp`, `location`'
118
-			. ' FROM `*PREFIX*files_trash` WHERE `user`=?');
119
-		$result = $query->execute(array($user));
120
-		$array = array();
121
-		while ($row = $result->fetchRow()) {
122
-			if (isset($array[$row['id']])) {
123
-				$array[$row['id']][$row['timestamp']] = $row['location'];
124
-			} else {
125
-				$array[$row['id']] = array($row['timestamp'] => $row['location']);
126
-			}
127
-		}
128
-		return $array;
129
-	}
130
-
131
-	/**
132
-	 * get original location of file
133
-	 *
134
-	 * @param string $user
135
-	 * @param string $filename
136
-	 * @param string $timestamp
137
-	 * @return string original location
138
-	 */
139
-	public static function getLocation($user, $filename, $timestamp) {
140
-		$query = \OC_DB::prepare('SELECT `location` FROM `*PREFIX*files_trash`'
141
-			. ' WHERE `user`=? AND `id`=? AND `timestamp`=?');
142
-		$result = $query->execute(array($user, $filename, $timestamp))->fetchAll();
143
-		if (isset($result[0]['location'])) {
144
-			return $result[0]['location'];
145
-		} else {
146
-			return false;
147
-		}
148
-	}
149
-
150
-	private static function setUpTrash($user) {
151
-		$view = new View('/' . $user);
152
-		if (!$view->is_dir('files_trashbin')) {
153
-			$view->mkdir('files_trashbin');
154
-		}
155
-		if (!$view->is_dir('files_trashbin/files')) {
156
-			$view->mkdir('files_trashbin/files');
157
-		}
158
-		if (!$view->is_dir('files_trashbin/versions')) {
159
-			$view->mkdir('files_trashbin/versions');
160
-		}
161
-		if (!$view->is_dir('files_trashbin/keys')) {
162
-			$view->mkdir('files_trashbin/keys');
163
-		}
164
-	}
165
-
166
-
167
-	/**
168
-	 * copy file to owners trash
169
-	 *
170
-	 * @param string $sourcePath
171
-	 * @param string $owner
172
-	 * @param string $targetPath
173
-	 * @param $user
174
-	 * @param integer $timestamp
175
-	 */
176
-	private static function copyFilesToUser($sourcePath, $owner, $targetPath, $user, $timestamp) {
177
-		self::setUpTrash($owner);
178
-
179
-		$targetFilename = basename($targetPath);
180
-		$targetLocation = dirname($targetPath);
181
-
182
-		$sourceFilename = basename($sourcePath);
183
-
184
-		$view = new View('/');
185
-
186
-		$target = $user . '/files_trashbin/files/' . $targetFilename . '.d' . $timestamp;
187
-		$source = $owner . '/files_trashbin/files/' . $sourceFilename . '.d' . $timestamp;
188
-		self::copy_recursive($source, $target, $view);
189
-
190
-
191
-		if ($view->file_exists($target)) {
192
-			$query = \OC_DB::prepare("INSERT INTO `*PREFIX*files_trash` (`id`,`timestamp`,`location`,`user`) VALUES (?,?,?,?)");
193
-			$result = $query->execute(array($targetFilename, $timestamp, $targetLocation, $user));
194
-			if (!$result) {
195
-				\OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated for the files owner', \OCP\Util::ERROR);
196
-			}
197
-		}
198
-	}
199
-
200
-
201
-	/**
202
-	 * move file to the trash bin
203
-	 *
204
-	 * @param string $file_path path to the deleted file/directory relative to the files root directory
205
-	 * @param bool $ownerOnly delete for owner only (if file gets moved out of a shared folder)
206
-	 *
207
-	 * @return bool
208
-	 */
209
-	public static function move2trash($file_path, $ownerOnly = false) {
210
-		// get the user for which the filesystem is setup
211
-		$root = Filesystem::getRoot();
212
-		list(, $user) = explode('/', $root);
213
-		list($owner, $ownerPath) = self::getUidAndFilename($file_path);
214
-
215
-		// if no owner found (ex: ext storage + share link), will use the current user's trashbin then
216
-		if (is_null($owner)) {
217
-			$owner = $user;
218
-			$ownerPath = $file_path;
219
-		}
220
-
221
-		$ownerView = new View('/' . $owner);
222
-		// file has been deleted in between
223
-		if (is_null($ownerPath) || $ownerPath === '' || !$ownerView->file_exists('/files/' . $ownerPath)) {
224
-			return true;
225
-		}
226
-
227
-		self::setUpTrash($user);
228
-		if ($owner !== $user) {
229
-			// also setup for owner
230
-			self::setUpTrash($owner);
231
-		}
232
-
233
-		$path_parts = pathinfo($ownerPath);
234
-
235
-		$filename = $path_parts['basename'];
236
-		$location = $path_parts['dirname'];
237
-		$timestamp = time();
238
-
239
-		// disable proxy to prevent recursive calls
240
-		$trashPath = '/files_trashbin/files/' . $filename . '.d' . $timestamp;
241
-
242
-		/** @var \OC\Files\Storage\Storage $trashStorage */
243
-		list($trashStorage, $trashInternalPath) = $ownerView->resolvePath($trashPath);
244
-		/** @var \OC\Files\Storage\Storage $sourceStorage */
245
-		list($sourceStorage, $sourceInternalPath) = $ownerView->resolvePath('/files/' . $ownerPath);
246
-		try {
247
-			$moveSuccessful = true;
248
-			if ($trashStorage->file_exists($trashInternalPath)) {
249
-				$trashStorage->unlink($trashInternalPath);
250
-			}
251
-			$trashStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath);
252
-		} catch (\OCA\Files_Trashbin\Exceptions\CopyRecursiveException $e) {
253
-			$moveSuccessful = false;
254
-			if ($trashStorage->file_exists($trashInternalPath)) {
255
-				$trashStorage->unlink($trashInternalPath);
256
-			}
257
-			\OCP\Util::writeLog('files_trashbin', 'Couldn\'t move ' . $file_path . ' to the trash bin', \OCP\Util::ERROR);
258
-		}
259
-
260
-		if ($sourceStorage->file_exists($sourceInternalPath)) { // failed to delete the original file, abort
261
-			if ($sourceStorage->is_dir($sourceInternalPath)) {
262
-				$sourceStorage->rmdir($sourceInternalPath);
263
-			} else {
264
-				$sourceStorage->unlink($sourceInternalPath);
265
-			}
266
-			return false;
267
-		}
268
-
269
-		$trashStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath);
270
-
271
-		if ($moveSuccessful) {
272
-			$query = \OC_DB::prepare("INSERT INTO `*PREFIX*files_trash` (`id`,`timestamp`,`location`,`user`) VALUES (?,?,?,?)");
273
-			$result = $query->execute(array($filename, $timestamp, $location, $owner));
274
-			if (!$result) {
275
-				\OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated', \OCP\Util::ERROR);
276
-			}
277
-			\OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_moveToTrash', array('filePath' => Filesystem::normalizePath($file_path),
278
-				'trashPath' => Filesystem::normalizePath($filename . '.d' . $timestamp)));
279
-
280
-			self::retainVersions($filename, $owner, $ownerPath, $timestamp);
281
-
282
-			// if owner !== user we need to also add a copy to the users trash
283
-			if ($user !== $owner && $ownerOnly === false) {
284
-				self::copyFilesToUser($ownerPath, $owner, $file_path, $user, $timestamp);
285
-			}
286
-		}
287
-
288
-		self::scheduleExpire($user);
289
-
290
-		// if owner !== user we also need to update the owners trash size
291
-		if ($owner !== $user) {
292
-			self::scheduleExpire($owner);
293
-		}
294
-
295
-		return $moveSuccessful;
296
-	}
297
-
298
-	/**
299
-	 * Move file versions to trash so that they can be restored later
300
-	 *
301
-	 * @param string $filename of deleted file
302
-	 * @param string $owner owner user id
303
-	 * @param string $ownerPath path relative to the owner's home storage
304
-	 * @param integer $timestamp when the file was deleted
305
-	 */
306
-	private static function retainVersions($filename, $owner, $ownerPath, $timestamp) {
307
-		if (\OCP\App::isEnabled('files_versions') && !empty($ownerPath)) {
308
-
309
-			$user = User::getUser();
310
-			$rootView = new View('/');
311
-
312
-			if ($rootView->is_dir($owner . '/files_versions/' . $ownerPath)) {
313
-				if ($owner !== $user) {
314
-					self::copy_recursive($owner . '/files_versions/' . $ownerPath, $owner . '/files_trashbin/versions/' . basename($ownerPath) . '.d' . $timestamp, $rootView);
315
-				}
316
-				self::move($rootView, $owner . '/files_versions/' . $ownerPath, $user . '/files_trashbin/versions/' . $filename . '.d' . $timestamp);
317
-			} else if ($versions = \OCA\Files_Versions\Storage::getVersions($owner, $ownerPath)) {
318
-
319
-				foreach ($versions as $v) {
320
-					if ($owner !== $user) {
321
-						self::copy($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $owner . '/files_trashbin/versions/' . $v['name'] . '.v' . $v['version'] . '.d' . $timestamp);
322
-					}
323
-					self::move($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $user . '/files_trashbin/versions/' . $filename . '.v' . $v['version'] . '.d' . $timestamp);
324
-				}
325
-			}
326
-		}
327
-	}
328
-
329
-	/**
330
-	 * Move a file or folder on storage level
331
-	 *
332
-	 * @param View $view
333
-	 * @param string $source
334
-	 * @param string $target
335
-	 * @return bool
336
-	 */
337
-	private static function move(View $view, $source, $target) {
338
-		/** @var \OC\Files\Storage\Storage $sourceStorage */
339
-		list($sourceStorage, $sourceInternalPath) = $view->resolvePath($source);
340
-		/** @var \OC\Files\Storage\Storage $targetStorage */
341
-		list($targetStorage, $targetInternalPath) = $view->resolvePath($target);
342
-		/** @var \OC\Files\Storage\Storage $ownerTrashStorage */
343
-
344
-		$result = $targetStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
345
-		if ($result) {
346
-			$targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
347
-		}
348
-		return $result;
349
-	}
350
-
351
-	/**
352
-	 * Copy a file or folder on storage level
353
-	 *
354
-	 * @param View $view
355
-	 * @param string $source
356
-	 * @param string $target
357
-	 * @return bool
358
-	 */
359
-	private static function copy(View $view, $source, $target) {
360
-		/** @var \OC\Files\Storage\Storage $sourceStorage */
361
-		list($sourceStorage, $sourceInternalPath) = $view->resolvePath($source);
362
-		/** @var \OC\Files\Storage\Storage $targetStorage */
363
-		list($targetStorage, $targetInternalPath) = $view->resolvePath($target);
364
-		/** @var \OC\Files\Storage\Storage $ownerTrashStorage */
365
-
366
-		$result = $targetStorage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
367
-		if ($result) {
368
-			$targetStorage->getUpdater()->update($targetInternalPath);
369
-		}
370
-		return $result;
371
-	}
372
-
373
-	/**
374
-	 * Restore a file or folder from trash bin
375
-	 *
376
-	 * @param string $file path to the deleted file/folder relative to "files_trashbin/files/",
377
-	 * including the timestamp suffix ".d12345678"
378
-	 * @param string $filename name of the file/folder
379
-	 * @param int $timestamp time when the file/folder was deleted
380
-	 *
381
-	 * @return bool true on success, false otherwise
382
-	 */
383
-	public static function restore($file, $filename, $timestamp) {
384
-		$user = User::getUser();
385
-		$view = new View('/' . $user);
386
-
387
-		$location = '';
388
-		if ($timestamp) {
389
-			$location = self::getLocation($user, $filename, $timestamp);
390
-			if ($location === false) {
391
-				\OCP\Util::writeLog('files_trashbin', 'trash bin database inconsistent! ($user: ' . $user . ' $filename: ' . $filename . ', $timestamp: ' . $timestamp . ')', \OCP\Util::ERROR);
392
-			} else {
393
-				// if location no longer exists, restore file in the root directory
394
-				if ($location !== '/' &&
395
-					(!$view->is_dir('files/' . $location) ||
396
-						!$view->isCreatable('files/' . $location))
397
-				) {
398
-					$location = '';
399
-				}
400
-			}
401
-		}
402
-
403
-		// we need a  extension in case a file/dir with the same name already exists
404
-		$uniqueFilename = self::getUniqueFilename($location, $filename, $view);
405
-
406
-		$source = Filesystem::normalizePath('files_trashbin/files/' . $file);
407
-		$target = Filesystem::normalizePath('files/' . $location . '/' . $uniqueFilename);
408
-		if (!$view->file_exists($source)) {
409
-			return false;
410
-		}
411
-		$mtime = $view->filemtime($source);
412
-
413
-		// restore file
414
-		$restoreResult = $view->rename($source, $target);
415
-
416
-		// handle the restore result
417
-		if ($restoreResult) {
418
-			$fakeRoot = $view->getRoot();
419
-			$view->chroot('/' . $user . '/files');
420
-			$view->touch('/' . $location . '/' . $uniqueFilename, $mtime);
421
-			$view->chroot($fakeRoot);
422
-			\OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', array('filePath' => Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename),
423
-				'trashPath' => Filesystem::normalizePath($file)));
424
-
425
-			self::restoreVersions($view, $file, $filename, $uniqueFilename, $location, $timestamp);
426
-
427
-			if ($timestamp) {
428
-				$query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?');
429
-				$query->execute(array($user, $filename, $timestamp));
430
-			}
431
-
432
-			return true;
433
-		}
434
-
435
-		return false;
436
-	}
437
-
438
-	/**
439
-	 * restore versions from trash bin
440
-	 *
441
-	 * @param View $view file view
442
-	 * @param string $file complete path to file
443
-	 * @param string $filename name of file once it was deleted
444
-	 * @param string $uniqueFilename new file name to restore the file without overwriting existing files
445
-	 * @param string $location location if file
446
-	 * @param int $timestamp deletion time
447
-	 * @return false|null
448
-	 */
449
-	private static function restoreVersions(View $view, $file, $filename, $uniqueFilename, $location, $timestamp) {
450
-
451
-		if (\OCP\App::isEnabled('files_versions')) {
452
-
453
-			$user = User::getUser();
454
-			$rootView = new View('/');
455
-
456
-			$target = Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename);
457
-
458
-			list($owner, $ownerPath) = self::getUidAndFilename($target);
459
-
460
-			// file has been deleted in between
461
-			if (empty($ownerPath)) {
462
-				return false;
463
-			}
464
-
465
-			if ($timestamp) {
466
-				$versionedFile = $filename;
467
-			} else {
468
-				$versionedFile = $file;
469
-			}
470
-
471
-			if ($view->is_dir('/files_trashbin/versions/' . $file)) {
472
-				$rootView->rename(Filesystem::normalizePath($user . '/files_trashbin/versions/' . $file), Filesystem::normalizePath($owner . '/files_versions/' . $ownerPath));
473
-			} else if ($versions = self::getVersionsFromTrash($versionedFile, $timestamp, $user)) {
474
-				foreach ($versions as $v) {
475
-					if ($timestamp) {
476
-						$rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v . '.d' . $timestamp, $owner . '/files_versions/' . $ownerPath . '.v' . $v);
477
-					} else {
478
-						$rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v, $owner . '/files_versions/' . $ownerPath . '.v' . $v);
479
-					}
480
-				}
481
-			}
482
-		}
483
-	}
484
-
485
-	/**
486
-	 * delete all files from the trash
487
-	 */
488
-	public static function deleteAll() {
489
-		$user = User::getUser();
490
-		$userRoot = \OC::$server->getUserFolder($user)->getParent();
491
-		$view = new View('/' . $user);
492
-		$fileInfos = $view->getDirectoryContent('files_trashbin/files');
493
-
494
-		try {
495
-			$trash = $userRoot->get('files_trashbin');
496
-		} catch (NotFoundException $e) {
497
-			return false;
498
-		}
499
-
500
-		// Array to store the relative path in (after the file is deleted, the view won't be able to relativise the path anymore)
501
-		$filePaths = array();
502
-		foreach($fileInfos as $fileInfo){
503
-			$filePaths[] = $view->getRelativePath($fileInfo->getPath());
504
-		}
505
-		unset($fileInfos); // save memory
506
-
507
-		// Bulk PreDelete-Hook
508
-		\OC_Hook::emit('\OCP\Trashbin', 'preDeleteAll', array('paths' => $filePaths));
509
-
510
-		// Single-File Hooks
511
-		foreach($filePaths as $path){
512
-			self::emitTrashbinPreDelete($path);
513
-		}
514
-
515
-		// actual file deletion
516
-		$trash->delete();
517
-		$query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=?');
518
-		$query->execute(array($user));
519
-
520
-		// Bulk PostDelete-Hook
521
-		\OC_Hook::emit('\OCP\Trashbin', 'deleteAll', array('paths' => $filePaths));
522
-
523
-		// Single-File Hooks
524
-		foreach($filePaths as $path){
525
-			self::emitTrashbinPostDelete($path);
526
-		}
527
-
528
-		$trash = $userRoot->newFolder('files_trashbin');
529
-		$trash->newFolder('files');
530
-
531
-		return true;
532
-	}
533
-
534
-	/**
535
-	 * wrapper function to emit the 'preDelete' hook of \OCP\Trashbin before a file is deleted
536
-	 * @param string $path
537
-	 */
538
-	protected static function emitTrashbinPreDelete($path){
539
-		\OC_Hook::emit('\OCP\Trashbin', 'preDelete', array('path' => $path));
540
-	}
541
-
542
-	/**
543
-	 * wrapper function to emit the 'delete' hook of \OCP\Trashbin after a file has been deleted
544
-	 * @param string $path
545
-	 */
546
-	protected static function emitTrashbinPostDelete($path){
547
-		\OC_Hook::emit('\OCP\Trashbin', 'delete', array('path' => $path));
548
-	}
549
-
550
-	/**
551
-	 * delete file from trash bin permanently
552
-	 *
553
-	 * @param string $filename path to the file
554
-	 * @param string $user
555
-	 * @param int $timestamp of deletion time
556
-	 *
557
-	 * @return int size of deleted files
558
-	 */
559
-	public static function delete($filename, $user, $timestamp = null) {
560
-		$userRoot = \OC::$server->getUserFolder($user)->getParent();
561
-		$view = new View('/' . $user);
562
-		$size = 0;
563
-
564
-		if ($timestamp) {
565
-			$query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?');
566
-			$query->execute(array($user, $filename, $timestamp));
567
-			$file = $filename . '.d' . $timestamp;
568
-		} else {
569
-			$file = $filename;
570
-		}
571
-
572
-		$size += self::deleteVersions($view, $file, $filename, $timestamp, $user);
573
-
574
-		try {
575
-			$node = $userRoot->get('/files_trashbin/files/' . $file);
576
-		} catch (NotFoundException $e) {
577
-			return $size;
578
-		}
579
-
580
-		if ($node instanceof Folder) {
581
-			$size += self::calculateSize(new View('/' . $user . '/files_trashbin/files/' . $file));
582
-		} else if ($node instanceof File) {
583
-			$size += $view->filesize('/files_trashbin/files/' . $file);
584
-		}
585
-
586
-		self::emitTrashbinPreDelete('/files_trashbin/files/' . $file);
587
-		$node->delete();
588
-		self::emitTrashbinPostDelete('/files_trashbin/files/' . $file);
589
-
590
-		return $size;
591
-	}
592
-
593
-	/**
594
-	 * @param View $view
595
-	 * @param string $file
596
-	 * @param string $filename
597
-	 * @param integer|null $timestamp
598
-	 * @param string $user
599
-	 * @return int
600
-	 */
601
-	private static function deleteVersions(View $view, $file, $filename, $timestamp, $user) {
602
-		$size = 0;
603
-		if (\OCP\App::isEnabled('files_versions')) {
604
-			if ($view->is_dir('files_trashbin/versions/' . $file)) {
605
-				$size += self::calculateSize(new View('/' . $user . '/files_trashbin/versions/' . $file));
606
-				$view->unlink('files_trashbin/versions/' . $file);
607
-			} else if ($versions = self::getVersionsFromTrash($filename, $timestamp, $user)) {
608
-				foreach ($versions as $v) {
609
-					if ($timestamp) {
610
-						$size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp);
611
-						$view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp);
612
-					} else {
613
-						$size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v);
614
-						$view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v);
615
-					}
616
-				}
617
-			}
618
-		}
619
-		return $size;
620
-	}
621
-
622
-	/**
623
-	 * check to see whether a file exists in trashbin
624
-	 *
625
-	 * @param string $filename path to the file
626
-	 * @param int $timestamp of deletion time
627
-	 * @return bool true if file exists, otherwise false
628
-	 */
629
-	public static function file_exists($filename, $timestamp = null) {
630
-		$user = User::getUser();
631
-		$view = new View('/' . $user);
632
-
633
-		if ($timestamp) {
634
-			$filename = $filename . '.d' . $timestamp;
635
-		} else {
636
-			$filename = $filename;
637
-		}
638
-
639
-		$target = Filesystem::normalizePath('files_trashbin/files/' . $filename);
640
-		return $view->file_exists($target);
641
-	}
642
-
643
-	/**
644
-	 * deletes used space for trash bin in db if user was deleted
645
-	 *
646
-	 * @param string $uid id of deleted user
647
-	 * @return bool result of db delete operation
648
-	 */
649
-	public static function deleteUser($uid) {
650
-		$query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=?');
651
-		return $query->execute(array($uid));
652
-	}
653
-
654
-	/**
655
-	 * calculate remaining free space for trash bin
656
-	 *
657
-	 * @param integer $trashbinSize current size of the trash bin
658
-	 * @param string $user
659
-	 * @return int available free space for trash bin
660
-	 */
661
-	private static function calculateFreeSpace($trashbinSize, $user) {
662
-		$softQuota = true;
663
-		$userObject = \OC::$server->getUserManager()->get($user);
664
-		if(is_null($userObject)) {
665
-			return 0;
666
-		}
667
-		$quota = $userObject->getQuota();
668
-		if ($quota === null || $quota === 'none') {
669
-			$quota = Filesystem::free_space('/');
670
-			$softQuota = false;
671
-			// inf or unknown free space
672
-			if ($quota < 0) {
673
-				$quota = PHP_INT_MAX;
674
-			}
675
-		} else {
676
-			$quota = \OCP\Util::computerFileSize($quota);
677
-		}
678
-
679
-		// calculate available space for trash bin
680
-		// subtract size of files and current trash bin size from quota
681
-		if ($softQuota) {
682
-			$userFolder = \OC::$server->getUserFolder($user);
683
-			if(is_null($userFolder)) {
684
-				return 0;
685
-			}
686
-			$free = $quota - $userFolder->getSize(); // remaining free space for user
687
-			if ($free > 0) {
688
-				$availableSpace = ($free * self::DEFAULTMAXSIZE / 100) - $trashbinSize; // how much space can be used for versions
689
-			} else {
690
-				$availableSpace = $free - $trashbinSize;
691
-			}
692
-		} else {
693
-			$availableSpace = $quota;
694
-		}
695
-
696
-		return $availableSpace;
697
-	}
698
-
699
-	/**
700
-	 * resize trash bin if necessary after a new file was added to Nextcloud
701
-	 *
702
-	 * @param string $user user id
703
-	 */
704
-	public static function resizeTrash($user) {
705
-
706
-		$size = self::getTrashbinSize($user);
707
-
708
-		$freeSpace = self::calculateFreeSpace($size, $user);
709
-
710
-		if ($freeSpace < 0) {
711
-			self::scheduleExpire($user);
712
-		}
713
-	}
714
-
715
-	/**
716
-	 * clean up the trash bin
717
-	 *
718
-	 * @param string $user
719
-	 */
720
-	public static function expire($user) {
721
-		$trashBinSize = self::getTrashbinSize($user);
722
-		$availableSpace = self::calculateFreeSpace($trashBinSize, $user);
723
-
724
-		$dirContent = Helper::getTrashFiles('/', $user, 'mtime');
725
-
726
-		// delete all files older then $retention_obligation
727
-		list($delSize, $count) = self::deleteExpiredFiles($dirContent, $user);
728
-
729
-		$availableSpace += $delSize;
730
-
731
-		// delete files from trash until we meet the trash bin size limit again
732
-		self::deleteFiles(array_slice($dirContent, $count), $user, $availableSpace);
733
-	}
734
-
735
-	/**
736
-	 * @param string $user
737
-	 */
738
-	private static function scheduleExpire($user) {
739
-		// let the admin disable auto expire
740
-		$application = new Application();
741
-		$expiration = $application->getContainer()->query('Expiration');
742
-		if ($expiration->isEnabled()) {
743
-			\OC::$server->getCommandBus()->push(new Expire($user));
744
-		}
745
-	}
746
-
747
-	/**
748
-	 * if the size limit for the trash bin is reached, we delete the oldest
749
-	 * files in the trash bin until we meet the limit again
750
-	 *
751
-	 * @param array $files
752
-	 * @param string $user
753
-	 * @param int $availableSpace available disc space
754
-	 * @return int size of deleted files
755
-	 */
756
-	protected static function deleteFiles($files, $user, $availableSpace) {
757
-		$application = new Application();
758
-		$expiration = $application->getContainer()->query('Expiration');
759
-		$size = 0;
760
-
761
-		if ($availableSpace < 0) {
762
-			foreach ($files as $file) {
763
-				if ($availableSpace < 0 && $expiration->isExpired($file['mtime'], true)) {
764
-					$tmp = self::delete($file['name'], $user, $file['mtime']);
765
-					\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);
766
-					$availableSpace += $tmp;
767
-					$size += $tmp;
768
-				} else {
769
-					break;
770
-				}
771
-			}
772
-		}
773
-		return $size;
774
-	}
775
-
776
-	/**
777
-	 * delete files older then max storage time
778
-	 *
779
-	 * @param array $files list of files sorted by mtime
780
-	 * @param string $user
781
-	 * @return integer[] size of deleted files and number of deleted files
782
-	 */
783
-	public static function deleteExpiredFiles($files, $user) {
784
-		$application = new Application();
785
-		$expiration = $application->getContainer()->query('Expiration');
786
-		$size = 0;
787
-		$count = 0;
788
-		foreach ($files as $file) {
789
-			$timestamp = $file['mtime'];
790
-			$filename = $file['name'];
791
-			if ($expiration->isExpired($timestamp)) {
792
-				$count++;
793
-				$size += self::delete($filename, $user, $timestamp);
794
-				\OC::$server->getLogger()->info(
795
-					'Remove "' . $filename . '" from trashbin because it exceeds max retention obligation term.',
796
-					['app' => 'files_trashbin']
797
-				);
798
-			} else {
799
-				break;
800
-			}
801
-		}
802
-
803
-		return array($size, $count);
804
-	}
805
-
806
-	/**
807
-	 * recursive copy to copy a whole directory
808
-	 *
809
-	 * @param string $source source path, relative to the users files directory
810
-	 * @param string $destination destination path relative to the users root directoy
811
-	 * @param View $view file view for the users root directory
812
-	 * @return int
813
-	 * @throws Exceptions\CopyRecursiveException
814
-	 */
815
-	private static function copy_recursive($source, $destination, View $view) {
816
-		$size = 0;
817
-		if ($view->is_dir($source)) {
818
-			$view->mkdir($destination);
819
-			$view->touch($destination, $view->filemtime($source));
820
-			foreach ($view->getDirectoryContent($source) as $i) {
821
-				$pathDir = $source . '/' . $i['name'];
822
-				if ($view->is_dir($pathDir)) {
823
-					$size += self::copy_recursive($pathDir, $destination . '/' . $i['name'], $view);
824
-				} else {
825
-					$size += $view->filesize($pathDir);
826
-					$result = $view->copy($pathDir, $destination . '/' . $i['name']);
827
-					if (!$result) {
828
-						throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException();
829
-					}
830
-					$view->touch($destination . '/' . $i['name'], $view->filemtime($pathDir));
831
-				}
832
-			}
833
-		} else {
834
-			$size += $view->filesize($source);
835
-			$result = $view->copy($source, $destination);
836
-			if (!$result) {
837
-				throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException();
838
-			}
839
-			$view->touch($destination, $view->filemtime($source));
840
-		}
841
-		return $size;
842
-	}
843
-
844
-	/**
845
-	 * find all versions which belong to the file we want to restore
846
-	 *
847
-	 * @param string $filename name of the file which should be restored
848
-	 * @param int $timestamp timestamp when the file was deleted
849
-	 * @return array
850
-	 */
851
-	private static function getVersionsFromTrash($filename, $timestamp, $user) {
852
-		$view = new View('/' . $user . '/files_trashbin/versions');
853
-		$versions = array();
854
-
855
-		//force rescan of versions, local storage may not have updated the cache
856
-		if (!self::$scannedVersions) {
857
-			/** @var \OC\Files\Storage\Storage $storage */
858
-			list($storage,) = $view->resolvePath('/');
859
-			$storage->getScanner()->scan('files_trashbin/versions');
860
-			self::$scannedVersions = true;
861
-		}
862
-
863
-		if ($timestamp) {
864
-			// fetch for old versions
865
-			$matches = $view->searchRaw($filename . '.v%.d' . $timestamp);
866
-			$offset = -strlen($timestamp) - 2;
867
-		} else {
868
-			$matches = $view->searchRaw($filename . '.v%');
869
-		}
870
-
871
-		if (is_array($matches)) {
872
-			foreach ($matches as $ma) {
873
-				if ($timestamp) {
874
-					$parts = explode('.v', substr($ma['path'], 0, $offset));
875
-					$versions[] = (end($parts));
876
-				} else {
877
-					$parts = explode('.v', $ma);
878
-					$versions[] = (end($parts));
879
-				}
880
-			}
881
-		}
882
-		return $versions;
883
-	}
884
-
885
-	/**
886
-	 * find unique extension for restored file if a file with the same name already exists
887
-	 *
888
-	 * @param string $location where the file should be restored
889
-	 * @param string $filename name of the file
890
-	 * @param View $view filesystem view relative to users root directory
891
-	 * @return string with unique extension
892
-	 */
893
-	private static function getUniqueFilename($location, $filename, View $view) {
894
-		$ext = pathinfo($filename, PATHINFO_EXTENSION);
895
-		$name = pathinfo($filename, PATHINFO_FILENAME);
896
-		$l = \OC::$server->getL10N('files_trashbin');
897
-
898
-		$location = '/' . trim($location, '/');
899
-
900
-		// if extension is not empty we set a dot in front of it
901
-		if ($ext !== '') {
902
-			$ext = '.' . $ext;
903
-		}
904
-
905
-		if ($view->file_exists('files' . $location . '/' . $filename)) {
906
-			$i = 2;
907
-			$uniqueName = $name . " (" . $l->t("restored") . ")" . $ext;
908
-			while ($view->file_exists('files' . $location . '/' . $uniqueName)) {
909
-				$uniqueName = $name . " (" . $l->t("restored") . " " . $i . ")" . $ext;
910
-				$i++;
911
-			}
912
-
913
-			return $uniqueName;
914
-		}
915
-
916
-		return $filename;
917
-	}
918
-
919
-	/**
920
-	 * get the size from a given root folder
921
-	 *
922
-	 * @param View $view file view on the root folder
923
-	 * @return integer size of the folder
924
-	 */
925
-	private static function calculateSize($view) {
926
-		$root = \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . $view->getAbsolutePath('');
927
-		if (!file_exists($root)) {
928
-			return 0;
929
-		}
930
-		$iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($root), \RecursiveIteratorIterator::CHILD_FIRST);
931
-		$size = 0;
932
-
933
-		/**
934
-		 * RecursiveDirectoryIterator on an NFS path isn't iterable with foreach
935
-		 * This bug is fixed in PHP 5.5.9 or before
936
-		 * See #8376
937
-		 */
938
-		$iterator->rewind();
939
-		while ($iterator->valid()) {
940
-			$path = $iterator->current();
941
-			$relpath = substr($path, strlen($root) - 1);
942
-			if (!$view->is_dir($relpath)) {
943
-				$size += $view->filesize($relpath);
944
-			}
945
-			$iterator->next();
946
-		}
947
-		return $size;
948
-	}
949
-
950
-	/**
951
-	 * get current size of trash bin from a given user
952
-	 *
953
-	 * @param string $user user who owns the trash bin
954
-	 * @return integer trash bin size
955
-	 */
956
-	private static function getTrashbinSize($user) {
957
-		$view = new View('/' . $user);
958
-		$fileInfo = $view->getFileInfo('/files_trashbin');
959
-		return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
960
-	}
961
-
962
-	/**
963
-	 * register hooks
964
-	 */
965
-	public static function registerHooks() {
966
-		// create storage wrapper on setup
967
-		\OCP\Util::connectHook('OC_Filesystem', 'preSetup', 'OCA\Files_Trashbin\Storage', 'setupStorage');
968
-		//Listen to delete user signal
969
-		\OCP\Util::connectHook('OC_User', 'pre_deleteUser', 'OCA\Files_Trashbin\Hooks', 'deleteUser_hook');
970
-		//Listen to post write hook
971
-		\OCP\Util::connectHook('OC_Filesystem', 'post_write', 'OCA\Files_Trashbin\Hooks', 'post_write_hook');
972
-		// pre and post-rename, disable trash logic for the copy+unlink case
973
-		\OCP\Util::connectHook('OC_Filesystem', 'delete', 'OCA\Files_Trashbin\Trashbin', 'ensureFileScannedHook');
974
-		\OCP\Util::connectHook('OC_Filesystem', 'rename', 'OCA\Files_Trashbin\Storage', 'preRenameHook');
975
-		\OCP\Util::connectHook('OC_Filesystem', 'post_rename', 'OCA\Files_Trashbin\Storage', 'postRenameHook');
976
-	}
977
-
978
-	/**
979
-	 * check if trash bin is empty for a given user
980
-	 *
981
-	 * @param string $user
982
-	 * @return bool
983
-	 */
984
-	public static function isEmpty($user) {
985
-
986
-		$view = new View('/' . $user . '/files_trashbin');
987
-		if ($view->is_dir('/files') && $dh = $view->opendir('/files')) {
988
-			while ($file = readdir($dh)) {
989
-				if (!Filesystem::isIgnoredDir($file)) {
990
-					return false;
991
-				}
992
-			}
993
-		}
994
-		return true;
995
-	}
996
-
997
-	/**
998
-	 * @param $path
999
-	 * @return string
1000
-	 */
1001
-	public static function preview_icon($path) {
1002
-		return \OCP\Util::linkToRoute('core_ajax_trashbin_preview', array('x' => 32, 'y' => 32, 'file' => $path));
1003
-	}
52
+    // unit: percentage; 50% of available disk space/quota
53
+    const DEFAULTMAXSIZE = 50;
54
+
55
+    /**
56
+     * Whether versions have already be rescanned during this PHP request
57
+     *
58
+     * @var bool
59
+     */
60
+    private static $scannedVersions = false;
61
+
62
+    /**
63
+     * Ensure we don't need to scan the file during the move to trash
64
+     * by triggering the scan in the pre-hook
65
+     *
66
+     * @param array $params
67
+     */
68
+    public static function ensureFileScannedHook($params) {
69
+        try {
70
+            self::getUidAndFilename($params['path']);
71
+        } catch (NotFoundException $e) {
72
+            // nothing to scan for non existing files
73
+        }
74
+    }
75
+
76
+    /**
77
+     * get the UID of the owner of the file and the path to the file relative to
78
+     * owners files folder
79
+     *
80
+     * @param string $filename
81
+     * @return array
82
+     * @throws \OC\User\NoUserException
83
+     */
84
+    public static function getUidAndFilename($filename) {
85
+        $uid = Filesystem::getOwner($filename);
86
+        $userManager = \OC::$server->getUserManager();
87
+        // if the user with the UID doesn't exists, e.g. because the UID points
88
+        // to a remote user with a federated cloud ID we use the current logged-in
89
+        // user. We need a valid local user to move the file to the right trash bin
90
+        if (!$userManager->userExists($uid)) {
91
+            $uid = User::getUser();
92
+        }
93
+        if (!$uid) {
94
+            // no owner, usually because of share link from ext storage
95
+            return [null, null];
96
+        }
97
+        Filesystem::initMountPoints($uid);
98
+        if ($uid != User::getUser()) {
99
+            $info = Filesystem::getFileInfo($filename);
100
+            $ownerView = new View('/' . $uid . '/files');
101
+            try {
102
+                $filename = $ownerView->getPath($info['fileid']);
103
+            } catch (NotFoundException $e) {
104
+                $filename = null;
105
+            }
106
+        }
107
+        return [$uid, $filename];
108
+    }
109
+
110
+    /**
111
+     * get original location of files for user
112
+     *
113
+     * @param string $user
114
+     * @return array (filename => array (timestamp => original location))
115
+     */
116
+    public static function getLocations($user) {
117
+        $query = \OC_DB::prepare('SELECT `id`, `timestamp`, `location`'
118
+            . ' FROM `*PREFIX*files_trash` WHERE `user`=?');
119
+        $result = $query->execute(array($user));
120
+        $array = array();
121
+        while ($row = $result->fetchRow()) {
122
+            if (isset($array[$row['id']])) {
123
+                $array[$row['id']][$row['timestamp']] = $row['location'];
124
+            } else {
125
+                $array[$row['id']] = array($row['timestamp'] => $row['location']);
126
+            }
127
+        }
128
+        return $array;
129
+    }
130
+
131
+    /**
132
+     * get original location of file
133
+     *
134
+     * @param string $user
135
+     * @param string $filename
136
+     * @param string $timestamp
137
+     * @return string original location
138
+     */
139
+    public static function getLocation($user, $filename, $timestamp) {
140
+        $query = \OC_DB::prepare('SELECT `location` FROM `*PREFIX*files_trash`'
141
+            . ' WHERE `user`=? AND `id`=? AND `timestamp`=?');
142
+        $result = $query->execute(array($user, $filename, $timestamp))->fetchAll();
143
+        if (isset($result[0]['location'])) {
144
+            return $result[0]['location'];
145
+        } else {
146
+            return false;
147
+        }
148
+    }
149
+
150
+    private static function setUpTrash($user) {
151
+        $view = new View('/' . $user);
152
+        if (!$view->is_dir('files_trashbin')) {
153
+            $view->mkdir('files_trashbin');
154
+        }
155
+        if (!$view->is_dir('files_trashbin/files')) {
156
+            $view->mkdir('files_trashbin/files');
157
+        }
158
+        if (!$view->is_dir('files_trashbin/versions')) {
159
+            $view->mkdir('files_trashbin/versions');
160
+        }
161
+        if (!$view->is_dir('files_trashbin/keys')) {
162
+            $view->mkdir('files_trashbin/keys');
163
+        }
164
+    }
165
+
166
+
167
+    /**
168
+     * copy file to owners trash
169
+     *
170
+     * @param string $sourcePath
171
+     * @param string $owner
172
+     * @param string $targetPath
173
+     * @param $user
174
+     * @param integer $timestamp
175
+     */
176
+    private static function copyFilesToUser($sourcePath, $owner, $targetPath, $user, $timestamp) {
177
+        self::setUpTrash($owner);
178
+
179
+        $targetFilename = basename($targetPath);
180
+        $targetLocation = dirname($targetPath);
181
+
182
+        $sourceFilename = basename($sourcePath);
183
+
184
+        $view = new View('/');
185
+
186
+        $target = $user . '/files_trashbin/files/' . $targetFilename . '.d' . $timestamp;
187
+        $source = $owner . '/files_trashbin/files/' . $sourceFilename . '.d' . $timestamp;
188
+        self::copy_recursive($source, $target, $view);
189
+
190
+
191
+        if ($view->file_exists($target)) {
192
+            $query = \OC_DB::prepare("INSERT INTO `*PREFIX*files_trash` (`id`,`timestamp`,`location`,`user`) VALUES (?,?,?,?)");
193
+            $result = $query->execute(array($targetFilename, $timestamp, $targetLocation, $user));
194
+            if (!$result) {
195
+                \OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated for the files owner', \OCP\Util::ERROR);
196
+            }
197
+        }
198
+    }
199
+
200
+
201
+    /**
202
+     * move file to the trash bin
203
+     *
204
+     * @param string $file_path path to the deleted file/directory relative to the files root directory
205
+     * @param bool $ownerOnly delete for owner only (if file gets moved out of a shared folder)
206
+     *
207
+     * @return bool
208
+     */
209
+    public static function move2trash($file_path, $ownerOnly = false) {
210
+        // get the user for which the filesystem is setup
211
+        $root = Filesystem::getRoot();
212
+        list(, $user) = explode('/', $root);
213
+        list($owner, $ownerPath) = self::getUidAndFilename($file_path);
214
+
215
+        // if no owner found (ex: ext storage + share link), will use the current user's trashbin then
216
+        if (is_null($owner)) {
217
+            $owner = $user;
218
+            $ownerPath = $file_path;
219
+        }
220
+
221
+        $ownerView = new View('/' . $owner);
222
+        // file has been deleted in between
223
+        if (is_null($ownerPath) || $ownerPath === '' || !$ownerView->file_exists('/files/' . $ownerPath)) {
224
+            return true;
225
+        }
226
+
227
+        self::setUpTrash($user);
228
+        if ($owner !== $user) {
229
+            // also setup for owner
230
+            self::setUpTrash($owner);
231
+        }
232
+
233
+        $path_parts = pathinfo($ownerPath);
234
+
235
+        $filename = $path_parts['basename'];
236
+        $location = $path_parts['dirname'];
237
+        $timestamp = time();
238
+
239
+        // disable proxy to prevent recursive calls
240
+        $trashPath = '/files_trashbin/files/' . $filename . '.d' . $timestamp;
241
+
242
+        /** @var \OC\Files\Storage\Storage $trashStorage */
243
+        list($trashStorage, $trashInternalPath) = $ownerView->resolvePath($trashPath);
244
+        /** @var \OC\Files\Storage\Storage $sourceStorage */
245
+        list($sourceStorage, $sourceInternalPath) = $ownerView->resolvePath('/files/' . $ownerPath);
246
+        try {
247
+            $moveSuccessful = true;
248
+            if ($trashStorage->file_exists($trashInternalPath)) {
249
+                $trashStorage->unlink($trashInternalPath);
250
+            }
251
+            $trashStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath);
252
+        } catch (\OCA\Files_Trashbin\Exceptions\CopyRecursiveException $e) {
253
+            $moveSuccessful = false;
254
+            if ($trashStorage->file_exists($trashInternalPath)) {
255
+                $trashStorage->unlink($trashInternalPath);
256
+            }
257
+            \OCP\Util::writeLog('files_trashbin', 'Couldn\'t move ' . $file_path . ' to the trash bin', \OCP\Util::ERROR);
258
+        }
259
+
260
+        if ($sourceStorage->file_exists($sourceInternalPath)) { // failed to delete the original file, abort
261
+            if ($sourceStorage->is_dir($sourceInternalPath)) {
262
+                $sourceStorage->rmdir($sourceInternalPath);
263
+            } else {
264
+                $sourceStorage->unlink($sourceInternalPath);
265
+            }
266
+            return false;
267
+        }
268
+
269
+        $trashStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $trashInternalPath);
270
+
271
+        if ($moveSuccessful) {
272
+            $query = \OC_DB::prepare("INSERT INTO `*PREFIX*files_trash` (`id`,`timestamp`,`location`,`user`) VALUES (?,?,?,?)");
273
+            $result = $query->execute(array($filename, $timestamp, $location, $owner));
274
+            if (!$result) {
275
+                \OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated', \OCP\Util::ERROR);
276
+            }
277
+            \OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_moveToTrash', array('filePath' => Filesystem::normalizePath($file_path),
278
+                'trashPath' => Filesystem::normalizePath($filename . '.d' . $timestamp)));
279
+
280
+            self::retainVersions($filename, $owner, $ownerPath, $timestamp);
281
+
282
+            // if owner !== user we need to also add a copy to the users trash
283
+            if ($user !== $owner && $ownerOnly === false) {
284
+                self::copyFilesToUser($ownerPath, $owner, $file_path, $user, $timestamp);
285
+            }
286
+        }
287
+
288
+        self::scheduleExpire($user);
289
+
290
+        // if owner !== user we also need to update the owners trash size
291
+        if ($owner !== $user) {
292
+            self::scheduleExpire($owner);
293
+        }
294
+
295
+        return $moveSuccessful;
296
+    }
297
+
298
+    /**
299
+     * Move file versions to trash so that they can be restored later
300
+     *
301
+     * @param string $filename of deleted file
302
+     * @param string $owner owner user id
303
+     * @param string $ownerPath path relative to the owner's home storage
304
+     * @param integer $timestamp when the file was deleted
305
+     */
306
+    private static function retainVersions($filename, $owner, $ownerPath, $timestamp) {
307
+        if (\OCP\App::isEnabled('files_versions') && !empty($ownerPath)) {
308
+
309
+            $user = User::getUser();
310
+            $rootView = new View('/');
311
+
312
+            if ($rootView->is_dir($owner . '/files_versions/' . $ownerPath)) {
313
+                if ($owner !== $user) {
314
+                    self::copy_recursive($owner . '/files_versions/' . $ownerPath, $owner . '/files_trashbin/versions/' . basename($ownerPath) . '.d' . $timestamp, $rootView);
315
+                }
316
+                self::move($rootView, $owner . '/files_versions/' . $ownerPath, $user . '/files_trashbin/versions/' . $filename . '.d' . $timestamp);
317
+            } else if ($versions = \OCA\Files_Versions\Storage::getVersions($owner, $ownerPath)) {
318
+
319
+                foreach ($versions as $v) {
320
+                    if ($owner !== $user) {
321
+                        self::copy($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $owner . '/files_trashbin/versions/' . $v['name'] . '.v' . $v['version'] . '.d' . $timestamp);
322
+                    }
323
+                    self::move($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $user . '/files_trashbin/versions/' . $filename . '.v' . $v['version'] . '.d' . $timestamp);
324
+                }
325
+            }
326
+        }
327
+    }
328
+
329
+    /**
330
+     * Move a file or folder on storage level
331
+     *
332
+     * @param View $view
333
+     * @param string $source
334
+     * @param string $target
335
+     * @return bool
336
+     */
337
+    private static function move(View $view, $source, $target) {
338
+        /** @var \OC\Files\Storage\Storage $sourceStorage */
339
+        list($sourceStorage, $sourceInternalPath) = $view->resolvePath($source);
340
+        /** @var \OC\Files\Storage\Storage $targetStorage */
341
+        list($targetStorage, $targetInternalPath) = $view->resolvePath($target);
342
+        /** @var \OC\Files\Storage\Storage $ownerTrashStorage */
343
+
344
+        $result = $targetStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
345
+        if ($result) {
346
+            $targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
347
+        }
348
+        return $result;
349
+    }
350
+
351
+    /**
352
+     * Copy a file or folder on storage level
353
+     *
354
+     * @param View $view
355
+     * @param string $source
356
+     * @param string $target
357
+     * @return bool
358
+     */
359
+    private static function copy(View $view, $source, $target) {
360
+        /** @var \OC\Files\Storage\Storage $sourceStorage */
361
+        list($sourceStorage, $sourceInternalPath) = $view->resolvePath($source);
362
+        /** @var \OC\Files\Storage\Storage $targetStorage */
363
+        list($targetStorage, $targetInternalPath) = $view->resolvePath($target);
364
+        /** @var \OC\Files\Storage\Storage $ownerTrashStorage */
365
+
366
+        $result = $targetStorage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
367
+        if ($result) {
368
+            $targetStorage->getUpdater()->update($targetInternalPath);
369
+        }
370
+        return $result;
371
+    }
372
+
373
+    /**
374
+     * Restore a file or folder from trash bin
375
+     *
376
+     * @param string $file path to the deleted file/folder relative to "files_trashbin/files/",
377
+     * including the timestamp suffix ".d12345678"
378
+     * @param string $filename name of the file/folder
379
+     * @param int $timestamp time when the file/folder was deleted
380
+     *
381
+     * @return bool true on success, false otherwise
382
+     */
383
+    public static function restore($file, $filename, $timestamp) {
384
+        $user = User::getUser();
385
+        $view = new View('/' . $user);
386
+
387
+        $location = '';
388
+        if ($timestamp) {
389
+            $location = self::getLocation($user, $filename, $timestamp);
390
+            if ($location === false) {
391
+                \OCP\Util::writeLog('files_trashbin', 'trash bin database inconsistent! ($user: ' . $user . ' $filename: ' . $filename . ', $timestamp: ' . $timestamp . ')', \OCP\Util::ERROR);
392
+            } else {
393
+                // if location no longer exists, restore file in the root directory
394
+                if ($location !== '/' &&
395
+                    (!$view->is_dir('files/' . $location) ||
396
+                        !$view->isCreatable('files/' . $location))
397
+                ) {
398
+                    $location = '';
399
+                }
400
+            }
401
+        }
402
+
403
+        // we need a  extension in case a file/dir with the same name already exists
404
+        $uniqueFilename = self::getUniqueFilename($location, $filename, $view);
405
+
406
+        $source = Filesystem::normalizePath('files_trashbin/files/' . $file);
407
+        $target = Filesystem::normalizePath('files/' . $location . '/' . $uniqueFilename);
408
+        if (!$view->file_exists($source)) {
409
+            return false;
410
+        }
411
+        $mtime = $view->filemtime($source);
412
+
413
+        // restore file
414
+        $restoreResult = $view->rename($source, $target);
415
+
416
+        // handle the restore result
417
+        if ($restoreResult) {
418
+            $fakeRoot = $view->getRoot();
419
+            $view->chroot('/' . $user . '/files');
420
+            $view->touch('/' . $location . '/' . $uniqueFilename, $mtime);
421
+            $view->chroot($fakeRoot);
422
+            \OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', array('filePath' => Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename),
423
+                'trashPath' => Filesystem::normalizePath($file)));
424
+
425
+            self::restoreVersions($view, $file, $filename, $uniqueFilename, $location, $timestamp);
426
+
427
+            if ($timestamp) {
428
+                $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?');
429
+                $query->execute(array($user, $filename, $timestamp));
430
+            }
431
+
432
+            return true;
433
+        }
434
+
435
+        return false;
436
+    }
437
+
438
+    /**
439
+     * restore versions from trash bin
440
+     *
441
+     * @param View $view file view
442
+     * @param string $file complete path to file
443
+     * @param string $filename name of file once it was deleted
444
+     * @param string $uniqueFilename new file name to restore the file without overwriting existing files
445
+     * @param string $location location if file
446
+     * @param int $timestamp deletion time
447
+     * @return false|null
448
+     */
449
+    private static function restoreVersions(View $view, $file, $filename, $uniqueFilename, $location, $timestamp) {
450
+
451
+        if (\OCP\App::isEnabled('files_versions')) {
452
+
453
+            $user = User::getUser();
454
+            $rootView = new View('/');
455
+
456
+            $target = Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename);
457
+
458
+            list($owner, $ownerPath) = self::getUidAndFilename($target);
459
+
460
+            // file has been deleted in between
461
+            if (empty($ownerPath)) {
462
+                return false;
463
+            }
464
+
465
+            if ($timestamp) {
466
+                $versionedFile = $filename;
467
+            } else {
468
+                $versionedFile = $file;
469
+            }
470
+
471
+            if ($view->is_dir('/files_trashbin/versions/' . $file)) {
472
+                $rootView->rename(Filesystem::normalizePath($user . '/files_trashbin/versions/' . $file), Filesystem::normalizePath($owner . '/files_versions/' . $ownerPath));
473
+            } else if ($versions = self::getVersionsFromTrash($versionedFile, $timestamp, $user)) {
474
+                foreach ($versions as $v) {
475
+                    if ($timestamp) {
476
+                        $rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v . '.d' . $timestamp, $owner . '/files_versions/' . $ownerPath . '.v' . $v);
477
+                    } else {
478
+                        $rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v, $owner . '/files_versions/' . $ownerPath . '.v' . $v);
479
+                    }
480
+                }
481
+            }
482
+        }
483
+    }
484
+
485
+    /**
486
+     * delete all files from the trash
487
+     */
488
+    public static function deleteAll() {
489
+        $user = User::getUser();
490
+        $userRoot = \OC::$server->getUserFolder($user)->getParent();
491
+        $view = new View('/' . $user);
492
+        $fileInfos = $view->getDirectoryContent('files_trashbin/files');
493
+
494
+        try {
495
+            $trash = $userRoot->get('files_trashbin');
496
+        } catch (NotFoundException $e) {
497
+            return false;
498
+        }
499
+
500
+        // Array to store the relative path in (after the file is deleted, the view won't be able to relativise the path anymore)
501
+        $filePaths = array();
502
+        foreach($fileInfos as $fileInfo){
503
+            $filePaths[] = $view->getRelativePath($fileInfo->getPath());
504
+        }
505
+        unset($fileInfos); // save memory
506
+
507
+        // Bulk PreDelete-Hook
508
+        \OC_Hook::emit('\OCP\Trashbin', 'preDeleteAll', array('paths' => $filePaths));
509
+
510
+        // Single-File Hooks
511
+        foreach($filePaths as $path){
512
+            self::emitTrashbinPreDelete($path);
513
+        }
514
+
515
+        // actual file deletion
516
+        $trash->delete();
517
+        $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=?');
518
+        $query->execute(array($user));
519
+
520
+        // Bulk PostDelete-Hook
521
+        \OC_Hook::emit('\OCP\Trashbin', 'deleteAll', array('paths' => $filePaths));
522
+
523
+        // Single-File Hooks
524
+        foreach($filePaths as $path){
525
+            self::emitTrashbinPostDelete($path);
526
+        }
527
+
528
+        $trash = $userRoot->newFolder('files_trashbin');
529
+        $trash->newFolder('files');
530
+
531
+        return true;
532
+    }
533
+
534
+    /**
535
+     * wrapper function to emit the 'preDelete' hook of \OCP\Trashbin before a file is deleted
536
+     * @param string $path
537
+     */
538
+    protected static function emitTrashbinPreDelete($path){
539
+        \OC_Hook::emit('\OCP\Trashbin', 'preDelete', array('path' => $path));
540
+    }
541
+
542
+    /**
543
+     * wrapper function to emit the 'delete' hook of \OCP\Trashbin after a file has been deleted
544
+     * @param string $path
545
+     */
546
+    protected static function emitTrashbinPostDelete($path){
547
+        \OC_Hook::emit('\OCP\Trashbin', 'delete', array('path' => $path));
548
+    }
549
+
550
+    /**
551
+     * delete file from trash bin permanently
552
+     *
553
+     * @param string $filename path to the file
554
+     * @param string $user
555
+     * @param int $timestamp of deletion time
556
+     *
557
+     * @return int size of deleted files
558
+     */
559
+    public static function delete($filename, $user, $timestamp = null) {
560
+        $userRoot = \OC::$server->getUserFolder($user)->getParent();
561
+        $view = new View('/' . $user);
562
+        $size = 0;
563
+
564
+        if ($timestamp) {
565
+            $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?');
566
+            $query->execute(array($user, $filename, $timestamp));
567
+            $file = $filename . '.d' . $timestamp;
568
+        } else {
569
+            $file = $filename;
570
+        }
571
+
572
+        $size += self::deleteVersions($view, $file, $filename, $timestamp, $user);
573
+
574
+        try {
575
+            $node = $userRoot->get('/files_trashbin/files/' . $file);
576
+        } catch (NotFoundException $e) {
577
+            return $size;
578
+        }
579
+
580
+        if ($node instanceof Folder) {
581
+            $size += self::calculateSize(new View('/' . $user . '/files_trashbin/files/' . $file));
582
+        } else if ($node instanceof File) {
583
+            $size += $view->filesize('/files_trashbin/files/' . $file);
584
+        }
585
+
586
+        self::emitTrashbinPreDelete('/files_trashbin/files/' . $file);
587
+        $node->delete();
588
+        self::emitTrashbinPostDelete('/files_trashbin/files/' . $file);
589
+
590
+        return $size;
591
+    }
592
+
593
+    /**
594
+     * @param View $view
595
+     * @param string $file
596
+     * @param string $filename
597
+     * @param integer|null $timestamp
598
+     * @param string $user
599
+     * @return int
600
+     */
601
+    private static function deleteVersions(View $view, $file, $filename, $timestamp, $user) {
602
+        $size = 0;
603
+        if (\OCP\App::isEnabled('files_versions')) {
604
+            if ($view->is_dir('files_trashbin/versions/' . $file)) {
605
+                $size += self::calculateSize(new View('/' . $user . '/files_trashbin/versions/' . $file));
606
+                $view->unlink('files_trashbin/versions/' . $file);
607
+            } else if ($versions = self::getVersionsFromTrash($filename, $timestamp, $user)) {
608
+                foreach ($versions as $v) {
609
+                    if ($timestamp) {
610
+                        $size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp);
611
+                        $view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp);
612
+                    } else {
613
+                        $size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v);
614
+                        $view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v);
615
+                    }
616
+                }
617
+            }
618
+        }
619
+        return $size;
620
+    }
621
+
622
+    /**
623
+     * check to see whether a file exists in trashbin
624
+     *
625
+     * @param string $filename path to the file
626
+     * @param int $timestamp of deletion time
627
+     * @return bool true if file exists, otherwise false
628
+     */
629
+    public static function file_exists($filename, $timestamp = null) {
630
+        $user = User::getUser();
631
+        $view = new View('/' . $user);
632
+
633
+        if ($timestamp) {
634
+            $filename = $filename . '.d' . $timestamp;
635
+        } else {
636
+            $filename = $filename;
637
+        }
638
+
639
+        $target = Filesystem::normalizePath('files_trashbin/files/' . $filename);
640
+        return $view->file_exists($target);
641
+    }
642
+
643
+    /**
644
+     * deletes used space for trash bin in db if user was deleted
645
+     *
646
+     * @param string $uid id of deleted user
647
+     * @return bool result of db delete operation
648
+     */
649
+    public static function deleteUser($uid) {
650
+        $query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=?');
651
+        return $query->execute(array($uid));
652
+    }
653
+
654
+    /**
655
+     * calculate remaining free space for trash bin
656
+     *
657
+     * @param integer $trashbinSize current size of the trash bin
658
+     * @param string $user
659
+     * @return int available free space for trash bin
660
+     */
661
+    private static function calculateFreeSpace($trashbinSize, $user) {
662
+        $softQuota = true;
663
+        $userObject = \OC::$server->getUserManager()->get($user);
664
+        if(is_null($userObject)) {
665
+            return 0;
666
+        }
667
+        $quota = $userObject->getQuota();
668
+        if ($quota === null || $quota === 'none') {
669
+            $quota = Filesystem::free_space('/');
670
+            $softQuota = false;
671
+            // inf or unknown free space
672
+            if ($quota < 0) {
673
+                $quota = PHP_INT_MAX;
674
+            }
675
+        } else {
676
+            $quota = \OCP\Util::computerFileSize($quota);
677
+        }
678
+
679
+        // calculate available space for trash bin
680
+        // subtract size of files and current trash bin size from quota
681
+        if ($softQuota) {
682
+            $userFolder = \OC::$server->getUserFolder($user);
683
+            if(is_null($userFolder)) {
684
+                return 0;
685
+            }
686
+            $free = $quota - $userFolder->getSize(); // remaining free space for user
687
+            if ($free > 0) {
688
+                $availableSpace = ($free * self::DEFAULTMAXSIZE / 100) - $trashbinSize; // how much space can be used for versions
689
+            } else {
690
+                $availableSpace = $free - $trashbinSize;
691
+            }
692
+        } else {
693
+            $availableSpace = $quota;
694
+        }
695
+
696
+        return $availableSpace;
697
+    }
698
+
699
+    /**
700
+     * resize trash bin if necessary after a new file was added to Nextcloud
701
+     *
702
+     * @param string $user user id
703
+     */
704
+    public static function resizeTrash($user) {
705
+
706
+        $size = self::getTrashbinSize($user);
707
+
708
+        $freeSpace = self::calculateFreeSpace($size, $user);
709
+
710
+        if ($freeSpace < 0) {
711
+            self::scheduleExpire($user);
712
+        }
713
+    }
714
+
715
+    /**
716
+     * clean up the trash bin
717
+     *
718
+     * @param string $user
719
+     */
720
+    public static function expire($user) {
721
+        $trashBinSize = self::getTrashbinSize($user);
722
+        $availableSpace = self::calculateFreeSpace($trashBinSize, $user);
723
+
724
+        $dirContent = Helper::getTrashFiles('/', $user, 'mtime');
725
+
726
+        // delete all files older then $retention_obligation
727
+        list($delSize, $count) = self::deleteExpiredFiles($dirContent, $user);
728
+
729
+        $availableSpace += $delSize;
730
+
731
+        // delete files from trash until we meet the trash bin size limit again
732
+        self::deleteFiles(array_slice($dirContent, $count), $user, $availableSpace);
733
+    }
734
+
735
+    /**
736
+     * @param string $user
737
+     */
738
+    private static function scheduleExpire($user) {
739
+        // let the admin disable auto expire
740
+        $application = new Application();
741
+        $expiration = $application->getContainer()->query('Expiration');
742
+        if ($expiration->isEnabled()) {
743
+            \OC::$server->getCommandBus()->push(new Expire($user));
744
+        }
745
+    }
746
+
747
+    /**
748
+     * if the size limit for the trash bin is reached, we delete the oldest
749
+     * files in the trash bin until we meet the limit again
750
+     *
751
+     * @param array $files
752
+     * @param string $user
753
+     * @param int $availableSpace available disc space
754
+     * @return int size of deleted files
755
+     */
756
+    protected static function deleteFiles($files, $user, $availableSpace) {
757
+        $application = new Application();
758
+        $expiration = $application->getContainer()->query('Expiration');
759
+        $size = 0;
760
+
761
+        if ($availableSpace < 0) {
762
+            foreach ($files as $file) {
763
+                if ($availableSpace < 0 && $expiration->isExpired($file['mtime'], true)) {
764
+                    $tmp = self::delete($file['name'], $user, $file['mtime']);
765
+                    \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);
766
+                    $availableSpace += $tmp;
767
+                    $size += $tmp;
768
+                } else {
769
+                    break;
770
+                }
771
+            }
772
+        }
773
+        return $size;
774
+    }
775
+
776
+    /**
777
+     * delete files older then max storage time
778
+     *
779
+     * @param array $files list of files sorted by mtime
780
+     * @param string $user
781
+     * @return integer[] size of deleted files and number of deleted files
782
+     */
783
+    public static function deleteExpiredFiles($files, $user) {
784
+        $application = new Application();
785
+        $expiration = $application->getContainer()->query('Expiration');
786
+        $size = 0;
787
+        $count = 0;
788
+        foreach ($files as $file) {
789
+            $timestamp = $file['mtime'];
790
+            $filename = $file['name'];
791
+            if ($expiration->isExpired($timestamp)) {
792
+                $count++;
793
+                $size += self::delete($filename, $user, $timestamp);
794
+                \OC::$server->getLogger()->info(
795
+                    'Remove "' . $filename . '" from trashbin because it exceeds max retention obligation term.',
796
+                    ['app' => 'files_trashbin']
797
+                );
798
+            } else {
799
+                break;
800
+            }
801
+        }
802
+
803
+        return array($size, $count);
804
+    }
805
+
806
+    /**
807
+     * recursive copy to copy a whole directory
808
+     *
809
+     * @param string $source source path, relative to the users files directory
810
+     * @param string $destination destination path relative to the users root directoy
811
+     * @param View $view file view for the users root directory
812
+     * @return int
813
+     * @throws Exceptions\CopyRecursiveException
814
+     */
815
+    private static function copy_recursive($source, $destination, View $view) {
816
+        $size = 0;
817
+        if ($view->is_dir($source)) {
818
+            $view->mkdir($destination);
819
+            $view->touch($destination, $view->filemtime($source));
820
+            foreach ($view->getDirectoryContent($source) as $i) {
821
+                $pathDir = $source . '/' . $i['name'];
822
+                if ($view->is_dir($pathDir)) {
823
+                    $size += self::copy_recursive($pathDir, $destination . '/' . $i['name'], $view);
824
+                } else {
825
+                    $size += $view->filesize($pathDir);
826
+                    $result = $view->copy($pathDir, $destination . '/' . $i['name']);
827
+                    if (!$result) {
828
+                        throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException();
829
+                    }
830
+                    $view->touch($destination . '/' . $i['name'], $view->filemtime($pathDir));
831
+                }
832
+            }
833
+        } else {
834
+            $size += $view->filesize($source);
835
+            $result = $view->copy($source, $destination);
836
+            if (!$result) {
837
+                throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException();
838
+            }
839
+            $view->touch($destination, $view->filemtime($source));
840
+        }
841
+        return $size;
842
+    }
843
+
844
+    /**
845
+     * find all versions which belong to the file we want to restore
846
+     *
847
+     * @param string $filename name of the file which should be restored
848
+     * @param int $timestamp timestamp when the file was deleted
849
+     * @return array
850
+     */
851
+    private static function getVersionsFromTrash($filename, $timestamp, $user) {
852
+        $view = new View('/' . $user . '/files_trashbin/versions');
853
+        $versions = array();
854
+
855
+        //force rescan of versions, local storage may not have updated the cache
856
+        if (!self::$scannedVersions) {
857
+            /** @var \OC\Files\Storage\Storage $storage */
858
+            list($storage,) = $view->resolvePath('/');
859
+            $storage->getScanner()->scan('files_trashbin/versions');
860
+            self::$scannedVersions = true;
861
+        }
862
+
863
+        if ($timestamp) {
864
+            // fetch for old versions
865
+            $matches = $view->searchRaw($filename . '.v%.d' . $timestamp);
866
+            $offset = -strlen($timestamp) - 2;
867
+        } else {
868
+            $matches = $view->searchRaw($filename . '.v%');
869
+        }
870
+
871
+        if (is_array($matches)) {
872
+            foreach ($matches as $ma) {
873
+                if ($timestamp) {
874
+                    $parts = explode('.v', substr($ma['path'], 0, $offset));
875
+                    $versions[] = (end($parts));
876
+                } else {
877
+                    $parts = explode('.v', $ma);
878
+                    $versions[] = (end($parts));
879
+                }
880
+            }
881
+        }
882
+        return $versions;
883
+    }
884
+
885
+    /**
886
+     * find unique extension for restored file if a file with the same name already exists
887
+     *
888
+     * @param string $location where the file should be restored
889
+     * @param string $filename name of the file
890
+     * @param View $view filesystem view relative to users root directory
891
+     * @return string with unique extension
892
+     */
893
+    private static function getUniqueFilename($location, $filename, View $view) {
894
+        $ext = pathinfo($filename, PATHINFO_EXTENSION);
895
+        $name = pathinfo($filename, PATHINFO_FILENAME);
896
+        $l = \OC::$server->getL10N('files_trashbin');
897
+
898
+        $location = '/' . trim($location, '/');
899
+
900
+        // if extension is not empty we set a dot in front of it
901
+        if ($ext !== '') {
902
+            $ext = '.' . $ext;
903
+        }
904
+
905
+        if ($view->file_exists('files' . $location . '/' . $filename)) {
906
+            $i = 2;
907
+            $uniqueName = $name . " (" . $l->t("restored") . ")" . $ext;
908
+            while ($view->file_exists('files' . $location . '/' . $uniqueName)) {
909
+                $uniqueName = $name . " (" . $l->t("restored") . " " . $i . ")" . $ext;
910
+                $i++;
911
+            }
912
+
913
+            return $uniqueName;
914
+        }
915
+
916
+        return $filename;
917
+    }
918
+
919
+    /**
920
+     * get the size from a given root folder
921
+     *
922
+     * @param View $view file view on the root folder
923
+     * @return integer size of the folder
924
+     */
925
+    private static function calculateSize($view) {
926
+        $root = \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . $view->getAbsolutePath('');
927
+        if (!file_exists($root)) {
928
+            return 0;
929
+        }
930
+        $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($root), \RecursiveIteratorIterator::CHILD_FIRST);
931
+        $size = 0;
932
+
933
+        /**
934
+         * RecursiveDirectoryIterator on an NFS path isn't iterable with foreach
935
+         * This bug is fixed in PHP 5.5.9 or before
936
+         * See #8376
937
+         */
938
+        $iterator->rewind();
939
+        while ($iterator->valid()) {
940
+            $path = $iterator->current();
941
+            $relpath = substr($path, strlen($root) - 1);
942
+            if (!$view->is_dir($relpath)) {
943
+                $size += $view->filesize($relpath);
944
+            }
945
+            $iterator->next();
946
+        }
947
+        return $size;
948
+    }
949
+
950
+    /**
951
+     * get current size of trash bin from a given user
952
+     *
953
+     * @param string $user user who owns the trash bin
954
+     * @return integer trash bin size
955
+     */
956
+    private static function getTrashbinSize($user) {
957
+        $view = new View('/' . $user);
958
+        $fileInfo = $view->getFileInfo('/files_trashbin');
959
+        return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
960
+    }
961
+
962
+    /**
963
+     * register hooks
964
+     */
965
+    public static function registerHooks() {
966
+        // create storage wrapper on setup
967
+        \OCP\Util::connectHook('OC_Filesystem', 'preSetup', 'OCA\Files_Trashbin\Storage', 'setupStorage');
968
+        //Listen to delete user signal
969
+        \OCP\Util::connectHook('OC_User', 'pre_deleteUser', 'OCA\Files_Trashbin\Hooks', 'deleteUser_hook');
970
+        //Listen to post write hook
971
+        \OCP\Util::connectHook('OC_Filesystem', 'post_write', 'OCA\Files_Trashbin\Hooks', 'post_write_hook');
972
+        // pre and post-rename, disable trash logic for the copy+unlink case
973
+        \OCP\Util::connectHook('OC_Filesystem', 'delete', 'OCA\Files_Trashbin\Trashbin', 'ensureFileScannedHook');
974
+        \OCP\Util::connectHook('OC_Filesystem', 'rename', 'OCA\Files_Trashbin\Storage', 'preRenameHook');
975
+        \OCP\Util::connectHook('OC_Filesystem', 'post_rename', 'OCA\Files_Trashbin\Storage', 'postRenameHook');
976
+    }
977
+
978
+    /**
979
+     * check if trash bin is empty for a given user
980
+     *
981
+     * @param string $user
982
+     * @return bool
983
+     */
984
+    public static function isEmpty($user) {
985
+
986
+        $view = new View('/' . $user . '/files_trashbin');
987
+        if ($view->is_dir('/files') && $dh = $view->opendir('/files')) {
988
+            while ($file = readdir($dh)) {
989
+                if (!Filesystem::isIgnoredDir($file)) {
990
+                    return false;
991
+                }
992
+            }
993
+        }
994
+        return true;
995
+    }
996
+
997
+    /**
998
+     * @param $path
999
+     * @return string
1000
+     */
1001
+    public static function preview_icon($path) {
1002
+        return \OCP\Util::linkToRoute('core_ajax_trashbin_preview', array('x' => 32, 'y' => 32, 'file' => $path));
1003
+    }
1004 1004
 }
Please login to merge, or discard this patch.
Spacing   +72 added lines, -72 removed lines patch added patch discarded remove patch
@@ -97,7 +97,7 @@  discard block
 block discarded – undo
97 97
 		Filesystem::initMountPoints($uid);
98 98
 		if ($uid != User::getUser()) {
99 99
 			$info = Filesystem::getFileInfo($filename);
100
-			$ownerView = new View('/' . $uid . '/files');
100
+			$ownerView = new View('/'.$uid.'/files');
101 101
 			try {
102 102
 				$filename = $ownerView->getPath($info['fileid']);
103 103
 			} catch (NotFoundException $e) {
@@ -148,7 +148,7 @@  discard block
 block discarded – undo
148 148
 	}
149 149
 
150 150
 	private static function setUpTrash($user) {
151
-		$view = new View('/' . $user);
151
+		$view = new View('/'.$user);
152 152
 		if (!$view->is_dir('files_trashbin')) {
153 153
 			$view->mkdir('files_trashbin');
154 154
 		}
@@ -183,8 +183,8 @@  discard block
 block discarded – undo
183 183
 
184 184
 		$view = new View('/');
185 185
 
186
-		$target = $user . '/files_trashbin/files/' . $targetFilename . '.d' . $timestamp;
187
-		$source = $owner . '/files_trashbin/files/' . $sourceFilename . '.d' . $timestamp;
186
+		$target = $user.'/files_trashbin/files/'.$targetFilename.'.d'.$timestamp;
187
+		$source = $owner.'/files_trashbin/files/'.$sourceFilename.'.d'.$timestamp;
188 188
 		self::copy_recursive($source, $target, $view);
189 189
 
190 190
 
@@ -218,9 +218,9 @@  discard block
 block discarded – undo
218 218
 			$ownerPath = $file_path;
219 219
 		}
220 220
 
221
-		$ownerView = new View('/' . $owner);
221
+		$ownerView = new View('/'.$owner);
222 222
 		// file has been deleted in between
223
-		if (is_null($ownerPath) || $ownerPath === '' || !$ownerView->file_exists('/files/' . $ownerPath)) {
223
+		if (is_null($ownerPath) || $ownerPath === '' || !$ownerView->file_exists('/files/'.$ownerPath)) {
224 224
 			return true;
225 225
 		}
226 226
 
@@ -237,12 +237,12 @@  discard block
 block discarded – undo
237 237
 		$timestamp = time();
238 238
 
239 239
 		// disable proxy to prevent recursive calls
240
-		$trashPath = '/files_trashbin/files/' . $filename . '.d' . $timestamp;
240
+		$trashPath = '/files_trashbin/files/'.$filename.'.d'.$timestamp;
241 241
 
242 242
 		/** @var \OC\Files\Storage\Storage $trashStorage */
243 243
 		list($trashStorage, $trashInternalPath) = $ownerView->resolvePath($trashPath);
244 244
 		/** @var \OC\Files\Storage\Storage $sourceStorage */
245
-		list($sourceStorage, $sourceInternalPath) = $ownerView->resolvePath('/files/' . $ownerPath);
245
+		list($sourceStorage, $sourceInternalPath) = $ownerView->resolvePath('/files/'.$ownerPath);
246 246
 		try {
247 247
 			$moveSuccessful = true;
248 248
 			if ($trashStorage->file_exists($trashInternalPath)) {
@@ -254,7 +254,7 @@  discard block
 block discarded – undo
254 254
 			if ($trashStorage->file_exists($trashInternalPath)) {
255 255
 				$trashStorage->unlink($trashInternalPath);
256 256
 			}
257
-			\OCP\Util::writeLog('files_trashbin', 'Couldn\'t move ' . $file_path . ' to the trash bin', \OCP\Util::ERROR);
257
+			\OCP\Util::writeLog('files_trashbin', 'Couldn\'t move '.$file_path.' to the trash bin', \OCP\Util::ERROR);
258 258
 		}
259 259
 
260 260
 		if ($sourceStorage->file_exists($sourceInternalPath)) { // failed to delete the original file, abort
@@ -275,7 +275,7 @@  discard block
 block discarded – undo
275 275
 				\OCP\Util::writeLog('files_trashbin', 'trash bin database couldn\'t be updated', \OCP\Util::ERROR);
276 276
 			}
277 277
 			\OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_moveToTrash', array('filePath' => Filesystem::normalizePath($file_path),
278
-				'trashPath' => Filesystem::normalizePath($filename . '.d' . $timestamp)));
278
+				'trashPath' => Filesystem::normalizePath($filename.'.d'.$timestamp)));
279 279
 
280 280
 			self::retainVersions($filename, $owner, $ownerPath, $timestamp);
281 281
 
@@ -309,18 +309,18 @@  discard block
 block discarded – undo
309 309
 			$user = User::getUser();
310 310
 			$rootView = new View('/');
311 311
 
312
-			if ($rootView->is_dir($owner . '/files_versions/' . $ownerPath)) {
312
+			if ($rootView->is_dir($owner.'/files_versions/'.$ownerPath)) {
313 313
 				if ($owner !== $user) {
314
-					self::copy_recursive($owner . '/files_versions/' . $ownerPath, $owner . '/files_trashbin/versions/' . basename($ownerPath) . '.d' . $timestamp, $rootView);
314
+					self::copy_recursive($owner.'/files_versions/'.$ownerPath, $owner.'/files_trashbin/versions/'.basename($ownerPath).'.d'.$timestamp, $rootView);
315 315
 				}
316
-				self::move($rootView, $owner . '/files_versions/' . $ownerPath, $user . '/files_trashbin/versions/' . $filename . '.d' . $timestamp);
316
+				self::move($rootView, $owner.'/files_versions/'.$ownerPath, $user.'/files_trashbin/versions/'.$filename.'.d'.$timestamp);
317 317
 			} else if ($versions = \OCA\Files_Versions\Storage::getVersions($owner, $ownerPath)) {
318 318
 
319 319
 				foreach ($versions as $v) {
320 320
 					if ($owner !== $user) {
321
-						self::copy($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $owner . '/files_trashbin/versions/' . $v['name'] . '.v' . $v['version'] . '.d' . $timestamp);
321
+						self::copy($rootView, $owner.'/files_versions'.$v['path'].'.v'.$v['version'], $owner.'/files_trashbin/versions/'.$v['name'].'.v'.$v['version'].'.d'.$timestamp);
322 322
 					}
323
-					self::move($rootView, $owner . '/files_versions' . $v['path'] . '.v' . $v['version'], $user . '/files_trashbin/versions/' . $filename . '.v' . $v['version'] . '.d' . $timestamp);
323
+					self::move($rootView, $owner.'/files_versions'.$v['path'].'.v'.$v['version'], $user.'/files_trashbin/versions/'.$filename.'.v'.$v['version'].'.d'.$timestamp);
324 324
 				}
325 325
 			}
326 326
 		}
@@ -382,18 +382,18 @@  discard block
 block discarded – undo
382 382
 	 */
383 383
 	public static function restore($file, $filename, $timestamp) {
384 384
 		$user = User::getUser();
385
-		$view = new View('/' . $user);
385
+		$view = new View('/'.$user);
386 386
 
387 387
 		$location = '';
388 388
 		if ($timestamp) {
389 389
 			$location = self::getLocation($user, $filename, $timestamp);
390 390
 			if ($location === false) {
391
-				\OCP\Util::writeLog('files_trashbin', 'trash bin database inconsistent! ($user: ' . $user . ' $filename: ' . $filename . ', $timestamp: ' . $timestamp . ')', \OCP\Util::ERROR);
391
+				\OCP\Util::writeLog('files_trashbin', 'trash bin database inconsistent! ($user: '.$user.' $filename: '.$filename.', $timestamp: '.$timestamp.')', \OCP\Util::ERROR);
392 392
 			} else {
393 393
 				// if location no longer exists, restore file in the root directory
394 394
 				if ($location !== '/' &&
395
-					(!$view->is_dir('files/' . $location) ||
396
-						!$view->isCreatable('files/' . $location))
395
+					(!$view->is_dir('files/'.$location) ||
396
+						!$view->isCreatable('files/'.$location))
397 397
 				) {
398 398
 					$location = '';
399 399
 				}
@@ -403,8 +403,8 @@  discard block
 block discarded – undo
403 403
 		// we need a  extension in case a file/dir with the same name already exists
404 404
 		$uniqueFilename = self::getUniqueFilename($location, $filename, $view);
405 405
 
406
-		$source = Filesystem::normalizePath('files_trashbin/files/' . $file);
407
-		$target = Filesystem::normalizePath('files/' . $location . '/' . $uniqueFilename);
406
+		$source = Filesystem::normalizePath('files_trashbin/files/'.$file);
407
+		$target = Filesystem::normalizePath('files/'.$location.'/'.$uniqueFilename);
408 408
 		if (!$view->file_exists($source)) {
409 409
 			return false;
410 410
 		}
@@ -416,10 +416,10 @@  discard block
 block discarded – undo
416 416
 		// handle the restore result
417 417
 		if ($restoreResult) {
418 418
 			$fakeRoot = $view->getRoot();
419
-			$view->chroot('/' . $user . '/files');
420
-			$view->touch('/' . $location . '/' . $uniqueFilename, $mtime);
419
+			$view->chroot('/'.$user.'/files');
420
+			$view->touch('/'.$location.'/'.$uniqueFilename, $mtime);
421 421
 			$view->chroot($fakeRoot);
422
-			\OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', array('filePath' => Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename),
422
+			\OCP\Util::emitHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', array('filePath' => Filesystem::normalizePath('/'.$location.'/'.$uniqueFilename),
423 423
 				'trashPath' => Filesystem::normalizePath($file)));
424 424
 
425 425
 			self::restoreVersions($view, $file, $filename, $uniqueFilename, $location, $timestamp);
@@ -453,7 +453,7 @@  discard block
 block discarded – undo
453 453
 			$user = User::getUser();
454 454
 			$rootView = new View('/');
455 455
 
456
-			$target = Filesystem::normalizePath('/' . $location . '/' . $uniqueFilename);
456
+			$target = Filesystem::normalizePath('/'.$location.'/'.$uniqueFilename);
457 457
 
458 458
 			list($owner, $ownerPath) = self::getUidAndFilename($target);
459 459
 
@@ -468,14 +468,14 @@  discard block
 block discarded – undo
468 468
 				$versionedFile = $file;
469 469
 			}
470 470
 
471
-			if ($view->is_dir('/files_trashbin/versions/' . $file)) {
472
-				$rootView->rename(Filesystem::normalizePath($user . '/files_trashbin/versions/' . $file), Filesystem::normalizePath($owner . '/files_versions/' . $ownerPath));
471
+			if ($view->is_dir('/files_trashbin/versions/'.$file)) {
472
+				$rootView->rename(Filesystem::normalizePath($user.'/files_trashbin/versions/'.$file), Filesystem::normalizePath($owner.'/files_versions/'.$ownerPath));
473 473
 			} else if ($versions = self::getVersionsFromTrash($versionedFile, $timestamp, $user)) {
474 474
 				foreach ($versions as $v) {
475 475
 					if ($timestamp) {
476
-						$rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v . '.d' . $timestamp, $owner . '/files_versions/' . $ownerPath . '.v' . $v);
476
+						$rootView->rename($user.'/files_trashbin/versions/'.$versionedFile.'.v'.$v.'.d'.$timestamp, $owner.'/files_versions/'.$ownerPath.'.v'.$v);
477 477
 					} else {
478
-						$rootView->rename($user . '/files_trashbin/versions/' . $versionedFile . '.v' . $v, $owner . '/files_versions/' . $ownerPath . '.v' . $v);
478
+						$rootView->rename($user.'/files_trashbin/versions/'.$versionedFile.'.v'.$v, $owner.'/files_versions/'.$ownerPath.'.v'.$v);
479 479
 					}
480 480
 				}
481 481
 			}
@@ -488,7 +488,7 @@  discard block
 block discarded – undo
488 488
 	public static function deleteAll() {
489 489
 		$user = User::getUser();
490 490
 		$userRoot = \OC::$server->getUserFolder($user)->getParent();
491
-		$view = new View('/' . $user);
491
+		$view = new View('/'.$user);
492 492
 		$fileInfos = $view->getDirectoryContent('files_trashbin/files');
493 493
 
494 494
 		try {
@@ -499,7 +499,7 @@  discard block
 block discarded – undo
499 499
 
500 500
 		// Array to store the relative path in (after the file is deleted, the view won't be able to relativise the path anymore)
501 501
 		$filePaths = array();
502
-		foreach($fileInfos as $fileInfo){
502
+		foreach ($fileInfos as $fileInfo) {
503 503
 			$filePaths[] = $view->getRelativePath($fileInfo->getPath());
504 504
 		}
505 505
 		unset($fileInfos); // save memory
@@ -508,7 +508,7 @@  discard block
 block discarded – undo
508 508
 		\OC_Hook::emit('\OCP\Trashbin', 'preDeleteAll', array('paths' => $filePaths));
509 509
 
510 510
 		// Single-File Hooks
511
-		foreach($filePaths as $path){
511
+		foreach ($filePaths as $path) {
512 512
 			self::emitTrashbinPreDelete($path);
513 513
 		}
514 514
 
@@ -521,7 +521,7 @@  discard block
 block discarded – undo
521 521
 		\OC_Hook::emit('\OCP\Trashbin', 'deleteAll', array('paths' => $filePaths));
522 522
 
523 523
 		// Single-File Hooks
524
-		foreach($filePaths as $path){
524
+		foreach ($filePaths as $path) {
525 525
 			self::emitTrashbinPostDelete($path);
526 526
 		}
527 527
 
@@ -535,7 +535,7 @@  discard block
 block discarded – undo
535 535
 	 * wrapper function to emit the 'preDelete' hook of \OCP\Trashbin before a file is deleted
536 536
 	 * @param string $path
537 537
 	 */
538
-	protected static function emitTrashbinPreDelete($path){
538
+	protected static function emitTrashbinPreDelete($path) {
539 539
 		\OC_Hook::emit('\OCP\Trashbin', 'preDelete', array('path' => $path));
540 540
 	}
541 541
 
@@ -543,7 +543,7 @@  discard block
 block discarded – undo
543 543
 	 * wrapper function to emit the 'delete' hook of \OCP\Trashbin after a file has been deleted
544 544
 	 * @param string $path
545 545
 	 */
546
-	protected static function emitTrashbinPostDelete($path){
546
+	protected static function emitTrashbinPostDelete($path) {
547 547
 		\OC_Hook::emit('\OCP\Trashbin', 'delete', array('path' => $path));
548 548
 	}
549 549
 
@@ -558,13 +558,13 @@  discard block
 block discarded – undo
558 558
 	 */
559 559
 	public static function delete($filename, $user, $timestamp = null) {
560 560
 		$userRoot = \OC::$server->getUserFolder($user)->getParent();
561
-		$view = new View('/' . $user);
561
+		$view = new View('/'.$user);
562 562
 		$size = 0;
563 563
 
564 564
 		if ($timestamp) {
565 565
 			$query = \OC_DB::prepare('DELETE FROM `*PREFIX*files_trash` WHERE `user`=? AND `id`=? AND `timestamp`=?');
566 566
 			$query->execute(array($user, $filename, $timestamp));
567
-			$file = $filename . '.d' . $timestamp;
567
+			$file = $filename.'.d'.$timestamp;
568 568
 		} else {
569 569
 			$file = $filename;
570 570
 		}
@@ -572,20 +572,20 @@  discard block
 block discarded – undo
572 572
 		$size += self::deleteVersions($view, $file, $filename, $timestamp, $user);
573 573
 
574 574
 		try {
575
-			$node = $userRoot->get('/files_trashbin/files/' . $file);
575
+			$node = $userRoot->get('/files_trashbin/files/'.$file);
576 576
 		} catch (NotFoundException $e) {
577 577
 			return $size;
578 578
 		}
579 579
 
580 580
 		if ($node instanceof Folder) {
581
-			$size += self::calculateSize(new View('/' . $user . '/files_trashbin/files/' . $file));
581
+			$size += self::calculateSize(new View('/'.$user.'/files_trashbin/files/'.$file));
582 582
 		} else if ($node instanceof File) {
583
-			$size += $view->filesize('/files_trashbin/files/' . $file);
583
+			$size += $view->filesize('/files_trashbin/files/'.$file);
584 584
 		}
585 585
 
586
-		self::emitTrashbinPreDelete('/files_trashbin/files/' . $file);
586
+		self::emitTrashbinPreDelete('/files_trashbin/files/'.$file);
587 587
 		$node->delete();
588
-		self::emitTrashbinPostDelete('/files_trashbin/files/' . $file);
588
+		self::emitTrashbinPostDelete('/files_trashbin/files/'.$file);
589 589
 
590 590
 		return $size;
591 591
 	}
@@ -601,17 +601,17 @@  discard block
 block discarded – undo
601 601
 	private static function deleteVersions(View $view, $file, $filename, $timestamp, $user) {
602 602
 		$size = 0;
603 603
 		if (\OCP\App::isEnabled('files_versions')) {
604
-			if ($view->is_dir('files_trashbin/versions/' . $file)) {
605
-				$size += self::calculateSize(new View('/' . $user . '/files_trashbin/versions/' . $file));
606
-				$view->unlink('files_trashbin/versions/' . $file);
604
+			if ($view->is_dir('files_trashbin/versions/'.$file)) {
605
+				$size += self::calculateSize(new View('/'.$user.'/files_trashbin/versions/'.$file));
606
+				$view->unlink('files_trashbin/versions/'.$file);
607 607
 			} else if ($versions = self::getVersionsFromTrash($filename, $timestamp, $user)) {
608 608
 				foreach ($versions as $v) {
609 609
 					if ($timestamp) {
610
-						$size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp);
611
-						$view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v . '.d' . $timestamp);
610
+						$size += $view->filesize('/files_trashbin/versions/'.$filename.'.v'.$v.'.d'.$timestamp);
611
+						$view->unlink('/files_trashbin/versions/'.$filename.'.v'.$v.'.d'.$timestamp);
612 612
 					} else {
613
-						$size += $view->filesize('/files_trashbin/versions/' . $filename . '.v' . $v);
614
-						$view->unlink('/files_trashbin/versions/' . $filename . '.v' . $v);
613
+						$size += $view->filesize('/files_trashbin/versions/'.$filename.'.v'.$v);
614
+						$view->unlink('/files_trashbin/versions/'.$filename.'.v'.$v);
615 615
 					}
616 616
 				}
617 617
 			}
@@ -628,15 +628,15 @@  discard block
 block discarded – undo
628 628
 	 */
629 629
 	public static function file_exists($filename, $timestamp = null) {
630 630
 		$user = User::getUser();
631
-		$view = new View('/' . $user);
631
+		$view = new View('/'.$user);
632 632
 
633 633
 		if ($timestamp) {
634
-			$filename = $filename . '.d' . $timestamp;
634
+			$filename = $filename.'.d'.$timestamp;
635 635
 		} else {
636 636
 			$filename = $filename;
637 637
 		}
638 638
 
639
-		$target = Filesystem::normalizePath('files_trashbin/files/' . $filename);
639
+		$target = Filesystem::normalizePath('files_trashbin/files/'.$filename);
640 640
 		return $view->file_exists($target);
641 641
 	}
642 642
 
@@ -661,7 +661,7 @@  discard block
 block discarded – undo
661 661
 	private static function calculateFreeSpace($trashbinSize, $user) {
662 662
 		$softQuota = true;
663 663
 		$userObject = \OC::$server->getUserManager()->get($user);
664
-		if(is_null($userObject)) {
664
+		if (is_null($userObject)) {
665 665
 			return 0;
666 666
 		}
667 667
 		$quota = $userObject->getQuota();
@@ -680,7 +680,7 @@  discard block
 block discarded – undo
680 680
 		// subtract size of files and current trash bin size from quota
681 681
 		if ($softQuota) {
682 682
 			$userFolder = \OC::$server->getUserFolder($user);
683
-			if(is_null($userFolder)) {
683
+			if (is_null($userFolder)) {
684 684
 				return 0;
685 685
 			}
686 686
 			$free = $quota - $userFolder->getSize(); // remaining free space for user
@@ -762,7 +762,7 @@  discard block
 block discarded – undo
762 762
 			foreach ($files as $file) {
763 763
 				if ($availableSpace < 0 && $expiration->isExpired($file['mtime'], true)) {
764 764
 					$tmp = self::delete($file['name'], $user, $file['mtime']);
765
-					\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);
765
+					\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);
766 766
 					$availableSpace += $tmp;
767 767
 					$size += $tmp;
768 768
 				} else {
@@ -792,7 +792,7 @@  discard block
 block discarded – undo
792 792
 				$count++;
793 793
 				$size += self::delete($filename, $user, $timestamp);
794 794
 				\OC::$server->getLogger()->info(
795
-					'Remove "' . $filename . '" from trashbin because it exceeds max retention obligation term.',
795
+					'Remove "'.$filename.'" from trashbin because it exceeds max retention obligation term.',
796 796
 					['app' => 'files_trashbin']
797 797
 				);
798 798
 			} else {
@@ -818,16 +818,16 @@  discard block
 block discarded – undo
818 818
 			$view->mkdir($destination);
819 819
 			$view->touch($destination, $view->filemtime($source));
820 820
 			foreach ($view->getDirectoryContent($source) as $i) {
821
-				$pathDir = $source . '/' . $i['name'];
821
+				$pathDir = $source.'/'.$i['name'];
822 822
 				if ($view->is_dir($pathDir)) {
823
-					$size += self::copy_recursive($pathDir, $destination . '/' . $i['name'], $view);
823
+					$size += self::copy_recursive($pathDir, $destination.'/'.$i['name'], $view);
824 824
 				} else {
825 825
 					$size += $view->filesize($pathDir);
826
-					$result = $view->copy($pathDir, $destination . '/' . $i['name']);
826
+					$result = $view->copy($pathDir, $destination.'/'.$i['name']);
827 827
 					if (!$result) {
828 828
 						throw new \OCA\Files_Trashbin\Exceptions\CopyRecursiveException();
829 829
 					}
830
-					$view->touch($destination . '/' . $i['name'], $view->filemtime($pathDir));
830
+					$view->touch($destination.'/'.$i['name'], $view->filemtime($pathDir));
831 831
 				}
832 832
 			}
833 833
 		} else {
@@ -849,7 +849,7 @@  discard block
 block discarded – undo
849 849
 	 * @return array
850 850
 	 */
851 851
 	private static function getVersionsFromTrash($filename, $timestamp, $user) {
852
-		$view = new View('/' . $user . '/files_trashbin/versions');
852
+		$view = new View('/'.$user.'/files_trashbin/versions');
853 853
 		$versions = array();
854 854
 
855 855
 		//force rescan of versions, local storage may not have updated the cache
@@ -862,10 +862,10 @@  discard block
 block discarded – undo
862 862
 
863 863
 		if ($timestamp) {
864 864
 			// fetch for old versions
865
-			$matches = $view->searchRaw($filename . '.v%.d' . $timestamp);
865
+			$matches = $view->searchRaw($filename.'.v%.d'.$timestamp);
866 866
 			$offset = -strlen($timestamp) - 2;
867 867
 		} else {
868
-			$matches = $view->searchRaw($filename . '.v%');
868
+			$matches = $view->searchRaw($filename.'.v%');
869 869
 		}
870 870
 
871 871
 		if (is_array($matches)) {
@@ -895,18 +895,18 @@  discard block
 block discarded – undo
895 895
 		$name = pathinfo($filename, PATHINFO_FILENAME);
896 896
 		$l = \OC::$server->getL10N('files_trashbin');
897 897
 
898
-		$location = '/' . trim($location, '/');
898
+		$location = '/'.trim($location, '/');
899 899
 
900 900
 		// if extension is not empty we set a dot in front of it
901 901
 		if ($ext !== '') {
902
-			$ext = '.' . $ext;
902
+			$ext = '.'.$ext;
903 903
 		}
904 904
 
905
-		if ($view->file_exists('files' . $location . '/' . $filename)) {
905
+		if ($view->file_exists('files'.$location.'/'.$filename)) {
906 906
 			$i = 2;
907
-			$uniqueName = $name . " (" . $l->t("restored") . ")" . $ext;
908
-			while ($view->file_exists('files' . $location . '/' . $uniqueName)) {
909
-				$uniqueName = $name . " (" . $l->t("restored") . " " . $i . ")" . $ext;
907
+			$uniqueName = $name." (".$l->t("restored").")".$ext;
908
+			while ($view->file_exists('files'.$location.'/'.$uniqueName)) {
909
+				$uniqueName = $name." (".$l->t("restored")." ".$i.")".$ext;
910 910
 				$i++;
911 911
 			}
912 912
 
@@ -923,7 +923,7 @@  discard block
 block discarded – undo
923 923
 	 * @return integer size of the folder
924 924
 	 */
925 925
 	private static function calculateSize($view) {
926
-		$root = \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . $view->getAbsolutePath('');
926
+		$root = \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data').$view->getAbsolutePath('');
927 927
 		if (!file_exists($root)) {
928 928
 			return 0;
929 929
 		}
@@ -954,7 +954,7 @@  discard block
 block discarded – undo
954 954
 	 * @return integer trash bin size
955 955
 	 */
956 956
 	private static function getTrashbinSize($user) {
957
-		$view = new View('/' . $user);
957
+		$view = new View('/'.$user);
958 958
 		$fileInfo = $view->getFileInfo('/files_trashbin');
959 959
 		return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
960 960
 	}
@@ -983,7 +983,7 @@  discard block
 block discarded – undo
983 983
 	 */
984 984
 	public static function isEmpty($user) {
985 985
 
986
-		$view = new View('/' . $user . '/files_trashbin');
986
+		$view = new View('/'.$user.'/files_trashbin');
987 987
 		if ($view->is_dir('/files') && $dh = $view->opendir('/files')) {
988 988
 			while ($file = readdir($dh)) {
989 989
 				if (!Filesystem::isIgnoredDir($file)) {
Please login to merge, or discard this patch.
apps/testing/locking/provisioning.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -80,7 +80,7 @@
 block discarded – undo
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()
Please login to merge, or discard this patch.
Indentation   +190 added lines, -190 removed lines patch added patch discarded remove patch
@@ -35,194 +35,194 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
Spacing   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -87,7 +87,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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);
Please login to merge, or discard this patch.
apps/updatenotification/lib/Notification/Notifier.php 3 patches
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -102,6 +102,9 @@
 block discarded – undo
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
 	}
Please login to merge, or discard this patch.
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -91,7 +91,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 
Please login to merge, or discard this patch.
Indentation   +137 added lines, -137 removed lines patch added patch discarded remove patch
@@ -36,141 +36,141 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/Command/SetConfig.php 3 patches
Doc Comments   -2 removed lines patch added patch discarded remove patch
@@ -74,8 +74,6 @@
 block discarded – undo
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);
Please login to merge, or discard this patch.
Indentation   +46 added lines, -46 removed lines patch added patch discarded remove patch
@@ -34,53 +34,53 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -60,7 +60,7 @@
 block discarded – undo
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
 		}
Please login to merge, or discard this patch.
apps/user_ldap/lib/Jobs/UpdateGroups.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -77,7 +77,7 @@
 block discarded – undo
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
Please login to merge, or discard this patch.
Spacing   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -45,14 +45,14 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 
Please login to merge, or discard this patch.
Indentation   +164 added lines, -164 removed lines patch added patch discarded remove patch
@@ -41,183 +41,183 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
lib/private/AllConfig.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -112,7 +112,7 @@
 block discarded – undo
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 = '') {
Please login to merge, or discard this patch.
Indentation   +423 added lines, -423 removed lines patch added patch discarded remove patch
@@ -37,427 +37,427 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
Spacing   +14 added lines, -14 removed lines patch added patch discarded remove patch
@@ -87,7 +87,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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 {
Please login to merge, or discard this patch.
lib/private/App/CodeChecker/NodeVisitor.php 3 patches
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -296,6 +296,9 @@
 block discarded – undo
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);
Please login to merge, or discard this patch.
Indentation   +276 added lines, -276 removed lines patch added patch discarded remove patch
@@ -29,280 +29,280 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
Spacing   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -102,7 +102,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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(),
Please login to merge, or discard this patch.
lib/private/AppFramework/Http.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -110,7 +110,7 @@
 block discarded – undo
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
Please login to merge, or discard this patch.
Indentation   +115 added lines, -115 removed lines patch added patch discarded remove patch
@@ -33,121 +33,121 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
Spacing   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -41,7 +41,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 
Please login to merge, or discard this patch.