Completed
Pull Request — master (#3770)
by Thomas
38:05 queued 14:21
created
lib/private/AppFramework/Middleware/Security/SecurityMiddleware.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -102,7 +102,7 @@
 block discarded – undo
102 102
 	 * @param bool $isLoggedIn
103 103
 	 * @param bool $isAdminUser
104 104
 	 * @param ContentSecurityPolicyManager $contentSecurityPolicyManager
105
-	 * @param CSRFTokenManager $csrfTokenManager
105
+	 * @param CsrfTokenManager $csrfTokenManager
106 106
 	 * @param ContentSecurityPolicyNonceManager $cspNonceManager
107 107
 	 * @param Throttler $throttler
108 108
 	 */
Please login to merge, or discard this patch.
Indentation   +190 added lines, -190 removed lines patch added patch discarded remove patch
@@ -64,219 +64,219 @@
 block discarded – undo
64 64
  * check fails
65 65
  */
66 66
 class SecurityMiddleware extends Middleware {
67
-	/** @var INavigationManager */
68
-	private $navigationManager;
69
-	/** @var IRequest */
70
-	private $request;
71
-	/** @var ControllerMethodReflector */
72
-	private $reflector;
73
-	/** @var string */
74
-	private $appName;
75
-	/** @var IURLGenerator */
76
-	private $urlGenerator;
77
-	/** @var ILogger */
78
-	private $logger;
79
-	/** @var ISession */
80
-	private $session;
81
-	/** @var bool */
82
-	private $isLoggedIn;
83
-	/** @var bool */
84
-	private $isAdminUser;
85
-	/** @var ContentSecurityPolicyManager */
86
-	private $contentSecurityPolicyManager;
87
-	/** @var CsrfTokenManager */
88
-	private $csrfTokenManager;
89
-	/** @var ContentSecurityPolicyNonceManager */
90
-	private $cspNonceManager;
91
-	/** @var Throttler */
92
-	private $throttler;
67
+    /** @var INavigationManager */
68
+    private $navigationManager;
69
+    /** @var IRequest */
70
+    private $request;
71
+    /** @var ControllerMethodReflector */
72
+    private $reflector;
73
+    /** @var string */
74
+    private $appName;
75
+    /** @var IURLGenerator */
76
+    private $urlGenerator;
77
+    /** @var ILogger */
78
+    private $logger;
79
+    /** @var ISession */
80
+    private $session;
81
+    /** @var bool */
82
+    private $isLoggedIn;
83
+    /** @var bool */
84
+    private $isAdminUser;
85
+    /** @var ContentSecurityPolicyManager */
86
+    private $contentSecurityPolicyManager;
87
+    /** @var CsrfTokenManager */
88
+    private $csrfTokenManager;
89
+    /** @var ContentSecurityPolicyNonceManager */
90
+    private $cspNonceManager;
91
+    /** @var Throttler */
92
+    private $throttler;
93 93
 
94
-	/**
95
-	 * @param IRequest $request
96
-	 * @param ControllerMethodReflector $reflector
97
-	 * @param INavigationManager $navigationManager
98
-	 * @param IURLGenerator $urlGenerator
99
-	 * @param ILogger $logger
100
-	 * @param ISession $session
101
-	 * @param string $appName
102
-	 * @param bool $isLoggedIn
103
-	 * @param bool $isAdminUser
104
-	 * @param ContentSecurityPolicyManager $contentSecurityPolicyManager
105
-	 * @param CSRFTokenManager $csrfTokenManager
106
-	 * @param ContentSecurityPolicyNonceManager $cspNonceManager
107
-	 * @param Throttler $throttler
108
-	 */
109
-	public function __construct(IRequest $request,
110
-								ControllerMethodReflector $reflector,
111
-								INavigationManager $navigationManager,
112
-								IURLGenerator $urlGenerator,
113
-								ILogger $logger,
114
-								ISession $session,
115
-								$appName,
116
-								$isLoggedIn,
117
-								$isAdminUser,
118
-								ContentSecurityPolicyManager $contentSecurityPolicyManager,
119
-								CsrfTokenManager $csrfTokenManager,
120
-								ContentSecurityPolicyNonceManager $cspNonceManager,
121
-								Throttler $throttler) {
122
-		$this->navigationManager = $navigationManager;
123
-		$this->request = $request;
124
-		$this->reflector = $reflector;
125
-		$this->appName = $appName;
126
-		$this->urlGenerator = $urlGenerator;
127
-		$this->logger = $logger;
128
-		$this->session = $session;
129
-		$this->isLoggedIn = $isLoggedIn;
130
-		$this->isAdminUser = $isAdminUser;
131
-		$this->contentSecurityPolicyManager = $contentSecurityPolicyManager;
132
-		$this->csrfTokenManager = $csrfTokenManager;
133
-		$this->cspNonceManager = $cspNonceManager;
134
-		$this->throttler = $throttler;
135
-	}
94
+    /**
95
+     * @param IRequest $request
96
+     * @param ControllerMethodReflector $reflector
97
+     * @param INavigationManager $navigationManager
98
+     * @param IURLGenerator $urlGenerator
99
+     * @param ILogger $logger
100
+     * @param ISession $session
101
+     * @param string $appName
102
+     * @param bool $isLoggedIn
103
+     * @param bool $isAdminUser
104
+     * @param ContentSecurityPolicyManager $contentSecurityPolicyManager
105
+     * @param CSRFTokenManager $csrfTokenManager
106
+     * @param ContentSecurityPolicyNonceManager $cspNonceManager
107
+     * @param Throttler $throttler
108
+     */
109
+    public function __construct(IRequest $request,
110
+                                ControllerMethodReflector $reflector,
111
+                                INavigationManager $navigationManager,
112
+                                IURLGenerator $urlGenerator,
113
+                                ILogger $logger,
114
+                                ISession $session,
115
+                                $appName,
116
+                                $isLoggedIn,
117
+                                $isAdminUser,
118
+                                ContentSecurityPolicyManager $contentSecurityPolicyManager,
119
+                                CsrfTokenManager $csrfTokenManager,
120
+                                ContentSecurityPolicyNonceManager $cspNonceManager,
121
+                                Throttler $throttler) {
122
+        $this->navigationManager = $navigationManager;
123
+        $this->request = $request;
124
+        $this->reflector = $reflector;
125
+        $this->appName = $appName;
126
+        $this->urlGenerator = $urlGenerator;
127
+        $this->logger = $logger;
128
+        $this->session = $session;
129
+        $this->isLoggedIn = $isLoggedIn;
130
+        $this->isAdminUser = $isAdminUser;
131
+        $this->contentSecurityPolicyManager = $contentSecurityPolicyManager;
132
+        $this->csrfTokenManager = $csrfTokenManager;
133
+        $this->cspNonceManager = $cspNonceManager;
134
+        $this->throttler = $throttler;
135
+    }
136 136
 
137 137
 
138
-	/**
139
-	 * This runs all the security checks before a method call. The
140
-	 * security checks are determined by inspecting the controller method
141
-	 * annotations
142
-	 * @param Controller $controller the controller
143
-	 * @param string $methodName the name of the method
144
-	 * @throws SecurityException when a security check fails
145
-	 */
146
-	public function beforeController($controller, $methodName) {
138
+    /**
139
+     * This runs all the security checks before a method call. The
140
+     * security checks are determined by inspecting the controller method
141
+     * annotations
142
+     * @param Controller $controller the controller
143
+     * @param string $methodName the name of the method
144
+     * @throws SecurityException when a security check fails
145
+     */
146
+    public function beforeController($controller, $methodName) {
147 147
 
148
-		// this will set the current navigation entry of the app, use this only
149
-		// for normal HTML requests and not for AJAX requests
150
-		$this->navigationManager->setActiveEntry($this->appName);
148
+        // this will set the current navigation entry of the app, use this only
149
+        // for normal HTML requests and not for AJAX requests
150
+        $this->navigationManager->setActiveEntry($this->appName);
151 151
 
152
-		// security checks
153
-		$isPublicPage = $this->reflector->hasAnnotation('PublicPage');
154
-		if(!$isPublicPage) {
155
-			if(!$this->isLoggedIn) {
156
-				throw new NotLoggedInException();
157
-			}
152
+        // security checks
153
+        $isPublicPage = $this->reflector->hasAnnotation('PublicPage');
154
+        if(!$isPublicPage) {
155
+            if(!$this->isLoggedIn) {
156
+                throw new NotLoggedInException();
157
+            }
158 158
 
159
-			if(!$this->reflector->hasAnnotation('NoAdminRequired')) {
160
-				if(!$this->isAdminUser) {
161
-					throw new NotAdminException();
162
-				}
163
-			}
164
-		}
159
+            if(!$this->reflector->hasAnnotation('NoAdminRequired')) {
160
+                if(!$this->isAdminUser) {
161
+                    throw new NotAdminException();
162
+                }
163
+            }
164
+        }
165 165
 
166
-		if ($this->reflector->hasAnnotation('PasswordConfirmationRequired')) {
167
-			$lastConfirm = (int) $this->session->get('last-password-confirm');
168
-			if ($lastConfirm < (time() - (30 * 60 + 15))) { // allow 15 seconds delay
169
-				throw new NotConfirmedException();
170
-			}
171
-		}
166
+        if ($this->reflector->hasAnnotation('PasswordConfirmationRequired')) {
167
+            $lastConfirm = (int) $this->session->get('last-password-confirm');
168
+            if ($lastConfirm < (time() - (30 * 60 + 15))) { // allow 15 seconds delay
169
+                throw new NotConfirmedException();
170
+            }
171
+        }
172 172
 
173
-		// Check for strict cookie requirement
174
-		if($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) {
175
-			if(!$this->request->passesStrictCookieCheck()) {
176
-				throw new StrictCookieMissingException();
177
-			}
178
-		}
179
-		// CSRF check - also registers the CSRF token since the session may be closed later
180
-		Util::callRegister();
181
-		if(!$this->reflector->hasAnnotation('NoCSRFRequired')) {
182
-			/*
173
+        // Check for strict cookie requirement
174
+        if($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) {
175
+            if(!$this->request->passesStrictCookieCheck()) {
176
+                throw new StrictCookieMissingException();
177
+            }
178
+        }
179
+        // CSRF check - also registers the CSRF token since the session may be closed later
180
+        Util::callRegister();
181
+        if(!$this->reflector->hasAnnotation('NoCSRFRequired')) {
182
+            /*
183 183
 			 * Only allow the CSRF check to fail on OCS Requests. This kind of
184 184
 			 * hacks around that we have no full token auth in place yet and we
185 185
 			 * do want to offer CSRF checks for web requests.
186 186
 			 */
187
-			if(!$this->request->passesCSRFCheck() && !(
188
-					$controller instanceof OCSController &&
189
-					$this->request->getHeader('OCS-APIREQUEST') === 'true')) {
190
-				throw new CrossSiteRequestForgeryException();
191
-			}
192
-		}
187
+            if(!$this->request->passesCSRFCheck() && !(
188
+                    $controller instanceof OCSController &&
189
+                    $this->request->getHeader('OCS-APIREQUEST') === 'true')) {
190
+                throw new CrossSiteRequestForgeryException();
191
+            }
192
+        }
193 193
 
194
-		if($this->reflector->hasAnnotation('BruteForceProtection')) {
195
-			$action = $this->reflector->getAnnotationParameter('BruteForceProtection');
196
-			$this->throttler->sleepDelay($this->request->getRemoteAddress(), $action);
197
-			$this->throttler->registerAttempt($action, $this->request->getRemoteAddress());
198
-		}
194
+        if($this->reflector->hasAnnotation('BruteForceProtection')) {
195
+            $action = $this->reflector->getAnnotationParameter('BruteForceProtection');
196
+            $this->throttler->sleepDelay($this->request->getRemoteAddress(), $action);
197
+            $this->throttler->registerAttempt($action, $this->request->getRemoteAddress());
198
+        }
199 199
 
200
-		/**
201
-		 * FIXME: Use DI once available
202
-		 * Checks if app is enabled (also includes a check whether user is allowed to access the resource)
203
-		 * The getAppPath() check is here since components such as settings also use the AppFramework and
204
-		 * therefore won't pass this check.
205
-		 */
206
-		if(\OC_App::getAppPath($this->appName) !== false && !\OC_App::isEnabled($this->appName)) {
207
-			throw new AppNotEnabledException();
208
-		}
200
+        /**
201
+         * FIXME: Use DI once available
202
+         * Checks if app is enabled (also includes a check whether user is allowed to access the resource)
203
+         * The getAppPath() check is here since components such as settings also use the AppFramework and
204
+         * therefore won't pass this check.
205
+         */
206
+        if(\OC_App::getAppPath($this->appName) !== false && !\OC_App::isEnabled($this->appName)) {
207
+            throw new AppNotEnabledException();
208
+        }
209 209
 
210
-	}
210
+    }
211 211
 
212
-	/**
213
-	 * Performs the default CSP modifications that may be injected by other
214
-	 * applications
215
-	 *
216
-	 * @param Controller $controller
217
-	 * @param string $methodName
218
-	 * @param Response $response
219
-	 * @return Response
220
-	 */
221
-	public function afterController($controller, $methodName, Response $response) {
222
-		$policy = !is_null($response->getContentSecurityPolicy()) ? $response->getContentSecurityPolicy() : new ContentSecurityPolicy();
212
+    /**
213
+     * Performs the default CSP modifications that may be injected by other
214
+     * applications
215
+     *
216
+     * @param Controller $controller
217
+     * @param string $methodName
218
+     * @param Response $response
219
+     * @return Response
220
+     */
221
+    public function afterController($controller, $methodName, Response $response) {
222
+        $policy = !is_null($response->getContentSecurityPolicy()) ? $response->getContentSecurityPolicy() : new ContentSecurityPolicy();
223 223
 
224
-		if (get_class($policy) === EmptyContentSecurityPolicy::class) {
225
-			return $response;
226
-		}
224
+        if (get_class($policy) === EmptyContentSecurityPolicy::class) {
225
+            return $response;
226
+        }
227 227
 
228
-		$defaultPolicy = $this->contentSecurityPolicyManager->getDefaultPolicy();
229
-		$defaultPolicy = $this->contentSecurityPolicyManager->mergePolicies($defaultPolicy, $policy);
228
+        $defaultPolicy = $this->contentSecurityPolicyManager->getDefaultPolicy();
229
+        $defaultPolicy = $this->contentSecurityPolicyManager->mergePolicies($defaultPolicy, $policy);
230 230
 
231
-		if($this->cspNonceManager->browserSupportsCspV3()) {
232
-			$defaultPolicy->useJsNonce($this->csrfTokenManager->getToken()->getEncryptedValue());
233
-		}
231
+        if($this->cspNonceManager->browserSupportsCspV3()) {
232
+            $defaultPolicy->useJsNonce($this->csrfTokenManager->getToken()->getEncryptedValue());
233
+        }
234 234
 
235
-		$response->setContentSecurityPolicy($defaultPolicy);
235
+        $response->setContentSecurityPolicy($defaultPolicy);
236 236
 
237
-		return $response;
238
-	}
237
+        return $response;
238
+    }
239 239
 
240
-	/**
241
-	 * If an SecurityException is being caught, ajax requests return a JSON error
242
-	 * response and non ajax requests redirect to the index
243
-	 * @param Controller $controller the controller that is being called
244
-	 * @param string $methodName the name of the method that will be called on
245
-	 *                           the controller
246
-	 * @param \Exception $exception the thrown exception
247
-	 * @throws \Exception the passed in exception if it can't handle it
248
-	 * @return Response a Response object or null in case that the exception could not be handled
249
-	 */
250
-	public function afterException($controller, $methodName, \Exception $exception) {
251
-		if($exception instanceof SecurityException) {
252
-			if($exception instanceof StrictCookieMissingException) {
253
-				return new RedirectResponse(\OC::$WEBROOT);
254
- 			}
255
-			if (stripos($this->request->getHeader('Accept'),'html') === false) {
256
-				$response = new JSONResponse(
257
-					array('message' => $exception->getMessage()),
258
-					$exception->getCode()
259
-				);
260
-			} else {
261
-				if($exception instanceof NotLoggedInException) {
262
-					$url = $this->urlGenerator->linkToRoute(
263
-						'core.login.showLoginForm',
264
-						[
265
-							'redirect_url' => $this->request->server['REQUEST_URI'],
266
-						]
267
-					);
268
-					$response = new RedirectResponse($url);
269
-				} else {
270
-					$response = new TemplateResponse('core', '403', ['file' => $exception->getMessage()], 'guest');
271
-					$response->setStatus($exception->getCode());
272
-				}
273
-			}
240
+    /**
241
+     * If an SecurityException is being caught, ajax requests return a JSON error
242
+     * response and non ajax requests redirect to the index
243
+     * @param Controller $controller the controller that is being called
244
+     * @param string $methodName the name of the method that will be called on
245
+     *                           the controller
246
+     * @param \Exception $exception the thrown exception
247
+     * @throws \Exception the passed in exception if it can't handle it
248
+     * @return Response a Response object or null in case that the exception could not be handled
249
+     */
250
+    public function afterException($controller, $methodName, \Exception $exception) {
251
+        if($exception instanceof SecurityException) {
252
+            if($exception instanceof StrictCookieMissingException) {
253
+                return new RedirectResponse(\OC::$WEBROOT);
254
+                }
255
+            if (stripos($this->request->getHeader('Accept'),'html') === false) {
256
+                $response = new JSONResponse(
257
+                    array('message' => $exception->getMessage()),
258
+                    $exception->getCode()
259
+                );
260
+            } else {
261
+                if($exception instanceof NotLoggedInException) {
262
+                    $url = $this->urlGenerator->linkToRoute(
263
+                        'core.login.showLoginForm',
264
+                        [
265
+                            'redirect_url' => $this->request->server['REQUEST_URI'],
266
+                        ]
267
+                    );
268
+                    $response = new RedirectResponse($url);
269
+                } else {
270
+                    $response = new TemplateResponse('core', '403', ['file' => $exception->getMessage()], 'guest');
271
+                    $response->setStatus($exception->getCode());
272
+                }
273
+            }
274 274
 
275
-			$this->logger->debug($exception->getMessage());
276
-			return $response;
277
-		}
275
+            $this->logger->debug($exception->getMessage());
276
+            return $response;
277
+        }
278 278
 
279
-		throw $exception;
280
-	}
279
+        throw $exception;
280
+    }
281 281
 
282 282
 }
Please login to merge, or discard this patch.
Spacing   +15 added lines, -15 removed lines patch added patch discarded remove patch
@@ -151,13 +151,13 @@  discard block
 block discarded – undo
151 151
 
152 152
 		// security checks
153 153
 		$isPublicPage = $this->reflector->hasAnnotation('PublicPage');
