nextcloud / server

apps/files_sharing/lib/SharedStorage.php

Unused Use Statements -1 removed lines

@@ -32,7 +32,6 @@
 namespace OCA\Files_Sharing;
 
 use OC\Files\Filesystem;
-use OC\Files\Cache\FailedCache;
 use OC\Files\Storage\Wrapper\PermissionsMask;
 use OCA\Files_Sharing\ISharedStorage;
 use OC\Files\Storage\FailedStorage;

Indentation +429 added lines, -429 removed lines

@@ -47,433 +47,433 @@
  */
 class SharedStorage extends \OC\Files\Storage\Wrapper\Jail implements ISharedStorage {
 
-	/** @var \OCP\Share\IShare */
-	private $superShare;
-
-	/** @var \OCP\Share\IShare[] */
-	private $groupedShares;
-
-	/**
-	 * @var \OC\Files\View
-	 */
-	private $ownerView;
-
-	private $initialized = false;
-
-	/**
-	 * @var ICacheEntry
-	 */
-	private $sourceRootInfo;
-
-	/** @var string */
-	private $user;
-
-	/**
-	 * @var \OCP\ILogger
-	 */
-	private $logger;
-
-	/** @var  IStorage */
-	private $nonMaskedStorage;
-
-	private $options;
-
-	public function __construct($arguments) {
-		$this->ownerView = $arguments['ownerView'];
-		$this->logger = \OC::$server->getLogger();
-
-		$this->superShare = $arguments['superShare'];
-		$this->groupedShares = $arguments['groupedShares'];
-
-		$this->user = $arguments['user'];
-
-		parent::__construct([
-			'storage' => null,
-			'root' => null,
-		]);
-	}
-
-	/**
-	 * @return ICacheEntry
-	 */
-	private function getSourceRootInfo() {
-		if (is_null($this->sourceRootInfo)) {
-			if (is_null($this->superShare->getNodeCacheEntry())) {
-				$this->sourceRootInfo = $this->nonMaskedStorage->getCache()->get($this->rootPath);
-			} else {
-				$this->sourceRootInfo = $this->superShare->getNodeCacheEntry();
-			}
-		}
-		return $this->sourceRootInfo;
-	}
-
-	private function init() {
-		if ($this->initialized) {
-			return;
-		}
-		$this->initialized = true;
-		try {
-			Filesystem::initMountPoints($this->superShare->getShareOwner());
-			$sourcePath = $this->ownerView->getPath($this->superShare->getNodeId());
-			list($this->nonMaskedStorage, $this->rootPath) = $this->ownerView->resolvePath($sourcePath);
-			$this->storage = new PermissionsMask([
-				'storage' => $this->nonMaskedStorage,
-				'mask' => $this->superShare->getPermissions()
-			]);
-		} catch (NotFoundException $e) {
-			$this->storage = new FailedStorage(['exception' => $e]);
-			$this->rootPath = '';
-		} catch (\Exception $e) {
-			$this->storage = new FailedStorage(['exception' => $e]);
-			$this->rootPath = '';
-			$this->logger->logException($e);
-		}
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function instanceOfStorage($class) {
-		if ($class === '\OC\Files\Storage\Common') {
-			return true;
-		}
-		if (in_array($class, ['\OC\Files\Storage\Home', '\OC\Files\ObjectStore\HomeObjectStoreStorage'])) {
-			return false;
-		}
-		return parent::instanceOfStorage($class);
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getShareId() {
-		return $this->superShare->getId();
-	}
-
-	private function isValid() {
-		return $this->getSourceRootInfo() && ($this->getSourceRootInfo()->getPermissions() & Constants::PERMISSION_SHARE) === Constants::PERMISSION_SHARE;
-	}
-
-	/**
-	 * get id of the mount point
-	 *
-	 * @return string
-	 */
-	public function getId() {
-		return 'shared::' . $this->getMountPoint();
-	}
-
-	/**
-	 * Get the permissions granted for a shared file
-	 *
-	 * @param string $target Shared target file path
-	 * @return int CRUDS permissions granted
-	 */
-	public function getPermissions($target = '') {
-		if (!$this->isValid()) {
-			return 0;
-		}
-		$permissions = $this->superShare->getPermissions();
-		// part files and the mount point always have delete permissions
-		if ($target === '' || pathinfo($target, PATHINFO_EXTENSION) === 'part') {
-			$permissions |= \OCP\Constants::PERMISSION_DELETE;
-		}
-
-		if (\OCP\Util::isSharingDisabledForUser()) {
-			$permissions &= ~\OCP\Constants::PERMISSION_SHARE;
-		}
-
-		return $permissions;
-	}
-
-	public function isCreatable($path) {
-		return ($this->getPermissions($path) & \OCP\Constants::PERMISSION_CREATE);
-	}
-
-	public function isReadable($path) {
-		if (!$this->isValid()) {
-			return false;
-		}
-		if (!$this->file_exists($path)) {
-			return false;
-		}
-		/** @var IStorage $storage */
-		/** @var string $internalPath */
-		list($storage, $internalPath) = $this->resolvePath($path);
-		return $storage->isReadable($internalPath);
-	}
-
-	public function isUpdatable($path) {
-		return ($this->getPermissions($path) & \OCP\Constants::PERMISSION_UPDATE);
-	}
-
-	public function isDeletable($path) {
-		return ($this->getPermissions($path) & \OCP\Constants::PERMISSION_DELETE);
-	}
-
-	public function isSharable($path) {
-		if (\OCP\Util::isSharingDisabledForUser() || !\OC\Share\Share::isResharingAllowed()) {
-			return false;
-		}
-		return ($this->getPermissions($path) & \OCP\Constants::PERMISSION_SHARE);
-	}
-
-	public function fopen($path, $mode) {
-		if ($source = $this->getSourcePath($path)) {
-			switch ($mode) {
-				case 'r+':
-				case 'rb+':
-				case 'w+':
-				case 'wb+':
-				case 'x+':
-				case 'xb+':
-				case 'a+':
-				case 'ab+':
-				case 'w':
-				case 'wb':
-				case 'x':
-				case 'xb':
-				case 'a':
-				case 'ab':
-					$creatable = $this->isCreatable($path);
-					$updatable = $this->isUpdatable($path);
-					// if neither permissions given, no need to continue
-					if (!$creatable && !$updatable) {
-						return false;
-					}
-
-					$exists = $this->file_exists($path);
-					// if a file exists, updatable permissions are required
-					if ($exists && !$updatable) {
-						return false;
-					}
-
-					// part file is allowed if !$creatable but the final file is $updatable
-					if (pathinfo($path, PATHINFO_EXTENSION) !== 'part') {
-						if (!$exists && !$creatable) {
-							return false;
-						}
-					}
-			}
-			$info = array(
-				'target' => $this->getMountPoint() . $path,
-				'source' => $source,
-				'mode' => $mode,
-			);
-			\OCP\Util::emitHook('\OC\Files\Storage\Shared', 'fopen', $info);
-			return $this->nonMaskedStorage->fopen($this->getSourcePath($path), $mode);
-		}
-		return false;
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.rename.php
-	 *
-	 * @param string $path1
-	 * @param string $path2
-	 * @return bool
-	 */
-	public function rename($path1, $path2) {
-		$this->init();
-		$isPartFile = pathinfo($path1, PATHINFO_EXTENSION) === 'part';
-		$targetExists = $this->file_exists($path2);
-		$sameFodler = dirname($path1) === dirname($path2);
-
-		if ($targetExists || ($sameFodler && !$isPartFile)) {
-			if (!$this->isUpdatable('')) {
-				return false;
-			}
-		} else {
-			if (!$this->isCreatable('')) {
-				return false;
-			}
-		}
-
-		return $this->nonMaskedStorage->rename($this->getSourcePath($path1), $this->getSourcePath($path2));
-	}
-
-	/**
-	 * return mount point of share, relative to data/user/files
-	 *
-	 * @return string
-	 */
-	public function getMountPoint() {
-		return $this->superShare->getTarget();
-	}
-
-	/**
-	 * @param string $path
-	 */
-	public function setMountPoint($path) {
-		$this->superShare->setTarget($path);
-
-		foreach ($this->groupedShares as $share) {
-			$share->setTarget($path);
-		}
-	}
-
-	/**
-	 * get the user who shared the file
-	 *
-	 * @return string
-	 */
-	public function getSharedFrom() {
-		return $this->superShare->getShareOwner();
-	}
-
-	/**
-	 * @return \OCP\Share\IShare
-	 */
-	public function getShare() {
-		return $this->superShare;
-	}
-
-	/**
-	 * return share type, can be "file" or "folder"
-	 *
-	 * @return string
-	 */
-	public function getItemType() {
-		return $this->superShare->getNodeType();
-	}
-
-	public function getCache($path = '', $storage = null) {
-		if ($this->cache) {
-			return $this->cache;
-		}
-		if (!$storage) {
-			$storage = $this;
-		}
-		$this->cache = new \OCA\Files_Sharing\Cache($storage, $this->getSourceRootInfo(), $this->superShare);
-		return $this->cache;
-	}
-
-	public function getScanner($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		return new \OCA\Files_Sharing\Scanner($storage);
-	}
-
-	public function getPropagator($storage = null) {
-		if (isset($this->propagator)) {
-			return $this->propagator;
-		}
-
-		if (!$storage) {
-			$storage = $this;
-		}
-		$this->propagator = new \OCA\Files_Sharing\SharedPropagator($storage, \OC::$server->getDatabaseConnection());
-		return $this->propagator;
-	}
-
-	public function getOwner($path) {
-		return $this->superShare->getShareOwner();
-	}
-
-	/**
-	 * unshare complete storage, also the grouped shares
-	 *
-	 * @return bool
-	 */
-	public function unshareStorage() {
-		foreach ($this->groupedShares as $share) {
-			\OC::$server->getShareManager()->deleteFromSelf($share, $this->user);
-		}
-		return true;
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function acquireLock($path, $type, ILockingProvider $provider) {
-		/** @var \OCP\Files\Storage $targetStorage */
-		list($targetStorage, $targetInternalPath) = $this->resolvePath($path);
-		$targetStorage->acquireLock($targetInternalPath, $type, $provider);
-		// lock the parent folders of the owner when locking the share as recipient
-		if ($path === '') {
-			$sourcePath = $this->ownerView->getPath($this->superShare->getNodeId());
-			$this->ownerView->lockFile(dirname($sourcePath), ILockingProvider::LOCK_SHARED, true);
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 */
-	public function releaseLock($path, $type, ILockingProvider $provider) {
-		/** @var \OCP\Files\Storage $targetStorage */
-		list($targetStorage, $targetInternalPath) = $this->resolvePath($path);
-		$targetStorage->releaseLock($targetInternalPath, $type, $provider);
-		// unlock the parent folders of the owner when unlocking the share as recipient
-		if ($path === '') {
-			$sourcePath = $this->ownerView->getPath($this->superShare->getNodeId());
-			$this->ownerView->unlockFile(dirname($sourcePath), ILockingProvider::LOCK_SHARED, true);
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 */
-	public function changeLock($path, $type, ILockingProvider $provider) {
-		/** @var \OCP\Files\Storage $targetStorage */
-		list($targetStorage, $targetInternalPath) = $this->resolvePath($path);
-		$targetStorage->changeLock($targetInternalPath, $type, $provider);
-	}
-
-	/**
-	 * @return array [ available, last_checked ]
-	 */
-	public function getAvailability() {
-		// shares do not participate in availability logic
-		return [
-			'available' => true,
-			'last_checked' => 0
-		];
-	}
-
-	/**
-	 * @param bool $available
-	 */
-	public function setAvailability($available) {
-		// shares do not participate in availability logic
-	}
-
-	public function getSourceStorage() {
-		$this->init();
-		return $this->nonMaskedStorage;
-	}
-
-	public function getWrapperStorage() {
-		$this->init();
-		return $this->storage;
-	}
-
-	public function file_get_contents($path) {
-		$info = [
-			'target' => $this->getMountPoint() . '/' . $path,
-			'source' => $this->getSourcePath($path),
-		];
-		\OCP\Util::emitHook('\OC\Files\Storage\Shared', 'file_get_contents', $info);
-		return parent::file_get_contents($path);
-	}
-
-	public function file_put_contents($path, $data) {
-		$info = [
-			'target' => $this->getMountPoint() . '/' . $path,
-			'source' => $this->getSourcePath($path),
-		];
-		\OCP\Util::emitHook('\OC\Files\Storage\Shared', 'file_put_contents', $info);
-		return parent::file_put_contents($path, $data);
-	}
-
-	public function setMountOptions(array $options) {
-		$this->mountOptions = $options;
-	}
+    /** @var \OCP\Share\IShare */
+    private $superShare;
+
+    /** @var \OCP\Share\IShare[] */
+    private $groupedShares;
+
+    /**
+     * @var \OC\Files\View
+     */
+    private $ownerView;
+
+    private $initialized = false;
+
+    /**
+     * @var ICacheEntry
+     */
+    private $sourceRootInfo;
+
+    /** @var string */
+    private $user;
+
+    /**
+     * @var \OCP\ILogger
+     */
+    private $logger;
+
+    /** @var  IStorage */
+    private $nonMaskedStorage;
+
+    private $options;
+
+    public function __construct($arguments) {
+        $this->ownerView = $arguments['ownerView'];
+        $this->logger = \OC::$server->getLogger();
+
+        $this->superShare = $arguments['superShare'];
+        $this->groupedShares = $arguments['groupedShares'];
+
+        $this->user = $arguments['user'];
+
+        parent::__construct([
+            'storage' => null,
+            'root' => null,
+        ]);
+    }
+
+    /**
+     * @return ICacheEntry
+     */
+    private function getSourceRootInfo() {
+        if (is_null($this->sourceRootInfo)) {
+            if (is_null($this->superShare->getNodeCacheEntry())) {
+                $this->sourceRootInfo = $this->nonMaskedStorage->getCache()->get($this->rootPath);
+            } else {
+                $this->sourceRootInfo = $this->superShare->getNodeCacheEntry();
+            }
+        }
+        return $this->sourceRootInfo;
+    }
+
+    private function init() {
+        if ($this->initialized) {
+            return;
+        }
+        $this->initialized = true;
+        try {
+            Filesystem::initMountPoints($this->superShare->getShareOwner());
+            $sourcePath = $this->ownerView->getPath($this->superShare->getNodeId());
+            list($this->nonMaskedStorage, $this->rootPath) = $this->ownerView->resolvePath($sourcePath);
+            $this->storage = new PermissionsMask([
+                'storage' => $this->nonMaskedStorage,
+                'mask' => $this->superShare->getPermissions()
+            ]);
+        } catch (NotFoundException $e) {
+            $this->storage = new FailedStorage(['exception' => $e]);
+            $this->rootPath = '';
+        } catch (\Exception $e) {
+            $this->storage = new FailedStorage(['exception' => $e]);
+            $this->rootPath = '';
+            $this->logger->logException($e);
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function instanceOfStorage($class) {
+        if ($class === '\OC\Files\Storage\Common') {
+            return true;
+        }
+        if (in_array($class, ['\OC\Files\Storage\Home', '\OC\Files\ObjectStore\HomeObjectStoreStorage'])) {
+            return false;
+        }
+        return parent::instanceOfStorage($class);
+    }
+
+    /**
+     * @return string
+     */
+    public function getShareId() {
+        return $this->superShare->getId();
+    }
+
+    private function isValid() {
+        return $this->getSourceRootInfo() && ($this->getSourceRootInfo()->getPermissions() & Constants::PERMISSION_SHARE) === Constants::PERMISSION_SHARE;
+    }
+
+    /**
+     * get id of the mount point
+     *
+     * @return string
+     */
+    public function getId() {
+        return 'shared::' . $this->getMountPoint();
+    }
+
+    /**
+     * Get the permissions granted for a shared file
+     *
+     * @param string $target Shared target file path
+     * @return int CRUDS permissions granted
+     */
+    public function getPermissions($target = '') {
+        if (!$this->isValid()) {
+            return 0;
+        }
+        $permissions = $this->superShare->getPermissions();
+        // part files and the mount point always have delete permissions
+        if ($target === '' || pathinfo($target, PATHINFO_EXTENSION) === 'part') {
+            $permissions |= \OCP\Constants::PERMISSION_DELETE;
+        }
+
+        if (\OCP\Util::isSharingDisabledForUser()) {
+            $permissions &= ~\OCP\Constants::PERMISSION_SHARE;
+        }
+
+        return $permissions;
+    }
+
+    public function isCreatable($path) {
+        return ($this->getPermissions($path) & \OCP\Constants::PERMISSION_CREATE);
+    }
+
+    public function isReadable($path) {
+        if (!$this->isValid()) {
+            return false;
+        }
+        if (!$this->file_exists($path)) {
+            return false;
+        }
+        /** @var IStorage $storage */
+        /** @var string $internalPath */
+        list($storage, $internalPath) = $this->resolvePath($path);
+        return $storage->isReadable($internalPath);
+    }
+
+    public function isUpdatable($path) {
+        return ($this->getPermissions($path) & \OCP\Constants::PERMISSION_UPDATE);
+    }
+
+    public function isDeletable($path) {
+        return ($this->getPermissions($path) & \OCP\Constants::PERMISSION_DELETE);
+    }
+
+    public function isSharable($path) {
+        if (\OCP\Util::isSharingDisabledForUser() || !\OC\Share\Share::isResharingAllowed()) {
+            return false;
+        }
+        return ($this->getPermissions($path) & \OCP\Constants::PERMISSION_SHARE);
+    }
+
+    public function fopen($path, $mode) {
+        if ($source = $this->getSourcePath($path)) {
+            switch ($mode) {
+                case 'r+':
+                case 'rb+':
+                case 'w+':
+                case 'wb+':
+                case 'x+':
+                case 'xb+':
+                case 'a+':
+                case 'ab+':
+                case 'w':
+                case 'wb':
+                case 'x':
+                case 'xb':
+                case 'a':
+                case 'ab':
+                    $creatable = $this->isCreatable($path);
+                    $updatable = $this->isUpdatable($path);
+                    // if neither permissions given, no need to continue
+                    if (!$creatable && !$updatable) {
+                        return false;
+                    }
+
+                    $exists = $this->file_exists($path);
+                    // if a file exists, updatable permissions are required
+                    if ($exists && !$updatable) {
+                        return false;
+                    }
+
+                    // part file is allowed if !$creatable but the final file is $updatable
+                    if (pathinfo($path, PATHINFO_EXTENSION) !== 'part') {
+                        if (!$exists && !$creatable) {
+                            return false;
+                        }
+                    }
+            }
+            $info = array(
+                'target' => $this->getMountPoint() . $path,
+                'source' => $source,
+                'mode' => $mode,
+            );
+            \OCP\Util::emitHook('\OC\Files\Storage\Shared', 'fopen', $info);
+            return $this->nonMaskedStorage->fopen($this->getSourcePath($path), $mode);
+        }
+        return false;
+    }
+
+    /**
+     * see http://php.net/manual/en/function.rename.php
+     *
+     * @param string $path1
+     * @param string $path2
+     * @return bool
+     */
+    public function rename($path1, $path2) {
+        $this->init();
+        $isPartFile = pathinfo($path1, PATHINFO_EXTENSION) === 'part';
+        $targetExists = $this->file_exists($path2);
+        $sameFodler = dirname($path1) === dirname($path2);
+
+        if ($targetExists || ($sameFodler && !$isPartFile)) {
+            if (!$this->isUpdatable('')) {
+                return false;
+            }
+        } else {
+            if (!$this->isCreatable('')) {
+                return false;
+            }
+        }
+
+        return $this->nonMaskedStorage->rename($this->getSourcePath($path1), $this->getSourcePath($path2));
+    }
+
+    /**
+     * return mount point of share, relative to data/user/files
+     *
+     * @return string
+     */
+    public function getMountPoint() {
+        return $this->superShare->getTarget();
+    }
+
+    /**
+     * @param string $path
+     */
+    public function setMountPoint($path) {
+        $this->superShare->setTarget($path);
+
+        foreach ($this->groupedShares as $share) {
+            $share->setTarget($path);
+        }
+    }
+
+    /**
+     * get the user who shared the file
+     *
+     * @return string
+     */
+    public function getSharedFrom() {
+        return $this->superShare->getShareOwner();
+    }
+
+    /**
+     * @return \OCP\Share\IShare
+     */
+    public function getShare() {
+        return $this->superShare;
+    }
+
+    /**
+     * return share type, can be "file" or "folder"
+     *
+     * @return string
+     */
+    public function getItemType() {
+        return $this->superShare->getNodeType();
+    }
+
+    public function getCache($path = '', $storage = null) {
+        if ($this->cache) {
+            return $this->cache;
+        }
+        if (!$storage) {
+            $storage = $this;
+        }
+        $this->cache = new \OCA\Files_Sharing\Cache($storage, $this->getSourceRootInfo(), $this->superShare);
+        return $this->cache;
+    }
+
+    public function getScanner($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        return new \OCA\Files_Sharing\Scanner($storage);
+    }
+
+    public function getPropagator($storage = null) {
+        if (isset($this->propagator)) {
+            return $this->propagator;
+        }
+
+        if (!$storage) {
+            $storage = $this;
+        }
+        $this->propagator = new \OCA\Files_Sharing\SharedPropagator($storage, \OC::$server->getDatabaseConnection());
+        return $this->propagator;
+    }
+
+    public function getOwner($path) {
+        return $this->superShare->getShareOwner();
+    }
+
+    /**
+     * unshare complete storage, also the grouped shares
+     *
+     * @return bool
+     */
+    public function unshareStorage() {
+        foreach ($this->groupedShares as $share) {
+            \OC::$server->getShareManager()->deleteFromSelf($share, $this->user);
+        }
+        return true;
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     */
+    public function acquireLock($path, $type, ILockingProvider $provider) {
+        /** @var \OCP\Files\Storage $targetStorage */
+        list($targetStorage, $targetInternalPath) = $this->resolvePath($path);
+        $targetStorage->acquireLock($targetInternalPath, $type, $provider);
+        // lock the parent folders of the owner when locking the share as recipient
+        if ($path === '') {
+            $sourcePath = $this->ownerView->getPath($this->superShare->getNodeId());
+            $this->ownerView->lockFile(dirname($sourcePath), ILockingProvider::LOCK_SHARED, true);
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     */
+    public function releaseLock($path, $type, ILockingProvider $provider) {
+        /** @var \OCP\Files\Storage $targetStorage */
+        list($targetStorage, $targetInternalPath) = $this->resolvePath($path);
+        $targetStorage->releaseLock($targetInternalPath, $type, $provider);
+        // unlock the parent folders of the owner when unlocking the share as recipient
+        if ($path === '') {
+            $sourcePath = $this->ownerView->getPath($this->superShare->getNodeId());
+            $this->ownerView->unlockFile(dirname($sourcePath), ILockingProvider::LOCK_SHARED, true);
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     */
+    public function changeLock($path, $type, ILockingProvider $provider) {
+        /** @var \OCP\Files\Storage $targetStorage */
+        list($targetStorage, $targetInternalPath) = $this->resolvePath($path);
+        $targetStorage->changeLock($targetInternalPath, $type, $provider);
+    }
+
+    /**
+     * @return array [ available, last_checked ]
+     */
+    public function getAvailability() {
+        // shares do not participate in availability logic
+        return [
+            'available' => true,
+            'last_checked' => 0
+        ];
+    }
+
+    /**
+     * @param bool $available
+     */
+    public function setAvailability($available) {
+        // shares do not participate in availability logic
+    }
+
+    public function getSourceStorage() {
+        $this->init();
+        return $this->nonMaskedStorage;
+    }
+
+    public function getWrapperStorage() {
+        $this->init();
+        return $this->storage;
+    }
+
+    public function file_get_contents($path) {
+        $info = [
+            'target' => $this->getMountPoint() . '/' . $path,
+            'source' => $this->getSourcePath($path),
+        ];
+        \OCP\Util::emitHook('\OC\Files\Storage\Shared', 'file_get_contents', $info);
+        return parent::file_get_contents($path);
+    }
+
+    public function file_put_contents($path, $data) {
+        $info = [
+            'target' => $this->getMountPoint() . '/' . $path,
+            'source' => $this->getSourcePath($path),
+        ];
+        \OCP\Util::emitHook('\OC\Files\Storage\Shared', 'file_put_contents', $info);
+        return parent::file_put_contents($path, $data);
+    }
+
+    public function setMountOptions(array $options) {
+        $this->mountOptions = $options;
+    }
 }

Spacing +4 added lines, -4 removed lines

@@ -160,7 +160,7 @@ 
 	 * @return string
 	 */
 	public function getId() {
-		return 'shared::' . $this->getMountPoint();
+		return 'shared::'.$this->getMountPoint();
 	}
 
 	/**
@@ -256,7 +256,7 @@ 
 					}
 			}
 			$info = array(
-				'target' => $this->getMountPoint() . $path,
+				'target' => $this->getMountPoint().$path,
 				'source' => $source,
 				'mode' => $mode,
 			);
@@ -457,7 +457,7 @@ 
 
 	public function file_get_contents($path) {
 		$info = [
-			'target' => $this->getMountPoint() . '/' . $path,
+			'target' => $this->getMountPoint().'/'.$path,
 			'source' => $this->getSourcePath($path),
 		];
 		\OCP\Util::emitHook('\OC\Files\Storage\Shared', 'file_get_contents', $info);
@@ -466,7 +466,7 @@ 
 
 	public function file_put_contents($path, $data) {
 		$info = [
-			'target' => $this->getMountPoint() . '/' . $path,
+			'target' => $this->getMountPoint().'/'.$path,
 			'source' => $this->getSourcePath($path),
 		];
 		\OCP\Util::emitHook('\OC\Files\Storage\Shared', 'file_put_contents', $info);

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
 	 */

Indentation +666 added lines, -666 removed lines

@@ -46,670 +46,670 @@
 
 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;
-
-	/**
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param IUserManager $userManager
-	 * @param IConfig $config
-	 * @param IGroupManager $groupManager
-	 * @param IUserSession $userSession
-	 * @param AccountManager $accountManager
-	 * @param ILogger $logger
-	 */
-	public function __construct($appName,
-								IRequest $request,
-								IUserManager $userManager,
-								IConfig $config,
-								IGroupManager $groupManager,
-								IUserSession $userSession,
-								AccountManager $accountManager,
-								ILogger $logger) {
-		parent::__construct($appName, $request);
-
-		$this->userManager = $userManager;
-		$this->config = $config;
-		$this->groupManager = $groupManager;
-		$this->userSession = $userSession;
-		$this->accountManager = $accountManager;
-		$this->logger = $logger;
-	}
-
-	/**
-	 * @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);
-
-		// Find the data
-		$data['id'] = $targetUserObject->getUID();
-		$data['quota'] = $this->fillStorageInfo($userId);
-		$data['email'] = $targetUserObject->getEMailAddress();
-		$data['displayname'] = $targetUserObject->getDisplayName();
-		$data['phone'] = $userAccount[\OC\Accounts\AccountManager::PROPERTY_PHONE]['value'];
-		$data['address'] = $userAccount[\OC\Accounts\AccountManager::PROPERTY_ADDRESS]['value'];
-		$data['webpage'] = $userAccount[\OC\Accounts\AccountManager::PROPERTY_WEBSITE]['value'];
-		$data['twitter'] = $userAccount[\OC\Accounts\AccountManager::PROPERTY_TWITTER]['value'];
-
-		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[] = 'email';
-			$permittedFields[] = 'password';
-			// 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[] = 'quota';
-				$permittedFields[] = 'password';
-				$permittedFields[] = 'email';
-			} 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':
-				$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 'email':
-				if(filter_var($value, FILTER_VALIDATE_EMAIL)) {
-					$targetUser->setEMailAddress($value);
-				} else {
-					throw new OCSException('', 102);
-				}
-				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;
-	}
+    /** @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;
+
+    /**
+     * @param string $appName
+     * @param IRequest $request
+     * @param IUserManager $userManager
+     * @param IConfig $config
+     * @param IGroupManager $groupManager
+     * @param IUserSession $userSession
+     * @param AccountManager $accountManager
+     * @param ILogger $logger
+     */
+    public function __construct($appName,
+                                IRequest $request,
+                                IUserManager $userManager,
+                                IConfig $config,
+                                IGroupManager $groupManager,
+                                IUserSession $userSession,
+                                AccountManager $accountManager,
+                                ILogger $logger) {
+        parent::__construct($appName, $request);
+
+        $this->userManager = $userManager;
+        $this->config = $config;
+        $this->groupManager = $groupManager;
+        $this->userSession = $userSession;
+        $this->accountManager = $accountManager;
+        $this->logger = $logger;
+    }
+
+    /**
+     * @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);
+
+        // Find the data
+        $data['id'] = $targetUserObject->getUID();
+        $data['quota'] = $this->fillStorageInfo($userId);
+        $data['email'] = $targetUserObject->getEMailAddress();
+        $data['displayname'] = $targetUserObject->getDisplayName();
+        $data['phone'] = $userAccount[\OC\Accounts\AccountManager::PROPERTY_PHONE]['value'];
+        $data['address'] = $userAccount[\OC\Accounts\AccountManager::PROPERTY_ADDRESS]['value'];
+        $data['webpage'] = $userAccount[\OC\Accounts\AccountManager::PROPERTY_WEBSITE]['value'];
+        $data['twitter'] = $userAccount[\OC\Accounts\AccountManager::PROPERTY_TWITTER]['value'];
+
+        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[] = 'email';
+            $permittedFields[] = 'password';
+            // 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[] = 'quota';
+                $permittedFields[] = 'password';
+                $permittedFields[] = 'email';
+            } 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':
+                $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 'email':
+                if(filter_var($value, FILTER_VALIDATE_EMAIL)) {
+                    $targetUser->setEMailAddress($value);
+                } else {
+                    throw new OCSException('', 102);
+                }
+                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;
+    }
 }

Spacing +48 added lines, -48 removed lines

@@ -104,7 +104,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);
@@ -112,7 +112,7 @@ 
 				$subAdminOfGroups[$key] = $group->getGID();
 			}
 
-			if($offset === null) {
+			if ($offset === null) {
 				$offset = 0;
 			}
 
@@ -146,22 +146,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);
 			}
 		}
@@ -210,7 +210,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'];
@@ -236,17 +236,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);
 			}
 		}
@@ -284,24 +284,24 @@ 
 		$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[] = 'email';
 			$permittedFields[] = 'password';
 			// 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';
@@ -314,17 +314,17 @@ 
 			}
 		}
 		// 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':
 				$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 {
@@ -333,9 +333,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);
@@ -347,7 +347,7 @@ 
 				$targetUser->setPassword($value);
 				break;
 			case 'email':
-				if(filter_var($value, FILTER_VALIDATE_EMAIL)) {
+				if (filter_var($value, FILTER_VALIDATE_EMAIL)) {
 					$targetUser->setEMailAddress($value);
 				} else {
 					throw new OCSException('', 102);
@@ -373,18 +373,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);
@@ -428,13 +428,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);
 		}
 
@@ -455,11 +455,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)
@@ -468,7 +468,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);
@@ -498,16 +498,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);
 		}
 
@@ -535,17 +535,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);
 		}
 
@@ -569,7 +569,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);
@@ -601,15 +601,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);
 		}
 
@@ -620,7 +620,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);
@@ -643,20 +643,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);
@@ -673,7 +673,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);
 		}
 
@@ -683,7 +683,7 @@ 
 			$groups[$key] = $group->getGID();
 		}
 
-		if(!$groups) {
+		if (!$groups) {
 			throw new OCSException('Unknown error occurred', 102);
 		} else {
 			return new DataResponse($groups);

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);

apps/sharebymail/lib/ShareByMailProvider.php

Doc Comments +11 added lines, -4 removed lines

@@ -185,10 +185,10 @@ 
 	 * publish activity if a file/folder was shared by mail
 	 *
 	 * @param $subject
-	 * @param $parameters
-	 * @param $affectedUser
+	 * @param string[] $parameters
+	 * @param string $affectedUser
 	 * @param $fileId
-	 * @param $filePath
+	 * @param string $filePath
 	 */
 	protected function publishActivity($subject, $parameters, $affectedUser, $fileId, $filePath) {
 		$event = $this->activityManager->generateEvent();
@@ -240,6 +240,12 @@ 
 
 	}
 
+	/**
+	 * @param string $link
+	 * @param string $owner
+	 * @param string $initiator
+	 * @param string $shareWith
+	 */
 	protected function sendMailNotification($filename, $link, $owner, $initiator, $shareWith) {
 		$ownerUser = $this->userManager->get($owner);
 		$initiatorUser = $this->userManager->get($initiator);
@@ -269,6 +275,7 @@ 
 	 * @param $link
 	 * @param $owner
 	 * @param $initiator
+	 * @param string $template
 	 * @return string plain text mail
 	 * @throws HintException
 	 */
@@ -708,7 +715,7 @@ 
 	/**
 	 * get database row of a give share
 	 *
-	 * @param $id
+	 * @param integer $id
 	 * @return array
 	 * @throws ShareNotFound
 	 */

Indentation +716 added lines, -716 removed lines

@@ -48,728 +48,728 @@
  */
 class ShareByMailProvider implements IShareProvider {
 
-	/** @var  IDBConnection */
-	private $dbConnection;
-
-	/** @var ILogger */
-	private $logger;
-
-	/** @var ISecureRandom */
-	private $secureRandom;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IRootFolder */
-	private $rootFolder;
-
-	/** @var IL10N */
-	private $l;
-
-	/** @var IMailer */
-	private $mailer;
-
-	/** @var IURLGenerator */
-	private $urlGenerator;
-
-	/** @var IManager  */
-	private $activityManager;
-
-	/**
-	 * Return the identifier of this provider.
-	 *
-	 * @return string Containing only [a-zA-Z0-9]
-	 */
-	public function identifier() {
-		return 'ocShareByMail';
-	}
-
-	/**
-	 * DefaultShareProvider constructor.
-	 *
-	 * @param IDBConnection $connection
-	 * @param ISecureRandom $secureRandom
-	 * @param IUserManager $userManager
-	 * @param IRootFolder $rootFolder
-	 * @param IL10N $l
-	 * @param ILogger $logger
-	 * @param IMailer $mailer
-	 * @param IURLGenerator $urlGenerator
-	 * @param IManager $activityManager
-	 */
-	public function __construct(
-		IDBConnection $connection,
-		ISecureRandom $secureRandom,
-		IUserManager $userManager,
-		IRootFolder $rootFolder,
-		IL10N $l,
-		ILogger $logger,
-		IMailer $mailer,
-		IURLGenerator $urlGenerator,
-		IManager $activityManager
-	) {
-		$this->dbConnection = $connection;
-		$this->secureRandom = $secureRandom;
-		$this->userManager = $userManager;
-		$this->rootFolder = $rootFolder;
-		$this->l = $l;
-		$this->logger = $logger;
-		$this->mailer = $mailer;
-		$this->urlGenerator = $urlGenerator;
-		$this->activityManager = $activityManager;
-	}
-
-	/**
-	 * Share a path
-	 *
-	 * @param IShare $share
-	 * @return IShare The share object
-	 * @throws ShareNotFound
-	 * @throws \Exception
-	 */
-	public function create(IShare $share) {
-
-		$shareWith = $share->getSharedWith();
-		/*
+    /** @var  IDBConnection */
+    private $dbConnection;
+
+    /** @var ILogger */
+    private $logger;
+
+    /** @var ISecureRandom */
+    private $secureRandom;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var IRootFolder */
+    private $rootFolder;
+
+    /** @var IL10N */
+    private $l;
+
+    /** @var IMailer */
+    private $mailer;
+
+    /** @var IURLGenerator */
+    private $urlGenerator;
+
+    /** @var IManager  */
+    private $activityManager;
+
+    /**
+     * Return the identifier of this provider.
+     *
+     * @return string Containing only [a-zA-Z0-9]
+     */
+    public function identifier() {
+        return 'ocShareByMail';
+    }
+
+    /**
+     * DefaultShareProvider constructor.
+     *
+     * @param IDBConnection $connection
+     * @param ISecureRandom $secureRandom
+     * @param IUserManager $userManager
+     * @param IRootFolder $rootFolder
+     * @param IL10N $l
+     * @param ILogger $logger
+     * @param IMailer $mailer
+     * @param IURLGenerator $urlGenerator
+     * @param IManager $activityManager
+     */
+    public function __construct(
+        IDBConnection $connection,
+        ISecureRandom $secureRandom,
+        IUserManager $userManager,
+        IRootFolder $rootFolder,
+        IL10N $l,
+        ILogger $logger,
+        IMailer $mailer,
+        IURLGenerator $urlGenerator,
+        IManager $activityManager
+    ) {
+        $this->dbConnection = $connection;
+        $this->secureRandom = $secureRandom;
+        $this->userManager = $userManager;
+        $this->rootFolder = $rootFolder;
+        $this->l = $l;
+        $this->logger = $logger;
+        $this->mailer = $mailer;
+        $this->urlGenerator = $urlGenerator;
+        $this->activityManager = $activityManager;
+    }
+
+    /**
+     * Share a path
+     *
+     * @param IShare $share
+     * @return IShare The share object
+     * @throws ShareNotFound
+     * @throws \Exception
+     */
+    public function create(IShare $share) {
+
+        $shareWith = $share->getSharedWith();
+        /*
 		 * Check if file is not already shared with the remote user
 		 */
-		$alreadyShared = $this->getSharedWith($shareWith, \OCP\Share::SHARE_TYPE_EMAIL, $share->getNode(), 1, 0);
-		if (!empty($alreadyShared)) {
-			$message = 'Sharing %s failed, this item is already shared with %s';
-			$message_t = $this->l->t('Sharing %s failed, this item is already shared with %s', array($share->getNode()->getName(), $shareWith));
-			$this->logger->debug(sprintf($message, $share->getNode()->getName(), $shareWith), ['app' => 'Federated File Sharing']);
-			throw new \Exception($message_t);
-		}
-
-		$shareId = $this->createMailShare($share);
-		$this->createActivity($share);
-		$data = $this->getRawShare($shareId);
-		return $this->createShareObject($data);
-
-	}
-
-	/**
-	 * create activity if a file/folder was shared by mail
-	 *
-	 * @param IShare $share
-	 */
-	protected function createActivity(IShare $share) {
-
-		$userFolder = $this->rootFolder->getUserFolder($share->getSharedBy());
-
-		$this->publishActivity(
-			Activity::SUBJECT_SHARED_EMAIL_SELF,
-			[$userFolder->getRelativePath($share->getNode()->getPath()), $share->getSharedWith()],
-			$share->getSharedBy(),
-			$share->getNode()->getId(),
-			$userFolder->getRelativePath($share->getNode()->getPath())
-		);
-
-		if ($share->getShareOwner() !== $share->getSharedBy()) {
-			$ownerFolder = $this->rootFolder->getUserFolder($share->getShareOwner());
-			$fileId = $share->getNode()->getId();
-			$nodes = $ownerFolder->getById($fileId);
-			$ownerPath = $nodes[0]->getPath();
-			$this->publishActivity(
-				Activity::SUBJECT_SHARED_EMAIL_BY,
-				[$ownerFolder->getRelativePath($ownerPath), $share->getSharedWith(), $share->getSharedBy()],
-				$share->getShareOwner(),
-				$fileId,
-				$ownerFolder->getRelativePath($ownerPath)
-			);
-		}
-
-	}
-
-	/**
-	 * publish activity if a file/folder was shared by mail
-	 *
-	 * @param $subject
-	 * @param $parameters
-	 * @param $affectedUser
-	 * @param $fileId
-	 * @param $filePath
-	 */
-	protected function publishActivity($subject, $parameters, $affectedUser, $fileId, $filePath) {
-		$event = $this->activityManager->generateEvent();
-		$event->setApp('sharebymail')
-			->setType('shared')
-			->setSubject($subject, $parameters)
-			->setAffectedUser($affectedUser)
-			->setObject('files', $fileId, $filePath);
-		$this->activityManager->publish($event);
-
-	}
-
-	/**
-	 * @param IShare $share
-	 * @return int
-	 * @throws \Exception
-	 */
-	protected function createMailShare(IShare $share) {
-		$share->setToken($this->generateToken());
-		$shareId = $this->addShareToDB(
-			$share->getNodeId(),
-			$share->getNodeType(),
-			$share->getSharedWith(),
-			$share->getSharedBy(),
-			$share->getShareOwner(),
-			$share->getPermissions(),
-			$share->getToken()
-		);
-
-		try {
-			$link = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.showShare',
-				['token' => $share->getToken()]);
-			$this->sendMailNotification($share->getNode()->getName(),
-				$link,
-				$share->getShareOwner(),
-				$share->getSharedBy(), $share->getSharedWith());
-		} catch (HintException $hintException) {
-			$this->logger->error('Failed to send share by mail: ' . $hintException->getMessage());
-			$this->removeShareFromTable($shareId);
-			throw $hintException;
-		} catch (\Exception $e) {
-			$this->logger->error('Failed to send share by mail: ' . $e->getMessage());
-			$this->removeShareFromTable($shareId);
-			throw new HintException('Failed to send share by mail',
-				$this->l->t('Failed to send share by E-mail'));
-		}
-
-		return $shareId;
-
-	}
-
-	protected function sendMailNotification($filename, $link, $owner, $initiator, $shareWith) {
-		$ownerUser = $this->userManager->get($owner);
-		$initiatorUser = $this->userManager->get($initiator);
-		$ownerDisplayName = ($ownerUser instanceof IUser) ? $ownerUser->getDisplayName() : $owner;
-		$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
-		if ($owner === $initiator) {
-			$subject = (string)$this->l->t('%s shared »%s« with you', array($ownerDisplayName, $filename));
-		} else {
-			$subject = (string)$this->l->t('%s shared »%s« with you on behalf of %s', array($ownerDisplayName, $filename, $initiatorDisplayName));
-		}
-
-		$message = $this->mailer->createMessage();
-		$htmlBody = $this->createMailBody('mail', $filename, $link, $ownerDisplayName, $initiatorDisplayName);
-		$textBody = $this->createMailBody('altmail', $filename, $link, $ownerDisplayName, $initiatorDisplayName);
-		$message->setTo([$shareWith]);
-		$message->setSubject($subject);
-		$message->setBody($textBody, 'text/plain');
-		$message->setHtmlBody($htmlBody);
-		$this->mailer->send($message);
-
-	}
-
-	/**
-	 * create mail body
-	 *
-	 * @param $filename
-	 * @param $link
-	 * @param $owner
-	 * @param $initiator
-	 * @return string plain text mail
-	 * @throws HintException
-	 */
-	protected function createMailBody($template, $filename, $link, $owner, $initiator) {
-
-		$mailBodyTemplate = new Template('sharebymail', $template, '');
-		$mailBodyTemplate->assign ('filename', $filename);
-		$mailBodyTemplate->assign ('link', $link);
-		$mailBodyTemplate->assign ('owner', $owner);
-		$mailBodyTemplate->assign ('initiator', $initiator);
-		$mailBodyTemplate->assign ('onBehalfOf', $initiator !== $owner);
-		$mailBody = $mailBodyTemplate->fetchPage();
-
-		if (is_string($mailBody)) {
-			return $mailBody;
-		}
-
-		throw new HintException('Failed to create the E-mail',
-			$this->l->t('Failed to create the E-mail'));
-	}
-
-	/**
-	 * generate share token
-	 *
-	 * @return string
-	 */
-	protected function generateToken() {
-		$token = $this->secureRandom->generate(
-			15, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_DIGITS);
-		return $token;
-	}
-
-	/**
-	 * Get all children of this share
-	 *
-	 * @param IShare $parent
-	 * @return IShare[]
-	 */
-	public function getChildren(IShare $parent) {
-		$children = [];
-
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->select('*')
-			->from('share')
-			->where($qb->expr()->eq('parent', $qb->createNamedParameter($parent->getId())))
-			->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
-			->orderBy('id');
-
-		$cursor = $qb->execute();
-		while($data = $cursor->fetch()) {
-			$children[] = $this->createShareObject($data);
-		}
-		$cursor->closeCursor();
-
-		return $children;
-	}
-
-	/**
-	 * add share to the database and return the ID
-	 *
-	 * @param int $itemSource
-	 * @param string $itemType
-	 * @param string $shareWith
-	 * @param string $sharedBy
-	 * @param string $uidOwner
-	 * @param int $permissions
-	 * @param string $token
-	 * @return int
-	 */
-	protected function addShareToDB($itemSource, $itemType, $shareWith, $sharedBy, $uidOwner, $permissions, $token) {
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->insert('share')
-			->setValue('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL))
-			->setValue('item_type', $qb->createNamedParameter($itemType))
-			->setValue('item_source', $qb->createNamedParameter($itemSource))
-			->setValue('file_source', $qb->createNamedParameter($itemSource))
-			->setValue('share_with', $qb->createNamedParameter($shareWith))
-			->setValue('uid_owner', $qb->createNamedParameter($uidOwner))
-			->setValue('uid_initiator', $qb->createNamedParameter($sharedBy))
-			->setValue('permissions', $qb->createNamedParameter($permissions))
-			->setValue('token', $qb->createNamedParameter($token))
-			->setValue('stime', $qb->createNamedParameter(time()));
-
-		/*
+        $alreadyShared = $this->getSharedWith($shareWith, \OCP\Share::SHARE_TYPE_EMAIL, $share->getNode(), 1, 0);
+        if (!empty($alreadyShared)) {
+            $message = 'Sharing %s failed, this item is already shared with %s';
+            $message_t = $this->l->t('Sharing %s failed, this item is already shared with %s', array($share->getNode()->getName(), $shareWith));
+            $this->logger->debug(sprintf($message, $share->getNode()->getName(), $shareWith), ['app' => 'Federated File Sharing']);
+            throw new \Exception($message_t);
+        }
+
+        $shareId = $this->createMailShare($share);
+        $this->createActivity($share);
+        $data = $this->getRawShare($shareId);
+        return $this->createShareObject($data);
+
+    }
+
+    /**
+     * create activity if a file/folder was shared by mail
+     *
+     * @param IShare $share
+     */
+    protected function createActivity(IShare $share) {
+
+        $userFolder = $this->rootFolder->getUserFolder($share->getSharedBy());
+
+        $this->publishActivity(
+            Activity::SUBJECT_SHARED_EMAIL_SELF,
+            [$userFolder->getRelativePath($share->getNode()->getPath()), $share->getSharedWith()],
+            $share->getSharedBy(),
+            $share->getNode()->getId(),
+            $userFolder->getRelativePath($share->getNode()->getPath())
+        );
+
+        if ($share->getShareOwner() !== $share->getSharedBy()) {
+            $ownerFolder = $this->rootFolder->getUserFolder($share->getShareOwner());
+            $fileId = $share->getNode()->getId();
+            $nodes = $ownerFolder->getById($fileId);
+            $ownerPath = $nodes[0]->getPath();
+            $this->publishActivity(
+                Activity::SUBJECT_SHARED_EMAIL_BY,
+                [$ownerFolder->getRelativePath($ownerPath), $share->getSharedWith(), $share->getSharedBy()],
+                $share->getShareOwner(),
+                $fileId,
+                $ownerFolder->getRelativePath($ownerPath)
+            );
+        }
+
+    }
+
+    /**
+     * publish activity if a file/folder was shared by mail
+     *
+     * @param $subject
+     * @param $parameters
+     * @param $affectedUser
+     * @param $fileId
+     * @param $filePath
+     */
+    protected function publishActivity($subject, $parameters, $affectedUser, $fileId, $filePath) {
+        $event = $this->activityManager->generateEvent();
+        $event->setApp('sharebymail')
+            ->setType('shared')
+            ->setSubject($subject, $parameters)
+            ->setAffectedUser($affectedUser)
+            ->setObject('files', $fileId, $filePath);
+        $this->activityManager->publish($event);
+
+    }
+
+    /**
+     * @param IShare $share
+     * @return int
+     * @throws \Exception
+     */
+    protected function createMailShare(IShare $share) {
+        $share->setToken($this->generateToken());
+        $shareId = $this->addShareToDB(
+            $share->getNodeId(),
+            $share->getNodeType(),
+            $share->getSharedWith(),
+            $share->getSharedBy(),
+            $share->getShareOwner(),
+            $share->getPermissions(),
+            $share->getToken()
+        );
+
+        try {
+            $link = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.showShare',
+                ['token' => $share->getToken()]);
+            $this->sendMailNotification($share->getNode()->getName(),
+                $link,
+                $share->getShareOwner(),
+                $share->getSharedBy(), $share->getSharedWith());
+        } catch (HintException $hintException) {
+            $this->logger->error('Failed to send share by mail: ' . $hintException->getMessage());
+            $this->removeShareFromTable($shareId);
+            throw $hintException;
+        } catch (\Exception $e) {
+            $this->logger->error('Failed to send share by mail: ' . $e->getMessage());
+            $this->removeShareFromTable($shareId);
+            throw new HintException('Failed to send share by mail',
+                $this->l->t('Failed to send share by E-mail'));
+        }
+
+        return $shareId;
+
+    }
+
+    protected function sendMailNotification($filename, $link, $owner, $initiator, $shareWith) {
+        $ownerUser = $this->userManager->get($owner);
+        $initiatorUser = $this->userManager->get($initiator);
+        $ownerDisplayName = ($ownerUser instanceof IUser) ? $ownerUser->getDisplayName() : $owner;
+        $initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
+        if ($owner === $initiator) {
+            $subject = (string)$this->l->t('%s shared »%s« with you', array($ownerDisplayName, $filename));
+        } else {
+            $subject = (string)$this->l->t('%s shared »%s« with you on behalf of %s', array($ownerDisplayName, $filename, $initiatorDisplayName));
+        }
+
+        $message = $this->mailer->createMessage();
+        $htmlBody = $this->createMailBody('mail', $filename, $link, $ownerDisplayName, $initiatorDisplayName);
+        $textBody = $this->createMailBody('altmail', $filename, $link, $ownerDisplayName, $initiatorDisplayName);
+        $message->setTo([$shareWith]);
+        $message->setSubject($subject);
+        $message->setBody($textBody, 'text/plain');
+        $message->setHtmlBody($htmlBody);
+        $this->mailer->send($message);
+
+    }
+
+    /**
+     * create mail body
+     *
+     * @param $filename
+     * @param $link
+     * @param $owner
+     * @param $initiator
+     * @return string plain text mail
+     * @throws HintException
+     */
+    protected function createMailBody($template, $filename, $link, $owner, $initiator) {
+
+        $mailBodyTemplate = new Template('sharebymail', $template, '');
+        $mailBodyTemplate->assign ('filename', $filename);
+        $mailBodyTemplate->assign ('link', $link);
+        $mailBodyTemplate->assign ('owner', $owner);
+        $mailBodyTemplate->assign ('initiator', $initiator);
+        $mailBodyTemplate->assign ('onBehalfOf', $initiator !== $owner);
+        $mailBody = $mailBodyTemplate->fetchPage();
+
+        if (is_string($mailBody)) {
+            return $mailBody;
+        }
+
+        throw new HintException('Failed to create the E-mail',
+            $this->l->t('Failed to create the E-mail'));
+    }
+
+    /**
+     * generate share token
+     *
+     * @return string
+     */
+    protected function generateToken() {
+        $token = $this->secureRandom->generate(
+            15, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_DIGITS);
+        return $token;
+    }
+
+    /**
+     * Get all children of this share
+     *
+     * @param IShare $parent
+     * @return IShare[]
+     */
+    public function getChildren(IShare $parent) {
+        $children = [];
+
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->select('*')
+            ->from('share')
+            ->where($qb->expr()->eq('parent', $qb->createNamedParameter($parent->getId())))
+            ->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
+            ->orderBy('id');
+
+        $cursor = $qb->execute();
+        while($data = $cursor->fetch()) {
+            $children[] = $this->createShareObject($data);
+        }
+        $cursor->closeCursor();
+
+        return $children;
+    }
+
+    /**
+     * add share to the database and return the ID
+     *
+     * @param int $itemSource
+     * @param string $itemType
+     * @param string $shareWith
+     * @param string $sharedBy
+     * @param string $uidOwner
+     * @param int $permissions
+     * @param string $token
+     * @return int
+     */
+    protected function addShareToDB($itemSource, $itemType, $shareWith, $sharedBy, $uidOwner, $permissions, $token) {
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->insert('share')
+            ->setValue('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL))
+            ->setValue('item_type', $qb->createNamedParameter($itemType))
+            ->setValue('item_source', $qb->createNamedParameter($itemSource))
+            ->setValue('file_source', $qb->createNamedParameter($itemSource))
+            ->setValue('share_with', $qb->createNamedParameter($shareWith))
+            ->setValue('uid_owner', $qb->createNamedParameter($uidOwner))
+            ->setValue('uid_initiator', $qb->createNamedParameter($sharedBy))
+            ->setValue('permissions', $qb->createNamedParameter($permissions))
+            ->setValue('token', $qb->createNamedParameter($token))
+            ->setValue('stime', $qb->createNamedParameter(time()));
+
+        /*
 		 * Added to fix https://github.com/owncloud/core/issues/22215
 		 * Can be removed once we get rid of ajax/share.php
 		 */
-		$qb->setValue('file_target', $qb->createNamedParameter(''));
-
-		$qb->execute();
-		$id = $qb->getLastInsertId();
-
-		return (int)$id;
-	}
-
-	/**
-	 * Update a share
-	 *
-	 * @param IShare $share
-	 * @return IShare The share object
-	 */
-	public function update(IShare $share) {
-		/*
+        $qb->setValue('file_target', $qb->createNamedParameter(''));
+
+        $qb->execute();
+        $id = $qb->getLastInsertId();
+
+        return (int)$id;
+    }
+
+    /**
+     * Update a share
+     *
+     * @param IShare $share
+     * @return IShare The share object
+     */
+    public function update(IShare $share) {
+        /*
 		 * We allow updating the permissions of mail shares
 		 */
-		$qb = $this->dbConnection->getQueryBuilder();
-			$qb->update('share')
-				->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId())))
-				->set('permissions', $qb->createNamedParameter($share->getPermissions()))
-				->set('uid_owner', $qb->createNamedParameter($share->getShareOwner()))
-				->set('uid_initiator', $qb->createNamedParameter($share->getSharedBy()))
-				->execute();
-
-		return $share;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function move(IShare $share, $recipient) {
-		/**
-		 * nothing to do here, mail shares are only outgoing shares
-		 */
-		return $share;
-	}
-
-	/**
-	 * Delete a share (owner unShares the file)
-	 *
-	 * @param IShare $share
-	 */
-	public function delete(IShare $share) {
-		$this->removeShareFromTable($share->getId());
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function deleteFromSelf(IShare $share, $recipient) {
-		// nothing to do here, mail shares are only outgoing shares
-		return;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getSharesBy($userId, $shareType, $node, $reshares, $limit, $offset) {
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->select('*')
-			->from('share');
-
-		$qb->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)));
-
-		/**
-		 * Reshares for this user are shares where they are the owner.
-		 */
-		if ($reshares === false) {
-			//Special case for old shares created via the web UI
-			$or1 = $qb->expr()->andX(
-				$qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)),
-				$qb->expr()->isNull('uid_initiator')
-			);
-
-			$qb->andWhere(
-				$qb->expr()->orX(
-					$qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId)),
-					$or1
-				)
-			);
-		} else {
-			$qb->andWhere(
-				$qb->expr()->orX(
-					$qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)),
-					$qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId))
-				)
-			);
-		}
-
-		if ($node !== null) {
-			$qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId())));
-		}
-
-		if ($limit !== -1) {
-			$qb->setMaxResults($limit);
-		}
-
-		$qb->setFirstResult($offset);
-		$qb->orderBy('id');
-
-		$cursor = $qb->execute();
-		$shares = [];
-		while($data = $cursor->fetch()) {
-			$shares[] = $this->createShareObject($data);
-		}
-		$cursor->closeCursor();
-
-		return $shares;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getShareById($id, $recipientId = null) {
-		$qb = $this->dbConnection->getQueryBuilder();
-
-		$qb->select('*')
-			->from('share')
-			->where($qb->expr()->eq('id', $qb->createNamedParameter($id)))
-			->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)));
-
-		$cursor = $qb->execute();
-		$data = $cursor->fetch();
-		$cursor->closeCursor();
-
-		if ($data === false) {
-			throw new ShareNotFound();
-		}
-
-		try {
-			$share = $this->createShareObject($data);
-		} catch (InvalidShare $e) {
-			throw new ShareNotFound();
-		}
-
-		return $share;
-	}
-
-	/**
-	 * Get shares for a given path
-	 *
-	 * @param \OCP\Files\Node $path
-	 * @return IShare[]
-	 */
-	public function getSharesByPath(Node $path) {
-		$qb = $this->dbConnection->getQueryBuilder();
-
-		$cursor = $qb->select('*')
-			->from('share')
-			->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($path->getId())))
-			->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
-			->execute();
-
-		$shares = [];
-		while($data = $cursor->fetch()) {
-			$shares[] = $this->createShareObject($data);
-		}
-		$cursor->closeCursor();
-
-		return $shares;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getSharedWith($userId, $shareType, $node, $limit, $offset) {
-		/** @var IShare[] $shares */
-		$shares = [];
-
-		//Get shares directly with this user
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->select('*')
-			->from('share');
-
-		// Order by id
-		$qb->orderBy('id');
-
-		// Set limit and offset
-		if ($limit !== -1) {
-			$qb->setMaxResults($limit);
-		}
-		$qb->setFirstResult($offset);
-
-		$qb->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)));
-		$qb->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($userId)));
-
-		// Filter by node if provided
-		if ($node !== null) {
-			$qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId())));
-		}
-
-		$cursor = $qb->execute();
-
-		while($data = $cursor->fetch()) {
-			$shares[] = $this->createShareObject($data);
-		}
-		$cursor->closeCursor();
-
-
-		return $shares;
-	}
-
-	/**
-	 * Get a share by token
-	 *
-	 * @param string $token
-	 * @return IShare
-	 * @throws ShareNotFound
-	 */
-	public function getShareByToken($token) {
-		$qb = $this->dbConnection->getQueryBuilder();
-
-		$cursor = $qb->select('*')
-			->from('share')
-			->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
-			->andWhere($qb->expr()->eq('token', $qb->createNamedParameter($token)))
-			->execute();
-
-		$data = $cursor->fetch();
-
-		if ($data === false) {
-			throw new ShareNotFound('Share not found', $this->l->t('Could not find share'));
-		}
-
-		try {
-			$share = $this->createShareObject($data);
-		} catch (InvalidShare $e) {
-			throw new ShareNotFound('Share not found', $this->l->t('Could not find share'));
-		}
-
-		return $share;
-	}
-
-	/**
-	 * remove share from table
-	 *
-	 * @param string $shareId
-	 */
-	protected function removeShareFromTable($shareId) {
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->delete('share')
-			->where($qb->expr()->eq('id', $qb->createNamedParameter($shareId)));
-		$qb->execute();
-	}
-
-	/**
-	 * Create a share object from an database row
-	 *
-	 * @param array $data
-	 * @return IShare
-	 * @throws InvalidShare
-	 * @throws ShareNotFound
-	 */
-	protected function createShareObject($data) {
-
-		$share = new Share($this->rootFolder, $this->userManager);
-		$share->setId((int)$data['id'])
-			->setShareType((int)$data['share_type'])
-			->setPermissions((int)$data['permissions'])
-			->setTarget($data['file_target'])
-			->setMailSend((bool)$data['mail_send'])
-			->setToken($data['token']);
-
-		$shareTime = new \DateTime();
-		$shareTime->setTimestamp((int)$data['stime']);
-		$share->setShareTime($shareTime);
-		$share->setSharedWith($data['share_with']);
-
-		if ($data['uid_initiator'] !== null) {
-			$share->setShareOwner($data['uid_owner']);
-			$share->setSharedBy($data['uid_initiator']);
-		} else {
-			//OLD SHARE
-			$share->setSharedBy($data['uid_owner']);
-			$path = $this->getNode($share->getSharedBy(), (int)$data['file_source']);
-
-			$owner = $path->getOwner();
-			$share->setShareOwner($owner->getUID());
-		}
-
-		$share->setNodeId((int)$data['file_source']);
-		$share->setNodeType($data['item_type']);
-
-		$share->setProviderId($this->identifier());
-
-		return $share;
-	}
-
-	/**
-	 * Get the node with file $id for $user
-	 *
-	 * @param string $userId
-	 * @param int $id
-	 * @return \OCP\Files\File|\OCP\Files\Folder
-	 * @throws InvalidShare
-	 */
-	private function getNode($userId, $id) {
-		try {
-			$userFolder = $this->rootFolder->getUserFolder($userId);
-		} catch (NotFoundException $e) {
-			throw new InvalidShare();
-		}
-
-		$nodes = $userFolder->getById($id);
-
-		if (empty($nodes)) {
-			throw new InvalidShare();
-		}
-
-		return $nodes[0];
-	}
-
-	/**
-	 * A user is deleted from the system
-	 * So clean up the relevant shares.
-	 *
-	 * @param string $uid
-	 * @param int $shareType
-	 */
-	public function userDeleted($uid, $shareType) {
-		$qb = $this->dbConnection->getQueryBuilder();
-
-		$qb->delete('share')
-			->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
-			->andWhere($qb->expr()->eq('uid_owner', $qb->createNamedParameter($uid)))
-			->execute();
-	}
-
-	/**
-	 * This provider does not support group shares
-	 *
-	 * @param string $gid
-	 */
-	public function groupDeleted($gid) {
-		return;
-	}
-
-	/**
-	 * This provider does not support group shares
-	 *
-	 * @param string $uid
-	 * @param string $gid
-	 */
-	public function userDeletedFromGroup($uid, $gid) {
-		return;
-	}
-
-	/**
-	 * get database row of a give share
-	 *
-	 * @param $id
-	 * @return array
-	 * @throws ShareNotFound
-	 */
-	protected function getRawShare($id) {
-
-		// Now fetch the inserted share and create a complete share object
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->select('*')
-			->from('share')
-			->where($qb->expr()->eq('id', $qb->createNamedParameter($id)));
-
-		$cursor = $qb->execute();
-		$data = $cursor->fetch();
-		$cursor->closeCursor();
-
-		if ($data === false) {
-			throw new ShareNotFound;
-		}
-
-		return $data;
-	}
-
-	public function getSharesInFolder($userId, Folder $node, $reshares) {
-		$qb = $this->dbConnection->getQueryBuilder();
-		$qb->select('*')
-			->from('share', 's')
-			->andWhere($qb->expr()->orX(
-				$qb->expr()->eq('item_type', $qb->createNamedParameter('file')),
-				$qb->expr()->eq('item_type', $qb->createNamedParameter('folder'))
-			))
-			->andWhere(
-				$qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL))
-			);
-
-		/**
-		 * Reshares for this user are shares where they are the owner.
-		 */
-		if ($reshares === false) {
-			$qb->andWhere($qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId)));
-		} else {
-			$qb->andWhere(
-				$qb->expr()->orX(
-					$qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)),
-					$qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId))
-				)
-			);
-		}
-
-		$qb->innerJoin('s', 'filecache' ,'f', 's.file_source = f.fileid');
-		$qb->andWhere($qb->expr()->eq('f.parent', $qb->createNamedParameter($node->getId())));
-
-		$qb->orderBy('id');
-
-		$cursor = $qb->execute();
-		$shares = [];
-		while ($data = $cursor->fetch()) {
-			$shares[$data['fileid']][] = $this->createShareObject($data);
-		}
-		$cursor->closeCursor();
-
-		return $shares;
-	}
+        $qb = $this->dbConnection->getQueryBuilder();
+            $qb->update('share')
+                ->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId())))
+                ->set('permissions', $qb->createNamedParameter($share->getPermissions()))
+                ->set('uid_owner', $qb->createNamedParameter($share->getShareOwner()))
+                ->set('uid_initiator', $qb->createNamedParameter($share->getSharedBy()))
+                ->execute();
+
+        return $share;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function move(IShare $share, $recipient) {
+        /**
+         * nothing to do here, mail shares are only outgoing shares
+         */
+        return $share;
+    }
+
+    /**
+     * Delete a share (owner unShares the file)
+     *
+     * @param IShare $share
+     */
+    public function delete(IShare $share) {
+        $this->removeShareFromTable($share->getId());
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function deleteFromSelf(IShare $share, $recipient) {
+        // nothing to do here, mail shares are only outgoing shares
+        return;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getSharesBy($userId, $shareType, $node, $reshares, $limit, $offset) {
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->select('*')
+            ->from('share');
+
+        $qb->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)));
+
+        /**
+         * Reshares for this user are shares where they are the owner.
+         */
+        if ($reshares === false) {
+            //Special case for old shares created via the web UI
+            $or1 = $qb->expr()->andX(
+                $qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)),
+                $qb->expr()->isNull('uid_initiator')
+            );
+
+            $qb->andWhere(
+                $qb->expr()->orX(
+                    $qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId)),
+                    $or1
+                )
+            );
+        } else {
+            $qb->andWhere(
+                $qb->expr()->orX(
+                    $qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)),
+                    $qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId))
+                )
+            );
+        }
+
+        if ($node !== null) {
+            $qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId())));
+        }
+
+        if ($limit !== -1) {
+            $qb->setMaxResults($limit);
+        }
+
+        $qb->setFirstResult($offset);
+        $qb->orderBy('id');
+
+        $cursor = $qb->execute();
+        $shares = [];
+        while($data = $cursor->fetch()) {
+            $shares[] = $this->createShareObject($data);
+        }
+        $cursor->closeCursor();
+
+        return $shares;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getShareById($id, $recipientId = null) {
+        $qb = $this->dbConnection->getQueryBuilder();
+
+        $qb->select('*')
+            ->from('share')
+            ->where($qb->expr()->eq('id', $qb->createNamedParameter($id)))
+            ->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)));
+
+        $cursor = $qb->execute();
+        $data = $cursor->fetch();
+        $cursor->closeCursor();
+
+        if ($data === false) {
+            throw new ShareNotFound();
+        }
+
+        try {
+            $share = $this->createShareObject($data);
+        } catch (InvalidShare $e) {
+            throw new ShareNotFound();
+        }
+
+        return $share;
+    }
+
+    /**
+     * Get shares for a given path
+     *
+     * @param \OCP\Files\Node $path
+     * @return IShare[]
+     */
+    public function getSharesByPath(Node $path) {
+        $qb = $this->dbConnection->getQueryBuilder();
+
+        $cursor = $qb->select('*')
+            ->from('share')
+            ->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($path->getId())))
+            ->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
+            ->execute();
+
+        $shares = [];
+        while($data = $cursor->fetch()) {
+            $shares[] = $this->createShareObject($data);
+        }
+        $cursor->closeCursor();
+
+        return $shares;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getSharedWith($userId, $shareType, $node, $limit, $offset) {
+        /** @var IShare[] $shares */
+        $shares = [];
+
+        //Get shares directly with this user
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->select('*')
+            ->from('share');
+
+        // Order by id
+        $qb->orderBy('id');
+
+        // Set limit and offset
+        if ($limit !== -1) {
+            $qb->setMaxResults($limit);
+        }
+        $qb->setFirstResult($offset);
+
+        $qb->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)));
+        $qb->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($userId)));
+
+        // Filter by node if provided
+        if ($node !== null) {
+            $qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId())));
+        }
+
+        $cursor = $qb->execute();
+
+        while($data = $cursor->fetch()) {
+            $shares[] = $this->createShareObject($data);
+        }
+        $cursor->closeCursor();
+
+
+        return $shares;
+    }
+
+    /**
+     * Get a share by token
+     *
+     * @param string $token
+     * @return IShare
+     * @throws ShareNotFound
+     */
+    public function getShareByToken($token) {
+        $qb = $this->dbConnection->getQueryBuilder();
+
+        $cursor = $qb->select('*')
+            ->from('share')
+            ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
+            ->andWhere($qb->expr()->eq('token', $qb->createNamedParameter($token)))
+            ->execute();
+
+        $data = $cursor->fetch();
+
+        if ($data === false) {
+            throw new ShareNotFound('Share not found', $this->l->t('Could not find share'));
+        }
+
+        try {
+            $share = $this->createShareObject($data);
+        } catch (InvalidShare $e) {
+            throw new ShareNotFound('Share not found', $this->l->t('Could not find share'));
+        }
+
+        return $share;
+    }
+
+    /**
+     * remove share from table
+     *
+     * @param string $shareId
+     */
+    protected function removeShareFromTable($shareId) {
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->delete('share')
+            ->where($qb->expr()->eq('id', $qb->createNamedParameter($shareId)));
+        $qb->execute();
+    }
+
+    /**
+     * Create a share object from an database row
+     *
+     * @param array $data
+     * @return IShare
+     * @throws InvalidShare
+     * @throws ShareNotFound
+     */
+    protected function createShareObject($data) {
+
+        $share = new Share($this->rootFolder, $this->userManager);
+        $share->setId((int)$data['id'])
+            ->setShareType((int)$data['share_type'])
+            ->setPermissions((int)$data['permissions'])
+            ->setTarget($data['file_target'])
+            ->setMailSend((bool)$data['mail_send'])
+            ->setToken($data['token']);
+
+        $shareTime = new \DateTime();
+        $shareTime->setTimestamp((int)$data['stime']);
+        $share->setShareTime($shareTime);
+        $share->setSharedWith($data['share_with']);
+
+        if ($data['uid_initiator'] !== null) {
+            $share->setShareOwner($data['uid_owner']);
+            $share->setSharedBy($data['uid_initiator']);
+        } else {
+            //OLD SHARE
+            $share->setSharedBy($data['uid_owner']);
+            $path = $this->getNode($share->getSharedBy(), (int)$data['file_source']);
+
+            $owner = $path->getOwner();
+            $share->setShareOwner($owner->getUID());
+        }
+
+        $share->setNodeId((int)$data['file_source']);
+        $share->setNodeType($data['item_type']);
+
+        $share->setProviderId($this->identifier());
+
+        return $share;
+    }
+
+    /**
+     * Get the node with file $id for $user
+     *
+     * @param string $userId
+     * @param int $id
+     * @return \OCP\Files\File|\OCP\Files\Folder
+     * @throws InvalidShare
+     */
+    private function getNode($userId, $id) {
+        try {
+            $userFolder = $this->rootFolder->getUserFolder($userId);
+        } catch (NotFoundException $e) {
+            throw new InvalidShare();
+        }
+
+        $nodes = $userFolder->getById($id);
+
+        if (empty($nodes)) {
+            throw new InvalidShare();
+        }
+
+        return $nodes[0];
+    }
+
+    /**
+     * A user is deleted from the system
+     * So clean up the relevant shares.
+     *
+     * @param string $uid
+     * @param int $shareType
+     */
+    public function userDeleted($uid, $shareType) {
+        $qb = $this->dbConnection->getQueryBuilder();
+
+        $qb->delete('share')
+            ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL)))
+            ->andWhere($qb->expr()->eq('uid_owner', $qb->createNamedParameter($uid)))
+            ->execute();
+    }
+
+    /**
+     * This provider does not support group shares
+     *
+     * @param string $gid
+     */
+    public function groupDeleted($gid) {
+        return;
+    }
+
+    /**
+     * This provider does not support group shares
+     *
+     * @param string $uid
+     * @param string $gid
+     */
+    public function userDeletedFromGroup($uid, $gid) {
+        return;
+    }
+
+    /**
+     * get database row of a give share
+     *
+     * @param $id
+     * @return array
+     * @throws ShareNotFound
+     */
+    protected function getRawShare($id) {
+
+        // Now fetch the inserted share and create a complete share object
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->select('*')
+            ->from('share')
+            ->where($qb->expr()->eq('id', $qb->createNamedParameter($id)));
+
+        $cursor = $qb->execute();
+        $data = $cursor->fetch();
+        $cursor->closeCursor();
+
+        if ($data === false) {
+            throw new ShareNotFound;
+        }
+
+        return $data;
+    }
+
+    public function getSharesInFolder($userId, Folder $node, $reshares) {
+        $qb = $this->dbConnection->getQueryBuilder();
+        $qb->select('*')
+            ->from('share', 's')
+            ->andWhere($qb->expr()->orX(
+                $qb->expr()->eq('item_type', $qb->createNamedParameter('file')),
+                $qb->expr()->eq('item_type', $qb->createNamedParameter('folder'))
+            ))
+            ->andWhere(
+                $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL))
+            );
+
+        /**
+         * Reshares for this user are shares where they are the owner.
+         */
+        if ($reshares === false) {
+            $qb->andWhere($qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId)));
+        } else {
+            $qb->andWhere(
+                $qb->expr()->orX(
+                    $qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)),
+                    $qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId))
+                )
+            );
+        }
+
+        $qb->innerJoin('s', 'filecache' ,'f', 's.file_source = f.fileid');
+        $qb->andWhere($qb->expr()->eq('f.parent', $qb->createNamedParameter($node->getId())));
+
+        $qb->orderBy('id');
+
+        $cursor = $qb->execute();
+        $shares = [];
+        while ($data = $cursor->fetch()) {
+            $shares[$data['fileid']][] = $this->createShareObject($data);
+        }
+        $cursor->closeCursor();
+
+        return $shares;
+    }
 
 }

