nextcloud / server

apps/files_sharing/lib/Controller/ShareController.php

Doc Comments +1 added lines, -1 removed lines

@@ -597,7 +597,7 @@
 	 * publish activity
 	 *
 	 * @param string $subject
-	 * @param array $parameters
+	 * @param string[] $parameters
 	 * @param string $affectedUser
 	 * @param int $fileId
 	 * @param string $filePath

Spacing +12 added lines, -12 removed lines

@@ -150,7 +150,7 @@ 
 	public function showAuthenticate($token) {
 		$share = $this->shareManager->getShareByToken($token);
 
-		if($this->linkShareAuth($share)) {
+		if ($this->linkShareAuth($share)) {
 			return new RedirectResponse($this->urlGenerator->linkToRoute('files_sharing.sharecontroller.showShare', array('token' => $token)));
 		}
 
@@ -178,7 +178,7 @@ 
 
 		$authenticate = $this->linkShareAuth($share, $password);
 
-		if($authenticate === true) {
+		if ($authenticate === true) {
 			return new RedirectResponse($this->urlGenerator->linkToRoute('files_sharing.sharecontroller.showShare', array('token' => $token)));
 		}
 
@@ -199,15 +199,15 @@ 
 	private function linkShareAuth(\OCP\Share\IShare $share, $password = null) {
 		if ($password !== null) {
 			if ($this->shareManager->checkPassword($share, $password)) {
-				$this->session->set('public_link_authenticated', (string)$share->getId());
+				$this->session->set('public_link_authenticated', (string) $share->getId());
 			} else {
 				$this->emitAccessShareHook($share, 403, 'Wrong password');
 				return false;
 			}
 		} else {
 			// not authenticated ?
-			if ( ! $this->session->exists('public_link_authenticated')
-				|| $this->session->get('public_link_authenticated') !== (string)$share->getId()) {
+			if (!$this->session->exists('public_link_authenticated')
+				|| $this->session->get('public_link_authenticated') !== (string) $share->getId()) {
 				return false;
 			}
 		}
@@ -228,7 +228,7 @@ 
 		$itemType = $itemSource = $uidOwner = '';
 		$token = $share;
 		$exception = null;
-		if($share instanceof \OCP\Share\IShare) {
+		if ($share instanceof \OCP\Share\IShare) {
 			try {
 				$token = $share->getToken();
 				$uidOwner = $share->getSharedBy();
@@ -247,7 +247,7 @@ 
 			'errorCode' => $errorCode,
 			'errorMessage' => $errorMessage,
 		]);
-		if(!is_null($exception)) {
+		if (!is_null($exception)) {
 			throw $exception;
 		}
 	}
@@ -340,7 +340,7 @@ 
 			if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
 				$freeSpace = max($freeSpace, 0);
 			} else {
-				$freeSpace = (INF > 0) ? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
+				$freeSpace = (INF > 0) ? INF : PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
 			}
 
 			$hideFileList = $share->getPermissions() & \OCP\Constants::PERMISSION_READ ? false : true;
@@ -371,7 +371,7 @@ 
 		$shareTmpl['previewMaxY'] = $this->config->getSystemValue('preview_max_y', 1024);
 		$shareTmpl['disclaimer'] = $this->config->getAppValue('core', 'shareapi_public_link_disclaimertext', null);
 		if ($shareTmpl['previewSupported']) {
-			$shareTmpl['previewImage'] = $this->urlGenerator->linkToRouteAbsolute( 'files_sharing.PublicPreview.getPreview',
+			$shareTmpl['previewImage'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.PublicPreview.getPreview',
 				['x' => 200, 'y' => 200, 'file' => $shareTmpl['directory_path'], 't' => $shareTmpl['dirToken']]);
 		} else {
 			$shareTmpl['previewImage'] = $this->urlGenerator->getAbsoluteURL($this->urlGenerator->imagePath('core', 'favicon-fb.png'));
@@ -401,7 +401,7 @@ 
 		}
 
 		// OpenGraph Support: http://ogp.me/
-		\OCP\Util::addHeader('meta', ['property' => "og:title", 'content' => $this->defaults->getName() . ' - ' . $this->defaults->getSlogan()]);
+		\OCP\Util::addHeader('meta', ['property' => "og:title", 'content' => $this->defaults->getName().' - '.$this->defaults->getSlogan()]);
 		\OCP\Util::addHeader('meta', ['property' => "og:description", 'content' => $this->l10n->t('%s is publicly shared', [$shareTmpl['filename']])]);
 		\OCP\Util::addHeader('meta', ['property' => "og:site_name", 'content' => $this->defaults->getName()]);
 		\OCP\Util::addHeader('meta', ['property' => "og:url", 'content' => $shareTmpl['shareUrl']]);
@@ -436,7 +436,7 @@ 
 
 		$share = $this->shareManager->getShareByToken($token);
 
-		if(!($share->getPermissions() & \OCP\Constants::PERMISSION_READ)) {
+		if (!($share->getPermissions() & \OCP\Constants::PERMISSION_READ)) {
 			return new \OCP\AppFramework\Http\DataResponse('Share is read-only');
 		}
 
@@ -514,7 +514,7 @@ 
 
 		$this->emitAccessShareHook($share);
 
-		$server_params = array( 'head' => $this->request->getMethod() == 'HEAD' );
+		$server_params = array('head' => $this->request->getMethod() == 'HEAD');
 
 		/**
 		 * Http range requests support

Indentation +550 added lines, -550 removed lines

@@ -64,558 +64,558 @@
  */
 class ShareController extends Controller {
 
-	/** @var IConfig */
-	protected $config;
-	/** @var IURLGenerator */
-	protected $urlGenerator;
-	/** @var IUserManager */
-	protected $userManager;
-	/** @var ILogger */
-	protected $logger;
-	/** @var \OCP\Activity\IManager */
-	protected $activityManager;
-	/** @var \OCP\Share\IManager */
-	protected $shareManager;
-	/** @var ISession */
-	protected $session;
-	/** @var IPreview */
-	protected $previewManager;
-	/** @var IRootFolder */
-	protected $rootFolder;
-	/** @var FederatedShareProvider */
-	protected $federatedShareProvider;
-	/** @var EventDispatcherInterface */
-	protected $eventDispatcher;
-	/** @var IL10N */
-	protected $l10n;
-	/** @var Defaults */
-	protected $defaults;
-
-	/**
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param IConfig $config
-	 * @param IURLGenerator $urlGenerator
-	 * @param IUserManager $userManager
-	 * @param ILogger $logger
-	 * @param \OCP\Activity\IManager $activityManager
-	 * @param \OCP\Share\IManager $shareManager
-	 * @param ISession $session
-	 * @param IPreview $previewManager
-	 * @param IRootFolder $rootFolder
-	 * @param FederatedShareProvider $federatedShareProvider
-	 * @param EventDispatcherInterface $eventDispatcher
-	 * @param IL10N $l10n
-	 * @param Defaults $defaults
-	 */
-	public function __construct($appName,
-								IRequest $request,
-								IConfig $config,
-								IURLGenerator $urlGenerator,
-								IUserManager $userManager,
-								ILogger $logger,
-								\OCP\Activity\IManager $activityManager,
-								\OCP\Share\IManager $shareManager,
-								ISession $session,
-								IPreview $previewManager,
-								IRootFolder $rootFolder,
-								FederatedShareProvider $federatedShareProvider,
-								EventDispatcherInterface $eventDispatcher,
-								IL10N $l10n,
-								Defaults $defaults) {
-		parent::__construct($appName, $request);
-
-		$this->config = $config;
-		$this->urlGenerator = $urlGenerator;
-		$this->userManager = $userManager;
-		$this->logger = $logger;
-		$this->activityManager = $activityManager;
-		$this->shareManager = $shareManager;
-		$this->session = $session;
-		$this->previewManager = $previewManager;
-		$this->rootFolder = $rootFolder;
-		$this->federatedShareProvider = $federatedShareProvider;
-		$this->eventDispatcher = $eventDispatcher;
-		$this->l10n = $l10n;
-		$this->defaults = $defaults;
-	}
-
-	/**
-	 * @PublicPage
-	 * @NoCSRFRequired
-	 *
-	 * @param string $token
-	 * @return TemplateResponse|RedirectResponse
-	 */
-	public function showAuthenticate($token) {
-		$share = $this->shareManager->getShareByToken($token);
-
-		if($this->linkShareAuth($share)) {
-			return new RedirectResponse($this->urlGenerator->linkToRoute('files_sharing.sharecontroller.showShare', array('token' => $token)));
-		}
-
-		return new TemplateResponse($this->appName, 'authenticate', array(), 'guest');
-	}
-
-	/**
-	 * @PublicPage
-	 * @UseSession
-	 * @BruteForceProtection(action=publicLinkAuth)
-	 *
-	 * Authenticates against password-protected shares
-	 * @param string $token
-	 * @param string $password
-	 * @return RedirectResponse|TemplateResponse|NotFoundResponse
-	 */
-	public function authenticate($token, $password = '') {
-
-		// Check whether share exists
-		try {
-			$share = $this->shareManager->getShareByToken($token);
-		} catch (ShareNotFound $e) {
-			return new NotFoundResponse();
-		}
-
-		$authenticate = $this->linkShareAuth($share, $password);
-
-		if($authenticate === true) {
-			return new RedirectResponse($this->urlGenerator->linkToRoute('files_sharing.sharecontroller.showShare', array('token' => $token)));
-		}
-
-		$response = new TemplateResponse($this->appName, 'authenticate', array('wrongpw' => true), 'guest');
-		$response->throttle();
-		return $response;
-	}
-
-	/**
-	 * Authenticate a link item with the given password.
-	 * Or use the session if no password is provided.
-	 *
-	 * This is a modified version of Helper::authenticate
-	 * TODO: Try to merge back eventually with Helper::authenticate
-	 *
-	 * @param \OCP\Share\IShare $share
-	 * @param string|null $password
-	 * @return bool
-	 */
-	private function linkShareAuth(\OCP\Share\IShare $share, $password = null) {
-		if ($password !== null) {
-			if ($this->shareManager->checkPassword($share, $password)) {
-				$this->session->set('public_link_authenticated', (string)$share->getId());
-			} else {
-				$this->emitAccessShareHook($share, 403, 'Wrong password');
-				return false;
-			}
-		} else {
-			// not authenticated ?
-			if ( ! $this->session->exists('public_link_authenticated')
-				|| $this->session->get('public_link_authenticated') !== (string)$share->getId()) {
-				return false;
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * throws hooks when a share is attempted to be accessed
-	 *
-	 * @param \OCP\Share\IShare|string $share the Share instance if available,
-	 * otherwise token
-	 * @param int $errorCode
-	 * @param string $errorMessage
-	 * @throws \OC\HintException
-	 * @throws \OC\ServerNotAvailableException
-	 */
-	protected function emitAccessShareHook($share, $errorCode = 200, $errorMessage = '') {
-		$itemType = $itemSource = $uidOwner = '';
-		$token = $share;
-		$exception = null;
-		if($share instanceof \OCP\Share\IShare) {
-			try {
-				$token = $share->getToken();
-				$uidOwner = $share->getSharedBy();
-				$itemType = $share->getNodeType();
-				$itemSource = $share->getNodeId();
-			} catch (\Exception $e) {
-				// we log what we know and pass on the exception afterwards
-				$exception = $e;
-			}
-		}
-		\OC_Hook::emit('OCP\Share', 'share_link_access', [
-			'itemType' => $itemType,
-			'itemSource' => $itemSource,
-			'uidOwner' => $uidOwner,
-			'token' => $token,
-			'errorCode' => $errorCode,
-			'errorMessage' => $errorMessage,
-		]);
-		if(!is_null($exception)) {
-			throw $exception;
-		}
-	}
-
-	/**
-	 * Validate the permissions of the share
-	 *
-	 * @param Share\IShare $share
-	 * @return bool
-	 */
-	private function validateShare(\OCP\Share\IShare $share) {
-		return $share->getNode()->isReadable() && $share->getNode()->isShareable();
-	}
-
-	/**
-	 * @PublicPage
-	 * @NoCSRFRequired
-	 *
-	 * @param string $token
-	 * @param string $path
-	 * @return TemplateResponse|RedirectResponse|NotFoundResponse
-	 * @throws NotFoundException
-	 * @throws \Exception
-	 */
-	public function showShare($token, $path = '') {
-		\OC_User::setIncognitoMode(true);
-
-		// Check whether share exists
-		try {
-			$share = $this->shareManager->getShareByToken($token);
-		} catch (ShareNotFound $e) {
-			$this->emitAccessShareHook($token, 404, 'Share not found');
-			return new NotFoundResponse();
-		}
-
-		// Share is password protected - check whether the user is permitted to access the share
-		if ($share->getPassword() !== null && !$this->linkShareAuth($share)) {
-			return new RedirectResponse($this->urlGenerator->linkToRoute('files_sharing.sharecontroller.authenticate',
-				array('token' => $token)));
-		}
-
-		if (!$this->validateShare($share)) {
-			throw new NotFoundException();
-		}
-		// We can't get the path of a file share
-		try {
-			if ($share->getNode() instanceof \OCP\Files\File && $path !== '') {
-				$this->emitAccessShareHook($share, 404, 'Share not found');
-				throw new NotFoundException();
-			}
-		} catch (\Exception $e) {
-			$this->emitAccessShareHook($share, 404, 'Share not found');
-			throw $e;
-		}
-
-		$shareTmpl = [];
-		$shareTmpl['displayName'] = $this->userManager->get($share->getShareOwner())->getDisplayName();
-		$shareTmpl['owner'] = $share->getShareOwner();
-		$shareTmpl['filename'] = $share->getNode()->getName();
-		$shareTmpl['directory_path'] = $share->getTarget();
-		$shareTmpl['mimetype'] = $share->getNode()->getMimetype();
-		$shareTmpl['previewSupported'] = $this->previewManager->isMimeSupported($share->getNode()->getMimetype());
-		$shareTmpl['dirToken'] = $token;
-		$shareTmpl['sharingToken'] = $token;
-		$shareTmpl['server2serversharing'] = $this->federatedShareProvider->isOutgoingServer2serverShareEnabled();
-		$shareTmpl['protected'] = $share->getPassword() !== null ? 'true' : 'false';
-		$shareTmpl['dir'] = '';
-		$shareTmpl['nonHumanFileSize'] = $share->getNode()->getSize();
-		$shareTmpl['fileSize'] = \OCP\Util::humanFileSize($share->getNode()->getSize());
-
-		// Show file list
-		$hideFileList = false;
-		if ($share->getNode() instanceof \OCP\Files\Folder) {
-			/** @var \OCP\Files\Folder $rootFolder */
-			$rootFolder = $share->getNode();
-
-			try {
-				$folderNode = $rootFolder->get($path);
-			} catch (\OCP\Files\NotFoundException $e) {
-				$this->emitAccessShareHook($share, 404, 'Share not found');
-				throw new NotFoundException();
-			}
-
-			$shareTmpl['dir'] = $rootFolder->getRelativePath($folderNode->getPath());
-
-			/*
+    /** @var IConfig */
+    protected $config;
+    /** @var IURLGenerator */
+    protected $urlGenerator;
+    /** @var IUserManager */
+    protected $userManager;
+    /** @var ILogger */
+    protected $logger;
+    /** @var \OCP\Activity\IManager */
+    protected $activityManager;
+    /** @var \OCP\Share\IManager */
+    protected $shareManager;
+    /** @var ISession */
+    protected $session;
+    /** @var IPreview */
+    protected $previewManager;
+    /** @var IRootFolder */
+    protected $rootFolder;
+    /** @var FederatedShareProvider */
+    protected $federatedShareProvider;
+    /** @var EventDispatcherInterface */
+    protected $eventDispatcher;
+    /** @var IL10N */
+    protected $l10n;
+    /** @var Defaults */
+    protected $defaults;
+
+    /**
+     * @param string $appName
+     * @param IRequest $request
+     * @param IConfig $config
+     * @param IURLGenerator $urlGenerator
+     * @param IUserManager $userManager
+     * @param ILogger $logger
+     * @param \OCP\Activity\IManager $activityManager
+     * @param \OCP\Share\IManager $shareManager
+     * @param ISession $session
+     * @param IPreview $previewManager
+     * @param IRootFolder $rootFolder
+     * @param FederatedShareProvider $federatedShareProvider
+     * @param EventDispatcherInterface $eventDispatcher
+     * @param IL10N $l10n
+     * @param Defaults $defaults
+     */
+    public function __construct($appName,
+                                IRequest $request,
+                                IConfig $config,
+                                IURLGenerator $urlGenerator,
+                                IUserManager $userManager,
+                                ILogger $logger,
+                                \OCP\Activity\IManager $activityManager,
+                                \OCP\Share\IManager $shareManager,
+                                ISession $session,
+                                IPreview $previewManager,
+                                IRootFolder $rootFolder,
+                                FederatedShareProvider $federatedShareProvider,
+                                EventDispatcherInterface $eventDispatcher,
+                                IL10N $l10n,
+                                Defaults $defaults) {
+        parent::__construct($appName, $request);
+
+        $this->config = $config;
+        $this->urlGenerator = $urlGenerator;
+        $this->userManager = $userManager;
+        $this->logger = $logger;
+        $this->activityManager = $activityManager;
+        $this->shareManager = $shareManager;
+        $this->session = $session;
+        $this->previewManager = $previewManager;
+        $this->rootFolder = $rootFolder;
+        $this->federatedShareProvider = $federatedShareProvider;
+        $this->eventDispatcher = $eventDispatcher;
+        $this->l10n = $l10n;
+        $this->defaults = $defaults;
+    }
+
+    /**
+     * @PublicPage
+     * @NoCSRFRequired
+     *
+     * @param string $token
+     * @return TemplateResponse|RedirectResponse
+     */
+    public function showAuthenticate($token) {
+        $share = $this->shareManager->getShareByToken($token);
+
+        if($this->linkShareAuth($share)) {
+            return new RedirectResponse($this->urlGenerator->linkToRoute('files_sharing.sharecontroller.showShare', array('token' => $token)));
+        }
+
+        return new TemplateResponse($this->appName, 'authenticate', array(), 'guest');
+    }
+
+    /**
+     * @PublicPage
+     * @UseSession
+     * @BruteForceProtection(action=publicLinkAuth)
+     *
+     * Authenticates against password-protected shares
+     * @param string $token
+     * @param string $password
+     * @return RedirectResponse|TemplateResponse|NotFoundResponse
+     */
+    public function authenticate($token, $password = '') {
+
+        // Check whether share exists
+        try {
+            $share = $this->shareManager->getShareByToken($token);
+        } catch (ShareNotFound $e) {
+            return new NotFoundResponse();
+        }
+
+        $authenticate = $this->linkShareAuth($share, $password);
+
+        if($authenticate === true) {
+            return new RedirectResponse($this->urlGenerator->linkToRoute('files_sharing.sharecontroller.showShare', array('token' => $token)));
+        }
+
+        $response = new TemplateResponse($this->appName, 'authenticate', array('wrongpw' => true), 'guest');
+        $response->throttle();
+        return $response;
+    }
+
+    /**
+     * Authenticate a link item with the given password.
+     * Or use the session if no password is provided.
+     *
+     * This is a modified version of Helper::authenticate
+     * TODO: Try to merge back eventually with Helper::authenticate
+     *
+     * @param \OCP\Share\IShare $share
+     * @param string|null $password
+     * @return bool
+     */
+    private function linkShareAuth(\OCP\Share\IShare $share, $password = null) {
+        if ($password !== null) {
+            if ($this->shareManager->checkPassword($share, $password)) {
+                $this->session->set('public_link_authenticated', (string)$share->getId());
+            } else {
+                $this->emitAccessShareHook($share, 403, 'Wrong password');
+                return false;
+            }
+        } else {
+            // not authenticated ?
+            if ( ! $this->session->exists('public_link_authenticated')
+                || $this->session->get('public_link_authenticated') !== (string)$share->getId()) {
+                return false;
+            }
+        }
+        return true;
+    }
+
+    /**
+     * throws hooks when a share is attempted to be accessed
+     *
+     * @param \OCP\Share\IShare|string $share the Share instance if available,
+     * otherwise token
+     * @param int $errorCode
+     * @param string $errorMessage
+     * @throws \OC\HintException
+     * @throws \OC\ServerNotAvailableException
+     */
+    protected function emitAccessShareHook($share, $errorCode = 200, $errorMessage = '') {
+        $itemType = $itemSource = $uidOwner = '';
+        $token = $share;
+        $exception = null;
+        if($share instanceof \OCP\Share\IShare) {
+            try {
+                $token = $share->getToken();
+                $uidOwner = $share->getSharedBy();
+                $itemType = $share->getNodeType();
+                $itemSource = $share->getNodeId();
+            } catch (\Exception $e) {
+                // we log what we know and pass on the exception afterwards
+                $exception = $e;
+            }
+        }
+        \OC_Hook::emit('OCP\Share', 'share_link_access', [
+            'itemType' => $itemType,
+            'itemSource' => $itemSource,
+            'uidOwner' => $uidOwner,
+            'token' => $token,
+            'errorCode' => $errorCode,
+            'errorMessage' => $errorMessage,
+        ]);
+        if(!is_null($exception)) {
+            throw $exception;
+        }
+    }
+
+    /**
+     * Validate the permissions of the share
+     *
+     * @param Share\IShare $share
+     * @return bool
+     */
+    private function validateShare(\OCP\Share\IShare $share) {
+        return $share->getNode()->isReadable() && $share->getNode()->isShareable();
+    }
+
+    /**
+     * @PublicPage
+     * @NoCSRFRequired
+     *
+     * @param string $token
+     * @param string $path
+     * @return TemplateResponse|RedirectResponse|NotFoundResponse
+     * @throws NotFoundException
+     * @throws \Exception
+     */
+    public function showShare($token, $path = '') {
+        \OC_User::setIncognitoMode(true);
+
+        // Check whether share exists
+        try {
+            $share = $this->shareManager->getShareByToken($token);
+        } catch (ShareNotFound $e) {
+            $this->emitAccessShareHook($token, 404, 'Share not found');
+            return new NotFoundResponse();
+        }
+
+        // Share is password protected - check whether the user is permitted to access the share
+        if ($share->getPassword() !== null && !$this->linkShareAuth($share)) {
+            return new RedirectResponse($this->urlGenerator->linkToRoute('files_sharing.sharecontroller.authenticate',
+                array('token' => $token)));
+        }
+
+        if (!$this->validateShare($share)) {
+            throw new NotFoundException();
+        }
+        // We can't get the path of a file share
+        try {
+            if ($share->getNode() instanceof \OCP\Files\File && $path !== '') {
+                $this->emitAccessShareHook($share, 404, 'Share not found');
+                throw new NotFoundException();
+            }
+        } catch (\Exception $e) {
+            $this->emitAccessShareHook($share, 404, 'Share not found');
+            throw $e;
+        }
+
+        $shareTmpl = [];
+        $shareTmpl['displayName'] = $this->userManager->get($share->getShareOwner())->getDisplayName();
+        $shareTmpl['owner'] = $share->getShareOwner();
+        $shareTmpl['filename'] = $share->getNode()->getName();
+        $shareTmpl['directory_path'] = $share->getTarget();
+        $shareTmpl['mimetype'] = $share->getNode()->getMimetype();
+        $shareTmpl['previewSupported'] = $this->previewManager->isMimeSupported($share->getNode()->getMimetype());
+        $shareTmpl['dirToken'] = $token;
+        $shareTmpl['sharingToken'] = $token;
+        $shareTmpl['server2serversharing'] = $this->federatedShareProvider->isOutgoingServer2serverShareEnabled();
+        $shareTmpl['protected'] = $share->getPassword() !== null ? 'true' : 'false';
+        $shareTmpl['dir'] = '';
+        $shareTmpl['nonHumanFileSize'] = $share->getNode()->getSize();
+        $shareTmpl['fileSize'] = \OCP\Util::humanFileSize($share->getNode()->getSize());
+
+        // Show file list
+        $hideFileList = false;
+        if ($share->getNode() instanceof \OCP\Files\Folder) {
+            /** @var \OCP\Files\Folder $rootFolder */
+            $rootFolder = $share->getNode();
+
+            try {
+                $folderNode = $rootFolder->get($path);
+            } catch (\OCP\Files\NotFoundException $e) {
+                $this->emitAccessShareHook($share, 404, 'Share not found');
+                throw new NotFoundException();
+            }
+
+            $shareTmpl['dir'] = $rootFolder->getRelativePath($folderNode->getPath());
+
+            /*
 			 * The OC_Util methods require a view. This just uses the node API
 			 */
-			$freeSpace = $share->getNode()->getStorage()->free_space($share->getNode()->getInternalPath());
-			if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-				$freeSpace = max($freeSpace, 0);
-			} else {
-				$freeSpace = (INF > 0) ? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
-			}
-
-			$hideFileList = $share->getPermissions() & \OCP\Constants::PERMISSION_READ ? false : true;
-			$maxUploadFilesize = $freeSpace;
-
-			$folder = new Template('files', 'list', '');
-			$folder->assign('dir', $rootFolder->getRelativePath($folderNode->getPath()));
-			$folder->assign('dirToken', $token);
-			$folder->assign('permissions', \OCP\Constants::PERMISSION_READ);
-			$folder->assign('isPublic', true);
-			$folder->assign('hideFileList', $hideFileList);
-			$folder->assign('publicUploadEnabled', 'no');
-			$folder->assign('uploadMaxFilesize', $maxUploadFilesize);
-			$folder->assign('uploadMaxHumanFilesize', \OCP\Util::humanFileSize($maxUploadFilesize));
-			$folder->assign('freeSpace', $freeSpace);
-			$folder->assign('usedSpacePercent', 0);
-			$folder->assign('trash', false);
-			$shareTmpl['folder'] = $folder->fetchPage();
-		}
-
-		$shareTmpl['hideFileList'] = $hideFileList;
-		$shareTmpl['shareOwner'] = $this->userManager->get($share->getShareOwner())->getDisplayName();
-		$shareTmpl['downloadURL'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.downloadShare', ['token' => $token]);
-		$shareTmpl['shareUrl'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.showShare', ['token' => $token]);
-		$shareTmpl['maxSizeAnimateGif'] = $this->config->getSystemValue('max_filesize_animated_gifs_public_sharing', 10);
-		$shareTmpl['previewEnabled'] = $this->config->getSystemValue('enable_previews', true);
-		$shareTmpl['previewMaxX'] = $this->config->getSystemValue('preview_max_x', 1024);
-		$shareTmpl['previewMaxY'] = $this->config->getSystemValue('preview_max_y', 1024);
-		$shareTmpl['disclaimer'] = $this->config->getAppValue('core', 'shareapi_public_link_disclaimertext', null);
-		if ($shareTmpl['previewSupported']) {
-			$shareTmpl['previewImage'] = $this->urlGenerator->linkToRouteAbsolute( 'files_sharing.PublicPreview.getPreview',
-				['x' => 200, 'y' => 200, 'file' => $shareTmpl['directory_path'], 't' => $shareTmpl['dirToken']]);
-		} else {
-			$shareTmpl['previewImage'] = $this->urlGenerator->getAbsoluteURL($this->urlGenerator->imagePath('core', 'favicon-fb.png'));
-		}
-
-		// Load files we need
-		\OCP\Util::addScript('files', 'file-upload');
-		\OCP\Util::addStyle('files_sharing', 'publicView');
-		\OCP\Util::addScript('files_sharing', 'public');
-		\OCP\Util::addScript('files', 'fileactions');
-		\OCP\Util::addScript('files', 'fileactionsmenu');
-		\OCP\Util::addScript('files', 'jquery.fileupload');
-		\OCP\Util::addScript('files_sharing', 'files_drop');
-
-		if (isset($shareTmpl['folder'])) {
-			// JS required for folders
-			\OCP\Util::addStyle('files', 'merged');
-			\OCP\Util::addScript('files', 'filesummary');
-			\OCP\Util::addScript('files', 'breadcrumb');
-			\OCP\Util::addScript('files', 'fileinfomodel');
-			\OCP\Util::addScript('files', 'newfilemenu');
-			\OCP\Util::addScript('files', 'files');
-			\OCP\Util::addScript('files', 'filelist');
-			\OCP\Util::addScript('files', 'keyboardshortcuts');
-		}
-
-		// OpenGraph Support: http://ogp.me/
-		\OCP\Util::addHeader('meta', ['property' => "og:title", 'content' => $this->defaults->getName() . ' - ' . $this->defaults->getSlogan()]);
-		\OCP\Util::addHeader('meta', ['property' => "og:description", 'content' => $this->l10n->t('%s is publicly shared', [$shareTmpl['filename']])]);
-		\OCP\Util::addHeader('meta', ['property' => "og:site_name", 'content' => $this->defaults->getName()]);
-		\OCP\Util::addHeader('meta', ['property' => "og:url", 'content' => $shareTmpl['shareUrl']]);
-		\OCP\Util::addHeader('meta', ['property' => "og:type", 'content' => "object"]);
-		\OCP\Util::addHeader('meta', ['property' => "og:image", 'content' => $shareTmpl['previewImage']]);
-
-		$this->eventDispatcher->dispatch('OCA\Files_Sharing::loadAdditionalScripts');
-
-		$csp = new \OCP\AppFramework\Http\ContentSecurityPolicy();
-		$csp->addAllowedFrameDomain('\'self\'');
-		$response = new TemplateResponse($this->appName, 'public', $shareTmpl, 'base');
-		$response->setContentSecurityPolicy($csp);
-
-		$this->emitAccessShareHook($share);
-
-		return $response;
-	}
-
-	/**
-	 * @PublicPage
-	 * @NoCSRFRequired
-	 *
-	 * @param string $token
-	 * @param string $files
-	 * @param string $path
-	 * @param string $downloadStartSecret
-	 * @return void|\OCP\AppFramework\Http\Response
-	 * @throws NotFoundException
-	 */
-	public function downloadShare($token, $files = null, $path = '', $downloadStartSecret = '') {
-		\OC_User::setIncognitoMode(true);
-
-		$share = $this->shareManager->getShareByToken($token);
-
-		if(!($share->getPermissions() & \OCP\Constants::PERMISSION_READ)) {
-			return new \OCP\AppFramework\Http\DataResponse('Share is read-only');
-		}
-
-		// Share is password protected - check whether the user is permitted to access the share
-		if ($share->getPassword() !== null && !$this->linkShareAuth($share)) {
-			return new RedirectResponse($this->urlGenerator->linkToRoute('files_sharing.sharecontroller.authenticate',
-				['token' => $token]));
-		}
-
-		$files_list = null;
-		if (!is_null($files)) { // download selected files
-			$files_list = json_decode($files);
-			// in case we get only a single file
-			if ($files_list === null) {
-				$files_list = [$files];
-			}
-		}
-
-		$userFolder = $this->rootFolder->getUserFolder($share->getShareOwner());
-		$originalSharePath = $userFolder->getRelativePath($share->getNode()->getPath());
-
-		if (!$this->validateShare($share)) {
-			throw new NotFoundException();
-		}
-
-		// Single file share
-		if ($share->getNode() instanceof \OCP\Files\File) {
-			// Single file download
-			$this->singleFileDownloaded($share, $share->getNode());
-		}
-		// Directory share
-		else {
-			/** @var \OCP\Files\Folder $node */
-			$node = $share->getNode();
-
-			// Try to get the path
-			if ($path !== '') {
-				try {
-					$node = $node->get($path);
-				} catch (NotFoundException $e) {
-					$this->emitAccessShareHook($share, 404, 'Share not found');
-					return new NotFoundResponse();
-				}
-			}
-
-			$originalSharePath = $userFolder->getRelativePath($node->getPath());
-
-			if ($node instanceof \OCP\Files\File) {
-				// Single file download
-				$this->singleFileDownloaded($share, $share->getNode());
-			} else if (!empty($files_list)) {
-				$this->fileListDownloaded($share, $files_list, $node);
-			} else {
-				// The folder is downloaded
-				$this->singleFileDownloaded($share, $share->getNode());
-			}
-		}
-
-		/* FIXME: We should do this all nicely in OCP */
-		OC_Util::tearDownFS();
-		OC_Util::setupFS($share->getShareOwner());
-
-		/**
-		 * this sets a cookie to be able to recognize the start of the download
-		 * the content must not be longer than 32 characters and must only contain
-		 * alphanumeric characters
-		 */
-		if (!empty($downloadStartSecret)
-			&& !isset($downloadStartSecret[32])
-			&& preg_match('!^[a-zA-Z0-9]+$!', $downloadStartSecret) === 1) {
-
-			// FIXME: set on the response once we use an actual app framework response
-			setcookie('ocDownloadStarted', $downloadStartSecret, time() + 20, '/');
-		}
-
-		$this->emitAccessShareHook($share);
-
-		$server_params = array( 'head' => $this->request->getMethod() == 'HEAD' );
-
-		/**
-		 * Http range requests support
-		 */
-		if (isset($_SERVER['HTTP_RANGE'])) {
-			$server_params['range'] = $this->request->getHeader('Range');
-		}
-
-		// download selected files
-		if (!is_null($files) && $files !== '') {
-			// FIXME: The exit is required here because otherwise the AppFramework is trying to add headers as well
-			// after dispatching the request which results in a "Cannot modify header information" notice.
-			OC_Files::get($originalSharePath, $files_list, $server_params);
-			exit();
-		} else {
-			// FIXME: The exit is required here because otherwise the AppFramework is trying to add headers as well
-			// after dispatching the request which results in a "Cannot modify header information" notice.
-			OC_Files::get(dirname($originalSharePath), basename($originalSharePath), $server_params);
-			exit();
-		}
-	}
-
-	/**
-	 * create activity for every downloaded file
-	 *
-	 * @param Share\IShare $share
-	 * @param array $files_list
-	 * @param \OCP\Files\Folder $node
-	 */
-	protected function fileListDownloaded(Share\IShare $share, array $files_list, \OCP\Files\Folder $node) {
-		foreach ($files_list as $file) {
-			$subNode = $node->get($file);
-			$this->singleFileDownloaded($share, $subNode);
-		}
-
-	}
-
-	/**
-	 * create activity if a single file was downloaded from a link share
-	 *
-	 * @param Share\IShare $share
-	 */
-	protected function singleFileDownloaded(Share\IShare $share, \OCP\Files\Node $node) {
-
-		$fileId = $node->getId();
-
-		$userFolder = $this->rootFolder->getUserFolder($share->getSharedBy());
-		$userNodeList = $userFolder->getById($fileId);
-		$userNode = $userNodeList[0];
-		$ownerFolder = $this->rootFolder->getUserFolder($share->getShareOwner());
-		$userPath = $userFolder->getRelativePath($userNode->getPath());
-		$ownerPath = $ownerFolder->getRelativePath($node->getPath());
-
-		$parameters = [$userPath];
-
-		if ($share->getShareType() === \OCP\Share::SHARE_TYPE_EMAIL) {
-			if ($node instanceof \OCP\Files\File) {
-				$subject = Downloads::SUBJECT_SHARED_FILE_BY_EMAIL_DOWNLOADED;
-			} else {
-				$subject = Downloads::SUBJECT_SHARED_FOLDER_BY_EMAIL_DOWNLOADED;
-			}
-			$parameters[] = $share->getSharedWith();
-		} else {
-			if ($node instanceof \OCP\Files\File) {
-				$subject = Downloads::SUBJECT_PUBLIC_SHARED_FILE_DOWNLOADED;
-			} else {
-				$subject = Downloads::SUBJECT_PUBLIC_SHARED_FOLDER_DOWNLOADED;
-			}
-		}
-
-		$this->publishActivity($subject, $parameters, $share->getSharedBy(), $fileId, $userPath);
-
-		if ($share->getShareOwner() !== $share->getSharedBy()) {
-			$parameters[0] = $ownerPath;
-			$this->publishActivity($subject, $parameters, $share->getShareOwner(), $fileId, $ownerPath);
-		}
-	}
-
-	/**
-	 * publish activity
-	 *
-	 * @param string $subject
-	 * @param array $parameters
-	 * @param string $affectedUser
-	 * @param int $fileId
-	 * @param string $filePath
-	 */
-	protected function publishActivity($subject,
-										array $parameters,
-										$affectedUser,
-										$fileId,
-										$filePath) {
-
-		$event = $this->activityManager->generateEvent();
-		$event->setApp('files_sharing')
-			->setType('public_links')
-			->setSubject($subject, $parameters)
-			->setAffectedUser($affectedUser)
-			->setObject('files', $fileId, $filePath);
-		$this->activityManager->publish($event);
-	}
+            $freeSpace = $share->getNode()->getStorage()->free_space($share->getNode()->getInternalPath());
+            if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+                $freeSpace = max($freeSpace, 0);
+            } else {
+                $freeSpace = (INF > 0) ? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
+            }
+
+            $hideFileList = $share->getPermissions() & \OCP\Constants::PERMISSION_READ ? false : true;
+            $maxUploadFilesize = $freeSpace;
+
+            $folder = new Template('files', 'list', '');
+            $folder->assign('dir', $rootFolder->getRelativePath($folderNode->getPath()));
+            $folder->assign('dirToken', $token);
+            $folder->assign('permissions', \OCP\Constants::PERMISSION_READ);
+            $folder->assign('isPublic', true);
+            $folder->assign('hideFileList', $hideFileList);
+            $folder->assign('publicUploadEnabled', 'no');
+            $folder->assign('uploadMaxFilesize', $maxUploadFilesize);
+            $folder->assign('uploadMaxHumanFilesize', \OCP\Util::humanFileSize($maxUploadFilesize));
+            $folder->assign('freeSpace', $freeSpace);
+            $folder->assign('usedSpacePercent', 0);
+            $folder->assign('trash', false);
+            $shareTmpl['folder'] = $folder->fetchPage();
+        }
+
+        $shareTmpl['hideFileList'] = $hideFileList;
+        $shareTmpl['shareOwner'] = $this->userManager->get($share->getShareOwner())->getDisplayName();
+        $shareTmpl['downloadURL'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.downloadShare', ['token' => $token]);
+        $shareTmpl['shareUrl'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.showShare', ['token' => $token]);
+        $shareTmpl['maxSizeAnimateGif'] = $this->config->getSystemValue('max_filesize_animated_gifs_public_sharing', 10);
+        $shareTmpl['previewEnabled'] = $this->config->getSystemValue('enable_previews', true);
+        $shareTmpl['previewMaxX'] = $this->config->getSystemValue('preview_max_x', 1024);
+        $shareTmpl['previewMaxY'] = $this->config->getSystemValue('preview_max_y', 1024);
+        $shareTmpl['disclaimer'] = $this->config->getAppValue('core', 'shareapi_public_link_disclaimertext', null);
+        if ($shareTmpl['previewSupported']) {
+            $shareTmpl['previewImage'] = $this->urlGenerator->linkToRouteAbsolute( 'files_sharing.PublicPreview.getPreview',
+                ['x' => 200, 'y' => 200, 'file' => $shareTmpl['directory_path'], 't' => $shareTmpl['dirToken']]);
+        } else {
+            $shareTmpl['previewImage'] = $this->urlGenerator->getAbsoluteURL($this->urlGenerator->imagePath('core', 'favicon-fb.png'));
+        }
+
+        // Load files we need
+        \OCP\Util::addScript('files', 'file-upload');
+        \OCP\Util::addStyle('files_sharing', 'publicView');
+        \OCP\Util::addScript('files_sharing', 'public');
+        \OCP\Util::addScript('files', 'fileactions');
+        \OCP\Util::addScript('files', 'fileactionsmenu');
+        \OCP\Util::addScript('files', 'jquery.fileupload');
+        \OCP\Util::addScript('files_sharing', 'files_drop');
+
+        if (isset($shareTmpl['folder'])) {
+            // JS required for folders
+            \OCP\Util::addStyle('files', 'merged');
+            \OCP\Util::addScript('files', 'filesummary');
+            \OCP\Util::addScript('files', 'breadcrumb');
+            \OCP\Util::addScript('files', 'fileinfomodel');
+            \OCP\Util::addScript('files', 'newfilemenu');
+            \OCP\Util::addScript('files', 'files');
+            \OCP\Util::addScript('files', 'filelist');
+            \OCP\Util::addScript('files', 'keyboardshortcuts');
+        }
+
+        // OpenGraph Support: http://ogp.me/
+        \OCP\Util::addHeader('meta', ['property' => "og:title", 'content' => $this->defaults->getName() . ' - ' . $this->defaults->getSlogan()]);
+        \OCP\Util::addHeader('meta', ['property' => "og:description", 'content' => $this->l10n->t('%s is publicly shared', [$shareTmpl['filename']])]);
+        \OCP\Util::addHeader('meta', ['property' => "og:site_name", 'content' => $this->defaults->getName()]);
+        \OCP\Util::addHeader('meta', ['property' => "og:url", 'content' => $shareTmpl['shareUrl']]);
+        \OCP\Util::addHeader('meta', ['property' => "og:type", 'content' => "object"]);
+        \OCP\Util::addHeader('meta', ['property' => "og:image", 'content' => $shareTmpl['previewImage']]);
+
+        $this->eventDispatcher->dispatch('OCA\Files_Sharing::loadAdditionalScripts');
+
+        $csp = new \OCP\AppFramework\Http\ContentSecurityPolicy();
+        $csp->addAllowedFrameDomain('\'self\'');
+        $response = new TemplateResponse($this->appName, 'public', $shareTmpl, 'base');
+        $response->setContentSecurityPolicy($csp);
+
+        $this->emitAccessShareHook($share);
+
+        return $response;
+    }
+
+    /**
+     * @PublicPage
+     * @NoCSRFRequired
+     *
+     * @param string $token
+     * @param string $files
+     * @param string $path
+     * @param string $downloadStartSecret
+     * @return void|\OCP\AppFramework\Http\Response
+     * @throws NotFoundException
+     */
+    public function downloadShare($token, $files = null, $path = '', $downloadStartSecret = '') {
+        \OC_User::setIncognitoMode(true);
+
+        $share = $this->shareManager->getShareByToken($token);
+
+        if(!($share->getPermissions() & \OCP\Constants::PERMISSION_READ)) {
+            return new \OCP\AppFramework\Http\DataResponse('Share is read-only');
+        }
+
+        // Share is password protected - check whether the user is permitted to access the share
+        if ($share->getPassword() !== null && !$this->linkShareAuth($share)) {
+            return new RedirectResponse($this->urlGenerator->linkToRoute('files_sharing.sharecontroller.authenticate',
+                ['token' => $token]));
+        }
+
+        $files_list = null;
+        if (!is_null($files)) { // download selected files
+            $files_list = json_decode($files);
+            // in case we get only a single file
+            if ($files_list === null) {
+                $files_list = [$files];
+            }
+        }
+
+        $userFolder = $this->rootFolder->getUserFolder($share->getShareOwner());
+        $originalSharePath = $userFolder->getRelativePath($share->getNode()->getPath());
+
+        if (!$this->validateShare($share)) {
+            throw new NotFoundException();
+        }
+
+        // Single file share
+        if ($share->getNode() instanceof \OCP\Files\File) {
+            // Single file download
+            $this->singleFileDownloaded($share, $share->getNode());
+        }
+        // Directory share
+        else {
+            /** @var \OCP\Files\Folder $node */
+            $node = $share->getNode();
+
+            // Try to get the path
+            if ($path !== '') {
+                try {
+                    $node = $node->get($path);
+                } catch (NotFoundException $e) {
+                    $this->emitAccessShareHook($share, 404, 'Share not found');
+                    return new NotFoundResponse();
+                }
+            }
+
+            $originalSharePath = $userFolder->getRelativePath($node->getPath());
+
+            if ($node instanceof \OCP\Files\File) {
+                // Single file download
+                $this->singleFileDownloaded($share, $share->getNode());
+            } else if (!empty($files_list)) {
+                $this->fileListDownloaded($share, $files_list, $node);
+            } else {
+                // The folder is downloaded
+                $this->singleFileDownloaded($share, $share->getNode());
+            }
+        }
+
+        /* FIXME: We should do this all nicely in OCP */
+        OC_Util::tearDownFS();
+        OC_Util::setupFS($share->getShareOwner());
+
+        /**
+         * this sets a cookie to be able to recognize the start of the download
+         * the content must not be longer than 32 characters and must only contain
+         * alphanumeric characters
+         */
+        if (!empty($downloadStartSecret)
+            && !isset($downloadStartSecret[32])
+            && preg_match('!^[a-zA-Z0-9]+$!', $downloadStartSecret) === 1) {
+
+            // FIXME: set on the response once we use an actual app framework response
+            setcookie('ocDownloadStarted', $downloadStartSecret, time() + 20, '/');
+        }
+
+        $this->emitAccessShareHook($share);
+
+        $server_params = array( 'head' => $this->request->getMethod() == 'HEAD' );
+
+        /**
+         * Http range requests support
+         */
+        if (isset($_SERVER['HTTP_RANGE'])) {
+            $server_params['range'] = $this->request->getHeader('Range');
+        }
+
+        // download selected files
+        if (!is_null($files) && $files !== '') {
+            // FIXME: The exit is required here because otherwise the AppFramework is trying to add headers as well
+            // after dispatching the request which results in a "Cannot modify header information" notice.
+            OC_Files::get($originalSharePath, $files_list, $server_params);
+            exit();
+        } else {
+            // FIXME: The exit is required here because otherwise the AppFramework is trying to add headers as well
+            // after dispatching the request which results in a "Cannot modify header information" notice.
+            OC_Files::get(dirname($originalSharePath), basename($originalSharePath), $server_params);
+            exit();
+        }
+    }
+
+    /**
+     * create activity for every downloaded file
+     *
+     * @param Share\IShare $share
+     * @param array $files_list
+     * @param \OCP\Files\Folder $node
+     */
+    protected function fileListDownloaded(Share\IShare $share, array $files_list, \OCP\Files\Folder $node) {
+        foreach ($files_list as $file) {
+            $subNode = $node->get($file);
+            $this->singleFileDownloaded($share, $subNode);
+        }
+
+    }
+
+    /**
+     * create activity if a single file was downloaded from a link share
+     *
+     * @param Share\IShare $share
+     */
+    protected function singleFileDownloaded(Share\IShare $share, \OCP\Files\Node $node) {
+
+        $fileId = $node->getId();
+
+        $userFolder = $this->rootFolder->getUserFolder($share->getSharedBy());
+        $userNodeList = $userFolder->getById($fileId);
+        $userNode = $userNodeList[0];
+        $ownerFolder = $this->rootFolder->getUserFolder($share->getShareOwner());
+        $userPath = $userFolder->getRelativePath($userNode->getPath());
+        $ownerPath = $ownerFolder->getRelativePath($node->getPath());
+
+        $parameters = [$userPath];
+
+        if ($share->getShareType() === \OCP\Share::SHARE_TYPE_EMAIL) {
+            if ($node instanceof \OCP\Files\File) {
+                $subject = Downloads::SUBJECT_SHARED_FILE_BY_EMAIL_DOWNLOADED;
+            } else {
+                $subject = Downloads::SUBJECT_SHARED_FOLDER_BY_EMAIL_DOWNLOADED;
+            }
+            $parameters[] = $share->getSharedWith();
+        } else {
+            if ($node instanceof \OCP\Files\File) {
+                $subject = Downloads::SUBJECT_PUBLIC_SHARED_FILE_DOWNLOADED;
+            } else {
+                $subject = Downloads::SUBJECT_PUBLIC_SHARED_FOLDER_DOWNLOADED;
+            }
+        }
+
+        $this->publishActivity($subject, $parameters, $share->getSharedBy(), $fileId, $userPath);
+
+        if ($share->getShareOwner() !== $share->getSharedBy()) {
+            $parameters[0] = $ownerPath;
+            $this->publishActivity($subject, $parameters, $share->getShareOwner(), $fileId, $ownerPath);
+        }
+    }
+
+    /**
+     * publish activity
+     *
+     * @param string $subject
+     * @param array $parameters
+     * @param string $affectedUser
+     * @param int $fileId
+     * @param string $filePath
+     */
+    protected function publishActivity($subject,
+                                        array $parameters,
+                                        $affectedUser,
+                                        $fileId,
+                                        $filePath) {
+
+        $event = $this->activityManager->generateEvent();
+        $event->setApp('files_sharing')
+            ->setType('public_links')
+            ->setSubject($subject, $parameters)
+            ->setAffectedUser($affectedUser)
+            ->setObject('files', $fileId, $filePath);
+        $this->activityManager->publish($event);
+    }
 
 
 }

apps/files_sharing/lib/Controller/ShareesAPIController.php

Doc Comments +4 added lines, -1 removed lines

@@ -358,7 +358,7 @@ 
 	 * split user and remote from federated cloud id
 	 *
 	 * @param string $address federated share address
-	 * @return array [user, remoteURL]
+	 * @return string[] [user, remoteURL]
 	 * @throws \Exception
 	 */
 	public function splitUserRemote($address) {
@@ -633,6 +633,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $search
+	 */
 	protected function getLookup($search) {
 		$isEnabled = $this->config->getAppValue('files_sharing', 'lookupServerEnabled', 'no');
 		$result = [];

Spacing +14 added lines, -14 removed lines

@@ -234,17 +234,17 @@ 
 		$this->result['groups'] = $this->result['exact']['groups'] = [];
 
 		$groups = $this->groupManager->search($search, $this->limit, $this->offset);
-		$groupIds = array_map(function (IGroup $group) { return $group->getGID(); }, $groups);
+		$groupIds = array_map(function(IGroup $group) { return $group->getGID(); }, $groups);
 
 		if (!$this->shareeEnumeration || sizeof($groups) < $this->limit) {
 			$this->reachedEndFor[] = 'groups';
 		}
 
-		$userGroups =  [];
+		$userGroups = [];
 		if (!empty($groups) && $this->shareWithGroupOnly) {
 			// Intersect all the groups that match with the groups this user is a member of
 			$userGroups = $this->groupManager->getUserGroups($this->userSession->getUser());
-			$userGroups = array_map(function (IGroup $group) { return $group->getGID(); }, $userGroups);
+			$userGroups = array_map(function(IGroup $group) { return $group->getGID(); }, $userGroups);
 			$groupIds = array_intersect($groupIds, $userGroups);
 		}
 
@@ -322,7 +322,7 @@ 
 							$result['exactIdMatch'] = true;
 						}
 						$result['exact'][] = [
-							'label' => $contact['FN'] . " ($cloudId)",
+							'label' => $contact['FN']." ($cloudId)",
 							'value' => [
 								'shareType' => Share::SHARE_TYPE_REMOTE,
 								'shareWith' => $cloudId,
@@ -331,7 +331,7 @@ 
 						];
 					} else {
 						$result['results'][] = [
-							'label' => $contact['FN'] . " ($cloudId)",
+							'label' => $contact['FN']." ($cloudId)",
 							'value' => [
 								'shareType' => Share::SHARE_TYPE_REMOTE,
 								'shareWith' => $cloudId,
@@ -415,13 +415,13 @@ 
 	public function search($search = '', $itemType = null, $page = 1, $perPage = 200, $shareType = null, $lookup = true) {
 
 		// only search for string larger than a given threshold
-		$threshold = (int)$this->config->getSystemValue('sharing.minSearchStringLength', 0);
+		$threshold = (int) $this->config->getSystemValue('sharing.minSearchStringLength', 0);
 		if (strlen($search) < $threshold) {
 			return new DataResponse($this->result);
 		}
 
 		// never return more than the max. number of results configured in the config.php
-		$maxResults = (int)$this->config->getSystemValue('sharing.maxAutocompleteResults', 0);
+		$maxResults = (int) $this->config->getSystemValue('sharing.maxAutocompleteResults', 0);
 		if ($maxResults > 0) {
 			$perPage = min($perPage, $maxResults);
 		}
@@ -585,7 +585,7 @@ 
 							$result['exactIdMatch'] = true;
 						}
 						$result['exact'][] = [
-							'label' => $contact['FN'] . " ($emailAddress)",
+							'label' => $contact['FN']." ($emailAddress)",
 							'value' => [
 								'shareType' => Share::SHARE_TYPE_EMAIL,
 								'shareWith' => $emailAddress,
@@ -593,7 +593,7 @@ 
 						];
 					} else {
 						$result['results'][] = [
-							'label' => $contact['FN'] . " ($emailAddress)",
+							'label' => $contact['FN']." ($emailAddress)",
 							'value' => [
 								'shareType' => Share::SHARE_TYPE_EMAIL,
 								'shareWith' => $emailAddress,
@@ -627,11 +627,11 @@ 
 		$isEnabled = $this->config->getAppValue('files_sharing', 'lookupServerEnabled', 'no');
 		$result = [];
 
-		if($isEnabled === 'yes') {
+		if ($isEnabled === 'yes') {
 			try {
 				$client = $this->clientService->newClient();
 				$response = $client->get(
-					'https://lookup.nextcloud.com/users?search=' . urlencode($search),
+					'https://lookup.nextcloud.com/users?search='.urlencode($search),
 					[
 						'timeout' => 10,
 						'connect_timeout' => 3,
@@ -666,12 +666,12 @@ 
 	 */
 	protected function getPaginationLink($page, array $params) {
 		if ($this->isV2()) {
-			$url = $this->urlGenerator->getAbsoluteURL('/ocs/v2.php/apps/files_sharing/api/v1/sharees') . '?';
+			$url = $this->urlGenerator->getAbsoluteURL('/ocs/v2.php/apps/files_sharing/api/v1/sharees').'?';
 		} else {
-			$url = $this->urlGenerator->getAbsoluteURL('/ocs/v1.php/apps/files_sharing/api/v1/sharees') . '?';
+			$url = $this->urlGenerator->getAbsoluteURL('/ocs/v1.php/apps/files_sharing/api/v1/sharees').'?';
 		}
 		$params['page'] = $page + 1;
-		$link = '<' . $url . http_build_query($params) . '>; rel="next"';
+		$link = '<'.$url.http_build_query($params).'>; rel="next"';
 
 		return $link;
 	}

Indentation +668 added lines, -668 removed lines

@@ -43,672 +43,672 @@
 
 class ShareesAPIController extends OCSController {
 
-	/** @var IGroupManager */
-	protected $groupManager;
-
-	/** @var IUserManager */
-	protected $userManager;
-
-	/** @var IManager */
-	protected $contactsManager;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IUserSession */
-	protected $userSession;
-
-	/** @var IURLGenerator */
-	protected $urlGenerator;
-
-	/** @var ILogger */
-	protected $logger;
-
-	/** @var \OCP\Share\IManager */
-	protected $shareManager;
-
-	/** @var IClientService */
-	protected $clientService;
-
-	/** @var ICloudIdManager  */
-	protected $cloudIdManager;
-
-	/** @var bool */
-	protected $shareWithGroupOnly = false;
-
-	/** @var bool */
-	protected $shareeEnumeration = true;
-
-	/** @var int */
-	protected $offset = 0;
-
-	/** @var int */
-	protected $limit = 10;
-
-	/** @var array */
-	protected $result = [
-		'exact' => [
-			'users' => [],
-			'groups' => [],
-			'remotes' => [],
-			'emails' => [],
-			'circles' => [],
-		],
-		'users' => [],
-		'groups' => [],
-		'remotes' => [],
-		'emails' => [],
-		'lookup' => [],
-		'circles' => [],
-	];
-
-	protected $reachedEndFor = [];
-
-	/**
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param IGroupManager $groupManager
-	 * @param IUserManager $userManager
-	 * @param IManager $contactsManager
-	 * @param IConfig $config
-	 * @param IUserSession $userSession
-	 * @param IURLGenerator $urlGenerator
-	 * @param ILogger $logger
-	 * @param \OCP\Share\IManager $shareManager
-	 * @param IClientService $clientService
-	 * @param ICloudIdManager $cloudIdManager
-	 */
-	public function __construct($appName,
-								IRequest $request,
-								IGroupManager $groupManager,
-								IUserManager $userManager,
-								IManager $contactsManager,
-								IConfig $config,
-								IUserSession $userSession,
-								IURLGenerator $urlGenerator,
-								ILogger $logger,
-								\OCP\Share\IManager $shareManager,
-								IClientService $clientService,
-								ICloudIdManager $cloudIdManager
-	) {
-		parent::__construct($appName, $request);
-
-		$this->groupManager = $groupManager;
-		$this->userManager = $userManager;
-		$this->contactsManager = $contactsManager;
-		$this->config = $config;
-		$this->userSession = $userSession;
-		$this->urlGenerator = $urlGenerator;
-		$this->logger = $logger;
-		$this->shareManager = $shareManager;
-		$this->clientService = $clientService;
-		$this->cloudIdManager = $cloudIdManager;
-	}
-
-	/**
-	 * @param string $search
-	 */
-	protected function getUsers($search) {
-		$this->result['users'] = $this->result['exact']['users'] = $users = [];
-
-		$userGroups = [];
-		if ($this->shareWithGroupOnly) {
-			// Search in all the groups this user is part of
-			$userGroups = $this->groupManager->getUserGroupIds($this->userSession->getUser());
-			foreach ($userGroups as $userGroup) {
-				$usersTmp = $this->groupManager->displayNamesInGroup($userGroup, $search, $this->limit, $this->offset);
-				foreach ($usersTmp as $uid => $userDisplayName) {
-					$users[$uid] = $userDisplayName;
-				}
-			}
-		} else {
-			// Search in all users
-			$usersTmp = $this->userManager->searchDisplayName($search, $this->limit, $this->offset);
-
-			foreach ($usersTmp as $user) {
-				$users[$user->getUID()] = $user->getDisplayName();
-			}
-		}
-
-		if (!$this->shareeEnumeration || sizeof($users) < $this->limit) {
-			$this->reachedEndFor[] = 'users';
-		}
-
-		$foundUserById = false;
-		$lowerSearch = strtolower($search);
-		foreach ($users as $uid => $userDisplayName) {
-			if (strtolower($uid) === $lowerSearch || strtolower($userDisplayName) === $lowerSearch) {
-				if (strtolower($uid) === $lowerSearch) {
-					$foundUserById = true;
-				}
-				$this->result['exact']['users'][] = [
-					'label' => $userDisplayName,
-					'value' => [
-						'shareType' => Share::SHARE_TYPE_USER,
-						'shareWith' => $uid,
-					],
-				];
-			} else {
-				$this->result['users'][] = [
-					'label' => $userDisplayName,
-					'value' => [
-						'shareType' => Share::SHARE_TYPE_USER,
-						'shareWith' => $uid,
-					],
-				];
-			}
-		}
-
-		if ($this->offset === 0 && !$foundUserById) {
-			// On page one we try if the search result has a direct hit on the
-			// user id and if so, we add that to the exact match list
-			$user = $this->userManager->get($search);
-			if ($user instanceof IUser) {
-				$addUser = true;
-
-				if ($this->shareWithGroupOnly) {
-					// Only add, if we have a common group
-					$commonGroups = array_intersect($userGroups, $this->groupManager->getUserGroupIds($user));
-					$addUser = !empty($commonGroups);
-				}
-
-				if ($addUser) {
-					array_push($this->result['exact']['users'], [
-						'label' => $user->getDisplayName(),
-						'value' => [
-							'shareType' => Share::SHARE_TYPE_USER,
-							'shareWith' => $user->getUID(),
-						],
-					]);
-				}
-			}
-		}
-
-		if (!$this->shareeEnumeration) {
-			$this->result['users'] = [];
-		}
-	}
-
-	/**
-	 * @param string $search
-	 */
-	protected function getGroups($search) {
-		$this->result['groups'] = $this->result['exact']['groups'] = [];
-
-		$groups = $this->groupManager->search($search, $this->limit, $this->offset);
-		$groupIds = array_map(function (IGroup $group) { return $group->getGID(); }, $groups);
-
-		if (!$this->shareeEnumeration || sizeof($groups) < $this->limit) {
-			$this->reachedEndFor[] = 'groups';
-		}
-
-		$userGroups =  [];
-		if (!empty($groups) && $this->shareWithGroupOnly) {
-			// Intersect all the groups that match with the groups this user is a member of
-			$userGroups = $this->groupManager->getUserGroups($this->userSession->getUser());
-			$userGroups = array_map(function (IGroup $group) { return $group->getGID(); }, $userGroups);
-			$groupIds = array_intersect($groupIds, $userGroups);
-		}
-
-		$lowerSearch = strtolower($search);
-		foreach ($groups as $group) {
-			// FIXME: use a more efficient approach
-			$gid = $group->getGID();
-			if (!in_array($gid, $groupIds)) {
-				continue;
-			}
-			if (strtolower($gid) === $lowerSearch || strtolower($group->getDisplayName()) === $lowerSearch) {
-				$this->result['exact']['groups'][] = [
-					'label' => $group->getDisplayName(),
-					'value' => [
-						'shareType' => Share::SHARE_TYPE_GROUP,
-						'shareWith' => $gid,
-					],
-				];
-			} else {
-				$this->result['groups'][] = [
-					'label' => $group->getDisplayName(),
-					'value' => [
-						'shareType' => Share::SHARE_TYPE_GROUP,
-						'shareWith' => $gid,
-					],
-				];
-			}
-		}
-
-		if ($this->offset === 0 && empty($this->result['exact']['groups'])) {
-			// On page one we try if the search result has a direct hit on the
-			// user id and if so, we add that to the exact match list
-			$group = $this->groupManager->get($search);
-			if ($group instanceof IGroup && (!$this->shareWithGroupOnly || in_array($group->getGID(), $userGroups))) {
-				array_push($this->result['exact']['groups'], [
-					'label' => $group->getDisplayName(),
-					'value' => [
-						'shareType' => Share::SHARE_TYPE_GROUP,
-						'shareWith' => $group->getGID(),
-					],
-				]);
-			}
-		}
-
-		if (!$this->shareeEnumeration) {
-			$this->result['groups'] = [];
-		}
-	}
-
-
-	/**
-	 * @param string $search
-	 */
-	protected function getCircles($search) {
-		$this->result['circles'] = $this->result['exact']['circles'] = [];
-
-		$result = \OCA\Circles\Api\Sharees::search($search, $this->limit, $this->offset);
-		if (array_key_exists('circles', $result['exact'])) {
-			$this->result['exact']['circles'] = $result['exact']['circles'];
-		}
-		if (array_key_exists('circles', $result)) {
-			$this->result['circles'] = $result['circles'];
-		}
-	}
-
-
-	/**
-	 * @param string $search
-	 * @return array
-	 */
-	protected function getRemote($search) {
-		$result = ['results' => [], 'exact' => []];
-
-		// Search in contacts
-		//@todo Pagination missing
-		$addressBookContacts = $this->contactsManager->search($search, ['CLOUD', 'FN']);
-		$result['exactIdMatch'] = false;
-		foreach ($addressBookContacts as $contact) {
-			if (isset($contact['isLocalSystemBook'])) {
-				continue;
-			}
-			if (isset($contact['CLOUD'])) {
-				$cloudIds = $contact['CLOUD'];
-				if (!is_array($cloudIds)) {
-					$cloudIds = [$cloudIds];
-				}
-				$lowerSearch = strtolower($search);
-				foreach ($cloudIds as $cloudId) {
-					list(, $serverUrl) = $this->splitUserRemote($cloudId);
-					if (strtolower($contact['FN']) === $lowerSearch || strtolower($cloudId) === $lowerSearch) {
-						if (strtolower($cloudId) === $lowerSearch) {
-							$result['exactIdMatch'] = true;
-						}
-						$result['exact'][] = [
-							'label' => $contact['FN'] . " ($cloudId)",
-							'value' => [
-								'shareType' => Share::SHARE_TYPE_REMOTE,
-								'shareWith' => $cloudId,
-								'server' => $serverUrl,
-							],
-						];
-					} else {
-						$result['results'][] = [
-							'label' => $contact['FN'] . " ($cloudId)",
-							'value' => [
-								'shareType' => Share::SHARE_TYPE_REMOTE,
-								'shareWith' => $cloudId,
-								'server' => $serverUrl,
-							],
-						];
-					}
-				}
-			}
-		}
-
-		if (!$this->shareeEnumeration) {
-			$result['results'] = [];
-		}
-
-		if (!$result['exactIdMatch'] && $this->cloudIdManager->isValidCloudId($search) && $this->offset === 0) {
-			$result['exact'][] = [
-				'label' => $search,
-				'value' => [
-					'shareType' => Share::SHARE_TYPE_REMOTE,
-					'shareWith' => $search,
-				],
-			];
-		}
-
-		$this->reachedEndFor[] = 'remotes';
-
-		return $result;
-	}
-
-	/**
-	 * split user and remote from federated cloud id
-	 *
-	 * @param string $address federated share address
-	 * @return array [user, remoteURL]
-	 * @throws \Exception
-	 */
-	public function splitUserRemote($address) {
-		try {
-			$cloudId = $this->cloudIdManager->resolveCloudId($address);
-			return [$cloudId->getUser(), $cloudId->getRemote()];
-		} catch (\InvalidArgumentException $e) {
-			throw new \Exception('Invalid Federated Cloud ID', 0, $e);
-		}
-	}
-
-	/**
-	 * Strips away a potential file names and trailing slashes:
-	 * - http://localhost
-	 * - http://localhost/
-	 * - http://localhost/index.php
-	 * - http://localhost/index.php/s/{shareToken}
-	 *
-	 * all return: http://localhost
-	 *
-	 * @param string $remote
-	 * @return string
-	 */
-	protected function fixRemoteURL($remote) {
-		$remote = str_replace('\\', '/', $remote);
-		if ($fileNamePosition = strpos($remote, '/index.php')) {
-			$remote = substr($remote, 0, $fileNamePosition);
-		}
-		$remote = rtrim($remote, '/');
-
-		return $remote;
-	}
-
-	/**
-	 * @NoAdminRequired
-	 *
-	 * @param string $search
-	 * @param string $itemType
-	 * @param int $page
-	 * @param int $perPage
-	 * @param int|int[] $shareType
-	 * @param bool $lookup
-	 * @return DataResponse
-	 * @throws OCSBadRequestException
-	 */
-	public function search($search = '', $itemType = null, $page = 1, $perPage = 200, $shareType = null, $lookup = true) {
-
-		// only search for string larger than a given threshold
-		$threshold = (int)$this->config->getSystemValue('sharing.minSearchStringLength', 0);
-		if (strlen($search) < $threshold) {
-			return new DataResponse($this->result);
-		}
-
-		// never return more than the max. number of results configured in the config.php
-		$maxResults = (int)$this->config->getSystemValue('sharing.maxAutocompleteResults', 0);
-		if ($maxResults > 0) {
-			$perPage = min($perPage, $maxResults);
-		}
-		if ($perPage <= 0) {
-			throw new OCSBadRequestException('Invalid perPage argument');
-		}
-		if ($page <= 0) {
-			throw new OCSBadRequestException('Invalid page');
-		}
-
-		$shareTypes = [
-			Share::SHARE_TYPE_USER,
-		];
-
-		if ($itemType === 'file' || $itemType === 'folder') {
-			if ($this->shareManager->allowGroupSharing()) {
-				$shareTypes[] = Share::SHARE_TYPE_GROUP;
-			}
-
-			if ($this->isRemoteSharingAllowed($itemType)) {
-				$shareTypes[] = Share::SHARE_TYPE_REMOTE;
-			}
-
-			if ($this->shareManager->shareProviderExists(Share::SHARE_TYPE_EMAIL)) {
-				$shareTypes[] = Share::SHARE_TYPE_EMAIL;
-			}
-		} else {
-			$shareTypes[] = Share::SHARE_TYPE_GROUP;
-			$shareTypes[] = Share::SHARE_TYPE_EMAIL;
-		}
-
-		if (\OCP\App::isEnabled('circles')) {
-			$shareTypes[] = Share::SHARE_TYPE_CIRCLE;
-		}
-
-		if (isset($_GET['shareType']) && is_array($_GET['shareType'])) {
-			$shareTypes = array_intersect($shareTypes, $_GET['shareType']);
-			sort($shareTypes);
-		} else if (is_numeric($shareType)) {
-			$shareTypes = array_intersect($shareTypes, [(int) $shareType]);
-			sort($shareTypes);
-		}
-
-		$this->shareWithGroupOnly = $this->config->getAppValue('core', 'shareapi_only_share_with_group_members', 'no') === 'yes';
-		$this->shareeEnumeration = $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes';
-		$this->limit = (int) $perPage;
-		$this->offset = $perPage * ($page - 1);
-
-		return $this->searchSharees($search, $itemType, $shareTypes, $page, $perPage, $lookup);
-	}
-
-	/**
-	 * Method to get out the static call for better testing
-	 *
-	 * @param string $itemType
-	 * @return bool
-	 */
-	protected function isRemoteSharingAllowed($itemType) {
-		try {
-			$backend = Share::getBackend($itemType);
-			return $backend->isShareTypeAllowed(Share::SHARE_TYPE_REMOTE);
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * Testable search function that does not need globals
-	 *
-	 * @param string $search
-	 * @param string $itemType
-	 * @param array $shareTypes
-	 * @param int $page
-	 * @param int $perPage
-	 * @param bool $lookup
-	 * @return DataResponse
-	 * @throws OCSBadRequestException
-	 */
-	protected function searchSharees($search, $itemType, array $shareTypes, $page, $perPage, $lookup) {
-		// Verify arguments
-		if ($itemType === null) {
-			throw new OCSBadRequestException('Missing itemType');
-		}
-
-		// Get users
-		if (in_array(Share::SHARE_TYPE_USER, $shareTypes)) {
-			$this->getUsers($search);
-		}
-
-		// Get groups
-		if (in_array(Share::SHARE_TYPE_GROUP, $shareTypes)) {
-			$this->getGroups($search);
-		}
-
-		// Get circles
-		if (in_array(Share::SHARE_TYPE_CIRCLE, $shareTypes)) {
-			$this->getCircles($search);
-		}
-
-
-		// Get remote
-		$remoteResults = ['results' => [], 'exact' => [], 'exactIdMatch' => false];
-		if (in_array(Share::SHARE_TYPE_REMOTE, $shareTypes)) {
-			$remoteResults = $this->getRemote($search);
-		}
-
-		// Get emails
-		$mailResults = ['results' => [], 'exact' => [], 'exactIdMatch' => false];
-		if (in_array(Share::SHARE_TYPE_EMAIL, $shareTypes)) {
-			$mailResults = $this->getEmail($search);
-		}
-
-		// Get from lookup server
-		if ($lookup) {
-			$this->getLookup($search);
-		}
-
-		// if we have a exact match, either for the federated cloud id or for the
-		// email address we only return the exact match. It is highly unlikely
-		// that the exact same email address and federated cloud id exists
-		if ($mailResults['exactIdMatch'] && !$remoteResults['exactIdMatch']) {
-			$this->result['emails'] = $mailResults['results'];
-			$this->result['exact']['emails'] = $mailResults['exact'];
-		} else if (!$mailResults['exactIdMatch'] && $remoteResults['exactIdMatch']) {
-			$this->result['remotes'] = $remoteResults['results'];
-			$this->result['exact']['remotes'] = $remoteResults['exact'];
-		} else {
-			$this->result['remotes'] = $remoteResults['results'];
-			$this->result['exact']['remotes'] = $remoteResults['exact'];
-			$this->result['emails'] = $mailResults['results'];
-			$this->result['exact']['emails'] = $mailResults['exact'];
-		}
-
-		$response = new DataResponse($this->result);
-
-		if (sizeof($this->reachedEndFor) < 3) {
-			$response->addHeader('Link', $this->getPaginationLink($page, [
-				'search' => $search,
-				'itemType' => $itemType,
-				'shareType' => $shareTypes,
-				'perPage' => $perPage,
-			]));
-		}
-
-		return $response;
-	}
-
-	/**
-	 * @param string $search
-	 * @return array
-	 */
-	protected function getEmail($search) {
-		$result = ['results' => [], 'exact' => []];
-
-		// Search in contacts
-		//@todo Pagination missing
-		$addressBookContacts = $this->contactsManager->search($search, ['EMAIL', 'FN']);
-		$result['exactIdMatch'] = false;
-		foreach ($addressBookContacts as $contact) {
-			if (isset($contact['isLocalSystemBook'])) {
-				continue;
-			}
-			if (isset($contact['EMAIL'])) {
-				$emailAddresses = $contact['EMAIL'];
-				if (!is_array($emailAddresses)) {
-					$emailAddresses = [$emailAddresses];
-				}
-				foreach ($emailAddresses as $emailAddress) {
-					if (strtolower($contact['FN']) === strtolower($search) || strtolower($emailAddress) === strtolower($search)) {
-						if (strtolower($emailAddress) === strtolower($search)) {
-							$result['exactIdMatch'] = true;
-						}
-						$result['exact'][] = [
-							'label' => $contact['FN'] . " ($emailAddress)",
-							'value' => [
-								'shareType' => Share::SHARE_TYPE_EMAIL,
-								'shareWith' => $emailAddress,
-							],
-						];
-					} else {
-						$result['results'][] = [
-							'label' => $contact['FN'] . " ($emailAddress)",
-							'value' => [
-								'shareType' => Share::SHARE_TYPE_EMAIL,
-								'shareWith' => $emailAddress,
-							],
-						];
-					}
-				}
-			}
-		}
-
-		if (!$this->shareeEnumeration) {
-			$result['results'] = [];
-		}
-
-		if (!$result['exactIdMatch'] && filter_var($search, FILTER_VALIDATE_EMAIL)) {
-			$result['exact'][] = [
-				'label' => $search,
-				'value' => [
-					'shareType' => Share::SHARE_TYPE_EMAIL,
-					'shareWith' => $search,
-				],
-			];
-		}
-
-		$this->reachedEndFor[] = 'emails';
-
-		return $result;
-	}
-
-	protected function getLookup($search) {
-		$isEnabled = $this->config->getAppValue('files_sharing', 'lookupServerEnabled', 'no');
-		$result = [];
-
-		if($isEnabled === 'yes') {
-			try {
-				$client = $this->clientService->newClient();
-				$response = $client->get(
-					'https://lookup.nextcloud.com/users?search=' . urlencode($search),
-					[
-						'timeout' => 10,
-						'connect_timeout' => 3,
-					]
-				);
-
-				$body = json_decode($response->getBody(), true);
-
-				$result = [];
-				foreach ($body as $lookup) {
-					$result[] = [
-						'label' => $lookup['federationId'],
-						'value' => [
-							'shareType' => Share::SHARE_TYPE_REMOTE,
-							'shareWith' => $lookup['federationId'],
-						],
-						'extra' => $lookup,
-					];
-				}
-			} catch (\Exception $e) {}
-		}
-
-		$this->result['lookup'] = $result;
-	}
-
-	/**
-	 * Generates a bunch of pagination links for the current page
-	 *
-	 * @param int $page Current page
-	 * @param array $params Parameters for the URL
-	 * @return string
-	 */
-	protected function getPaginationLink($page, array $params) {
-		if ($this->isV2()) {
-			$url = $this->urlGenerator->getAbsoluteURL('/ocs/v2.php/apps/files_sharing/api/v1/sharees') . '?';
-		} else {
-			$url = $this->urlGenerator->getAbsoluteURL('/ocs/v1.php/apps/files_sharing/api/v1/sharees') . '?';
-		}
-		$params['page'] = $page + 1;
-		$link = '<' . $url . http_build_query($params) . '>; rel="next"';
-
-		return $link;
-	}
-
-	/**
-	 * @return bool
-	 */
-	protected function isV2() {
-		return $this->request->getScriptName() === '/ocs/v2.php';
-	}
+    /** @var IGroupManager */
+    protected $groupManager;
+
+    /** @var IUserManager */
+    protected $userManager;
+
+    /** @var IManager */
+    protected $contactsManager;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var IUserSession */
+    protected $userSession;
+
+    /** @var IURLGenerator */
+    protected $urlGenerator;
+
+    /** @var ILogger */
+    protected $logger;
+
+    /** @var \OCP\Share\IManager */
+    protected $shareManager;
+
+    /** @var IClientService */
+    protected $clientService;
+
+    /** @var ICloudIdManager  */
+    protected $cloudIdManager;
+
+    /** @var bool */
+    protected $shareWithGroupOnly = false;
+
+    /** @var bool */
+    protected $shareeEnumeration = true;
+
+    /** @var int */
+    protected $offset = 0;
+
+    /** @var int */
+    protected $limit = 10;
+
+    /** @var array */
+    protected $result = [
+        'exact' => [
+            'users' => [],
+            'groups' => [],
+            'remotes' => [],
+            'emails' => [],
+            'circles' => [],
+        ],
+        'users' => [],
+        'groups' => [],
+        'remotes' => [],
+        'emails' => [],
+        'lookup' => [],
+        'circles' => [],
+    ];
+
+    protected $reachedEndFor = [];
+
+    /**
+     * @param string $appName
+     * @param IRequest $request
+     * @param IGroupManager $groupManager
+     * @param IUserManager $userManager
+     * @param IManager $contactsManager
+     * @param IConfig $config
+     * @param IUserSession $userSession
+     * @param IURLGenerator $urlGenerator
+     * @param ILogger $logger
+     * @param \OCP\Share\IManager $shareManager
+     * @param IClientService $clientService
+     * @param ICloudIdManager $cloudIdManager
+     */
+    public function __construct($appName,
+                                IRequest $request,
+                                IGroupManager $groupManager,
+                                IUserManager $userManager,
+                                IManager $contactsManager,
+                                IConfig $config,
+                                IUserSession $userSession,
+                                IURLGenerator $urlGenerator,
+                                ILogger $logger,
+                                \OCP\Share\IManager $shareManager,
+                                IClientService $clientService,
+                                ICloudIdManager $cloudIdManager
+    ) {
+        parent::__construct($appName, $request);
+
+        $this->groupManager = $groupManager;
+        $this->userManager = $userManager;
+        $this->contactsManager = $contactsManager;
+        $this->config = $config;
+        $this->userSession = $userSession;
+        $this->urlGenerator = $urlGenerator;
+        $this->logger = $logger;
+        $this->shareManager = $shareManager;
+        $this->clientService = $clientService;
+        $this->cloudIdManager = $cloudIdManager;
+    }
+
+    /**
+     * @param string $search
+     */
+    protected function getUsers($search) {
+        $this->result['users'] = $this->result['exact']['users'] = $users = [];
+
+        $userGroups = [];
+        if ($this->shareWithGroupOnly) {
+            // Search in all the groups this user is part of
+            $userGroups = $this->groupManager->getUserGroupIds($this->userSession->getUser());
+            foreach ($userGroups as $userGroup) {
+                $usersTmp = $this->groupManager->displayNamesInGroup($userGroup, $search, $this->limit, $this->offset);
+                foreach ($usersTmp as $uid => $userDisplayName) {
+                    $users[$uid] = $userDisplayName;
+                }
+            }
+        } else {
+            // Search in all users
+            $usersTmp = $this->userManager->searchDisplayName($search, $this->limit, $this->offset);
+
+            foreach ($usersTmp as $user) {
+                $users[$user->getUID()] = $user->getDisplayName();
+            }
+        }
+
+        if (!$this->shareeEnumeration || sizeof($users) < $this->limit) {
+            $this->reachedEndFor[] = 'users';
+        }
+
+        $foundUserById = false;
+        $lowerSearch = strtolower($search);
+        foreach ($users as $uid => $userDisplayName) {
+            if (strtolower($uid) === $lowerSearch || strtolower($userDisplayName) === $lowerSearch) {
+                if (strtolower($uid) === $lowerSearch) {
+                    $foundUserById = true;
+                }
+                $this->result['exact']['users'][] = [
+                    'label' => $userDisplayName,
+                    'value' => [
+                        'shareType' => Share::SHARE_TYPE_USER,
+                        'shareWith' => $uid,
+                    ],
+                ];
+            } else {
+                $this->result['users'][] = [
+                    'label' => $userDisplayName,
+                    'value' => [
+                        'shareType' => Share::SHARE_TYPE_USER,
+                        'shareWith' => $uid,
+                    ],
+                ];
+            }
+        }
+
+        if ($this->offset === 0 && !$foundUserById) {
+            // On page one we try if the search result has a direct hit on the
+            // user id and if so, we add that to the exact match list
+            $user = $this->userManager->get($search);
+            if ($user instanceof IUser) {
+                $addUser = true;
+
+                if ($this->shareWithGroupOnly) {
+                    // Only add, if we have a common group
+                    $commonGroups = array_intersect($userGroups, $this->groupManager->getUserGroupIds($user));
+                    $addUser = !empty($commonGroups);
+                }
+
+                if ($addUser) {
+                    array_push($this->result['exact']['users'], [
+                        'label' => $user->getDisplayName(),
+                        'value' => [
+                            'shareType' => Share::SHARE_TYPE_USER,
+                            'shareWith' => $user->getUID(),
+                        ],
+                    ]);
+                }
+            }
+        }
+
+        if (!$this->shareeEnumeration) {
+            $this->result['users'] = [];
+        }
+    }
+
+    /**
+     * @param string $search
+     */
+    protected function getGroups($search) {
+        $this->result['groups'] = $this->result['exact']['groups'] = [];
+
+        $groups = $this->groupManager->search($search, $this->limit, $this->offset);
+        $groupIds = array_map(function (IGroup $group) { return $group->getGID(); }, $groups);
+
+        if (!$this->shareeEnumeration || sizeof($groups) < $this->limit) {
+            $this->reachedEndFor[] = 'groups';
+        }
+
+        $userGroups =  [];
+        if (!empty($groups) && $this->shareWithGroupOnly) {
+            // Intersect all the groups that match with the groups this user is a member of
+            $userGroups = $this->groupManager->getUserGroups($this->userSession->getUser());
+            $userGroups = array_map(function (IGroup $group) { return $group->getGID(); }, $userGroups);
+            $groupIds = array_intersect($groupIds, $userGroups);
+        }
+
+        $lowerSearch = strtolower($search);
+        foreach ($groups as $group) {
+            // FIXME: use a more efficient approach
+            $gid = $group->getGID();
+            if (!in_array($gid, $groupIds)) {
+                continue;
+            }
+            if (strtolower($gid) === $lowerSearch || strtolower($group->getDisplayName()) === $lowerSearch) {
+                $this->result['exact']['groups'][] = [
+                    'label' => $group->getDisplayName(),
+                    'value' => [
+                        'shareType' => Share::SHARE_TYPE_GROUP,
+                        'shareWith' => $gid,
+                    ],
+                ];
+            } else {
+                $this->result['groups'][] = [
+                    'label' => $group->getDisplayName(),
+                    'value' => [
+                        'shareType' => Share::SHARE_TYPE_GROUP,
+                        'shareWith' => $gid,
+                    ],
+                ];
+            }
+        }
+
+        if ($this->offset === 0 && empty($this->result['exact']['groups'])) {
+            // On page one we try if the search result has a direct hit on the
+            // user id and if so, we add that to the exact match list
+            $group = $this->groupManager->get($search);
+            if ($group instanceof IGroup && (!$this->shareWithGroupOnly || in_array($group->getGID(), $userGroups))) {
+                array_push($this->result['exact']['groups'], [
+                    'label' => $group->getDisplayName(),
+                    'value' => [
+                        'shareType' => Share::SHARE_TYPE_GROUP,
+                        'shareWith' => $group->getGID(),
+                    ],
+                ]);
+            }
+        }
+
+        if (!$this->shareeEnumeration) {
+            $this->result['groups'] = [];
+        }
+    }
+
+
+    /**
+     * @param string $search
+     */
+    protected function getCircles($search) {
+        $this->result['circles'] = $this->result['exact']['circles'] = [];
+
+        $result = \OCA\Circles\Api\Sharees::search($search, $this->limit, $this->offset);
+        if (array_key_exists('circles', $result['exact'])) {
+            $this->result['exact']['circles'] = $result['exact']['circles'];
+        }
+        if (array_key_exists('circles', $result)) {
+            $this->result['circles'] = $result['circles'];
+        }
+    }
+
+
+    /**
+     * @param string $search
+     * @return array
+     */
+    protected function getRemote($search) {
+        $result = ['results' => [], 'exact' => []];
+
+        // Search in contacts
+        //@todo Pagination missing
+        $addressBookContacts = $this->contactsManager->search($search, ['CLOUD', 'FN']);
+        $result['exactIdMatch'] = false;
+        foreach ($addressBookContacts as $contact) {
+            if (isset($contact['isLocalSystemBook'])) {
+                continue;
+            }
+            if (isset($contact['CLOUD'])) {
+                $cloudIds = $contact['CLOUD'];
+                if (!is_array($cloudIds)) {
+                    $cloudIds = [$cloudIds];
+                }
+                $lowerSearch = strtolower($search);
+                foreach ($cloudIds as $cloudId) {
+                    list(, $serverUrl) = $this->splitUserRemote($cloudId);
+                    if (strtolower($contact['FN']) === $lowerSearch || strtolower($cloudId) === $lowerSearch) {
+                        if (strtolower($cloudId) === $lowerSearch) {
+                            $result['exactIdMatch'] = true;
+                        }
+                        $result['exact'][] = [
+                            'label' => $contact['FN'] . " ($cloudId)",
+                            'value' => [
+                                'shareType' => Share::SHARE_TYPE_REMOTE,
+                                'shareWith' => $cloudId,
+                                'server' => $serverUrl,
+                            ],
+                        ];
+                    } else {
+                        $result['results'][] = [
+                            'label' => $contact['FN'] . " ($cloudId)",
+                            'value' => [
+                                'shareType' => Share::SHARE_TYPE_REMOTE,
+                                'shareWith' => $cloudId,
+                                'server' => $serverUrl,
+                            ],
+                        ];
+                    }
+                }
+            }
+        }
+
+        if (!$this->shareeEnumeration) {
+            $result['results'] = [];
+        }
+
+        if (!$result['exactIdMatch'] && $this->cloudIdManager->isValidCloudId($search) && $this->offset === 0) {
+            $result['exact'][] = [
+                'label' => $search,
+                'value' => [
+                    'shareType' => Share::SHARE_TYPE_REMOTE,
+                    'shareWith' => $search,
+                ],
+            ];
+        }
+
+        $this->reachedEndFor[] = 'remotes';
+
+        return $result;
+    }
+
+    /**
+     * split user and remote from federated cloud id
+     *
+     * @param string $address federated share address
+     * @return array [user, remoteURL]
+     * @throws \Exception
+     */
+    public function splitUserRemote($address) {
+        try {
+            $cloudId = $this->cloudIdManager->resolveCloudId($address);
+            return [$cloudId->getUser(), $cloudId->getRemote()];
+        } catch (\InvalidArgumentException $e) {
+            throw new \Exception('Invalid Federated Cloud ID', 0, $e);
+        }
+    }
+
+    /**
+     * Strips away a potential file names and trailing slashes:
+     * - http://localhost
+     * - http://localhost/
+     * - http://localhost/index.php
+     * - http://localhost/index.php/s/{shareToken}
+     *
+     * all return: http://localhost
+     *
+     * @param string $remote
+     * @return string
+     */
+    protected function fixRemoteURL($remote) {
+        $remote = str_replace('\\', '/', $remote);
+        if ($fileNamePosition = strpos($remote, '/index.php')) {
+            $remote = substr($remote, 0, $fileNamePosition);
+        }
+        $remote = rtrim($remote, '/');
+
+        return $remote;
+    }
+
+    /**
+     * @NoAdminRequired
+     *
+     * @param string $search
+     * @param string $itemType
+     * @param int $page
+     * @param int $perPage
+     * @param int|int[] $shareType
+     * @param bool $lookup
+     * @return DataResponse
+     * @throws OCSBadRequestException
+     */
+    public function search($search = '', $itemType = null, $page = 1, $perPage = 200, $shareType = null, $lookup = true) {
+
+        // only search for string larger than a given threshold
+        $threshold = (int)$this->config->getSystemValue('sharing.minSearchStringLength', 0);
+        if (strlen($search) < $threshold) {
+            return new DataResponse($this->result);
+        }
+
+        // never return more than the max. number of results configured in the config.php
+        $maxResults = (int)$this->config->getSystemValue('sharing.maxAutocompleteResults', 0);
+        if ($maxResults > 0) {
+            $perPage = min($perPage, $maxResults);
+        }
+        if ($perPage <= 0) {
+            throw new OCSBadRequestException('Invalid perPage argument');
+        }
+        if ($page <= 0) {
+            throw new OCSBadRequestException('Invalid page');
+        }
+
+        $shareTypes = [
+            Share::SHARE_TYPE_USER,
+        ];
+
+        if ($itemType === 'file' || $itemType === 'folder') {
+            if ($this->shareManager->allowGroupSharing()) {
+                $shareTypes[] = Share::SHARE_TYPE_GROUP;
+            }
+
+            if ($this->isRemoteSharingAllowed($itemType)) {
+                $shareTypes[] = Share::SHARE_TYPE_REMOTE;
+            }
+
+            if ($this->shareManager->shareProviderExists(Share::SHARE_TYPE_EMAIL)) {
+                $shareTypes[] = Share::SHARE_TYPE_EMAIL;
+            }
+        } else {
+            $shareTypes[] = Share::SHARE_TYPE_GROUP;
+            $shareTypes[] = Share::SHARE_TYPE_EMAIL;
+        }
+
+        if (\OCP\App::isEnabled('circles')) {
+            $shareTypes[] = Share::SHARE_TYPE_CIRCLE;
+        }
+
+        if (isset($_GET['shareType']) && is_array($_GET['shareType'])) {
+            $shareTypes = array_intersect($shareTypes, $_GET['shareType']);
+            sort($shareTypes);
+        } else if (is_numeric($shareType)) {
+            $shareTypes = array_intersect($shareTypes, [(int) $shareType]);
+            sort($shareTypes);
+        }
+
+        $this->shareWithGroupOnly = $this->config->getAppValue('core', 'shareapi_only_share_with_group_members', 'no') === 'yes';
+        $this->shareeEnumeration = $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes';
+        $this->limit = (int) $perPage;
+        $this->offset = $perPage * ($page - 1);
+
+        return $this->searchSharees($search, $itemType, $shareTypes, $page, $perPage, $lookup);
+    }
+
+    /**
+     * Method to get out the static call for better testing
+     *
+     * @param string $itemType
+     * @return bool
+     */
+    protected function isRemoteSharingAllowed($itemType) {
+        try {
+            $backend = Share::getBackend($itemType);
+            return $backend->isShareTypeAllowed(Share::SHARE_TYPE_REMOTE);
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * Testable search function that does not need globals
+     *
+     * @param string $search
+     * @param string $itemType
+     * @param array $shareTypes
+     * @param int $page
+     * @param int $perPage
+     * @param bool $lookup
+     * @return DataResponse
+     * @throws OCSBadRequestException
+     */
+    protected function searchSharees($search, $itemType, array $shareTypes, $page, $perPage, $lookup) {
+        // Verify arguments
+        if ($itemType === null) {
+            throw new OCSBadRequestException('Missing itemType');
+        }
+
+        // Get users
+        if (in_array(Share::SHARE_TYPE_USER, $shareTypes)) {
+            $this->getUsers($search);
+        }
+
+        // Get groups
+        if (in_array(Share::SHARE_TYPE_GROUP, $shareTypes)) {
+            $this->getGroups($search);
+        }
+
+        // Get circles
+        if (in_array(Share::SHARE_TYPE_CIRCLE, $shareTypes)) {
+            $this->getCircles($search);
+        }
+
+
+        // Get remote
+        $remoteResults = ['results' => [], 'exact' => [], 'exactIdMatch' => false];
+        if (in_array(Share::SHARE_TYPE_REMOTE, $shareTypes)) {
+            $remoteResults = $this->getRemote($search);
+        }
+
+        // Get emails
+        $mailResults = ['results' => [], 'exact' => [], 'exactIdMatch' => false];
+        if (in_array(Share::SHARE_TYPE_EMAIL, $shareTypes)) {
+            $mailResults = $this->getEmail($search);
+        }
+
+        // Get from lookup server
+        if ($lookup) {
+            $this->getLookup($search);
+        }
+
+        // if we have a exact match, either for the federated cloud id or for the
+        // email address we only return the exact match. It is highly unlikely
+        // that the exact same email address and federated cloud id exists
+        if ($mailResults['exactIdMatch'] && !$remoteResults['exactIdMatch']) {
+            $this->result['emails'] = $mailResults['results'];
+            $this->result['exact']['emails'] = $mailResults['exact'];
+        } else if (!$mailResults['exactIdMatch'] && $remoteResults['exactIdMatch']) {
+            $this->result['remotes'] = $remoteResults['results'];
+            $this->result['exact']['remotes'] = $remoteResults['exact'];
+        } else {
+            $this->result['remotes'] = $remoteResults['results'];
+            $this->result['exact']['remotes'] = $remoteResults['exact'];
+            $this->result['emails'] = $mailResults['results'];
+            $this->result['exact']['emails'] = $mailResults['exact'];
+        }
+
+        $response = new DataResponse($this->result);
+
+        if (sizeof($this->reachedEndFor) < 3) {
+            $response->addHeader('Link', $this->getPaginationLink($page, [
+                'search' => $search,
+                'itemType' => $itemType,
+                'shareType' => $shareTypes,
+                'perPage' => $perPage,
+            ]));
+        }
+
+        return $response;
+    }
+
+    /**
+     * @param string $search
+     * @return array
+     */
+    protected function getEmail($search) {
+        $result = ['results' => [], 'exact' => []];
+
+        // Search in contacts
+        //@todo Pagination missing
+        $addressBookContacts = $this->contactsManager->search($search, ['EMAIL', 'FN']);
+        $result['exactIdMatch'] = false;
+        foreach ($addressBookContacts as $contact) {
+            if (isset($contact['isLocalSystemBook'])) {
+                continue;
+            }
+            if (isset($contact['EMAIL'])) {
+                $emailAddresses = $contact['EMAIL'];
+                if (!is_array($emailAddresses)) {
+                    $emailAddresses = [$emailAddresses];
+                }
+                foreach ($emailAddresses as $emailAddress) {
+                    if (strtolower($contact['FN']) === strtolower($search) || strtolower($emailAddress) === strtolower($search)) {
+                        if (strtolower($emailAddress) === strtolower($search)) {
+                            $result['exactIdMatch'] = true;
+                        }
+                        $result['exact'][] = [
+                            'label' => $contact['FN'] . " ($emailAddress)",
+                            'value' => [
+                                'shareType' => Share::SHARE_TYPE_EMAIL,
+                                'shareWith' => $emailAddress,
+                            ],
+                        ];
+                    } else {
+                        $result['results'][] = [
+                            'label' => $contact['FN'] . " ($emailAddress)",
+                            'value' => [
+                                'shareType' => Share::SHARE_TYPE_EMAIL,
+                                'shareWith' => $emailAddress,
+                            ],
+                        ];
+                    }
+                }
+            }
+        }
+
+        if (!$this->shareeEnumeration) {
+            $result['results'] = [];
+        }
+
+        if (!$result['exactIdMatch'] && filter_var($search, FILTER_VALIDATE_EMAIL)) {
+            $result['exact'][] = [
+                'label' => $search,
+                'value' => [
+                    'shareType' => Share::SHARE_TYPE_EMAIL,
+                    'shareWith' => $search,
+                ],
+            ];
+        }
+
+        $this->reachedEndFor[] = 'emails';
+
+        return $result;
+    }
+
+    protected function getLookup($search) {
+        $isEnabled = $this->config->getAppValue('files_sharing', 'lookupServerEnabled', 'no');
+        $result = [];
+
+        if($isEnabled === 'yes') {
+            try {
+                $client = $this->clientService->newClient();
+                $response = $client->get(
+                    'https://lookup.nextcloud.com/users?search=' . urlencode($search),
+                    [
+                        'timeout' => 10,
+                        'connect_timeout' => 3,
+                    ]
+                );
+
+                $body = json_decode($response->getBody(), true);
+
+                $result = [];
+                foreach ($body as $lookup) {
+                    $result[] = [
+                        'label' => $lookup['federationId'],
+                        'value' => [
+                            'shareType' => Share::SHARE_TYPE_REMOTE,
+                            'shareWith' => $lookup['federationId'],
+                        ],
+                        'extra' => $lookup,
+                    ];
+                }
+            } catch (\Exception $e) {}
+        }
+
+        $this->result['lookup'] = $result;
+    }
+
+    /**
+     * Generates a bunch of pagination links for the current page
+     *
+     * @param int $page Current page
+     * @param array $params Parameters for the URL
+     * @return string
+     */
+    protected function getPaginationLink($page, array $params) {
+        if ($this->isV2()) {
+            $url = $this->urlGenerator->getAbsoluteURL('/ocs/v2.php/apps/files_sharing/api/v1/sharees') . '?';
+        } else {
+            $url = $this->urlGenerator->getAbsoluteURL('/ocs/v1.php/apps/files_sharing/api/v1/sharees') . '?';
+        }
+        $params['page'] = $page + 1;
+        $link = '<' . $url . http_build_query($params) . '>; rel="next"';
+
+        return $link;
+    }
+
+    /**
+     * @return bool
+     */
+    protected function isV2() {
+        return $this->request->getScriptName() === '/ocs/v2.php';
+    }
 }

apps/provisioning_api/lib/Controller/UsersController.php

Doc Comments +1 added lines, -1 removed lines

@@ -225,7 +225,7 @@
 	/**
 	 * creates a array with all user data
 	 *
-	 * @param $userId
+	 * @param string $userId
 	 * @return array
 	 * @throws OCSException
 	 */

Braces +1 added lines, -1 removed lines

@@ -335,7 +335,7 @@
 					}
 					if($quota === 0) {
 						$quota = 'default';
-					}else if($quota === -1) {
+					} else if($quota === -1) {
 						$quota = 'none';
 					} else {
 						$quota = \OCP\Util::humanFileSize($quota);

Indentation +773 added lines, -773 removed lines

@@ -51,777 +51,777 @@
 
 class UsersController extends OCSController {
 
-	/** @var IUserManager */
-	private $userManager;
-	/** @var IConfig */
-	private $config;
-	/** @var IGroupManager|\OC\Group\Manager */ // FIXME Requires a method that is not on the interface
-	private $groupManager;
-	/** @var IUserSession */
-	private $userSession;
-	/** @var AccountManager */
-	private $accountManager;
-	/** @var ILogger */
-	private $logger;
-	/** @var string */
-	private $fromMailAddress;
-	/** @var IURLGenerator */
-	private $urlGenerator;
-	/** @var IMailer */
-	private $mailer;
-	/** @var Defaults */
-	private $defaults;
-	/** @var IFactory */
-	private $l10nFactory;
-	/** @var NewUserMailHelper */
-	private $newUserMailHelper;
-
-	/**
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param IUserManager $userManager
-	 * @param IConfig $config
-	 * @param IGroupManager $groupManager
-	 * @param IUserSession $userSession
-	 * @param AccountManager $accountManager
-	 * @param ILogger $logger
-	 * @param string $fromMailAddress
-	 * @param IURLGenerator $urlGenerator
-	 * @param IMailer $mailer
-	 * @param Defaults $defaults
-	 * @param IFactory $l10nFactory
-	 * @param NewUserMailHelper $newUserMailHelper
-	 */
-	public function __construct($appName,
-								IRequest $request,
-								IUserManager $userManager,
-								IConfig $config,
-								IGroupManager $groupManager,
-								IUserSession $userSession,
-								AccountManager $accountManager,
-								ILogger $logger,
-								$fromMailAddress,
-								IURLGenerator $urlGenerator,
-								IMailer $mailer,
-								Defaults $defaults,
-								IFactory $l10nFactory,
-								NewUserMailHelper $newUserMailHelper) {
-		parent::__construct($appName, $request);
-
-		$this->userManager = $userManager;
-		$this->config = $config;
-		$this->groupManager = $groupManager;
-		$this->userSession = $userSession;
-		$this->accountManager = $accountManager;
-		$this->logger = $logger;
-		$this->fromMailAddress = $fromMailAddress;
-		$this->urlGenerator = $urlGenerator;
-		$this->mailer = $mailer;
-		$this->defaults = $defaults;
-		$this->l10nFactory = $l10nFactory;
-		$this->newUserMailHelper = $newUserMailHelper;
-	}
-
-	/**
-	 * @NoAdminRequired
-	 *
-	 * returns a list of users
-	 *
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return DataResponse
-	 */
-	public function getUsers($search = '', $limit = null, $offset = null) {
-		$user = $this->userSession->getUser();
-		$users = [];
-
-		// Admin? Or SubAdmin?
-		$uid = $user->getUID();
-		$subAdminManager = $this->groupManager->getSubAdmin();
-		if($this->groupManager->isAdmin($uid)){
-			$users = $this->userManager->search($search, $limit, $offset);
-		} else if ($subAdminManager->isSubAdmin($user)) {
-			$subAdminOfGroups = $subAdminManager->getSubAdminsGroups($user);
-			foreach ($subAdminOfGroups as $key => $group) {
-				$subAdminOfGroups[$key] = $group->getGID();
-			}
-
-			if($offset === null) {
-				$offset = 0;
-			}
-
-			$users = [];
-			foreach ($subAdminOfGroups as $group) {
-				$users = array_merge($users, $this->groupManager->displayNamesInGroup($group, $search));
-			}
-
-			$users = array_slice($users, $offset, $limit);
-		}
-
-		$users = array_keys($users);
-
-		return new DataResponse([
-			'users' => $users
-		]);
-	}
-
-	/**
-	 * @PasswordConfirmationRequired
-	 * @NoAdminRequired
-	 *
-	 * @param string $userid
-	 * @param string $password
-	 * @param array $groups
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function addUser($userid, $password, $groups = null) {
-		$user = $this->userSession->getUser();
-		$isAdmin = $this->groupManager->isAdmin($user->getUID());
-		$subAdminManager = $this->groupManager->getSubAdmin();
-
-		if($this->userManager->userExists($userid)) {
-			$this->logger->error('Failed addUser attempt: User already exists.', ['app' => 'ocs_api']);
-			throw new OCSException('User already exists', 102);
-		}
-
-		if(is_array($groups)) {
-			foreach ($groups as $group) {
-				if(!$this->groupManager->groupExists($group)) {
-					throw new OCSException('group '.$group.' does not exist', 104);
-				}
-				if(!$isAdmin && !$subAdminManager->isSubAdminofGroup($user, $this->groupManager->get($group))) {
-					throw new OCSException('insufficient privileges for group '. $group, 105);
-				}
-			}
-		} else {
-			if(!$isAdmin) {
-				throw new OCSException('no group specified (required for subadmins)', 106);
-			}
-		}
-
-		try {
-			$newUser = $this->userManager->createUser($userid, $password);
-			$this->logger->info('Successful addUser call with userid: '.$userid, ['app' => 'ocs_api']);
-
-			if (is_array($groups)) {
-				foreach ($groups as $group) {
-					$this->groupManager->get($group)->addUser($newUser);
-					$this->logger->info('Added userid '.$userid.' to group '.$group, ['app' => 'ocs_api']);
-				}
-			}
-			return new DataResponse();
-		} catch (\Exception $e) {
-			$this->logger->error('Failed addUser attempt with exception: '.$e->getMessage(), ['app' => 'ocs_api']);
-			throw new OCSException('Bad request', 101);
-		}
-	}
-
-	/**
-	 * @NoAdminRequired
-	 * @NoSubAdminRequired
-	 *
-	 * gets user info
-	 *
-	 * @param string $userId
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function getUser($userId) {
-		$data = $this->getUserData($userId);
-		return new DataResponse($data);
-	}
-
-	/**
-	 * @NoAdminRequired
-	 * @NoSubAdminRequired
-	 *
-	 * gets user info from the currently logged in user
-	 *
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function getCurrentUser() {
-		$user = $this->userSession->getUser();
-		if ($user) {
-			$data =  $this->getUserData($user->getUID());
-			// rename "displayname" to "display-name" only for this call to keep
-			// the API stable.
-			$data['display-name'] = $data['displayname'];
-			unset($data['displayname']);
-			return new DataResponse($data);
-
-		}
-
-		throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
-	}
-
-	/**
-	 * creates a array with all user data
-	 *
-	 * @param $userId
-	 * @return array
-	 * @throws OCSException
-	 */
-	protected function getUserData($userId) {
-		$currentLoggedInUser = $this->userSession->getUser();
-
-		$data = [];
-
-		// Check if the target user exists
-		$targetUserObject = $this->userManager->get($userId);
-		if($targetUserObject === null) {
-			throw new OCSException('The requested user could not be found', \OCP\API::RESPOND_NOT_FOUND);
-		}
-
-		// Admin? Or SubAdmin?
-		if($this->groupManager->isAdmin($currentLoggedInUser->getUID())
-			|| $this->groupManager->getSubAdmin()->isUserAccessible($currentLoggedInUser, $targetUserObject)) {
-			$data['enabled'] = $this->config->getUserValue($userId, 'core', 'enabled', 'true');
-		} else {
-			// Check they are looking up themselves
-			if($currentLoggedInUser->getUID() !== $userId) {
-				throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
-			}
-		}
-
-		$userAccount = $this->accountManager->getUser($targetUserObject);
-		$groups = $this->groupManager->getUserGroups($targetUserObject);
-		$gids = [];
-		foreach ($groups as $group) {
-			$gids[] = $group->getDisplayName();
-		}
-
-		// Find the data
-		$data['id'] = $targetUserObject->getUID();
-		$data['quota'] = $this->fillStorageInfo($userId);
-		$data[AccountManager::PROPERTY_EMAIL] = $targetUserObject->getEMailAddress();
-		$data[AccountManager::PROPERTY_DISPLAYNAME] = $targetUserObject->getDisplayName();
-		$data[AccountManager::PROPERTY_PHONE] = $userAccount[AccountManager::PROPERTY_PHONE]['value'];
-		$data[AccountManager::PROPERTY_ADDRESS] = $userAccount[AccountManager::PROPERTY_ADDRESS]['value'];
-		$data[AccountManager::PROPERTY_WEBSITE] = $userAccount[AccountManager::PROPERTY_WEBSITE]['value'];
-		$data[AccountManager::PROPERTY_TWITTER] = $userAccount[AccountManager::PROPERTY_TWITTER]['value'];
-		$data['groups'] = $gids;
-
-		return $data;
-	}
-
-	/**
-	 * @NoAdminRequired
-	 * @NoSubAdminRequired
-	 * @PasswordConfirmationRequired
-	 *
-	 * edit users
-	 *
-	 * @param string $userId
-	 * @param string $key
-	 * @param string $value
-	 * @return DataResponse
-	 * @throws OCSException
-	 * @throws OCSForbiddenException
-	 */
-	public function editUser($userId, $key, $value) {
-		$currentLoggedInUser = $this->userSession->getUser();
-
-		$targetUser = $this->userManager->get($userId);
-		if($targetUser === null) {
-			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
-		}
-
-		$permittedFields = [];
-		if($userId === $currentLoggedInUser->getUID()) {
-			// Editing self (display, email)
-			$permittedFields[] = 'display';
-			$permittedFields[] = AccountManager::PROPERTY_DISPLAYNAME;
-			$permittedFields[] = AccountManager::PROPERTY_EMAIL;
-			$permittedFields[] = 'password';
-			$permittedFields[] = AccountManager::PROPERTY_PHONE;
-			$permittedFields[] = AccountManager::PROPERTY_ADDRESS;
-			$permittedFields[] = AccountManager::PROPERTY_WEBSITE;
-			$permittedFields[] = AccountManager::PROPERTY_TWITTER;
-			// If admin they can edit their own quota
-			if($this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
-				$permittedFields[] = 'quota';
-			}
-		} else {
-			// Check if admin / subadmin
-			$subAdminManager = $this->groupManager->getSubAdmin();
-			if($subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
-			|| $this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
-				// They have permissions over the user
-				$permittedFields[] = 'display';
-				$permittedFields[] = AccountManager::PROPERTY_DISPLAYNAME;
-				$permittedFields[] = AccountManager::PROPERTY_EMAIL;
-				$permittedFields[] = 'password';
-				$permittedFields[] = AccountManager::PROPERTY_PHONE;
-				$permittedFields[] = AccountManager::PROPERTY_ADDRESS;
-				$permittedFields[] = AccountManager::PROPERTY_WEBSITE;
-				$permittedFields[] = AccountManager::PROPERTY_TWITTER;
-				$permittedFields[] = 'quota';
-			} else {
-				// No rights
-				throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
-			}
-		}
-		// Check if permitted to edit this field
-		if(!in_array($key, $permittedFields)) {
-			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
-		}
-		// Process the edit
-		switch($key) {
-			case 'display':
-			case AccountManager::PROPERTY_DISPLAYNAME:
-				$targetUser->setDisplayName($value);
-				break;
-			case 'quota':
-				$quota = $value;
-				if($quota !== 'none' && $quota !== 'default') {
-					if (is_numeric($quota)) {
-						$quota = (float) $quota;
-					} else {
-						$quota = \OCP\Util::computerFileSize($quota);
-					}
-					if ($quota === false) {
-						throw new OCSException('Invalid quota value '.$value, 103);
-					}
-					if($quota === 0) {
-						$quota = 'default';
-					}else if($quota === -1) {
-						$quota = 'none';
-					} else {
-						$quota = \OCP\Util::humanFileSize($quota);
-					}
-				}
-				$targetUser->setQuota($quota);
-				break;
-			case 'password':
-				$targetUser->setPassword($value);
-				break;
-			case AccountManager::PROPERTY_EMAIL:
-				if(filter_var($value, FILTER_VALIDATE_EMAIL)) {
-					$targetUser->setEMailAddress($value);
-				} else {
-					throw new OCSException('', 102);
-				}
-				break;
-			case AccountManager::PROPERTY_PHONE:
-			case AccountManager::PROPERTY_ADDRESS:
-			case AccountManager::PROPERTY_WEBSITE:
-			case AccountManager::PROPERTY_TWITTER:
-				$userAccount = $this->accountManager->getUser($targetUser);
-				if ($userAccount[$key]['value'] !== $value) {
-					$userAccount[$key]['value'] = $value;
-					$this->accountManager->updateUser($targetUser, $userAccount);
-				}
-				break;
-			default:
-				throw new OCSException('', 103);
-		}
-		return new DataResponse();
-	}
-
-	/**
-	 * @PasswordConfirmationRequired
-	 * @NoAdminRequired
-	 *
-	 * @param string $userId
-	 * @return DataResponse
-	 * @throws OCSException
-	 * @throws OCSForbiddenException
-	 */
-	public function deleteUser($userId) {
-		$currentLoggedInUser = $this->userSession->getUser();
-
-		$targetUser = $this->userManager->get($userId);
-
-		if($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
-			throw new OCSException('', 101);
-		}
-
-		// If not permitted
-		$subAdminManager = $this->groupManager->getSubAdmin();
-		if(!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
-			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
-		}
-
-		// Go ahead with the delete
-		if($targetUser->delete()) {
-			return new DataResponse();
-		} else {
-			throw new OCSException('', 101);
-		}
-	}
-
-	/**
-	 * @PasswordConfirmationRequired
-	 * @NoAdminRequired
-	 *
-	 * @param string $userId
-	 * @return DataResponse
-	 * @throws OCSException
-	 * @throws OCSForbiddenException
-	 */
-	public function disableUser($userId) {
-		return $this->setEnabled($userId, false);
-	}
-
-	/**
-	 * @PasswordConfirmationRequired
-	 * @NoAdminRequired
-	 *
-	 * @param string $userId
-	 * @return DataResponse
-	 * @throws OCSException
-	 * @throws OCSForbiddenException
-	 */
-	public function enableUser($userId) {
-		return $this->setEnabled($userId, true);
-	}
-
-	/**
-	 * @param string $userId
-	 * @param bool $value
-	 * @return DataResponse
-	 * @throws OCSException
-	 * @throws OCSForbiddenException
-	 */
-	private function setEnabled($userId, $value) {
-		$currentLoggedInUser = $this->userSession->getUser();
-
-		$targetUser = $this->userManager->get($userId);
-		if($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
-			throw new OCSException('', 101);
-		}
-
-		// If not permitted
-		$subAdminManager = $this->groupManager->getSubAdmin();
-		if(!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
-			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
-		}
-
-		// enable/disable the user now
-		$targetUser->setEnabled($value);
-		return new DataResponse();
-	}
-
-	/**
-	 * @NoAdminRequired
-	 * @NoSubAdminRequired
-	 *
-	 * @param string $userId
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function getUsersGroups($userId) {
-		$loggedInUser = $this->userSession->getUser();
-
-		$targetUser = $this->userManager->get($userId);
-		if($targetUser === null) {
-			throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
-		}
-
-		if($targetUser->getUID() === $loggedInUser->getUID() || $this->groupManager->isAdmin($loggedInUser->getUID())) {
-			// Self lookup or admin lookup
-			return new DataResponse([
-				'groups' => $this->groupManager->getUserGroupIds($targetUser)
-			]);
-		} else {
-			$subAdminManager = $this->groupManager->getSubAdmin();
-
-			// Looking up someone else
-			if($subAdminManager->isUserAccessible($loggedInUser, $targetUser)) {
-				// Return the group that the method caller is subadmin of for the user in question
-				/** @var IGroup[] $getSubAdminsGroups */
-				$getSubAdminsGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
-				foreach ($getSubAdminsGroups as $key => $group) {
-					$getSubAdminsGroups[$key] = $group->getGID();
-				}
-				$groups = array_intersect(
-					$getSubAdminsGroups,
-					$this->groupManager->getUserGroupIds($targetUser)
-				);
-				return new DataResponse(['groups' => $groups]);
-			} else {
-				// Not permitted
-				throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
-			}
-		}
-
-	}
-
-	/**
-	 * @PasswordConfirmationRequired
-	 * @NoAdminRequired
-	 *
-	 * @param string $userId
-	 * @param string $groupid
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function addToGroup($userId, $groupid = '') {
-		if($groupid === '') {
-			throw new OCSException('', 101);
-		}
-
-		$group = $this->groupManager->get($groupid);
-		$targetUser = $this->userManager->get($userId);
-		if($group === null) {
-			throw new OCSException('', 102);
-		}
-		if($targetUser === null) {
-			throw new OCSException('', 103);
-		}
-
-		// If they're not an admin, check they are a subadmin of the group in question
-		$loggedInUser = $this->userSession->getUser();
-		$subAdminManager = $this->groupManager->getSubAdmin();
-		if (!$this->groupManager->isAdmin($loggedInUser->getUID()) && !$subAdminManager->isSubAdminOfGroup($loggedInUser, $group)) {
-			throw new OCSException('', 104);
-		}
-
-		// Add user to group
-		$group->addUser($targetUser);
-		return new DataResponse();
-	}
-
-	/**
-	 * @PasswordConfirmationRequired
-	 * @NoAdminRequired
-	 *
-	 * @param string $userId
-	 * @param string $groupid
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function removeFromGroup($userId, $groupid) {
-		$loggedInUser = $this->userSession->getUser();
-
-		if($groupid === null) {
-			throw new OCSException('', 101);
-		}
-
-		$group = $this->groupManager->get($groupid);
-		if($group === null) {
-			throw new OCSException('', 102);
-		}
-
-		$targetUser = $this->userManager->get($userId);
-		if($targetUser === null) {
-			throw new OCSException('', 103);
-		}
-
-		// If they're not an admin, check they are a subadmin of the group in question
-		$subAdminManager = $this->groupManager->getSubAdmin();
-		if (!$this->groupManager->isAdmin($loggedInUser->getUID()) && !$subAdminManager->isSubAdminOfGroup($loggedInUser, $group)) {
-			throw new OCSException('', 104);
-		}
-
-		// Check they aren't removing themselves from 'admin' or their 'subadmin; group
-		if ($userId === $loggedInUser->getUID()) {
-			if ($this->groupManager->isAdmin($loggedInUser->getUID())) {
-				if ($group->getGID() === 'admin') {
-					throw new OCSException('Cannot remove yourself from the admin group', 105);
-				}
-			} else {
-				// Not an admin, so the user must be a subadmin of this group, but that is not allowed.
-				throw new OCSException('Cannot remove yourself from this group as you are a SubAdmin', 105);
-			}
-
-		} else if (!$this->groupManager->isAdmin($loggedInUser->getUID())) {
-			/** @var IGroup[] $subAdminGroups */
-			$subAdminGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
-			$subAdminGroups = array_map(function (IGroup $subAdminGroup) {
-				return $subAdminGroup->getGID();
-			}, $subAdminGroups);
-			$userGroups = $this->groupManager->getUserGroupIds($targetUser);
-			$userSubAdminGroups = array_intersect($subAdminGroups, $userGroups);
-
-			if (count($userSubAdminGroups) <= 1) {
-				// Subadmin must not be able to remove a user from all their subadmin groups.
-				throw new OCSException('Cannot remove user from this group as this is the only remaining group you are a SubAdmin of', 105);
-			}
-		}
-
-		// Remove user from group
-		$group->removeUser($targetUser);
-		return new DataResponse();
-	}
-
-	/**
-	 * Creates a subadmin
-	 *
-	 * @PasswordConfirmationRequired
-	 *
-	 * @param string $userId
-	 * @param string $groupid
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function addSubAdmin($userId, $groupid) {
-		$group = $this->groupManager->get($groupid);
-		$user = $this->userManager->get($userId);
-
-		// Check if the user exists
-		if($user === null) {
-			throw new OCSException('User does not exist', 101);
-		}
-		// Check if group exists
-		if($group === null) {
-			throw new OCSException('Group:'.$groupid.' does not exist',  102);
-		}
-		// Check if trying to make subadmin of admin group
-		if(strtolower($groupid) === 'admin') {
-			throw new OCSException('Cannot create subadmins for admin group', 103);
-		}
-
-		$subAdminManager = $this->groupManager->getSubAdmin();
-
-		// We cannot be subadmin twice
-		if ($subAdminManager->isSubAdminofGroup($user, $group)) {
-			return new DataResponse();
-		}
-		// Go
-		if($subAdminManager->createSubAdmin($user, $group)) {
-			return new DataResponse();
-		} else {
-			throw new OCSException('Unknown error occurred', 103);
-		}
-	}
-
-	/**
-	 * Removes a subadmin from a group
-	 *
-	 * @PasswordConfirmationRequired
-	 *
-	 * @param string $userId
-	 * @param string $groupid
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function removeSubAdmin($userId, $groupid) {
-		$group = $this->groupManager->get($groupid);
-		$user = $this->userManager->get($userId);
-		$subAdminManager = $this->groupManager->getSubAdmin();
-
-		// Check if the user exists
-		if($user === null) {
-			throw new OCSException('User does not exist', 101);
-		}
-		// Check if the group exists
-		if($group === null) {
-			throw new OCSException('Group does not exist', 101);
-		}
-		// Check if they are a subadmin of this said group
-		if(!$subAdminManager->isSubAdminofGroup($user, $group)) {
-			throw new OCSException('User is not a subadmin of this group', 102);
-		}
-
-		// Go
-		if($subAdminManager->deleteSubAdmin($user, $group)) {
-			return new DataResponse();
-		} else {
-			throw new OCSException('Unknown error occurred', 103);
-		}
-	}
-
-	/**
-	 * Get the groups a user is a subadmin of
-	 *
-	 * @param string $userId
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function getUserSubAdminGroups($userId) {
-		$user = $this->userManager->get($userId);
-		// Check if the user exists
-		if($user === null) {
-			throw new OCSException('User does not exist', 101);
-		}
-
-		// Get the subadmin groups
-		$groups = $this->groupManager->getSubAdmin()->getSubAdminsGroups($user);
-		foreach ($groups as $key => $group) {
-			$groups[$key] = $group->getGID();
-		}
-
-		if(!$groups) {
-			throw new OCSException('Unknown error occurred', 102);
-		} else {
-			return new DataResponse($groups);
-		}
-	}
-
-	/**
-	 * @param string $userId
-	 * @return array
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	protected function fillStorageInfo($userId) {
-		try {
-			\OC_Util::tearDownFS();
-			\OC_Util::setupFS($userId);
-			$storage = OC_Helper::getStorageInfo('/');
-			$data = [
-				'free' => $storage['free'],
-				'used' => $storage['used'],
-				'total' => $storage['total'],
-				'relative' => $storage['relative'],
-				'quota' => $storage['quota'],
-			];
-		} catch (NotFoundException $ex) {
-			$data = [];
-		}
-		return $data;
-	}
-
-	/**
-	 * @NoAdminRequired
-	 * @PasswordConfirmationRequired
-	 *
-	 * resend welcome message
-	 *
-	 * @param string $userId
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function resendWelcomeMessage($userId) {
-		$currentLoggedInUser = $this->userSession->getUser();
-
-		$targetUser = $this->userManager->get($userId);
-		if($targetUser === null) {
-			throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
-		}
-
-		// Check if admin / subadmin
-		$subAdminManager = $this->groupManager->getSubAdmin();
-		if(!$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
-			&& !$this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
-			// No rights
-			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
-		}
-
-		$email = $targetUser->getEMailAddress();
-		if ($email === '' || $email === null) {
-			throw new OCSException('Email address not available', 101);
-		}
-		$username = $targetUser->getUID();
-		$lang = $this->config->getUserValue($username, 'core', 'lang', 'en');
-		if (!$this->l10nFactory->languageExists('settings', $lang)) {
-			$lang = 'en';
-		}
-
-		$l10n = $this->l10nFactory->get('settings', $lang);
-
-		try {
-			$this->newUserMailHelper->setL10N($l10n);
-			$emailTemplate = $this->newUserMailHelper->generateTemplate($targetUser, false);
-			$this->newUserMailHelper->sendMail($targetUser, $emailTemplate);
-		} catch(\Exception $e) {
-			$this->logger->error("Can't send new user mail to $email: " . $e->getMessage(), array('app' => 'settings'));
-			throw new OCSException('Sending email failed', 102);
-		}
-
-		return new DataResponse();
-	}
+    /** @var IUserManager */
+    private $userManager;
+    /** @var IConfig */
+    private $config;
+    /** @var IGroupManager|\OC\Group\Manager */ // FIXME Requires a method that is not on the interface
+    private $groupManager;
+    /** @var IUserSession */
+    private $userSession;
+    /** @var AccountManager */
+    private $accountManager;
+    /** @var ILogger */
+    private $logger;
+    /** @var string */
+    private $fromMailAddress;
+    /** @var IURLGenerator */
+    private $urlGenerator;
+    /** @var IMailer */
+    private $mailer;
+    /** @var Defaults */
+    private $defaults;
+    /** @var IFactory */
+    private $l10nFactory;
+    /** @var NewUserMailHelper */
+    private $newUserMailHelper;
+
+    /**
+     * @param string $appName
+     * @param IRequest $request
+     * @param IUserManager $userManager
+     * @param IConfig $config
+     * @param IGroupManager $groupManager
+     * @param IUserSession $userSession
+     * @param AccountManager $accountManager
+     * @param ILogger $logger
+     * @param string $fromMailAddress
+     * @param IURLGenerator $urlGenerator
+     * @param IMailer $mailer
+     * @param Defaults $defaults
+     * @param IFactory $l10nFactory
+     * @param NewUserMailHelper $newUserMailHelper
+     */
+    public function __construct($appName,
+                                IRequest $request,
+                                IUserManager $userManager,
+                                IConfig $config,
+                                IGroupManager $groupManager,
+                                IUserSession $userSession,
+                                AccountManager $accountManager,
+                                ILogger $logger,
+                                $fromMailAddress,
+                                IURLGenerator $urlGenerator,
+                                IMailer $mailer,
+                                Defaults $defaults,
+                                IFactory $l10nFactory,
+                                NewUserMailHelper $newUserMailHelper) {
+        parent::__construct($appName, $request);
+
+        $this->userManager = $userManager;
+        $this->config = $config;
+        $this->groupManager = $groupManager;
+        $this->userSession = $userSession;
+        $this->accountManager = $accountManager;
+        $this->logger = $logger;
+        $this->fromMailAddress = $fromMailAddress;
+        $this->urlGenerator = $urlGenerator;
+        $this->mailer = $mailer;
+        $this->defaults = $defaults;
+        $this->l10nFactory = $l10nFactory;
+        $this->newUserMailHelper = $newUserMailHelper;
+    }
+
+    /**
+     * @NoAdminRequired
+     *
+     * returns a list of users
+     *
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return DataResponse
+     */
+    public function getUsers($search = '', $limit = null, $offset = null) {
+        $user = $this->userSession->getUser();
+        $users = [];
+
+        // Admin? Or SubAdmin?
+        $uid = $user->getUID();
+        $subAdminManager = $this->groupManager->getSubAdmin();
+        if($this->groupManager->isAdmin($uid)){
+            $users = $this->userManager->search($search, $limit, $offset);
+        } else if ($subAdminManager->isSubAdmin($user)) {
+            $subAdminOfGroups = $subAdminManager->getSubAdminsGroups($user);
+            foreach ($subAdminOfGroups as $key => $group) {
+                $subAdminOfGroups[$key] = $group->getGID();
+            }
+
+            if($offset === null) {
+                $offset = 0;
+            }
+
+            $users = [];
+            foreach ($subAdminOfGroups as $group) {
+                $users = array_merge($users, $this->groupManager->displayNamesInGroup($group, $search));
+            }
+
+            $users = array_slice($users, $offset, $limit);
+        }
+
+        $users = array_keys($users);
+
+        return new DataResponse([
+            'users' => $users
+        ]);
+    }
+
+    /**
+     * @PasswordConfirmationRequired
+     * @NoAdminRequired
+     *
+     * @param string $userid
+     * @param string $password
+     * @param array $groups
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function addUser($userid, $password, $groups = null) {
+        $user = $this->userSession->getUser();
+        $isAdmin = $this->groupManager->isAdmin($user->getUID());
+        $subAdminManager = $this->groupManager->getSubAdmin();
+
+        if($this->userManager->userExists($userid)) {
+            $this->logger->error('Failed addUser attempt: User already exists.', ['app' => 'ocs_api']);
+            throw new OCSException('User already exists', 102);
+        }
+
+        if(is_array($groups)) {
+            foreach ($groups as $group) {
+                if(!$this->groupManager->groupExists($group)) {
+                    throw new OCSException('group '.$group.' does not exist', 104);
+                }
+                if(!$isAdmin && !$subAdminManager->isSubAdminofGroup($user, $this->groupManager->get($group))) {
+                    throw new OCSException('insufficient privileges for group '. $group, 105);
+                }
+            }
+        } else {
+            if(!$isAdmin) {
+                throw new OCSException('no group specified (required for subadmins)', 106);
+            }
+        }
+
+        try {
+            $newUser = $this->userManager->createUser($userid, $password);
+            $this->logger->info('Successful addUser call with userid: '.$userid, ['app' => 'ocs_api']);
+
+            if (is_array($groups)) {
+                foreach ($groups as $group) {
+                    $this->groupManager->get($group)->addUser($newUser);
+                    $this->logger->info('Added userid '.$userid.' to group '.$group, ['app' => 'ocs_api']);
+                }
+            }
+            return new DataResponse();
+        } catch (\Exception $e) {
+            $this->logger->error('Failed addUser attempt with exception: '.$e->getMessage(), ['app' => 'ocs_api']);
+            throw new OCSException('Bad request', 101);
+        }
+    }
+
+    /**
+     * @NoAdminRequired
+     * @NoSubAdminRequired
+     *
+     * gets user info
+     *
+     * @param string $userId
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function getUser($userId) {
+        $data = $this->getUserData($userId);
+        return new DataResponse($data);
+    }
+
+    /**
+     * @NoAdminRequired
+     * @NoSubAdminRequired
+     *
+     * gets user info from the currently logged in user
+     *
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function getCurrentUser() {
+        $user = $this->userSession->getUser();
+        if ($user) {
+            $data =  $this->getUserData($user->getUID());
+            // rename "displayname" to "display-name" only for this call to keep
+            // the API stable.
+            $data['display-name'] = $data['displayname'];
+            unset($data['displayname']);
+            return new DataResponse($data);
+
+        }
+
+        throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
+    }
+
+    /**
+     * creates a array with all user data
+     *
+     * @param $userId
+     * @return array
+     * @throws OCSException
+     */
+    protected function getUserData($userId) {
+        $currentLoggedInUser = $this->userSession->getUser();
+
+        $data = [];
+
+        // Check if the target user exists
+        $targetUserObject = $this->userManager->get($userId);
+        if($targetUserObject === null) {
+            throw new OCSException('The requested user could not be found', \OCP\API::RESPOND_NOT_FOUND);
+        }
+
+        // Admin? Or SubAdmin?
+        if($this->groupManager->isAdmin($currentLoggedInUser->getUID())
+            || $this->groupManager->getSubAdmin()->isUserAccessible($currentLoggedInUser, $targetUserObject)) {
+            $data['enabled'] = $this->config->getUserValue($userId, 'core', 'enabled', 'true');
+        } else {
+            // Check they are looking up themselves
+            if($currentLoggedInUser->getUID() !== $userId) {
+                throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
+            }
+        }
+
+        $userAccount = $this->accountManager->getUser($targetUserObject);
+        $groups = $this->groupManager->getUserGroups($targetUserObject);
+        $gids = [];
+        foreach ($groups as $group) {
+            $gids[] = $group->getDisplayName();
+        }
+
+        // Find the data
+        $data['id'] = $targetUserObject->getUID();
+        $data['quota'] = $this->fillStorageInfo($userId);
+        $data[AccountManager::PROPERTY_EMAIL] = $targetUserObject->getEMailAddress();
+        $data[AccountManager::PROPERTY_DISPLAYNAME] = $targetUserObject->getDisplayName();
+        $data[AccountManager::PROPERTY_PHONE] = $userAccount[AccountManager::PROPERTY_PHONE]['value'];
+        $data[AccountManager::PROPERTY_ADDRESS] = $userAccount[AccountManager::PROPERTY_ADDRESS]['value'];
+        $data[AccountManager::PROPERTY_WEBSITE] = $userAccount[AccountManager::PROPERTY_WEBSITE]['value'];
+        $data[AccountManager::PROPERTY_TWITTER] = $userAccount[AccountManager::PROPERTY_TWITTER]['value'];
+        $data['groups'] = $gids;
+
+        return $data;
+    }
+
+    /**
+     * @NoAdminRequired
+     * @NoSubAdminRequired
+     * @PasswordConfirmationRequired
+     *
+     * edit users
+     *
+     * @param string $userId
+     * @param string $key
+     * @param string $value
+     * @return DataResponse
+     * @throws OCSException
+     * @throws OCSForbiddenException
+     */
+    public function editUser($userId, $key, $value) {
+        $currentLoggedInUser = $this->userSession->getUser();
+
+        $targetUser = $this->userManager->get($userId);
+        if($targetUser === null) {
+            throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
+        }
+
+        $permittedFields = [];
+        if($userId === $currentLoggedInUser->getUID()) {
+            // Editing self (display, email)
+            $permittedFields[] = 'display';
+            $permittedFields[] = AccountManager::PROPERTY_DISPLAYNAME;
+            $permittedFields[] = AccountManager::PROPERTY_EMAIL;
+            $permittedFields[] = 'password';
+            $permittedFields[] = AccountManager::PROPERTY_PHONE;
+            $permittedFields[] = AccountManager::PROPERTY_ADDRESS;
+            $permittedFields[] = AccountManager::PROPERTY_WEBSITE;
+            $permittedFields[] = AccountManager::PROPERTY_TWITTER;
+            // If admin they can edit their own quota
+            if($this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
+                $permittedFields[] = 'quota';
+            }
+        } else {
+            // Check if admin / subadmin
+            $subAdminManager = $this->groupManager->getSubAdmin();
+            if($subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
+            || $this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
+                // They have permissions over the user
+                $permittedFields[] = 'display';
+                $permittedFields[] = AccountManager::PROPERTY_DISPLAYNAME;
+                $permittedFields[] = AccountManager::PROPERTY_EMAIL;
+                $permittedFields[] = 'password';
+                $permittedFields[] = AccountManager::PROPERTY_PHONE;
+                $permittedFields[] = AccountManager::PROPERTY_ADDRESS;
+                $permittedFields[] = AccountManager::PROPERTY_WEBSITE;
+                $permittedFields[] = AccountManager::PROPERTY_TWITTER;
+                $permittedFields[] = 'quota';
+            } else {
+                // No rights
+                throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
+            }
+        }
+        // Check if permitted to edit this field
+        if(!in_array($key, $permittedFields)) {
+            throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
+        }
+        // Process the edit
+        switch($key) {
+            case 'display':
+            case AccountManager::PROPERTY_DISPLAYNAME:
+                $targetUser->setDisplayName($value);
+                break;
+            case 'quota':
+                $quota = $value;
+                if($quota !== 'none' && $quota !== 'default') {
+                    if (is_numeric($quota)) {
+                        $quota = (float) $quota;
+                    } else {
+                        $quota = \OCP\Util::computerFileSize($quota);
+                    }
+                    if ($quota === false) {
+                        throw new OCSException('Invalid quota value '.$value, 103);
+                    }
+                    if($quota === 0) {
+                        $quota = 'default';
+                    }else if($quota === -1) {
+                        $quota = 'none';
+                    } else {
+                        $quota = \OCP\Util::humanFileSize($quota);
+                    }
+                }
+                $targetUser->setQuota($quota);
+                break;
+            case 'password':
+                $targetUser->setPassword($value);
+                break;
+            case AccountManager::PROPERTY_EMAIL:
+                if(filter_var($value, FILTER_VALIDATE_EMAIL)) {
+                    $targetUser->setEMailAddress($value);
+                } else {
+                    throw new OCSException('', 102);
+                }
+                break;
+            case AccountManager::PROPERTY_PHONE:
+            case AccountManager::PROPERTY_ADDRESS:
+            case AccountManager::PROPERTY_WEBSITE:
+            case AccountManager::PROPERTY_TWITTER:
+                $userAccount = $this->accountManager->getUser($targetUser);
+                if ($userAccount[$key]['value'] !== $value) {
+                    $userAccount[$key]['value'] = $value;
+                    $this->accountManager->updateUser($targetUser, $userAccount);
+                }
+                break;
+            default:
+                throw new OCSException('', 103);
+        }
+        return new DataResponse();
+    }
+
+    /**
+     * @PasswordConfirmationRequired
+     * @NoAdminRequired
+     *
+     * @param string $userId
+     * @return DataResponse
+     * @throws OCSException
+     * @throws OCSForbiddenException
+     */
+    public function deleteUser($userId) {
+        $currentLoggedInUser = $this->userSession->getUser();
+
+        $targetUser = $this->userManager->get($userId);
+
+        if($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
+            throw new OCSException('', 101);
+        }
+
+        // If not permitted
+        $subAdminManager = $this->groupManager->getSubAdmin();
+        if(!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
+            throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
+        }
+
+        // Go ahead with the delete
+        if($targetUser->delete()) {
+            return new DataResponse();
+        } else {
+            throw new OCSException('', 101);
+        }
+    }
+
+    /**
+     * @PasswordConfirmationRequired
+     * @NoAdminRequired
+     *
+     * @param string $userId
+     * @return DataResponse
+     * @throws OCSException
+     * @throws OCSForbiddenException
+     */
+    public function disableUser($userId) {
+        return $this->setEnabled($userId, false);
+    }
+
+    /**
+     * @PasswordConfirmationRequired
+     * @NoAdminRequired
+     *
+     * @param string $userId
+     * @return DataResponse
+     * @throws OCSException
+     * @throws OCSForbiddenException
+     */
+    public function enableUser($userId) {
+        return $this->setEnabled($userId, true);
+    }
+
+    /**
+     * @param string $userId
+     * @param bool $value
+     * @return DataResponse
+     * @throws OCSException
+     * @throws OCSForbiddenException
+     */
+    private function setEnabled($userId, $value) {
+        $currentLoggedInUser = $this->userSession->getUser();
+
+        $targetUser = $this->userManager->get($userId);
+        if($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
+            throw new OCSException('', 101);
+        }
+
+        // If not permitted
+        $subAdminManager = $this->groupManager->getSubAdmin();
+        if(!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
+            throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
+        }
+
+        // enable/disable the user now
+        $targetUser->setEnabled($value);
+        return new DataResponse();
+    }
+
+    /**
+     * @NoAdminRequired
+     * @NoSubAdminRequired
+     *
+     * @param string $userId
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function getUsersGroups($userId) {
+        $loggedInUser = $this->userSession->getUser();
+
+        $targetUser = $this->userManager->get($userId);
+        if($targetUser === null) {
+            throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
+        }
+
+        if($targetUser->getUID() === $loggedInUser->getUID() || $this->groupManager->isAdmin($loggedInUser->getUID())) {
+            // Self lookup or admin lookup
+            return new DataResponse([
+                'groups' => $this->groupManager->getUserGroupIds($targetUser)
+            ]);
+        } else {
+            $subAdminManager = $this->groupManager->getSubAdmin();
+
+            // Looking up someone else
+            if($subAdminManager->isUserAccessible($loggedInUser, $targetUser)) {
+                // Return the group that the method caller is subadmin of for the user in question
+                /** @var IGroup[] $getSubAdminsGroups */
+                $getSubAdminsGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
+                foreach ($getSubAdminsGroups as $key => $group) {
+                    $getSubAdminsGroups[$key] = $group->getGID();
+                }
+                $groups = array_intersect(
+                    $getSubAdminsGroups,
+                    $this->groupManager->getUserGroupIds($targetUser)
+                );
+                return new DataResponse(['groups' => $groups]);
+            } else {
+                // Not permitted
+                throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
+            }
+        }
+
+    }
+
+    /**
+     * @PasswordConfirmationRequired
+     * @NoAdminRequired
+     *
+     * @param string $userId
+     * @param string $groupid
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function addToGroup($userId, $groupid = '') {
+        if($groupid === '') {
+            throw new OCSException('', 101);
+        }
+
+        $group = $this->groupManager->get($groupid);
+        $targetUser = $this->userManager->get($userId);
+        if($group === null) {
+            throw new OCSException('', 102);
+        }
+        if($targetUser === null) {
+            throw new OCSException('', 103);
+        }
+
+        // If they're not an admin, check they are a subadmin of the group in question
+        $loggedInUser = $this->userSession->getUser();
+        $subAdminManager = $this->groupManager->getSubAdmin();
+        if (!$this->groupManager->isAdmin($loggedInUser->getUID()) && !$subAdminManager->isSubAdminOfGroup($loggedInUser, $group)) {
+            throw new OCSException('', 104);
+        }
+
+        // Add user to group
+        $group->addUser($targetUser);
+        return new DataResponse();
+    }
+
+    /**
+     * @PasswordConfirmationRequired
+     * @NoAdminRequired
+     *
+     * @param string $userId
+     * @param string $groupid
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function removeFromGroup($userId, $groupid) {
+        $loggedInUser = $this->userSession->getUser();
+
+        if($groupid === null) {
+            throw new OCSException('', 101);
+        }
+
+        $group = $this->groupManager->get($groupid);
+        if($group === null) {
+            throw new OCSException('', 102);
+        }
+
+        $targetUser = $this->userManager->get($userId);
+        if($targetUser === null) {
+            throw new OCSException('', 103);
+        }
+
+        // If they're not an admin, check they are a subadmin of the group in question
+        $subAdminManager = $this->groupManager->getSubAdmin();
+        if (!$this->groupManager->isAdmin($loggedInUser->getUID()) && !$subAdminManager->isSubAdminOfGroup($loggedInUser, $group)) {
+            throw new OCSException('', 104);
+        }
+
+        // Check they aren't removing themselves from 'admin' or their 'subadmin; group
+        if ($userId === $loggedInUser->getUID()) {
+            if ($this->groupManager->isAdmin($loggedInUser->getUID())) {
+                if ($group->getGID() === 'admin') {
+                    throw new OCSException('Cannot remove yourself from the admin group', 105);
+                }
+            } else {
+                // Not an admin, so the user must be a subadmin of this group, but that is not allowed.
+                throw new OCSException('Cannot remove yourself from this group as you are a SubAdmin', 105);
+            }
+
+        } else if (!$this->groupManager->isAdmin($loggedInUser->getUID())) {
+            /** @var IGroup[] $subAdminGroups */
+            $subAdminGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
+            $subAdminGroups = array_map(function (IGroup $subAdminGroup) {
+                return $subAdminGroup->getGID();
+            }, $subAdminGroups);
+            $userGroups = $this->groupManager->getUserGroupIds($targetUser);
+            $userSubAdminGroups = array_intersect($subAdminGroups, $userGroups);
+
+            if (count($userSubAdminGroups) <= 1) {
+                // Subadmin must not be able to remove a user from all their subadmin groups.
+                throw new OCSException('Cannot remove user from this group as this is the only remaining group you are a SubAdmin of', 105);
+            }
+        }
+
+        // Remove user from group
+        $group->removeUser($targetUser);
+        return new DataResponse();
+    }
+
+    /**
+     * Creates a subadmin
+     *
+     * @PasswordConfirmationRequired
+     *
+     * @param string $userId
+     * @param string $groupid
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function addSubAdmin($userId, $groupid) {
+        $group = $this->groupManager->get($groupid);
+        $user = $this->userManager->get($userId);
+
+        // Check if the user exists
+        if($user === null) {
+            throw new OCSException('User does not exist', 101);
+        }
+        // Check if group exists
+        if($group === null) {
+            throw new OCSException('Group:'.$groupid.' does not exist',  102);
+        }
+        // Check if trying to make subadmin of admin group
+        if(strtolower($groupid) === 'admin') {
+            throw new OCSException('Cannot create subadmins for admin group', 103);
+        }
+
+        $subAdminManager = $this->groupManager->getSubAdmin();
+
+        // We cannot be subadmin twice
+        if ($subAdminManager->isSubAdminofGroup($user, $group)) {
+            return new DataResponse();
+        }
+        // Go
+        if($subAdminManager->createSubAdmin($user, $group)) {
+            return new DataResponse();
+        } else {
+            throw new OCSException('Unknown error occurred', 103);
+        }
+    }
+
+    /**
+     * Removes a subadmin from a group
+     *
+     * @PasswordConfirmationRequired
+     *
+     * @param string $userId
+     * @param string $groupid
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function removeSubAdmin($userId, $groupid) {
+        $group = $this->groupManager->get($groupid);
+        $user = $this->userManager->get($userId);
+        $subAdminManager = $this->groupManager->getSubAdmin();
+
+        // Check if the user exists
+        if($user === null) {
+            throw new OCSException('User does not exist', 101);
+        }
+        // Check if the group exists
+        if($group === null) {
+            throw new OCSException('Group does not exist', 101);
+        }
+        // Check if they are a subadmin of this said group
+        if(!$subAdminManager->isSubAdminofGroup($user, $group)) {
+            throw new OCSException('User is not a subadmin of this group', 102);
+        }
+
+        // Go
+        if($subAdminManager->deleteSubAdmin($user, $group)) {
+            return new DataResponse();
+        } else {
+            throw new OCSException('Unknown error occurred', 103);
+        }
+    }
+
+    /**
+     * Get the groups a user is a subadmin of
+     *
+     * @param string $userId
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function getUserSubAdminGroups($userId) {
+        $user = $this->userManager->get($userId);
+        // Check if the user exists
+        if($user === null) {
+            throw new OCSException('User does not exist', 101);
+        }
+
+        // Get the subadmin groups
+        $groups = $this->groupManager->getSubAdmin()->getSubAdminsGroups($user);
+        foreach ($groups as $key => $group) {
+            $groups[$key] = $group->getGID();
+        }
+
+        if(!$groups) {
+            throw new OCSException('Unknown error occurred', 102);
+        } else {
+            return new DataResponse($groups);
+        }
+    }
+
+    /**
+     * @param string $userId
+     * @return array
+     * @throws \OCP\Files\NotFoundException
+     */
+    protected function fillStorageInfo($userId) {
+        try {
+            \OC_Util::tearDownFS();
+            \OC_Util::setupFS($userId);
+            $storage = OC_Helper::getStorageInfo('/');
+            $data = [
+                'free' => $storage['free'],
+                'used' => $storage['used'],
+                'total' => $storage['total'],
+                'relative' => $storage['relative'],
+                'quota' => $storage['quota'],
+            ];
+        } catch (NotFoundException $ex) {
+            $data = [];
+        }
+        return $data;
+    }
+
+    /**
+     * @NoAdminRequired
+     * @PasswordConfirmationRequired
+     *
+     * resend welcome message
+     *
+     * @param string $userId
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function resendWelcomeMessage($userId) {
+        $currentLoggedInUser = $this->userSession->getUser();
+
+        $targetUser = $this->userManager->get($userId);
+        if($targetUser === null) {
+            throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
+        }
+
+        // Check if admin / subadmin
+        $subAdminManager = $this->groupManager->getSubAdmin();
+        if(!$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
+            && !$this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
+            // No rights
+            throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
+        }
+
+        $email = $targetUser->getEMailAddress();
+        if ($email === '' || $email === null) {
+            throw new OCSException('Email address not available', 101);
+        }
+        $username = $targetUser->getUID();
+        $lang = $this->config->getUserValue($username, 'core', 'lang', 'en');
+        if (!$this->l10nFactory->languageExists('settings', $lang)) {
+            $lang = 'en';
+        }
+
+        $l10n = $this->l10nFactory->get('settings', $lang);
+
+        try {
+            $this->newUserMailHelper->setL10N($l10n);
+            $emailTemplate = $this->newUserMailHelper->generateTemplate($targetUser, false);
+            $this->newUserMailHelper->sendMail($targetUser, $emailTemplate);
+        } catch(\Exception $e) {
+            $this->logger->error("Can't send new user mail to $email: " . $e->getMessage(), array('app' => 'settings'));
+            throw new OCSException('Sending email failed', 102);
+        }
+
+        return new DataResponse();
+    }
 }

Spacing +52 added lines, -52 removed lines

@@ -139,7 +139,7 @@ 
 		// Admin? Or SubAdmin?
 		$uid = $user->getUID();
 		$subAdminManager = $this->groupManager->getSubAdmin();
-		if($this->groupManager->isAdmin($uid)){
+		if ($this->groupManager->isAdmin($uid)) {
 			$users = $this->userManager->search($search, $limit, $offset);
 		} else if ($subAdminManager->isSubAdmin($user)) {
 			$subAdminOfGroups = $subAdminManager->getSubAdminsGroups($user);
@@ -147,7 +147,7 @@ 
 				$subAdminOfGroups[$key] = $group->getGID();
 			}
 
-			if($offset === null) {
+			if ($offset === null) {
 				$offset = 0;
 			}
 
@@ -181,22 +181,22 @@ 
 		$isAdmin = $this->groupManager->isAdmin($user->getUID());
 		$subAdminManager = $this->groupManager->getSubAdmin();
 
-		if($this->userManager->userExists($userid)) {
+		if ($this->userManager->userExists($userid)) {
 			$this->logger->error('Failed addUser attempt: User already exists.', ['app' => 'ocs_api']);
 			throw new OCSException('User already exists', 102);
 		}
 
-		if(is_array($groups)) {
+		if (is_array($groups)) {
 			foreach ($groups as $group) {
-				if(!$this->groupManager->groupExists($group)) {
+				if (!$this->groupManager->groupExists($group)) {
 					throw new OCSException('group '.$group.' does not exist', 104);
 				}
-				if(!$isAdmin && !$subAdminManager->isSubAdminofGroup($user, $this->groupManager->get($group))) {
-					throw new OCSException('insufficient privileges for group '. $group, 105);
+				if (!$isAdmin && !$subAdminManager->isSubAdminofGroup($user, $this->groupManager->get($group))) {
+					throw new OCSException('insufficient privileges for group '.$group, 105);
 				}
 			}
 		} else {
-			if(!$isAdmin) {
+			if (!$isAdmin) {
 				throw new OCSException('no group specified (required for subadmins)', 106);
 			}
 		}
@@ -245,7 +245,7 @@ 
 	public function getCurrentUser() {
 		$user = $this->userSession->getUser();
 		if ($user) {
-			$data =  $this->getUserData($user->getUID());
+			$data = $this->getUserData($user->getUID());
 			// rename "displayname" to "display-name" only for this call to keep
 			// the API stable.
 			$data['display-name'] = $data['displayname'];
@@ -271,17 +271,17 @@ 
 
 		// Check if the target user exists
 		$targetUserObject = $this->userManager->get($userId);
-		if($targetUserObject === null) {
+		if ($targetUserObject === null) {
 			throw new OCSException('The requested user could not be found', \OCP\API::RESPOND_NOT_FOUND);
 		}
 
 		// Admin? Or SubAdmin?
-		if($this->groupManager->isAdmin($currentLoggedInUser->getUID())
+		if ($this->groupManager->isAdmin($currentLoggedInUser->getUID())
 			|| $this->groupManager->getSubAdmin()->isUserAccessible($currentLoggedInUser, $targetUserObject)) {
 			$data['enabled'] = $this->config->getUserValue($userId, 'core', 'enabled', 'true');
 		} else {
 			// Check they are looking up themselves
-			if($currentLoggedInUser->getUID() !== $userId) {
+			if ($currentLoggedInUser->getUID() !== $userId) {
 				throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
 			}
 		}
@@ -325,12 +325,12 @@ 
 		$currentLoggedInUser = $this->userSession->getUser();
 
 		$targetUser = $this->userManager->get($userId);
-		if($targetUser === null) {
+		if ($targetUser === null) {
 			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
 		}
 
 		$permittedFields = [];
-		if($userId === $currentLoggedInUser->getUID()) {
+		if ($userId === $currentLoggedInUser->getUID()) {
 			// Editing self (display, email)
 			$permittedFields[] = 'display';
 			$permittedFields[] = AccountManager::PROPERTY_DISPLAYNAME;
@@ -341,13 +341,13 @@ 
 			$permittedFields[] = AccountManager::PROPERTY_WEBSITE;
 			$permittedFields[] = AccountManager::PROPERTY_TWITTER;
 			// If admin they can edit their own quota
-			if($this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
+			if ($this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
 				$permittedFields[] = 'quota';
 			}
 		} else {
 			// Check if admin / subadmin
 			$subAdminManager = $this->groupManager->getSubAdmin();
-			if($subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
+			if ($subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
 			|| $this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
 				// They have permissions over the user
 				$permittedFields[] = 'display';
@@ -365,18 +365,18 @@ 
 			}
 		}
 		// Check if permitted to edit this field
-		if(!in_array($key, $permittedFields)) {
+		if (!in_array($key, $permittedFields)) {
 			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
 		}
 		// Process the edit
-		switch($key) {
+		switch ($key) {
 			case 'display':
 			case AccountManager::PROPERTY_DISPLAYNAME:
 				$targetUser->setDisplayName($value);
 				break;
 			case 'quota':
 				$quota = $value;
-				if($quota !== 'none' && $quota !== 'default') {
+				if ($quota !== 'none' && $quota !== 'default') {
 					if (is_numeric($quota)) {
 						$quota = (float) $quota;
 					} else {
@@ -385,9 +385,9 @@ 
 					if ($quota === false) {
 						throw new OCSException('Invalid quota value '.$value, 103);
 					}
-					if($quota === 0) {
+					if ($quota === 0) {
 						$quota = 'default';
-					}else if($quota === -1) {
+					} else if ($quota === -1) {
 						$quota = 'none';
 					} else {
 						$quota = \OCP\Util::humanFileSize($quota);
@@ -399,7 +399,7 @@ 
 				$targetUser->setPassword($value);
 				break;
 			case AccountManager::PROPERTY_EMAIL:
-				if(filter_var($value, FILTER_VALIDATE_EMAIL)) {
+				if (filter_var($value, FILTER_VALIDATE_EMAIL)) {
 					$targetUser->setEMailAddress($value);
 				} else {
 					throw new OCSException('', 102);
@@ -435,18 +435,18 @@ 
 
 		$targetUser = $this->userManager->get($userId);
 
-		if($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
+		if ($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
 			throw new OCSException('', 101);
 		}
 
 		// If not permitted
 		$subAdminManager = $this->groupManager->getSubAdmin();
-		if(!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
+		if (!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
 			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
 		}
 
 		// Go ahead with the delete
-		if($targetUser->delete()) {
+		if ($targetUser->delete()) {
 			return new DataResponse();
 		} else {
 			throw new OCSException('', 101);
@@ -490,13 +490,13 @@ 
 		$currentLoggedInUser = $this->userSession->getUser();
 
 		$targetUser = $this->userManager->get($userId);
-		if($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
+		if ($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
 			throw new OCSException('', 101);
 		}
 
 		// If not permitted
 		$subAdminManager = $this->groupManager->getSubAdmin();
-		if(!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
+		if (!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
 			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
 		}
 
@@ -517,11 +517,11 @@ 
 		$loggedInUser = $this->userSession->getUser();
 
 		$targetUser = $this->userManager->get($userId);
-		if($targetUser === null) {
+		if ($targetUser === null) {
 			throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
 		}
 
-		if($targetUser->getUID() === $loggedInUser->getUID() || $this->groupManager->isAdmin($loggedInUser->getUID())) {
+		if ($targetUser->getUID() === $loggedInUser->getUID() || $this->groupManager->isAdmin($loggedInUser->getUID())) {
 			// Self lookup or admin lookup
 			return new DataResponse([
 				'groups' => $this->groupManager->getUserGroupIds($targetUser)
@@ -530,7 +530,7 @@ 
 			$subAdminManager = $this->groupManager->getSubAdmin();
 
 			// Looking up someone else
-			if($subAdminManager->isUserAccessible($loggedInUser, $targetUser)) {
+			if ($subAdminManager->isUserAccessible($loggedInUser, $targetUser)) {
 				// Return the group that the method caller is subadmin of for the user in question
 				/** @var IGroup[] $getSubAdminsGroups */
 				$getSubAdminsGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
@@ -560,16 +560,16 @@ 
 	 * @throws OCSException
 	 */
 	public function addToGroup($userId, $groupid = '') {
-		if($groupid === '') {
+		if ($groupid === '') {
 			throw new OCSException('', 101);
 		}
 
 		$group = $this->groupManager->get($groupid);
 		$targetUser = $this->userManager->get($userId);
-		if($group === null) {
+		if ($group === null) {
 			throw new OCSException('', 102);
 		}
-		if($targetUser === null) {
+		if ($targetUser === null) {
 			throw new OCSException('', 103);
 		}
 
@@ -597,17 +597,17 @@ 
 	public function removeFromGroup($userId, $groupid) {
 		$loggedInUser = $this->userSession->getUser();
 
-		if($groupid === null) {
+		if ($groupid === null) {
 			throw new OCSException('', 101);
 		}
 
 		$group = $this->groupManager->get($groupid);
-		if($group === null) {
+		if ($group === null) {
 			throw new OCSException('', 102);
 		}
 
 		$targetUser = $this->userManager->get($userId);
-		if($targetUser === null) {
+		if ($targetUser === null) {
 			throw new OCSException('', 103);
 		}
 
@@ -631,7 +631,7 @@ 
 		} else if (!$this->groupManager->isAdmin($loggedInUser->getUID())) {
 			/** @var IGroup[] $subAdminGroups */
 			$subAdminGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
-			$subAdminGroups = array_map(function (IGroup $subAdminGroup) {
+			$subAdminGroups = array_map(function(IGroup $subAdminGroup) {
 				return $subAdminGroup->getGID();
 			}, $subAdminGroups);
 			$userGroups = $this->groupManager->getUserGroupIds($targetUser);
@@ -663,15 +663,15 @@ 
 		$user = $this->userManager->get($userId);
 
 		// Check if the user exists
-		if($user === null) {
+		if ($user === null) {
 			throw new OCSException('User does not exist', 101);
 		}
 		// Check if group exists
-		if($group === null) {
-			throw new OCSException('Group:'.$groupid.' does not exist',  102);
+		if ($group === null) {
+			throw new OCSException('Group:'.$groupid.' does not exist', 102);
 		}
 		// Check if trying to make subadmin of admin group
-		if(strtolower($groupid) === 'admin') {
+		if (strtolower($groupid) === 'admin') {
 			throw new OCSException('Cannot create subadmins for admin group', 103);
 		}
 
@@ -682,7 +682,7 @@ 
 			return new DataResponse();
 		}
 		// Go
-		if($subAdminManager->createSubAdmin($user, $group)) {
+		if ($subAdminManager->createSubAdmin($user, $group)) {
 			return new DataResponse();
 		} else {
 			throw new OCSException('Unknown error occurred', 103);
@@ -705,20 +705,20 @@ 
 		$subAdminManager = $this->groupManager->getSubAdmin();
 
 		// Check if the user exists
-		if($user === null) {
+		if ($user === null) {
 			throw new OCSException('User does not exist', 101);
 		}
 		// Check if the group exists
-		if($group === null) {
+		if ($group === null) {
 			throw new OCSException('Group does not exist', 101);
 		}
 		// Check if they are a subadmin of this said group
-		if(!$subAdminManager->isSubAdminofGroup($user, $group)) {
+		if (!$subAdminManager->isSubAdminofGroup($user, $group)) {
 			throw new OCSException('User is not a subadmin of this group', 102);
 		}
 
 		// Go
-		if($subAdminManager->deleteSubAdmin($user, $group)) {
+		if ($subAdminManager->deleteSubAdmin($user, $group)) {
 			return new DataResponse();
 		} else {
 			throw new OCSException('Unknown error occurred', 103);
@@ -735,7 +735,7 @@ 
 	public function getUserSubAdminGroups($userId) {
 		$user = $this->userManager->get($userId);
 		// Check if the user exists
-		if($user === null) {
+		if ($user === null) {
 			throw new OCSException('User does not exist', 101);
 		}
 
@@ -745,7 +745,7 @@ 
 			$groups[$key] = $group->getGID();
 		}
 
-		if(!$groups) {
+		if (!$groups) {
 			throw new OCSException('Unknown error occurred', 102);
 		} else {
 			return new DataResponse($groups);
@@ -789,13 +789,13 @@ 
 		$currentLoggedInUser = $this->userSession->getUser();
 
 		$targetUser = $this->userManager->get($userId);
-		if($targetUser === null) {
+		if ($targetUser === null) {
 			throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
 		}
 
 		// Check if admin / subadmin
 		$subAdminManager = $this->groupManager->getSubAdmin();
-		if(!$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
+		if (!$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
 			&& !$this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
 			// No rights
 			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
@@ -817,8 +817,8 @@ 
 			$this->newUserMailHelper->setL10N($l10n);
 			$emailTemplate = $this->newUserMailHelper->generateTemplate($targetUser, false);
 			$this->newUserMailHelper->sendMail($targetUser, $emailTemplate);
-		} catch(\Exception $e) {
-			$this->logger->error("Can't send new user mail to $email: " . $e->getMessage(), array('app' => 'settings'));
+		} catch (\Exception $e) {
+			$this->logger->error("Can't send new user mail to $email: ".$e->getMessage(), array('app' => 'settings'));
 			throw new OCSException('Sending email failed', 102);
 		}
 

apps/user_ldap/lib/Helper.php

Doc Comments +3 added lines

@@ -124,6 +124,9 @@
 		return $nextPrefix;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	private function getServersConfig($value) {
 		$regex = '/' . $value . '$/S';
 

Indentation +258 added lines, -258 removed lines

@@ -34,126 +34,126 @@ 
 
 class Helper {
 
-	/** @var IConfig */
-	private $config;
-
-	/**
-	 * Helper constructor.
-	 *
-	 * @param IConfig $config
-	 */
-	public function __construct(IConfig $config) {
-		$this->config = $config;
-	}
-
-	/**
-	 * returns prefixes for each saved LDAP/AD server configuration.
-	 * @param bool $activeConfigurations optional, whether only active configuration shall be
-	 * retrieved, defaults to false
-	 * @return array with a list of the available prefixes
-	 *
-	 * Configuration prefixes are used to set up configurations for n LDAP or
-	 * AD servers. Since configuration is stored in the database, table
-	 * appconfig under appid user_ldap, the common identifiers in column
-	 * 'configkey' have a prefix. The prefix for the very first server
-	 * configuration is empty.
-	 * Configkey Examples:
-	 * Server 1: ldap_login_filter
-	 * Server 2: s1_ldap_login_filter
-	 * Server 3: s2_ldap_login_filter
-	 *
-	 * The prefix needs to be passed to the constructor of Connection class,
-	 * except the default (first) server shall be connected to.
-	 *
-	 */
-	public function getServerConfigurationPrefixes($activeConfigurations = false) {
-		$referenceConfigkey = 'ldap_configuration_active';
-
-		$keys = $this->getServersConfig($referenceConfigkey);
-
-		$prefixes = [];
-		foreach ($keys as $key) {
-			if ($activeConfigurations && $this->config->getAppValue('user_ldap', $key, '0') !== '1') {
-				continue;
-			}
-
-			$len = strlen($key) - strlen($referenceConfigkey);
-			$prefixes[] = substr($key, 0, $len);
-		}
-
-		return $prefixes;
-	}
-
-	/**
-	 *
-	 * determines the host for every configured connection
-	 * @return array an array with configprefix as keys
-	 *
-	 */
-	public function getServerConfigurationHosts() {
-		$referenceConfigkey = 'ldap_host';
-
-		$keys = $this->getServersConfig($referenceConfigkey);
-
-		$result = array();
-		foreach($keys as $key) {
-			$len = strlen($key) - strlen($referenceConfigkey);
-			$prefix = substr($key, 0, $len);
-			$result[$prefix] = $this->config->getAppValue('user_ldap', $key);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * return the next available configuration prefix
-	 *
-	 * @return string
-	 */
-	public function getNextServerConfigurationPrefix() {
-		$serverConnections = $this->getServerConfigurationPrefixes();
-
-		if(count($serverConnections) === 0) {
-			return 's01';
-		}
-
-		sort($serverConnections);
-		$lastKey = array_pop($serverConnections);
-		$lastNumber = intval(str_replace('s', '', $lastKey));
-		$nextPrefix = 's' . str_pad($lastNumber + 1, 2, '0', STR_PAD_LEFT);
-		return $nextPrefix;
-	}
-
-	private function getServersConfig($value) {
-		$regex = '/' . $value . '$/S';
-
-		$keys = $this->config->getAppKeys('user_ldap');
-		$result = [];
-		foreach ($keys as $key) {
-			if (preg_match($regex, $key) === 1) {
-				$result[] = $key;
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * deletes a given saved LDAP/AD server configuration.
-	 * @param string $prefix the configuration prefix of the config to delete
-	 * @return bool true on success, false otherwise
-	 */
-	public function deleteServerConfiguration($prefix) {
-		if(!in_array($prefix, self::getServerConfigurationPrefixes())) {
-			return false;
-		}
-
-		$saveOtherConfigurations = '';
-		if(empty($prefix)) {
-			$saveOtherConfigurations = 'AND `configkey` NOT LIKE \'s%\'';
-		}
-
-		$query = \OCP\DB::prepare('
+    /** @var IConfig */
+    private $config;
+
+    /**
+     * Helper constructor.
+     *
+     * @param IConfig $config
+     */
+    public function __construct(IConfig $config) {
+        $this->config = $config;
+    }
+
+    /**
+     * returns prefixes for each saved LDAP/AD server configuration.
+     * @param bool $activeConfigurations optional, whether only active configuration shall be
+     * retrieved, defaults to false
+     * @return array with a list of the available prefixes
+     *
+     * Configuration prefixes are used to set up configurations for n LDAP or
+     * AD servers. Since configuration is stored in the database, table
+     * appconfig under appid user_ldap, the common identifiers in column
+     * 'configkey' have a prefix. The prefix for the very first server
+     * configuration is empty.
+     * Configkey Examples:
+     * Server 1: ldap_login_filter
+     * Server 2: s1_ldap_login_filter
+     * Server 3: s2_ldap_login_filter
+     *
+     * The prefix needs to be passed to the constructor of Connection class,
+     * except the default (first) server shall be connected to.
+     *
+     */
+    public function getServerConfigurationPrefixes($activeConfigurations = false) {
+        $referenceConfigkey = 'ldap_configuration_active';
+
+        $keys = $this->getServersConfig($referenceConfigkey);
+
+        $prefixes = [];
+        foreach ($keys as $key) {
+            if ($activeConfigurations && $this->config->getAppValue('user_ldap', $key, '0') !== '1') {
+                continue;
+            }
+
+            $len = strlen($key) - strlen($referenceConfigkey);
+            $prefixes[] = substr($key, 0, $len);
+        }
+
+        return $prefixes;
+    }
+
+    /**
+     *
+     * determines the host for every configured connection
+     * @return array an array with configprefix as keys
+     *
+     */
+    public function getServerConfigurationHosts() {
+        $referenceConfigkey = 'ldap_host';
+
+        $keys = $this->getServersConfig($referenceConfigkey);
+
+        $result = array();
+        foreach($keys as $key) {
+            $len = strlen($key) - strlen($referenceConfigkey);
+            $prefix = substr($key, 0, $len);
+            $result[$prefix] = $this->config->getAppValue('user_ldap', $key);
+        }
+
+        return $result;
+    }
+
+    /**
+     * return the next available configuration prefix
+     *
+     * @return string
+     */
+    public function getNextServerConfigurationPrefix() {
+        $serverConnections = $this->getServerConfigurationPrefixes();
+
+        if(count($serverConnections) === 0) {
+            return 's01';
+        }
+
+        sort($serverConnections);
+        $lastKey = array_pop($serverConnections);
+        $lastNumber = intval(str_replace('s', '', $lastKey));
+        $nextPrefix = 's' . str_pad($lastNumber + 1, 2, '0', STR_PAD_LEFT);
+        return $nextPrefix;
+    }
+
+    private function getServersConfig($value) {
+        $regex = '/' . $value . '$/S';
+
+        $keys = $this->config->getAppKeys('user_ldap');
+        $result = [];
+        foreach ($keys as $key) {
+            if (preg_match($regex, $key) === 1) {
+                $result[] = $key;
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * deletes a given saved LDAP/AD server configuration.
+     * @param string $prefix the configuration prefix of the config to delete
+     * @return bool true on success, false otherwise
+     */
+    public function deleteServerConfiguration($prefix) {
+        if(!in_array($prefix, self::getServerConfigurationPrefixes())) {
+            return false;
+        }
+
+        $saveOtherConfigurations = '';
+        if(empty($prefix)) {
+            $saveOtherConfigurations = 'AND `configkey` NOT LIKE \'s%\'';
+        }
+
+        $query = \OCP\DB::prepare('
 			DELETE
 			FROM `*PREFIX*appconfig`
 			WHERE `configkey` LIKE ?
@@ -161,145 +161,145 @@ 
 				AND `appid` = \'user_ldap\'
 				AND `configkey` NOT IN (\'enabled\', \'installed_version\', \'types\', \'bgjUpdateGroupsLastRun\')
 		');
-		$delRows = $query->execute(array($prefix.'%'));
-
-		if(\OCP\DB::isError($delRows)) {
-			return false;
-		}
-
-		if($delRows === 0) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * checks whether there is one or more disabled LDAP configurations
-	 * @throws \Exception
-	 * @return bool
-	 */
-	public function haveDisabledConfigurations() {
-		$all = $this->getServerConfigurationPrefixes(false);
-		$active = $this->getServerConfigurationPrefixes(true);
-
-		if(!is_array($all) || !is_array($active)) {
-			throw new \Exception('Unexpected Return Value');
-		}
-
-		return count($all) !== count($active) || count($all) === 0;
-	}
-
-	/**
-	 * extracts the domain from a given URL
-	 * @param string $url the URL
-	 * @return string|false domain as string on success, false otherwise
-	 */
-	public function getDomainFromURL($url) {
-		$uinfo = parse_url($url);
-		if(!is_array($uinfo)) {
-			return false;
-		}
-
-		$domain = false;
-		if(isset($uinfo['host'])) {
-			$domain = $uinfo['host'];
-		} else if(isset($uinfo['path'])) {
-			$domain = $uinfo['path'];
-		}
-
-		return $domain;
-	}
+        $delRows = $query->execute(array($prefix.'%'));
+
+        if(\OCP\DB::isError($delRows)) {
+            return false;
+        }
+
+        if($delRows === 0) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * checks whether there is one or more disabled LDAP configurations
+     * @throws \Exception
+     * @return bool
+     */
+    public function haveDisabledConfigurations() {
+        $all = $this->getServerConfigurationPrefixes(false);
+        $active = $this->getServerConfigurationPrefixes(true);
+
+        if(!is_array($all) || !is_array($active)) {
+            throw new \Exception('Unexpected Return Value');
+        }
+
+        return count($all) !== count($active) || count($all) === 0;
+    }
+
+    /**
+     * extracts the domain from a given URL
+     * @param string $url the URL
+     * @return string|false domain as string on success, false otherwise
+     */
+    public function getDomainFromURL($url) {
+        $uinfo = parse_url($url);
+        if(!is_array($uinfo)) {
+            return false;
+        }
+
+        $domain = false;
+        if(isset($uinfo['host'])) {
+            $domain = $uinfo['host'];
+        } else if(isset($uinfo['path'])) {
+            $domain = $uinfo['path'];
+        }
+
+        return $domain;
+    }
 	
-	/**
-	 *
-	 * Set the LDAPProvider in the config
-	 *
-	 */
-	public function setLDAPProvider() {
-		$current = \OC::$server->getConfig()->getSystemValue('ldapProviderFactory', null);
-		if(is_null($current)) {
-			\OC::$server->getConfig()->setSystemValue('ldapProviderFactory', '\\OCA\\User_LDAP\\LDAPProviderFactory');
-		}
-	}
+    /**
+     *
+     * Set the LDAPProvider in the config
+     *
+     */
+    public function setLDAPProvider() {
+        $current = \OC::$server->getConfig()->getSystemValue('ldapProviderFactory', null);
+        if(is_null($current)) {
+            \OC::$server->getConfig()->setSystemValue('ldapProviderFactory', '\\OCA\\User_LDAP\\LDAPProviderFactory');
+        }
+    }
 	
-	/**
-	 * sanitizes a DN received from the LDAP server
-	 * @param array $dn the DN in question
-	 * @return array the sanitized DN
-	 */
-	public function sanitizeDN($dn) {
-		//treating multiple base DNs
-		if(is_array($dn)) {
-			$result = array();
-			foreach($dn as $singleDN) {
-				$result[] = $this->sanitizeDN($singleDN);
-			}
-			return $result;
-		}
-
-		//OID sometimes gives back DNs with whitespace after the comma
-		// a la "uid=foo, cn=bar, dn=..." We need to tackle this!
-		$dn = preg_replace('/([^\\\]),(\s+)/u', '\1,', $dn);
-
-		//make comparisons and everything work
-		$dn = mb_strtolower($dn, 'UTF-8');
-
-		//escape DN values according to RFC 2253 – this is already done by ldap_explode_dn
-		//to use the DN in search filters, \ needs to be escaped to \5c additionally
-		//to use them in bases, we convert them back to simple backslashes in readAttribute()
-		$replacements = array(
-			'\,' => '\5c2C',
-			'\=' => '\5c3D',
-			'\+' => '\5c2B',
-			'\<' => '\5c3C',
-			'\>' => '\5c3E',
-			'\;' => '\5c3B',
-			'\"' => '\5c22',
-			'\#' => '\5c23',
-			'('  => '\28',
-			')'  => '\29',
-			'*'  => '\2A',
-		);
-		$dn = str_replace(array_keys($replacements), array_values($replacements), $dn);
-
-		return $dn;
-	}
+    /**
+     * sanitizes a DN received from the LDAP server
+     * @param array $dn the DN in question
+     * @return array the sanitized DN
+     */
+    public function sanitizeDN($dn) {
+        //treating multiple base DNs
+        if(is_array($dn)) {
+            $result = array();
+            foreach($dn as $singleDN) {
+                $result[] = $this->sanitizeDN($singleDN);
+            }
+            return $result;
+        }
+
+        //OID sometimes gives back DNs with whitespace after the comma
+        // a la "uid=foo, cn=bar, dn=..." We need to tackle this!
+        $dn = preg_replace('/([^\\\]),(\s+)/u', '\1,', $dn);
+
+        //make comparisons and everything work
+        $dn = mb_strtolower($dn, 'UTF-8');
+
+        //escape DN values according to RFC 2253 – this is already done by ldap_explode_dn
+        //to use the DN in search filters, \ needs to be escaped to \5c additionally
+        //to use them in bases, we convert them back to simple backslashes in readAttribute()
+        $replacements = array(
+            '\,' => '\5c2C',
+            '\=' => '\5c3D',
+            '\+' => '\5c2B',
+            '\<' => '\5c3C',
+            '\>' => '\5c3E',
+            '\;' => '\5c3B',
+            '\"' => '\5c22',
+            '\#' => '\5c23',
+            '('  => '\28',
+            ')'  => '\29',
+            '*'  => '\2A',
+        );
+        $dn = str_replace(array_keys($replacements), array_values($replacements), $dn);
+
+        return $dn;
+    }
 	
-	/**
-	 * converts a stored DN so it can be used as base parameter for LDAP queries, internally we store them for usage in LDAP filters
-	 * @param string $dn the DN
-	 * @return string
-	 */
-	public function DNasBaseParameter($dn) {
-		return str_ireplace('\\5c', '\\', $dn);
-	}
-
-	/**
-	 * listens to a hook thrown by server2server sharing and replaces the given
-	 * login name by a username, if it matches an LDAP user.
-	 *
-	 * @param array $param
-	 * @throws \Exception
-	 */
-	public static function loginName2UserName($param) {
-		if(!isset($param['uid'])) {
-			throw new \Exception('key uid is expected to be set in $param');
-		}
-
-		//ain't it ironic?
-		$helper = new Helper(\OC::$server->getConfig());
-
-		$configPrefixes = $helper->getServerConfigurationPrefixes(true);
-		$ldapWrapper = new LDAP();
-		$ocConfig = \OC::$server->getConfig();
-
-		$userBackend  = new User_Proxy(
-			$configPrefixes, $ldapWrapper, $ocConfig
-		);
-		$uid = $userBackend->loginName2UserName($param['uid'] );
-		if($uid !== false) {
-			$param['uid'] = $uid;
-		}
-	}
+    /**
+     * converts a stored DN so it can be used as base parameter for LDAP queries, internally we store them for usage in LDAP filters
+     * @param string $dn the DN
+     * @return string
+     */
+    public function DNasBaseParameter($dn) {
+        return str_ireplace('\\5c', '\\', $dn);
+    }
+
+    /**
+     * listens to a hook thrown by server2server sharing and replaces the given
+     * login name by a username, if it matches an LDAP user.
+     *
+     * @param array $param
+     * @throws \Exception
+     */
+    public static function loginName2UserName($param) {
+        if(!isset($param['uid'])) {
+            throw new \Exception('key uid is expected to be set in $param');
+        }
+
+        //ain't it ironic?
+        $helper = new Helper(\OC::$server->getConfig());
+
+        $configPrefixes = $helper->getServerConfigurationPrefixes(true);
+        $ldapWrapper = new LDAP();
+        $ocConfig = \OC::$server->getConfig();
+
+        $userBackend  = new User_Proxy(
+            $configPrefixes, $ldapWrapper, $ocConfig
+        );
+        $uid = $userBackend->loginName2UserName($param['uid'] );
+        if($uid !== false) {
+            $param['uid'] = $uid;
+        }
+    }
 }

Spacing +19 added lines, -19 removed lines

@@ -96,7 +96,7 @@ 
 		$keys = $this->getServersConfig($referenceConfigkey);
 
 		$result = array();
-		foreach($keys as $key) {
+		foreach ($keys as $key) {
 			$len = strlen($key) - strlen($referenceConfigkey);
 			$prefix = substr($key, 0, $len);
 			$result[$prefix] = $this->config->getAppValue('user_ldap', $key);
@@ -113,19 +113,19 @@ 
 	public function getNextServerConfigurationPrefix() {
 		$serverConnections = $this->getServerConfigurationPrefixes();
 
-		if(count($serverConnections) === 0) {
+		if (count($serverConnections) === 0) {
 			return 's01';
 		}
 
 		sort($serverConnections);
 		$lastKey = array_pop($serverConnections);
 		$lastNumber = intval(str_replace('s', '', $lastKey));
-		$nextPrefix = 's' . str_pad($lastNumber + 1, 2, '0', STR_PAD_LEFT);
+		$nextPrefix = 's'.str_pad($lastNumber + 1, 2, '0', STR_PAD_LEFT);
 		return $nextPrefix;
 	}
 
 	private function getServersConfig($value) {
-		$regex = '/' . $value . '$/S';
+		$regex = '/'.$value.'$/S';
 
 		$keys = $this->config->getAppKeys('user_ldap');
 		$result = [];
@@ -144,12 +144,12 @@ 
 	 * @return bool true on success, false otherwise
 	 */
 	public function deleteServerConfiguration($prefix) {
-		if(!in_array($prefix, self::getServerConfigurationPrefixes())) {
+		if (!in_array($prefix, self::getServerConfigurationPrefixes())) {
 			return false;
 		}
 
 		$saveOtherConfigurations = '';
-		if(empty($prefix)) {
+		if (empty($prefix)) {
 			$saveOtherConfigurations = 'AND `configkey` NOT LIKE \'s%\'';
 		}
 
@@ -163,11 +163,11 @@ 
 		');
 		$delRows = $query->execute(array($prefix.'%'));
 
-		if(\OCP\DB::isError($delRows)) {
+		if (\OCP\DB::isError($delRows)) {
 			return false;
 		}
 
-		if($delRows === 0) {
+		if ($delRows === 0) {
 			return false;
 		}
 
@@ -183,7 +183,7 @@ 
 		$all = $this->getServerConfigurationPrefixes(false);
 		$active = $this->getServerConfigurationPrefixes(true);
 
-		if(!is_array($all) || !is_array($active)) {
+		if (!is_array($all) || !is_array($active)) {
 			throw new \Exception('Unexpected Return Value');
 		}
 
@@ -197,14 +197,14 @@ 
 	 */
 	public function getDomainFromURL($url) {
 		$uinfo = parse_url($url);
-		if(!is_array($uinfo)) {
+		if (!is_array($uinfo)) {
 			return false;
 		}
 
 		$domain = false;
-		if(isset($uinfo['host'])) {
+		if (isset($uinfo['host'])) {
 			$domain = $uinfo['host'];
-		} else if(isset($uinfo['path'])) {
+		} else if (isset($uinfo['path'])) {
 			$domain = $uinfo['path'];
 		}
 
@@ -218,7 +218,7 @@ 
 	 */
 	public function setLDAPProvider() {
 		$current = \OC::$server->getConfig()->getSystemValue('ldapProviderFactory', null);
-		if(is_null($current)) {
+		if (is_null($current)) {
 			\OC::$server->getConfig()->setSystemValue('ldapProviderFactory', '\\OCA\\User_LDAP\\LDAPProviderFactory');
 		}
 	}
@@ -230,9 +230,9 @@ 
 	 */
 	public function sanitizeDN($dn) {
 		//treating multiple base DNs
-		if(is_array($dn)) {
+		if (is_array($dn)) {
 			$result = array();
-			foreach($dn as $singleDN) {
+			foreach ($dn as $singleDN) {
 				$result[] = $this->sanitizeDN($singleDN);
 			}
 			return $result;
@@ -283,7 +283,7 @@ 
 	 * @throws \Exception
 	 */
 	public static function loginName2UserName($param) {
-		if(!isset($param['uid'])) {
+		if (!isset($param['uid'])) {
 			throw new \Exception('key uid is expected to be set in $param');
 		}
 
@@ -294,11 +294,11 @@ 
 		$ldapWrapper = new LDAP();
 		$ocConfig = \OC::$server->getConfig();
 
-		$userBackend  = new User_Proxy(
+		$userBackend = new User_Proxy(
 			$configPrefixes, $ldapWrapper, $ocConfig
 		);
-		$uid = $userBackend->loginName2UserName($param['uid'] );
-		if($uid !== false) {
+		$uid = $userBackend->loginName2UserName($param['uid']);
+		if ($uid !== false) {
 			$param['uid'] = $uid;
 		}
 	}

core/Middleware/TwoFactorMiddleware.php

Doc Comments +4 added lines

@@ -104,6 +104,10 @@
 		// TODO: dont check/enforce 2FA if a auth token is used
 	}
 
+	/**
+	 * @param Controller $controller
+	 * @param string $methodName
+	 */
 	private function checkTwoFactor($controller, $methodName, IUser $user) {
 		// If two-factor auth is in progress disallow access to any controllers
 		// defined within "LoginController".

Indentation +93 added lines, -93 removed lines

@@ -41,98 +41,98 @@
 
 class TwoFactorMiddleware extends Middleware {
 
-	/** @var Manager */
-	private $twoFactorManager;
-
-	/** @var Session */
-	private $userSession;
-
-	/** @var ISession */
-	private $session;
-
-	/** @var IURLGenerator */
-	private $urlGenerator;
-
-	/** @var IControllerMethodReflector */
-	private $reflector;
-
-	/** @var IRequest */
-	private $request;
-
-	/**
-	 * @param Manager $twoFactorManager
-	 * @param Session $userSession
-	 * @param ISession $session
-	 * @param IURLGenerator $urlGenerator
-	 */
-	public function __construct(Manager $twoFactorManager, Session $userSession, ISession $session,
-		IURLGenerator $urlGenerator, IControllerMethodReflector $reflector, IRequest $request) {
-		$this->twoFactorManager = $twoFactorManager;
-		$this->userSession = $userSession;
-		$this->session = $session;
-		$this->urlGenerator = $urlGenerator;
-		$this->reflector = $reflector;
-		$this->request = $request;
-	}
-
-	/**
-	 * @param Controller $controller
-	 * @param string $methodName
-	 */
-	public function beforeController($controller, $methodName) {
-		if ($this->reflector->hasAnnotation('PublicPage')) {
-			// Don't block public pages
-			return;
-		}
-
-		if ($controller instanceof LoginController && $methodName === 'logout') {
-			// Don't block the logout page, to allow canceling the 2FA
-			return;
-		}
-
-		if ($this->userSession->isLoggedIn()) {
-			$user = $this->userSession->getUser();
-
-			if ($this->twoFactorManager->isTwoFactorAuthenticated($user)) {
-				$this->checkTwoFactor($controller, $methodName, $user);
-			} else if ($controller instanceof TwoFactorChallengeController) {
-				// Allow access to the two-factor controllers only if two-factor authentication
-				// is in progress.
-				throw new UserAlreadyLoggedInException();
-			}
-		}
-		// TODO: dont check/enforce 2FA if a auth token is used
-	}
-
-	private function checkTwoFactor($controller, $methodName, IUser $user) {
-		// If two-factor auth is in progress disallow access to any controllers
-		// defined within "LoginController".
-		$needsSecondFactor = $this->twoFactorManager->needsSecondFactor($user);
-		$twoFactor = $controller instanceof TwoFactorChallengeController;
-
-		// Disallow access to any controller if 2FA needs to be checked
-		if ($needsSecondFactor && !$twoFactor) {
-			throw new TwoFactorAuthRequiredException();
-		}
-
-		// Allow access to the two-factor controllers only if two-factor authentication
-		// is in progress.
-		if (!$needsSecondFactor && $twoFactor) {
-			throw new UserAlreadyLoggedInException();
-		}
-	}
-
-	public function afterException($controller, $methodName, Exception $exception) {
-		if ($exception instanceof TwoFactorAuthRequiredException) {
-			return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.selectChallenge', [
-					'redirect_url' => urlencode($this->request->server['REQUEST_URI']),
-			]));
-		}
-		if ($exception instanceof UserAlreadyLoggedInException) {
-			return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.index'));
-		}
-
-		throw $exception;
-	}
+    /** @var Manager */
+    private $twoFactorManager;
+
+    /** @var Session */
+    private $userSession;
+
+    /** @var ISession */
+    private $session;
+
+    /** @var IURLGenerator */
+    private $urlGenerator;
+
+    /** @var IControllerMethodReflector */
+    private $reflector;
+
+    /** @var IRequest */
+    private $request;
+
+    /**
+     * @param Manager $twoFactorManager
+     * @param Session $userSession
+     * @param ISession $session
+     * @param IURLGenerator $urlGenerator
+     */
+    public function __construct(Manager $twoFactorManager, Session $userSession, ISession $session,
+        IURLGenerator $urlGenerator, IControllerMethodReflector $reflector, IRequest $request) {
+        $this->twoFactorManager = $twoFactorManager;
+        $this->userSession = $userSession;
+        $this->session = $session;
+        $this->urlGenerator = $urlGenerator;
+        $this->reflector = $reflector;
+        $this->request = $request;
+    }
+
+    /**
+     * @param Controller $controller
+     * @param string $methodName
+     */
+    public function beforeController($controller, $methodName) {
+        if ($this->reflector->hasAnnotation('PublicPage')) {
+            // Don't block public pages
+            return;
+        }
+
+        if ($controller instanceof LoginController && $methodName === 'logout') {
+            // Don't block the logout page, to allow canceling the 2FA
+            return;
+        }
+
+        if ($this->userSession->isLoggedIn()) {
+            $user = $this->userSession->getUser();
+
+            if ($this->twoFactorManager->isTwoFactorAuthenticated($user)) {
+                $this->checkTwoFactor($controller, $methodName, $user);
+            } else if ($controller instanceof TwoFactorChallengeController) {
+                // Allow access to the two-factor controllers only if two-factor authentication
+                // is in progress.
+                throw new UserAlreadyLoggedInException();
+            }
+        }
+        // TODO: dont check/enforce 2FA if a auth token is used
+    }
+
+    private function checkTwoFactor($controller, $methodName, IUser $user) {
+        // If two-factor auth is in progress disallow access to any controllers
+        // defined within "LoginController".
+        $needsSecondFactor = $this->twoFactorManager->needsSecondFactor($user);
+        $twoFactor = $controller instanceof TwoFactorChallengeController;
+
+        // Disallow access to any controller if 2FA needs to be checked
+        if ($needsSecondFactor && !$twoFactor) {
+            throw new TwoFactorAuthRequiredException();
+        }
+
+        // Allow access to the two-factor controllers only if two-factor authentication
+        // is in progress.
+        if (!$needsSecondFactor && $twoFactor) {
+            throw new UserAlreadyLoggedInException();
+        }
+    }
+
+    public function afterException($controller, $methodName, Exception $exception) {
+        if ($exception instanceof TwoFactorAuthRequiredException) {
+            return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.selectChallenge', [
+                    'redirect_url' => urlencode($this->request->server['REQUEST_URI']),
+            ]));
+        }
+        if ($exception instanceof UserAlreadyLoggedInException) {
+            return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.index'));
+        }
+
+        throw $exception;
+    }
 
 }

lib/private/Archive/ZIP.php

Doc Comments +1 added lines

@@ -370,6 +370,7 @@
 
 	/**
 	 * write back temporary files
+	 * @param string $path
 	 */
 	function writeBack($tmpFile, $path) {
 		$this->addFile($path, $tmpFile);

Indentation +192 added lines, -192 removed lines

@@ -34,199 +34,199 @@
 use Icewind\Streams\CallbackWrapper;
 
 class ZIP extends Archive{
-	/**
-	 * @var \ZipArchive zip
-	 */
-	private $zip=null;
-	private $path;
+    /**
+     * @var \ZipArchive zip
+     */
+    private $zip=null;
+    private $path;
 
-	/**
-	 * @param string $source
-	 */
-	function __construct($source) {
-		$this->path=$source;
-		$this->zip=new \ZipArchive();
-		if($this->zip->open($source, \ZipArchive::CREATE)) {
-		}else{
-			\OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, \OCP\Util::WARN);
-		}
-	}
-	/**
-	 * add an empty folder to the archive
-	 * @param string $path
-	 * @return bool
-	 */
-	function addFolder($path) {
-		return $this->zip->addEmptyDir($path);
-	}
-	/**
-	 * add a file to the archive
-	 * @param string $path
-	 * @param string $source either a local file or string data
-	 * @return bool
-	 */
-	function addFile($path, $source='') {
-		if($source and $source[0]=='/' and file_exists($source)) {
-			$result=$this->zip->addFile($source, $path);
-		}else{
-			$result=$this->zip->addFromString($path, $source);
-		}
-		if($result) {
-			$this->zip->close();//close and reopen to save the zip
-			$this->zip->open($this->path);
-		}
-		return $result;
-	}
-	/**
-	 * rename a file or folder in the archive
-	 * @param string $source
-	 * @param string $dest
-	 * @return boolean|null
-	 */
-	function rename($source, $dest) {
-		$source=$this->stripPath($source);
-		$dest=$this->stripPath($dest);
-		$this->zip->renameName($source, $dest);
-	}
-	/**
-	 * get the uncompressed size of a file in the archive
-	 * @param string $path
-	 * @return int
-	 */
-	function filesize($path) {
-		$stat=$this->zip->statName($path);
-		return $stat['size'];
-	}
-	/**
-	 * get the last modified time of a file in the archive
-	 * @param string $path
-	 * @return int
-	 */
-	function mtime($path) {
-		return filemtime($this->path);
-	}
-	/**
-	 * get the files in a folder
-	 * @param string $path
-	 * @return array
-	 */
-	function getFolder($path) {
-		$files=$this->getFiles();
-		$folderContent=array();
-		$pathLength=strlen($path);
-		foreach($files as $file) {
-			if(substr($file, 0, $pathLength)==$path and $file!=$path) {
-				if(strrpos(substr($file, 0, -1), '/')<=$pathLength) {
-					$folderContent[]=substr($file, $pathLength);
-				}
-			}
-		}
-		return $folderContent;
-	}
-	/**
-	 * get all files in the archive
-	 * @return array
-	 */
-	function getFiles() {
-		$fileCount=$this->zip->numFiles;
-		$files=array();
-		for($i=0;$i<$fileCount;$i++) {
-			$files[]=$this->zip->getNameIndex($i);
-		}
-		return $files;
-	}
-	/**
-	 * get the content of a file
-	 * @param string $path
-	 * @return string
-	 */
-	function getFile($path) {
-		return $this->zip->getFromName($path);
-	}
-	/**
-	 * extract a single file from the archive
-	 * @param string $path
-	 * @param string $dest
-	 * @return boolean|null
-	 */
-	function extractFile($path, $dest) {
-		$fp = $this->zip->getStream($path);
-		file_put_contents($dest, $fp);
-	}
-	/**
-	 * extract the archive
-	 * @param string $dest
-	 * @return bool
-	 */
-	function extract($dest) {
-		return $this->zip->extractTo($dest);
-	}
-	/**
-	 * check if a file or folder exists in the archive
-	 * @param string $path
-	 * @return bool
-	 */
-	function fileExists($path) {
-		return ($this->zip->locateName($path)!==false) or ($this->zip->locateName($path.'/')!==false);
-	}
-	/**
-	 * remove a file or folder from the archive
-	 * @param string $path
-	 * @return bool
-	 */
-	function remove($path) {
-		if($this->fileExists($path.'/')) {
-			return $this->zip->deleteName($path.'/');
-		}else{
-			return $this->zip->deleteName($path);
-		}
-	}
-	/**
-	 * get a file handler
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource
-	 */
-	function getStream($path, $mode) {
-		if($mode=='r' or $mode=='rb') {
-			return $this->zip->getStream($path);
-		} else {
-			//since we can't directly get a writable stream,
-			//make a temp copy of the file and put it back
-			//in the archive when the stream is closed
-			if(strrpos($path, '.')!==false) {
-				$ext=substr($path, strrpos($path, '.'));
-			}else{
-				$ext='';
-			}
-			$tmpFile=\OCP\Files::tmpFile($ext);
-			if($this->fileExists($path)) {
-				$this->extractFile($path, $tmpFile);
-			}
-			$handle = fopen($tmpFile, $mode);
-			return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
-				$this->writeBack($tmpFile, $path);
-			});
-		}
-	}
+    /**
+     * @param string $source
+     */
+    function __construct($source) {
+        $this->path=$source;
+        $this->zip=new \ZipArchive();
+        if($this->zip->open($source, \ZipArchive::CREATE)) {
+        }else{
+            \OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, \OCP\Util::WARN);
+        }
+    }
+    /**
+     * add an empty folder to the archive
+     * @param string $path
+     * @return bool
+     */
+    function addFolder($path) {
+        return $this->zip->addEmptyDir($path);
+    }
+    /**
+     * add a file to the archive
+     * @param string $path
+     * @param string $source either a local file or string data
+     * @return bool
+     */
+    function addFile($path, $source='') {
+        if($source and $source[0]=='/' and file_exists($source)) {
+            $result=$this->zip->addFile($source, $path);
+        }else{
+            $result=$this->zip->addFromString($path, $source);
+        }
+        if($result) {
+            $this->zip->close();//close and reopen to save the zip
+            $this->zip->open($this->path);
+        }
+        return $result;
+    }
+    /**
+     * rename a file or folder in the archive
+     * @param string $source
+     * @param string $dest
+     * @return boolean|null
+     */
+    function rename($source, $dest) {
+        $source=$this->stripPath($source);
+        $dest=$this->stripPath($dest);
+        $this->zip->renameName($source, $dest);
+    }
+    /**
+     * get the uncompressed size of a file in the archive
+     * @param string $path
+     * @return int
+     */
+    function filesize($path) {
+        $stat=$this->zip->statName($path);
+        return $stat['size'];
+    }
+    /**
+     * get the last modified time of a file in the archive
+     * @param string $path
+     * @return int
+     */
+    function mtime($path) {
+        return filemtime($this->path);
+    }
+    /**
+     * get the files in a folder
+     * @param string $path
+     * @return array
+     */
+    function getFolder($path) {
+        $files=$this->getFiles();
+        $folderContent=array();
+        $pathLength=strlen($path);
+        foreach($files as $file) {
+            if(substr($file, 0, $pathLength)==$path and $file!=$path) {
+                if(strrpos(substr($file, 0, -1), '/')<=$pathLength) {
+                    $folderContent[]=substr($file, $pathLength);
+                }
+            }
+        }
+        return $folderContent;
+    }
+    /**
+     * get all files in the archive
+     * @return array
+     */
+    function getFiles() {
+        $fileCount=$this->zip->numFiles;
+        $files=array();
+        for($i=0;$i<$fileCount;$i++) {
+            $files[]=$this->zip->getNameIndex($i);
+        }
+        return $files;
+    }
+    /**
+     * get the content of a file
+     * @param string $path
+     * @return string
+     */
+    function getFile($path) {
+        return $this->zip->getFromName($path);
+    }
+    /**
+     * extract a single file from the archive
+     * @param string $path
+     * @param string $dest
+     * @return boolean|null
+     */
+    function extractFile($path, $dest) {
+        $fp = $this->zip->getStream($path);
+        file_put_contents($dest, $fp);
+    }
+    /**
+     * extract the archive
+     * @param string $dest
+     * @return bool
+     */
+    function extract($dest) {
+        return $this->zip->extractTo($dest);
+    }
+    /**
+     * check if a file or folder exists in the archive
+     * @param string $path
+     * @return bool
+     */
+    function fileExists($path) {
+        return ($this->zip->locateName($path)!==false) or ($this->zip->locateName($path.'/')!==false);
+    }
+    /**
+     * remove a file or folder from the archive
+     * @param string $path
+     * @return bool
+     */
+    function remove($path) {
+        if($this->fileExists($path.'/')) {
+            return $this->zip->deleteName($path.'/');
+        }else{
+            return $this->zip->deleteName($path);
+        }
+    }
+    /**
+     * get a file handler
+     * @param string $path
+     * @param string $mode
+     * @return resource
+     */
+    function getStream($path, $mode) {
+        if($mode=='r' or $mode=='rb') {
+            return $this->zip->getStream($path);
+        } else {
+            //since we can't directly get a writable stream,
+            //make a temp copy of the file and put it back
+            //in the archive when the stream is closed
+            if(strrpos($path, '.')!==false) {
+                $ext=substr($path, strrpos($path, '.'));
+            }else{
+                $ext='';
+            }
+            $tmpFile=\OCP\Files::tmpFile($ext);
+            if($this->fileExists($path)) {
+                $this->extractFile($path, $tmpFile);
+            }
+            $handle = fopen($tmpFile, $mode);
+            return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
+                $this->writeBack($tmpFile, $path);
+            });
+        }
+    }
 
-	/**
-	 * write back temporary files
-	 */
-	function writeBack($tmpFile, $path) {
-		$this->addFile($path, $tmpFile);
-		unlink($tmpFile);
-	}
+    /**
+     * write back temporary files
+     */
+    function writeBack($tmpFile, $path) {
+        $this->addFile($path, $tmpFile);
+        unlink($tmpFile);
+    }
 
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	private function stripPath($path) {
-		if(!$path || $path[0]=='/') {
-			return substr($path, 1);
-		}else{
-			return $path;
-		}
-	}
+    /**
+     * @param string $path
+     * @return string
+     */
+    private function stripPath($path) {
+        if(!$path || $path[0]=='/') {
+            return substr($path, 1);
+        }else{
+            return $path;
+        }
+    }
 }

Spacing +40 added lines, -40 removed lines

@@ -33,21 +33,21 @@ 
 
 use Icewind\Streams\CallbackWrapper;
 
-class ZIP extends Archive{
+class ZIP extends Archive {
 	/**
 	 * @var \ZipArchive zip
 	 */
-	private $zip=null;
+	private $zip = null;
 	private $path;
 
 	/**
 	 * @param string $source
 	 */
 	function __construct($source) {
-		$this->path=$source;
-		$this->zip=new \ZipArchive();
-		if($this->zip->open($source, \ZipArchive::CREATE)) {
-		}else{
+		$this->path = $source;
+		$this->zip = new \ZipArchive();
+		if ($this->zip->open($source, \ZipArchive::CREATE)) {
+		} else {
 			\OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, \OCP\Util::WARN);
 		}
 	}
@@ -65,14 +65,14 @@ 
 	 * @param string $source either a local file or string data
 	 * @return bool
 	 */
-	function addFile($path, $source='') {
-		if($source and $source[0]=='/' and file_exists($source)) {
-			$result=$this->zip->addFile($source, $path);
-		}else{
-			$result=$this->zip->addFromString($path, $source);
+	function addFile($path, $source = '') {
+		if ($source and $source[0] == '/' and file_exists($source)) {
+			$result = $this->zip->addFile($source, $path);
+		} else {
+			$result = $this->zip->addFromString($path, $source);
 		}
-		if($result) {
-			$this->zip->close();//close and reopen to save the zip
+		if ($result) {
+			$this->zip->close(); //close and reopen to save the zip
 			$this->zip->open($this->path);
 		}
 		return $result;
@@ -84,8 +84,8 @@ 
 	 * @return boolean|null
 	 */
 	function rename($source, $dest) {
-		$source=$this->stripPath($source);
-		$dest=$this->stripPath($dest);
+		$source = $this->stripPath($source);
+		$dest = $this->stripPath($dest);
 		$this->zip->renameName($source, $dest);
 	}
 	/**
@@ -94,7 +94,7 @@ 
 	 * @return int
 	 */
 	function filesize($path) {
-		$stat=$this->zip->statName($path);
+		$stat = $this->zip->statName($path);
 		return $stat['size'];
 	}
 	/**
@@ -111,13 +111,13 @@ 
 	 * @return array
 	 */
 	function getFolder($path) {
-		$files=$this->getFiles();
-		$folderContent=array();
-		$pathLength=strlen($path);
-		foreach($files as $file) {
-			if(substr($file, 0, $pathLength)==$path and $file!=$path) {
-				if(strrpos(substr($file, 0, -1), '/')<=$pathLength) {
-					$folderContent[]=substr($file, $pathLength);
+		$files = $this->getFiles();
+		$folderContent = array();
+		$pathLength = strlen($path);
+		foreach ($files as $file) {
+			if (substr($file, 0, $pathLength) == $path and $file != $path) {
+				if (strrpos(substr($file, 0, -1), '/') <= $pathLength) {
+					$folderContent[] = substr($file, $pathLength);
 				}
 			}
 		}
@@ -128,10 +128,10 @@ 
 	 * @return array
 	 */
 	function getFiles() {
-		$fileCount=$this->zip->numFiles;
-		$files=array();
-		for($i=0;$i<$fileCount;$i++) {
-			$files[]=$this->zip->getNameIndex($i);
+		$fileCount = $this->zip->numFiles;
+		$files = array();
+		for ($i = 0; $i < $fileCount; $i++) {
+			$files[] = $this->zip->getNameIndex($i);
 		}
 		return $files;
 	}
@@ -167,7 +167,7 @@ 
 	 * @return bool
 	 */
 	function fileExists($path) {
-		return ($this->zip->locateName($path)!==false) or ($this->zip->locateName($path.'/')!==false);
+		return ($this->zip->locateName($path) !== false) or ($this->zip->locateName($path.'/') !== false);
 	}
 	/**
 	 * remove a file or folder from the archive
@@ -175,9 +175,9 @@ 
 	 * @return bool
 	 */
 	function remove($path) {
-		if($this->fileExists($path.'/')) {
+		if ($this->fileExists($path.'/')) {
 			return $this->zip->deleteName($path.'/');
-		}else{
+		} else {
 			return $this->zip->deleteName($path);
 		}
 	}
@@ -188,23 +188,23 @@ 
 	 * @return resource
 	 */
 	function getStream($path, $mode) {
-		if($mode=='r' or $mode=='rb') {
+		if ($mode == 'r' or $mode == 'rb') {
 			return $this->zip->getStream($path);
 		} else {
 			//since we can't directly get a writable stream,
 			//make a temp copy of the file and put it back
 			//in the archive when the stream is closed
-			if(strrpos($path, '.')!==false) {
-				$ext=substr($path, strrpos($path, '.'));
-			}else{
-				$ext='';
+			if (strrpos($path, '.') !== false) {
+				$ext = substr($path, strrpos($path, '.'));
+			} else {
+				$ext = '';
 			}
-			$tmpFile=\OCP\Files::tmpFile($ext);
-			if($this->fileExists($path)) {
+			$tmpFile = \OCP\Files::tmpFile($ext);
+			if ($this->fileExists($path)) {
 				$this->extractFile($path, $tmpFile);
 			}
 			$handle = fopen($tmpFile, $mode);
-			return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
+			return CallbackWrapper::wrap($handle, null, null, function() use ($path, $tmpFile) {
 				$this->writeBack($tmpFile, $path);
 			});
 		}
@@ -223,9 +223,9 @@ 
 	 * @return string
 	 */
 	private function stripPath($path) {
-		if(!$path || $path[0]=='/') {
+		if (!$path || $path[0] == '/') {
 			return substr($path, 1);
-		}else{
+		} else {
 			return $path;
 		}
 	}

Braces +5 added lines, -5 removed lines

@@ -47,7 +47,7 @@ 
 		$this->path=$source;
 		$this->zip=new \ZipArchive();
 		if($this->zip->open($source, \ZipArchive::CREATE)) {
-		}else{
+		} else{
 			\OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, \OCP\Util::WARN);
 		}
 	}
@@ -68,7 +68,7 @@ 
 	function addFile($path, $source='') {
 		if($source and $source[0]=='/' and file_exists($source)) {
 			$result=$this->zip->addFile($source, $path);
-		}else{
+		} else{
 			$result=$this->zip->addFromString($path, $source);
 		}
 		if($result) {
@@ -177,7 +177,7 @@ 
 	function remove($path) {
 		if($this->fileExists($path.'/')) {
 			return $this->zip->deleteName($path.'/');
-		}else{
+		} else{
 			return $this->zip->deleteName($path);
 		}
 	}
@@ -196,7 +196,7 @@ 
 			//in the archive when the stream is closed
 			if(strrpos($path, '.')!==false) {
 				$ext=substr($path, strrpos($path, '.'));
-			}else{
+			} else{
 				$ext='';
 			}
 			$tmpFile=\OCP\Files::tmpFile($ext);
@@ -225,7 +225,7 @@ 
 	private function stripPath($path) {
 		if(!$path || $path[0]=='/') {
 			return substr($path, 1);
-		}else{
+		} else{
 			return $path;
 		}
 	}

lib/private/Files/Cache/Wrapper/CacheJail.php

Doc Comments +3 added lines

@@ -194,6 +194,9 @@
 		return $this->getCache()->getStatus($this->getSourcePath($file));
 	}
 
+	/**
+	 * @param ICacheEntry[] $results
+	 */
 	private function formatSearchResults($results) {
 		$results = array_filter($results, array($this, 'filterCacheEntry'));
 		$results = array_values($results);

Spacing +3 added lines, -3 removed lines

@@ -51,7 +51,7 @@ 
 		if ($path === '') {
 			return $this->root;
 		} else {
-			return $this->root . '/' . ltrim($path, '/');
+			return $this->root.'/'.ltrim($path, '/');
 		}
 	}
 
@@ -66,7 +66,7 @@ 
 		$rootLength = strlen($this->root) + 1;
 		if ($path === $this->root) {
 			return '';
-		} else if (substr($path, 0, $rootLength) === $this->root . '/') {
+		} else if (substr($path, 0, $rootLength) === $this->root.'/') {
 			return substr($path, $rootLength);
 		} else {
 			return null;
@@ -86,7 +86,7 @@ 
 
 	protected function filterCacheEntry($entry) {
 		$rootLength = strlen($this->root) + 1;
-		return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root . '/');
+		return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root.'/');
 	}
 
 	/**

Indentation +253 added lines, -253 removed lines

@@ -34,284 +34,284 @@
  * Jail to a subdirectory of the wrapped cache
  */
 class CacheJail extends CacheWrapper {
-	/**
-	 * @var string
-	 */
-	protected $root;
+    /**
+     * @var string
+     */
+    protected $root;
 
-	/**
-	 * @param \OCP\Files\Cache\ICache $cache
-	 * @param string $root
-	 */
-	public function __construct($cache, $root) {
-		parent::__construct($cache);
-		$this->root = $root;
-	}
+    /**
+     * @param \OCP\Files\Cache\ICache $cache
+     * @param string $root
+     */
+    public function __construct($cache, $root) {
+        parent::__construct($cache);
+        $this->root = $root;
+    }
 
-	protected function getSourcePath($path) {
-		if ($path === '') {
-			return $this->root;
-		} else {
-			return $this->root . '/' . ltrim($path, '/');
-		}
-	}
+    protected function getSourcePath($path) {
+        if ($path === '') {
+            return $this->root;
+        } else {
+            return $this->root . '/' . ltrim($path, '/');
+        }
+    }
 
-	/**
-	 * @param string $path
-	 * @return null|string the jailed path or null if the path is outside the jail
-	 */
-	protected function getJailedPath($path) {
-		if ($this->root === '') {
-			return $path;
-		}
-		$rootLength = strlen($this->root) + 1;
-		if ($path === $this->root) {
-			return '';
-		} else if (substr($path, 0, $rootLength) === $this->root . '/') {
-			return substr($path, $rootLength);
-		} else {
-			return null;
-		}
-	}
+    /**
+     * @param string $path
+     * @return null|string the jailed path or null if the path is outside the jail
+     */
+    protected function getJailedPath($path) {
+        if ($this->root === '') {
+            return $path;
+        }
+        $rootLength = strlen($this->root) + 1;
+        if ($path === $this->root) {
+            return '';
+        } else if (substr($path, 0, $rootLength) === $this->root . '/') {
+            return substr($path, $rootLength);
+        } else {
+            return null;
+        }
+    }
 
-	/**
-	 * @param ICacheEntry|array $entry
-	 * @return array
-	 */
-	protected function formatCacheEntry($entry) {
-		if (isset($entry['path'])) {
-			$entry['path'] = $this->getJailedPath($entry['path']);
-		}
-		return $entry;
-	}
+    /**
+     * @param ICacheEntry|array $entry
+     * @return array
+     */
+    protected function formatCacheEntry($entry) {
+        if (isset($entry['path'])) {
+            $entry['path'] = $this->getJailedPath($entry['path']);
+        }
+        return $entry;
+    }
 
-	protected function filterCacheEntry($entry) {
-		$rootLength = strlen($this->root) + 1;
-		return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root . '/');
-	}
+    protected function filterCacheEntry($entry) {
+        $rootLength = strlen($this->root) + 1;
+        return ($entry['path'] === $this->root) or (substr($entry['path'], 0, $rootLength) === $this->root . '/');
+    }
 
-	/**
-	 * get the stored metadata of a file or folder
-	 *
-	 * @param string /int $file
-	 * @return array|false
-	 */
-	public function get($file) {
-		if (is_string($file) or $file == '') {
-			$file = $this->getSourcePath($file);
-		}
-		return parent::get($file);
-	}
+    /**
+     * get the stored metadata of a file or folder
+     *
+     * @param string /int $file
+     * @return array|false
+     */
+    public function get($file) {
+        if (is_string($file) or $file == '') {
+            $file = $this->getSourcePath($file);
+        }
+        return parent::get($file);
+    }
 
-	/**
-	 * insert meta data for a new file or folder
-	 *
-	 * @param string $file
-	 * @param array $data
-	 *
-	 * @return int file id
-	 * @throws \RuntimeException
-	 */
-	public function insert($file, array $data) {
-		return $this->getCache()->insert($this->getSourcePath($file), $data);
-	}
+    /**
+     * insert meta data for a new file or folder
+     *
+     * @param string $file
+     * @param array $data
+     *
+     * @return int file id
+     * @throws \RuntimeException
+     */
+    public function insert($file, array $data) {
+        return $this->getCache()->insert($this->getSourcePath($file), $data);
+    }
 
-	/**
-	 * update the metadata in the cache
-	 *
-	 * @param int $id
-	 * @param array $data
-	 */
-	public function update($id, array $data) {
-		$this->getCache()->update($id, $data);
-	}
+    /**
+     * update the metadata in the cache
+     *
+     * @param int $id
+     * @param array $data
+     */
+    public function update($id, array $data) {
+        $this->getCache()->update($id, $data);
+    }
 
-	/**
-	 * get the file id for a file
-	 *
-	 * @param string $file
-	 * @return int
-	 */
-	public function getId($file) {
-		return $this->getCache()->getId($this->getSourcePath($file));
-	}
+    /**
+     * get the file id for a file
+     *
+     * @param string $file
+     * @return int
+     */
+    public function getId($file) {
+        return $this->getCache()->getId($this->getSourcePath($file));
+    }
 
-	/**
-	 * get the id of the parent folder of a file
-	 *
-	 * @param string $file
-	 * @return int
-	 */
-	public function getParentId($file) {
-		return $this->getCache()->getParentId($this->getSourcePath($file));
-	}
+    /**
+     * get the id of the parent folder of a file
+     *
+     * @param string $file
+     * @return int
+     */
+    public function getParentId($file) {
+        return $this->getCache()->getParentId($this->getSourcePath($file));
+    }
 
-	/**
-	 * check if a file is available in the cache
-	 *
-	 * @param string $file
-	 * @return bool
-	 */
-	public function inCache($file) {
-		return $this->getCache()->inCache($this->getSourcePath($file));
-	}
+    /**
+     * check if a file is available in the cache
+     *
+     * @param string $file
+     * @return bool
+     */
+    public function inCache($file) {
+        return $this->getCache()->inCache($this->getSourcePath($file));
+    }
 
-	/**
-	 * remove a file or folder from the cache
-	 *
-	 * @param string $file
-	 */
-	public function remove($file) {
-		$this->getCache()->remove($this->getSourcePath($file));
-	}
+    /**
+     * remove a file or folder from the cache
+     *
+     * @param string $file
+     */
+    public function remove($file) {
+        $this->getCache()->remove($this->getSourcePath($file));
+    }
 
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * @param string $source
-	 * @param string $target
-	 */
-	public function move($source, $target) {
-		$this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target));
-	}
+    /**
+     * Move a file or folder in the cache
+     *
+     * @param string $source
+     * @param string $target
+     */
+    public function move($source, $target) {
+        $this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target));
+    }
 
-	/**
-	 * remove all entries for files that are stored on the storage from the cache
-	 */
-	public function clear() {
-		$this->getCache()->remove($this->root);
-	}
+    /**
+     * remove all entries for files that are stored on the storage from the cache
+     */
+    public function clear() {
+        $this->getCache()->remove($this->root);
+    }
 
-	/**
-	 * @param string $file
-	 *
-	 * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
-	 */
-	public function getStatus($file) {
-		return $this->getCache()->getStatus($this->getSourcePath($file));
-	}
+    /**
+     * @param string $file
+     *
+     * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
+     */
+    public function getStatus($file) {
+        return $this->getCache()->getStatus($this->getSourcePath($file));
+    }
 
-	private function formatSearchResults($results) {
-		$results = array_filter($results, array($this, 'filterCacheEntry'));
-		$results = array_values($results);
-		return array_map(array($this, 'formatCacheEntry'), $results);
-	}
+    private function formatSearchResults($results) {
+        $results = array_filter($results, array($this, 'filterCacheEntry'));
+        $results = array_values($results);
+        return array_map(array($this, 'formatCacheEntry'), $results);
+    }
 
-	/**
-	 * search for files matching $pattern
-	 *
-	 * @param string $pattern
-	 * @return array an array of file data
-	 */
-	public function search($pattern) {
-		$results = $this->getCache()->search($pattern);
-		return $this->formatSearchResults($results);
-	}
+    /**
+     * search for files matching $pattern
+     *
+     * @param string $pattern
+     * @return array an array of file data
+     */
+    public function search($pattern) {
+        $results = $this->getCache()->search($pattern);
+        return $this->formatSearchResults($results);
+    }
 
-	/**
-	 * search for files by mimetype
-	 *
-	 * @param string $mimetype
-	 * @return array
-	 */
-	public function searchByMime($mimetype) {
-		$results = $this->getCache()->searchByMime($mimetype);
-		return $this->formatSearchResults($results);
-	}
+    /**
+     * search for files by mimetype
+     *
+     * @param string $mimetype
+     * @return array
+     */
+    public function searchByMime($mimetype) {
+        $results = $this->getCache()->searchByMime($mimetype);
+        return $this->formatSearchResults($results);
+    }
 
-	public function searchQuery(ISearchQuery $query) {
-		$results = $this->getCache()->searchQuery($query);
-		return $this->formatSearchResults($results);
-	}
+    public function searchQuery(ISearchQuery $query) {
+        $results = $this->getCache()->searchQuery($query);
+        return $this->formatSearchResults($results);
+    }
 
-	/**
-	 * search for files by mimetype
-	 *
-	 * @param string|int $tag name or tag id
-	 * @param string $userId owner of the tags
-	 * @return array
-	 */
-	public function searchByTag($tag, $userId) {
-		$results = $this->getCache()->searchByTag($tag, $userId);
-		return $this->formatSearchResults($results);
-	}
+    /**
+     * search for files by mimetype
+     *
+     * @param string|int $tag name or tag id
+     * @param string $userId owner of the tags
+     * @return array
+     */
+    public function searchByTag($tag, $userId) {
+        $results = $this->getCache()->searchByTag($tag, $userId);
+        return $this->formatSearchResults($results);
+    }
 
-	/**
-	 * update the folder size and the size of all parent folders
-	 *
-	 * @param string|boolean $path
-	 * @param array $data (optional) meta data of the folder
-	 */
-	public function correctFolderSize($path, $data = null) {
-		if ($this->getCache() instanceof Cache) {
-			$this->getCache()->correctFolderSize($this->getSourcePath($path), $data);
-		}
-	}
+    /**
+     * update the folder size and the size of all parent folders
+     *
+     * @param string|boolean $path
+     * @param array $data (optional) meta data of the folder
+     */
+    public function correctFolderSize($path, $data = null) {
+        if ($this->getCache() instanceof Cache) {
+            $this->getCache()->correctFolderSize($this->getSourcePath($path), $data);
+        }
+    }
 
-	/**
-	 * get the size of a folder and set it in the cache
-	 *
-	 * @param string $path
-	 * @param array $entry (optional) meta data of the folder
-	 * @return int
-	 */
-	public function calculateFolderSize($path, $entry = null) {
-		if ($this->getCache() instanceof Cache) {
-			return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry);
-		} else {
-			return 0;
-		}
+    /**
+     * get the size of a folder and set it in the cache
+     *
+     * @param string $path
+     * @param array $entry (optional) meta data of the folder
+     * @return int
+     */
+    public function calculateFolderSize($path, $entry = null) {
+        if ($this->getCache() instanceof Cache) {
+            return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry);
+        } else {
+            return 0;
+        }
 
-	}
+    }
 
-	/**
-	 * get all file ids on the files on the storage
-	 *
-	 * @return int[]
-	 */
-	public function getAll() {
-		// not supported
-		return array();
-	}
+    /**
+     * get all file ids on the files on the storage
+     *
+     * @return int[]
+     */
+    public function getAll() {
+        // not supported
+        return array();
+    }
 
-	/**
-	 * find a folder in the cache which has not been fully scanned
-	 *
-	 * If multiply incomplete folders are in the cache, the one with the highest id will be returned,
-	 * use the one with the highest id gives the best result with the background scanner, since that is most
-	 * likely the folder where we stopped scanning previously
-	 *
-	 * @return string|bool the path of the folder or false when no folder matched
-	 */
-	public function getIncomplete() {
-		// not supported
-		return false;
-	}
+    /**
+     * find a folder in the cache which has not been fully scanned
+     *
+     * If multiply incomplete folders are in the cache, the one with the highest id will be returned,
+     * use the one with the highest id gives the best result with the background scanner, since that is most
+     * likely the folder where we stopped scanning previously
+     *
+     * @return string|bool the path of the folder or false when no folder matched
+     */
+    public function getIncomplete() {
+        // not supported
+        return false;
+    }
 
-	/**
-	 * get the path of a file on this storage by it's id
-	 *
-	 * @param int $id
-	 * @return string|null
-	 */
-	public function getPathById($id) {
-		$path = $this->getCache()->getPathById($id);
-		return $this->getJailedPath($path);
-	}
+    /**
+     * get the path of a file on this storage by it's id
+     *
+     * @param int $id
+     * @return string|null
+     */
+    public function getPathById($id) {
+        $path = $this->getCache()->getPathById($id);
+        return $this->getJailedPath($path);
+    }
 
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * Note that this should make sure the entries are removed from the source cache
-	 *
-	 * @param \OCP\Files\Cache\ICache $sourceCache
-	 * @param string $sourcePath
-	 * @param string $targetPath
-	 */
-	public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
-		if ($sourceCache === $this) {
-			return $this->move($sourcePath, $targetPath);
-		}
-		return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath));
-	}
+    /**
+     * Move a file or folder in the cache
+     *
+     * Note that this should make sure the entries are removed from the source cache
+     *
+     * @param \OCP\Files\Cache\ICache $sourceCache
+     * @param string $sourcePath
+     * @param string $targetPath
+     */
+    public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
+        if ($sourceCache === $this) {
+            return $this->move($sourcePath, $targetPath);
+        }
+        return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath));
+    }
 }

lib/private/Files/FileInfo.php

Unused Use Statements -1 removed lines

@@ -32,7 +32,6 @@
 
 use OCP\Files\Cache\ICacheEntry;
 use OCP\Files\Mount\IMountPoint;
-use OCP\Files\Storage\IStorage;
 use OCP\Files\IHomeStorage;
 use OCP\IUser;
 

Indentation +352 added lines, -352 removed lines

@@ -37,356 +37,356 @@
 use OCP\IUser;
 
 class FileInfo implements \OCP\Files\FileInfo, \ArrayAccess {
-	/**
-	 * @var array $data
-	 */
-	private $data;
-
-	/**
-	 * @var string $path
-	 */
-	private $path;
-
-	/**
-	 * @var \OC\Files\Storage\Storage $storage
-	 */
-	private $storage;
-
-	/**
-	 * @var string $internalPath
-	 */
-	private $internalPath;
-
-	/**
-	 * @var \OCP\Files\Mount\IMountPoint
-	 */
-	private $mount;
-
-	/**
-	 * @var IUser
-	 */
-	private $owner;
-
-	/**
-	 * @var string[]
-	 */
-	private $childEtags = [];
-
-	/**
-	 * @var IMountPoint[]
-	 */
-	private $subMounts = [];
-
-	private $subMountsUsed = false;
-
-	/**
-	 * @param string|boolean $path
-	 * @param Storage\Storage $storage
-	 * @param string $internalPath
-	 * @param array|ICacheEntry $data
-	 * @param \OCP\Files\Mount\IMountPoint $mount
-	 * @param \OCP\IUser|null $owner
-	 */
-	public function __construct($path, $storage, $internalPath, $data, $mount, $owner= null) {
-		$this->path = $path;
-		$this->storage = $storage;
-		$this->internalPath = $internalPath;
-		$this->data = $data;
-		$this->mount = $mount;
-		$this->owner = $owner;
-	}
-
-	public function offsetSet($offset, $value) {
-		$this->data[$offset] = $value;
-	}
-
-	public function offsetExists($offset) {
-		return isset($this->data[$offset]);
-	}
-
-	public function offsetUnset($offset) {
-		unset($this->data[$offset]);
-	}
-
-	public function offsetGet($offset) {
-		if ($offset === 'type') {
-			return $this->getType();
-		} else if ($offset === 'etag') {
-			return $this->getEtag();
-		} else if ($offset === 'size') {
-			return $this->getSize();
-		} else if ($offset === 'mtime') {
-			return $this->getMTime();
-		} elseif ($offset === 'permissions') {
-			return $this->getPermissions();
-		} elseif (isset($this->data[$offset])) {
-			return $this->data[$offset];
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getPath() {
-		return $this->path;
-	}
-
-	/**
-	 * @return \OCP\Files\Storage
-	 */
-	public function getStorage() {
-		return $this->storage;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getInternalPath() {
-		return $this->internalPath;
-	}
-
-	/**
-	 * Get FileInfo ID or null in case of part file
-	 *
-	 * @return int|null
-	 */
-	public function getId() {
-		return isset($this->data['fileid']) ? (int)  $this->data['fileid'] : null;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getMimetype() {
-		return $this->data['mimetype'];
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getMimePart() {
-		return $this->data['mimepart'];
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getName() {
-		return basename($this->getPath());
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getEtag() {
-		$this->updateEntryfromSubMounts();
-		if (count($this->childEtags) > 0) {
-			$combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags);
-			return md5($combinedEtag);
-		} else {
-			return $this->data['etag'];
-		}
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getSize() {
-		$this->updateEntryfromSubMounts();
-		return isset($this->data['size']) ? (int) $this->data['size'] : 0;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getMTime() {
-		$this->updateEntryfromSubMounts();
-		return (int) $this->data['mtime'];
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isEncrypted() {
-		return $this->data['encrypted'];
-	}
-
-	/**
-	 * Return the currently version used for the HMAC in the encryption app
-	 *
-	 * @return int
-	 */
-	public function getEncryptedVersion() {
-		return isset($this->data['encryptedVersion']) ? (int) $this->data['encryptedVersion'] : 1;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getPermissions() {
-		$perms = (int) $this->data['permissions'];
-		if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) {
-			$perms = $perms & ~\OCP\Constants::PERMISSION_SHARE;
-		}
-		return (int) $perms;
-	}
-
-	/**
-	 * @return \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER
-	 */
-	public function getType() {
-		if (!isset($this->data['type'])) {
-			$this->data['type'] = ($this->getMimetype() === 'httpd/unix-directory') ? self::TYPE_FOLDER : self::TYPE_FILE;
-		}
-		return $this->data['type'];
-	}
-
-	public function getData() {
-		return $this->data;
-	}
-
-	/**
-	 * @param int $permissions
-	 * @return bool
-	 */
-	protected function checkPermissions($permissions) {
-		return ($this->getPermissions() & $permissions) === $permissions;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isReadable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_READ);
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isUpdateable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE);
-	}
-
-	/**
-	 * Check whether new files or folders can be created inside this folder
-	 *
-	 * @return bool
-	 */
-	public function isCreatable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_CREATE);
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isDeletable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_DELETE);
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isShareable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_SHARE);
-	}
-
-	/**
-	 * Check if a file or folder is shared
-	 *
-	 * @return bool
-	 */
-	public function isShared() {
-		$sid = $this->getStorage()->getId();
-		if (!is_null($sid)) {
-			$sid = explode(':', $sid);
-			return ($sid[0] === 'shared');
-		}
-
-		return false;
-	}
-
-	public function isMounted() {
-		$storage = $this->getStorage();
-		if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
-			return false;
-		}
-		$sid = $storage->getId();
-		if (!is_null($sid)) {
-			$sid = explode(':', $sid);
-			return ($sid[0] !== 'home' and $sid[0] !== 'shared');
-		}
-
-		return false;
-	}
-
-	/**
-	 * Get the mountpoint the file belongs to
-	 *
-	 * @return \OCP\Files\Mount\IMountPoint
-	 */
-	public function getMountPoint() {
-		return $this->mount;
-	}
-
-	/**
-	 * Get the owner of the file
-	 *
-	 * @return \OCP\IUser
-	 */
-	public function getOwner() {
-		return $this->owner;
-	}
-
-	/**
-	 * @param IMountPoint[] $mounts
-	 */
-	public function setSubMounts(array $mounts) {
-		$this->subMounts = $mounts;
-	}
-
-	private function updateEntryfromSubMounts() {
-		if ($this->subMountsUsed) {
-			return;
-		}
-		$this->subMountsUsed = true;
-		foreach ($this->subMounts as $mount) {
-			$subStorage = $mount->getStorage();
-			if ($subStorage) {
-				$subCache = $subStorage->getCache('');
-				$rootEntry = $subCache->get('');
-				$this->addSubEntry($rootEntry, $mount->getMountPoint());
-			}
-		}
-	}
-
-	/**
-	 * Add a cache entry which is the child of this folder
-	 *
-	 * Sets the size, etag and size to for cross-storage childs
-	 *
-	 * @param array|ICacheEntry $data cache entry for the child
-	 * @param string $entryPath full path of the child entry
-	 */
-	public function addSubEntry($data, $entryPath) {
-		$this->data['size'] += isset($data['size']) ? $data['size'] : 0;
-		if (isset($data['mtime'])) {
-			$this->data['mtime'] = max($this->data['mtime'], $data['mtime']);
-		}
-		if (isset($data['etag'])) {
-			// prefix the etag with the relative path of the subentry to propagate etag on mount moves
-			$relativeEntryPath = substr($entryPath, strlen($this->getPath()));
-			// attach the permissions to propagate etag on permision changes of submounts
-			$permissions = isset($data['permissions']) ? $data['permissions'] : 0;
-			$this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions;
-		}
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getChecksum() {
-		return $this->data['checksum'];
-	}
+    /**
+     * @var array $data
+     */
+    private $data;
+
+    /**
+     * @var string $path
+     */
+    private $path;
+
+    /**
+     * @var \OC\Files\Storage\Storage $storage
+     */
+    private $storage;
+
+    /**
+     * @var string $internalPath
+     */
+    private $internalPath;
+
+    /**
+     * @var \OCP\Files\Mount\IMountPoint
+     */
+    private $mount;
+
+    /**
+     * @var IUser
+     */
+    private $owner;
+
+    /**
+     * @var string[]
+     */
+    private $childEtags = [];
+
+    /**
+     * @var IMountPoint[]
+     */
+    private $subMounts = [];
+
+    private $subMountsUsed = false;
+
+    /**
+     * @param string|boolean $path
+     * @param Storage\Storage $storage
+     * @param string $internalPath
+     * @param array|ICacheEntry $data
+     * @param \OCP\Files\Mount\IMountPoint $mount
+     * @param \OCP\IUser|null $owner
+     */
+    public function __construct($path, $storage, $internalPath, $data, $mount, $owner= null) {
+        $this->path = $path;
+        $this->storage = $storage;
+        $this->internalPath = $internalPath;
+        $this->data = $data;
+        $this->mount = $mount;
+        $this->owner = $owner;
+    }
+
+    public function offsetSet($offset, $value) {
+        $this->data[$offset] = $value;
+    }
+
+    public function offsetExists($offset) {
+        return isset($this->data[$offset]);
+    }
+
+    public function offsetUnset($offset) {
+        unset($this->data[$offset]);
+    }
+
+    public function offsetGet($offset) {
+        if ($offset === 'type') {
+            return $this->getType();
+        } else if ($offset === 'etag') {
+            return $this->getEtag();
+        } else if ($offset === 'size') {
+            return $this->getSize();
+        } else if ($offset === 'mtime') {
+            return $this->getMTime();
+        } elseif ($offset === 'permissions') {
+            return $this->getPermissions();
+        } elseif (isset($this->data[$offset])) {
+            return $this->data[$offset];
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public function getPath() {
+        return $this->path;
+    }
+
+    /**
+     * @return \OCP\Files\Storage
+     */
+    public function getStorage() {
+        return $this->storage;
+    }
+
+    /**
+     * @return string
+     */
+    public function getInternalPath() {
+        return $this->internalPath;
+    }
+
+    /**
+     * Get FileInfo ID or null in case of part file
+     *
+     * @return int|null
+     */
+    public function getId() {
+        return isset($this->data['fileid']) ? (int)  $this->data['fileid'] : null;
+    }
+
+    /**
+     * @return string
+     */
+    public function getMimetype() {
+        return $this->data['mimetype'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getMimePart() {
+        return $this->data['mimepart'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getName() {
+        return basename($this->getPath());
+    }
+
+    /**
+     * @return string
+     */
+    public function getEtag() {
+        $this->updateEntryfromSubMounts();
+        if (count($this->childEtags) > 0) {
+            $combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags);
+            return md5($combinedEtag);
+        } else {
+            return $this->data['etag'];
+        }
+    }
+
+    /**
+     * @return int
+     */
+    public function getSize() {
+        $this->updateEntryfromSubMounts();
+        return isset($this->data['size']) ? (int) $this->data['size'] : 0;
+    }
+
+    /**
+     * @return int
+     */
+    public function getMTime() {
+        $this->updateEntryfromSubMounts();
+        return (int) $this->data['mtime'];
+    }
+
+    /**
+     * @return bool
+     */
+    public function isEncrypted() {
+        return $this->data['encrypted'];
+    }
+
+    /**
+     * Return the currently version used for the HMAC in the encryption app
+     *
+     * @return int
+     */
+    public function getEncryptedVersion() {
+        return isset($this->data['encryptedVersion']) ? (int) $this->data['encryptedVersion'] : 1;
+    }
+
+    /**
+     * @return int
+     */
+    public function getPermissions() {
+        $perms = (int) $this->data['permissions'];
+        if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) {
+            $perms = $perms & ~\OCP\Constants::PERMISSION_SHARE;
+        }
+        return (int) $perms;
+    }
+
+    /**
+     * @return \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER
+     */
+    public function getType() {
+        if (!isset($this->data['type'])) {
+            $this->data['type'] = ($this->getMimetype() === 'httpd/unix-directory') ? self::TYPE_FOLDER : self::TYPE_FILE;
+        }
+        return $this->data['type'];
+    }
+
+    public function getData() {
+        return $this->data;
+    }
+
+    /**
+     * @param int $permissions
+     * @return bool
+     */
+    protected function checkPermissions($permissions) {
+        return ($this->getPermissions() & $permissions) === $permissions;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isReadable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_READ);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isUpdateable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE);
+    }
+
+    /**
+     * Check whether new files or folders can be created inside this folder
+     *
+     * @return bool
+     */
+    public function isCreatable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_CREATE);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isDeletable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_DELETE);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isShareable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_SHARE);
+    }
+
+    /**
+     * Check if a file or folder is shared
+     *
+     * @return bool
+     */
+    public function isShared() {
+        $sid = $this->getStorage()->getId();
+        if (!is_null($sid)) {
+            $sid = explode(':', $sid);
+            return ($sid[0] === 'shared');
+        }
+
+        return false;
+    }
+
+    public function isMounted() {
+        $storage = $this->getStorage();
+        if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
+            return false;
+        }
+        $sid = $storage->getId();
+        if (!is_null($sid)) {
+            $sid = explode(':', $sid);
+            return ($sid[0] !== 'home' and $sid[0] !== 'shared');
+        }
+
+        return false;
+    }
+
+    /**
+     * Get the mountpoint the file belongs to
+     *
+     * @return \OCP\Files\Mount\IMountPoint
+     */
+    public function getMountPoint() {
+        return $this->mount;
+    }
+
+    /**
+     * Get the owner of the file
+     *
+     * @return \OCP\IUser
+     */
+    public function getOwner() {
+        return $this->owner;
+    }
+
+    /**
+     * @param IMountPoint[] $mounts
+     */
+    public function setSubMounts(array $mounts) {
+        $this->subMounts = $mounts;
+    }
+
+    private function updateEntryfromSubMounts() {
+        if ($this->subMountsUsed) {
+            return;
+        }
+        $this->subMountsUsed = true;
+        foreach ($this->subMounts as $mount) {
+            $subStorage = $mount->getStorage();
+            if ($subStorage) {
+                $subCache = $subStorage->getCache('');
+                $rootEntry = $subCache->get('');
+                $this->addSubEntry($rootEntry, $mount->getMountPoint());
+            }
+        }
+    }
+
+    /**
+     * Add a cache entry which is the child of this folder
+     *
+     * Sets the size, etag and size to for cross-storage childs
+     *
+     * @param array|ICacheEntry $data cache entry for the child
+     * @param string $entryPath full path of the child entry
+     */
+    public function addSubEntry($data, $entryPath) {
+        $this->data['size'] += isset($data['size']) ? $data['size'] : 0;
+        if (isset($data['mtime'])) {
+            $this->data['mtime'] = max($this->data['mtime'], $data['mtime']);
+        }
+        if (isset($data['etag'])) {
+            // prefix the etag with the relative path of the subentry to propagate etag on mount moves
+            $relativeEntryPath = substr($entryPath, strlen($this->getPath()));
+            // attach the permissions to propagate etag on permision changes of submounts
+            $permissions = isset($data['permissions']) ? $data['permissions'] : 0;
+            $this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions;
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getChecksum() {
+        return $this->data['checksum'];
+    }
 }

Spacing +4 added lines, -4 removed lines

@@ -87,7 +87,7 @@ 
 	 * @param \OCP\Files\Mount\IMountPoint $mount
 	 * @param \OCP\IUser|null $owner
 	 */
-	public function __construct($path, $storage, $internalPath, $data, $mount, $owner= null) {
+	public function __construct($path, $storage, $internalPath, $data, $mount, $owner = null) {
 		$this->path = $path;
 		$this->storage = $storage;
 		$this->internalPath = $internalPath;
@@ -153,7 +153,7 @@ 
 	 * @return int|null
 	 */
 	public function getId() {
-		return isset($this->data['fileid']) ? (int)  $this->data['fileid'] : null;
+		return isset($this->data['fileid']) ? (int) $this->data['fileid'] : null;
 	}
 
 	/**
@@ -183,7 +183,7 @@ 
 	public function getEtag() {
 		$this->updateEntryfromSubMounts();
 		if (count($this->childEtags) > 0) {
-			$combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags);
+			$combinedEtag = $this->data['etag'].'::'.implode('::', $this->childEtags);
 			return md5($combinedEtag);
 		} else {
 			return $this->data['etag'];
@@ -379,7 +379,7 @@ 
 			$relativeEntryPath = substr($entryPath, strlen($this->getPath()));
 			// attach the permissions to propagate etag on permision changes of submounts
 			$permissions = isset($data['permissions']) ? $data['permissions'] : 0;
-			$this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions;
+			$this->childEtags[] = $relativeEntryPath.'/'.$data['etag'].$permissions;
 		}
 	}
 

lib/private/Group/Manager.php

Doc Comments +1 added lines, -1 removed lines

@@ -156,7 +156,7 @@
 	/**
 	 * @param string $gid
 	 * @param string $displayName
-	 * @return \OCP\IGroup
+	 * @return null|Group
 	 */
 	protected function getGroupObject($gid, $displayName = null) {
 		$backends = array();

Indentation +318 added lines, -318 removed lines

@@ -58,323 +58,323 @@
  * @package OC\Group
  */
 class Manager extends PublicEmitter implements IGroupManager {
-	/**
-	 * @var GroupInterface[] $backends
-	 */
-	private $backends = array();
-
-	/**
-	 * @var \OC\User\Manager $userManager
-	 */
-	private $userManager;
-
-	/**
-	 * @var \OC\Group\Group[]
-	 */
-	private $cachedGroups = array();
-
-	/**
-	 * @var \OC\Group\Group[]
-	 */
-	private $cachedUserGroups = array();
-
-	/** @var \OC\SubAdmin */
-	private $subAdmin = null;
-
-	/** @var ILogger */
-	private $logger;
-
-	/**
-	 * @param \OC\User\Manager $userManager
-	 * @param ILogger $logger
-	 */
-	public function __construct(\OC\User\Manager $userManager, ILogger $logger) {
-		$this->userManager = $userManager;
-		$this->logger = $logger;
-		$cachedGroups = & $this->cachedGroups;
-		$cachedUserGroups = & $this->cachedUserGroups;
-		$this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
-			/**
-			 * @var \OC\Group\Group $group
-			 */
-			unset($cachedGroups[$group->getGID()]);
-			$cachedUserGroups = array();
-		});
-		$this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
-			/**
-			 * @var \OC\Group\Group $group
-			 */
-			$cachedUserGroups = array();
-		});
-		$this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
-			/**
-			 * @var \OC\Group\Group $group
-			 */
-			$cachedUserGroups = array();
-		});
-	}
-
-	/**
-	 * Checks whether a given backend is used
-	 *
-	 * @param string $backendClass Full classname including complete namespace
-	 * @return bool
-	 */
-	public function isBackendUsed($backendClass) {
-		$backendClass = strtolower(ltrim($backendClass, '\\'));
-
-		foreach ($this->backends as $backend) {
-			if (strtolower(get_class($backend)) === $backendClass) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * @param \OCP\GroupInterface $backend
-	 */
-	public function addBackend($backend) {
-		$this->backends[] = $backend;
-		$this->clearCaches();
-	}
-
-	public function clearBackends() {
-		$this->backends = array();
-		$this->clearCaches();
-	}
+    /**
+     * @var GroupInterface[] $backends
+     */
+    private $backends = array();
+
+    /**
+     * @var \OC\User\Manager $userManager
+     */
+    private $userManager;
+
+    /**
+     * @var \OC\Group\Group[]
+     */
+    private $cachedGroups = array();
+
+    /**
+     * @var \OC\Group\Group[]
+     */
+    private $cachedUserGroups = array();
+
+    /** @var \OC\SubAdmin */
+    private $subAdmin = null;
+
+    /** @var ILogger */
+    private $logger;
+
+    /**
+     * @param \OC\User\Manager $userManager
+     * @param ILogger $logger
+     */
+    public function __construct(\OC\User\Manager $userManager, ILogger $logger) {
+        $this->userManager = $userManager;
+        $this->logger = $logger;
+        $cachedGroups = & $this->cachedGroups;
+        $cachedUserGroups = & $this->cachedUserGroups;
+        $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
+            /**
+             * @var \OC\Group\Group $group
+             */
+            unset($cachedGroups[$group->getGID()]);
+            $cachedUserGroups = array();
+        });
+        $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
+            /**
+             * @var \OC\Group\Group $group
+             */
+            $cachedUserGroups = array();
+        });
+        $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
+            /**
+             * @var \OC\Group\Group $group
+             */
+            $cachedUserGroups = array();
+        });
+    }
+
+    /**
+     * Checks whether a given backend is used
+     *
+     * @param string $backendClass Full classname including complete namespace
+     * @return bool
+     */
+    public function isBackendUsed($backendClass) {
+        $backendClass = strtolower(ltrim($backendClass, '\\'));
+
+        foreach ($this->backends as $backend) {
+            if (strtolower(get_class($backend)) === $backendClass) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param \OCP\GroupInterface $backend
+     */
+    public function addBackend($backend) {
+        $this->backends[] = $backend;
+        $this->clearCaches();
+    }
+
+    public function clearBackends() {
+        $this->backends = array();
+        $this->clearCaches();
+    }
 	
-	protected function clearCaches() {
-		$this->cachedGroups = array();
-		$this->cachedUserGroups = array();
-	}
-
-	/**
-	 * @param string $gid
-	 * @return \OC\Group\Group
-	 */
-	public function get($gid) {
-		if (isset($this->cachedGroups[$gid])) {
-			return $this->cachedGroups[$gid];
-		}
-		return $this->getGroupObject($gid);
-	}
-
-	/**
-	 * @param string $gid
-	 * @param string $displayName
-	 * @return \OCP\IGroup
-	 */
-	protected function getGroupObject($gid, $displayName = null) {
-		$backends = array();
-		foreach ($this->backends as $backend) {
-			if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) {
-				$groupData = $backend->getGroupDetails($gid);
-				if (is_array($groupData)) {
-					// take the display name from the first backend that has a non-null one
-					if (is_null($displayName) && isset($groupData['displayName'])) {
-						$displayName = $groupData['displayName'];
-					}
-					$backends[] = $backend;
-				}
-			} else if ($backend->groupExists($gid)) {
-				$backends[] = $backend;
-			}
-		}
-		if (count($backends) === 0) {
-			return null;
-		}
-		$this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName);
-		return $this->cachedGroups[$gid];
-	}
-
-	/**
-	 * @param string $gid
-	 * @return bool
-	 */
-	public function groupExists($gid) {
-		return $this->get($gid) instanceof IGroup;
-	}
-
-	/**
-	 * @param string $gid
-	 * @return \OC\Group\Group
-	 */
-	public function createGroup($gid) {
-		if ($gid === '' || $gid === null) {
-			return false;
-		} else if ($group = $this->get($gid)) {
-			return $group;
-		} else {
-			$this->emit('\OC\Group', 'preCreate', array($gid));
-			foreach ($this->backends as $backend) {
-				if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) {
-					$backend->createGroup($gid);
-					$group = $this->getGroupObject($gid);
-					$this->emit('\OC\Group', 'postCreate', array($group));
-					return $group;
-				}
-			}
-			return null;
-		}
-	}
-
-	/**
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OC\Group\Group[]
-	 */
-	public function search($search, $limit = null, $offset = null) {
-		$groups = array();
-		foreach ($this->backends as $backend) {
-			$groupIds = $backend->getGroups($search, $limit, $offset);
-			foreach ($groupIds as $groupId) {
-				$aGroup = $this->get($groupId);
-				if ($aGroup instanceof IGroup) {
-					$groups[$groupId] = $aGroup;
-				} else {
-					$this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']);
-				}
-			}
-			if (!is_null($limit) and $limit <= 0) {
-				return array_values($groups);
-			}
-		}
-		return array_values($groups);
-	}
-
-	/**
-	 * @param \OC\User\User|null $user
-	 * @return \OC\Group\Group[]
-	 */
-	public function getUserGroups($user) {
-		if (!$user instanceof IUser) {
-			return [];
-		}
-		return $this->getUserIdGroups($user->getUID());
-	}
-
-	/**
-	 * @param string $uid the user id
-	 * @return \OC\Group\Group[]
-	 */
-	public function getUserIdGroups($uid) {
-		if (isset($this->cachedUserGroups[$uid])) {
-			return $this->cachedUserGroups[$uid];
-		}
-		$groups = array();
-		foreach ($this->backends as $backend) {
-			$groupIds = $backend->getUserGroups($uid);
-			if (is_array($groupIds)) {
-				foreach ($groupIds as $groupId) {
-					$aGroup = $this->get($groupId);
-					if ($aGroup instanceof IGroup) {
-						$groups[$groupId] = $aGroup;
-					} else {
-						$this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']);
-					}
-				}
-			}
-		}
-		$this->cachedUserGroups[$uid] = $groups;
-		return $this->cachedUserGroups[$uid];
-	}
-
-	/**
-	 * Checks if a userId is in the admin group
-	 * @param string $userId
-	 * @return bool if admin
-	 */
-	public function isAdmin($userId) {
-		return $this->isInGroup($userId, 'admin');
-	}
-
-	/**
-	 * Checks if a userId is in a group
-	 * @param string $userId
-	 * @param string $group
-	 * @return bool if in group
-	 */
-	public function isInGroup($userId, $group) {
-		return array_key_exists($group, $this->getUserIdGroups($userId));
-	}
-
-	/**
-	 * get a list of group ids for a user
-	 * @param \OC\User\User $user
-	 * @return array with group ids
-	 */
-	public function getUserGroupIds($user) {
-		return array_map(function($value) {
-			return (string) $value;
-		}, array_keys($this->getUserGroups($user)));
-	}
-
-	/**
-	 * get a list of all display names in a group
-	 * @param string $gid
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of display names (value) and user ids (key)
-	 */
-	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
-		$group = $this->get($gid);
-		if(is_null($group)) {
-			return array();
-		}
-
-		$search = trim($search);
-		$groupUsers = array();
-
-		if(!empty($search)) {
-			// only user backends have the capability to do a complex search for users
-			$searchOffset = 0;
-			$searchLimit = $limit * 100;
-			if($limit === -1) {
-				$searchLimit = 500;
-			}
-
-			do {
-				$filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
-				foreach($filteredUsers as $filteredUser) {
-					if($group->inGroup($filteredUser)) {
-						$groupUsers[]= $filteredUser;
-					}
-				}
-				$searchOffset += $searchLimit;
-			} while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
-
-			if($limit === -1) {
-				$groupUsers = array_slice($groupUsers, $offset);
-			} else {
-				$groupUsers = array_slice($groupUsers, $offset, $limit);
-			}
-		} else {
-			$groupUsers = $group->searchUsers('', $limit, $offset);
-		}
-
-		$matchingUsers = array();
-		foreach($groupUsers as $groupUser) {
-			$matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
-		}
-		return $matchingUsers;
-	}
-
-	/**
-	 * @return \OC\SubAdmin
-	 */
-	public function getSubAdmin() {
-		if (!$this->subAdmin) {
-			$this->subAdmin = new \OC\SubAdmin(
-				$this->userManager,
-				$this,
-				\OC::$server->getDatabaseConnection()
-			);
-		}
-
-		return $this->subAdmin;
-	}
+    protected function clearCaches() {
+        $this->cachedGroups = array();
+        $this->cachedUserGroups = array();
+    }
+
+    /**
+     * @param string $gid
+     * @return \OC\Group\Group
+     */
+    public function get($gid) {
+        if (isset($this->cachedGroups[$gid])) {
+            return $this->cachedGroups[$gid];
+        }
+        return $this->getGroupObject($gid);
+    }
+
+    /**
+     * @param string $gid
+     * @param string $displayName
+     * @return \OCP\IGroup
+     */
+    protected function getGroupObject($gid, $displayName = null) {
+        $backends = array();
+        foreach ($this->backends as $backend) {
+            if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) {
+                $groupData = $backend->getGroupDetails($gid);
+                if (is_array($groupData)) {
+                    // take the display name from the first backend that has a non-null one
+                    if (is_null($displayName) && isset($groupData['displayName'])) {
+                        $displayName = $groupData['displayName'];
+                    }
+                    $backends[] = $backend;
+                }
+            } else if ($backend->groupExists($gid)) {
+                $backends[] = $backend;
+            }
+        }
+        if (count($backends) === 0) {
+            return null;
+        }
+        $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName);
+        return $this->cachedGroups[$gid];
+    }
+
+    /**
+     * @param string $gid
+     * @return bool
+     */
+    public function groupExists($gid) {
+        return $this->get($gid) instanceof IGroup;
+    }
+
+    /**
+     * @param string $gid
+     * @return \OC\Group\Group
+     */
+    public function createGroup($gid) {
+        if ($gid === '' || $gid === null) {
+            return false;
+        } else if ($group = $this->get($gid)) {
+            return $group;
+        } else {
+            $this->emit('\OC\Group', 'preCreate', array($gid));
+            foreach ($this->backends as $backend) {
+                if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) {
+                    $backend->createGroup($gid);
+                    $group = $this->getGroupObject($gid);
+                    $this->emit('\OC\Group', 'postCreate', array($group));
+                    return $group;
+                }
+            }
+            return null;
+        }
+    }
+
+    /**
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return \OC\Group\Group[]
+     */
+    public function search($search, $limit = null, $offset = null) {
+        $groups = array();
+        foreach ($this->backends as $backend) {
+            $groupIds = $backend->getGroups($search, $limit, $offset);
+            foreach ($groupIds as $groupId) {
+                $aGroup = $this->get($groupId);
+                if ($aGroup instanceof IGroup) {
+                    $groups[$groupId] = $aGroup;
+                } else {
+                    $this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']);
+                }
+            }
+            if (!is_null($limit) and $limit <= 0) {
+                return array_values($groups);
+            }
+        }
+        return array_values($groups);
+    }
+
+    /**
+     * @param \OC\User\User|null $user
+     * @return \OC\Group\Group[]
+     */
+    public function getUserGroups($user) {
+        if (!$user instanceof IUser) {
+            return [];
+        }
+        return $this->getUserIdGroups($user->getUID());
+    }
+
+    /**
+     * @param string $uid the user id
+     * @return \OC\Group\Group[]
+     */
+    public function getUserIdGroups($uid) {
+        if (isset($this->cachedUserGroups[$uid])) {
+            return $this->cachedUserGroups[$uid];
+        }
+        $groups = array();
+        foreach ($this->backends as $backend) {
+            $groupIds = $backend->getUserGroups($uid);
+            if (is_array($groupIds)) {
+                foreach ($groupIds as $groupId) {
+                    $aGroup = $this->get($groupId);
+                    if ($aGroup instanceof IGroup) {
+                        $groups[$groupId] = $aGroup;
+                    } else {
+                        $this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']);
+                    }
+                }
+            }
+        }
+        $this->cachedUserGroups[$uid] = $groups;
+        return $this->cachedUserGroups[$uid];
+    }
+
+    /**
+     * Checks if a userId is in the admin group
+     * @param string $userId
+     * @return bool if admin
+     */
+    public function isAdmin($userId) {
+        return $this->isInGroup($userId, 'admin');
+    }
+
+    /**
+     * Checks if a userId is in a group
+     * @param string $userId
+     * @param string $group
+     * @return bool if in group
+     */
+    public function isInGroup($userId, $group) {
+        return array_key_exists($group, $this->getUserIdGroups($userId));
+    }
+
+    /**
+     * get a list of group ids for a user
+     * @param \OC\User\User $user
+     * @return array with group ids
+     */
+    public function getUserGroupIds($user) {
+        return array_map(function($value) {
+            return (string) $value;
+        }, array_keys($this->getUserGroups($user)));
+    }
+
+    /**
+     * get a list of all display names in a group
+     * @param string $gid
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of display names (value) and user ids (key)
+     */
+    public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
+        $group = $this->get($gid);
+        if(is_null($group)) {
+            return array();
+        }
+
+        $search = trim($search);
+        $groupUsers = array();
+
+        if(!empty($search)) {
+            // only user backends have the capability to do a complex search for users
+            $searchOffset = 0;
+            $searchLimit = $limit * 100;
+            if($limit === -1) {
+                $searchLimit = 500;
+            }
+
+            do {
+                $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
+                foreach($filteredUsers as $filteredUser) {
+                    if($group->inGroup($filteredUser)) {
+                        $groupUsers[]= $filteredUser;
+                    }
+                }
+                $searchOffset += $searchLimit;
+            } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
+
+            if($limit === -1) {
+                $groupUsers = array_slice($groupUsers, $offset);
+            } else {
+                $groupUsers = array_slice($groupUsers, $offset, $limit);
+            }
+        } else {
+            $groupUsers = $group->searchUsers('', $limit, $offset);
+        }
+
+        $matchingUsers = array();
+        foreach($groupUsers as $groupUser) {
+            $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
+        }
+        return $matchingUsers;
+    }
+
+    /**
+     * @return \OC\SubAdmin
+     */
+    public function getSubAdmin() {
+        if (!$this->subAdmin) {
+            $this->subAdmin = new \OC\SubAdmin(
+                $this->userManager,
+                $this,
+                \OC::$server->getDatabaseConnection()
+            );
+        }
+
+        return $this->subAdmin;
+    }
 }

Spacing +14 added lines, -14 removed lines

@@ -93,20 +93,20 @@ 
 		$this->logger = $logger;
 		$cachedGroups = & $this->cachedGroups;
 		$cachedUserGroups = & $this->cachedUserGroups;
-		$this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
+		$this->listen('\OC\Group', 'postDelete', function($group) use (&$cachedGroups, &$cachedUserGroups) {
 			/**
 			 * @var \OC\Group\Group $group
 			 */
 			unset($cachedGroups[$group->getGID()]);
 			$cachedUserGroups = array();
 		});
-		$this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
+		$this->listen('\OC\Group', 'postAddUser', function($group) use (&$cachedUserGroups) {
 			/**
 			 * @var \OC\Group\Group $group
 			 */
 			$cachedUserGroups = array();
 		});
-		$this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
+		$this->listen('\OC\Group', 'postRemoveUser', function($group) use (&$cachedUserGroups) {
 			/**
 			 * @var \OC\Group\Group $group
 			 */
@@ -235,7 +235,7 @@ 
 				if ($aGroup instanceof IGroup) {
 					$groups[$groupId] = $aGroup;
 				} else {
-					$this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']);
+					$this->logger->debug('Group "'.$groupId.'" was returned by search but not found through direct access', ['app' => 'core']);
 				}
 			}
 			if (!is_null($limit) and $limit <= 0) {
@@ -273,7 +273,7 @@ 
 					if ($aGroup instanceof IGroup) {
 						$groups[$groupId] = $aGroup;
 					} else {
-						$this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']);
+						$this->logger->debug('User "'.$uid.'" belongs to deleted group: "'.$groupId.'"', ['app' => 'core']);
 					}
 				}
 			}
@@ -322,32 +322,32 @@ 
 	 */
 	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
 		$group = $this->get($gid);
-		if(is_null($group)) {
+		if (is_null($group)) {
 			return array();
 		}
 
 		$search = trim($search);
 		$groupUsers = array();
 
-		if(!empty($search)) {
+		if (!empty($search)) {
 			// only user backends have the capability to do a complex search for users
 			$searchOffset = 0;
 			$searchLimit = $limit * 100;
-			if($limit === -1) {
+			if ($limit === -1) {
 				$searchLimit = 500;
 			}
 
 			do {
 				$filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
-				foreach($filteredUsers as $filteredUser) {
-					if($group->inGroup($filteredUser)) {
-						$groupUsers[]= $filteredUser;
+				foreach ($filteredUsers as $filteredUser) {
+					if ($group->inGroup($filteredUser)) {
+						$groupUsers[] = $filteredUser;
 					}
 				}
 				$searchOffset += $searchLimit;
-			} while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
+			} while (count($groupUsers) < $searchLimit + $offset && count($filteredUsers) >= $searchLimit);
 
-			if($limit === -1) {
+			if ($limit === -1) {
 				$groupUsers = array_slice($groupUsers, $offset);
 			} else {
 				$groupUsers = array_slice($groupUsers, $offset, $limit);
@@ -357,7 +357,7 @@ 
 		}
 
 		$matchingUsers = array();
-		foreach($groupUsers as $groupUser) {
+		foreach ($groupUsers as $groupUser) {
 			$matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
 		}
 		return $matchingUsers;