154
-		if(!$isPublicPage) {
155
-			if(!$this->isLoggedIn) {
154
+		if (!$isPublicPage) {
155
+			if (!$this->isLoggedIn) {
156 156
 				throw new NotLoggedInException();
157 157
 			}
158 158
 
159
-			if(!$this->reflector->hasAnnotation('NoAdminRequired')) {
160
-				if(!$this->isAdminUser) {
159
+			if (!$this->reflector->hasAnnotation('NoAdminRequired')) {
160
+				if (!$this->isAdminUser) {
161 161
 					throw new NotAdminException();
162 162
 				}
163 163
 			}
@@ -171,27 +171,27 @@  discard block
 block discarded – undo
171 171
 		}
172 172
 
173 173
 		// Check for strict cookie requirement
174
-		if($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) {
175
-			if(!$this->request->passesStrictCookieCheck()) {
174
+		if ($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) {
175
+			if (!$this->request->passesStrictCookieCheck()) {
176 176
 				throw new StrictCookieMissingException();
177 177
 			}
178 178
 		}
179 179
 		// CSRF check - also registers the CSRF token since the session may be closed later
180 180
 		Util::callRegister();
181
-		if(!$this->reflector->hasAnnotation('NoCSRFRequired')) {
181
+		if (!$this->reflector->hasAnnotation('NoCSRFRequired')) {
182 182
 			/*
183 183
 			 * Only allow the CSRF check to fail on OCS Requests. This kind of
184 184
 			 * hacks around that we have no full token auth in place yet and we
185 185
 			 * do want to offer CSRF checks for web requests.
186 186
 			 */
187
-			if(!$this->request->passesCSRFCheck() && !(
187
+			if (!$this->request->passesCSRFCheck() && !(
188 188
 					$controller instanceof OCSController &&
189 189
 					$this->request->getHeader('OCS-APIREQUEST') === 'true')) {
190 190
 				throw new CrossSiteRequestForgeryException();
191 191
 			}
192 192
 		}
193 193
 
194
-		if($this->reflector->hasAnnotation('BruteForceProtection')) {
194
+		if ($this->reflector->hasAnnotation('BruteForceProtection')) {
195 195
 			$action = $this->reflector->getAnnotationParameter('BruteForceProtection');
196 196
 			$this->throttler->sleepDelay($this->request->getRemoteAddress(), $action);
197 197
 			$this->throttler->registerAttempt($action, $this->request->getRemoteAddress());
@@ -203,7 +203,7 @@  discard block
 block discarded – undo
203 203
 		 * The getAppPath() check is here since components such as settings also use the AppFramework and
204 204
 		 * therefore won't pass this check.
205 205
 		 */
206
-		if(\OC_App::getAppPath($this->appName) !== false && !\OC_App::isEnabled($this->appName)) {
206
+		if (\OC_App::getAppPath($this->appName) !== false && !\OC_App::isEnabled($this->appName)) {
207 207
 			throw new AppNotEnabledException();
208 208
 		}
209 209
 
@@ -228,7 +228,7 @@  discard block
 block discarded – undo
228 228
 		$defaultPolicy = $this->contentSecurityPolicyManager->getDefaultPolicy();
229 229
 		$defaultPolicy = $this->contentSecurityPolicyManager->mergePolicies($defaultPolicy, $policy);
230 230
 
231
-		if($this->cspNonceManager->browserSupportsCspV3()) {
231
+		if ($this->cspNonceManager->browserSupportsCspV3()) {
232 232
 			$defaultPolicy->useJsNonce($this->csrfTokenManager->getToken()->getEncryptedValue());
233 233
 		}
234 234
 
@@ -248,17 +248,17 @@  discard block
 block discarded – undo
248 248
 	 * @return Response a Response object or null in case that the exception could not be handled
249 249
 	 */
250 250
 	public function afterException($controller, $methodName, \Exception $exception) {
251
-		if($exception instanceof SecurityException) {
252
-			if($exception instanceof StrictCookieMissingException) {
251
+		if ($exception instanceof SecurityException) {
252
+			if ($exception instanceof StrictCookieMissingException) {
253 253
 				return new RedirectResponse(\OC::$WEBROOT);
254 254
  			}
255
-			if (stripos($this->request->getHeader('Accept'),'html') === false) {
255
+			if (stripos($this->request->getHeader('Accept'), 'html') === false) {
256 256
 				$response = new JSONResponse(
257 257
 					array('message' => $exception->getMessage()),
258 258
 					$exception->getCode()
259 259
 				);
260 260
 			} else {
261
-				if($exception instanceof NotLoggedInException) {
261
+				if ($exception instanceof NotLoggedInException) {
262 262
 					$url = $this->urlGenerator->linkToRoute(
263 263
 						'core.login.showLoginForm',
264 264
 						[
Please login to merge, or discard this patch.
lib/private/Archive/ZIP.php 4 patches
Doc Comments   +1 added lines patch added patch discarded remove patch
@@ -370,6 +370,7 @@
 block discarded – undo
370 370
 
371 371
 	/**
372 372
 	 * write back temporary files
373
+	 * @param string $path
373 374
 	 */
374 375
 	function writeBack($tmpFile, $path) {
375 376
 		$this->addFile($path, $tmpFile);
Please login to merge, or discard this patch.
Indentation   +192 added lines, -192 removed lines patch added patch discarded remove patch
@@ -34,199 +34,199 @@
 block discarded – undo
34 34
 use Icewind\Streams\CallbackWrapper;
35 35
 
36 36
 class ZIP extends Archive{
37
-	/**
38
-	 * @var \ZipArchive zip
39
-	 */
40
-	private $zip=null;
41
-	private $path;
37
+    /**
38
+     * @var \ZipArchive zip
39
+     */
40
+    private $zip=null;
41
+    private $path;
42 42
 
43
-	/**
44
-	 * @param string $source
45
-	 */
46
-	function __construct($source) {
47
-		$this->path=$source;
48
-		$this->zip=new \ZipArchive();
49
-		if($this->zip->open($source, \ZipArchive::CREATE)) {
50
-		}else{
51
-			\OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, \OCP\Util::WARN);
52
-		}
53
-	}
54
-	/**
55
-	 * add an empty folder to the archive
56
-	 * @param string $path
57
-	 * @return bool
58
-	 */
59
-	function addFolder($path) {
60
-		return $this->zip->addEmptyDir($path);
61
-	}
62
-	/**
63
-	 * add a file to the archive
64
-	 * @param string $path
65
-	 * @param string $source either a local file or string data
66
-	 * @return bool
67
-	 */
68
-	function addFile($path, $source='') {
69
-		if($source and $source[0]=='/' and file_exists($source)) {
70
-			$result=$this->zip->addFile($source, $path);
71
-		}else{
72
-			$result=$this->zip->addFromString($path, $source);
73
-		}
74
-		if($result) {
75
-			$this->zip->close();//close and reopen to save the zip
76
-			$this->zip->open($this->path);
77
-		}
78
-		return $result;
79
-	}
80
-	/**
81
-	 * rename a file or folder in the archive
82
-	 * @param string $source
83
-	 * @param string $dest
84
-	 * @return boolean|null
85
-	 */
86
-	function rename($source, $dest) {
87
-		$source=$this->stripPath($source);
88
-		$dest=$this->stripPath($dest);
89
-		$this->zip->renameName($source, $dest);
90
-	}
91
-	/**
92
-	 * get the uncompressed size of a file in the archive
93
-	 * @param string $path
94
-	 * @return int
95
-	 */
96
-	function filesize($path) {
97
-		$stat=$this->zip->statName($path);
98
-		return $stat['size'];
99
-	}
100
-	/**
101
-	 * get the last modified time of a file in the archive
102
-	 * @param string $path
103
-	 * @return int
104
-	 */
105
-	function mtime($path) {
106
-		return filemtime($this->path);
107
-	}
108
-	/**
109
-	 * get the files in a folder
110
-	 * @param string $path
111
-	 * @return array
112
-	 */
113
-	function getFolder($path) {
114
-		$files=$this->getFiles();
115
-		$folderContent=array();
116
-		$pathLength=strlen($path);
117
-		foreach($files as $file) {
118
-			if(substr($file, 0, $pathLength)==$path and $file!=$path) {
119
-				if(strrpos(substr($file, 0, -1), '/')<=$pathLength) {
120
-					$folderContent[]=substr($file, $pathLength);
121
-				}
122
-			}
123
-		}
124
-		return $folderContent;
125
-	}
126
-	/**
127
-	 * get all files in the archive
128
-	 * @return array
129
-	 */
130
-	function getFiles() {
131
-		$fileCount=$this->zip->numFiles;
132
-		$files=array();
133
-		for($i=0;$i<$fileCount;$i++) {
134
-			$files[]=$this->zip->getNameIndex($i);
135
-		}
136
-		return $files;
137
-	}
138
-	/**
139
-	 * get the content of a file
140
-	 * @param string $path
141
-	 * @return string
142
-	 */
143
-	function getFile($path) {
144
-		return $this->zip->getFromName($path);
145
-	}
146
-	/**
147
-	 * extract a single file from the archive
148
-	 * @param string $path
149
-	 * @param string $dest
150
-	 * @return boolean|null
151
-	 */
152
-	function extractFile($path, $dest) {
153
-		$fp = $this->zip->getStream($path);
154
-		file_put_contents($dest, $fp);
155
-	}
156
-	/**
157
-	 * extract the archive
158
-	 * @param string $dest
159
-	 * @return bool
160
-	 */
161
-	function extract($dest) {
162
-		return $this->zip->extractTo($dest);
163
-	}
164
-	/**
165
-	 * check if a file or folder exists in the archive
166
-	 * @param string $path
167
-	 * @return bool
168
-	 */
169
-	function fileExists($path) {
170
-		return ($this->zip->locateName($path)!==false) or ($this->zip->locateName($path.'/')!==false);
171
-	}
172
-	/**
173
-	 * remove a file or folder from the archive
174
-	 * @param string $path
175
-	 * @return bool
176
-	 */
177
-	function remove($path) {
178
-		if($this->fileExists($path.'/')) {
179
-			return $this->zip->deleteName($path.'/');
180
-		}else{
181
-			return $this->zip->deleteName($path);
182
-		}
183
-	}
184
-	/**
185
-	 * get a file handler
186
-	 * @param string $path
187
-	 * @param string $mode
188
-	 * @return resource
189
-	 */
190
-	function getStream($path, $mode) {
191
-		if($mode=='r' or $mode=='rb') {
192
-			return $this->zip->getStream($path);
193
-		} else {
194
-			//since we can't directly get a writable stream,
195
-			//make a temp copy of the file and put it back
196
-			//in the archive when the stream is closed
197
-			if(strrpos($path, '.')!==false) {
198
-				$ext=substr($path, strrpos($path, '.'));
199
-			}else{
200
-				$ext='';
201
-			}
202
-			$tmpFile=\OCP\Files::tmpFile($ext);
203
-			if($this->fileExists($path)) {
204
-				$this->extractFile($path, $tmpFile);
205
-			}
206
-			$handle = fopen($tmpFile, $mode);
207
-			return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
208
-				$this->writeBack($tmpFile, $path);
209
-			});
210
-		}
211
-	}
43
+    /**
44
+     * @param string $source
45
+     */
46
+    function __construct($source) {
47
+        $this->path=$source;
48
+        $this->zip=new \ZipArchive();
49
+        if($this->zip->open($source, \ZipArchive::CREATE)) {
50
+        }else{
51
+            \OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, \OCP\Util::WARN);
52
+        }
53
+    }
54
+    /**
55
+     * add an empty folder to the archive
56
+     * @param string $path
57
+     * @return bool
58
+     */
59
+    function addFolder($path) {
60
+        return $this->zip->addEmptyDir($path);
61
+    }
62
+    /**
63
+     * add a file to the archive
64
+     * @param string $path
65
+     * @param string $source either a local file or string data
66
+     * @return bool
67
+     */
68
+    function addFile($path, $source='') {
69
+        if($source and $source[0]=='/' and file_exists($source)) {
70
+            $result=$this->zip->addFile($source, $path);
71
+        }else{
72
+            $result=$this->zip->addFromString($path, $source);
73
+        }
74
+        if($result) {
75
+            $this->zip->close();//close and reopen to save the zip
76
+            $this->zip->open($this->path);
77
+        }
78
+        return $result;
79
+    }
80
+    /**
81
+     * rename a file or folder in the archive
82
+     * @param string $source
83
+     * @param string $dest
84
+     * @return boolean|null
85
+     */
86
+    function rename($source, $dest) {
87
+        $source=$this->stripPath($source);
88
+        $dest=$this->stripPath($dest);
89
+        $this->zip->renameName($source, $dest);
90
+    }
91
+    /**
92
+     * get the uncompressed size of a file in the archive
93
+     * @param string $path
94
+     * @return int
95
+     */
96
+    function filesize($path) {
97
+        $stat=$this->zip->statName($path);
98
+        return $stat['size'];
99
+    }
100
+    /**
101
+     * get the last modified time of a file in the archive
102
+     * @param string $path
103
+     * @return int
104
+     */
105
+    function mtime($path) {
106
+        return filemtime($this->path);
107
+    }
108
+    /**
109
+     * get the files in a folder
110
+     * @param string $path
111
+     * @return array
112
+     */
113
+    function getFolder($path) {
114
+        $files=$this->getFiles();
115
+        $folderContent=array();
116
+        $pathLength=strlen($path);
117
+        foreach($files as $file) {
118
+            if(substr($file, 0, $pathLength)==$path and $file!=$path) {
119
+                if(strrpos(substr($file, 0, -1), '/')<=$pathLength) {
120
+                    $folderContent[]=substr($file, $pathLength);
121
+                }
122
+            }
123
+        }
124
+        return $folderContent;
125
+    }
126
+    /**
127
+     * get all files in the archive
128
+     * @return array
129
+     */
130
+    function getFiles() {
131
+        $fileCount=$this->zip->numFiles;
132
+        $files=array();
133
+        for($i=0;$i<$fileCount;$i++) {
134
+            $files[]=$this->zip->getNameIndex($i);
135
+        }
136
+        return $files;
137
+    }
138
+    /**
139
+     * get the content of a file
140
+     * @param string $path
141
+     * @return string
142
+     */
143
+    function getFile($path) {
144
+        return $this->zip->getFromName($path);
145
+    }
146
+    /**
147
+     * extract a single file from the archive
148
+     * @param string $path
149
+     * @param string $dest
150
+     * @return boolean|null
151
+     */
152
+    function extractFile($path, $dest) {
153
+        $fp = $this->zip->getStream($path);
154
+        file_put_contents($dest, $fp);
155
+    }
156
+    /**
157
+     * extract the archive
158
+     * @param string $dest
159
+     * @return bool
160
+     */
161
+    function extract($dest) {
162
+        return $this->zip->extractTo($dest);
163
+    }
164
+    /**
165
+     * check if a file or folder exists in the archive
166
+     * @param string $path
167
+     * @return bool
168
+     */
169
+    function fileExists($path) {
170
+        return ($this->zip->locateName($path)!==false) or ($this->zip->locateName($path.'/')!==false);
171
+    }
172
+    /**
173
+     * remove a file or folder from the archive
174
+     * @param string $path
175
+     * @return bool
176
+     */
177
+    function remove($path) {
178
+        if($this->fileExists($path.'/')) {
179
+            return $this->zip->deleteName($path.'/');
180
+        }else{
181
+            return $this->zip->deleteName($path);
182
+        }
183
+    }
184
+    /**
185
+     * get a file handler
186
+     * @param string $path
187
+     * @param string $mode
188
+     * @return resource
189
+     */
190
+    function getStream($path, $mode) {
191
+        if($mode=='r' or $mode=='rb') {
192
+            return $this->zip->getStream($path);
193
+        } else {
194
+            //since we can't directly get a writable stream,
195
+            //make a temp copy of the file and put it back
196
+            //in the archive when the stream is closed
197
+            if(strrpos($path, '.')!==false) {
198
+                $ext=substr($path, strrpos($path, '.'));
199
+            }else{
200
+                $ext='';
201
+            }
202
+            $tmpFile=\OCP\Files::tmpFile($ext);
203
+            if($this->fileExists($path)) {
204
+                $this->extractFile($path, $tmpFile);
205
+            }
206
+            $handle = fopen($tmpFile, $mode);
207
+            return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
208
+                $this->writeBack($tmpFile, $path);
209
+            });
210
+        }
211
+    }
212 212
 
213
-	/**
214
-	 * write back temporary files
215
-	 */
216
-	function writeBack($tmpFile, $path) {
217
-		$this->addFile($path, $tmpFile);
218
-		unlink($tmpFile);
219
-	}
213
+    /**
214
+     * write back temporary files
215
+     */
216
+    function writeBack($tmpFile, $path) {
217
+        $this->addFile($path, $tmpFile);
218
+        unlink($tmpFile);
219
+    }
220 220
 
221
-	/**
222
-	 * @param string $path
223
-	 * @return string
224
-	 */
225
-	private function stripPath($path) {
226
-		if(!$path || $path[0]=='/') {
227
-			return substr($path, 1);
228
-		}else{
229
-			return $path;
230
-		}
231
-	}
221
+    /**
222
+     * @param string $path
223
+     * @return string
224
+     */
225
+    private function stripPath($path) {
226
+        if(!$path || $path[0]=='/') {
227
+            return substr($path, 1);
228
+        }else{
229
+            return $path;
230
+        }
231
+    }
232 232
 }
Please login to merge, or discard this patch.
Spacing   +40 added lines, -40 removed lines patch added patch discarded remove patch
@@ -33,21 +33,21 @@  discard block
 block discarded – undo
33 33
 
34 34
 use Icewind\Streams\CallbackWrapper;
35 35
 
36
-class ZIP extends Archive{
36
+class ZIP extends Archive {
37 37
 	/**
38 38
 	 * @var \ZipArchive zip
39 39
 	 */
40
-	private $zip=null;
40
+	private $zip = null;
41 41
 	private $path;
42 42
 
43 43
 	/**
44 44
 	 * @param string $source
45 45
 	 */
46 46
 	function __construct($source) {
47
-		$this->path=$source;
48
-		$this->zip=new \ZipArchive();
49
-		if($this->zip->open($source, \ZipArchive::CREATE)) {
50
-		}else{
47
+		$this->path = $source;
48
+		$this->zip = new \ZipArchive();
49
+		if ($this->zip->open($source, \ZipArchive::CREATE)) {
50
+		} else {
51 51
 			\OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, \OCP\Util::WARN);
52 52
 		}
53 53
 	}
@@ -65,14 +65,14 @@  discard block
 block discarded – undo
65 65
 	 * @param string $source either a local file or string data
66 66
 	 * @return bool
67 67
 	 */
68
-	function addFile($path, $source='') {
69
-		if($source and $source[0]=='/' and file_exists($source)) {
70
-			$result=$this->zip->addFile($source, $path);
71
-		}else{
72
-			$result=$this->zip->addFromString($path, $source);
68
+	function addFile($path, $source = '') {
69
+		if ($source and $source[0] == '/' and file_exists($source)) {
70
+			$result = $this->zip->addFile($source, $path);
71
+		} else {
72
+			$result = $this->zip->addFromString($path, $source);
73 73
 		}
74
-		if($result) {
75
-			$this->zip->close();//close and reopen to save the zip
74
+		if ($result) {
75
+			$this->zip->close(); //close and reopen to save the zip
76 76
 			$this->zip->open($this->path);
77 77
 		}
78 78
 		return $result;
@@ -84,8 +84,8 @@  discard block
 block discarded – undo
84 84
 	 * @return boolean|null
85 85
 	 */
86 86
 	function rename($source, $dest) {
87
-		$source=$this->stripPath($source);
88
-		$dest=$this->stripPath($dest);
87
+		$source = $this->stripPath($source);
88
+		$dest = $this->stripPath($dest);
89 89
 		$this->zip->renameName($source, $dest);
90 90
 	}
91 91
 	/**
@@ -94,7 +94,7 @@  discard block
 block discarded – undo
94 94
 	 * @return int
95 95
 	 */
96 96
 	function filesize($path) {
97
-		$stat=$this->zip->statName($path);
97
+		$stat = $this->zip->statName($path);
98 98
 		return $stat['size'];
99 99
 	}
100 100
 	/**
@@ -111,13 +111,13 @@  discard block
 block discarded – undo
111 111
 	 * @return array
112 112
 	 */
113 113
 	function getFolder($path) {
114
-		$files=$this->getFiles();
115
-		$folderContent=array();
116
-		$pathLength=strlen($path);
117
-		foreach($files as $file) {
118
-			if(substr($file, 0, $pathLength)==$path and $file!=$path) {
119
-				if(strrpos(substr($file, 0, -1), '/')<=$pathLength) {
120
-					$folderContent[]=substr($file, $pathLength);
114
+		$files = $this->getFiles();
115
+		$folderContent = array();
116
+		$pathLength = strlen($path);
117
+		foreach ($files as $file) {
118
+			if (substr($file, 0, $pathLength) == $path and $file != $path) {
119
+				if (strrpos(substr($file, 0, -1), '/') <= $pathLength) {
120
+					$folderContent[] = substr($file, $pathLength);
121 121
 				}
122 122
 			}
123 123
 		}
@@ -128,10 +128,10 @@  discard block
 block discarded – undo
128 128
 	 * @return array
129 129
 	 */
130 130
 	function getFiles() {
131
-		$fileCount=$this->zip->numFiles;
132
-		$files=array();
133
-		for($i=0;$i<$fileCount;$i++) {
134
-			$files[]=$this->zip->getNameIndex($i);
131
+		$fileCount = $this->zip->numFiles;
132
+		$files = array();
133
+		for ($i = 0; $i < $fileCount; $i++) {
134
+			$files[] = $this->zip->getNameIndex($i);
135 135
 		}
136 136
 		return $files;
137 137
 	}
@@ -167,7 +167,7 @@  discard block
 block discarded – undo
167 167
 	 * @return bool
168 168
 	 */
169 169
 	function fileExists($path) {
170
-		return ($this->zip->locateName($path)!==false) or ($this->zip->locateName($path.'/')!==false);
170
+		return ($this->zip->locateName($path) !== false) or ($this->zip->locateName($path.'/') !== false);
171 171
 	}
172 172
 	/**
173 173
 	 * remove a file or folder from the archive
@@ -175,9 +175,9 @@  discard block
 block discarded – undo
175 175
 	 * @return bool
176 176
 	 */
177 177
 	function remove($path) {
178
-		if($this->fileExists($path.'/')) {
178
+		if ($this->fileExists($path.'/')) {
179 179
 			return $this->zip->deleteName($path.'/');
180
-		}else{
180
+		} else {
181 181
 			return $this->zip->deleteName($path);
182 182
 		}
183 183
 	}
@@ -188,23 +188,23 @@  discard block
 block discarded – undo
188 188
 	 * @return resource
189 189
 	 */
190 190
 	function getStream($path, $mode) {
191
-		if($mode=='r' or $mode=='rb') {
191
+		if ($mode == 'r' or $mode == 'rb') {
192 192
 			return $this->zip->getStream($path);
193 193
 		} else {
194 194
 			//since we can't directly get a writable stream,
195 195
 			//make a temp copy of the file and put it back
196 196
 			//in the archive when the stream is closed
197
-			if(strrpos($path, '.')!==false) {
198
-				$ext=substr($path, strrpos($path, '.'));
199
-			}else{
200
-				$ext='';
197
+			if (strrpos($path, '.') !== false) {
198
+				$ext = substr($path, strrpos($path, '.'));
199
+			} else {
200
+				$ext = '';
201 201
 			}
202
-			$tmpFile=\OCP\Files::tmpFile($ext);
203
-			if($this->fileExists($path)) {
202
+			$tmpFile = \OCP\Files::tmpFile($ext);
203
+			if ($this->fileExists($path)) {
204 204
 				$this->extractFile($path, $tmpFile);
205 205
 			}
206 206
 			$handle = fopen($tmpFile, $mode);
207
-			return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
207
+			return CallbackWrapper::wrap($handle, null, null, function() use ($path, $tmpFile) {
208 208
 				$this->writeBack($tmpFile, $path);
209 209
 			});
210 210
 		}
@@ -223,9 +223,9 @@  discard block
 block discarded – undo
223 223
 	 * @return string
224 224
 	 */
225 225
 	private function stripPath($path) {
226
-		if(!$path || $path[0]=='/') {
226
+		if (!$path || $path[0] == '/') {
227 227
 			return substr($path, 1);
228
-		}else{
228
+		} else {
229 229
 			return $path;
230 230
 		}
231 231
 	}
Please login to merge, or discard this patch.
Braces   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -47,7 +47,7 @@  discard block
 block discarded – undo
47 47
 		$this->path=$source;
48 48
 		$this->zip=new \ZipArchive();
49 49
 		if($this->zip->open($source, \ZipArchive::CREATE)) {
50
-		}else{
50
+		} else{
51 51
 			\OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, \OCP\Util::WARN);
52 52
 		}
53 53
 	}
@@ -68,7 +68,7 @@  discard block
 block discarded – undo
68 68
 	function addFile($path, $source='') {
69 69
 		if($source and $source[0]=='/' and file_exists($source)) {
70 70
 			$result=$this->zip->addFile($source, $path);
71
-		}else{
71
+		} else{
72 72
 			$result=$this->zip->addFromString($path, $source);
73 73
 		}
74 74
 		if($result) {
@@ -177,7 +177,7 @@  discard block
 block discarded – undo
177 177
 	function remove($path) {
178 178
 		if($this->fileExists($path.'/')) {
179 179
 			return $this->zip->deleteName($path.'/');
180
-		}else{
180
+		} else{
181 181
 			return $this->zip->deleteName($path);
182 182
 		}
183 183
 	}
@@ -196,7 +196,7 @@  discard block
 block discarded – undo
196 196
 			//in the archive when the stream is closed
197 197
 			if(strrpos($path, '.')!==false) {
198 198
 				$ext=substr($path, strrpos($path, '.'));
199
-			}else{
199
+			} else{
200 200
 				$ext='';
201 201
 			}
202 202
 			$tmpFile=\OCP\Files::tmpFile($ext);
@@ -225,7 +225,7 @@  discard block
 block discarded – undo
225 225
 	private function stripPath($path) {
226 226
 		if(!$path || $path[0]=='/') {
227 227
 			return substr($path, 1);
228
-		}else{
228
+		} else{
229 229
 			return $path;
230 230
 		}
231 231
 	}
Please login to merge, or discard this patch.
lib/private/Files/Cache/Wrapper/CacheJail.php 3 patches
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -194,6 +194,9 @@
 block discarded – undo
194 194
 		return $this->getCache()->getStatus($this->getSourcePath($file));
195 195
 	}
196 196
 
197
+	/**
198
+	 * @param ICacheEntry[] $results
199
+	 */
197 200
 	private function formatSearchResults($results) {
198 201
 		$results = array_filter($results, array($this, 'filterCacheEntry'));
199 202
 		$results = array_values($results);
Please login to merge, or discard this patch.
Indentation   +249 added lines, -249 removed lines patch added patch discarded remove patch
@@ -33,279 +33,279 @@
 block discarded – undo
33 33
  * Jail to a subdirectory of the wrapped cache
34 34
  */
35 35
 class CacheJail extends CacheWrapper {
36
-	/**
37
-	 * @var string
38
-	 */
39
-	protected $root;
36
+    /**
37
+     * @var string
38
+     */
39
+    protected $root;
40 40
 
41
-	/**
42
-	 * @param \OCP\Files\Cache\ICache $cache
43
-	 * @param string $root
44
-	 */
45
-	public function __construct($cache, $root) {
46
-		parent::__construct($cache);
47
-		$this->root = $root;
48
-	}
41
+    /**
42
+     * @param \OCP\Files\Cache\ICache $cache
43
+     * @param string $root
44
+     */
45
+    public function __construct($cache, $root) {
46
+        parent::__construct($cache);
47
+        $this->root = $root;
48
+    }
49 49
 
50
-	protected function getSourcePath($path) {
51
-		if ($path === '') {
52
-			return $this->root;
53
-		} else {
54
-			return $this->root . '/' . ltrim($path, '/');
55
-		}
56
-	}
50
+    protected function getSourcePath($path) {
51
+        if ($path === '') {
52
+            return $this->root;
53
+        } else {
54
+            return $this->root . '/' . ltrim($path, '/');
55
+        }
56
+    }
57 57
 
58
-	/**
59
-	 * @param string $path
60
-	 * @return null|string the jailed path or null if the path is outside the jail
61
-	 */
62
-	protected function getJailedPath($path) {
63
-		if ($this->root === '') {
64
-			return $path;
65
-		}
66
-		$rootLength = strlen($this->root) + 1;
67
-		if ($path === $this->root) {
68
-			return '';
69
-		} else if (substr($path, 0, $rootLength) === $this->root . '/') {
70
-			return substr($path, $rootLength);
71
-		} else {
72
-			return null;
73
-		}
74
-	}
58
+    /**
59
+     * @param string $path
60
+     * @return null|string the jailed path or null if the path is outside the jail
61
+     */
62
+    protected function getJailedPath($path) {
63
+        if ($this->root === '') {
64
+            return $path;
65
+        }
66
+        $rootLength = strlen($this->root) + 1;
67
+        if ($path === $this->root) {
68
+            return '';
69
+        } else if (substr($path, 0, $rootLength) === $this->root . '/') {
70
+            return substr($path, $rootLength);
71
+        } else {
72
+            return null;
73
+        }
74
+    }
75 75
 
76
-	/**
77
-	 * @param ICacheEntry|array $entry
78
-	 * @return array
79
-	 */
80
-	protected function formatCacheEntry($entry) {
81
-		if (isset($entry['path'])) {
82
-			$entry['path'] = $this->getJailedPath($entry['path']);
83
-		}
84
-		return $entry;
85
-	}
76
+    /**
77
+     * @param ICacheEntry|array $entry
78
+     * @return array
79
+     */
80
+    protected function formatCacheEntry($entry) {
81
+        if (isset($entry['path'])) {
82
+            $entry['path'] = $this->getJailedPath($entry['path']);
83
+        }
84
+        return $entry;
85
+    }
86 86
 
87
-	protected function filterCacheEntry($entry) {
88
-		$rootLength = strlen($this->root) + 1;
89
-		return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root . '/');
90
-	}
87
+    protected function filterCacheEntry($entry) {
88
+        $rootLength = strlen($this->root) + 1;
89
+        return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root . '/');
90
+    }
91 91
 
92
-	/**
93
-	 * get the stored metadata of a file or folder
94
-	 *
95
-	 * @param string /int $file
96
-	 * @return array|false
97
-	 */
98
-	public function get($file) {
99
-		if (is_string($file) or $file == '') {
100
-			$file = $this->getSourcePath($file);
101
-		}
102
-		return parent::get($file);
103
-	}
92
+    /**
93
+     * get the stored metadata of a file or folder
94
+     *
95
+     * @param string /int $file
96
+     * @return array|false
97
+     */
98
+    public function get($file) {
99
+        if (is_string($file) or $file == '') {
100
+            $file = $this->getSourcePath($file);
101
+        }
102
+        return parent::get($file);
103
+    }
104 104
 
105
-	/**
106
-	 * insert meta data for a new file or folder
107
-	 *
108
-	 * @param string $file
109
-	 * @param array $data
110
-	 *
111
-	 * @return int file id
112
-	 * @throws \RuntimeException
113
-	 */
114
-	public function insert($file, array $data) {
115
-		return $this->getCache()->insert($this->getSourcePath($file), $data);
116
-	}
105
+    /**
106
+     * insert meta data for a new file or folder
107
+     *
108
+     * @param string $file
109
+     * @param array $data
110
+     *
111
+     * @return int file id
112
+     * @throws \RuntimeException
113
+     */
114
+    public function insert($file, array $data) {
115
+        return $this->getCache()->insert($this->getSourcePath($file), $data);
116
+    }
117 117
 
118
-	/**
119
-	 * update the metadata in the cache
120
-	 *
121
-	 * @param int $id
122
-	 * @param array $data
123
-	 */
124
-	public function update($id, array $data) {
125
-		$this->getCache()->update($id, $data);
126
-	}
118
+    /**
119
+     * update the metadata in the cache
120
+     *
121
+     * @param int $id
122
+     * @param array $data
123
+     */
124
+    public function update($id, array $data) {
125
+        $this->getCache()->update($id, $data);
126
+    }
127 127
 
128
-	/**
129
-	 * get the file id for a file
130
-	 *
131
-	 * @param string $file
132
-	 * @return int
133
-	 */
134
-	public function getId($file) {
135
-		return $this->getCache()->getId($this->getSourcePath($file));
136
-	}
128
+    /**
129
+     * get the file id for a file
130
+     *
131
+     * @param string $file
132
+     * @return int
133
+     */
134
+    public function getId($file) {
135
+        return $this->getCache()->getId($this->getSourcePath($file));
136
+    }
137 137
 
138
-	/**
139
-	 * get the id of the parent folder of a file
140
-	 *
141
-	 * @param string $file
142
-	 * @return int
143
-	 */
144
-	public function getParentId($file) {
145
-		return $this->getCache()->getParentId($this->getSourcePath($file));
146
-	}
138
+    /**
139
+     * get the id of the parent folder of a file
140
+     *
141
+     * @param string $file
142
+     * @return int
143
+     */
144
+    public function getParentId($file) {
145
+        return $this->getCache()->getParentId($this->getSourcePath($file));
146
+    }
147 147
 
148
-	/**
149
-	 * check if a file is available in the cache
150
-	 *
151
-	 * @param string $file
152
-	 * @return bool
153
-	 */
154
-	public function inCache($file) {
155
-		return $this->getCache()->inCache($this->getSourcePath($file));
156
-	}
148
+    /**
149
+     * check if a file is available in the cache
150
+     *
151
+     * @param string $file
152
+     * @return bool
153
+     */
154
+    public function inCache($file) {
155
+        return $this->getCache()->inCache($this->getSourcePath($file));
156
+    }
157 157
 
158
-	/**
159
-	 * remove a file or folder from the cache
160
-	 *
161
-	 * @param string $file
162
-	 */
163
-	public function remove($file) {
164
-		$this->getCache()->remove($this->getSourcePath($file));
165
-	}
158
+    /**
159
+     * remove a file or folder from the cache
160
+     *
161
+     * @param string $file
162
+     */
163
+    public function remove($file) {
164
+        $this->getCache()->remove($this->getSourcePath($file));
165
+    }
166 166
 
167
-	/**
168
-	 * Move a file or folder in the cache
169
-	 *
170
-	 * @param string $source
171
-	 * @param string $target
172
-	 */
173
-	public function move($source, $target) {
174
-		$this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target));
175
-	}
167
+    /**
168
+     * Move a file or folder in the cache
169
+     *
170
+     * @param string $source
171
+     * @param string $target
172
+     */
173
+    public function move($source, $target) {
174
+        $this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target));
175
+    }
176 176
 
177
-	/**
178
-	 * remove all entries for files that are stored on the storage from the cache
179
-	 */
180
-	public function clear() {
181
-		$this->getCache()->remove($this->root);
182
-	}
177
+    /**
178
+     * remove all entries for files that are stored on the storage from the cache
179
+     */
180
+    public function clear() {
181
+        $this->getCache()->remove($this->root);
182
+    }
183 183
 
184
-	/**
185
-	 * @param string $file
186
-	 *
187
-	 * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
188
-	 */
189
-	public function getStatus($file) {
190
-		return $this->getCache()->getStatus($this->getSourcePath($file));
191
-	}
184
+    /**
185
+     * @param string $file
186
+     *
187
+     * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
188
+     */
189
+    public function getStatus($file) {
190
+        return $this->getCache()->getStatus($this->getSourcePath($file));
191
+    }
192 192
 
193
-	private function formatSearchResults($results) {
194
-		$results = array_filter($results, array($this, 'filterCacheEntry'));
195
-		$results = array_values($results);
196
-		return array_map(array($this, 'formatCacheEntry'), $results);
197
-	}
193
+    private function formatSearchResults($results) {
194
+        $results = array_filter($results, array($this, 'filterCacheEntry'));
195
+        $results = array_values($results);
196
+        return array_map(array($this, 'formatCacheEntry'), $results);
197
+    }
198 198
 
199
-	/**
200
-	 * search for files matching $pattern
201
-	 *
202
-	 * @param string $pattern
203
-	 * @return array an array of file data
204
-	 */
205
-	public function search($pattern) {
206
-		$results = $this->getCache()->search($pattern);
207
-		return $this->formatSearchResults($results);
208
-	}
199
+    /**
200
+     * search for files matching $pattern
201
+     *
202
+     * @param string $pattern
203
+     * @return array an array of file data
204
+     */
205
+    public function search($pattern) {
206
+        $results = $this->getCache()->search($pattern);
207
+        return $this->formatSearchResults($results);
208
+    }
209 209
 
210
-	/**
211
-	 * search for files by mimetype
212
-	 *
213
-	 * @param string $mimetype
214
-	 * @return array
215
-	 */
216
-	public function searchByMime($mimetype) {
217
-		$results = $this->getCache()->searchByMime($mimetype);
218
-		return $this->formatSearchResults($results);
219
-	}
210
+    /**
211
+     * search for files by mimetype
212
+     *
213
+     * @param string $mimetype
214
+     * @return array
215
+     */
216
+    public function searchByMime($mimetype) {
217
+        $results = $this->getCache()->searchByMime($mimetype);
218
+        return $this->formatSearchResults($results);
219
+    }
220 220
 
221
-	/**
222
-	 * search for files by mimetype
223
-	 *
224
-	 * @param string|int $tag name or tag id
225
-	 * @param string $userId owner of the tags
226
-	 * @return array
227
-	 */
228
-	public function searchByTag($tag, $userId) {
229
-		$results = $this->getCache()->searchByTag($tag, $userId);
230
-		return $this->formatSearchResults($results);
231
-	}
221
+    /**
222
+     * search for files by mimetype
223
+     *
224
+     * @param string|int $tag name or tag id
225
+     * @param string $userId owner of the tags
226
+     * @return array
227
+     */
228
+    public function searchByTag($tag, $userId) {
229
+        $results = $this->getCache()->searchByTag($tag, $userId);
230
+        return $this->formatSearchResults($results);
231
+    }
232 232
 
233
-	/**
234
-	 * update the folder size and the size of all parent folders
235
-	 *
236
-	 * @param string|boolean $path
237
-	 * @param array $data (optional) meta data of the folder
238
-	 */
239
-	public function correctFolderSize($path, $data = null) {
240
-		if ($this->getCache() instanceof Cache) {
241
-			$this->getCache()->correctFolderSize($this->getSourcePath($path), $data);
242
-		}
243
-	}
233
+    /**
234
+     * update the folder size and the size of all parent folders
235
+     *
236
+     * @param string|boolean $path
237
+     * @param array $data (optional) meta data of the folder
238
+     */
239
+    public function correctFolderSize($path, $data = null) {
240
+        if ($this->getCache() instanceof Cache) {
241
+            $this->getCache()->correctFolderSize($this->getSourcePath($path), $data);
242
+        }
243
+    }
244 244
 
245
-	/**
246
-	 * get the size of a folder and set it in the cache
247
-	 *
248
-	 * @param string $path
249
-	 * @param array $entry (optional) meta data of the folder
250
-	 * @return int
251
-	 */
252
-	public function calculateFolderSize($path, $entry = null) {
253
-		if ($this->getCache() instanceof Cache) {
254
-			return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry);
255
-		} else {
256
-			return 0;
257
-		}
245
+    /**
246
+     * get the size of a folder and set it in the cache
247
+     *
248
+     * @param string $path
249
+     * @param array $entry (optional) meta data of the folder
250
+     * @return int
251
+     */
252
+    public function calculateFolderSize($path, $entry = null) {
253
+        if ($this->getCache() instanceof Cache) {
254
+            return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry);
255
+        } else {
256
+            return 0;
257
+        }
258 258
 
259
-	}
259
+    }
260 260
 
261
-	/**
262
-	 * get all file ids on the files on the storage
263
-	 *
264
-	 * @return int[]
265
-	 */
266
-	public function getAll() {
267
-		// not supported
268
-		return array();
269
-	}
261
+    /**
262
+     * get all file ids on the files on the storage
263
+     *
264
+     * @return int[]
265
+     */
266
+    public function getAll() {
267
+        // not supported
268
+        return array();
269
+    }
270 270
 
271
-	/**
272
-	 * find a folder in the cache which has not been fully scanned
273
-	 *
274
-	 * If multiply incomplete folders are in the cache, the one with the highest id will be returned,
275
-	 * use the one with the highest id gives the best result with the background scanner, since that is most
276
-	 * likely the folder where we stopped scanning previously
277
-	 *
278
-	 * @return string|bool the path of the folder or false when no folder matched
279
-	 */
280
-	public function getIncomplete() {
281
-		// not supported
282
-		return false;
283
-	}
271
+    /**
272
+     * find a folder in the cache which has not been fully scanned
273
+     *
274
+     * If multiply incomplete folders are in the cache, the one with the highest id will be returned,
275
+     * use the one with the highest id gives the best result with the background scanner, since that is most
276
+     * likely the folder where we stopped scanning previously
277
+     *
278
+     * @return string|bool the path of the folder or false when no folder matched
279
+     */
280
+    public function getIncomplete() {
281
+        // not supported
282
+        return false;
283
+    }
284 284
 
285
-	/**
286
-	 * get the path of a file on this storage by it's id
287
-	 *
288
-	 * @param int $id
289
-	 * @return string|null
290
-	 */
291
-	public function getPathById($id) {
292
-		$path = $this->getCache()->getPathById($id);
293
-		return $this->getJailedPath($path);
294
-	}
285
+    /**
286
+     * get the path of a file on this storage by it's id
287
+     *
288
+     * @param int $id
289
+     * @return string|null
290
+     */
291
+    public function getPathById($id) {
292
+        $path = $this->getCache()->getPathById($id);
293
+        return $this->getJailedPath($path);
294
+    }
295 295
 
296
-	/**
297
-	 * Move a file or folder in the cache
298
-	 *
299
-	 * Note that this should make sure the entries are removed from the source cache
300
-	 *
301
-	 * @param \OCP\Files\Cache\ICache $sourceCache
302
-	 * @param string $sourcePath
303
-	 * @param string $targetPath
304
-	 */
305
-	public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
306
-		if ($sourceCache === $this) {
307
-			return $this->move($sourcePath, $targetPath);
308
-		}
309
-		return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath));
310
-	}
296
+    /**
297
+     * Move a file or folder in the cache
298
+     *
299
+     * Note that this should make sure the entries are removed from the source cache
300
+     *
301
+     * @param \OCP\Files\Cache\ICache $sourceCache
302
+     * @param string $sourcePath
303
+     * @param string $targetPath
304
+     */
305
+    public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
306
+        if ($sourceCache === $this) {
307
+            return $this->move($sourcePath, $targetPath);
308
+        }
309
+        return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath));
310
+    }
311 311
 }
Please login to merge, or discard this patch.
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -51,7 +51,7 @@  discard block
 block discarded – undo
51 51
 		if ($path === '') {
52 52
 			return $this->root;
53 53
 		} else {
54
-			return $this->root . '/' . ltrim($path, '/');
54
+			return $this->root.'/'.ltrim($path, '/');
55 55
 		}
56 56
 	}
57 57
 
@@ -66,7 +66,7 @@  discard block
 block discarded – undo
66 66
 		$rootLength = strlen($this->root) + 1;
67 67
 		if ($path === $this->root) {
68 68
 			return '';
69
-		} else if (substr($path, 0, $rootLength) === $this->root . '/') {
69
+		} else if (substr($path, 0, $rootLength) === $this->root.'/') {
70 70
 			return substr($path, $rootLength);
71 71
 		} else {
72 72
 			return null;
@@ -86,7 +86,7 @@  discard block
 block discarded – undo
86 86
 
87 87
 	protected function filterCacheEntry($entry) {
88 88
 		$rootLength = strlen($this->root) + 1;
89
-		return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root . '/');
89
+		return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root.'/');
90 90
 	}
91 91
 
92 92
 	/**
Please login to merge, or discard this patch.
lib/private/Files/FileInfo.php 3 patches
Unused Use Statements   -1 removed lines patch added patch discarded remove patch
@@ -32,7 +32,6 @@
 block discarded – undo
32 32
 
33 33
 use OCP\Files\Cache\ICacheEntry;
34 34
 use OCP\Files\Mount\IMountPoint;
35
-use OCP\Files\Storage\IStorage;
36 35
 use OCP\Files\IHomeStorage;
37 36
 use OCP\IUser;
38 37
 
Please login to merge, or discard this patch.
Indentation   +350 added lines, -350 removed lines patch added patch discarded remove patch
@@ -37,354 +37,354 @@
 block discarded – undo
37 37
 use OCP\IUser;
38 38
 
39 39
 class FileInfo implements \OCP\Files\FileInfo, \ArrayAccess {
40
-	/**
41
-	 * @var array $data
42
-	 */
43
-	private $data;
44
-
45
-	/**
46
-	 * @var string $path
47
-	 */
48
-	private $path;
49
-
50
-	/**
51
-	 * @var \OC\Files\Storage\Storage $storage
52
-	 */
53
-	private $storage;
54
-
55
-	/**
56
-	 * @var string $internalPath
57
-	 */
58
-	private $internalPath;
59
-
60
-	/**
61
-	 * @var \OCP\Files\Mount\IMountPoint
62
-	 */
63
-	private $mount;
64
-
65
-	/**
66
-	 * @var IUser
67
-	 */
68
-	private $owner;
69
-
70
-	/**
71
-	 * @var string[]
72
-	 */
73
-	private $childEtags = [];
74
-
75
-	/**
76
-	 * @var IMountPoint[]
77
-	 */
78
-	private $subMounts = [];
79
-
80
-	private $subMountsUsed = false;
81
-
82
-	/**
83
-	 * @param string|boolean $path
84
-	 * @param Storage\Storage $storage
85
-	 * @param string $internalPath
86
-	 * @param array|ICacheEntry $data
87
-	 * @param \OCP\Files\Mount\IMountPoint $mount
88
-	 * @param \OCP\IUser|null $owner
89
-	 */
90
-	public function __construct($path, $storage, $internalPath, $data, $mount, $owner= null) {
91
-		$this->path = $path;
92
-		$this->storage = $storage;
93
-		$this->internalPath = $internalPath;
94
-		$this->data = $data;
95
-		$this->mount = $mount;
96
-		$this->owner = $owner;
97
-	}
98
-
99
-	public function offsetSet($offset, $value) {
100
-		$this->data[$offset] = $value;
101
-	}
102
-
103
-	public function offsetExists($offset) {
104
-		return isset($this->data[$offset]);
105
-	}
106
-
107
-	public function offsetUnset($offset) {
108
-		unset($this->data[$offset]);
109
-	}
110
-
111
-	public function offsetGet($offset) {
112
-		if ($offset === 'type') {
113
-			return $this->getType();
114
-		} else if ($offset === 'etag') {
115
-			return $this->getEtag();
116
-		} else if ($offset === 'size') {
117
-			return $this->getSize();
118
-		} else if ($offset === 'mtime') {
119
-			return $this->getMTime();
120
-		} elseif ($offset === 'permissions') {
121
-			return $this->getPermissions();
122
-		} elseif (isset($this->data[$offset])) {
123
-			return $this->data[$offset];
124
-		} else {
125
-			return null;
126
-		}
127
-	}
128
-
129
-	/**
130
-	 * @return string
131
-	 */
132
-	public function getPath() {
133
-		return $this->path;
134
-	}
135
-
136
-	/**
137
-	 * @return \OCP\Files\Storage
138
-	 */
139
-	public function getStorage() {
140
-		return $this->storage;
141
-	}
142
-
143
-	/**
144
-	 * @return string
145
-	 */
146
-	public function getInternalPath() {
147
-		return $this->internalPath;
148
-	}
149
-
150
-	/**
151
-	 * @return int
152
-	 */
153
-	public function getId() {
154
-		return $this->data['fileid'];
155
-	}
156
-
157
-	/**
158
-	 * @return string
159
-	 */
160
-	public function getMimetype() {
161
-		return $this->data['mimetype'];
162
-	}
163
-
164
-	/**
165
-	 * @return string
166
-	 */
167
-	public function getMimePart() {
168
-		return $this->data['mimepart'];
169
-	}
170
-
171
-	/**
172
-	 * @return string
173
-	 */
174
-	public function getName() {
175
-		return basename($this->getPath());
176
-	}
177
-
178
-	/**
179
-	 * @return string
180
-	 */
181
-	public function getEtag() {
182
-		$this->updateEntryfromSubMounts();
183
-		if (count($this->childEtags) > 0) {
184
-			$combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags);
185
-			return md5($combinedEtag);
186
-		} else {
187
-			return $this->data['etag'];
188
-		}
189
-	}
190
-
191
-	/**
192
-	 * @return int
193
-	 */
194
-	public function getSize() {
195
-		$this->updateEntryfromSubMounts();
196
-		return isset($this->data['size']) ? $this->data['size'] : 0;
197
-	}
198
-
199
-	/**
200
-	 * @return int
201
-	 */
202
-	public function getMTime() {
203
-		$this->updateEntryfromSubMounts();
204
-		return $this->data['mtime'];
205
-	}
206
-
207
-	/**
208
-	 * @return bool
209
-	 */
210
-	public function isEncrypted() {
211
-		return $this->data['encrypted'];
212
-	}
213
-
214
-	/**
215
-	 * Return the currently version used for the HMAC in the encryption app
216
-	 *
217
-	 * @return int
218
-	 */
219
-	public function getEncryptedVersion() {
220
-		return isset($this->data['encryptedVersion']) ? (int) $this->data['encryptedVersion'] : 1;
221
-	}
222
-
223
-	/**
224
-	 * @return int
225
-	 */
226
-	public function getPermissions() {
227
-		$perms = $this->data['permissions'];
228
-		if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) {
229
-			$perms = $perms & ~\OCP\Constants::PERMISSION_SHARE;
230
-		}
231
-		return $perms;
232
-	}
233
-
234
-	/**
235
-	 * @return \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER
236
-	 */
237
-	public function getType() {
238
-		if (!isset($this->data['type'])) {
239
-			$this->data['type'] = ($this->getMimetype() === 'httpd/unix-directory') ? self::TYPE_FOLDER : self::TYPE_FILE;
240
-		}
241
-		return $this->data['type'];
242
-	}
243
-
244
-	public function getData() {
245
-		return $this->data;
246
-	}
247
-
248
-	/**
249
-	 * @param int $permissions
250
-	 * @return bool
251
-	 */
252
-	protected function checkPermissions($permissions) {
253
-		return ($this->getPermissions() & $permissions) === $permissions;
254
-	}
255
-
256
-	/**
257
-	 * @return bool
258
-	 */
259
-	public function isReadable() {
260
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_READ);
261
-	}
262
-
263
-	/**
264
-	 * @return bool
265
-	 */
266
-	public function isUpdateable() {
267
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE);
268
-	}
269
-
270
-	/**
271
-	 * Check whether new files or folders can be created inside this folder
272
-	 *
273
-	 * @return bool
274
-	 */
275
-	public function isCreatable() {
276
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_CREATE);
277
-	}
278
-
279
-	/**
280
-	 * @return bool
281
-	 */
282
-	public function isDeletable() {
283
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_DELETE);
284
-	}
285
-
286
-	/**
287
-	 * @return bool
288
-	 */
289
-	public function isShareable() {
290
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_SHARE);
291
-	}
292
-
293
-	/**
294
-	 * Check if a file or folder is shared
295
-	 *
296
-	 * @return bool
297
-	 */
298
-	public function isShared() {
299
-		$sid = $this->getStorage()->getId();
300
-		if (!is_null($sid)) {
301
-			$sid = explode(':', $sid);
302
-			return ($sid[0] === 'shared');
303
-		}
304
-
305
-		return false;
306
-	}
307
-
308
-	public function isMounted() {
309
-		$storage = $this->getStorage();
310
-		if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
311
-			return false;
312
-		}
313
-		$sid = $storage->getId();
314
-		if (!is_null($sid)) {
315
-			$sid = explode(':', $sid);
316
-			return ($sid[0] !== 'home' and $sid[0] !== 'shared');
317
-		}
318
-
319
-		return false;
320
-	}
321
-
322
-	/**
323
-	 * Get the mountpoint the file belongs to
324
-	 *
325
-	 * @return \OCP\Files\Mount\IMountPoint
326
-	 */
327
-	public function getMountPoint() {
328
-		return $this->mount;
329
-	}
330
-
331
-	/**
332
-	 * Get the owner of the file
333
-	 *
334
-	 * @return \OCP\IUser
335
-	 */
336
-	public function getOwner() {
337
-		return $this->owner;
338
-	}
339
-
340
-	/**
341
-	 * @param IMountPoint[] $mounts
342
-	 */
343
-	public function setSubMounts(array $mounts) {
344
-		$this->subMounts = $mounts;
345
-	}
346
-
347
-	private function updateEntryfromSubMounts() {
348
-		if ($this->subMountsUsed) {
349
-			return;
350
-		}
351
-		$this->subMountsUsed = true;
352
-		foreach ($this->subMounts as $mount) {
353
-			$subStorage = $mount->getStorage();
354
-			if ($subStorage) {
355
-				$subCache = $subStorage->getCache('');
356
-				$rootEntry = $subCache->get('');
357
-				$this->addSubEntry($rootEntry, $mount->getMountPoint());
358
-			}
359
-		}
360
-	}
361
-
362
-	/**
363
-	 * Add a cache entry which is the child of this folder
364
-	 *
365
-	 * Sets the size, etag and size to for cross-storage childs
366
-	 *
367
-	 * @param array|ICacheEntry $data cache entry for the child
368
-	 * @param string $entryPath full path of the child entry
369
-	 */
370
-	public function addSubEntry($data, $entryPath) {
371
-		$this->data['size'] += isset($data['size']) ? $data['size'] : 0;
372
-		if (isset($data['mtime'])) {
373
-			$this->data['mtime'] = max($this->data['mtime'], $data['mtime']);
374
-		}
375
-		if (isset($data['etag'])) {
376
-			// prefix the etag with the relative path of the subentry to propagate etag on mount moves
377
-			$relativeEntryPath = substr($entryPath, strlen($this->getPath()));
378
-			// attach the permissions to propagate etag on permision changes of submounts
379
-			$permissions = isset($data['permissions']) ? $data['permissions'] : 0;
380
-			$this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions;
381
-		}
382
-	}
383
-
384
-	/**
385
-	 * @inheritdoc
386
-	 */
387
-	public function getChecksum() {
388
-		return $this->data['checksum'];
389
-	}
40
+    /**
41
+     * @var array $data
42
+     */
43
+    private $data;
44
+
45
+    /**
46
+     * @var string $path
47
+     */
48
+    private $path;
49
+
50
+    /**
51
+     * @var \OC\Files\Storage\Storage $storage
52
+     */
53
+    private $storage;
54
+
55
+    /**
56
+     * @var string $internalPath
57
+     */
58
+    private $internalPath;
59
+
60
+    /**
61
+     * @var \OCP\Files\Mount\IMountPoint
62
+     */
63
+    private $mount;
64
+
65
+    /**
66
+     * @var IUser
67
+     */
68
+    private $owner;
69
+
70
+    /**
71
+     * @var string[]
72
+     */
73
+    private $childEtags = [];
74
+
75
+    /**
76
+     * @var IMountPoint[]
77
+     */
78
+    private $subMounts = [];
79
+
80
+    private $subMountsUsed = false;
81
+
82
+    /**
83
+     * @param string|boolean $path
84
+     * @param Storage\Storage $storage
85
+     * @param string $internalPath
86
+     * @param array|ICacheEntry $data
87
+     * @param \OCP\Files\Mount\IMountPoint $mount
88
+     * @param \OCP\IUser|null $owner
89
+     */
90
+    public function __construct($path, $storage, $internalPath, $data, $mount, $owner= null) {
91
+        $this->path = $path;
92
+        $this->storage = $storage;
93
+        $this->internalPath = $internalPath;
94
+        $this->data = $data;
95
+        $this->mount = $mount;
96
+        $this->owner = $owner;
97
+    }
98
+
99
+    public function offsetSet($offset, $value) {
100
+        $this->data[$offset] = $value;
101
+    }
102
+
103
+    public function offsetExists($offset) {
104
+        return isset($this->data[$offset]);
105
+    }
106
+
107
+    public function offsetUnset($offset) {
108
+        unset($this->data[$offset]);
109
+    }
110
+
111
+    public function offsetGet($offset) {
112
+        if ($offset === 'type') {
113
+            return $this->getType();
114
+        } else if ($offset === 'etag') {
115
+            return $this->getEtag();
116
+        } else if ($offset === 'size') {
117
+            return $this->getSize();
118
+        } else if ($offset === 'mtime') {
119
+            return $this->getMTime();
120
+        } elseif ($offset === 'permissions') {
121
+            return $this->getPermissions();
122
+        } elseif (isset($this->data[$offset])) {
123
+            return $this->data[$offset];
124
+        } else {
125
+            return null;
126
+        }
127
+    }
128
+
129
+    /**
130
+     * @return string
131
+     */
132
+    public function getPath() {
133
+        return $this->path;
134
+    }
135
+
136
+    /**
137
+     * @return \OCP\Files\Storage
138
+     */
139
+    public function getStorage() {
140
+        return $this->storage;
141
+    }
142
+
143
+    /**
144
+     * @return string
145
+     */
146
+    public function getInternalPath() {
147
+        return $this->internalPath;
148
+    }
149
+
150
+    /**
151
+     * @return int
152
+     */
153
+    public function getId() {
154
+        return $this->data['fileid'];
155
+    }
156
+
157
+    /**
158
+     * @return string
159
+     */
160
+    public function getMimetype() {
161
+        return $this->data['mimetype'];
162
+    }
163
+
164
+    /**
165
+     * @return string
166
+     */
167
+    public function getMimePart() {
168
+        return $this->data['mimepart'];
169
+    }
170
+
171
+    /**
172
+     * @return string
173
+     */
174
+    public function getName() {
175
+        return basename($this->getPath());
176
+    }
177
+
178
+    /**
179
+     * @return string
180
+     */
181
+    public function getEtag() {
182
+        $this->updateEntryfromSubMounts();
183
+        if (count($this->childEtags) > 0) {
184
+            $combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags);
185
+            return md5($combinedEtag);
186
+        } else {
187
+            return $this->data['etag'];
188
+        }
189
+    }
190
+
191
+    /**
192
+     * @return int
193
+     */
194
+    public function getSize() {
195
+        $this->updateEntryfromSubMounts();
196
+        return isset($this->data['size']) ? $this->data['size'] : 0;
197
+    }
198
+
199
+    /**
200
+     * @return int
201
+     */
202
+    public function getMTime() {
203
+        $this->updateEntryfromSubMounts();
204
+        return $this->data['mtime'];
205
+    }
206
+
207
+    /**
208
+     * @return bool
209
+     */
210
+    public function isEncrypted() {
211
+        return $this->data['encrypted'];
212
+    }
213
+
214
+    /**
215
+     * Return the currently version used for the HMAC in the encryption app
216
+     *
217
+     * @return int
218
+     */
219
+    public function getEncryptedVersion() {
220
+        return isset($this->data['encryptedVersion']) ? (int) $this->data['encryptedVersion'] : 1;
221
+    }
222
+
223
+    /**
224
+     * @return int
225
+     */
226
+    public function getPermissions() {
227
+        $perms = $this->data['permissions'];
228
+        if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) {
229
+            $perms = $perms & ~\OCP\Constants::PERMISSION_SHARE;
230
+        }
231
+        return $perms;
232
+    }
233
+
234
+    /**
235
+     * @return \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER
236
+     */
237
+    public function getType() {
238
+        if (!isset($this->data['type'])) {
239
+            $this->data['type'] = ($this->getMimetype() === 'httpd/unix-directory') ? self::TYPE_FOLDER : self::TYPE_FILE;
240
+        }
241
+        return $this->data['type'];
242
+    }
243
+
244
+    public function getData() {
245
+        return $this->data;
246
+    }
247
+
248
+    /**
249
+     * @param int $permissions
250
+     * @return bool
251
+     */
252
+    protected function checkPermissions($permissions) {
253
+        return ($this->getPermissions() & $permissions) === $permissions;
254
+    }
255
+
256
+    /**
257
+     * @return bool
258
+     */
259
+    public function isReadable() {
260
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_READ);
261
+    }
262
+
263
+    /**
264
+     * @return bool
265
+     */
266
+    public function isUpdateable() {
267
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE);
268
+    }
269
+
270
+    /**
271
+     * Check whether new files or folders can be created inside this folder
272
+     *
273
+     * @return bool
274
+     */
275
+    public function isCreatable() {
276
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_CREATE);
277
+    }
278
+
279
+    /**
280
+     * @return bool
281
+     */
282
+    public function isDeletable() {
283
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_DELETE);
284
+    }
285
+
286
+    /**
287
+     * @return bool
288
+     */
289
+    public function isShareable() {
290
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_SHARE);
291
+    }
292
+
293
+    /**
294
+     * Check if a file or folder is shared
295
+     *
296
+     * @return bool
297
+     */
298
+    public function isShared() {
299
+        $sid = $this->getStorage()->getId();
300
+        if (!is_null($sid)) {
301
+            $sid = explode(':', $sid);
302
+            return ($sid[0] === 'shared');
303
+        }
304
+
305
+        return false;
306
+    }
307
+
308
+    public function isMounted() {
309
+        $storage = $this->getStorage();
310
+        if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
311
+            return false;
312
+        }
313
+        $sid = $storage->getId();
314
+        if (!is_null($sid)) {
315
+            $sid = explode(':', $sid);
316
+            return ($sid[0] !== 'home' and $sid[0] !== 'shared');
317
+        }
318
+
319
+        return false;
320
+    }
321
+
322
+    /**
323
+     * Get the mountpoint the file belongs to
324
+     *
325
+     * @return \OCP\Files\Mount\IMountPoint
326
+     */
327
+    public function getMountPoint() {
328
+        return $this->mount;
329
+    }
330
+
331
+    /**
332
+     * Get the owner of the file
333
+     *
334
+     * @return \OCP\IUser
335
+     */
336
+    public function getOwner() {
337
+        return $this->owner;
338
+    }
339
+
340
+    /**
341
+     * @param IMountPoint[] $mounts
342
+     */
343
+    public function setSubMounts(array $mounts) {
344
+        $this->subMounts = $mounts;
345
+    }
346
+
347
+    private function updateEntryfromSubMounts() {
348
+        if ($this->subMountsUsed) {
349
+            return;
350
+        }
351
+        $this->subMountsUsed = true;
352
+        foreach ($this->subMounts as $mount) {
353
+            $subStorage = $mount->getStorage();
354
+            if ($subStorage) {
355
+                $subCache = $subStorage->getCache('');
356
+                $rootEntry = $subCache->get('');
357
+                $this->addSubEntry($rootEntry, $mount->getMountPoint());
358
+            }
359
+        }
360
+    }
361
+
362
+    /**
363
+     * Add a cache entry which is the child of this folder
364
+     *
365
+     * Sets the size, etag and size to for cross-storage childs
366
+     *
367
+     * @param array|ICacheEntry $data cache entry for the child
368
+     * @param string $entryPath full path of the child entry
369
+     */
370
+    public function addSubEntry($data, $entryPath) {
371
+        $this->data['size'] += isset($data['size']) ? $data['size'] : 0;
372
+        if (isset($data['mtime'])) {
373
+            $this->data['mtime'] = max($this->data['mtime'], $data['mtime']);
374
+        }
375
+        if (isset($data['etag'])) {
376
+            // prefix the etag with the relative path of the subentry to propagate etag on mount moves
377
+            $relativeEntryPath = substr($entryPath, strlen($this->getPath()));
378
+            // attach the permissions to propagate etag on permision changes of submounts
379
+            $permissions = isset($data['permissions']) ? $data['permissions'] : 0;
380
+            $this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions;
381
+        }
382
+    }
383
+
384
+    /**
385
+     * @inheritdoc
386
+     */
387
+    public function getChecksum() {
388
+        return $this->data['checksum'];
389
+    }
390 390
 }
Please login to merge, or discard this patch.
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -87,7 +87,7 @@  discard block
 block discarded – undo
87 87
 	 * @param \OCP\Files\Mount\IMountPoint $mount
88 88
 	 * @param \OCP\IUser|null $owner
89 89
 	 */
90
-	public function __construct($path, $storage, $internalPath, $data, $mount, $owner= null) {
90
+	public function __construct($path, $storage, $internalPath, $data, $mount, $owner = null) {
91 91
 		$this->path = $path;
92 92
 		$this->storage = $storage;
93 93
 		$this->internalPath = $internalPath;
@@ -181,7 +181,7 @@  discard block
 block discarded – undo
181 181
 	public function getEtag() {
182 182
 		$this->updateEntryfromSubMounts();
183 183
 		if (count($this->childEtags) > 0) {
184
-			$combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags);
184
+			$combinedEtag = $this->data['etag'].'::'.implode('::', $this->childEtags);
185 185
 			return md5($combinedEtag);
186 186
 		} else {
187 187
 			return $this->data['etag'];
@@ -377,7 +377,7 @@  discard block
 block discarded – undo
377 377
 			$relativeEntryPath = substr($entryPath, strlen($this->getPath()));
378 378
 			// attach the permissions to propagate etag on permision changes of submounts
379 379
 			$permissions = isset($data['permissions']) ? $data['permissions'] : 0;
380
-			$this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions;
380
+			$this->childEtags[] = $relativeEntryPath.'/'.$data['etag'].$permissions;
381 381
 		}
382 382
 	}
383 383
 
Please login to merge, or discard this patch.
lib/private/Group/Manager.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -156,7 +156,7 @@
 block discarded – undo
156 156
 	/**
157 157
 	 * @param string $gid
158 158
 	 * @param string $displayName
159
-	 * @return \OCP\IGroup
159
+	 * @return null|Group
160 160
 	 */
161 161
 	protected function getGroupObject($gid, $displayName = null) {
162 162
 		$backends = array();
Please login to merge, or discard this patch.
Indentation   +275 added lines, -275 removed lines patch added patch discarded remove patch
@@ -55,308 +55,308 @@
 block discarded – undo
55 55
  * @package OC\Group
56 56
  */
57 57
 class Manager extends PublicEmitter implements IGroupManager {
58
-	/**
59
-	 * @var GroupInterface[] $backends
60
-	 */
61
-	private $backends = array();
58
+    /**
59
+     * @var GroupInterface[] $backends
60
+     */
61
+    private $backends = array();
62 62
 
63
-	/**
64
-	 * @var \OC\User\Manager $userManager
65
-	 */
66
-	private $userManager;
63
+    /**
64
+     * @var \OC\User\Manager $userManager
65
+     */
66
+    private $userManager;
67 67
 
68
-	/**
69
-	 * @var \OC\Group\Group[]
70
-	 */
71
-	private $cachedGroups = array();
68
+    /**
69
+     * @var \OC\Group\Group[]
70
+     */
71
+    private $cachedGroups = array();
72 72
 
73
-	/**
74
-	 * @var \OC\Group\Group[]
75
-	 */
76
-	private $cachedUserGroups = array();
73
+    /**
74
+     * @var \OC\Group\Group[]
75
+     */
76
+    private $cachedUserGroups = array();
77 77
 
78
-	/** @var \OC\SubAdmin */
79
-	private $subAdmin = null;
78
+    /** @var \OC\SubAdmin */
79
+    private $subAdmin = null;
80 80
 
81
-	/**
82
-	 * @param \OC\User\Manager $userManager
83
-	 */
84
-	public function __construct(\OC\User\Manager $userManager) {
85
-		$this->userManager = $userManager;
86
-		$cachedGroups = & $this->cachedGroups;
87
-		$cachedUserGroups = & $this->cachedUserGroups;
88
-		$this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
89
-			/**
90
-			 * @var \OC\Group\Group $group
91
-			 */
92
-			unset($cachedGroups[$group->getGID()]);
93
-			$cachedUserGroups = array();
94
-		});
95
-		$this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
96
-			/**
97
-			 * @var \OC\Group\Group $group
98
-			 */
99
-			$cachedUserGroups = array();
100
-		});
101
-		$this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
102
-			/**
103
-			 * @var \OC\Group\Group $group
104
-			 */
105
-			$cachedUserGroups = array();
106
-		});
107
-	}
81
+    /**
82
+     * @param \OC\User\Manager $userManager
83
+     */
84
+    public function __construct(\OC\User\Manager $userManager) {
85
+        $this->userManager = $userManager;
86
+        $cachedGroups = & $this->cachedGroups;
87
+        $cachedUserGroups = & $this->cachedUserGroups;
88
+        $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
89
+            /**
90
+             * @var \OC\Group\Group $group
91
+             */
92
+            unset($cachedGroups[$group->getGID()]);
93
+            $cachedUserGroups = array();
94
+        });
95
+        $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
96
+            /**
97
+             * @var \OC\Group\Group $group
98
+             */
99
+            $cachedUserGroups = array();
100
+        });
101
+        $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
102
+            /**
103
+             * @var \OC\Group\Group $group
104
+             */
105
+            $cachedUserGroups = array();
106
+        });
107
+    }
108 108
 