Spacing +23 added lines, -23 removed lines

@@ -226,11 +226,11 @@ 
 				$share->getShareOwner(),
 				$share->getSharedBy(), $share->getSharedWith());
 		} catch (HintException $hintException) {
-			$this->logger->error('Failed to send share by mail: ' . $hintException->getMessage());
+			$this->logger->error('Failed to send share by mail: '.$hintException->getMessage());
 			$this->removeShareFromTable($shareId);
 			throw $hintException;
 		} catch (\Exception $e) {
-			$this->logger->error('Failed to send share by mail: ' . $e->getMessage());
+			$this->logger->error('Failed to send share by mail: '.$e->getMessage());
 			$this->removeShareFromTable($shareId);
 			throw new HintException('Failed to send share by mail',
 				$this->l->t('Failed to send share by E-mail'));
@@ -246,9 +246,9 @@ 
 		$ownerDisplayName = ($ownerUser instanceof IUser) ? $ownerUser->getDisplayName() : $owner;
 		$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
 		if ($owner === $initiator) {
-			$subject = (string)$this->l->t('%s shared »%s« with you', array($ownerDisplayName, $filename));
+			$subject = (string) $this->l->t('%s shared »%s« with you', array($ownerDisplayName, $filename));
 		} else {
-			$subject = (string)$this->l->t('%s shared »%s« with you on behalf of %s', array($ownerDisplayName, $filename, $initiatorDisplayName));
+			$subject = (string) $this->l->t('%s shared »%s« with you on behalf of %s', array($ownerDisplayName, $filename, $initiatorDisplayName));
 		}
 
 		$message = $this->mailer->createMessage();
@@ -275,11 +275,11 @@ 
 	protected function createMailBody($template, $filename, $link, $owner, $initiator) {
 
 		$mailBodyTemplate = new Template('sharebymail', $template, '');
-		$mailBodyTemplate->assign ('filename', $filename);
-		$mailBodyTemplate->assign ('link', $link);
-		$mailBodyTemplate->assign ('owner', $owner);
-		$mailBodyTemplate->assign ('initiator', $initiator);
-		$mailBodyTemplate->assign ('onBehalfOf', $initiator !== $owner);
+		$mailBodyTemplate->assign('filename', $filename);
+		$mailBodyTemplate->assign('link', $link);
+		$mailBodyTemplate->assign('owner', $owner);
+		$mailBodyTemplate->assign('initiator', $initiator);
+		$mailBodyTemplate->assign('onBehalfOf', $initiator !== $owner);
 		$mailBody = $mailBodyTemplate->fetchPage();
 
 		if (is_string($mailBody)) {
@@ -297,7 +297,7 @@ 
 	 */
 	protected function generateToken() {
 		$token = $this->secureRandom->generate(
-			15, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_DIGITS);
+			15, ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_UPPER.ISecureRandom::CHAR_DIGITS);
 		return $token;
 	}
 
@@ -318,7 +318,7 @@ 
 			->orderBy('id');
 
 		$cursor = $qb->execute();
-		while($data = $cursor->fetch()) {
+		while ($data = $cursor->fetch()) {
 			$children[] = $this->createShareObject($data);
 		}
 		$cursor->closeCursor();
@@ -361,7 +361,7 @@ 
 		$qb->execute();
 		$id = $qb->getLastInsertId();
 
-		return (int)$id;
+		return (int) $id;
 	}
 
 	/**
@@ -460,7 +460,7 @@ 
 
 		$cursor = $qb->execute();
 		$shares = [];
-		while($data = $cursor->fetch()) {
+		while ($data = $cursor->fetch()) {
 			$shares[] = $this->createShareObject($data);
 		}
 		$cursor->closeCursor();
@@ -512,7 +512,7 @@ 
 			->execute();
 
 		$shares = [];
-		while($data = $cursor->fetch()) {
+		while ($data = $cursor->fetch()) {
 			$shares[] = $this->createShareObject($data);
 		}
 		$cursor->closeCursor();
@@ -551,7 +551,7 @@ 
 
 		$cursor = $qb->execute();
 
-		while($data = $cursor->fetch()) {
+		while ($data = $cursor->fetch()) {
 			$shares[] = $this->createShareObject($data);
 		}
 		$cursor->closeCursor();
@@ -614,15 +614,15 @@ 
 	protected function createShareObject($data) {
 
 		$share = new Share($this->rootFolder, $this->userManager);
-		$share->setId((int)$data['id'])
-			->setShareType((int)$data['share_type'])
-			->setPermissions((int)$data['permissions'])
+		$share->setId((int) $data['id'])
+			->setShareType((int) $data['share_type'])
+			->setPermissions((int) $data['permissions'])
 			->setTarget($data['file_target'])
-			->setMailSend((bool)$data['mail_send'])
+			->setMailSend((bool) $data['mail_send'])
 			->setToken($data['token']);
 
 		$shareTime = new \DateTime();
-		$shareTime->setTimestamp((int)$data['stime']);
+		$shareTime->setTimestamp((int) $data['stime']);
 		$share->setShareTime($shareTime);
 		$share->setSharedWith($data['share_with']);
 
@@ -632,13 +632,13 @@ 
 		} else {
 			//OLD SHARE
 			$share->setSharedBy($data['uid_owner']);
-			$path = $this->getNode($share->getSharedBy(), (int)$data['file_source']);
+			$path = $this->getNode($share->getSharedBy(), (int) $data['file_source']);
 
 			$owner = $path->getOwner();
 			$share->setShareOwner($owner->getUID());
 		}
 
-		$share->setNodeId((int)$data['file_source']);
+		$share->setNodeId((int) $data['file_source']);
 		$share->setNodeType($data['item_type']);
 
 		$share->setProviderId($this->identifier());
@@ -757,7 +757,7 @@ 
 			);
 		}
 
-		$qb->innerJoin('s', 'filecache' ,'f', 's.file_source = f.fileid');
+		$qb->innerJoin('s', 'filecache', 'f', 's.file_source = f.fileid');
 		$qb->andWhere($qb->expr()->eq('f.parent', $qb->createNamedParameter($node->getId())));
 
 		$qb->orderBy('id');

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/AppFramework/Middleware/Security/SecurityMiddleware.php

Doc Comments +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
 	 * @param bool $isLoggedIn
 	 * @param bool $isAdminUser
 	 * @param ContentSecurityPolicyManager $contentSecurityPolicyManager
-	 * @param CSRFTokenManager $csrfTokenManager
+	 * @param CsrfTokenManager $csrfTokenManager
 	 * @param ContentSecurityPolicyNonceManager $cspNonceManager
 	 * @param Throttler $throttler
 	 */

Indentation +190 added lines, -190 removed lines

@@ -64,219 +64,219 @@
  * check fails
  */
 class SecurityMiddleware extends Middleware {
-	/** @var INavigationManager */
-	private $navigationManager;
-	/** @var IRequest */
-	private $request;
-	/** @var ControllerMethodReflector */
-	private $reflector;
-	/** @var string */
-	private $appName;
-	/** @var IURLGenerator */
-	private $urlGenerator;
-	/** @var ILogger */
-	private $logger;
-	/** @var ISession */
-	private $session;
-	/** @var bool */
-	private $isLoggedIn;
-	/** @var bool */
-	private $isAdminUser;
-	/** @var ContentSecurityPolicyManager */
-	private $contentSecurityPolicyManager;
-	/** @var CsrfTokenManager */
-	private $csrfTokenManager;
-	/** @var ContentSecurityPolicyNonceManager */
-	private $cspNonceManager;
-	/** @var Throttler */
-	private $throttler;
+    /** @var INavigationManager */
+    private $navigationManager;
+    /** @var IRequest */
+    private $request;
+    /** @var ControllerMethodReflector */
+    private $reflector;
+    /** @var string */
+    private $appName;
+    /** @var IURLGenerator */
+    private $urlGenerator;
+    /** @var ILogger */
+    private $logger;
+    /** @var ISession */
+    private $session;
+    /** @var bool */
+    private $isLoggedIn;
+    /** @var bool */
+    private $isAdminUser;
+    /** @var ContentSecurityPolicyManager */
+    private $contentSecurityPolicyManager;
+    /** @var CsrfTokenManager */
+    private $csrfTokenManager;
+    /** @var ContentSecurityPolicyNonceManager */
+    private $cspNonceManager;
+    /** @var Throttler */
+    private $throttler;
 
-	/**
-	 * @param IRequest $request
-	 * @param ControllerMethodReflector $reflector
-	 * @param INavigationManager $navigationManager
-	 * @param IURLGenerator $urlGenerator
-	 * @param ILogger $logger
-	 * @param ISession $session
-	 * @param string $appName
-	 * @param bool $isLoggedIn
-	 * @param bool $isAdminUser
-	 * @param ContentSecurityPolicyManager $contentSecurityPolicyManager
-	 * @param CSRFTokenManager $csrfTokenManager
-	 * @param ContentSecurityPolicyNonceManager $cspNonceManager
-	 * @param Throttler $throttler
-	 */
-	public function __construct(IRequest $request,
-								ControllerMethodReflector $reflector,
-								INavigationManager $navigationManager,
-								IURLGenerator $urlGenerator,
-								ILogger $logger,
-								ISession $session,
-								$appName,
-								$isLoggedIn,
-								$isAdminUser,
-								ContentSecurityPolicyManager $contentSecurityPolicyManager,
-								CsrfTokenManager $csrfTokenManager,
-								ContentSecurityPolicyNonceManager $cspNonceManager,
-								Throttler $throttler) {
-		$this->navigationManager = $navigationManager;
-		$this->request = $request;
-		$this->reflector = $reflector;
-		$this->appName = $appName;
-		$this->urlGenerator = $urlGenerator;
-		$this->logger = $logger;
-		$this->session = $session;
-		$this->isLoggedIn = $isLoggedIn;
-		$this->isAdminUser = $isAdminUser;
-		$this->contentSecurityPolicyManager = $contentSecurityPolicyManager;
-		$this->csrfTokenManager = $csrfTokenManager;
-		$this->cspNonceManager = $cspNonceManager;
-		$this->throttler = $throttler;
-	}
+    /**
+     * @param IRequest $request
+     * @param ControllerMethodReflector $reflector
+     * @param INavigationManager $navigationManager
+     * @param IURLGenerator $urlGenerator
+     * @param ILogger $logger
+     * @param ISession $session
+     * @param string $appName
+     * @param bool $isLoggedIn
+     * @param bool $isAdminUser
+     * @param ContentSecurityPolicyManager $contentSecurityPolicyManager
+     * @param CSRFTokenManager $csrfTokenManager
+     * @param ContentSecurityPolicyNonceManager $cspNonceManager
+     * @param Throttler $throttler
+     */
+    public function __construct(IRequest $request,
+                                ControllerMethodReflector $reflector,
+                                INavigationManager $navigationManager,
+                                IURLGenerator $urlGenerator,
+                                ILogger $logger,
+                                ISession $session,
+                                $appName,
+                                $isLoggedIn,
+                                $isAdminUser,
+                                ContentSecurityPolicyManager $contentSecurityPolicyManager,
+                                CsrfTokenManager $csrfTokenManager,
+                                ContentSecurityPolicyNonceManager $cspNonceManager,
+                                Throttler $throttler) {
+        $this->navigationManager = $navigationManager;
+        $this->request = $request;
+        $this->reflector = $reflector;
+        $this->appName = $appName;
+        $this->urlGenerator = $urlGenerator;
+        $this->logger = $logger;
+        $this->session = $session;
+        $this->isLoggedIn = $isLoggedIn;
+        $this->isAdminUser = $isAdminUser;
+        $this->contentSecurityPolicyManager = $contentSecurityPolicyManager;
+        $this->csrfTokenManager = $csrfTokenManager;
+        $this->cspNonceManager = $cspNonceManager;
+        $this->throttler = $throttler;
+    }
 
 
-	/**
-	 * This runs all the security checks before a method call. The
-	 * security checks are determined by inspecting the controller method
-	 * annotations
-	 * @param Controller $controller the controller
-	 * @param string $methodName the name of the method
-	 * @throws SecurityException when a security check fails
-	 */
-	public function beforeController($controller, $methodName) {
+    /**
+     * This runs all the security checks before a method call. The
+     * security checks are determined by inspecting the controller method
+     * annotations
+     * @param Controller $controller the controller
+     * @param string $methodName the name of the method
+     * @throws SecurityException when a security check fails
+     */
+    public function beforeController($controller, $methodName) {
 
-		// this will set the current navigation entry of the app, use this only
-		// for normal HTML requests and not for AJAX requests
-		$this->navigationManager->setActiveEntry($this->appName);
+        // this will set the current navigation entry of the app, use this only
+        // for normal HTML requests and not for AJAX requests
+        $this->navigationManager->setActiveEntry($this->appName);
 
-		// security checks
-		$isPublicPage = $this->reflector->hasAnnotation('PublicPage');
-		if(!$isPublicPage) {
-			if(!$this->isLoggedIn) {
-				throw new NotLoggedInException();
-			}
+        // security checks
+        $isPublicPage = $this->reflector->hasAnnotation('PublicPage');
+        if(!$isPublicPage) {
+            if(!$this->isLoggedIn) {
+                throw new NotLoggedInException();
+            }
 
-			if(!$this->reflector->hasAnnotation('NoAdminRequired')) {
-				if(!$this->isAdminUser) {
-					throw new NotAdminException();
-				}
-			}
-		}
+            if(!$this->reflector->hasAnnotation('NoAdminRequired')) {
+                if(!$this->isAdminUser) {
+                    throw new NotAdminException();
+                }
+            }
+        }
 
-		if ($this->reflector->hasAnnotation('PasswordConfirmationRequired')) {
-			$lastConfirm = (int) $this->session->get('last-password-confirm');
-			if ($lastConfirm < (time() - (30 * 60 + 15))) { // allow 15 seconds delay
-				throw new NotConfirmedException();
-			}
-		}
+        if ($this->reflector->hasAnnotation('PasswordConfirmationRequired')) {
+            $lastConfirm = (int) $this->session->get('last-password-confirm');
+            if ($lastConfirm < (time() - (30 * 60 + 15))) { // allow 15 seconds delay
+                throw new NotConfirmedException();
+            }
+        }
 
-		// Check for strict cookie requirement
-		if($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) {
-			if(!$this->request->passesStrictCookieCheck()) {
-				throw new StrictCookieMissingException();
-			}
-		}
-		// CSRF check - also registers the CSRF token since the session may be closed later
-		Util::callRegister();
-		if(!$this->reflector->hasAnnotation('NoCSRFRequired')) {
-			/*
+        // Check for strict cookie requirement
+        if($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) {
+            if(!$this->request->passesStrictCookieCheck()) {
+                throw new StrictCookieMissingException();
+            }
+        }
+        // CSRF check - also registers the CSRF token since the session may be closed later
+        Util::callRegister();
+        if(!$this->reflector->hasAnnotation('NoCSRFRequired')) {
+            /*
 			 * Only allow the CSRF check to fail on OCS Requests. This kind of
 			 * hacks around that we have no full token auth in place yet and we
 			 * do want to offer CSRF checks for web requests.
 			 */
-			if(!$this->request->passesCSRFCheck() && !(
-					$controller instanceof OCSController &&
-					$this->request->getHeader('OCS-APIREQUEST') === 'true')) {
-				throw new CrossSiteRequestForgeryException();
-			}
-		}
+            if(!$this->request->passesCSRFCheck() && !(
+                    $controller instanceof OCSController &&
+                    $this->request->getHeader('OCS-APIREQUEST') === 'true')) {
+                throw new CrossSiteRequestForgeryException();
+            }
+        }
 
-		if($this->reflector->hasAnnotation('BruteForceProtection')) {
-			$action = $this->reflector->getAnnotationParameter('BruteForceProtection');
-			$this->throttler->sleepDelay($this->request->getRemoteAddress(), $action);
-			$this->throttler->registerAttempt($action, $this->request->getRemoteAddress());
-		}
+        if($this->reflector->hasAnnotation('BruteForceProtection')) {
+            $action = $this->reflector->getAnnotationParameter('BruteForceProtection');
+            $this->throttler->sleepDelay($this->request->getRemoteAddress(), $action);
+            $this->throttler->registerAttempt($action, $this->request->getRemoteAddress());
+        }
 
-		/**
-		 * FIXME: Use DI once available
-		 * Checks if app is enabled (also includes a check whether user is allowed to access the resource)
-		 * The getAppPath() check is here since components such as settings also use the AppFramework and
-		 * therefore won't pass this check.
-		 */
-		if(\OC_App::getAppPath($this->appName) !== false && !\OC_App::isEnabled($this->appName)) {
-			throw new AppNotEnabledException();
-		}
+        /**
+         * FIXME: Use DI once available
+         * Checks if app is enabled (also includes a check whether user is allowed to access the resource)
+         * The getAppPath() check is here since components such as settings also use the AppFramework and
+         * therefore won't pass this check.
+         */
+        if(\OC_App::getAppPath($this->appName) !== false && !\OC_App::isEnabled($this->appName)) {
+            throw new AppNotEnabledException();
+        }
 
-	}
+    }
 
-	/**
-	 * Performs the default CSP modifications that may be injected by other
-	 * applications
-	 *
-	 * @param Controller $controller
-	 * @param string $methodName
-	 * @param Response $response
-	 * @return Response
-	 */
-	public function afterController($controller, $methodName, Response $response) {
-		$policy = !is_null($response->getContentSecurityPolicy()) ? $response->getContentSecurityPolicy() : new ContentSecurityPolicy();
+    /**
+     * Performs the default CSP modifications that may be injected by other
+     * applications
+     *
+     * @param Controller $controller
+     * @param string $methodName
+     * @param Response $response
+     * @return Response
+     */
+    public function afterController($controller, $methodName, Response $response) {
+        $policy = !is_null($response->getContentSecurityPolicy()) ? $response->getContentSecurityPolicy() : new ContentSecurityPolicy();
 
-		if (get_class($policy) === EmptyContentSecurityPolicy::class) {
-			return $response;
-		}
+        if (get_class($policy) === EmptyContentSecurityPolicy::class) {
+            return $response;
+        }
 
-		$defaultPolicy = $this->contentSecurityPolicyManager->getDefaultPolicy();
-		$defaultPolicy = $this->contentSecurityPolicyManager->mergePolicies($defaultPolicy, $policy);
+        $defaultPolicy = $this->contentSecurityPolicyManager->getDefaultPolicy();
+        $defaultPolicy = $this->contentSecurityPolicyManager->mergePolicies($defaultPolicy, $policy);
 
-		if($this->cspNonceManager->browserSupportsCspV3()) {
-			$defaultPolicy->useJsNonce($this->csrfTokenManager->getToken()->getEncryptedValue());
-		}
+        if($this->cspNonceManager->browserSupportsCspV3()) {
+            $defaultPolicy->useJsNonce($this->csrfTokenManager->getToken()->getEncryptedValue());
+        }
 
-		$response->setContentSecurityPolicy($defaultPolicy);
+        $response->setContentSecurityPolicy($defaultPolicy);
 
-		return $response;
-	}
+        return $response;
+    }
 
-	/**
-	 * If an SecurityException is being caught, ajax requests return a JSON error
-	 * response and non ajax requests redirect to the index
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 * @param \Exception $exception the thrown exception
-	 * @throws \Exception the passed in exception if it can't handle it
-	 * @return Response a Response object or null in case that the exception could not be handled
-	 */
-	public function afterException($controller, $methodName, \Exception $exception) {
-		if($exception instanceof SecurityException) {
-			if($exception instanceof StrictCookieMissingException) {
-				return new RedirectResponse(\OC::$WEBROOT);
- 			}
-			if (stripos($this->request->getHeader('Accept'),'html') === false) {
-				$response = new JSONResponse(
-					array('message' => $exception->getMessage()),
-					$exception->getCode()
-				);
-			} else {
-				if($exception instanceof NotLoggedInException) {
-					$url = $this->urlGenerator->linkToRoute(
-						'core.login.showLoginForm',
-						[
-							'redirect_url' => $this->request->server['REQUEST_URI'],
-						]
-					);
-					$response = new RedirectResponse($url);
-				} else {
-					$response = new TemplateResponse('core', '403', ['file' => $exception->getMessage()], 'guest');
-					$response->setStatus($exception->getCode());
-				}
-			}
+    /**
+     * If an SecurityException is being caught, ajax requests return a JSON error
+     * response and non ajax requests redirect to the index
+     * @param Controller $controller the controller that is being called
+     * @param string $methodName the name of the method that will be called on
+     *                           the controller
+     * @param \Exception $exception the thrown exception
+     * @throws \Exception the passed in exception if it can't handle it
+     * @return Response a Response object or null in case that the exception could not be handled
+     */
+    public function afterException($controller, $methodName, \Exception $exception) {
+        if($exception instanceof SecurityException) {
+            if($exception instanceof StrictCookieMissingException) {
+                return new RedirectResponse(\OC::$WEBROOT);
+                }
+            if (stripos($this->request->getHeader('Accept'),'html') === false) {
+                $response = new JSONResponse(
+                    array('message' => $exception->getMessage()),
+                    $exception->getCode()
+                );
+            } else {
+                if($exception instanceof NotLoggedInException) {
+                    $url = $this->urlGenerator->linkToRoute(
+                        'core.login.showLoginForm',
+                        [
+                            'redirect_url' => $this->request->server['REQUEST_URI'],
+                        ]
+                    );
+                    $response = new RedirectResponse($url);
+                } else {
+                    $response = new TemplateResponse('core', '403', ['file' => $exception->getMessage()], 'guest');
+                    $response->setStatus($exception->getCode());
+                }
+            }
 
-			$this->logger->debug($exception->getMessage());
-			return $response;
-		}
+            $this->logger->debug($exception->getMessage());
+            return $response;
+        }
 
-		throw $exception;
-	}
+        throw $exception;
+    }
 
 }

Spacing +15 added lines, -15 removed lines

@@ -151,13 +151,13 @@ 
 
 		// security checks
 		$isPublicPage = $this->reflector->hasAnnotation('PublicPage');
-		if(!$isPublicPage) {
-			if(!$this->isLoggedIn) {
+		if (!$isPublicPage) {
+			if (!$this->isLoggedIn) {
 				throw new NotLoggedInException();
 			}
 
-			if(!$this->reflector->hasAnnotation('NoAdminRequired')) {
-				if(!$this->isAdminUser) {
+			if (!$this->reflector->hasAnnotation('NoAdminRequired')) {
+				if (!$this->isAdminUser) {
 					throw new NotAdminException();
 				}
 			}
@@ -171,27 +171,27 @@ 
 		}
 
 		// Check for strict cookie requirement
-		if($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) {
-			if(!$this->request->passesStrictCookieCheck()) {
+		if ($this->reflector->hasAnnotation('StrictCookieRequired') || !$this->reflector->hasAnnotation('NoCSRFRequired')) {
+			if (!$this->request->passesStrictCookieCheck()) {
 				throw new StrictCookieMissingException();
 			}
 		}
 		// CSRF check - also registers the CSRF token since the session may be closed later
 		Util::callRegister();
-		if(!$this->reflector->hasAnnotation('NoCSRFRequired')) {
+		if (!$this->reflector->hasAnnotation('NoCSRFRequired')) {
 			/*
 			 * Only allow the CSRF check to fail on OCS Requests. This kind of
 			 * hacks around that we have no full token auth in place yet and we
 			 * do want to offer CSRF checks for web requests.
 			 */
-			if(!$this->request->passesCSRFCheck() && !(
+			if (!$this->request->passesCSRFCheck() && !(
 					$controller instanceof OCSController &&
 					$this->request->getHeader('OCS-APIREQUEST') === 'true')) {
 				throw new CrossSiteRequestForgeryException();
 			}
 		}
 
-		if($this->reflector->hasAnnotation('BruteForceProtection')) {
+		if ($this->reflector->hasAnnotation('BruteForceProtection')) {
 			$action = $this->reflector->getAnnotationParameter('BruteForceProtection');
 			$this->throttler->sleepDelay($this->request->getRemoteAddress(), $action);
 			$this->throttler->registerAttempt($action, $this->request->getRemoteAddress());
@@ -203,7 +203,7 @@ 
 		 * The getAppPath() check is here since components such as settings also use the AppFramework and
 		 * therefore won't pass this check.
 		 */
-		if(\OC_App::getAppPath($this->appName) !== false && !\OC_App::isEnabled($this->appName)) {
+		if (\OC_App::getAppPath($this->appName) !== false && !\OC_App::isEnabled($this->appName)) {
 			throw new AppNotEnabledException();
 		}
 
@@ -228,7 +228,7 @@ 
 		$defaultPolicy = $this->contentSecurityPolicyManager->getDefaultPolicy();
 		$defaultPolicy = $this->contentSecurityPolicyManager->mergePolicies($defaultPolicy, $policy);
 
-		if($this->cspNonceManager->browserSupportsCspV3()) {
+		if ($this->cspNonceManager->browserSupportsCspV3()) {
 			$defaultPolicy->useJsNonce($this->csrfTokenManager->getToken()->getEncryptedValue());
 		}
 
@@ -248,17 +248,17 @@ 
 	 * @return Response a Response object or null in case that the exception could not be handled
 	 */
 	public function afterException($controller, $methodName, \Exception $exception) {
-		if($exception instanceof SecurityException) {
-			if($exception instanceof StrictCookieMissingException) {
+		if ($exception instanceof SecurityException) {
+			if ($exception instanceof StrictCookieMissingException) {
 				return new RedirectResponse(\OC::$WEBROOT);
  			}
-			if (stripos($this->request->getHeader('Accept'),'html') === false) {
+			if (stripos($this->request->getHeader('Accept'), 'html') === false) {
 				$response = new JSONResponse(
 					array('message' => $exception->getMessage()),
 					$exception->getCode()
 				);
 			} else {
-				if($exception instanceof NotLoggedInException) {
+				if ($exception instanceof NotLoggedInException) {
 					$url = $this->urlGenerator->linkToRoute(
 						'core.login.showLoginForm',
 						[

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);

Indentation +249 added lines, -249 removed lines

@@ -33,279 +33,279 @@
  * 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);
+    }
 
-	/**
-	 * 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));
+    }
 }

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.'/');
 	}
 
 	/**

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 +350 added lines, -350 removed lines

@@ -37,354 +37,354 @@
 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;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getId() {
-		return $this->data['fileid'];
-	}
-
-	/**
-	 * @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']) ? $this->data['size'] : 0;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getMTime() {
-		$this->updateEntryfromSubMounts();
-		return $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 = $this->data['permissions'];
-		if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) {
-			$perms = $perms & ~\OCP\Constants::PERMISSION_SHARE;
-		}
-		return $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;
+    }
+
+    /**
+     * @return int
+     */
+    public function getId() {
+        return $this->data['fileid'];
+    }
+
+    /**
+     * @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']) ? $this->data['size'] : 0;
+    }
+
+    /**
+     * @return int
+     */
+    public function getMTime() {
+        $this->updateEntryfromSubMounts();
+        return $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 = $this->data['permissions'];
+        if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) {
+            $perms = $perms & ~\OCP\Constants::PERMISSION_SHARE;
+        }
+        return $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 +3 added lines, -3 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;
@@ -181,7 +181,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'];
@@ -377,7 +377,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;
 		}
 	}