109
-	/**
110
-	 * Checks whether a given backend is used
111
-	 *
112
-	 * @param string $backendClass Full classname including complete namespace
113
-	 * @return bool
114
-	 */
115
-	public function isBackendUsed($backendClass) {
116
-		$backendClass = strtolower(ltrim($backendClass, '\\'));
109
+    /**
110
+     * Checks whether a given backend is used
111
+     *
112
+     * @param string $backendClass Full classname including complete namespace
113
+     * @return bool
114
+     */
115
+    public function isBackendUsed($backendClass) {
116
+        $backendClass = strtolower(ltrim($backendClass, '\\'));
117 117
 
118
-		foreach ($this->backends as $backend) {
119
-			if (strtolower(get_class($backend)) === $backendClass) {
120
-				return true;
121
-			}
122
-		}
118
+        foreach ($this->backends as $backend) {
119
+            if (strtolower(get_class($backend)) === $backendClass) {
120
+                return true;
121
+            }
122
+        }
123 123
 
124
-		return false;
125
-	}
124
+        return false;
125
+    }
126 126
 
127
-	/**
128
-	 * @param \OCP\GroupInterface $backend
129
-	 */
130
-	public function addBackend($backend) {
131
-		$this->backends[] = $backend;
132
-		$this->clearCaches();
133
-	}
127
+    /**
128
+     * @param \OCP\GroupInterface $backend
129
+     */
130
+    public function addBackend($backend) {
131
+        $this->backends[] = $backend;
132
+        $this->clearCaches();
133
+    }
134 134
 
135
-	public function clearBackends() {
136
-		$this->backends = array();
137
-		$this->clearCaches();
138
-	}
135
+    public function clearBackends() {
136
+        $this->backends = array();
137
+        $this->clearCaches();
138
+    }
139 139
 	
140
-	protected function clearCaches() {
141
-		$this->cachedGroups = array();
142
-		$this->cachedUserGroups = array();
143
-	}
140
+    protected function clearCaches() {
141
+        $this->cachedGroups = array();
142
+        $this->cachedUserGroups = array();
143
+    }
144 144
 
145
-	/**
146
-	 * @param string $gid
147
-	 * @return \OC\Group\Group
148
-	 */
149
-	public function get($gid) {
150
-		if (isset($this->cachedGroups[$gid])) {
151
-			return $this->cachedGroups[$gid];
152
-		}
153
-		return $this->getGroupObject($gid);
154
-	}
145
+    /**
146
+     * @param string $gid
147
+     * @return \OC\Group\Group
148
+     */
149
+    public function get($gid) {
150
+        if (isset($this->cachedGroups[$gid])) {
151
+            return $this->cachedGroups[$gid];
152
+        }
153
+        return $this->getGroupObject($gid);
154
+    }
155 155
 
156
-	/**
157
-	 * @param string $gid
158
-	 * @param string $displayName
159
-	 * @return \OCP\IGroup
160
-	 */
161
-	protected function getGroupObject($gid, $displayName = null) {
162
-		$backends = array();
163
-		foreach ($this->backends as $backend) {
164
-			if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) {
165
-				$groupData = $backend->getGroupDetails($gid);
166
-				if (is_array($groupData)) {
167
-					// take the display name from the first backend that has a non-null one
168
-					if (is_null($displayName) && isset($groupData['displayName'])) {
169
-						$displayName = $groupData['displayName'];
170
-					}
171
-					$backends[] = $backend;
172
-				}
173
-			} else if ($backend->groupExists($gid)) {
174
-				$backends[] = $backend;
175
-			}
176
-		}
177
-		if (count($backends) === 0) {
178
-			return null;
179
-		}
180
-		$this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName);
181
-		return $this->cachedGroups[$gid];
182
-	}
156
+    /**
157
+     * @param string $gid
158
+     * @param string $displayName
159
+     * @return \OCP\IGroup
160
+     */
161
+    protected function getGroupObject($gid, $displayName = null) {
162
+        $backends = array();
163
+        foreach ($this->backends as $backend) {
164
+            if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) {
165
+                $groupData = $backend->getGroupDetails($gid);
166
+                if (is_array($groupData)) {
167
+                    // take the display name from the first backend that has a non-null one
168
+                    if (is_null($displayName) && isset($groupData['displayName'])) {
169
+                        $displayName = $groupData['displayName'];
170
+                    }
171
+                    $backends[] = $backend;
172
+                }
173
+            } else if ($backend->groupExists($gid)) {
174
+                $backends[] = $backend;
175
+            }
176
+        }
177
+        if (count($backends) === 0) {
178
+            return null;
179
+        }
180
+        $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName);
181
+        return $this->cachedGroups[$gid];
182
+    }
183 183
 
184
-	/**
185
-	 * @param string $gid
186
-	 * @return bool
187
-	 */
188
-	public function groupExists($gid) {
189
-		return !is_null($this->get($gid));
190
-	}
184
+    /**
185
+     * @param string $gid
186
+     * @return bool
187
+     */
188
+    public function groupExists($gid) {
189
+        return !is_null($this->get($gid));
190
+    }
191 191
 
192
-	/**
193
-	 * @param string $gid
194
-	 * @return \OC\Group\Group
195
-	 */
196
-	public function createGroup($gid) {
197
-		if ($gid === '' || is_null($gid)) {
198
-			return false;
199
-		} else if ($group = $this->get($gid)) {
200
-			return $group;
201
-		} else {
202
-			$this->emit('\OC\Group', 'preCreate', array($gid));
203
-			foreach ($this->backends as $backend) {
204
-				if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) {
205
-					$backend->createGroup($gid);
206
-					$group = $this->getGroupObject($gid);
207
-					$this->emit('\OC\Group', 'postCreate', array($group));
208
-					return $group;
209
-				}
210
-			}
211
-			return null;
212
-		}
213
-	}
192
+    /**
193
+     * @param string $gid
194
+     * @return \OC\Group\Group
195
+     */
196
+    public function createGroup($gid) {
197
+        if ($gid === '' || is_null($gid)) {
198
+            return false;
199
+        } else if ($group = $this->get($gid)) {
200
+            return $group;
201
+        } else {
202
+            $this->emit('\OC\Group', 'preCreate', array($gid));
203
+            foreach ($this->backends as $backend) {
204
+                if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) {
205
+                    $backend->createGroup($gid);
206
+                    $group = $this->getGroupObject($gid);
207
+                    $this->emit('\OC\Group', 'postCreate', array($group));
208
+                    return $group;
209
+                }
210
+            }
211
+            return null;
212
+        }
213
+    }
214 214
 
215
-	/**
216
-	 * @param string $search
217
-	 * @param int $limit
218
-	 * @param int $offset
219
-	 * @return \OC\Group\Group[]
220
-	 */
221
-	public function search($search, $limit = null, $offset = null) {
222
-		$groups = array();
223
-		foreach ($this->backends as $backend) {
224
-			$groupIds = $backend->getGroups($search, $limit, $offset);
225
-			foreach ($groupIds as $groupId) {
226
-				$groups[$groupId] = $this->get($groupId);
227
-			}
228
-			if (!is_null($limit) and $limit <= 0) {
229
-				return array_values($groups);
230
-			}
231
-		}
232
-		return array_values($groups);
233
-	}
215
+    /**
216
+     * @param string $search
217
+     * @param int $limit
218
+     * @param int $offset
219
+     * @return \OC\Group\Group[]
220
+     */
221
+    public function search($search, $limit = null, $offset = null) {
222
+        $groups = array();
223
+        foreach ($this->backends as $backend) {
224
+            $groupIds = $backend->getGroups($search, $limit, $offset);
225
+            foreach ($groupIds as $groupId) {
226
+                $groups[$groupId] = $this->get($groupId);
227
+            }
228
+            if (!is_null($limit) and $limit <= 0) {
229
+                return array_values($groups);
230
+            }
231
+        }
232
+        return array_values($groups);
233
+    }
234 234
 
235
-	/**
236
-	 * @param \OC\User\User|null $user
237
-	 * @return \OC\Group\Group[]
238
-	 */
239
-	public function getUserGroups($user) {
240
-		if (is_null($user)) {
241
-			return [];
242
-		}
243
-		return $this->getUserIdGroups($user->getUID());
244
-	}
235
+    /**
236
+     * @param \OC\User\User|null $user
237
+     * @return \OC\Group\Group[]
238
+     */
239
+    public function getUserGroups($user) {
240
+        if (is_null($user)) {
241
+            return [];
242
+        }
243
+        return $this->getUserIdGroups($user->getUID());
244
+    }
245 245
 
246
-	/**
247
-	 * @param string $uid the user id
248
-	 * @return \OC\Group\Group[]
249
-	 */
250
-	public function getUserIdGroups($uid) {
251
-		if (isset($this->cachedUserGroups[$uid])) {
252
-			return $this->cachedUserGroups[$uid];
253
-		}
254
-		$groups = array();
255
-		foreach ($this->backends as $backend) {
256
-			$groupIds = $backend->getUserGroups($uid);
257
-			if (is_array($groupIds)) {
258
-				foreach ($groupIds as $groupId) {
259
-					$groups[$groupId] = $this->get($groupId);
260
-				}
261
-			}
262
-		}
263
-		$this->cachedUserGroups[$uid] = $groups;
264
-		return $this->cachedUserGroups[$uid];
265
-	}
246
+    /**
247
+     * @param string $uid the user id
248
+     * @return \OC\Group\Group[]
249
+     */
250
+    public function getUserIdGroups($uid) {
251
+        if (isset($this->cachedUserGroups[$uid])) {
252
+            return $this->cachedUserGroups[$uid];
253
+        }
254
+        $groups = array();
255
+        foreach ($this->backends as $backend) {
256
+            $groupIds = $backend->getUserGroups($uid);
257
+            if (is_array($groupIds)) {
258
+                foreach ($groupIds as $groupId) {
259
+                    $groups[$groupId] = $this->get($groupId);
260
+                }
261
+            }
262
+        }
263
+        $this->cachedUserGroups[$uid] = $groups;
264
+        return $this->cachedUserGroups[$uid];
265
+    }
266 266
 
267
-	/**
268
-	 * Checks if a userId is in the admin group
269
-	 * @param string $userId
270
-	 * @return bool if admin
271
-	 */
272
-	public function isAdmin($userId) {
273
-		return $this->isInGroup($userId, 'admin');
274
-	}
267
+    /**
268
+     * Checks if a userId is in the admin group
269
+     * @param string $userId
270
+     * @return bool if admin
271
+     */
272
+    public function isAdmin($userId) {
273
+        return $this->isInGroup($userId, 'admin');
274
+    }
275 275
 
276
-	/**
277
-	 * Checks if a userId is in a group
278
-	 * @param string $userId
279
-	 * @param string $group
280
-	 * @return bool if in group
281
-	 */
282
-	public function isInGroup($userId, $group) {
283
-		return array_key_exists($group, $this->getUserIdGroups($userId));
284
-	}
276
+    /**
277
+     * Checks if a userId is in a group
278
+     * @param string $userId
279
+     * @param string $group
280
+     * @return bool if in group
281
+     */
282
+    public function isInGroup($userId, $group) {
283
+        return array_key_exists($group, $this->getUserIdGroups($userId));
284
+    }
285 285
 
286
-	/**
287
-	 * get a list of group ids for a user
288
-	 * @param \OC\User\User $user
289
-	 * @return array with group ids
290
-	 */
291
-	public function getUserGroupIds($user) {
292
-		return array_map(function($value) {
293
-			return (string) $value;
294
-		}, array_keys($this->getUserGroups($user)));
295
-	}
286
+    /**
287
+     * get a list of group ids for a user
288
+     * @param \OC\User\User $user
289
+     * @return array with group ids
290
+     */
291
+    public function getUserGroupIds($user) {
292
+        return array_map(function($value) {
293
+            return (string) $value;
294
+        }, array_keys($this->getUserGroups($user)));
295
+    }
296 296
 
297
-	/**
298
-	 * get a list of all display names in a group
299
-	 * @param string $gid
300
-	 * @param string $search
301
-	 * @param int $limit
302
-	 * @param int $offset
303
-	 * @return array an array of display names (value) and user ids (key)
304
-	 */
305
-	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
306
-		$group = $this->get($gid);
307
-		if(is_null($group)) {
308
-			return array();
309
-		}
297
+    /**
298
+     * get a list of all display names in a group
299
+     * @param string $gid
300
+     * @param string $search
301
+     * @param int $limit
302
+     * @param int $offset
303
+     * @return array an array of display names (value) and user ids (key)
304
+     */
305
+    public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
306
+        $group = $this->get($gid);
307
+        if(is_null($group)) {
308
+            return array();
309
+        }
310 310
 
311
-		$search = trim($search);
312
-		$groupUsers = array();
311
+        $search = trim($search);
312
+        $groupUsers = array();
313 313
 
314
-		if(!empty($search)) {
315
-			// only user backends have the capability to do a complex search for users
316
-			$searchOffset = 0;
317
-			$searchLimit = $limit * 100;
318
-			if($limit === -1) {
319
-				$searchLimit = 500;
320
-			}
314
+        if(!empty($search)) {
315
+            // only user backends have the capability to do a complex search for users
316
+            $searchOffset = 0;
317
+            $searchLimit = $limit * 100;
318
+            if($limit === -1) {
319
+                $searchLimit = 500;
320
+            }
321 321
 
322
-			do {
323
-				$filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
324
-				foreach($filteredUsers as $filteredUser) {
325
-					if($group->inGroup($filteredUser)) {
326
-						$groupUsers[]= $filteredUser;
327
-					}
328
-				}
329
-				$searchOffset += $searchLimit;
330
-			} while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
322
+            do {
323
+                $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
324
+                foreach($filteredUsers as $filteredUser) {
325
+                    if($group->inGroup($filteredUser)) {
326
+                        $groupUsers[]= $filteredUser;
327
+                    }
328
+                }
329
+                $searchOffset += $searchLimit;
330
+            } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
331 331
 
332
-			if($limit === -1) {
333
-				$groupUsers = array_slice($groupUsers, $offset);
334
-			} else {
335
-				$groupUsers = array_slice($groupUsers, $offset, $limit);
336
-			}
337
-		} else {
338
-			$groupUsers = $group->searchUsers('', $limit, $offset);
339
-		}
332
+            if($limit === -1) {
333
+                $groupUsers = array_slice($groupUsers, $offset);
334
+            } else {
335
+                $groupUsers = array_slice($groupUsers, $offset, $limit);
336
+            }
337
+        } else {
338
+            $groupUsers = $group->searchUsers('', $limit, $offset);
339
+        }
340 340
 
341
-		$matchingUsers = array();
342
-		foreach($groupUsers as $groupUser) {
343
-			$matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
344
-		}
345
-		return $matchingUsers;
346
-	}
341
+        $matchingUsers = array();
342
+        foreach($groupUsers as $groupUser) {
343
+            $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
344
+        }
345
+        return $matchingUsers;
346
+    }
347 347
 
348
-	/**
349
-	 * @return \OC\SubAdmin
350
-	 */
351
-	public function getSubAdmin() {
352
-		if (!$this->subAdmin) {
353
-			$this->subAdmin = new \OC\SubAdmin(
354
-				$this->userManager,
355
-				$this,
356
-				\OC::$server->getDatabaseConnection()
357
-			);
358
-		}
348
+    /**
349
+     * @return \OC\SubAdmin
350
+     */
351
+    public function getSubAdmin() {
352
+        if (!$this->subAdmin) {
353
+            $this->subAdmin = new \OC\SubAdmin(
354
+                $this->userManager,
355
+                $this,
356
+                \OC::$server->getDatabaseConnection()
357
+            );
358
+        }
359 359
 
360
-		return $this->subAdmin;
361
-	}
360
+        return $this->subAdmin;
361
+    }
362 362
 }
Please login to merge, or discard this patch.
Spacing   +12 added lines, -12 removed lines patch added patch discarded remove patch
@@ -85,20 +85,20 @@  discard block
 block discarded – undo
85 85
 		$this->userManager = $userManager;
86 86
 		$cachedGroups = & $this->cachedGroups;
87 87
 		$cachedUserGroups = & $this->cachedUserGroups;
88
-		$this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
88
+		$this->listen('\OC\Group', 'postDelete', function($group) use (&$cachedGroups, &$cachedUserGroups) {
89 89
 			/**
90 90
 			 * @var \OC\Group\Group $group
91 91
 			 */
92 92
 			unset($cachedGroups[$group->getGID()]);
93 93
 			$cachedUserGroups = array();
94 94
 		});
95
-		$this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
95
+		$this->listen('\OC\Group', 'postAddUser', function($group) use (&$cachedUserGroups) {
96 96
 			/**
97 97
 			 * @var \OC\Group\Group $group
98 98
 			 */
99 99
 			$cachedUserGroups = array();
100 100
 		});
101
-		$this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
101
+		$this->listen('\OC\Group', 'postRemoveUser', function($group) use (&$cachedUserGroups) {
102 102
 			/**
103 103
 			 * @var \OC\Group\Group $group
104 104
 			 */
@@ -304,32 +304,32 @@  discard block
 block discarded – undo
304 304
 	 */
305 305
 	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
306 306
 		$group = $this->get($gid);
307
-		if(is_null($group)) {
307
+		if (is_null($group)) {
308 308
 			return array();
309 309
 		}
310 310
 
311 311
 		$search = trim($search);
312 312
 		$groupUsers = array();
313 313
 
314
-		if(!empty($search)) {
314
+		if (!empty($search)) {
315 315
 			// only user backends have the capability to do a complex search for users
316 316
 			$searchOffset = 0;
317 317
 			$searchLimit = $limit * 100;
318
-			if($limit === -1) {
318
+			if ($limit === -1) {
319 319
 				$searchLimit = 500;
320 320
 			}
321 321
 
322 322
 			do {
323 323
 				$filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
324
-				foreach($filteredUsers as $filteredUser) {
325
-					if($group->inGroup($filteredUser)) {
326
-						$groupUsers[]= $filteredUser;
324
+				foreach ($filteredUsers as $filteredUser) {
325
+					if ($group->inGroup($filteredUser)) {
326
+						$groupUsers[] = $filteredUser;
327 327
 					}
328 328
 				}
329 329
 				$searchOffset += $searchLimit;
330
-			} while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
330
+			} while (count($groupUsers) < $searchLimit + $offset && count($filteredUsers) >= $searchLimit);
331 331
 
332
-			if($limit === -1) {
332
+			if ($limit === -1) {
333 333
 				$groupUsers = array_slice($groupUsers, $offset);
334 334
 			} else {
335 335
 				$groupUsers = array_slice($groupUsers, $offset, $limit);
@@ -339,7 +339,7 @@  discard block
 block discarded – undo
339 339
 		}
340 340
 
341 341
 		$matchingUsers = array();
342
-		foreach($groupUsers as $groupUser) {
342
+		foreach ($groupUsers as $groupUser) {
343 343
 			$matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
344 344
 		}
345 345
 		return $matchingUsers;
Please login to merge, or discard this patch.
lib/private/legacy/template/functions.php 3 patches
Doc Comments   +2 added lines, -1 removed lines patch added patch discarded remove patch
@@ -183,7 +183,7 @@  discard block
 block discarded – undo
183 183
  * make preview_icon available as a simple function
184 184
  * Returns the path to the preview of the image.
185 185
  * @param string $path path of file
186
- * @return link to the preview
186
+ * @return string to the preview
187 187
  */
188 188
 function preview_icon( $path ) {
189 189
 	return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]);
@@ -191,6 +191,7 @@  discard block
 block discarded – undo
191 191
 
192 192
 /**
193 193
  * @param string $path
194
+ * @param string $token
194 195
  */
195 196
 function publicPreview_icon ( $path, $token ) {
196 197
 	return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]);
Please login to merge, or discard this patch.
Indentation   +81 added lines, -81 removed lines patch added patch discarded remove patch
@@ -34,7 +34,7 @@  discard block
 block discarded – undo
34 34
  * @param string $string the string which will be escaped and printed
35 35
  */
36 36
 function p($string) {
37
-	print(\OCP\Util::sanitizeHTML($string));
37
+    print(\OCP\Util::sanitizeHTML($string));
38 38
 }
39 39
 
40 40
 /**
@@ -43,7 +43,7 @@  discard block
 block discarded – undo
43 43
  * @param string|array $string the string which will be printed as it is
44 44
  */
45 45
 function print_unescaped($string) {
46
-	print($string);
46
+    print($string);
47 47
 }
48 48
 
49 49
 /**
@@ -53,13 +53,13 @@  discard block
 block discarded – undo
53 53
  * if an array is given it will add all scripts
54 54
  */
55 55
 function script($app, $file = null) {
56
-	if(is_array($file)) {
57
-		foreach($file as $f) {
58
-			OC_Util::addScript($app, $f);
59
-		}
60
-	} else {
61
-		OC_Util::addScript($app, $file);
62
-	}
56
+    if(is_array($file)) {
57
+        foreach($file as $f) {
58
+            OC_Util::addScript($app, $f);
59
+        }
60
+    } else {
61
+        OC_Util::addScript($app, $file);
62
+    }
63 63
 }
64 64
 
65 65
 /**
@@ -69,13 +69,13 @@  discard block
 block discarded – undo
69 69
  * if an array is given it will add all scripts
70 70
  */
71 71
 function vendor_script($app, $file = null) {
72
-	if(is_array($file)) {
73
-		foreach($file as $f) {
74
-			OC_Util::addVendorScript($app, $f);
75
-		}
76
-	} else {
77
-		OC_Util::addVendorScript($app, $file);
78
-	}
72
+    if(is_array($file)) {
73
+        foreach($file as $f) {
74
+            OC_Util::addVendorScript($app, $f);
75
+        }
76
+    } else {
77
+        OC_Util::addVendorScript($app, $file);
78
+    }
79 79
 }
80 80
 
81 81
 /**
@@ -85,13 +85,13 @@  discard block
 block discarded – undo
85 85
  * if an array is given it will add all styles
86 86
  */
87 87
 function style($app, $file = null) {
88
-	if(is_array($file)) {
89
-		foreach($file as $f) {
90
-			OC_Util::addStyle($app, $f);
91
-		}
92
-	} else {
93
-		OC_Util::addStyle($app, $file);
94
-	}
88
+    if(is_array($file)) {
89
+        foreach($file as $f) {
90
+            OC_Util::addStyle($app, $f);
91
+        }
92
+    } else {
93
+        OC_Util::addStyle($app, $file);
94
+    }
95 95
 }
96 96
 
97 97
 /**
@@ -101,13 +101,13 @@  discard block
 block discarded – undo
101 101
  * if an array is given it will add all styles
102 102
  */
103 103
 function vendor_style($app, $file = null) {
104
-	if(is_array($file)) {
105
-		foreach($file as $f) {
106
-			OC_Util::addVendorStyle($app, $f);
107
-		}
108
-	} else {
109
-		OC_Util::addVendorStyle($app, $file);
110
-	}
104
+    if(is_array($file)) {
105
+        foreach($file as $f) {
106
+            OC_Util::addVendorStyle($app, $f);
107
+        }
108
+    } else {
109
+        OC_Util::addVendorStyle($app, $file);
110
+    }
111 111
 }
112 112
 
113 113
 /**
@@ -116,7 +116,7 @@  discard block
 block discarded – undo
116 116
  * if an array is given it will add all styles
117 117
  */
118 118
 function translation($app) {
119
-	OC_Util::addTranslations($app);
119
+    OC_Util::addTranslations($app);
120 120
 }
121 121
 
122 122
 /**
@@ -126,15 +126,15 @@  discard block
 block discarded – undo
126 126
  * if an array is given it will add all components
127 127
  */
128 128
 function component($app, $file) {
129
-	if(is_array($file)) {
130
-		foreach($file as $f) {
131
-			$url = link_to($app, 'component/' . $f . '.html');
132
-			OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url));
133
-		}
134
-	} else {
135
-		$url = link_to($app, 'component/' . $file . '.html');
136
-		OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url));
137
-	}
129
+    if(is_array($file)) {
130
+        foreach($file as $f) {
131
+            $url = link_to($app, 'component/' . $f . '.html');
132
+            OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url));
133
+        }
134
+    } else {
135
+        $url = link_to($app, 'component/' . $file . '.html');
136
+        OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url));
137
+    }
138 138
 }
139 139
 
140 140
 /**
@@ -147,7 +147,7 @@  discard block
 block discarded – undo
147 147
  * For further information have a look at \OCP\IURLGenerator::linkTo
148 148
  */
149 149
 function link_to( $app, $file, $args = array() ) {
150
-	return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
150
+    return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
151 151
 }
152 152
 
153 153
 /**
@@ -155,7 +155,7 @@  discard block
 block discarded – undo
155 155
  * @return string url to the online documentation
156 156
  */
157 157
 function link_to_docs($key) {
158
-	return \OC::$server->getURLGenerator()->linkToDocs($key);
158
+    return \OC::$server->getURLGenerator()->linkToDocs($key);
159 159
 }
160 160
 
161 161
 /**
@@ -167,7 +167,7 @@  discard block
 block discarded – undo
167 167
  * For further information have a look at \OCP\IURLGenerator::imagePath
168 168
  */
169 169
 function image_path( $app, $image ) {
170
-	return \OC::$server->getURLGenerator()->imagePath( $app, $image );
170
+    return \OC::$server->getURLGenerator()->imagePath( $app, $image );
171 171
 }
172 172
 
173 173
 /**
@@ -176,7 +176,7 @@  discard block
 block discarded – undo
176 176
  * @return string link to the image
177 177
  */
178 178
 function mimetype_icon( $mimetype ) {
179
-	return \OC::$server->getMimeTypeDetector()->mimeTypeIcon( $mimetype );
179
+    return \OC::$server->getMimeTypeDetector()->mimeTypeIcon( $mimetype );
180 180
 }
181 181
 
182 182
 /**
@@ -186,14 +186,14 @@  discard block
 block discarded – undo
186 186
  * @return link to the preview
187 187
  */
188 188
 function preview_icon( $path ) {
189
-	return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]);
189
+    return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]);
190 190
 }
191 191
 
192 192
 /**
193 193
  * @param string $path
194 194
  */
195 195
 function publicPreview_icon ( $path, $token ) {
196
-	return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]);
196
+    return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]);
197 197
 }
198 198
 
199 199
 /**
@@ -204,7 +204,7 @@  discard block
 block discarded – undo
204 204
  * For further information have a look at OC_Helper::humanFileSize
205 205
  */
206 206
 function human_file_size( $bytes ) {
207
-	return OC_Helper::humanFileSize( $bytes );
207
+    return OC_Helper::humanFileSize( $bytes );
208 208
 }
209 209
 
210 210
 /**
@@ -213,9 +213,9 @@  discard block
 block discarded – undo
213 213
  * @return $timestamp without time value
214 214
  */
215 215
 function strip_time($timestamp){
216
-	$date = new \DateTime("@{$timestamp}");
217
-	$date->setTime(0, 0, 0);
218
-	return intval($date->format('U'));
216
+    $date = new \DateTime("@{$timestamp}");
217
+    $date->setTime(0, 0, 0);
218
+    return intval($date->format('U'));
219 219
 }
220 220
 
221 221
 /**
@@ -227,39 +227,39 @@  discard block
 block discarded – undo
227 227
  * @return string timestamp
228 228
  */
229 229
 function relative_modified_date($timestamp, $fromTime = null, $dateOnly = false) {
230
-	/** @var \OC\DateTimeFormatter $formatter */
231
-	$formatter = \OC::$server->query('DateTimeFormatter');
230
+    /** @var \OC\DateTimeFormatter $formatter */
231
+    $formatter = \OC::$server->query('DateTimeFormatter');
232 232
 
233
-	if ($dateOnly){
234
-		return $formatter->formatDateSpan($timestamp, $fromTime);
235
-	}
236
-	return $formatter->formatTimeSpan($timestamp, $fromTime);
233
+    if ($dateOnly){
234
+        return $formatter->formatDateSpan($timestamp, $fromTime);
235
+    }
236
+    return $formatter->formatTimeSpan($timestamp, $fromTime);
237 237
 }
238 238
 
239 239
 function html_select_options($options, $selected, $params=array()) {
240
-	if (!is_array($selected)) {
241
-		$selected=array($selected);
242
-	}
243
-	if (isset($params['combine']) && $params['combine']) {
244
-		$options = array_combine($options, $options);
245
-	}
246
-	$value_name = $label_name = false;
247
-	if (isset($params['value'])) {
248
-		$value_name = $params['value'];
249
-	}
250
-	if (isset($params['label'])) {
251
-		$label_name = $params['label'];
252
-	}
253
-	$html = '';
254
-	foreach($options as $value => $label) {
255
-		if ($value_name && is_array($label)) {
256
-			$value = $label[$value_name];
257
-		}
258
-		if ($label_name && is_array($label)) {
259
-			$label = $label[$label_name];
260
-		}
261
-		$select = in_array($value, $selected) ? ' selected="selected"' : '';
262
-		$html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n";
263
-	}
264
-	return $html;
240
+    if (!is_array($selected)) {
241
+        $selected=array($selected);
242
+    }
243
+    if (isset($params['combine']) && $params['combine']) {
244
+        $options = array_combine($options, $options);
245
+    }
246
+    $value_name = $label_name = false;
247
+    if (isset($params['value'])) {
248
+        $value_name = $params['value'];
249
+    }
250
+    if (isset($params['label'])) {
251
+        $label_name = $params['label'];
252
+    }
253
+    $html = '';
254
+    foreach($options as $value => $label) {
255
+        if ($value_name && is_array($label)) {
256
+            $value = $label[$value_name];
257
+        }
258
+        if ($label_name && is_array($label)) {
259
+            $label = $label[$label_name];
260
+        }
261
+        $select = in_array($value, $selected) ? ' selected="selected"' : '';
262
+        $html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n";
263
+    }
264
+    return $html;
265 265
 }
Please login to merge, or discard this patch.
Spacing   +27 added lines, -27 removed lines patch added patch discarded remove patch
@@ -53,8 +53,8 @@  discard block
 block discarded – undo
53 53
  * if an array is given it will add all scripts
54 54
  */
55 55
 function script($app, $file = null) {
56
-	if(is_array($file)) {
57
-		foreach($file as $f) {
56
+	if (is_array($file)) {
57
+		foreach ($file as $f) {
58 58
 			OC_Util::addScript($app, $f);
59 59
 		}
60 60
 	} else {
@@ -69,8 +69,8 @@  discard block
 block discarded – undo
69 69
  * if an array is given it will add all scripts
70 70
  */
71 71
 function vendor_script($app, $file = null) {
72
-	if(is_array($file)) {
73
-		foreach($file as $f) {
72
+	if (is_array($file)) {
73
+		foreach ($file as $f) {
74 74
 			OC_Util::addVendorScript($app, $f);
75 75
 		}
76 76
 	} else {
@@ -85,8 +85,8 @@  discard block
 block discarded – undo
85 85
  * if an array is given it will add all styles
86 86
  */
87 87
 function style($app, $file = null) {
88
-	if(is_array($file)) {
89
-		foreach($file as $f) {
88
+	if (is_array($file)) {
89
+		foreach ($file as $f) {
90 90
 			OC_Util::addStyle($app, $f);
91 91
 		}
92 92
 	} else {
@@ -101,8 +101,8 @@  discard block
 block discarded – undo
101 101
  * if an array is given it will add all styles
102 102
  */
103 103
 function vendor_style($app, $file = null) {
104
-	if(is_array($file)) {
105
-		foreach($file as $f) {
104
+	if (is_array($file)) {
105
+		foreach ($file as $f) {
106 106
 			OC_Util::addVendorStyle($app, $f);
107 107
 		}
108 108
 	} else {
@@ -126,13 +126,13 @@  discard block
 block discarded – undo
126 126
  * if an array is given it will add all components
127 127
  */
128 128
 function component($app, $file) {
129
-	if(is_array($file)) {
130
-		foreach($file as $f) {
131
-			$url = link_to($app, 'component/' . $f . '.html');
129
+	if (is_array($file)) {
130
+		foreach ($file as $f) {
131
+			$url = link_to($app, 'component/'.$f.'.html');
132 132
 			OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url));
133 133
 		}
134 134
 	} else {
135
-		$url = link_to($app, 'component/' . $file . '.html');
135
+		$url = link_to($app, 'component/'.$file.'.html');
136 136
 		OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url));
137 137
 	}
138 138
 }
@@ -146,7 +146,7 @@  discard block
 block discarded – undo
146 146
  *
147 147
  * For further information have a look at \OCP\IURLGenerator::linkTo
148 148
  */
149
-function link_to( $app, $file, $args = array() ) {
149
+function link_to($app, $file, $args = array()) {
150 150
 	return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
151 151
 }
152 152
 
@@ -166,8 +166,8 @@  discard block
 block discarded – undo
166 166
  *
167 167
  * For further information have a look at \OCP\IURLGenerator::imagePath
168 168
  */
169
-function image_path( $app, $image ) {
170
-	return \OC::$server->getURLGenerator()->imagePath( $app, $image );
169
+function image_path($app, $image) {
170
+	return \OC::$server->getURLGenerator()->imagePath($app, $image);
171 171
 }
172 172
 
173 173
 /**
@@ -175,8 +175,8 @@  discard block
 block discarded – undo
175 175
  * @param string $mimetype mimetype
176 176
  * @return string link to the image
177 177
  */
178
-function mimetype_icon( $mimetype ) {
179
-	return \OC::$server->getMimeTypeDetector()->mimeTypeIcon( $mimetype );
178
+function mimetype_icon($mimetype) {
179
+	return \OC::$server->getMimeTypeDetector()->mimeTypeIcon($mimetype);
180 180
 }
181 181
 
182 182
 /**
@@ -185,14 +185,14 @@  discard block
 block discarded – undo
185 185
  * @param string $path path of file
186 186
  * @return link to the preview
187 187
  */
188
-function preview_icon( $path ) {
188
+function preview_icon($path) {
189 189
 	return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]);
190 190
 }
191 191
 
192 192
 /**
193 193
  * @param string $path
194 194
  */
195
-function publicPreview_icon ( $path, $token ) {
195
+function publicPreview_icon($path, $token) {
196 196
 	return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]);
197 197
 }
198 198
 
@@ -203,8 +203,8 @@  discard block
 block discarded – undo
203 203
  *
204 204
  * For further information have a look at OC_Helper::humanFileSize
205 205
  */
206
-function human_file_size( $bytes ) {
207
-	return OC_Helper::humanFileSize( $bytes );
206
+function human_file_size($bytes) {
207
+	return OC_Helper::humanFileSize($bytes);
208 208
 }
209 209
 
210 210
 /**
@@ -212,7 +212,7 @@  discard block
 block discarded – undo
212 212
  * @param int $timestamp UNIX timestamp to strip
213 213
  * @return $timestamp without time value
214 214
  */
215
-function strip_time($timestamp){
215
+function strip_time($timestamp) {
216 216
 	$date = new \DateTime("@{$timestamp}");
217 217
 	$date->setTime(0, 0, 0);
218 218
 	return intval($date->format('U'));
@@ -230,15 +230,15 @@  discard block
 block discarded – undo
230 230
 	/** @var \OC\DateTimeFormatter $formatter */
231 231
 	$formatter = \OC::$server->query('DateTimeFormatter');
232 232
 
233
-	if ($dateOnly){
233
+	if ($dateOnly) {
234 234
 		return $formatter->formatDateSpan($timestamp, $fromTime);
235 235
 	}
236 236
 	return $formatter->formatTimeSpan($timestamp, $fromTime);
237 237
 }
238 238
 
239
-function html_select_options($options, $selected, $params=array()) {
239
+function html_select_options($options, $selected, $params = array()) {
240 240
 	if (!is_array($selected)) {
241
-		$selected=array($selected);
241
+		$selected = array($selected);
242 242
 	}
243 243
 	if (isset($params['combine']) && $params['combine']) {
244 244
 		$options = array_combine($options, $options);
@@ -251,7 +251,7 @@  discard block
 block discarded – undo
251 251
 		$label_name = $params['label'];
252 252
 	}
253 253
 	$html = '';
254
-	foreach($options as $value => $label) {
254
+	foreach ($options as $value => $label) {
255 255
 		if ($value_name && is_array($label)) {
256 256
 			$value = $label[$value_name];
257 257
 		}
@@ -259,7 +259,7 @@  discard block
 block discarded – undo
259 259
 			$label = $label[$label_name];
260 260
 		}
261 261
 		$select = in_array($value, $selected) ? ' selected="selected"' : '';
262
-		$html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n";
262
+		$html .= '<option value="'.\OCP\Util::sanitizeHTML($value).'"'.$select.'>'.\OCP\Util::sanitizeHTML($label).'</option>'."\n";
263 263
 	}
264 264
 	return $html;
265 265
 }
Please login to merge, or discard this patch.
lib/private/Memcache/APCu.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -65,7 +65,7 @@
 block discarded – undo
65 65
 	 * Set a value in the cache if it's not already stored
66 66
 	 *
67 67
 	 * @param string $key
68
-	 * @param mixed $value
68
+	 * @param integer $value
69 69
 	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
70 70
 	 * @return bool
71 71
 	 */
Please login to merge, or discard this patch.
Indentation   +125 added lines, -125 removed lines patch added patch discarded remove patch
@@ -30,140 +30,140 @@
 block discarded – undo
30 30
 use OCP\IMemcache;
31 31
 
32 32
 class APCu extends Cache implements IMemcache {
33
-	use CASTrait {
34
-		cas as casEmulated;
35
-	}
33
+    use CASTrait {
34
+        cas as casEmulated;
35
+    }
36 36
 
37
-	use CADTrait;
37
+    use CADTrait;
38 38
 
39
-	public function get($key) {
40
-		$result = apcu_fetch($this->getPrefix() . $key, $success);
41
-		if (!$success) {
42
-			return null;
43
-		}
44
-		return $result;
45
-	}
39
+    public function get($key) {
40
+        $result = apcu_fetch($this->getPrefix() . $key, $success);
41
+        if (!$success) {
42
+            return null;
43
+        }
44
+        return $result;
45
+    }
46 46
 
47
-	public function set($key, $value, $ttl = 0) {
48
-		return apcu_store($this->getPrefix() . $key, $value, $ttl);
49
-	}
47
+    public function set($key, $value, $ttl = 0) {
48
+        return apcu_store($this->getPrefix() . $key, $value, $ttl);
49
+    }
50 50
 
51
-	public function hasKey($key) {
52
-		return apcu_exists($this->getPrefix() . $key);
53
-	}
51
+    public function hasKey($key) {
52
+        return apcu_exists($this->getPrefix() . $key);
53
+    }
54 54
 
55
-	public function remove($key) {
56
-		return apcu_delete($this->getPrefix() . $key);
57
-	}
55
+    public function remove($key) {
56
+        return apcu_delete($this->getPrefix() . $key);
57
+    }
58 58
 
59
-	public function clear($prefix = '') {
60
-		$ns = $this->getPrefix() . $prefix;
61
-		$ns = preg_quote($ns, '/');
62
-		if(class_exists('\APCIterator')) {
63
-			$iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
64
-		} else {
65
-			$iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
66
-		}
67
-		return apcu_delete($iter);
68
-	}
59
+    public function clear($prefix = '') {
60
+        $ns = $this->getPrefix() . $prefix;
61
+        $ns = preg_quote($ns, '/');
62
+        if(class_exists('\APCIterator')) {
63
+            $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
64
+        } else {
65
+            $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
66
+        }
67
+        return apcu_delete($iter);
68
+    }
69 69
 
70
-	/**
71
-	 * Set a value in the cache if it's not already stored
72
-	 *
73
-	 * @param string $key
74
-	 * @param mixed $value
75
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
76
-	 * @return bool
77
-	 */
78
-	public function add($key, $value, $ttl = 0) {
79
-		return apcu_add($this->getPrefix() . $key, $value, $ttl);
80
-	}
70
+    /**
71
+     * Set a value in the cache if it's not already stored
72
+     *
73
+     * @param string $key
74
+     * @param mixed $value
75
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
76
+     * @return bool
77
+     */
78
+    public function add($key, $value, $ttl = 0) {
79
+        return apcu_add($this->getPrefix() . $key, $value, $ttl);
80
+    }
81 81
 
82
-	/**
83
-	 * Increase a stored number
84
-	 *
85
-	 * @param string $key
86
-	 * @param int $step
87
-	 * @return int | bool
88
-	 */
89
-	public function inc($key, $step = 1) {
90
-		$this->add($key, 0);
91
-		/**
92
-		 * TODO - hack around a PHP 7 specific issue in APCu
93
-		 *
94
-		 * on PHP 7 the apcu_inc method on a non-existing object will increment
95
-		 * "0" and result in "1" as value - therefore we check for existence
96
-		 * first
97
-		 *
98
-		 * on PHP 5.6 this is not the case
99
-		 *
100
-		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
101
-		 * for details
102
-		 */
103
-		return apcu_exists($this->getPrefix() . $key)
104
-			? apcu_inc($this->getPrefix() . $key, $step)
105
-			: false;
106
-	}
82
+    /**
83
+     * Increase a stored number
84
+     *
85
+     * @param string $key
86
+     * @param int $step
87
+     * @return int | bool
88
+     */
89
+    public function inc($key, $step = 1) {
90
+        $this->add($key, 0);
91
+        /**
92
+         * TODO - hack around a PHP 7 specific issue in APCu
93
+         *
94
+         * on PHP 7 the apcu_inc method on a non-existing object will increment
95
+         * "0" and result in "1" as value - therefore we check for existence
96
+         * first
97
+         *
98
+         * on PHP 5.6 this is not the case
99
+         *
100
+         * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
101
+         * for details
102
+         */
103
+        return apcu_exists($this->getPrefix() . $key)
104
+            ? apcu_inc($this->getPrefix() . $key, $step)
105
+            : false;
106
+    }
107 107
 
108
-	/**
109
-	 * Decrease a stored number
110
-	 *
111
-	 * @param string $key
112
-	 * @param int $step
113
-	 * @return int | bool
114
-	 */
115
-	public function dec($key, $step = 1) {
116
-		/**
117
-		 * TODO - hack around a PHP 7 specific issue in APCu
118
-		 *
119
-		 * on PHP 7 the apcu_dec method on a non-existing object will decrement
120
-		 * "0" and result in "-1" as value - therefore we check for existence
121
-		 * first
122
-		 *
123
-		 * on PHP 5.6 this is not the case
124
-		 *
125
-		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
126
-		 * for details
127
-		 */
128
-		return apcu_exists($this->getPrefix() . $key)
129
-			? apcu_dec($this->getPrefix() . $key, $step)
130
-			: false;
131
-	}
108
+    /**
109
+     * Decrease a stored number
110
+     *
111
+     * @param string $key
112
+     * @param int $step
113
+     * @return int | bool
114
+     */
115
+    public function dec($key, $step = 1) {
116
+        /**
117
+         * TODO - hack around a PHP 7 specific issue in APCu
118
+         *
119
+         * on PHP 7 the apcu_dec method on a non-existing object will decrement
120
+         * "0" and result in "-1" as value - therefore we check for existence
121
+         * first
122
+         *
123
+         * on PHP 5.6 this is not the case
124
+         *
125
+         * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
126
+         * for details
127
+         */
128
+        return apcu_exists($this->getPrefix() . $key)
129
+            ? apcu_dec($this->getPrefix() . $key, $step)
130
+            : false;
131
+    }
132 132
 
133
-	/**
134
-	 * Compare and set
135
-	 *
136
-	 * @param string $key
137
-	 * @param mixed $old
138
-	 * @param mixed $new
139
-	 * @return bool
140
-	 */
141
-	public function cas($key, $old, $new) {
142
-		// apc only does cas for ints
143
-		if (is_int($old) and is_int($new)) {
144
-			return apcu_cas($this->getPrefix() . $key, $old, $new);
145
-		} else {
146
-			return $this->casEmulated($key, $old, $new);
147
-		}
148
-	}
133
+    /**
134
+     * Compare and set
135
+     *
136
+     * @param string $key
137
+     * @param mixed $old
138
+     * @param mixed $new
139
+     * @return bool
140
+     */
141
+    public function cas($key, $old, $new) {
142
+        // apc only does cas for ints
143
+        if (is_int($old) and is_int($new)) {
144
+            return apcu_cas($this->getPrefix() . $key, $old, $new);
145
+        } else {
146
+            return $this->casEmulated($key, $old, $new);
147
+        }
148
+    }
149 149
 
150
-	/**
151
-	 * @return bool
152
-	 */
153
-	static public function isAvailable() {
154
-		if (!extension_loaded('apcu')) {
155
-			return false;
156
-		} elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) {
157
-			return false;
158
-		} elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) {
159
-			return false;
160
-		} elseif (
161
-				version_compare(phpversion('apc'), '4.0.6') === -1 &&
162
-				version_compare(phpversion('apcu'), '5.1.0') === -1
163
-		) {
164
-			return false;
165
-		} else {
166
-			return true;
167
-		}
168
-	}
150
+    /**
151
+     * @return bool
152
+     */
153
+    static public function isAvailable() {
154
+        if (!extension_loaded('apcu')) {
155
+            return false;
156
+        } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) {
157
+            return false;
158
+        } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) {
159
+            return false;
160
+        } elseif (
161
+                version_compare(phpversion('apc'), '4.0.6') === -1 &&
162
+                version_compare(phpversion('apcu'), '5.1.0') === -1
163
+        ) {
164
+            return false;
165
+        } else {
166
+            return true;
167
+        }
168
+    }
169 169
 }
Please login to merge, or discard this patch.
Spacing   +14 added lines, -14 removed lines patch added patch discarded remove patch
@@ -37,7 +37,7 @@  discard block
 block discarded – undo
37 37
 	use CADTrait;
38 38
 
39 39
 	public function get($key) {
40
-		$result = apcu_fetch($this->getPrefix() . $key, $success);
40
+		$result = apcu_fetch($this->getPrefix().$key, $success);
41 41
 		if (!$success) {
42 42
 			return null;
43 43
 		}
@@ -45,24 +45,24 @@  discard block
 block discarded – undo
45 45
 	}
46 46
 
47 47
 	public function set($key, $value, $ttl = 0) {
48
-		return apcu_store($this->getPrefix() . $key, $value, $ttl);
48
+		return apcu_store($this->getPrefix().$key, $value, $ttl);
49 49
 	}
50 50
 
51 51
 	public function hasKey($key) {
52
-		return apcu_exists($this->getPrefix() . $key);
52
+		return apcu_exists($this->getPrefix().$key);
53 53
 	}
54 54
 
55 55
 	public function remove($key) {
56
-		return apcu_delete($this->getPrefix() . $key);
56
+		return apcu_delete($this->getPrefix().$key);
57 57
 	}
58 58
 
59 59
 	public function clear($prefix = '') {
60
-		$ns = $this->getPrefix() . $prefix;
60
+		$ns = $this->getPrefix().$prefix;
61 61
 		$ns = preg_quote($ns, '/');
62
-		if(class_exists('\APCIterator')) {
63
-			$iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
62
+		if (class_exists('\APCIterator')) {
63
+			$iter = new \APCIterator('user', '/^'.$ns.'/', APC_ITER_KEY);
64 64
 		} else {
65
-			$iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
65
+			$iter = new \APCUIterator('/^'.$ns.'/', APC_ITER_KEY);
66 66
 		}
67 67
 		return apcu_delete($iter);
68 68
 	}
@@ -76,7 +76,7 @@  discard block
 block discarded – undo
76 76
 	 * @return bool
77 77
 	 */
78 78
 	public function add($key, $value, $ttl = 0) {
79
-		return apcu_add($this->getPrefix() . $key, $value, $ttl);
79
+		return apcu_add($this->getPrefix().$key, $value, $ttl);
80 80
 	}
81 81
 
82 82
 	/**
@@ -100,8 +100,8 @@  discard block
 block discarded – undo
100 100
 		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
101 101
 		 * for details
102 102
 		 */
103
-		return apcu_exists($this->getPrefix() . $key)
104
-			? apcu_inc($this->getPrefix() . $key, $step)
103
+		return apcu_exists($this->getPrefix().$key)
104
+			? apcu_inc($this->getPrefix().$key, $step)
105 105
 			: false;
106 106
 	}
107 107
 
@@ -125,8 +125,8 @@  discard block
 block discarded – undo
125 125
 		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
126 126
 		 * for details
127 127
 		 */
128
-		return apcu_exists($this->getPrefix() . $key)
129
-			? apcu_dec($this->getPrefix() . $key, $step)
128
+		return apcu_exists($this->getPrefix().$key)
129
+			? apcu_dec($this->getPrefix().$key, $step)
130 130
 			: false;
131 131
 	}
132 132
 
@@ -141,7 +141,7 @@  discard block
 block discarded – undo
141 141
 	public function cas($key, $old, $new) {
142 142
 		// apc only does cas for ints
143 143
 		if (is_int($old) and is_int($new)) {
144
-			return apcu_cas($this->getPrefix() . $key, $old, $new);
144
+			return apcu_cas($this->getPrefix().$key, $old, $new);
145 145
 		} else {
146 146
 			return $this->casEmulated($key, $old, $new);
147 147
 		}
Please login to merge, or discard this patch.
lib/private/Memcache/ArrayCache.php 2 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -65,7 +65,7 @@
 block discarded – undo
65 65
 	 * Set a value in the cache if it's not already stored
66 66
 	 *
67 67
 	 * @param string $key
68
-	 * @param mixed $value
68
+	 * @param integer $value
69 69
 	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
70 70
 	 * @return bool
71 71
 	 */
Please login to merge, or discard this patch.
Indentation   +117 added lines, -117 removed lines patch added patch discarded remove patch
@@ -27,133 +27,133 @@
 block discarded – undo
27 27
 use OCP\IMemcache;
28 28
 
29 29
 class ArrayCache extends Cache implements IMemcache {
30
-	/** @var array Array with the cached data */
31
-	protected $cachedData = array();
30
+    /** @var array Array with the cached data */
31
+    protected $cachedData = array();
32 32
 
33
-	use CADTrait;
33
+    use CADTrait;
34 34
 
35
-	/**
36
-	 * {@inheritDoc}
37
-	 */
38
-	public function get($key) {
39
-		if ($this->hasKey($key)) {
40
-			return $this->cachedData[$key];
41
-		}
42
-		return null;
43
-	}
35
+    /**
36
+     * {@inheritDoc}
37
+     */
38
+    public function get($key) {
39
+        if ($this->hasKey($key)) {
40
+            return $this->cachedData[$key];
41
+        }
42
+        return null;
43
+    }
44 44
 
45
-	/**
46
-	 * {@inheritDoc}
47
-	 */
48
-	public function set($key, $value, $ttl = 0) {
49
-		$this->cachedData[$key] = $value;
50
-		return true;
51
-	}
45
+    /**
46
+     * {@inheritDoc}
47
+     */
48
+    public function set($key, $value, $ttl = 0) {
49
+        $this->cachedData[$key] = $value;
50
+        return true;
51
+    }
52 52
 
53
-	/**
54
-	 * {@inheritDoc}
55
-	 */
56
-	public function hasKey($key) {
57
-		return isset($this->cachedData[$key]);
58
-	}
53
+    /**
54
+     * {@inheritDoc}
55
+     */
56
+    public function hasKey($key) {
57
+        return isset($this->cachedData[$key]);
58
+    }
59 59
 
60
-	/**
61
-	 * {@inheritDoc}
62
-	 */
63
-	public function remove($key) {
64
-		unset($this->cachedData[$key]);
65
-		return true;
66
-	}
60
+    /**
61
+     * {@inheritDoc}
62
+     */
63
+    public function remove($key) {
64
+        unset($this->cachedData[$key]);
65
+        return true;
66
+    }
67 67
 
68
-	/**
69
-	 * {@inheritDoc}
70
-	 */
71
-	public function clear($prefix = '') {
72
-		if ($prefix === '') {
73
-			$this->cachedData = [];
74
-			return true;
75
-		}
68
+    /**
69
+     * {@inheritDoc}
70
+     */
71
+    public function clear($prefix = '') {
72
+        if ($prefix === '') {
73
+            $this->cachedData = [];
74
+            return true;
75
+        }
76 76
 
77
-		foreach ($this->cachedData as $key => $value) {
78
-			if (strpos($key, $prefix) === 0) {
79
-				$this->remove($key);
80
-			}
81
-		}
82
-		return true;
83
-	}
77
+        foreach ($this->cachedData as $key => $value) {
78
+            if (strpos($key, $prefix) === 0) {
79
+                $this->remove($key);
80
+            }
81
+        }
82
+        return true;
83
+    }
84 84
 
85
-	/**
86
-	 * Set a value in the cache if it's not already stored
87
-	 *
88
-	 * @param string $key
89
-	 * @param mixed $value
90
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
91
-	 * @return bool
92
-	 */
93
-	public function add($key, $value, $ttl = 0) {
94
-		// since this cache is not shared race conditions aren't an issue
95
-		if ($this->hasKey($key)) {
96
-			return false;
97
-		} else {
98
-			return $this->set($key, $value, $ttl);
99
-		}
100
-	}
85
+    /**
86
+     * Set a value in the cache if it's not already stored
87
+     *
88
+     * @param string $key
89
+     * @param mixed $value
90
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
91
+     * @return bool
92
+     */
93
+    public function add($key, $value, $ttl = 0) {
94
+        // since this cache is not shared race conditions aren't an issue
95
+        if ($this->hasKey($key)) {
96
+            return false;
97
+        } else {
98
+            return $this->set($key, $value, $ttl);
99
+        }
100
+    }
101 101
 
102
-	/**
103
-	 * Increase a stored number
104
-	 *
105
-	 * @param string $key
106
-	 * @param int $step
107
-	 * @return int | bool
108
-	 */
109
-	public function inc($key, $step = 1) {
110
-		$oldValue = $this->get($key);
111
-		if (is_int($oldValue)) {
112
-			$this->set($key, $oldValue + $step);
113
-			return $oldValue + $step;
114
-		} else {
115
-			$success = $this->add($key, $step);
116
-			return ($success) ? $step : false;
117
-		}
118
-	}
102
+    /**
103
+     * Increase a stored number
104
+     *
105
+     * @param string $key
106
+     * @param int $step
107
+     * @return int | bool
108
+     */
109
+    public function inc($key, $step = 1) {
110
+        $oldValue = $this->get($key);
111
+        if (is_int($oldValue)) {
112
+            $this->set($key, $oldValue + $step);
113
+            return $oldValue + $step;
114
+        } else {
115
+            $success = $this->add($key, $step);
116
+            return ($success) ? $step : false;
117
+        }
118
+    }
119 119
 
120
-	/**
121
-	 * Decrease a stored number
122
-	 *
123
-	 * @param string $key
124
-	 * @param int $step
125
-	 * @return int | bool
126
-	 */
127
-	public function dec($key, $step = 1) {
128
-		$oldValue = $this->get($key);
129
-		if (is_int($oldValue)) {
130
-			$this->set($key, $oldValue - $step);
131
-			return $oldValue - $step;
132
-		} else {
133
-			return false;
134
-		}
135
-	}
120
+    /**
121
+     * Decrease a stored number
122
+     *
123
+     * @param string $key
124
+     * @param int $step
125
+     * @return int | bool
126
+     */
127
+    public function dec($key, $step = 1) {
128
+        $oldValue = $this->get($key);
129
+        if (is_int($oldValue)) {
130
+            $this->set($key, $oldValue - $step);
131
+            return $oldValue - $step;
132
+        } else {
133
+            return false;
134
+        }
135
+    }
136 136
 
137
-	/**
138
-	 * Compare and set
139
-	 *
140
-	 * @param string $key
141
-	 * @param mixed $old
142
-	 * @param mixed $new
143
-	 * @return bool
144
-	 */
145
-	public function cas($key, $old, $new) {
146
-		if ($this->get($key) === $old) {
147
-			return $this->set($key, $new);
148
-		} else {
149
-			return false;
150
-		}
151
-	}
137
+    /**
138
+     * Compare and set
139
+     *
140
+     * @param string $key
141
+     * @param mixed $old
142
+     * @param mixed $new
143
+     * @return bool
144
+     */
145
+    public function cas($key, $old, $new) {
146
+        if ($this->get($key) === $old) {
147
+            return $this->set($key, $new);
148
+        } else {
149
+            return false;
150
+        }
151
+    }
152 152
 
153
-	/**
154
-	 * {@inheritDoc}
155
-	 */
156
-	static public function isAvailable() {
157
-		return true;
158
-	}
153
+    /**
154
+     * {@inheritDoc}
155
+     */
156
+    static public function isAvailable() {
157
+        return true;
158
+    }
159 159
 }
Please login to merge, or discard this patch.
lib/private/User/Session.php 3 patches
Doc Comments   +4 added lines, -1 removed lines patch added patch discarded remove patch
@@ -311,7 +311,7 @@  discard block
 block discarded – undo
311 311
 	 * @param OC\Security\Bruteforce\Throttler $throttler
312 312
 	 * @throws LoginException
313 313
 	 * @throws PasswordLoginForbiddenException
314
-	 * @return boolean
314
+	 * @return boolean|null
315 315
 	 */
316 316
 	public function logClientIn($user,
317 317
 								$password,
@@ -361,6 +361,9 @@  discard block
 block discarded – undo
361 361
 		return $this->config->getSystemValue('token_auth_enforced', false);
362 362
 	}
363 363
 
364
+	/**
365
+	 * @param string $username
366
+	 */
364 367
 	protected function isTwoFactorEnforced($username) {
365 368
 		Util::emitHook(
366 369
 			'\OCA\Files_Sharing\API\Server2Server',
Please login to merge, or discard this patch.
Indentation   +782 added lines, -782 removed lines patch added patch discarded remove patch
@@ -75,788 +75,788 @@
 block discarded – undo
75 75
  */
76 76
 class Session implements IUserSession, Emitter {
77 77
 
78
-	/** @var IUserManager $manager */
79
-	private $manager;
80
-
81
-	/** @var ISession $session */
82
-	private $session;
83
-
84
-	/** @var ITimeFactory */
85
-	private $timeFacory;
86
-
87
-	/** @var IProvider */
88
-	private $tokenProvider;
89
-
90
-	/** @var IConfig */
91
-	private $config;
92
-
93
-	/** @var User $activeUser */
94
-	protected $activeUser;
95
-
96
-	/** @var ISecureRandom */
97
-	private $random;
98
-
99
-	/**
100
-	 * @param IUserManager $manager
101
-	 * @param ISession $session
102
-	 * @param ITimeFactory $timeFacory
103
-	 * @param IProvider $tokenProvider
104
-	 * @param IConfig $config
105
-	 * @param ISecureRandom $random
106
-	 */
107
-	public function __construct(IUserManager $manager,
108
-								ISession $session,
109
-								ITimeFactory $timeFacory,
110
-								$tokenProvider,
111
-								IConfig $config,
112
-								ISecureRandom $random) {
113
-		$this->manager = $manager;
114
-		$this->session = $session;
115
-		$this->timeFacory = $timeFacory;
116
-		$this->tokenProvider = $tokenProvider;
117
-		$this->config = $config;
118
-		$this->random = $random;
119
-	}
120
-
121
-	/**
122
-	 * @param IProvider $provider
123
-	 */
124
-	public function setTokenProvider(IProvider $provider) {
125
-		$this->tokenProvider = $provider;
126
-	}
127
-
128
-	/**
129
-	 * @param string $scope
130
-	 * @param string $method
131
-	 * @param callable $callback
132
-	 */
133
-	public function listen($scope, $method, callable $callback) {
134
-		$this->manager->listen($scope, $method, $callback);
135
-	}
136
-
137
-	/**
138
-	 * @param string $scope optional
139
-	 * @param string $method optional
140
-	 * @param callable $callback optional
141
-	 */
142
-	public function removeListener($scope = null, $method = null, callable $callback = null) {
143
-		$this->manager->removeListener($scope, $method, $callback);
144
-	}
145
-
146
-	/**
147
-	 * get the manager object
148
-	 *
149
-	 * @return Manager
150
-	 */
151
-	public function getManager() {
152
-		return $this->manager;
153
-	}
154
-
155
-	/**
156
-	 * get the session object
157
-	 *
158
-	 * @return ISession
159
-	 */
160
-	public function getSession() {
161
-		return $this->session;
162
-	}
163
-
164
-	/**
165
-	 * set the session object
166
-	 *
167
-	 * @param ISession $session
168
-	 */
169
-	public function setSession(ISession $session) {
170
-		if ($this->session instanceof ISession) {
171
-			$this->session->close();
172
-		}
173
-		$this->session = $session;
174
-		$this->activeUser = null;
175
-	}
176
-
177
-	/**
178
-	 * set the currently active user
179
-	 *
180
-	 * @param IUser|null $user
181
-	 */
182
-	public function setUser($user) {
183
-		if (is_null($user)) {
184
-			$this->session->remove('user_id');
185
-		} else {
186
-			$this->session->set('user_id', $user->getUID());
187
-		}
188
-		$this->activeUser = $user;
189
-	}
190
-
191
-	/**
192
-	 * get the current active user
193
-	 *
194
-	 * @return IUser|null Current user, otherwise null
195
-	 */
196
-	public function getUser() {
197
-		// FIXME: This is a quick'n dirty work-around for the incognito mode as
198
-		// described at https://github.com/owncloud/core/pull/12912#issuecomment-67391155
199
-		if (OC_User::isIncognitoMode()) {
200
-			return null;
201
-		}
202
-		if (is_null($this->activeUser)) {
203
-			$uid = $this->session->get('user_id');
204
-			if (is_null($uid)) {
205
-				return null;
206
-			}
207
-			$this->activeUser = $this->manager->get($uid);
208
-			if (is_null($this->activeUser)) {
209
-				return null;
210
-			}
211
-			$this->validateSession();
212
-		}
213
-		return $this->activeUser;
214
-	}
215
-
216
-	/**
217
-	 * Validate whether the current session is valid
218
-	 *
219
-	 * - For token-authenticated clients, the token validity is checked
220
-	 * - For browsers, the session token validity is checked
221
-	 */
222
-	protected function validateSession() {
223
-		$token = null;
224
-		$appPassword = $this->session->get('app_password');
225
-
226
-		if (is_null($appPassword)) {
227
-			try {
228
-				$token = $this->session->getId();
229
-			} catch (SessionNotAvailableException $ex) {
230
-				return;
231
-			}
232
-		} else {
233
-			$token = $appPassword;
234
-		}
235
-
236
-		if (!$this->validateToken($token)) {
237
-			// Session was invalidated
238
-			$this->logout();
239
-		}
240
-	}
241
-
242
-	/**
243
-	 * Checks whether the user is logged in
244
-	 *
245
-	 * @return bool if logged in
246
-	 */
247
-	public function isLoggedIn() {
248
-		$user = $this->getUser();
249
-		if (is_null($user)) {
250
-			return false;
251
-		}
252
-
253
-		return $user->isEnabled();
254
-	}
255
-
256
-	/**
257
-	 * set the login name
258
-	 *
259
-	 * @param string|null $loginName for the logged in user
260
-	 */
261
-	public function setLoginName($loginName) {
262
-		if (is_null($loginName)) {
263
-			$this->session->remove('loginname');
264
-		} else {
265
-			$this->session->set('loginname', $loginName);
266
-		}
267
-	}
268
-
269
-	/**
270
-	 * get the login name of the current user
271
-	 *
272
-	 * @return string
273
-	 */
274
-	public function getLoginName() {
275
-		if ($this->activeUser) {
276
-			return $this->session->get('loginname');
277
-		} else {
278
-			$uid = $this->session->get('user_id');
279
-			if ($uid) {
280
-				$this->activeUser = $this->manager->get($uid);
281
-				return $this->session->get('loginname');
282
-			} else {
283
-				return null;
284
-			}
285
-		}
286
-	}
287
-
288
-	/**
289
-	 * set the token id
290
-	 *
291
-	 * @param int|null $token that was used to log in
292
-	 */
293
-	protected function setToken($token) {
294
-		if ($token === null) {
295
-			$this->session->remove('token-id');
296
-		} else {
297
-			$this->session->set('token-id', $token);
298
-		}
299
-	}
300
-
301
-	/**
302
-	 * try to log in with the provided credentials
303
-	 *
304
-	 * @param string $uid
305
-	 * @param string $password
306
-	 * @return boolean|null
307
-	 * @throws LoginException
308
-	 */
309
-	public function login($uid, $password) {
310
-		$this->session->regenerateId();
311
-		if ($this->validateToken($password, $uid)) {
312
-			return $this->loginWithToken($password);
313
-		}
314
-		return $this->loginWithPassword($uid, $password);
315
-	}
316
-
317
-	/**
318
-	 * Tries to log in a client
319
-	 *
320
-	 * Checks token auth enforced
321
-	 * Checks 2FA enabled
322
-	 *
323
-	 * @param string $user
324
-	 * @param string $password
325
-	 * @param IRequest $request
326
-	 * @param OC\Security\Bruteforce\Throttler $throttler
327
-	 * @throws LoginException
328
-	 * @throws PasswordLoginForbiddenException
329
-	 * @return boolean
330
-	 */
331
-	public function logClientIn($user,
332
-								$password,
333
-								IRequest $request,
334
-								OC\Security\Bruteforce\Throttler $throttler) {
335
-		$currentDelay = $throttler->sleepDelay($request->getRemoteAddress(), 'login');
336
-
337
-		if ($this->manager instanceof PublicEmitter) {
338
-			$this->manager->emit('\OC\User', 'preLogin', array($user, $password));
339
-		}
340
-
341
-		$isTokenPassword = $this->isTokenPassword($password);
342
-		if (!$isTokenPassword && $this->isTokenAuthEnforced()) {
343
-			throw new PasswordLoginForbiddenException();
344
-		}
345
-		if (!$isTokenPassword && $this->isTwoFactorEnforced($user)) {
346
-			throw new PasswordLoginForbiddenException();
347
-		}
348
-		if (!$this->login($user, $password) ) {
349
-			$users = $this->manager->getByEmail($user);
350
-			if (count($users) === 1) {
351
-				return $this->login($users[0]->getUID(), $password);
352
-			}
353
-
354
-			$throttler->registerAttempt('login', $request->getRemoteAddress(), ['uid' => $user]);
355
-			if($currentDelay === 0) {
356
-				$throttler->sleepDelay($request->getRemoteAddress(), 'login');
357
-			}
358
-			return false;
359
-		}
360
-
361
-		if ($isTokenPassword) {
362
-			$this->session->set('app_password', $password);
363
-		} else if($this->supportsCookies($request)) {
364
-			// Password login, but cookies supported -> create (browser) session token
365
-			$this->createSessionToken($request, $this->getUser()->getUID(), $user, $password);
366
-		}
367
-
368
-		return true;
369
-	}
370
-
371
-	protected function supportsCookies(IRequest $request) {
372
-		if (!is_null($request->getCookie('cookie_test'))) {
373
-			return true;
374
-		}
375
-		setcookie('cookie_test', 'test', $this->timeFacory->getTime() + 3600);
376
-		return false;
377
-	}
378
-
379
-	private function isTokenAuthEnforced() {
380
-		return $this->config->getSystemValue('token_auth_enforced', false);
381
-	}
382
-
383
-	protected function isTwoFactorEnforced($username) {
384
-		Util::emitHook(
385
-			'\OCA\Files_Sharing\API\Server2Server',
386
-			'preLoginNameUsedAsUserName',
387
-			array('uid' => &$username)
388
-		);
389
-		$user = $this->manager->get($username);
390
-		if (is_null($user)) {
391
-			$users = $this->manager->getByEmail($username);
392
-			if (empty($users)) {
393
-				return false;
394
-			}
395
-			if (count($users) !== 1) {
396
-				return true;
397
-			}
398
-			$user = $users[0];
399
-		}
400
-		// DI not possible due to cyclic dependencies :'-/
401
-		return OC::$server->getTwoFactorAuthManager()->isTwoFactorAuthenticated($user);
402
-	}
403
-
404
-	/**
405
-	 * Check if the given 'password' is actually a device token
406
-	 *
407
-	 * @param string $password
408
-	 * @return boolean
409
-	 */
410
-	public function isTokenPassword($password) {
411
-		try {
412
-			$this->tokenProvider->getToken($password);
413
-			return true;
414
-		} catch (InvalidTokenException $ex) {
415
-			return false;
416
-		}
417
-	}
418
-
419
-	protected function prepareUserLogin($firstTimeLogin) {
420
-		// TODO: mock/inject/use non-static
421
-		// Refresh the token
422
-		\OC::$server->getCsrfTokenManager()->refreshToken();
423
-		//we need to pass the user name, which may differ from login name
424
-		$user = $this->getUser()->getUID();
425
-		OC_Util::setupFS($user);
426
-
427
-		if ($firstTimeLogin) {
428
-			// TODO: lock necessary?
429
-			//trigger creation of user home and /files folder
430
-			$userFolder = \OC::$server->getUserFolder($user);
431
-
432
-			// copy skeleton
433
-			\OC_Util::copySkeleton($user, $userFolder);
434
-
435
-			// trigger any other initialization
436
-			\OC::$server->getEventDispatcher()->dispatch(IUser::class . '::firstLogin', new GenericEvent($this->getUser()));
437
-		}
438
-	}
439
-
440
-	/**
441
-	 * Tries to login the user with HTTP Basic Authentication
442
-	 *
443
-	 * @todo do not allow basic auth if the user is 2FA enforced
444
-	 * @param IRequest $request
445
-	 * @param OC\Security\Bruteforce\Throttler $throttler
446
-	 * @return boolean if the login was successful
447
-	 */
448
-	public function tryBasicAuthLogin(IRequest $request,
449
-									  OC\Security\Bruteforce\Throttler $throttler) {
450
-		if (!empty($request->server['PHP_AUTH_USER']) && !empty($request->server['PHP_AUTH_PW'])) {
451
-			try {
452
-				if ($this->logClientIn($request->server['PHP_AUTH_USER'], $request->server['PHP_AUTH_PW'], $request, $throttler)) {
453
-					/**
454
-					 * Add DAV authenticated. This should in an ideal world not be
455
-					 * necessary but the iOS App reads cookies from anywhere instead
456
-					 * only the DAV endpoint.
457
-					 * This makes sure that the cookies will be valid for the whole scope
458
-					 * @see https://github.com/owncloud/core/issues/22893
459
-					 */
460
-					$this->session->set(
461
-						Auth::DAV_AUTHENTICATED, $this->getUser()->getUID()
462
-					);
463
-
464
-					// Set the last-password-confirm session to make the sudo mode work
465
-					 $this->session->set('last-password-confirm', $this->timeFacory->getTime());
466
-
467
-					return true;
468
-				}
469
-			} catch (PasswordLoginForbiddenException $ex) {
470
-				// Nothing to do
471
-			}
472
-		}
473
-		return false;
474
-	}
475
-
476
-	/**
477
-	 * Log an user in via login name and password
478
-	 *
479
-	 * @param string $uid
480
-	 * @param string $password
481
-	 * @return boolean
482
-	 * @throws LoginException if an app canceld the login process or the user is not enabled
483
-	 */
484
-	private function loginWithPassword($uid, $password) {
485
-		$user = $this->manager->checkPassword($uid, $password);
486
-		if ($user === false) {
487
-			// Password check failed
488
-			return false;
489
-		}
490
-
491
-		if ($user->isEnabled()) {
492
-			$this->setUser($user);
493
-			$this->setLoginName($uid);
494
-			$this->setToken(null);
495
-			$firstTimeLogin = $user->updateLastLoginTimestamp();
496
-			$this->manager->emit('\OC\User', 'postLogin', [$user, $password]);
497
-			if ($this->isLoggedIn()) {
498
-				$this->prepareUserLogin($firstTimeLogin);
499
-				return true;
500
-			} else {
501
-				// injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
502
-				$message = \OC::$server->getL10N('lib')->t('Login canceled by app');
503
-				throw new LoginException($message);
504
-			}
505
-		} else {
506
-			// injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
507
-			$message = \OC::$server->getL10N('lib')->t('User disabled');
508
-			throw new LoginException($message);
509
-		}
510
-	}
511
-
512
-	/**
513
-	 * Log an user in with a given token (id)
514
-	 *
515
-	 * @param string $token
516
-	 * @return boolean
517
-	 * @throws LoginException if an app canceled the login process or the user is not enabled
518
-	 */
519
-	private function loginWithToken($token) {
520
-		try {
521
-			$dbToken = $this->tokenProvider->getToken($token);
522
-		} catch (InvalidTokenException $ex) {
523
-			return false;
524
-		}
525
-		$uid = $dbToken->getUID();
526
-
527
-		// When logging in with token, the password must be decrypted first before passing to login hook
528
-		$password = '';
529
-		try {
530
-			$password = $this->tokenProvider->getPassword($dbToken, $token);
531
-		} catch (PasswordlessTokenException $ex) {
532
-			// Ignore and use empty string instead
533
-		}
534
-
535
-		$user = $this->manager->get($uid);
536
-		if (is_null($user)) {
537
-			// user does not exist
538
-			return false;
539
-		}
540
-		if (!$user->isEnabled()) {
541
-			// disabled users can not log in
542
-			// injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
543
-			$message = \OC::$server->getL10N('lib')->t('User disabled');
544
-			throw new LoginException($message);
545
-		}
546
-
547
-		//login
548
-		$this->setUser($user);
549
-		$this->setLoginName($dbToken->getLoginName());
550
-		$this->setToken($dbToken->getId());
551
-		\OC::$server->getLockdownManager()->setToken($dbToken);
552
-		$this->manager->emit('\OC\User', 'postLogin', array($user, $password));
553
-
554
-		if ($this->isLoggedIn()) {
555
-			$this->prepareUserLogin(false); // token login cant be the first
556
-		} else {
557
-			// injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
558
-			$message = \OC::$server->getL10N('lib')->t('Login canceled by app');
559
-			throw new LoginException($message);
560
-		}
561
-
562
-		return true;
563
-	}
564
-
565
-	/**
566
-	 * Create a new session token for the given user credentials
567
-	 *
568
-	 * @param IRequest $request
569
-	 * @param string $uid user UID
570
-	 * @param string $loginName login name
571
-	 * @param string $password
572
-	 * @param int $remember
573
-	 * @return boolean
574
-	 */
575
-	public function createSessionToken(IRequest $request, $uid, $loginName, $password = null, $remember = IToken::DO_NOT_REMEMBER) {
576
-		if (is_null($this->manager->get($uid))) {
577
-			// User does not exist
578
-			return false;
579
-		}
580
-		$name = isset($request->server['HTTP_USER_AGENT']) ? $request->server['HTTP_USER_AGENT'] : 'unknown browser';
581
-		try {
582
-			$sessionId = $this->session->getId();
583
-			$pwd = $this->getPassword($password);
584
-			$this->tokenProvider->generateToken($sessionId, $uid, $loginName, $pwd, $name, IToken::TEMPORARY_TOKEN, $remember);
585
-			return true;
586
-		} catch (SessionNotAvailableException $ex) {
587
-			// This can happen with OCC, where a memory session is used
588
-			// if a memory session is used, we shouldn't create a session token anyway
589
-			return false;
590
-		}
591
-	}
592
-
593
-	/**
594
-	 * Checks if the given password is a token.
595
-	 * If yes, the password is extracted from the token.
596
-	 * If no, the same password is returned.
597
-	 *
598
-	 * @param string $password either the login password or a device token
599
-	 * @return string|null the password or null if none was set in the token
600
-	 */
601
-	private function getPassword($password) {
602
-		if (is_null($password)) {
603
-			// This is surely no token ;-)
604
-			return null;
605
-		}
606
-		try {
607
-			$token = $this->tokenProvider->getToken($password);
608
-			try {
609
-				return $this->tokenProvider->getPassword($token, $password);
610
-			} catch (PasswordlessTokenException $ex) {
611
-				return null;
612
-			}
613
-		} catch (InvalidTokenException $ex) {
614
-			return $password;
615
-		}
616
-	}
617
-
618
-	/**
619
-	 * @param IToken $dbToken
620
-	 * @param string $token
621
-	 * @return boolean
622
-	 */
623
-	private function checkTokenCredentials(IToken $dbToken, $token) {
624
-		// Check whether login credentials are still valid and the user was not disabled
625
-		// This check is performed each 5 minutes
626
-		$lastCheck = $dbToken->getLastCheck() ? : 0;
627
-		$now = $this->timeFacory->getTime();
628
-		if ($lastCheck > ($now - 60 * 5)) {
629
-			// Checked performed recently, nothing to do now
630
-			return true;
631
-		}
632
-
633
-		try {
634
-			$pwd = $this->tokenProvider->getPassword($dbToken, $token);
635
-		} catch (InvalidTokenException $ex) {
636
-			// An invalid token password was used -> log user out
637
-			return false;
638
-		} catch (PasswordlessTokenException $ex) {
639
-			// Token has no password
640
-
641
-			if (!is_null($this->activeUser) && !$this->activeUser->isEnabled()) {
642
-				$this->tokenProvider->invalidateToken($token);
643
-				return false;
644
-			}
645
-
646
-			$dbToken->setLastCheck($now);
647
-			return true;
648
-		}
649
-
650
-		if ($this->manager->checkPassword($dbToken->getLoginName(), $pwd) === false
651
-			|| (!is_null($this->activeUser) && !$this->activeUser->isEnabled())) {
652
-			$this->tokenProvider->invalidateToken($token);
653
-			// Password has changed or user was disabled -> log user out
654
-			return false;
655
-		}
656
-		$dbToken->setLastCheck($now);
657
-		return true;
658
-	}
659
-
660
-	/**
661
-	 * Check if the given token exists and performs password/user-enabled checks
662
-	 *
663
-	 * Invalidates the token if checks fail
664
-	 *
665
-	 * @param string $token
666
-	 * @param string $user login name
667
-	 * @return boolean
668
-	 */
669
-	private function validateToken($token, $user = null) {
670
-		try {
671
-			$dbToken = $this->tokenProvider->getToken($token);
672
-		} catch (InvalidTokenException $ex) {
673
-			return false;
674
-		}
675
-
676
-		// Check if login names match
677
-		if (!is_null($user) && $dbToken->getLoginName() !== $user) {
678
-			// TODO: this makes it imposssible to use different login names on browser and client
679
-			// e.g. login by e-mail '[email protected]' on browser for generating the token will not
680
-			//      allow to use the client token with the login name 'user'.
681
-			return false;
682
-		}
683
-
684
-		if (!$this->checkTokenCredentials($dbToken, $token)) {
685
-			return false;
686
-		}
687
-
688
-		$this->tokenProvider->updateTokenActivity($dbToken);
689
-
690
-		return true;
691
-	}
692
-
693
-	/**
694
-	 * Tries to login the user with auth token header
695
-	 *
696
-	 * @param IRequest $request
697
-	 * @todo check remember me cookie
698
-	 * @return boolean
699
-	 */
700
-	public function tryTokenLogin(IRequest $request) {
701
-		$authHeader = $request->getHeader('Authorization');
702
-		if (strpos($authHeader, 'token ') === false) {
703
-			// No auth header, let's try session id
704
-			try {
705
-				$token = $this->session->getId();
706
-			} catch (SessionNotAvailableException $ex) {
707
-				return false;
708
-			}
709
-		} else {
710
-			$token = substr($authHeader, 6);
711
-		}
712
-
713
-		if (!$this->loginWithToken($token)) {
714
-			return false;
715
-		}
716
-		if(!$this->validateToken($token)) {
717
-			return false;
718
-		}
719
-		return true;
720
-	}
721
-
722
-	/**
723
-	 * perform login using the magic cookie (remember login)
724
-	 *
725
-	 * @param string $uid the username
726
-	 * @param string $currentToken
727
-	 * @param string $oldSessionId
728
-	 * @return bool
729
-	 */
730
-	public function loginWithCookie($uid, $currentToken, $oldSessionId) {
731
-		$this->session->regenerateId();
732
-		$this->manager->emit('\OC\User', 'preRememberedLogin', array($uid));
733
-		$user = $this->manager->get($uid);
734
-		if (is_null($user)) {
735
-			// user does not exist
736
-			return false;
737
-		}
738
-
739
-		// get stored tokens
740
-		$tokens = $this->config->getUserKeys($uid, 'login_token');
741
-		// test cookies token against stored tokens
742
-		if (!in_array($currentToken, $tokens, true)) {
743
-			return false;
744
-		}
745
-		// replace successfully used token with a new one
746
-		$this->config->deleteUserValue($uid, 'login_token', $currentToken);
747
-		$newToken = $this->random->generate(32);
748
-		$this->config->setUserValue($uid, 'login_token', $newToken, $this->timeFacory->getTime());
749
-
750
-		try {
751
-			$sessionId = $this->session->getId();
752
-			$this->tokenProvider->renewSessionToken($oldSessionId, $sessionId);
753
-		} catch (SessionNotAvailableException $ex) {
754
-			return false;
755
-		} catch (InvalidTokenException $ex) {
756
-			\OC::$server->getLogger()->warning('Renewing session token failed', ['app' => 'core']);
757
-			return false;
758
-		}
759
-
760
-		$this->setMagicInCookie($user->getUID(), $newToken);
761
-		$token = $this->tokenProvider->getToken($sessionId);
762
-
763
-		//login
764
-		$this->setUser($user);
765
-		$this->setLoginName($token->getLoginName());
766
-		$this->setToken($token->getId());
767
-		$user->updateLastLoginTimestamp();
768
-		$this->manager->emit('\OC\User', 'postRememberedLogin', [$user]);
769
-		return true;
770
-	}
771
-
772
-	/**
773
-	 * @param IUser $user
774
-	 */
775
-	public function createRememberMeToken(IUser $user) {
776
-		$token = $this->random->generate(32);
777
-		$this->config->setUserValue($user->getUID(), 'login_token', $token, $this->timeFacory->getTime());
778
-		$this->setMagicInCookie($user->getUID(), $token);
779
-	}
780
-
781
-	/**
782
-	 * logout the user from the session
783
-	 */
784
-	public function logout() {
785
-		$this->manager->emit('\OC\User', 'logout');
786
-		$user = $this->getUser();
787
-		if (!is_null($user)) {
788
-			try {
789
-				$this->tokenProvider->invalidateToken($this->session->getId());
790
-			} catch (SessionNotAvailableException $ex) {
791
-
792
-			}
793
-		}
794
-		$this->setUser(null);
795
-		$this->setLoginName(null);
796
-		$this->setToken(null);
797
-		$this->unsetMagicInCookie();
798
-		$this->session->clear();
799
-	}
800
-
801
-	/**
802
-	 * Set cookie value to use in next page load
803
-	 *
804
-	 * @param string $username username to be set
805
-	 * @param string $token
806
-	 */
807
-	public function setMagicInCookie($username, $token) {
808
-		$secureCookie = OC::$server->getRequest()->getServerProtocol() === 'https';
809
-		$webRoot = \OC::$WEBROOT;
810
-		if ($webRoot === '') {
811
-			$webRoot = '/';
812
-		}
813
-
814
-		$expires = $this->timeFacory->getTime() + $this->config->getSystemValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15);
815
-		setcookie('nc_username', $username, $expires, $webRoot, '', $secureCookie, true);
816
-		setcookie('nc_token', $token, $expires, $webRoot, '', $secureCookie, true);
817
-		try {
818
-			setcookie('nc_session_id', $this->session->getId(), $expires, $webRoot, '', $secureCookie, true);
819
-		} catch (SessionNotAvailableException $ex) {
820
-			// ignore
821
-		}
822
-	}
823
-
824
-	/**
825
-	 * Remove cookie for "remember username"
826
-	 */
827
-	public function unsetMagicInCookie() {
828
-		//TODO: DI for cookies and IRequest
829
-		$secureCookie = OC::$server->getRequest()->getServerProtocol() === 'https';
830
-
831
-		unset($_COOKIE['nc_username']); //TODO: DI
832
-		unset($_COOKIE['nc_token']);
833
-		unset($_COOKIE['nc_session_id']);
834
-		setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
835
-		setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
836
-		setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
837
-		// old cookies might be stored under /webroot/ instead of /webroot
838
-		// and Firefox doesn't like it!
839
-		setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
840
-		setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
841
-		setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
842
-	}
843
-
844
-	/**
845
-	 * Update password of the browser session token if there is one
846
-	 *
847
-	 * @param string $password
848
-	 */
849
-	public function updateSessionTokenPassword($password) {
850
-		try {
851
-			$sessionId = $this->session->getId();
852
-			$token = $this->tokenProvider->getToken($sessionId);
853
-			$this->tokenProvider->setPassword($token, $sessionId, $password);
854
-		} catch (SessionNotAvailableException $ex) {
855
-			// Nothing to do
856
-		} catch (InvalidTokenException $ex) {
857
-			// Nothing to do
858
-		}
859
-	}
78
+    /** @var IUserManager $manager */
79
+    private $manager;
80
+
81
+    /** @var ISession $session */
82
+    private $session;
83
+
84
+    /** @var ITimeFactory */
85
+    private $timeFacory;
86
+
87
+    /** @var IProvider */
88
+    private $tokenProvider;
89
+
90
+    /** @var IConfig */
91
+    private $config;
92
+
93
+    /** @var User $activeUser */
94
+    protected $activeUser;
95
+
96
+    /** @var ISecureRandom */
97
+    private $random;
98
+
99
+    /**
100
+     * @param IUserManager $manager
101
+     * @param ISession $session
102
+     * @param ITimeFactory $timeFacory
103
+     * @param IProvider $tokenProvider
104
+     * @param IConfig $config
105
+     * @param ISecureRandom $random
106
+     */
107
+    public function __construct(IUserManager $manager,
108
+                                ISession $session,
109
+                                ITimeFactory $timeFacory,
110
+                                $tokenProvider,
111
+                                IConfig $config,
112
+                                ISecureRandom $random) {
113
+        $this->manager = $manager;
114
+        $this->session = $session;
115
+        $this->timeFacory = $timeFacory;
116
+        $this->tokenProvider = $tokenProvider;
117
+        $this->config = $config;
118
+        $this->random = $random;
119
+    }
120
+
121
+    /**
122
+     * @param IProvider $provider
123
+     */
124
+    public function setTokenProvider(IProvider $provider) {
125
+        $this->tokenProvider = $provider;
126
+    }
127
+
128
+    /**
129
+     * @param string $scope
130
+     * @param string $method
131
+     * @param callable $callback
132
+     */
133
+    public function listen($scope, $method, callable $callback) {
134
+        $this->manager->listen($scope, $method, $callback);
135
+    }
136
+
137
+    /**
138
+     * @param string $scope optional
139
+     * @param string $method optional
140
+     * @param callable $callback optional
141
+     */
142
+    public function removeListener($scope = null, $method = null, callable $callback = null) {
143
+        $this->manager->removeListener($scope, $method, $callback);
144
+    }
145
+
146
+    /**
147
+     * get the manager object
148
+     *
149
+     * @return Manager
150
+     */
151
+    public function getManager() {
152
+        return $this->manager;
153
+    }
154
+
155
+    /**
156
+     * get the session object
157
+     *
158
+     * @return ISession
159
+     */
160
+    public function getSession() {
161
+        return $this->session;
162
+    }
163
+
164
+    /**
165
+     * set the session object
166
+     *
167
+     * @param ISession $session
168
+     */
169
+    public function setSession(ISession $session) {
170
+        if ($this->session instanceof ISession) {
171
+            $this->session->close();
172
+        }
173
+        $this->session = $session;
174
+        $this->activeUser = null;
175
+    }
176
+
177
+    /**
178
+     * set the currently active user
179
+     *
180
+     * @param IUser|null $user
181
+     */
182
+    public function setUser($user) {
183
+        if (is_null($user)) {
184
+            $this->session->remove('user_id');
185
+        } else {
186
+            $this->session->set('user_id', $user->getUID());
187
+        }
188
+        $this->activeUser = $user;
189
+    }
190
+
191
+    /**
192
+     * get the current active user
193
+     *
194
+     * @return IUser|null Current user, otherwise null
195
+     */
196
+    public function getUser() {
197
+        // FIXME: This is a quick'n dirty work-around for the incognito mode as
198
+        // described at https://github.com/owncloud/core/pull/12912#issuecomment-67391155
199
+        if (OC_User::isIncognitoMode()) {
200
+            return null;
201
+        }
202
+        if (is_null($this->activeUser)) {
203
+            $uid = $this->session->get('user_id');
204
+            if (is_null($uid)) {
205
+                return null;
206
+            }
207
+            $this->activeUser = $this->manager->get($uid);
208
+            if (is_null($this->activeUser)) {
209
+                return null;
210
+            }
211
+            $this->validateSession();
212
+        }
213
+        return $this->activeUser;
214
+    }
215
+
216
+    /**
217
+     * Validate whether the current session is valid
218
+     *
219
+     * - For token-authenticated clients, the token validity is checked
220
+     * - For browsers, the session token validity is checked
221
+     */
222
+    protected function validateSession() {
223
+        $token = null;
224
+        $appPassword = $this->session->get('app_password');
225
+
226
+        if (is_null($appPassword)) {
227
+            try {
228
+                $token = $this->session->getId();
229
+            } catch (SessionNotAvailableException $ex) {
230
+                return;
231
+            }
232
+        } else {
233
+            $token = $appPassword;
234
+        }
235
+
236
+        if (!$this->validateToken($token)) {
237
+            // Session was invalidated
238
+            $this->logout();
239
+        }
240
+    }
241
+
242
+    /**
243
+     * Checks whether the user is logged in
244
+     *
245
+     * @return bool if logged in
246
+     */
247
+    public function isLoggedIn() {
248
+        $user = $this->getUser();
249
+        if (is_null($user)) {
250
+            return false;
251
+        }
252
+
253
+        return $user->isEnabled();
254
+    }
255
+
256
+    /**
257
+     * set the login name
258
+     *
259
+     * @param string|null $loginName for the logged in user
260
+     */
261
+    public function setLoginName($loginName) {
262
+        if (is_null($loginName)) {
263
+            $this->session->remove('loginname');
264
+        } else {
265
+            $this->session->set('loginname', $loginName);
266
+        }
267
+    }
268
+
269
+    /**
270
+     * get the login name of the current user
271
+     *
272
+     * @return string
273
+     */
274
+    public function getLoginName() {
275
+        if ($this->activeUser) {
276
+            return $this->session->get('loginname');
277
+        } else {
278
+            $uid = $this->session->get('user_id');
279
+            if ($uid) {
280
+                $this->activeUser = $this->manager->get($uid);
281
+                return $this->session->get('loginname');
282
+            } else {
283
+                return null;
284
+            }
285
+        }
286
+    }
287
+
288
+    /**
289
+     * set the token id
290
+     *
291
+     * @param int|null $token that was used to log in
292
+     */
293
+    protected function setToken($token) {
294
+        if ($token === null) {
295
+            $this->session->remove('token-id');
296
+        } else {
297
+            $this->session->set('token-id', $token);
298
+        }
299
+    }
300
+
301
+    /**
302
+     * try to log in with the provided credentials
303
+     *
304
+     * @param string $uid
305
+     * @param string $password
306
+     * @return boolean|null
307
+     * @throws LoginException
308
+     */
309
+    public function login($uid, $password) {
310
+        $this->session->regenerateId();
311
+        if ($this->validateToken($password, $uid)) {
312
+            return $this->loginWithToken($password);
313
+        }
314
+        return $this->loginWithPassword($uid, $password);
315
+    }
316
+
317
+    /**
318
+     * Tries to log in a client
319
+     *
320
+     * Checks token auth enforced
321
+     * Checks 2FA enabled
322
+     *
323
+     * @param string $user
324
+     * @param string $password
325
+     * @param IRequest $request
326
+     * @param OC\Security\Bruteforce\Throttler $throttler
327
+     * @throws LoginException
328
+     * @throws PasswordLoginForbiddenException
329
+     * @return boolean
330
+     */
331
+    public function logClientIn($user,
332
+                                $password,
333
+                                IRequest $request,
334
+                                OC\Security\Bruteforce\Throttler $throttler) {
335
+        $currentDelay = $throttler->sleepDelay($request->getRemoteAddress(), 'login');
336
+
337
+        if ($this->manager instanceof PublicEmitter) {
338
+            $this->manager->emit('\OC\User', 'preLogin', array($user, $password));
339
+        }
340
+
341
+        $isTokenPassword = $this->isTokenPassword($password);
342
+        if (!$isTokenPassword && $this->isTokenAuthEnforced()) {
343
+            throw new PasswordLoginForbiddenException();
344
+        }
345
+        if (!$isTokenPassword && $this->isTwoFactorEnforced($user)) {
346
+            throw new PasswordLoginForbiddenException();
347
+        }
348
+        if (!$this->login($user, $password) ) {
349
+            $users = $this->manager->getByEmail($user);
350
+            if (count($users) === 1) {
351
+                return $this->login($users[0]->getUID(), $password);
352
+            }
353
+
354
+            $throttler->registerAttempt('login', $request->getRemoteAddress(), ['uid' => $user]);
355
+            if($currentDelay === 0) {
356
+                $throttler->sleepDelay($request->getRemoteAddress(), 'login');
357
+            }
358
+            return false;
359
+        }
360
+
361
+        if ($isTokenPassword) {
362
+            $this->session->set('app_password', $password);
363
+        } else if($this->supportsCookies($request)) {
364
+            // Password login, but cookies supported -> create (browser) session token
365
+            $this->createSessionToken($request, $this->getUser()->getUID(), $user, $password);
366
+        }
367
+
368
+        return true;
369
+    }
370
+
371
+    protected function supportsCookies(IRequest $request) {
372
+        if (!is_null($request->getCookie('cookie_test'))) {
373
+            return true;
374
+        }
375
+        setcookie('cookie_test', 'test', $this->timeFacory->getTime() + 3600);
376
+        return false;
377
+    }
378
+
379
+    private function isTokenAuthEnforced() {
380
+        return $this->config->getSystemValue('token_auth_enforced', false);
381
+    }
382
+
383
+    protected function isTwoFactorEnforced($username) {
384
+        Util::emitHook(
385
+            '\OCA\Files_Sharing\API\Server2Server',
386
+            'preLoginNameUsedAsUserName',
387
+            array('uid' => &$username)
388
+        );
389
+        $user = $this->manager->get($username);
390
+        if (is_null($user)) {
391
+            $users = $this->manager->getByEmail($username);
392
+            if (empty($users)) {
393
+                return false;
394
+            }
395
+            if (count($users) !== 1) {
396
+                return true;
397
+            }
398
+            $user = $users[0];
399
+        }
400
+        // DI not possible due to cyclic dependencies :'-/
401
+        return OC::$server->getTwoFactorAuthManager()->isTwoFactorAuthenticated($user);
402
+    }
403
+
404
+    /**
405
+     * Check if the given 'password' is actually a device token
406
+     *
407
+     * @param string $password
408
+     * @return boolean
409
+     */
410
+    public function isTokenPassword($password) {
411
+        try {
412
+            $this->tokenProvider->getToken($password);
413
+            return true;
414
+        } catch (InvalidTokenException $ex) {
415
+            return false;
416
+        }
417
+    }
418
+
419
+    protected function prepareUserLogin($firstTimeLogin) {
420
+        // TODO: mock/inject/use non-static
421
+        // Refresh the token
422
+        \OC::$server->getCsrfTokenManager()->refreshToken();
423
+        //we need to pass the user name, which may differ from login name
424
+        $user = $this->getUser()->getUID();
425
+        OC_Util::setupFS($user);
426
+
427
+        if ($firstTimeLogin) {
428
+            // TODO: lock necessary?
429
+            //trigger creation of user home and /files folder
430
+            $userFolder = \OC::$server->getUserFolder($user);
431
+
432
+            // copy skeleton
433
+            \OC_Util::copySkeleton($user, $userFolder);
434
+
435
+            // trigger any other initialization
436
+            \OC::$server->getEventDispatcher()->dispatch(IUser::class . '::firstLogin', new GenericEvent($this->getUser()));
437
+        }
438
+    }
439
+
440
+    /**
441
+     * Tries to login the user with HTTP Basic Authentication
442
+     *
443
+     * @todo do not allow basic auth if the user is 2FA enforced
444
+     * @param IRequest $request
445
+     * @param OC\Security\Bruteforce\Throttler $throttler
446
+     * @return boolean if the login was successful
447
+     */
448
+    public function tryBasicAuthLogin(IRequest $request,
449
+                                        OC\Security\Bruteforce\Throttler $throttler) {
450
+        if (!empty($request->server['PHP_AUTH_USER']) && !empty($request->server['PHP_AUTH_PW'])) {
451
+            try {
452
+                if ($this->logClientIn($request->server['PHP_AUTH_USER'], $request->server['PHP_AUTH_PW'], $request, $throttler)) {
453
+                    /**
454
+                     * Add DAV authenticated. This should in an ideal world not be
455
+                     * necessary but the iOS App reads cookies from anywhere instead
456
+                     * only the DAV endpoint.
457
+                     * This makes sure that the cookies will be valid for the whole scope
458
+                     * @see https://github.com/owncloud/core/issues/22893
459
+                     */
460
+                    $this->session->set(
461
+                        Auth::DAV_AUTHENTICATED, $this->getUser()->getUID()
462
+                    );
463
+
464
+                    // Set the last-password-confirm session to make the sudo mode work
465
+                        $this->session->set('last-password-confirm', $this->timeFacory->getTime());
466
+
467
+                    return true;
468
+                }
469
+            } catch (PasswordLoginForbiddenException $ex) {
470
+                // Nothing to do
471
+            }
472
+        }
473
+        return false;
474
+    }
475
+
476
+    /**
477
+     * Log an user in via login name and password
478
+     *
479
+     * @param string $uid
480
+     * @param string $password
481
+     * @return boolean
482
+     * @throws LoginException if an app canceld the login process or the user is not enabled
483
+     */
484
+    private function loginWithPassword($uid, $password) {
485
+        $user = $this->manager->checkPassword($uid, $password);
486
+        if ($user === false) {
487
+            // Password check failed
488
+            return false;
489
+        }
490
+
491
+        if ($user->isEnabled()) {
492
+            $this->setUser($user);
493
+            $this->setLoginName($uid);
494
+            $this->setToken(null);
495
+            $firstTimeLogin = $user->updateLastLoginTimestamp();
496
+            $this->manager->emit('\OC\User', 'postLogin', [$user, $password]);
497
+            if ($this->isLoggedIn()) {
498
+                $this->prepareUserLogin($firstTimeLogin);
499
+                return true;
500
+            } else {
501
+                // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
502
+                $message = \OC::$server->getL10N('lib')->t('Login canceled by app');
503
+                throw new LoginException($message);
504
+            }
505
+        } else {
506
+            // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
507
+            $message = \OC::$server->getL10N('lib')->t('User disabled');
508
+            throw new LoginException($message);
509
+        }
510
+    }
511
+
512
+    /**
513
+     * Log an user in with a given token (id)
514
+     *
515
+     * @param string $token
516
+     * @return boolean
517
+     * @throws LoginException if an app canceled the login process or the user is not enabled
518
+     */
519
+    private function loginWithToken($token) {
520
+        try {
521
+            $dbToken = $this->tokenProvider->getToken($token);
522
+        } catch (InvalidTokenException $ex) {
523
+            return false;
524
+        }
525
+        $uid = $dbToken->getUID();
526
+
527
+        // When logging in with token, the password must be decrypted first before passing to login hook
528
+        $password = '';
529
+        try {
530
+            $password = $this->tokenProvider->getPassword($dbToken, $token);
531
+        } catch (PasswordlessTokenException $ex) {
532
+            // Ignore and use empty string instead
533
+        }
534
+
535
+        $user = $this->manager->get($uid);
536
+        if (is_null($user)) {
537
+            // user does not exist
538
+            return false;
539
+        }
540
+        if (!$user->isEnabled()) {
541
+            // disabled users can not log in
542
+            // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
543
+            $message = \OC::$server->getL10N('lib')->t('User disabled');
544
+            throw new LoginException($message);
545
+        }
546
+
547
+        //login
548
+        $this->setUser($user);
549
+        $this->setLoginName($dbToken->getLoginName());
550
+        $this->setToken($dbToken->getId());
551
+        \OC::$server->getLockdownManager()->setToken($dbToken);
552
+        $this->manager->emit('\OC\User', 'postLogin', array($user, $password));
553
+
554
+        if ($this->isLoggedIn()) {
555
+            $this->prepareUserLogin(false); // token login cant be the first
556
+        } else {
557
+            // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
558
+            $message = \OC::$server->getL10N('lib')->t('Login canceled by app');
559
+            throw new LoginException($message);
560
+        }
561
+
562
+        return true;
563
+    }
564
+
565
+    /**
566
+     * Create a new session token for the given user credentials
567
+     *
568
+     * @param IRequest $request
569
+     * @param string $uid user UID
570
+     * @param string $loginName login name
571
+     * @param string $password
572
+     * @param int $remember
573
+     * @return boolean
574
+     */
575
+    public function createSessionToken(IRequest $request, $uid, $loginName, $password = null, $remember = IToken::DO_NOT_REMEMBER) {
576
+        if (is_null($this->manager->get($uid))) {
577
+            // User does not exist
578
+            return false;
579
+        }
580
+        $name = isset($request->server['HTTP_USER_AGENT']) ? $request->server['HTTP_USER_AGENT'] : 'unknown browser';
581
+        try {
582
+            $sessionId = $this->session->getId();
583
+            $pwd = $this->getPassword($password);
584
+            $this->tokenProvider->generateToken($sessionId, $uid, $loginName, $pwd, $name, IToken::TEMPORARY_TOKEN, $remember);
585
+            return true;
586
+        } catch (SessionNotAvailableException $ex) {
587
+            // This can happen with OCC, where a memory session is used
588
+            // if a memory session is used, we shouldn't create a session token anyway
589
+            return false;
590
+        }
591
+    }
592
+
593
+    /**
594
+     * Checks if the given password is a token.
595
+     * If yes, the password is extracted from the token.
596
+     * If no, the same password is returned.
597
+     *
598
+     * @param string $password either the login password or a device token
599
+     * @return string|null the password or null if none was set in the token
600
+     */
601
+    private function getPassword($password) {
602
+        if (is_null($password)) {
603
+            // This is surely no token ;-)
604
+            return null;
605
+        }
606
+        try {
607
+            $token = $this->tokenProvider->getToken($password);
608
+            try {
609
+                return $this->tokenProvider->getPassword($token, $password);
610
+            } catch (PasswordlessTokenException $ex) {
611
+                return null;
612
+            }
613
+        } catch (InvalidTokenException $ex) {
614
+            return $password;
615
+        }
616
+    }
617
+
618
+    /**
619
+     * @param IToken $dbToken
620
+     * @param string $token
621
+     * @return boolean
622
+     */
623
+    private function checkTokenCredentials(IToken $dbToken, $token) {
624
+        // Check whether login credentials are still valid and the user was not disabled
625
+        // This check is performed each 5 minutes
626
+        $lastCheck = $dbToken->getLastCheck() ? : 0;
627
+        $now = $this->timeFacory->getTime();
628
+        if ($lastCheck > ($now - 60 * 5)) {
629
+            // Checked performed recently, nothing to do now
630
+            return true;
631
+        }
632
+
633
+        try {
634
+            $pwd = $this->tokenProvider->getPassword($dbToken, $token);
635
+        } catch (InvalidTokenException $ex) {
636
+            // An invalid token password was used -> log user out
637
+            return false;
638
+        } catch (PasswordlessTokenException $ex) {
639
+            // Token has no password
640
+
641
+            if (!is_null($this->activeUser) && !$this->activeUser->isEnabled()) {
642
+                $this->tokenProvider->invalidateToken($token);
643
+                return false;
644
+            }
645
+
646
+            $dbToken->setLastCheck($now);
647
+            return true;
648
+        }
649
+
650
+        if ($this->manager->checkPassword($dbToken->getLoginName(), $pwd) === false
651
+            || (!is_null($this->activeUser) && !$this->activeUser->isEnabled())) {
652
+            $this->tokenProvider->invalidateToken($token);
653
+            // Password has changed or user was disabled -> log user out
654
+            return false;
655
+        }
656
+        $dbToken->setLastCheck($now);
657
+        return true;
658
+    }
659
+
660
+    /**
661
+     * Check if the given token exists and performs password/user-enabled checks
662
+     *
663
+     * Invalidates the token if checks fail
664
+     *
665
+     * @param string $token
666
+     * @param string $user login name
667
+     * @return boolean
668
+     */
669
+    private function validateToken($token, $user = null) {
670
+        try {
671
+            $dbToken = $this->tokenProvider->getToken($token);
672
+        } catch (InvalidTokenException $ex) {
673
+            return false;
674
+        }
675
+
676
+        // Check if login names match
677
+        if (!is_null($user) && $dbToken->getLoginName() !== $user) {
678
+            // TODO: this makes it imposssible to use different login names on browser and client
679
+            // e.g. login by e-mail '[email protected]' on browser for generating the token will not
680
+            //      allow to use the client token with the login name 'user'.
681
+            return false;
682
+        }
683
+
684
+        if (!$this->checkTokenCredentials($dbToken, $token)) {
685
+            return false;
686
+        }
687
+
688
+        $this->tokenProvider->updateTokenActivity($dbToken);
689
+
690
+        return true;
691
+    }
692
+
693
+    /**
694
+     * Tries to login the user with auth token header
695
+     *
696
+     * @param IRequest $request
697
+     * @todo check remember me cookie
698
+     * @return boolean
699
+     */
700
+    public function tryTokenLogin(IRequest $request) {
701
+        $authHeader = $request->getHeader('Authorization');
702
+        if (strpos($authHeader, 'token ') === false) {
703
+            // No auth header, let's try session id
704
+            try {
705
+                $token = $this->session->getId();
706
+            } catch (SessionNotAvailableException $ex) {
707
+                return false;
708
+            }
709
+        } else {
710
+            $token = substr($authHeader, 6);
711
+        }
712
+
713
+        if (!$this->loginWithToken($token)) {
714
+            return false;
715
+        }
716
+        if(!$this->validateToken($token)) {
717
+            return false;
718
+        }
719
+        return true;
720
+    }
721
+
722
+    /**
723
+     * perform login using the magic cookie (remember login)
724
+     *
725
+     * @param string $uid the username
726
+     * @param string $currentToken
727
+     * @param string $oldSessionId
728
+     * @return bool
729
+     */
730
+    public function loginWithCookie($uid, $currentToken, $oldSessionId) {
731
+        $this->session->regenerateId();
732
+        $this->manager->emit('\OC\User', 'preRememberedLogin', array($uid));
733
+        $user = $this->manager->get($uid);
734
+        if (is_null($user)) {
735
+            // user does not exist
736
+            return false;
737
+        }
738
+
739
+        // get stored tokens
740
+        $tokens = $this->config->getUserKeys($uid, 'login_token');
741
+        // test cookies token against stored tokens
742
+        if (!in_array($currentToken, $tokens, true)) {
743
+            return false;
744
+        }
745
+        // replace successfully used token with a new one
746
+        $this->config->deleteUserValue($uid, 'login_token', $currentToken);
747
+        $newToken = $this->random->generate(32);
748
+        $this->config->setUserValue($uid, 'login_token', $newToken, $this->timeFacory->getTime());
749
+
750
+        try {
751
+            $sessionId = $this->session->getId();
752
+            $this->tokenProvider->renewSessionToken($oldSessionId, $sessionId);
753
+        } catch (SessionNotAvailableException $ex) {
754
+            return false;
755
+        } catch (InvalidTokenException $ex) {
756
+            \OC::$server->getLogger()->warning('Renewing session token failed', ['app' => 'core']);
757
+            return false;
758
+        }
759
+
760
+        $this->setMagicInCookie($user->getUID(), $newToken);
761
+        $token = $this->tokenProvider->getToken($sessionId);
762
+
763
+        //login
764
+        $this->setUser($user);
765
+        $this->setLoginName($token->getLoginName());
766
+        $this->setToken($token->getId());
767
+        $user->updateLastLoginTimestamp();
768
+        $this->manager->emit('\OC\User', 'postRememberedLogin', [$user]);
769
+        return true;
770
+    }
771
+
772
+    /**
773
+     * @param IUser $user
774
+     */
775
+    public function createRememberMeToken(IUser $user) {
776
+        $token = $this->random->generate(32);
777
+        $this->config->setUserValue($user->getUID(), 'login_token', $token, $this->timeFacory->getTime());
778
+        $this->setMagicInCookie($user->getUID(), $token);
779
+    }
780
+
781
+    /**
782
+     * logout the user from the session
783
+     */
784
+    public function logout() {
785
+        $this->manager->emit('\OC\User', 'logout');
786
+        $user = $this->getUser();
787
+        if (!is_null($user)) {
788
+            try {
789
+                $this->tokenProvider->invalidateToken($this->session->getId());
790
+            } catch (SessionNotAvailableException $ex) {
791
+
792
+            }
793
+        }
794
+        $this->setUser(null);
795
+        $this->setLoginName(null);
796
+        $this->setToken(null);
797
+        $this->unsetMagicInCookie();
798
+        $this->session->clear();
799
+    }
800
+
801
+    /**
802
+     * Set cookie value to use in next page load
803
+     *
804
+     * @param string $username username to be set
805
+     * @param string $token
806
+     */
807
+    public function setMagicInCookie($username, $token) {
808
+        $secureCookie = OC::$server->getRequest()->getServerProtocol() === 'https';
809
+        $webRoot = \OC::$WEBROOT;
810
+        if ($webRoot === '') {
811
+            $webRoot = '/';
812
+        }
813
+
814
+        $expires = $this->timeFacory->getTime() + $this->config->getSystemValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15);
815
+        setcookie('nc_username', $username, $expires, $webRoot, '', $secureCookie, true);
816
+        setcookie('nc_token', $token, $expires, $webRoot, '', $secureCookie, true);
817
+        try {
818
+            setcookie('nc_session_id', $this->session->getId(), $expires, $webRoot, '', $secureCookie, true);
819
+        } catch (SessionNotAvailableException $ex) {
820
+            // ignore
821
+        }
822
+    }
823
+
824
+    /**
825
+     * Remove cookie for "remember username"
826
+     */
827
+    public function unsetMagicInCookie() {
828
+        //TODO: DI for cookies and IRequest
829
+        $secureCookie = OC::$server->getRequest()->getServerProtocol() === 'https';
830
+
831
+        unset($_COOKIE['nc_username']); //TODO: DI
832
+        unset($_COOKIE['nc_token']);
833
+        unset($_COOKIE['nc_session_id']);
834
+        setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
835
+        setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
836
+        setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
837
+        // old cookies might be stored under /webroot/ instead of /webroot
838
+        // and Firefox doesn't like it!
839
+        setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
840
+        setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
841
+        setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
842
+    }
843
+
844
+    /**
845
+     * Update password of the browser session token if there is one
846
+     *
847
+     * @param string $password
848
+     */
849
+    public function updateSessionTokenPassword($password) {
850
+        try {
851
+            $sessionId = $this->session->getId();
852
+            $token = $this->tokenProvider->getToken($sessionId);
853
+            $this->tokenProvider->setPassword($token, $sessionId, $password);
854
+        } catch (SessionNotAvailableException $ex) {
855
+            // Nothing to do
856
+        } catch (InvalidTokenException $ex) {
857
+            // Nothing to do
858
+        }
859
+    }
860 860
 
861 861
 
862 862
 }
Please login to merge, or discard this patch.
Spacing   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -345,14 +345,14 @@  discard block
 block discarded – undo
345 345
 		if (!$isTokenPassword && $this->isTwoFactorEnforced($user)) {
346 346
 			throw new PasswordLoginForbiddenException();
347 347
 		}
348
-		if (!$this->login($user, $password) ) {
348
+		if (!$this->login($user, $password)) {
349 349
 			$users = $this->manager->getByEmail($user);
350 350
 			if (count($users) === 1) {
351 351
 				return $this->login($users[0]->getUID(), $password);
352 352
 			}
353 353
 
354 354
 			$throttler->registerAttempt('login', $request->getRemoteAddress(), ['uid' => $user]);
355
-			if($currentDelay === 0) {
355
+			if ($currentDelay === 0) {
356 356
 				$throttler->sleepDelay($request->getRemoteAddress(), 'login');
357 357
 			}
358 358
 			return false;
@@ -360,7 +360,7 @@  discard block
 block discarded – undo
360 360
 
361 361
 		if ($isTokenPassword) {
362 362
 			$this->session->set('app_password', $password);
363
-		} else if($this->supportsCookies($request)) {
363
+		} else if ($this->supportsCookies($request)) {
364 364
 			// Password login, but cookies supported -> create (browser) session token
365 365
 			$this->createSessionToken($request, $this->getUser()->getUID(), $user, $password);
366 366
 		}
@@ -433,7 +433,7 @@  discard block
 block discarded – undo
433 433
 			\OC_Util::copySkeleton($user, $userFolder);
434 434
 
435 435
 			// trigger any other initialization
436
-			\OC::$server->getEventDispatcher()->dispatch(IUser::class . '::firstLogin', new GenericEvent($this->getUser()));
436
+			\OC::$server->getEventDispatcher()->dispatch(IUser::class.'::firstLogin', new GenericEvent($this->getUser()));
437 437
 		}
438 438
 	}
439 439
 
@@ -623,7 +623,7 @@  discard block
 block discarded – undo
623 623
 	private function checkTokenCredentials(IToken $dbToken, $token) {
624 624
 		// Check whether login credentials are still valid and the user was not disabled
625 625
 		// This check is performed each 5 minutes
626
-		$lastCheck = $dbToken->getLastCheck() ? : 0;
626
+		$lastCheck = $dbToken->getLastCheck() ?: 0;
627 627
 		$now = $this->timeFacory->getTime();
628 628
 		if ($lastCheck > ($now - 60 * 5)) {
629 629
 			// Checked performed recently, nothing to do now
@@ -713,7 +713,7 @@  discard block
 block discarded – undo
713 713
 		if (!$this->loginWithToken($token)) {
714 714
 			return false;
715 715
 		}
716
-		if(!$this->validateToken($token)) {
716
+		if (!$this->validateToken($token)) {
717 717
 			return false;
718 718
 		}
719 719
 		return true;
@@ -836,9 +836,9 @@  discard block
 block discarded – undo
836 836
 		setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
837 837
 		// old cookies might be stored under /webroot/ instead of /webroot
838 838
 		// and Firefox doesn't like it!
839
-		setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
840
-		setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
841
-		setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
839
+		setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT.'/', '', $secureCookie, true);
840
+		setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT.'/', '', $secureCookie, true);
841
+		setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT.'/', '', $secureCookie, true);
842 842
 	}
843 843
 
844 844
 	/**
Please login to merge, or discard this patch.