nextcloud / server

apps/dav/lib/Connector/Sabre/CommentPropertiesPlugin.php

Indentation +127 added lines, -127 removed lines

@@ -30,132 +30,132 @@
 
 class CommentPropertiesPlugin extends ServerPlugin {
 
-	const PROPERTY_NAME_HREF   = '{http://owncloud.org/ns}comments-href';
-	const PROPERTY_NAME_COUNT  = '{http://owncloud.org/ns}comments-count';
-	const PROPERTY_NAME_UNREAD = '{http://owncloud.org/ns}comments-unread';
-
-	/** @var  \Sabre\DAV\Server */
-	protected $server;
-
-	/** @var ICommentsManager */
-	private $commentsManager;
-
-	/** @var IUserSession */
-	private $userSession;
-
-	private $cachedUnreadCount = [];
-
-	private $cachedFolders = [];
-
-	public function __construct(ICommentsManager $commentsManager, IUserSession $userSession) {
-		$this->commentsManager = $commentsManager;
-		$this->userSession = $userSession;
-	}
-
-	/**
-	 * This initializes the plugin.
-	 *
-	 * This function is called by Sabre\DAV\Server, after
-	 * addPlugin is called.
-	 *
-	 * This method should set up the required event subscriptions.
-	 *
-	 * @param \Sabre\DAV\Server $server
-	 * @return void
-	 */
-	function initialize(\Sabre\DAV\Server $server) {
-		$this->server = $server;
-		$this->server->on('propFind', array($this, 'handleGetProperties'));
-	}
-
-	/**
-	 * Adds tags and favorites properties to the response,
-	 * if requested.
-	 *
-	 * @param PropFind $propFind
-	 * @param \Sabre\DAV\INode $node
-	 * @return void
-	 */
-	public function handleGetProperties(
-		PropFind $propFind,
-		\Sabre\DAV\INode $node
-	) {
-		if (!($node instanceof File) && !($node instanceof Directory)) {
-			return;
-		}
-
-		// need prefetch ?
-		if ($node instanceof \OCA\DAV\Connector\Sabre\Directory
-			&& $propFind->getDepth() !== 0
-			&& !is_null($propFind->getStatus(self::PROPERTY_NAME_UNREAD))
-		) {
-			$unreadCounts = $this->commentsManager->getNumberOfUnreadCommentsForFolder($node->getId(), $this->userSession->getUser());
-			$this->cachedFolders[] = $node->getPath();
-			foreach ($unreadCounts as $id => $count) {
-				$this->cachedUnreadCount[$id] = $count;
-			}
-		}
-
-		$propFind->handle(self::PROPERTY_NAME_COUNT, function() use ($node) {
-			return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId());
-		});
-
-		$propFind->handle(self::PROPERTY_NAME_HREF, function() use ($node) {
-			return $this->getCommentsLink($node);
-		});
-
-		$propFind->handle(self::PROPERTY_NAME_UNREAD, function() use ($node) {
-			if (isset($this->cachedUnreadCount[$node->getId()])) {
-				return $this->cachedUnreadCount[$node->getId()];
-			} else {
-				list($parentPath,) = \Sabre\Uri\split($node->getPath());
-				if ($parentPath === '') {
-					$parentPath = '/';
-				}
-				// if we already cached the folder this file is in we know there are no shares for this file
-				if (array_search($parentPath, $this->cachedFolders) === false) {
-					return $this->getUnreadCount($node);
-				} else {
-					return 0;
-				}
-			}
-		});
-	}
-
-	/**
-	 * returns a reference to the comments node
-	 *
-	 * @param Node $node
-	 * @return mixed|string
-	 */
-	public function getCommentsLink(Node $node) {
-		$href =  $this->server->getBaseUri();
-		$entryPoint = strpos($href, '/remote.php/');
-		if($entryPoint === false) {
-			// in case we end up somewhere else, unexpectedly.
-			return null;
-		}
-		$commentsPart = 'dav/comments/files/' . rawurldecode($node->getId());
-		$href = substr_replace($href, $commentsPart, $entryPoint + strlen('/remote.php/'));
-		return $href;
-	}
-
-	/**
-	 * returns the number of unread comments for the currently logged in user
-	 * on the given file or directory node
-	 *
-	 * @param Node $node
-	 * @return Int|null
-	 */
-	public function getUnreadCount(Node $node) {
-		$user = $this->userSession->getUser();
-		if(is_null($user)) {
-			return null;
-		}
-
-		$lastRead = $this->commentsManager->getReadMark('files', (string)$node->getId(), $user);
-
-		return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId(), $lastRead);
-	}
+    const PROPERTY_NAME_HREF   = '{http://owncloud.org/ns}comments-href';
+    const PROPERTY_NAME_COUNT  = '{http://owncloud.org/ns}comments-count';
+    const PROPERTY_NAME_UNREAD = '{http://owncloud.org/ns}comments-unread';
+
+    /** @var  \Sabre\DAV\Server */
+    protected $server;
+
+    /** @var ICommentsManager */
+    private $commentsManager;
+
+    /** @var IUserSession */
+    private $userSession;
+
+    private $cachedUnreadCount = [];
+
+    private $cachedFolders = [];
+
+    public function __construct(ICommentsManager $commentsManager, IUserSession $userSession) {
+        $this->commentsManager = $commentsManager;
+        $this->userSession = $userSession;
+    }
+
+    /**
+     * This initializes the plugin.
+     *
+     * This function is called by Sabre\DAV\Server, after
+     * addPlugin is called.
+     *
+     * This method should set up the required event subscriptions.
+     *
+     * @param \Sabre\DAV\Server $server
+     * @return void
+     */
+    function initialize(\Sabre\DAV\Server $server) {
+        $this->server = $server;
+        $this->server->on('propFind', array($this, 'handleGetProperties'));
+    }
+
+    /**
+     * Adds tags and favorites properties to the response,
+     * if requested.
+     *
+     * @param PropFind $propFind
+     * @param \Sabre\DAV\INode $node
+     * @return void
+     */
+    public function handleGetProperties(
+        PropFind $propFind,
+        \Sabre\DAV\INode $node
+    ) {
+        if (!($node instanceof File) && !($node instanceof Directory)) {
+            return;
+        }
+
+        // need prefetch ?
+        if ($node instanceof \OCA\DAV\Connector\Sabre\Directory
+            && $propFind->getDepth() !== 0
+            && !is_null($propFind->getStatus(self::PROPERTY_NAME_UNREAD))
+        ) {
+            $unreadCounts = $this->commentsManager->getNumberOfUnreadCommentsForFolder($node->getId(), $this->userSession->getUser());
+            $this->cachedFolders[] = $node->getPath();
+            foreach ($unreadCounts as $id => $count) {
+                $this->cachedUnreadCount[$id] = $count;
+            }
+        }
+
+        $propFind->handle(self::PROPERTY_NAME_COUNT, function() use ($node) {
+            return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId());
+        });
+
+        $propFind->handle(self::PROPERTY_NAME_HREF, function() use ($node) {
+            return $this->getCommentsLink($node);
+        });
+
+        $propFind->handle(self::PROPERTY_NAME_UNREAD, function() use ($node) {
+            if (isset($this->cachedUnreadCount[$node->getId()])) {
+                return $this->cachedUnreadCount[$node->getId()];
+            } else {
+                list($parentPath,) = \Sabre\Uri\split($node->getPath());
+                if ($parentPath === '') {
+                    $parentPath = '/';
+                }
+                // if we already cached the folder this file is in we know there are no shares for this file
+                if (array_search($parentPath, $this->cachedFolders) === false) {
+                    return $this->getUnreadCount($node);
+                } else {
+                    return 0;
+                }
+            }
+        });
+    }
+
+    /**
+     * returns a reference to the comments node
+     *
+     * @param Node $node
+     * @return mixed|string
+     */
+    public function getCommentsLink(Node $node) {
+        $href =  $this->server->getBaseUri();
+        $entryPoint = strpos($href, '/remote.php/');
+        if($entryPoint === false) {
+            // in case we end up somewhere else, unexpectedly.
+            return null;
+        }
+        $commentsPart = 'dav/comments/files/' . rawurldecode($node->getId());
+        $href = substr_replace($href, $commentsPart, $entryPoint + strlen('/remote.php/'));
+        return $href;
+    }
+
+    /**
+     * returns the number of unread comments for the currently logged in user
+     * on the given file or directory node
+     *
+     * @param Node $node
+     * @return Int|null
+     */
+    public function getUnreadCount(Node $node) {
+        $user = $this->userSession->getUser();
+        if(is_null($user)) {
+            return null;
+        }
+
+        $lastRead = $this->commentsManager->getReadMark('files', (string)$node->getId(), $user);
+
+        return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId(), $lastRead);
+    }
 
 }

Spacing +7 added lines, -7 removed lines

@@ -97,7 +97,7 @@ 
 		}
 
 		$propFind->handle(self::PROPERTY_NAME_COUNT, function() use ($node) {
-			return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId());
+			return $this->commentsManager->getNumberOfCommentsForObject('files', (string) $node->getId());
 		});
 
 		$propFind->handle(self::PROPERTY_NAME_HREF, function() use ($node) {
@@ -129,13 +129,13 @@ 
 	 * @return mixed|string
 	 */
 	public function getCommentsLink(Node $node) {
-		$href =  $this->server->getBaseUri();
+		$href = $this->server->getBaseUri();
 		$entryPoint = strpos($href, '/remote.php/');
-		if($entryPoint === false) {
+		if ($entryPoint === false) {
 			// in case we end up somewhere else, unexpectedly.
 			return null;
 		}
-		$commentsPart = 'dav/comments/files/' . rawurldecode($node->getId());
+		$commentsPart = 'dav/comments/files/'.rawurldecode($node->getId());
 		$href = substr_replace($href, $commentsPart, $entryPoint + strlen('/remote.php/'));
 		return $href;
 	}
@@ -149,13 +149,13 @@ 
 	 */
 	public function getUnreadCount(Node $node) {
 		$user = $this->userSession->getUser();
-		if(is_null($user)) {
+		if (is_null($user)) {
 			return null;
 		}
 
-		$lastRead = $this->commentsManager->getReadMark('files', (string)$node->getId(), $user);
+		$lastRead = $this->commentsManager->getReadMark('files', (string) $node->getId(), $user);
 
-		return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId(), $lastRead);
+		return $this->commentsManager->getNumberOfCommentsForObject('files', (string) $node->getId(), $lastRead);
 	}
 
 }

apps/dav/lib/Connector/Sabre/Node.php

Indentation +322 added lines, -322 removed lines

@@ -44,332 +44,332 @@
 
 abstract class Node implements \Sabre\DAV\INode {
 
-	/**
-	 * @var \OC\Files\View
-	 */
-	protected $fileView;
-
-	/**
-	 * The path to the current node
-	 *
-	 * @var string
-	 */
-	protected $path;
-
-	/**
-	 * node properties cache
-	 *
-	 * @var array
-	 */
-	protected $property_cache = null;
-
-	/**
-	 * @var \OCP\Files\FileInfo
-	 */
-	protected $info;
-
-	/**
-	 * @var IManager
-	 */
-	protected $shareManager;
-
-	/**
-	 * Sets up the node, expects a full path name
-	 *
-	 * @param \OC\Files\View $view
-	 * @param \OCP\Files\FileInfo $info
-	 * @param IManager $shareManager
-	 */
-	public function __construct(View $view, FileInfo $info, IManager $shareManager = null) {
-		$this->fileView = $view;
-		$this->path = $this->fileView->getRelativePath($info->getPath());
-		$this->info = $info;
-		if ($shareManager) {
-			$this->shareManager = $shareManager;
-		} else {
-			$this->shareManager = \OC::$server->getShareManager();
-		}
-	}
-
-	protected function refreshInfo() {
-		$this->info = $this->fileView->getFileInfo($this->path);
-	}
-
-	/**
-	 *  Returns the name of the node
-	 *
-	 * @return string
-	 */
-	public function getName() {
-		return $this->info->getName();
-	}
-
-	/**
-	 * Returns the full path
-	 *
-	 * @return string
-	 */
-	public function getPath() {
-		return $this->path;
-	}
-
-	/**
-	 * Renames the node
-	 *
-	 * @param string $name The new name
-	 * @throws \Sabre\DAV\Exception\BadRequest
-	 * @throws \Sabre\DAV\Exception\Forbidden
-	 */
-	public function setName($name) {
-
-		// rename is only allowed if the update privilege is granted
-		if (!$this->info->isUpdateable()) {
-			throw new \Sabre\DAV\Exception\Forbidden();
-		}
-
-		list($parentPath,) = \Sabre\Uri\split($this->path);
-		list(, $newName) = \Sabre\Uri\split($name);
-
-		// verify path of the target
-		$this->verifyPath();
-
-		$newPath = $parentPath . '/' . $newName;
-
-		$this->fileView->rename($this->path, $newPath);
-
-		$this->path = $newPath;
-
-		$this->refreshInfo();
-	}
-
-	public function setPropertyCache($property_cache) {
-		$this->property_cache = $property_cache;
-	}
-
-	/**
-	 * Returns the last modification time, as a unix timestamp
-	 *
-	 * @return int timestamp as integer
-	 */
-	public function getLastModified() {
-		$timestamp = $this->info->getMtime();
-		if (!empty($timestamp)) {
-			return (int)$timestamp;
-		}
-		return $timestamp;
-	}
-
-	/**
-	 *  sets the last modification time of the file (mtime) to the value given
-	 *  in the second parameter or to now if the second param is empty.
-	 *  Even if the modification time is set to a custom value the access time is set to now.
-	 */
-	public function touch($mtime) {
-		$mtime = $this->sanitizeMtime($mtime);
-		$this->fileView->touch($this->path, $mtime);
-		$this->refreshInfo();
-	}
-
-	/**
-	 * Returns the ETag for a file
-	 *
-	 * An ETag is a unique identifier representing the current version of the
-	 * file. If the file changes, the ETag MUST change.  The ETag is an
-	 * arbitrary string, but MUST be surrounded by double-quotes.
-	 *
-	 * Return null if the ETag can not effectively be determined
-	 *
-	 * @return string
-	 */
-	public function getETag() {
-		return '"' . $this->info->getEtag() . '"';
-	}
-
-	/**
-	 * Sets the ETag
-	 *
-	 * @param string $etag
-	 *
-	 * @return int file id of updated file or -1 on failure
-	 */
-	public function setETag($etag) {
-		return $this->fileView->putFileInfo($this->path, array('etag' => $etag));
-	}
-
-	/**
-	 * Returns the size of the node, in bytes
-	 *
-	 * @return integer
-	 */
-	public function getSize() {
-		return $this->info->getSize();
-	}
-
-	/**
-	 * Returns the cache's file id
-	 *
-	 * @return int
-	 */
-	public function getId() {
-		return $this->info->getId();
-	}
-
-	/**
-	 * @return string|null
-	 */
-	public function getFileId() {
-		if ($this->info->getId()) {
-			$instanceId = \OC_Util::getInstanceId();
-			$id = sprintf('%08d', $this->info->getId());
-			return $id . $instanceId;
-		}
-
-		return null;
-	}
-
-	/**
-	 * @return integer
-	 */
-	public function getInternalFileId() {
-		return $this->info->getId();
-	}
-
-	/**
-	 * @param string $user
-	 * @return int
-	 */
-	public function getSharePermissions($user) {
-
-		// check of we access a federated share
-		if ($user !== null) {
-			try {
-				$share = $this->shareManager->getShareByToken($user);
-				return $share->getPermissions();
-			} catch (ShareNotFound $e) {
-				// ignore
-			}
-		}
-
-		$storage = $this->info->getStorage();
-
-		$path = $this->info->getInternalPath();
-
-		if ($storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
-			/** @var \OCA\Files_Sharing\SharedStorage $storage */
-			$permissions = (int)$storage->getShare()->getPermissions();
-		} else {
-			$permissions = $storage->getPermissions($path);
-		}
-
-		/*
+    /**
+     * @var \OC\Files\View
+     */
+    protected $fileView;
+
+    /**
+     * The path to the current node
+     *
+     * @var string
+     */
+    protected $path;
+
+    /**
+     * node properties cache
+     *
+     * @var array
+     */
+    protected $property_cache = null;
+
+    /**
+     * @var \OCP\Files\FileInfo
+     */
+    protected $info;
+
+    /**
+     * @var IManager
+     */
+    protected $shareManager;
+
+    /**
+     * Sets up the node, expects a full path name
+     *
+     * @param \OC\Files\View $view
+     * @param \OCP\Files\FileInfo $info
+     * @param IManager $shareManager
+     */
+    public function __construct(View $view, FileInfo $info, IManager $shareManager = null) {
+        $this->fileView = $view;
+        $this->path = $this->fileView->getRelativePath($info->getPath());
+        $this->info = $info;
+        if ($shareManager) {
+            $this->shareManager = $shareManager;
+        } else {
+            $this->shareManager = \OC::$server->getShareManager();
+        }
+    }
+
+    protected function refreshInfo() {
+        $this->info = $this->fileView->getFileInfo($this->path);
+    }
+
+    /**
+     *  Returns the name of the node
+     *
+     * @return string
+     */
+    public function getName() {
+        return $this->info->getName();
+    }
+
+    /**
+     * Returns the full path
+     *
+     * @return string
+     */
+    public function getPath() {
+        return $this->path;
+    }
+
+    /**
+     * Renames the node
+     *
+     * @param string $name The new name
+     * @throws \Sabre\DAV\Exception\BadRequest
+     * @throws \Sabre\DAV\Exception\Forbidden
+     */
+    public function setName($name) {
+
+        // rename is only allowed if the update privilege is granted
+        if (!$this->info->isUpdateable()) {
+            throw new \Sabre\DAV\Exception\Forbidden();
+        }
+
+        list($parentPath,) = \Sabre\Uri\split($this->path);
+        list(, $newName) = \Sabre\Uri\split($name);
+
+        // verify path of the target
+        $this->verifyPath();
+
+        $newPath = $parentPath . '/' . $newName;
+
+        $this->fileView->rename($this->path, $newPath);
+
+        $this->path = $newPath;
+
+        $this->refreshInfo();
+    }
+
+    public function setPropertyCache($property_cache) {
+        $this->property_cache = $property_cache;
+    }
+
+    /**
+     * Returns the last modification time, as a unix timestamp
+     *
+     * @return int timestamp as integer
+     */
+    public function getLastModified() {
+        $timestamp = $this->info->getMtime();
+        if (!empty($timestamp)) {
+            return (int)$timestamp;
+        }
+        return $timestamp;
+    }
+
+    /**
+     *  sets the last modification time of the file (mtime) to the value given
+     *  in the second parameter or to now if the second param is empty.
+     *  Even if the modification time is set to a custom value the access time is set to now.
+     */
+    public function touch($mtime) {
+        $mtime = $this->sanitizeMtime($mtime);
+        $this->fileView->touch($this->path, $mtime);
+        $this->refreshInfo();
+    }
+
+    /**
+     * Returns the ETag for a file
+     *
+     * An ETag is a unique identifier representing the current version of the
+     * file. If the file changes, the ETag MUST change.  The ETag is an
+     * arbitrary string, but MUST be surrounded by double-quotes.
+     *
+     * Return null if the ETag can not effectively be determined
+     *
+     * @return string
+     */
+    public function getETag() {
+        return '"' . $this->info->getEtag() . '"';
+    }
+
+    /**
+     * Sets the ETag
+     *
+     * @param string $etag
+     *
+     * @return int file id of updated file or -1 on failure
+     */
+    public function setETag($etag) {
+        return $this->fileView->putFileInfo($this->path, array('etag' => $etag));
+    }
+
+    /**
+     * Returns the size of the node, in bytes
+     *
+     * @return integer
+     */
+    public function getSize() {
+        return $this->info->getSize();
+    }
+
+    /**
+     * Returns the cache's file id
+     *
+     * @return int
+     */
+    public function getId() {
+        return $this->info->getId();
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getFileId() {
+        if ($this->info->getId()) {
+            $instanceId = \OC_Util::getInstanceId();
+            $id = sprintf('%08d', $this->info->getId());
+            return $id . $instanceId;
+        }
+
+        return null;
+    }
+
+    /**
+     * @return integer
+     */
+    public function getInternalFileId() {
+        return $this->info->getId();
+    }
+
+    /**
+     * @param string $user
+     * @return int
+     */
+    public function getSharePermissions($user) {
+
+        // check of we access a federated share
+        if ($user !== null) {
+            try {
+                $share = $this->shareManager->getShareByToken($user);
+                return $share->getPermissions();
+            } catch (ShareNotFound $e) {
+                // ignore
+            }
+        }
+
+        $storage = $this->info->getStorage();
+
+        $path = $this->info->getInternalPath();
+
+        if ($storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
+            /** @var \OCA\Files_Sharing\SharedStorage $storage */
+            $permissions = (int)$storage->getShare()->getPermissions();
+        } else {
+            $permissions = $storage->getPermissions($path);
+        }
+
+        /*
 		 * We can always share non moveable mount points with DELETE and UPDATE
 		 * Eventually we need to do this properly
 		 */
-		$mountpoint = $this->info->getMountPoint();
-		if (!($mountpoint instanceof MoveableMount)) {
-			$mountpointpath = $mountpoint->getMountPoint();
-			if (substr($mountpointpath, -1) === '/') {
-				$mountpointpath = substr($mountpointpath, 0, -1);
-			}
-
-			if ($mountpointpath === $this->info->getPath()) {
-				$permissions |= \OCP\Constants::PERMISSION_DELETE | \OCP\Constants::PERMISSION_UPDATE;
-			}
-		}
-
-		/*
+        $mountpoint = $this->info->getMountPoint();
+        if (!($mountpoint instanceof MoveableMount)) {
+            $mountpointpath = $mountpoint->getMountPoint();
+            if (substr($mountpointpath, -1) === '/') {
+                $mountpointpath = substr($mountpointpath, 0, -1);
+            }
+
+            if ($mountpointpath === $this->info->getPath()) {
+                $permissions |= \OCP\Constants::PERMISSION_DELETE | \OCP\Constants::PERMISSION_UPDATE;
+            }
+        }
+
+        /*
 		 * Files can't have create or delete permissions
 		 */
-		if ($this->info->getType() === \OCP\Files\FileInfo::TYPE_FILE) {
-			$permissions &= ~(\OCP\Constants::PERMISSION_CREATE | \OCP\Constants::PERMISSION_DELETE);
-		}
-
-		return $permissions;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getDavPermissions() {
-		$p = '';
-		if ($this->info->isShared()) {
-			$p .= 'S';
-		}
-		if ($this->info->isShareable()) {
-			$p .= 'R';
-		}
-		if ($this->info->isMounted()) {
-			$p .= 'M';
-		}
-		if ($this->info->isReadable()) {
-			$p .= 'G';
-		}
-		if ($this->info->isDeletable()) {
-			$p .= 'D';
-		}
-		if ($this->info->isUpdateable()) {
-			$p .= 'NV'; // Renameable, Moveable
-		}
-		if ($this->info->getType() === \OCP\Files\FileInfo::TYPE_FILE) {
-			if ($this->info->isUpdateable()) {
-				$p .= 'W';
-			}
-		} else {
-			if ($this->info->isCreatable()) {
-				$p .= 'CK';
-			}
-		}
-		return $p;
-	}
-
-	public function getOwner() {
-		return $this->info->getOwner();
-	}
-
-	protected function verifyPath() {
-		try {
-			$fileName = basename($this->info->getPath());
-			$this->fileView->verifyPath($this->path, $fileName);
-		} catch (\OCP\Files\InvalidPathException $ex) {
-			throw new InvalidPath($ex->getMessage());
-		}
-	}
-
-	/**
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 */
-	public function acquireLock($type) {
-		$this->fileView->lockFile($this->path, $type);
-	}
-
-	/**
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 */
-	public function releaseLock($type) {
-		$this->fileView->unlockFile($this->path, $type);
-	}
-
-	/**
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 */
-	public function changeLock($type) {
-		$this->fileView->changeLock($this->path, $type);
-	}
-
-	public function getFileInfo() {
-		return $this->info;
-	}
-
-	protected function sanitizeMtime($mtimeFromRequest) {
-		// In PHP 5.X "is_numeric" returns true for strings in hexadecimal
-		// notation. This is no longer the case in PHP 7.X, so this check
-		// ensures that strings with hexadecimal notations fail too in PHP 5.X.
-		$isHexadecimal = is_string($mtimeFromRequest) && preg_match('/^\s*0[xX]/', $mtimeFromRequest);
-		if ($isHexadecimal || !is_numeric($mtimeFromRequest)) {
-			throw new \InvalidArgumentException('X-OC-MTime header must be an integer (unix timestamp).');
-		}
-
-		return (int)$mtimeFromRequest;
-	}
+        if ($this->info->getType() === \OCP\Files\FileInfo::TYPE_FILE) {
+            $permissions &= ~(\OCP\Constants::PERMISSION_CREATE | \OCP\Constants::PERMISSION_DELETE);
+        }
+
+        return $permissions;
+    }
+
+    /**
+     * @return string
+     */
+    public function getDavPermissions() {
+        $p = '';
+        if ($this->info->isShared()) {
+            $p .= 'S';
+        }
+        if ($this->info->isShareable()) {
+            $p .= 'R';
+        }
+        if ($this->info->isMounted()) {
+            $p .= 'M';
+        }
+        if ($this->info->isReadable()) {
+            $p .= 'G';
+        }
+        if ($this->info->isDeletable()) {
+            $p .= 'D';
+        }
+        if ($this->info->isUpdateable()) {
+            $p .= 'NV'; // Renameable, Moveable
+        }
+        if ($this->info->getType() === \OCP\Files\FileInfo::TYPE_FILE) {
+            if ($this->info->isUpdateable()) {
+                $p .= 'W';
+            }
+        } else {
+            if ($this->info->isCreatable()) {
+                $p .= 'CK';
+            }
+        }
+        return $p;
+    }
+
+    public function getOwner() {
+        return $this->info->getOwner();
+    }
+
+    protected function verifyPath() {
+        try {
+            $fileName = basename($this->info->getPath());
+            $this->fileView->verifyPath($this->path, $fileName);
+        } catch (\OCP\Files\InvalidPathException $ex) {
+            throw new InvalidPath($ex->getMessage());
+        }
+    }
+
+    /**
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     */
+    public function acquireLock($type) {
+        $this->fileView->lockFile($this->path, $type);
+    }
+
+    /**
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     */
+    public function releaseLock($type) {
+        $this->fileView->unlockFile($this->path, $type);
+    }
+
+    /**
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     */
+    public function changeLock($type) {
+        $this->fileView->changeLock($this->path, $type);
+    }
+
+    public function getFileInfo() {
+        return $this->info;
+    }
+
+    protected function sanitizeMtime($mtimeFromRequest) {
+        // In PHP 5.X "is_numeric" returns true for strings in hexadecimal
+        // notation. This is no longer the case in PHP 7.X, so this check
+        // ensures that strings with hexadecimal notations fail too in PHP 5.X.
+        $isHexadecimal = is_string($mtimeFromRequest) && preg_match('/^\s*0[xX]/', $mtimeFromRequest);
+        if ($isHexadecimal || !is_numeric($mtimeFromRequest)) {
+            throw new \InvalidArgumentException('X-OC-MTime header must be an integer (unix timestamp).');
+        }
+
+        return (int)$mtimeFromRequest;
+    }
 
 }

Spacing +6 added lines, -6 removed lines

@@ -133,7 +133,7 @@ 
 		// verify path of the target
 		$this->verifyPath();
 
-		$newPath = $parentPath . '/' . $newName;
+		$newPath = $parentPath.'/'.$newName;
 
 		$this->fileView->rename($this->path, $newPath);
 
@@ -154,7 +154,7 @@ 
 	public function getLastModified() {
 		$timestamp = $this->info->getMtime();
 		if (!empty($timestamp)) {
-			return (int)$timestamp;
+			return (int) $timestamp;
 		}
 		return $timestamp;
 	}
@@ -182,7 +182,7 @@ 
 	 * @return string
 	 */
 	public function getETag() {
-		return '"' . $this->info->getEtag() . '"';
+		return '"'.$this->info->getEtag().'"';
 	}
 
 	/**
@@ -221,7 +221,7 @@ 
 		if ($this->info->getId()) {
 			$instanceId = \OC_Util::getInstanceId();
 			$id = sprintf('%08d', $this->info->getId());
-			return $id . $instanceId;
+			return $id.$instanceId;
 		}
 
 		return null;
@@ -256,7 +256,7 @@ 
 
 		if ($storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
 			/** @var \OCA\Files_Sharing\SharedStorage $storage */
-			$permissions = (int)$storage->getShare()->getPermissions();
+			$permissions = (int) $storage->getShare()->getPermissions();
 		} else {
 			$permissions = $storage->getPermissions($path);
 		}
@@ -369,7 +369,7 @@ 
 			throw new \InvalidArgumentException('X-OC-MTime header must be an integer (unix timestamp).');
 		}
 
-		return (int)$mtimeFromRequest;
+		return (int) $mtimeFromRequest;
 	}
 
 }

apps/dav/lib/CalDAV/Search/Xml/Filter/OffsetFilter.php

Indentation +12 added lines, -12 removed lines

@@ -29,17 +29,17 @@
 
 class OffsetFilter implements XmlDeserializable {
 
-	/**
-	 * @param Reader $reader
-	 * @throws BadRequest
-	 * @return int
-	 */
-	static function xmlDeserialize(Reader $reader) {
-		$value = $reader->parseInnerTree();
-		if (!is_int($value) && !is_string($value)) {
-			throw new BadRequest('The {' . SearchPlugin::NS_Nextcloud . '}offset has illegal value');
-		}
+    /**
+     * @param Reader $reader
+     * @throws BadRequest
+     * @return int
+     */
+    static function xmlDeserialize(Reader $reader) {
+        $value = $reader->parseInnerTree();
+        if (!is_int($value) && !is_string($value)) {
+            throw new BadRequest('The {' . SearchPlugin::NS_Nextcloud . '}offset has illegal value');
+        }
 
-		return (int)$value;
-	}
+        return (int)$value;
+    }
 }
\ No newline at end of file

Spacing +2 added lines, -2 removed lines

@@ -37,9 +37,9 @@
 	static function xmlDeserialize(Reader $reader) {
 		$value = $reader->parseInnerTree();
 		if (!is_int($value) && !is_string($value)) {
-			throw new BadRequest('The {' . SearchPlugin::NS_Nextcloud . '}offset has illegal value');
+			throw new BadRequest('The {'.SearchPlugin::NS_Nextcloud.'}offset has illegal value');
 		}
 
-		return (int)$value;
+		return (int) $value;
 	}
 }
\ No newline at end of file

apps/dav/lib/CalDAV/Search/Xml/Filter/LimitFilter.php

Indentation +12 added lines, -12 removed lines

@@ -29,17 +29,17 @@
 
 class LimitFilter implements XmlDeserializable {
 
-	/**
-	 * @param Reader $reader
-	 * @throws BadRequest
-	 * @return int
-	 */
-	static function xmlDeserialize(Reader $reader) {
-		$value = $reader->parseInnerTree();
-		if (!is_int($value) && !is_string($value)) {
-			throw new BadRequest('The {' . SearchPlugin::NS_Nextcloud . '}limit has illegal value');
-		}
+    /**
+     * @param Reader $reader
+     * @throws BadRequest
+     * @return int
+     */
+    static function xmlDeserialize(Reader $reader) {
+        $value = $reader->parseInnerTree();
+        if (!is_int($value) && !is_string($value)) {
+            throw new BadRequest('The {' . SearchPlugin::NS_Nextcloud . '}limit has illegal value');
+        }
 
-		return (int)$value;
-	}
+        return (int)$value;
+    }
 }
\ No newline at end of file

Spacing +2 added lines, -2 removed lines

@@ -37,9 +37,9 @@
 	static function xmlDeserialize(Reader $reader) {
 		$value = $reader->parseInnerTree();
 		if (!is_int($value) && !is_string($value)) {
-			throw new BadRequest('The {' . SearchPlugin::NS_Nextcloud . '}limit has illegal value');
+			throw new BadRequest('The {'.SearchPlugin::NS_Nextcloud.'}limit has illegal value');
 		}
 
-		return (int)$value;
+		return (int) $value;
 	}
 }
\ No newline at end of file

apps/files_trashbin/lib/Expiration.php

Indentation +135 added lines, -135 removed lines

@@ -28,139 +28,139 @@
 
 class Expiration {
 
-	// how long do we keep files in the trash bin if no other value is defined in the config file (unit: days)
-	const DEFAULT_RETENTION_OBLIGATION = 30;
-	const NO_OBLIGATION = -1;
-
-	/** @var ITimeFactory */
-	private $timeFactory;
-
-	/** @var string */
-	private $retentionObligation;
-
-	/** @var int */
-	private $minAge;
-
-	/** @var int */
-	private $maxAge;
-
-	/** @var bool */
-	private $canPurgeToSaveSpace;
-
-	public function __construct(IConfig $config,ITimeFactory $timeFactory){
-		$this->timeFactory = $timeFactory;
-		$this->retentionObligation = $config->getSystemValue('trashbin_retention_obligation', 'auto');
-
-		if ($this->retentionObligation !== 'disabled') {
-			$this->parseRetentionObligation();
-		}
-	}
-
-	/**
-	 * Is trashbin expiration enabled
-	 * @return bool
-	 */
-	public function isEnabled(){
-		return $this->retentionObligation !== 'disabled';
-	}
-
-	/**
-	 * Check if given timestamp in expiration range
-	 * @param int $timestamp
-	 * @param bool $quotaExceeded
-	 * @return bool
-	 */
-	public function isExpired($timestamp, $quotaExceeded = false){
-		// No expiration if disabled
-		if (!$this->isEnabled()) {
-			return false;
-		}
-
-		// Purge to save space (if allowed)
-		if ($quotaExceeded && $this->canPurgeToSaveSpace) {
-			return true;
-		}
-
-		$time = $this->timeFactory->getTime();
-		// Never expire dates in future e.g. misconfiguration or negative time
-		// adjustment
-		if ($time<$timestamp) {
-			return false;
-		}
-
-		// Purge as too old
-		if ($this->maxAge !== self::NO_OBLIGATION) {
-			$maxTimestamp = $time - ($this->maxAge * 86400);
-			$isOlderThanMax = $timestamp < $maxTimestamp;
-		} else {
-			$isOlderThanMax = false;
-		}
-
-		if ($this->minAge !== self::NO_OBLIGATION) {
-			// older than Min obligation and we are running out of quota?
-			$minTimestamp = $time - ($this->minAge * 86400);
-			$isMinReached = ($timestamp < $minTimestamp) && $quotaExceeded;
-		} else {
-			$isMinReached = false;
-		}
-
-		return $isOlderThanMax || $isMinReached;
-	}
-
-	/**
-	 * @return bool|int
-	 */
-	public function getMaxAgeAsTimestamp() {
-		$maxAge = false;
-		if ($this->isEnabled() && $this->maxAge !== self::NO_OBLIGATION) {
-			$time = $this->timeFactory->getTime();
-			$maxAge = $time - ($this->maxAge * 86400);
-		}
-		return $maxAge;
-	}
-
-	private function parseRetentionObligation(){
-		$splitValues = explode(',', $this->retentionObligation);
-		if (!isset($splitValues[0])) {
-			$minValue = self::DEFAULT_RETENTION_OBLIGATION;
-		} else {
-			$minValue = trim($splitValues[0]);
-		}
-
-		if (!isset($splitValues[1]) && $minValue === 'auto') {
-			$maxValue = 'auto';
-		} elseif (!isset($splitValues[1])) {
-			$maxValue = self::DEFAULT_RETENTION_OBLIGATION;
-		} else {
-			$maxValue = trim($splitValues[1]);
-		}
-
-		if ($minValue === 'auto' && $maxValue === 'auto') {
-			// Default: Keep for 30 days but delete anytime if space needed
-			$this->minAge = self::DEFAULT_RETENTION_OBLIGATION;
-			$this->maxAge = self::NO_OBLIGATION;
-			$this->canPurgeToSaveSpace = true;
-		} elseif ($minValue !== 'auto' && $maxValue === 'auto') {
-			// Keep for X days but delete anytime if space needed
-			$this->minAge = (int)$minValue;
-			$this->maxAge = self::NO_OBLIGATION;
-			$this->canPurgeToSaveSpace = true;
-		} elseif ($minValue === 'auto' && $maxValue !== 'auto') {
-			// Delete anytime if space needed, Delete all older than max automatically
-			$this->minAge = self::NO_OBLIGATION;
-			$this->maxAge = (int)$maxValue;
-			$this->canPurgeToSaveSpace = true;
-		} elseif ($minValue !== 'auto' && $maxValue !== 'auto') {
-			// Delete all older than max OR older than min if space needed
-
-			// Max < Min as per https://github.com/owncloud/core/issues/16300
-			if ($maxValue < $minValue) {
-				$maxValue = $minValue;
-			}
-
-			$this->minAge = (int)$minValue;
-			$this->maxAge = (int)$maxValue;
-			$this->canPurgeToSaveSpace = false;
-		}
-	}
+    // how long do we keep files in the trash bin if no other value is defined in the config file (unit: days)
+    const DEFAULT_RETENTION_OBLIGATION = 30;
+    const NO_OBLIGATION = -1;
+
+    /** @var ITimeFactory */
+    private $timeFactory;
+
+    /** @var string */
+    private $retentionObligation;
+
+    /** @var int */
+    private $minAge;
+
+    /** @var int */
+    private $maxAge;
+
+    /** @var bool */
+    private $canPurgeToSaveSpace;
+
+    public function __construct(IConfig $config,ITimeFactory $timeFactory){
+        $this->timeFactory = $timeFactory;
+        $this->retentionObligation = $config->getSystemValue('trashbin_retention_obligation', 'auto');
+
+        if ($this->retentionObligation !== 'disabled') {
+            $this->parseRetentionObligation();
+        }
+    }
+
+    /**
+     * Is trashbin expiration enabled
+     * @return bool
+     */
+    public function isEnabled(){
+        return $this->retentionObligation !== 'disabled';
+    }
+
+    /**
+     * Check if given timestamp in expiration range
+     * @param int $timestamp
+     * @param bool $quotaExceeded
+     * @return bool
+     */
+    public function isExpired($timestamp, $quotaExceeded = false){
+        // No expiration if disabled
+        if (!$this->isEnabled()) {
+            return false;
+        }
+
+        // Purge to save space (if allowed)
+        if ($quotaExceeded && $this->canPurgeToSaveSpace) {
+            return true;
+        }
+
+        $time = $this->timeFactory->getTime();
+        // Never expire dates in future e.g. misconfiguration or negative time
+        // adjustment
+        if ($time<$timestamp) {
+            return false;
+        }
+
+        // Purge as too old
+        if ($this->maxAge !== self::NO_OBLIGATION) {
+            $maxTimestamp = $time - ($this->maxAge * 86400);
+            $isOlderThanMax = $timestamp < $maxTimestamp;
+        } else {
+            $isOlderThanMax = false;
+        }
+
+        if ($this->minAge !== self::NO_OBLIGATION) {
+            // older than Min obligation and we are running out of quota?
+            $minTimestamp = $time - ($this->minAge * 86400);
+            $isMinReached = ($timestamp < $minTimestamp) && $quotaExceeded;
+        } else {
+            $isMinReached = false;
+        }
+
+        return $isOlderThanMax || $isMinReached;
+    }
+
+    /**
+     * @return bool|int
+     */
+    public function getMaxAgeAsTimestamp() {
+        $maxAge = false;
+        if ($this->isEnabled() && $this->maxAge !== self::NO_OBLIGATION) {
+            $time = $this->timeFactory->getTime();
+            $maxAge = $time - ($this->maxAge * 86400);
+        }
+        return $maxAge;
+    }
+
+    private function parseRetentionObligation(){
+        $splitValues = explode(',', $this->retentionObligation);
+        if (!isset($splitValues[0])) {
+            $minValue = self::DEFAULT_RETENTION_OBLIGATION;
+        } else {
+            $minValue = trim($splitValues[0]);
+        }
+
+        if (!isset($splitValues[1]) && $minValue === 'auto') {
+            $maxValue = 'auto';
+        } elseif (!isset($splitValues[1])) {
+            $maxValue = self::DEFAULT_RETENTION_OBLIGATION;
+        } else {
+            $maxValue = trim($splitValues[1]);
+        }
+
+        if ($minValue === 'auto' && $maxValue === 'auto') {
+            // Default: Keep for 30 days but delete anytime if space needed
+            $this->minAge = self::DEFAULT_RETENTION_OBLIGATION;
+            $this->maxAge = self::NO_OBLIGATION;
+            $this->canPurgeToSaveSpace = true;
+        } elseif ($minValue !== 'auto' && $maxValue === 'auto') {
+            // Keep for X days but delete anytime if space needed
+            $this->minAge = (int)$minValue;
+            $this->maxAge = self::NO_OBLIGATION;
+            $this->canPurgeToSaveSpace = true;
+        } elseif ($minValue === 'auto' && $maxValue !== 'auto') {
+            // Delete anytime if space needed, Delete all older than max automatically
+            $this->minAge = self::NO_OBLIGATION;
+            $this->maxAge = (int)$maxValue;
+            $this->canPurgeToSaveSpace = true;
+        } elseif ($minValue !== 'auto' && $maxValue !== 'auto') {
+            // Delete all older than max OR older than min if space needed
+
+            // Max < Min as per https://github.com/owncloud/core/issues/16300
+            if ($maxValue < $minValue) {
+                $maxValue = $minValue;
+            }
+
+            $this->minAge = (int)$minValue;
+            $this->maxAge = (int)$maxValue;
+            $this->canPurgeToSaveSpace = false;
+        }
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -47,7 +47,7 @@ 
 	/** @var bool */
 	private $canPurgeToSaveSpace;
 
-	public function __construct(IConfig $config,ITimeFactory $timeFactory){
+	public function __construct(IConfig $config, ITimeFactory $timeFactory) {
 		$this->timeFactory = $timeFactory;
 		$this->retentionObligation = $config->getSystemValue('trashbin_retention_obligation', 'auto');
 
@@ -60,7 +60,7 @@ 
 	 * Is trashbin expiration enabled
 	 * @return bool
 	 */
-	public function isEnabled(){
+	public function isEnabled() {
 		return $this->retentionObligation !== 'disabled';
 	}
 
@@ -70,7 +70,7 @@ 
 	 * @param bool $quotaExceeded
 	 * @return bool
 	 */
-	public function isExpired($timestamp, $quotaExceeded = false){
+	public function isExpired($timestamp, $quotaExceeded = false) {
 		// No expiration if disabled
 		if (!$this->isEnabled()) {
 			return false;
@@ -84,7 +84,7 @@ 
 		$time = $this->timeFactory->getTime();
 		// Never expire dates in future e.g. misconfiguration or negative time
 		// adjustment
-		if ($time<$timestamp) {
+		if ($time < $timestamp) {
 			return false;
 		}
 
@@ -119,7 +119,7 @@ 
 		return $maxAge;
 	}
 
-	private function parseRetentionObligation(){
+	private function parseRetentionObligation() {
 		$splitValues = explode(',', $this->retentionObligation);
 		if (!isset($splitValues[0])) {
 			$minValue = self::DEFAULT_RETENTION_OBLIGATION;
@@ -142,13 +142,13 @@ 
 			$this->canPurgeToSaveSpace = true;
 		} elseif ($minValue !== 'auto' && $maxValue === 'auto') {
 			// Keep for X days but delete anytime if space needed
-			$this->minAge = (int)$minValue;
+			$this->minAge = (int) $minValue;
 			$this->maxAge = self::NO_OBLIGATION;
 			$this->canPurgeToSaveSpace = true;
 		} elseif ($minValue === 'auto' && $maxValue !== 'auto') {
 			// Delete anytime if space needed, Delete all older than max automatically
 			$this->minAge = self::NO_OBLIGATION;
-			$this->maxAge = (int)$maxValue;
+			$this->maxAge = (int) $maxValue;
 			$this->canPurgeToSaveSpace = true;
 		} elseif ($minValue !== 'auto' && $maxValue !== 'auto') {
 			// Delete all older than max OR older than min if space needed
@@ -158,8 +158,8 @@ 
 				$maxValue = $minValue;
 			}
 
-			$this->minAge = (int)$minValue;
-			$this->maxAge = (int)$maxValue;
+			$this->minAge = (int) $minValue;
+			$this->maxAge = (int) $maxValue;
 			$this->canPurgeToSaveSpace = false;
 		}
 	}

apps/files_versions/lib/Expiration.php

Indentation +169 added lines, -169 removed lines

@@ -27,173 +27,173 @@
 
 class Expiration {
 
-	// how long do we keep files a version if no other value is defined in the config file (unit: days)
-	const NO_OBLIGATION = -1;
-
-	/** @var ITimeFactory */
-	private $timeFactory;
-
-	/** @var string */
-	private $retentionObligation;
-
-	/** @var int */
-	private $minAge;
-
-	/** @var int */
-	private $maxAge;
-
-	/** @var bool */
-	private $canPurgeToSaveSpace;
-
-	public function __construct(IConfig $config,ITimeFactory $timeFactory){
-		$this->timeFactory = $timeFactory;
-		$this->retentionObligation = $config->getSystemValue('versions_retention_obligation', 'auto');
-
-		if ($this->retentionObligation !== 'disabled') {
-			$this->parseRetentionObligation();
-		}
-	}
-
-	/**
-	 * Is versions expiration enabled
-	 * @return bool
-	 */
-	public function isEnabled(){
-		return $this->retentionObligation !== 'disabled';
-	}
-
-	/**
-	 * Is default expiration active
-	 */
-	public function shouldAutoExpire(){
-		return $this->minAge === self::NO_OBLIGATION
-				|| $this->maxAge === self::NO_OBLIGATION;
-	}
-
-	/**
-	 * Check if given timestamp in expiration range
-	 * @param int $timestamp
-	 * @param bool $quotaExceeded
-	 * @return bool
-	 */
-	public function isExpired($timestamp, $quotaExceeded = false){
-		// No expiration if disabled
-		if (!$this->isEnabled()) {
-			return false;
-		}
-
-		// Purge to save space (if allowed)
-		if ($quotaExceeded && $this->canPurgeToSaveSpace) {
-			return true;
-		}
-
-		$time = $this->timeFactory->getTime();
-		// Never expire dates in future e.g. misconfiguration or negative time
-		// adjustment
-		if ($time<$timestamp) {
-			return false;
-		}
-
-		// Purge as too old
-		if ($this->maxAge !== self::NO_OBLIGATION) {
-			$maxTimestamp = $time - ($this->maxAge * 86400);
-			$isOlderThanMax = $timestamp < $maxTimestamp;
-		} else {
-			$isOlderThanMax = false;
-		}
-
-		if ($this->minAge !== self::NO_OBLIGATION) {
-			// older than Min obligation and we are running out of quota?
-			$minTimestamp = $time - ($this->minAge * 86400);
-			$isMinReached = ($timestamp < $minTimestamp) && $quotaExceeded;
-		} else {
-			$isMinReached = false;
-		}
-
-		return $isOlderThanMax || $isMinReached;
-	}
-
-	/**
-	 * Get maximal retention obligation as a timestamp
-	 * @return int
-	 */
-	public function getMaxAgeAsTimestamp(){
-		$maxAge = false;
-		if ($this->isEnabled() && $this->maxAge !== self::NO_OBLIGATION) {
-			$time = $this->timeFactory->getTime();
-			$maxAge = $time - ($this->maxAge * 86400);
-		}
-		return $maxAge;
-	}
-
-	/**
-	* Read versions_retention_obligation, validate it 
-	* and set private members accordingly
-	*/
-	private function parseRetentionObligation(){
-		$splitValues = explode(',', $this->retentionObligation);
-		if (!isset($splitValues[0])) {
-			$minValue = 'auto';
-		} else {
-			$minValue = trim($splitValues[0]);
-		}
-
-		if (!isset($splitValues[1])) {
-			$maxValue = 'auto';
-		} else {
-			$maxValue = trim($splitValues[1]);
-		}
-
-		$isValid = true;
-		// Validate
-		if (!ctype_digit($minValue) && $minValue !== 'auto') {
-			$isValid = false;
-			\OC::$server->getLogger()->warning(
-					$minValue . ' is not a valid value for minimal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.',
-					['app'=>'files_versions']
-			);
-		}
-
-		if (!ctype_digit($maxValue) && $maxValue !== 'auto') {
-			$isValid = false;
-			\OC::$server->getLogger()->warning(
-					$maxValue . ' is not a valid value for maximal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.',
-					['app'=>'files_versions']
-			);
-		}
-
-		if (!$isValid){
-			$minValue = 'auto';
-			$maxValue = 'auto';
-		}
-
-
-		if ($minValue === 'auto' && $maxValue === 'auto') {
-			// Default: Delete anytime if space needed
-			$this->minAge = self::NO_OBLIGATION;
-			$this->maxAge = self::NO_OBLIGATION;
-			$this->canPurgeToSaveSpace = true;
-		} elseif ($minValue !== 'auto' && $maxValue === 'auto') {
-			// Keep for X days but delete anytime if space needed
-			$this->minAge = (int)$minValue;
-			$this->maxAge = self::NO_OBLIGATION;
-			$this->canPurgeToSaveSpace = true;
-		} elseif ($minValue === 'auto' && $maxValue !== 'auto') {
-			// Delete anytime if space needed, Delete all older than max automatically
-			$this->minAge = self::NO_OBLIGATION;
-			$this->maxAge = (int)$maxValue;
-			$this->canPurgeToSaveSpace = true;
-		} elseif ($minValue !== 'auto' && $maxValue !== 'auto') {
-			// Delete all older than max OR older than min if space needed
-
-			// Max < Min as per https://github.com/owncloud/core/issues/16301
-			if ($maxValue < $minValue) {
-				$maxValue = $minValue;
-			}
-
-			$this->minAge = (int)$minValue;
-			$this->maxAge = (int)$maxValue;
-			$this->canPurgeToSaveSpace = false;
-		}
-	}
+    // how long do we keep files a version if no other value is defined in the config file (unit: days)
+    const NO_OBLIGATION = -1;
+
+    /** @var ITimeFactory */
+    private $timeFactory;
+
+    /** @var string */
+    private $retentionObligation;
+
+    /** @var int */
+    private $minAge;
+
+    /** @var int */
+    private $maxAge;
+
+    /** @var bool */
+    private $canPurgeToSaveSpace;
+
+    public function __construct(IConfig $config,ITimeFactory $timeFactory){
+        $this->timeFactory = $timeFactory;
+        $this->retentionObligation = $config->getSystemValue('versions_retention_obligation', 'auto');
+
+        if ($this->retentionObligation !== 'disabled') {
+            $this->parseRetentionObligation();
+        }
+    }
+
+    /**
+     * Is versions expiration enabled
+     * @return bool
+     */
+    public function isEnabled(){
+        return $this->retentionObligation !== 'disabled';
+    }
+
+    /**
+     * Is default expiration active
+     */
+    public function shouldAutoExpire(){
+        return $this->minAge === self::NO_OBLIGATION
+                || $this->maxAge === self::NO_OBLIGATION;
+    }
+
+    /**
+     * Check if given timestamp in expiration range
+     * @param int $timestamp
+     * @param bool $quotaExceeded
+     * @return bool
+     */
+    public function isExpired($timestamp, $quotaExceeded = false){
+        // No expiration if disabled
+        if (!$this->isEnabled()) {
+            return false;
+        }
+
+        // Purge to save space (if allowed)
+        if ($quotaExceeded && $this->canPurgeToSaveSpace) {
+            return true;
+        }
+
+        $time = $this->timeFactory->getTime();
+        // Never expire dates in future e.g. misconfiguration or negative time
+        // adjustment
+        if ($time<$timestamp) {
+            return false;
+        }
+
+        // Purge as too old
+        if ($this->maxAge !== self::NO_OBLIGATION) {
+            $maxTimestamp = $time - ($this->maxAge * 86400);
+            $isOlderThanMax = $timestamp < $maxTimestamp;
+        } else {
+            $isOlderThanMax = false;
+        }
+
+        if ($this->minAge !== self::NO_OBLIGATION) {
+            // older than Min obligation and we are running out of quota?
+            $minTimestamp = $time - ($this->minAge * 86400);
+            $isMinReached = ($timestamp < $minTimestamp) && $quotaExceeded;
+        } else {
+            $isMinReached = false;
+        }
+
+        return $isOlderThanMax || $isMinReached;
+    }
+
+    /**
+     * Get maximal retention obligation as a timestamp
+     * @return int
+     */
+    public function getMaxAgeAsTimestamp(){
+        $maxAge = false;
+        if ($this->isEnabled() && $this->maxAge !== self::NO_OBLIGATION) {
+            $time = $this->timeFactory->getTime();
+            $maxAge = $time - ($this->maxAge * 86400);
+        }
+        return $maxAge;
+    }
+
+    /**
+     * Read versions_retention_obligation, validate it 
+     * and set private members accordingly
+     */
+    private function parseRetentionObligation(){
+        $splitValues = explode(',', $this->retentionObligation);
+        if (!isset($splitValues[0])) {
+            $minValue = 'auto';
+        } else {
+            $minValue = trim($splitValues[0]);
+        }
+
+        if (!isset($splitValues[1])) {
+            $maxValue = 'auto';
+        } else {
+            $maxValue = trim($splitValues[1]);
+        }
+
+        $isValid = true;
+        // Validate
+        if (!ctype_digit($minValue) && $minValue !== 'auto') {
+            $isValid = false;
+            \OC::$server->getLogger()->warning(
+                    $minValue . ' is not a valid value for minimal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.',
+                    ['app'=>'files_versions']
+            );
+        }
+
+        if (!ctype_digit($maxValue) && $maxValue !== 'auto') {
+            $isValid = false;
+            \OC::$server->getLogger()->warning(
+                    $maxValue . ' is not a valid value for maximal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.',
+                    ['app'=>'files_versions']
+            );
+        }
+
+        if (!$isValid){
+            $minValue = 'auto';
+            $maxValue = 'auto';
+        }
+
+
+        if ($minValue === 'auto' && $maxValue === 'auto') {
+            // Default: Delete anytime if space needed
+            $this->minAge = self::NO_OBLIGATION;
+            $this->maxAge = self::NO_OBLIGATION;
+            $this->canPurgeToSaveSpace = true;
+        } elseif ($minValue !== 'auto' && $maxValue === 'auto') {
+            // Keep for X days but delete anytime if space needed
+            $this->minAge = (int)$minValue;
+            $this->maxAge = self::NO_OBLIGATION;
+            $this->canPurgeToSaveSpace = true;
+        } elseif ($minValue === 'auto' && $maxValue !== 'auto') {
+            // Delete anytime if space needed, Delete all older than max automatically
+            $this->minAge = self::NO_OBLIGATION;
+            $this->maxAge = (int)$maxValue;
+            $this->canPurgeToSaveSpace = true;
+        } elseif ($minValue !== 'auto' && $maxValue !== 'auto') {
+            // Delete all older than max OR older than min if space needed
+
+            // Max < Min as per https://github.com/owncloud/core/issues/16301
+            if ($maxValue < $minValue) {
+                $maxValue = $minValue;
+            }
+
+            $this->minAge = (int)$minValue;
+            $this->maxAge = (int)$maxValue;
+            $this->canPurgeToSaveSpace = false;
+        }
+    }
 }

Spacing +14 added lines, -14 removed lines

@@ -45,7 +45,7 @@ 
 	/** @var bool */
 	private $canPurgeToSaveSpace;
 
-	public function __construct(IConfig $config,ITimeFactory $timeFactory){
+	public function __construct(IConfig $config, ITimeFactory $timeFactory) {
 		$this->timeFactory = $timeFactory;
 		$this->retentionObligation = $config->getSystemValue('versions_retention_obligation', 'auto');
 
@@ -58,14 +58,14 @@ 
 	 * Is versions expiration enabled
 	 * @return bool
 	 */
-	public function isEnabled(){
+	public function isEnabled() {
 		return $this->retentionObligation !== 'disabled';
 	}
 
 	/**
 	 * Is default expiration active
 	 */
-	public function shouldAutoExpire(){
+	public function shouldAutoExpire() {
 		return $this->minAge === self::NO_OBLIGATION
 				|| $this->maxAge === self::NO_OBLIGATION;
 	}
@@ -76,7 +76,7 @@ 
 	 * @param bool $quotaExceeded
 	 * @return bool
 	 */
-	public function isExpired($timestamp, $quotaExceeded = false){
+	public function isExpired($timestamp, $quotaExceeded = false) {
 		// No expiration if disabled
 		if (!$this->isEnabled()) {
 			return false;
@@ -90,7 +90,7 @@ 
 		$time = $this->timeFactory->getTime();
 		// Never expire dates in future e.g. misconfiguration or negative time
 		// adjustment
-		if ($time<$timestamp) {
+		if ($time < $timestamp) {
 			return false;
 		}
 
@@ -117,7 +117,7 @@ 
 	 * Get maximal retention obligation as a timestamp
 	 * @return int
 	 */
-	public function getMaxAgeAsTimestamp(){
+	public function getMaxAgeAsTimestamp() {
 		$maxAge = false;
 		if ($this->isEnabled() && $this->maxAge !== self::NO_OBLIGATION) {
 			$time = $this->timeFactory->getTime();
@@ -130,7 +130,7 @@ 
 	* Read versions_retention_obligation, validate it 
 	* and set private members accordingly
 	*/
-	private function parseRetentionObligation(){
+	private function parseRetentionObligation() {
 		$splitValues = explode(',', $this->retentionObligation);
 		if (!isset($splitValues[0])) {
 			$minValue = 'auto';
@@ -149,7 +149,7 @@ 
 		if (!ctype_digit($minValue) && $minValue !== 'auto') {
 			$isValid = false;
 			\OC::$server->getLogger()->warning(
-					$minValue . ' is not a valid value for minimal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.',
+					$minValue.' is not a valid value for minimal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.',
 					['app'=>'files_versions']
 			);
 		}
@@ -157,12 +157,12 @@ 
 		if (!ctype_digit($maxValue) && $maxValue !== 'auto') {
 			$isValid = false;
 			\OC::$server->getLogger()->warning(
-					$maxValue . ' is not a valid value for maximal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.',
+					$maxValue.' is not a valid value for maximal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.',
 					['app'=>'files_versions']
 			);
 		}
 
-		if (!$isValid){
+		if (!$isValid) {
 			$minValue = 'auto';
 			$maxValue = 'auto';
 		}
@@ -175,13 +175,13 @@ 
 			$this->canPurgeToSaveSpace = true;
 		} elseif ($minValue !== 'auto' && $maxValue === 'auto') {
 			// Keep for X days but delete anytime if space needed
-			$this->minAge = (int)$minValue;
+			$this->minAge = (int) $minValue;
 			$this->maxAge = self::NO_OBLIGATION;
 			$this->canPurgeToSaveSpace = true;
 		} elseif ($minValue === 'auto' && $maxValue !== 'auto') {
 			// Delete anytime if space needed, Delete all older than max automatically
 			$this->minAge = self::NO_OBLIGATION;
-			$this->maxAge = (int)$maxValue;
+			$this->maxAge = (int) $maxValue;
 			$this->canPurgeToSaveSpace = true;
 		} elseif ($minValue !== 'auto' && $maxValue !== 'auto') {
 			// Delete all older than max OR older than min if space needed
@@ -191,8 +191,8 @@ 
 				$maxValue = $minValue;
 			}
 
-			$this->minAge = (int)$minValue;
-			$this->maxAge = (int)$maxValue;
+			$this->minAge = (int) $minValue;
+			$this->maxAge = (int) $maxValue;
 			$this->canPurgeToSaveSpace = false;
 		}
 	}

apps/files_versions/lib/Storage.php

Indentation +792 added lines, -792 removed lines

@@ -54,797 +54,797 @@
 
 class Storage {
 
-	const DEFAULTENABLED=true;
-	const DEFAULTMAXSIZE=50; // unit: percentage; 50% of available disk space/quota
-	const VERSIONS_ROOT = 'files_versions/';
-
-	const DELETE_TRIGGER_MASTER_REMOVED = 0;
-	const DELETE_TRIGGER_RETENTION_CONSTRAINT = 1;
-	const DELETE_TRIGGER_QUOTA_EXCEEDED = 2;
-
-	// files for which we can remove the versions after the delete operation was successful
-	private static $deletedFiles = array();
-
-	private static $sourcePathAndUser = array();
-
-	private static $max_versions_per_interval = array(
-		//first 10sec, one version every 2sec
-		1 => array('intervalEndsAfter' => 10,      'step' => 2),
-		//next minute, one version every 10sec
-		2 => array('intervalEndsAfter' => 60,      'step' => 10),
-		//next hour, one version every minute
-		3 => array('intervalEndsAfter' => 3600,    'step' => 60),
-		//next 24h, one version every hour
-		4 => array('intervalEndsAfter' => 86400,   'step' => 3600),
-		//next 30days, one version per day
-		5 => array('intervalEndsAfter' => 2592000, 'step' => 86400),
-		//until the end one version per week
-		6 => array('intervalEndsAfter' => -1,      'step' => 604800),
-	);
-
-	/** @var \OCA\Files_Versions\AppInfo\Application */
-	private static $application;
-
-	/**
-	 * get the UID of the owner of the file and the path to the file relative to
-	 * owners files folder
-	 *
-	 * @param string $filename
-	 * @return array
-	 * @throws \OC\User\NoUserException
-	 */
-	public static function getUidAndFilename($filename) {
-		$uid = Filesystem::getOwner($filename);
-		$userManager = \OC::$server->getUserManager();
-		// if the user with the UID doesn't exists, e.g. because the UID points
-		// to a remote user with a federated cloud ID we use the current logged-in
-		// user. We need a valid local user to create the versions
-		if (!$userManager->userExists($uid)) {
-			$uid = User::getUser();
-		}
-		Filesystem::initMountPoints($uid);
-		if ( $uid !== User::getUser() ) {
-			$info = Filesystem::getFileInfo($filename);
-			$ownerView = new View('/'.$uid.'/files');
-			try {
-				$filename = $ownerView->getPath($info['fileid']);
-				// make sure that the file name doesn't end with a trailing slash
-				// can for example happen single files shared across servers
-				$filename = rtrim($filename, '/');
-			} catch (NotFoundException $e) {
-				$filename = null;
-			}
-		}
-		return [$uid, $filename];
-	}
-
-	/**
-	 * Remember the owner and the owner path of the source file
-	 *
-	 * @param string $source source path
-	 */
-	public static function setSourcePathAndUser($source) {
-		list($uid, $path) = self::getUidAndFilename($source);
-		self::$sourcePathAndUser[$source] = array('uid' => $uid, 'path' => $path);
-	}
-
-	/**
-	 * Gets the owner and the owner path from the source path
-	 *
-	 * @param string $source source path
-	 * @return array with user id and path
-	 */
-	public static function getSourcePathAndUser($source) {
-
-		if (isset(self::$sourcePathAndUser[$source])) {
-			$uid = self::$sourcePathAndUser[$source]['uid'];
-			$path = self::$sourcePathAndUser[$source]['path'];
-			unset(self::$sourcePathAndUser[$source]);
-		} else {
-			$uid = $path = false;
-		}
-		return array($uid, $path);
-	}
-
-	/**
-	 * get current size of all versions from a given user
-	 *
-	 * @param string $user user who owns the versions
-	 * @return int versions size
-	 */
-	private static function getVersionsSize($user) {
-		$view = new View('/' . $user);
-		$fileInfo = $view->getFileInfo('/files_versions');
-		return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
-	}
-
-	/**
-	 * store a new version of a file.
-	 */
-	public static function store($filename) {
-
-		// if the file gets streamed we need to remove the .part extension
-		// to get the right target
-		$ext = pathinfo($filename, PATHINFO_EXTENSION);
-		if ($ext === 'part') {
-			$filename = substr($filename, 0, strlen($filename) - 5);
-		}
-
-		// we only handle existing files
-		if (! Filesystem::file_exists($filename) || Filesystem::is_dir($filename)) {
-			return false;
-		}
-
-		list($uid, $filename) = self::getUidAndFilename($filename);
-
-		$files_view = new View('/'.$uid .'/files');
-		$users_view = new View('/'.$uid);
-
-		$eventDispatcher = \OC::$server->getEventDispatcher();
-		$id = $files_view->getFileInfo($filename)->getId();
-		$nodes = \OC::$server->getRootFolder()->getById($id);
-		foreach ($nodes as $node) {
-			$event = new CreateVersionEvent($node);
-			$eventDispatcher->dispatch('OCA\Files_Versions::createVersion', $event);
-			if ($event->shouldCreateVersion() === false) {
-				return false;
-			}
-		}
-
-		// no use making versions for empty files
-		if ($files_view->filesize($filename) === 0) {
-			return false;
-		}
-
-		// create all parent folders
-		self::createMissingDirectories($filename, $users_view);
-
-		self::scheduleExpire($uid, $filename);
-
-		// store a new version of a file
-		$mtime = $users_view->filemtime('files/' . $filename);
-		$users_view->copy('files/' . $filename, 'files_versions/' . $filename . '.v' . $mtime);
-		// call getFileInfo to enforce a file cache entry for the new version
-		$users_view->getFileInfo('files_versions/' . $filename . '.v' . $mtime);
-	}
-
-
-	/**
-	 * mark file as deleted so that we can remove the versions if the file is gone
-	 * @param string $path
-	 */
-	public static function markDeletedFile($path) {
-		list($uid, $filename) = self::getUidAndFilename($path);
-		self::$deletedFiles[$path] = array(
-			'uid' => $uid,
-			'filename' => $filename);
-	}
-
-	/**
-	 * delete the version from the storage and cache
-	 *
-	 * @param View $view
-	 * @param string $path
-	 */
-	protected static function deleteVersion($view, $path) {
-		$view->unlink($path);
-		/**
-		 * @var \OC\Files\Storage\Storage $storage
-		 * @var string $internalPath
-		 */
-		list($storage, $internalPath) = $view->resolvePath($path);
-		$cache = $storage->getCache($internalPath);
-		$cache->remove($internalPath);
-	}
-
-	/**
-	 * Delete versions of a file
-	 */
-	public static function delete($path) {
-
-		$deletedFile = self::$deletedFiles[$path];
-		$uid = $deletedFile['uid'];
-		$filename = $deletedFile['filename'];
-
-		if (!Filesystem::file_exists($path)) {
-
-			$view = new View('/' . $uid . '/files_versions');
-
-			$versions = self::getVersions($uid, $filename);
-			if (!empty($versions)) {
-				foreach ($versions as $v) {
-					\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
-					self::deleteVersion($view, $filename . '.v' . $v['version']);
-					\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
-				}
-			}
-		}
-		unset(self::$deletedFiles[$path]);
-	}
-
-	/**
-	 * Rename or copy versions of a file of the given paths
-	 *
-	 * @param string $sourcePath source path of the file to move, relative to
-	 * the currently logged in user's "files" folder
-	 * @param string $targetPath target path of the file to move, relative to
-	 * the currently logged in user's "files" folder
-	 * @param string $operation can be 'copy' or 'rename'
-	 */
-	public static function renameOrCopy($sourcePath, $targetPath, $operation) {
-		list($sourceOwner, $sourcePath) = self::getSourcePathAndUser($sourcePath);
-
-		// it was a upload of a existing file if no old path exists
-		// in this case the pre-hook already called the store method and we can
-		// stop here
-		if ($sourcePath === false) {
-			return true;
-		}
-
-		list($targetOwner, $targetPath) = self::getUidAndFilename($targetPath);
-
-		$sourcePath = ltrim($sourcePath, '/');
-		$targetPath = ltrim($targetPath, '/');
-
-		$rootView = new View('');
-
-		// did we move a directory ?
-		if ($rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
-			// does the directory exists for versions too ?
-			if ($rootView->is_dir('/' . $sourceOwner . '/files_versions/' . $sourcePath)) {
-				// create missing dirs if necessary
-				self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
-
-				// move the directory containing the versions
-				$rootView->$operation(
-					'/' . $sourceOwner . '/files_versions/' . $sourcePath,
-					'/' . $targetOwner . '/files_versions/' . $targetPath
-				);
-			}
-		} else if ($versions = Storage::getVersions($sourceOwner, '/' . $sourcePath)) {
-			// create missing dirs if necessary
-			self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
-
-			foreach ($versions as $v) {
-				// move each version one by one to the target directory
-				$rootView->$operation(
-					'/' . $sourceOwner . '/files_versions/' . $sourcePath.'.v' . $v['version'],
-					'/' . $targetOwner . '/files_versions/' . $targetPath.'.v'.$v['version']
-				);
-			}
-		}
-
-		// if we moved versions directly for a file, schedule expiration check for that file
-		if (!$rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
-			self::scheduleExpire($targetOwner, $targetPath);
-		}
-
-	}
-
-	/**
-	 * Rollback to an old version of a file.
-	 *
-	 * @param string $file file name
-	 * @param int $revision revision timestamp
-	 * @return bool
-	 */
-	public static function rollback($file, $revision) {
-
-		// add expected leading slash
-		$file = '/' . ltrim($file, '/');
-		list($uid, $filename) = self::getUidAndFilename($file);
-		if ($uid === null || trim($filename, '/') === '') {
-			return false;
-		}
-
-		$users_view = new View('/'.$uid);
-		$files_view = new View('/'. User::getUser().'/files');
-
-		$versionCreated = false;
-
-		$fileInfo = $files_view->getFileInfo($file);
-
-		// check if user has the permissions to revert a version
-		if (!$fileInfo->isUpdateable()) {
-			return false;
-		}
-
-		//first create a new version
-		$version = 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename);
-		if (!$users_view->file_exists($version)) {
-			$users_view->copy('files'.$filename, 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename));
-			$versionCreated = true;
-		}
-
-		$fileToRestore =  'files_versions' . $filename . '.v' . $revision;
-
-		// Restore encrypted version of the old file for the newly restored file
-		// This has to happen manually here since the file is manually copied below
-		$oldVersion = $users_view->getFileInfo($fileToRestore)->getEncryptedVersion();
-		$oldFileInfo = $users_view->getFileInfo($fileToRestore);
-		$cache = $fileInfo->getStorage()->getCache();
-		$cache->update(
-			$fileInfo->getId(), [
-				'encrypted' => $oldVersion,
-				'encryptedVersion' => $oldVersion,
-				'size' => $oldFileInfo->getSize()
-			]
-		);
-
-		// rollback
-		if (self::copyFileContents($users_view, $fileToRestore, 'files' . $filename)) {
-			$files_view->touch($file, $revision);
-			Storage::scheduleExpire($uid, $file);
-			\OC_Hook::emit('\OCP\Versions', 'rollback', array(
-				'path' => $filename,
-				'revision' => $revision,
-			));
-			return true;
-		} else if ($versionCreated) {
-			self::deleteVersion($users_view, $version);
-		}
-
-		return false;
-
-	}
-
-	/**
-	 * Stream copy file contents from $path1 to $path2
-	 *
-	 * @param View $view view to use for copying
-	 * @param string $path1 source file to copy
-	 * @param string $path2 target file
-	 *
-	 * @return bool true for success, false otherwise
-	 */
-	private static function copyFileContents($view, $path1, $path2) {
-		/** @var \OC\Files\Storage\Storage $storage1 */
-		list($storage1, $internalPath1) = $view->resolvePath($path1);
-		/** @var \OC\Files\Storage\Storage $storage2 */
-		list($storage2, $internalPath2) = $view->resolvePath($path2);
-
-		$view->lockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
-		$view->lockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
-
-		// TODO add a proper way of overwriting a file while maintaining file ids
-		if ($storage1->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage') || $storage2->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage')) {
-			$source = $storage1->fopen($internalPath1, 'r');
-			$target = $storage2->fopen($internalPath2, 'w');
-			list(, $result) = \OC_Helper::streamCopy($source, $target);
-			fclose($source);
-			fclose($target);
-
-			if ($result !== false) {
-				$storage1->unlink($internalPath1);
-			}
-		} else {
-			$result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2);
-		}
-
-		$view->unlockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
-		$view->unlockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
-
-		return ($result !== false);
-	}
-
-	/**
-	 * get a list of all available versions of a file in descending chronological order
-	 * @param string $uid user id from the owner of the file
-	 * @param string $filename file to find versions of, relative to the user files dir
-	 * @param string $userFullPath
-	 * @return array versions newest version first
-	 */
-	public static function getVersions($uid, $filename, $userFullPath = '') {
-		$versions = array();
-		if (empty($filename)) {
-			return $versions;
-		}
-		// fetch for old versions
-		$view = new View('/' . $uid . '/');
-
-		$pathinfo = pathinfo($filename);
-		$versionedFile = $pathinfo['basename'];
-
-		$dir = Filesystem::normalizePath(self::VERSIONS_ROOT . '/' . $pathinfo['dirname']);
-
-		$dirContent = false;
-		if ($view->is_dir($dir)) {
-			$dirContent = $view->opendir($dir);
-		}
-
-		if ($dirContent === false) {
-			return $versions;
-		}
-
-		if (is_resource($dirContent)) {
-			while (($entryName = readdir($dirContent)) !== false) {
-				if (!Filesystem::isIgnoredDir($entryName)) {
-					$pathparts = pathinfo($entryName);
-					$filename = $pathparts['filename'];
-					if ($filename === $versionedFile) {
-						$pathparts = pathinfo($entryName);
-						$timestamp = substr($pathparts['extension'], 1);
-						$filename = $pathparts['filename'];
-						$key = $timestamp . '#' . $filename;
-						$versions[$key]['version'] = $timestamp;
-						$versions[$key]['humanReadableTimestamp'] = self::getHumanReadableTimestamp($timestamp);
-						if (empty($userFullPath)) {
-							$versions[$key]['preview'] = '';
-						} else {
-							$versions[$key]['preview'] = \OC::$server->getURLGenerator('files_version.Preview.getPreview', ['file' => $userFullPath, 'version' => $timestamp]);
-						}
-						$versions[$key]['path'] = Filesystem::normalizePath($pathinfo['dirname'] . '/' . $filename);
-						$versions[$key]['name'] = $versionedFile;
-						$versions[$key]['size'] = $view->filesize($dir . '/' . $entryName);
-						$versions[$key]['mimetype'] = \OC::$server->getMimeTypeDetector()->detectPath($versionedFile);
-					}
-				}
-			}
-			closedir($dirContent);
-		}
-
-		// sort with newest version first
-		krsort($versions);
-
-		return $versions;
-	}
-
-	/**
-	 * Expire versions that older than max version retention time
-	 * @param string $uid
-	 */
-	public static function expireOlderThanMaxForUser($uid){
-		$expiration = self::getExpiration();
-		$threshold = $expiration->getMaxAgeAsTimestamp();
-		$versions = self::getAllVersions($uid);
-		if (!$threshold || !array_key_exists('all', $versions)) {
-			return;
-		}
-
-		$toDelete = [];
-		foreach (array_reverse($versions['all']) as $key => $version) {
-			if ((int)$version['version'] <$threshold) {
-				$toDelete[$key] = $version;
-			} else {
-				//Versions are sorted by time - nothing mo to iterate.
-				break;
-			}
-		}
-
-		$view = new View('/' . $uid . '/files_versions');
-		if (!empty($toDelete)) {
-			foreach ($toDelete as $version) {
-				\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
-				self::deleteVersion($view, $version['path'] . '.v' . $version['version']);
-				\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
-			}
-		}
-	}
-
-	/**
-	 * translate a timestamp into a string like "5 days ago"
-	 * @param int $timestamp
-	 * @return string for example "5 days ago"
-	 */
-	private static function getHumanReadableTimestamp($timestamp) {
-
-		$diff = time() - $timestamp;
-
-		if ($diff < 60) { // first minute
-			return  $diff . " seconds ago";
-		} elseif ($diff < 3600) { //first hour
-			return round($diff / 60) . " minutes ago";
-		} elseif ($diff < 86400) { // first day
-			return round($diff / 3600) . " hours ago";
-		} elseif ($diff < 604800) { //first week
-			return round($diff / 86400) . " days ago";
-		} elseif ($diff < 2419200) { //first month
-			return round($diff / 604800) . " weeks ago";
-		} elseif ($diff < 29030400) { // first year
-			return round($diff / 2419200) . " months ago";
-		} else {
-			return round($diff / 29030400) . " years ago";
-		}
-
-	}
-
-	/**
-	 * returns all stored file versions from a given user
-	 * @param string $uid id of the user
-	 * @return array with contains two arrays 'all' which contains all versions sorted by age and 'by_file' which contains all versions sorted by filename
-	 */
-	private static function getAllVersions($uid) {
-		$view = new View('/' . $uid . '/');
-		$dirs = array(self::VERSIONS_ROOT);
-		$versions = array();
-
-		while (!empty($dirs)) {
-			$dir = array_pop($dirs);
-			$files = $view->getDirectoryContent($dir);
-
-			foreach ($files as $file) {
-				$fileData = $file->getData();
-				$filePath = $dir . '/' . $fileData['name'];
-				if ($file['type'] === 'dir') {
-					array_push($dirs, $filePath);
-				} else {
-					$versionsBegin = strrpos($filePath, '.v');
-					$relPathStart = strlen(self::VERSIONS_ROOT);
-					$version = substr($filePath, $versionsBegin + 2);
-					$relpath = substr($filePath, $relPathStart, $versionsBegin - $relPathStart);
-					$key = $version . '#' . $relpath;
-					$versions[$key] = array('path' => $relpath, 'timestamp' => $version);
-				}
-			}
-		}
-
-		// newest version first
-		krsort($versions);
-
-		$result = array();
-
-		foreach ($versions as $key => $value) {
-			$size = $view->filesize(self::VERSIONS_ROOT.'/'.$value['path'].'.v'.$value['timestamp']);
-			$filename = $value['path'];
-
-			$result['all'][$key]['version'] = $value['timestamp'];
-			$result['all'][$key]['path'] = $filename;
-			$result['all'][$key]['size'] = $size;
-
-			$result['by_file'][$filename][$key]['version'] = $value['timestamp'];
-			$result['by_file'][$filename][$key]['path'] = $filename;
-			$result['by_file'][$filename][$key]['size'] = $size;
-		}
-
-		return $result;
-	}
-
-	/**
-	 * get list of files we want to expire
-	 * @param array $versions list of versions
-	 * @param integer $time
-	 * @param bool $quotaExceeded is versions storage limit reached
-	 * @return array containing the list of to deleted versions and the size of them
-	 */
-	protected static function getExpireList($time, $versions, $quotaExceeded = false) {
-		$expiration = self::getExpiration();
-
-		if ($expiration->shouldAutoExpire()) {
-			list($toDelete, $size) = self::getAutoExpireList($time, $versions);
-		} else {
-			$size = 0;
-			$toDelete = [];  // versions we want to delete
-		}
-
-		foreach ($versions as $key => $version) {
-			if ($expiration->isExpired($version['version'], $quotaExceeded) && !isset($toDelete[$key])) {
-				$size += $version['size'];
-				$toDelete[$key] = $version['path'] . '.v' . $version['version'];
-			}
-		}
-
-		return [$toDelete, $size];
-	}
-
-	/**
-	 * get list of files we want to expire
-	 * @param array $versions list of versions
-	 * @param integer $time
-	 * @return array containing the list of to deleted versions and the size of them
-	 */
-	protected static function getAutoExpireList($time, $versions) {
-		$size = 0;
-		$toDelete = array();  // versions we want to delete
-
-		$interval = 1;
-		$step = Storage::$max_versions_per_interval[$interval]['step'];
-		if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] === -1) {
-			$nextInterval = -1;
-		} else {
-			$nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
-		}
-
-		$firstVersion = reset($versions);
-		$firstKey = key($versions);
-		$prevTimestamp = $firstVersion['version'];
-		$nextVersion = $firstVersion['version'] - $step;
-		unset($versions[$firstKey]);
-
-		foreach ($versions as $key => $version) {
-			$newInterval = true;
-			while ($newInterval) {
-				if ($nextInterval === -1 || $prevTimestamp > $nextInterval) {
-					if ($version['version'] > $nextVersion) {
-						//distance between two version too small, mark to delete
-						$toDelete[$key] = $version['path'] . '.v' . $version['version'];
-						$size += $version['size'];
-						\OCP\Util::writeLog('files_versions', 'Mark to expire '. $version['path'] .' next version should be ' . $nextVersion . " or smaller. (prevTimestamp: " . $prevTimestamp . "; step: " . $step, \OCP\Util::INFO);
-					} else {
-						$nextVersion = $version['version'] - $step;
-						$prevTimestamp = $version['version'];
-					}
-					$newInterval = false; // version checked so we can move to the next one
-				} else { // time to move on to the next interval
-					$interval++;
-					$step = Storage::$max_versions_per_interval[$interval]['step'];
-					$nextVersion = $prevTimestamp - $step;
-					if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] === -1) {
-						$nextInterval = -1;
-					} else {
-						$nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
-					}
-					$newInterval = true; // we changed the interval -> check same version with new interval
-				}
-			}
-		}
-
-		return array($toDelete, $size);
-	}
-
-	/**
-	 * Schedule versions expiration for the given file
-	 *
-	 * @param string $uid owner of the file
-	 * @param string $fileName file/folder for which to schedule expiration
-	 */
-	private static function scheduleExpire($uid, $fileName) {
-		// let the admin disable auto expire
-		$expiration = self::getExpiration();
-		if ($expiration->isEnabled()) {
-			$command = new Expire($uid, $fileName);
-			\OC::$server->getCommandBus()->push($command);
-		}
-	}
-
-	/**
-	 * Expire versions which exceed the quota.
-	 *
-	 * This will setup the filesystem for the given user but will not
-	 * tear it down afterwards.
-	 *
-	 * @param string $filename path to file to expire
-	 * @param string $uid user for which to expire the version
-	 * @return bool|int|null
-	 */
-	public static function expire($filename, $uid) {
-		$expiration = self::getExpiration();
-
-		if ($expiration->isEnabled()) {
-			// get available disk space for user
-			$user = \OC::$server->getUserManager()->get($uid);
-			if (is_null($user)) {
-				\OCP\Util::writeLog('files_versions', 'Backends provided no user object for ' . $uid, \OCP\Util::ERROR);
-				throw new \OC\User\NoUserException('Backends provided no user object for ' . $uid);
-			}
-
-			\OC_Util::setupFS($uid);
-
-			if (!Filesystem::file_exists($filename)) {
-				return false;
-			}
-
-			if (empty($filename)) {
-				// file maybe renamed or deleted
-				return false;
-			}
-			$versionsFileview = new View('/'.$uid.'/files_versions');
-
-			$softQuota = true;
-			$quota = $user->getQuota();
-			if ( $quota === null || $quota === 'none' ) {
-				$quota = Filesystem::free_space('/');
-				$softQuota = false;
-			} else {
-				$quota = \OCP\Util::computerFileSize($quota);
-			}
-
-			// make sure that we have the current size of the version history
-			$versionsSize = self::getVersionsSize($uid);
-
-			// calculate available space for version history
-			// subtract size of files and current versions size from quota
-			if ($quota >= 0) {
-				if ($softQuota) {
-					$files_view = new View('/' . $uid . '/files');
-					$rootInfo = $files_view->getFileInfo('/', false);
-					$free = $quota - $rootInfo['size']; // remaining free space for user
-					if ($free > 0) {
-						$availableSpace = ($free * self::DEFAULTMAXSIZE / 100) - $versionsSize; // how much space can be used for versions
-					} else {
-						$availableSpace = $free - $versionsSize;
-					}
-				} else {
-					$availableSpace = $quota;
-				}
-			} else {
-				$availableSpace = PHP_INT_MAX;
-			}
-
-			$allVersions = Storage::getVersions($uid, $filename);
-
-			$time = time();
-			list($toDelete, $sizeOfDeletedVersions) = self::getExpireList($time, $allVersions, $availableSpace <= 0);
-
-			$availableSpace = $availableSpace + $sizeOfDeletedVersions;
-			$versionsSize = $versionsSize - $sizeOfDeletedVersions;
-
-			// if still not enough free space we rearrange the versions from all files
-			if ($availableSpace <= 0) {
-				$result = Storage::getAllVersions($uid);
-				$allVersions = $result['all'];
-
-				foreach ($result['by_file'] as $versions) {
-					list($toDeleteNew, $size) = self::getExpireList($time, $versions, $availableSpace <= 0);
-					$toDelete = array_merge($toDelete, $toDeleteNew);
-					$sizeOfDeletedVersions += $size;
-				}
-				$availableSpace = $availableSpace + $sizeOfDeletedVersions;
-				$versionsSize = $versionsSize - $sizeOfDeletedVersions;
-			}
-
-			foreach($toDelete as $key => $path) {
-				\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
-				self::deleteVersion($versionsFileview, $path);
-				\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
-				unset($allVersions[$key]); // update array with the versions we keep
-				\OCP\Util::writeLog('files_versions', "Expire: " . $path, \OCP\Util::INFO);
-			}
-
-			// Check if enough space is available after versions are rearranged.
-			// If not we delete the oldest versions until we meet the size limit for versions,
-			// but always keep the two latest versions
-			$numOfVersions = count($allVersions) -2 ;
-			$i = 0;
-			// sort oldest first and make sure that we start at the first element
-			ksort($allVersions);
-			reset($allVersions);
-			while ($availableSpace < 0 && $i < $numOfVersions) {
-				$version = current($allVersions);
-				\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
-				self::deleteVersion($versionsFileview, $version['path'] . '.v' . $version['version']);
-				\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
-				\OCP\Util::writeLog('files_versions', 'running out of space! Delete oldest version: ' . $version['path'].'.v'.$version['version'] , \OCP\Util::INFO);
-				$versionsSize -= $version['size'];
-				$availableSpace += $version['size'];
-				next($allVersions);
-				$i++;
-			}
-
-			return $versionsSize; // finally return the new size of the version history
-		}
-
-		return false;
-	}
-
-	/**
-	 * Create recursively missing directories inside of files_versions
-	 * that match the given path to a file.
-	 *
-	 * @param string $filename $path to a file, relative to the user's
-	 * "files" folder
-	 * @param View $view view on data/user/
-	 */
-	private static function createMissingDirectories($filename, $view) {
-		$dirname = Filesystem::normalizePath(dirname($filename));
-		$dirParts = explode('/', $dirname);
-		$dir = "/files_versions";
-		foreach ($dirParts as $part) {
-			$dir = $dir . '/' . $part;
-			if (!$view->file_exists($dir)) {
-				$view->mkdir($dir);
-			}
-		}
-	}
-
-	/**
-	 * Static workaround
-	 * @return Expiration
-	 */
-	protected static function getExpiration(){
-		if (is_null(self::$application)) {
-			self::$application = new Application();
-		}
-		return self::$application->getContainer()->query('Expiration');
-	}
+    const DEFAULTENABLED=true;
+    const DEFAULTMAXSIZE=50; // unit: percentage; 50% of available disk space/quota
+    const VERSIONS_ROOT = 'files_versions/';
+
+    const DELETE_TRIGGER_MASTER_REMOVED = 0;
+    const DELETE_TRIGGER_RETENTION_CONSTRAINT = 1;
+    const DELETE_TRIGGER_QUOTA_EXCEEDED = 2;
+
+    // files for which we can remove the versions after the delete operation was successful
+    private static $deletedFiles = array();
+
+    private static $sourcePathAndUser = array();
+
+    private static $max_versions_per_interval = array(
+        //first 10sec, one version every 2sec
+        1 => array('intervalEndsAfter' => 10,      'step' => 2),
+        //next minute, one version every 10sec
+        2 => array('intervalEndsAfter' => 60,      'step' => 10),
+        //next hour, one version every minute
+        3 => array('intervalEndsAfter' => 3600,    'step' => 60),
+        //next 24h, one version every hour
+        4 => array('intervalEndsAfter' => 86400,   'step' => 3600),
+        //next 30days, one version per day
+        5 => array('intervalEndsAfter' => 2592000, 'step' => 86400),
+        //until the end one version per week
+        6 => array('intervalEndsAfter' => -1,      'step' => 604800),
+    );
+
+    /** @var \OCA\Files_Versions\AppInfo\Application */
+    private static $application;
+
+    /**
+     * get the UID of the owner of the file and the path to the file relative to
+     * owners files folder
+     *
+     * @param string $filename
+     * @return array
+     * @throws \OC\User\NoUserException
+     */
+    public static function getUidAndFilename($filename) {
+        $uid = Filesystem::getOwner($filename);
+        $userManager = \OC::$server->getUserManager();
+        // if the user with the UID doesn't exists, e.g. because the UID points
+        // to a remote user with a federated cloud ID we use the current logged-in
+        // user. We need a valid local user to create the versions
+        if (!$userManager->userExists($uid)) {
+            $uid = User::getUser();
+        }
+        Filesystem::initMountPoints($uid);
+        if ( $uid !== User::getUser() ) {
+            $info = Filesystem::getFileInfo($filename);
+            $ownerView = new View('/'.$uid.'/files');
+            try {
+                $filename = $ownerView->getPath($info['fileid']);
+                // make sure that the file name doesn't end with a trailing slash
+                // can for example happen single files shared across servers
+                $filename = rtrim($filename, '/');
+            } catch (NotFoundException $e) {
+                $filename = null;
+            }
+        }
+        return [$uid, $filename];
+    }
+
+    /**
+     * Remember the owner and the owner path of the source file
+     *
+     * @param string $source source path
+     */
+    public static function setSourcePathAndUser($source) {
+        list($uid, $path) = self::getUidAndFilename($source);
+        self::$sourcePathAndUser[$source] = array('uid' => $uid, 'path' => $path);
+    }
+
+    /**
+     * Gets the owner and the owner path from the source path
+     *
+     * @param string $source source path
+     * @return array with user id and path
+     */
+    public static function getSourcePathAndUser($source) {
+
+        if (isset(self::$sourcePathAndUser[$source])) {
+            $uid = self::$sourcePathAndUser[$source]['uid'];
+            $path = self::$sourcePathAndUser[$source]['path'];
+            unset(self::$sourcePathAndUser[$source]);
+        } else {
+            $uid = $path = false;
+        }
+        return array($uid, $path);
+    }
+
+    /**
+     * get current size of all versions from a given user
+     *
+     * @param string $user user who owns the versions
+     * @return int versions size
+     */
+    private static function getVersionsSize($user) {
+        $view = new View('/' . $user);
+        $fileInfo = $view->getFileInfo('/files_versions');
+        return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
+    }
+
+    /**
+     * store a new version of a file.
+     */
+    public static function store($filename) {
+
+        // if the file gets streamed we need to remove the .part extension
+        // to get the right target
+        $ext = pathinfo($filename, PATHINFO_EXTENSION);
+        if ($ext === 'part') {
+            $filename = substr($filename, 0, strlen($filename) - 5);
+        }
+
+        // we only handle existing files
+        if (! Filesystem::file_exists($filename) || Filesystem::is_dir($filename)) {
+            return false;
+        }
+
+        list($uid, $filename) = self::getUidAndFilename($filename);
+
+        $files_view = new View('/'.$uid .'/files');
+        $users_view = new View('/'.$uid);
+
+        $eventDispatcher = \OC::$server->getEventDispatcher();
+        $id = $files_view->getFileInfo($filename)->getId();
+        $nodes = \OC::$server->getRootFolder()->getById($id);
+        foreach ($nodes as $node) {
+            $event = new CreateVersionEvent($node);
+            $eventDispatcher->dispatch('OCA\Files_Versions::createVersion', $event);
+            if ($event->shouldCreateVersion() === false) {
+                return false;
+            }
+        }
+
+        // no use making versions for empty files
+        if ($files_view->filesize($filename) === 0) {
+            return false;
+        }
+
+        // create all parent folders
+        self::createMissingDirectories($filename, $users_view);
+
+        self::scheduleExpire($uid, $filename);
+
+        // store a new version of a file
+        $mtime = $users_view->filemtime('files/' . $filename);
+        $users_view->copy('files/' . $filename, 'files_versions/' . $filename . '.v' . $mtime);
+        // call getFileInfo to enforce a file cache entry for the new version
+        $users_view->getFileInfo('files_versions/' . $filename . '.v' . $mtime);
+    }
+
+
+    /**
+     * mark file as deleted so that we can remove the versions if the file is gone
+     * @param string $path
+     */
+    public static function markDeletedFile($path) {
+        list($uid, $filename) = self::getUidAndFilename($path);
+        self::$deletedFiles[$path] = array(
+            'uid' => $uid,
+            'filename' => $filename);
+    }
+
+    /**
+     * delete the version from the storage and cache
+     *
+     * @param View $view
+     * @param string $path
+     */
+    protected static function deleteVersion($view, $path) {
+        $view->unlink($path);
+        /**
+         * @var \OC\Files\Storage\Storage $storage
+         * @var string $internalPath
+         */
+        list($storage, $internalPath) = $view->resolvePath($path);
+        $cache = $storage->getCache($internalPath);
+        $cache->remove($internalPath);
+    }
+
+    /**
+     * Delete versions of a file
+     */
+    public static function delete($path) {
+
+        $deletedFile = self::$deletedFiles[$path];
+        $uid = $deletedFile['uid'];
+        $filename = $deletedFile['filename'];
+
+        if (!Filesystem::file_exists($path)) {
+
+            $view = new View('/' . $uid . '/files_versions');
+
+            $versions = self::getVersions($uid, $filename);
+            if (!empty($versions)) {
+                foreach ($versions as $v) {
+                    \OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
+                    self::deleteVersion($view, $filename . '.v' . $v['version']);
+                    \OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
+                }
+            }
+        }
+        unset(self::$deletedFiles[$path]);
+    }
+
+    /**
+     * Rename or copy versions of a file of the given paths
+     *
+     * @param string $sourcePath source path of the file to move, relative to
+     * the currently logged in user's "files" folder
+     * @param string $targetPath target path of the file to move, relative to
+     * the currently logged in user's "files" folder
+     * @param string $operation can be 'copy' or 'rename'
+     */
+    public static function renameOrCopy($sourcePath, $targetPath, $operation) {
+        list($sourceOwner, $sourcePath) = self::getSourcePathAndUser($sourcePath);
+
+        // it was a upload of a existing file if no old path exists
+        // in this case the pre-hook already called the store method and we can
+        // stop here
+        if ($sourcePath === false) {
+            return true;
+        }
+
+        list($targetOwner, $targetPath) = self::getUidAndFilename($targetPath);
+
+        $sourcePath = ltrim($sourcePath, '/');
+        $targetPath = ltrim($targetPath, '/');
+
+        $rootView = new View('');
+
+        // did we move a directory ?
+        if ($rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
+            // does the directory exists for versions too ?
+            if ($rootView->is_dir('/' . $sourceOwner . '/files_versions/' . $sourcePath)) {
+                // create missing dirs if necessary
+                self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
+
+                // move the directory containing the versions
+                $rootView->$operation(
+                    '/' . $sourceOwner . '/files_versions/' . $sourcePath,
+                    '/' . $targetOwner . '/files_versions/' . $targetPath
+                );
+            }
+        } else if ($versions = Storage::getVersions($sourceOwner, '/' . $sourcePath)) {
+            // create missing dirs if necessary
+            self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
+
+            foreach ($versions as $v) {
+                // move each version one by one to the target directory
+                $rootView->$operation(
+                    '/' . $sourceOwner . '/files_versions/' . $sourcePath.'.v' . $v['version'],
+                    '/' . $targetOwner . '/files_versions/' . $targetPath.'.v'.$v['version']
+                );
+            }
+        }
+
+        // if we moved versions directly for a file, schedule expiration check for that file
+        if (!$rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
+            self::scheduleExpire($targetOwner, $targetPath);
+        }
+
+    }
+
+    /**
+     * Rollback to an old version of a file.
+     *
+     * @param string $file file name
+     * @param int $revision revision timestamp
+     * @return bool
+     */
+    public static function rollback($file, $revision) {
+
+        // add expected leading slash
+        $file = '/' . ltrim($file, '/');
+        list($uid, $filename) = self::getUidAndFilename($file);
+        if ($uid === null || trim($filename, '/') === '') {
+            return false;
+        }
+
+        $users_view = new View('/'.$uid);
+        $files_view = new View('/'. User::getUser().'/files');
+
+        $versionCreated = false;
+
+        $fileInfo = $files_view->getFileInfo($file);
+
+        // check if user has the permissions to revert a version
+        if (!$fileInfo->isUpdateable()) {
+            return false;
+        }
+
+        //first create a new version
+        $version = 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename);
+        if (!$users_view->file_exists($version)) {
+            $users_view->copy('files'.$filename, 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename));
+            $versionCreated = true;
+        }
+
+        $fileToRestore =  'files_versions' . $filename . '.v' . $revision;
+
+        // Restore encrypted version of the old file for the newly restored file
+        // This has to happen manually here since the file is manually copied below
+        $oldVersion = $users_view->getFileInfo($fileToRestore)->getEncryptedVersion();
+        $oldFileInfo = $users_view->getFileInfo($fileToRestore);
+        $cache = $fileInfo->getStorage()->getCache();
+        $cache->update(
+            $fileInfo->getId(), [
+                'encrypted' => $oldVersion,
+                'encryptedVersion' => $oldVersion,
+                'size' => $oldFileInfo->getSize()
+            ]
+        );
+
+        // rollback
+        if (self::copyFileContents($users_view, $fileToRestore, 'files' . $filename)) {
+            $files_view->touch($file, $revision);
+            Storage::scheduleExpire($uid, $file);
+            \OC_Hook::emit('\OCP\Versions', 'rollback', array(
+                'path' => $filename,
+                'revision' => $revision,
+            ));
+            return true;
+        } else if ($versionCreated) {
+            self::deleteVersion($users_view, $version);
+        }
+
+        return false;
+
+    }
+
+    /**
+     * Stream copy file contents from $path1 to $path2
+     *
+     * @param View $view view to use for copying
+     * @param string $path1 source file to copy
+     * @param string $path2 target file
+     *
+     * @return bool true for success, false otherwise
+     */
+    private static function copyFileContents($view, $path1, $path2) {
+        /** @var \OC\Files\Storage\Storage $storage1 */
+        list($storage1, $internalPath1) = $view->resolvePath($path1);
+        /** @var \OC\Files\Storage\Storage $storage2 */
+        list($storage2, $internalPath2) = $view->resolvePath($path2);
+
+        $view->lockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
+        $view->lockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
+
+        // TODO add a proper way of overwriting a file while maintaining file ids
+        if ($storage1->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage') || $storage2->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage')) {
+            $source = $storage1->fopen($internalPath1, 'r');
+            $target = $storage2->fopen($internalPath2, 'w');
+            list(, $result) = \OC_Helper::streamCopy($source, $target);
+            fclose($source);
+            fclose($target);
+
+            if ($result !== false) {
+                $storage1->unlink($internalPath1);
+            }
+        } else {
+            $result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2);
+        }
+
+        $view->unlockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
+        $view->unlockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
+
+        return ($result !== false);
+    }
+
+    /**
+     * get a list of all available versions of a file in descending chronological order
+     * @param string $uid user id from the owner of the file
+     * @param string $filename file to find versions of, relative to the user files dir
+     * @param string $userFullPath
+     * @return array versions newest version first
+     */
+    public static function getVersions($uid, $filename, $userFullPath = '') {
+        $versions = array();
+        if (empty($filename)) {
+            return $versions;
+        }
+        // fetch for old versions
+        $view = new View('/' . $uid . '/');
+
+        $pathinfo = pathinfo($filename);
+        $versionedFile = $pathinfo['basename'];
+
+        $dir = Filesystem::normalizePath(self::VERSIONS_ROOT . '/' . $pathinfo['dirname']);
+
+        $dirContent = false;
+        if ($view->is_dir($dir)) {
+            $dirContent = $view->opendir($dir);
+        }
+
+        if ($dirContent === false) {
+            return $versions;
+        }
+
+        if (is_resource($dirContent)) {
+            while (($entryName = readdir($dirContent)) !== false) {
+                if (!Filesystem::isIgnoredDir($entryName)) {
+                    $pathparts = pathinfo($entryName);
+                    $filename = $pathparts['filename'];
+                    if ($filename === $versionedFile) {
+                        $pathparts = pathinfo($entryName);
+                        $timestamp = substr($pathparts['extension'], 1);
+                        $filename = $pathparts['filename'];
+                        $key = $timestamp . '#' . $filename;
+                        $versions[$key]['version'] = $timestamp;
+                        $versions[$key]['humanReadableTimestamp'] = self::getHumanReadableTimestamp($timestamp);
+                        if (empty($userFullPath)) {
+                            $versions[$key]['preview'] = '';
+                        } else {
+                            $versions[$key]['preview'] = \OC::$server->getURLGenerator('files_version.Preview.getPreview', ['file' => $userFullPath, 'version' => $timestamp]);
+                        }
+                        $versions[$key]['path'] = Filesystem::normalizePath($pathinfo['dirname'] . '/' . $filename);
+                        $versions[$key]['name'] = $versionedFile;
+                        $versions[$key]['size'] = $view->filesize($dir . '/' . $entryName);
+                        $versions[$key]['mimetype'] = \OC::$server->getMimeTypeDetector()->detectPath($versionedFile);
+                    }
+                }
+            }
+            closedir($dirContent);
+        }
+
+        // sort with newest version first
+        krsort($versions);
+
+        return $versions;
+    }
+
+    /**
+     * Expire versions that older than max version retention time
+     * @param string $uid
+     */
+    public static function expireOlderThanMaxForUser($uid){
+        $expiration = self::getExpiration();
+        $threshold = $expiration->getMaxAgeAsTimestamp();
+        $versions = self::getAllVersions($uid);
+        if (!$threshold || !array_key_exists('all', $versions)) {
+            return;
+        }
+
+        $toDelete = [];
+        foreach (array_reverse($versions['all']) as $key => $version) {
+            if ((int)$version['version'] <$threshold) {
+                $toDelete[$key] = $version;
+            } else {
+                //Versions are sorted by time - nothing mo to iterate.
+                break;
+            }
+        }
+
+        $view = new View('/' . $uid . '/files_versions');
+        if (!empty($toDelete)) {
+            foreach ($toDelete as $version) {
+                \OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
+                self::deleteVersion($view, $version['path'] . '.v' . $version['version']);
+                \OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
+            }
+        }
+    }
+
+    /**
+     * translate a timestamp into a string like "5 days ago"
+     * @param int $timestamp
+     * @return string for example "5 days ago"
+     */
+    private static function getHumanReadableTimestamp($timestamp) {
+
+        $diff = time() - $timestamp;
+
+        if ($diff < 60) { // first minute
+            return  $diff . " seconds ago";
+        } elseif ($diff < 3600) { //first hour
+            return round($diff / 60) . " minutes ago";
+        } elseif ($diff < 86400) { // first day
+            return round($diff / 3600) . " hours ago";
+        } elseif ($diff < 604800) { //first week
+            return round($diff / 86400) . " days ago";
+        } elseif ($diff < 2419200) { //first month
+            return round($diff / 604800) . " weeks ago";
+        } elseif ($diff < 29030400) { // first year
+            return round($diff / 2419200) . " months ago";
+        } else {
+            return round($diff / 29030400) . " years ago";
+        }
+
+    }
+
+    /**
+     * returns all stored file versions from a given user
+     * @param string $uid id of the user
+     * @return array with contains two arrays 'all' which contains all versions sorted by age and 'by_file' which contains all versions sorted by filename
+     */
+    private static function getAllVersions($uid) {
+        $view = new View('/' . $uid . '/');
+        $dirs = array(self::VERSIONS_ROOT);
+        $versions = array();
+
+        while (!empty($dirs)) {
+            $dir = array_pop($dirs);
+            $files = $view->getDirectoryContent($dir);
+
+            foreach ($files as $file) {
+                $fileData = $file->getData();
+                $filePath = $dir . '/' . $fileData['name'];
+                if ($file['type'] === 'dir') {
+                    array_push($dirs, $filePath);
+                } else {
+                    $versionsBegin = strrpos($filePath, '.v');
+                    $relPathStart = strlen(self::VERSIONS_ROOT);
+                    $version = substr($filePath, $versionsBegin + 2);
+                    $relpath = substr($filePath, $relPathStart, $versionsBegin - $relPathStart);
+                    $key = $version . '#' . $relpath;
+                    $versions[$key] = array('path' => $relpath, 'timestamp' => $version);
+                }
+            }
+        }
+
+        // newest version first
+        krsort($versions);
+
+        $result = array();
+
+        foreach ($versions as $key => $value) {
+            $size = $view->filesize(self::VERSIONS_ROOT.'/'.$value['path'].'.v'.$value['timestamp']);
+            $filename = $value['path'];
+
+            $result['all'][$key]['version'] = $value['timestamp'];
+            $result['all'][$key]['path'] = $filename;
+            $result['all'][$key]['size'] = $size;
+
+            $result['by_file'][$filename][$key]['version'] = $value['timestamp'];
+            $result['by_file'][$filename][$key]['path'] = $filename;
+            $result['by_file'][$filename][$key]['size'] = $size;
+        }
+
+        return $result;
+    }
+
+    /**
+     * get list of files we want to expire
+     * @param array $versions list of versions
+     * @param integer $time
+     * @param bool $quotaExceeded is versions storage limit reached
+     * @return array containing the list of to deleted versions and the size of them
+     */
+    protected static function getExpireList($time, $versions, $quotaExceeded = false) {
+        $expiration = self::getExpiration();
+
+        if ($expiration->shouldAutoExpire()) {
+            list($toDelete, $size) = self::getAutoExpireList($time, $versions);
+        } else {
+            $size = 0;
+            $toDelete = [];  // versions we want to delete
+        }
+
+        foreach ($versions as $key => $version) {
+            if ($expiration->isExpired($version['version'], $quotaExceeded) && !isset($toDelete[$key])) {
+                $size += $version['size'];
+                $toDelete[$key] = $version['path'] . '.v' . $version['version'];
+            }
+        }
+
+        return [$toDelete, $size];
+    }
+
+    /**
+     * get list of files we want to expire
+     * @param array $versions list of versions
+     * @param integer $time
+     * @return array containing the list of to deleted versions and the size of them
+     */
+    protected static function getAutoExpireList($time, $versions) {
+        $size = 0;
+        $toDelete = array();  // versions we want to delete
+
+        $interval = 1;
+        $step = Storage::$max_versions_per_interval[$interval]['step'];
+        if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] === -1) {
+            $nextInterval = -1;
+        } else {
+            $nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
+        }
+
+        $firstVersion = reset($versions);
+        $firstKey = key($versions);
+        $prevTimestamp = $firstVersion['version'];
+        $nextVersion = $firstVersion['version'] - $step;
+        unset($versions[$firstKey]);
+
+        foreach ($versions as $key => $version) {
+            $newInterval = true;
+            while ($newInterval) {
+                if ($nextInterval === -1 || $prevTimestamp > $nextInterval) {
+                    if ($version['version'] > $nextVersion) {
+                        //distance between two version too small, mark to delete
+                        $toDelete[$key] = $version['path'] . '.v' . $version['version'];
+                        $size += $version['size'];
+                        \OCP\Util::writeLog('files_versions', 'Mark to expire '. $version['path'] .' next version should be ' . $nextVersion . " or smaller. (prevTimestamp: " . $prevTimestamp . "; step: " . $step, \OCP\Util::INFO);
+                    } else {
+                        $nextVersion = $version['version'] - $step;
+                        $prevTimestamp = $version['version'];
+                    }
+                    $newInterval = false; // version checked so we can move to the next one
+                } else { // time to move on to the next interval
+                    $interval++;
+                    $step = Storage::$max_versions_per_interval[$interval]['step'];
+                    $nextVersion = $prevTimestamp - $step;
+                    if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] === -1) {
+                        $nextInterval = -1;
+                    } else {
+                        $nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
+                    }
+                    $newInterval = true; // we changed the interval -> check same version with new interval
+                }
+            }
+        }
+
+        return array($toDelete, $size);
+    }
+
+    /**
+     * Schedule versions expiration for the given file
+     *
+     * @param string $uid owner of the file
+     * @param string $fileName file/folder for which to schedule expiration
+     */
+    private static function scheduleExpire($uid, $fileName) {
+        // let the admin disable auto expire
+        $expiration = self::getExpiration();
+        if ($expiration->isEnabled()) {
+            $command = new Expire($uid, $fileName);
+            \OC::$server->getCommandBus()->push($command);
+        }
+    }
+
+    /**
+     * Expire versions which exceed the quota.
+     *
+     * This will setup the filesystem for the given user but will not
+     * tear it down afterwards.
+     *
+     * @param string $filename path to file to expire
+     * @param string $uid user for which to expire the version
+     * @return bool|int|null
+     */
+    public static function expire($filename, $uid) {
+        $expiration = self::getExpiration();
+
+        if ($expiration->isEnabled()) {
+            // get available disk space for user
+            $user = \OC::$server->getUserManager()->get($uid);
+            if (is_null($user)) {
+                \OCP\Util::writeLog('files_versions', 'Backends provided no user object for ' . $uid, \OCP\Util::ERROR);
+                throw new \OC\User\NoUserException('Backends provided no user object for ' . $uid);
+            }
+
+            \OC_Util::setupFS($uid);
+
+            if (!Filesystem::file_exists($filename)) {
+                return false;
+            }
+
+            if (empty($filename)) {
+                // file maybe renamed or deleted
+                return false;
+            }
+            $versionsFileview = new View('/'.$uid.'/files_versions');
+
+            $softQuota = true;
+            $quota = $user->getQuota();
+            if ( $quota === null || $quota === 'none' ) {
+                $quota = Filesystem::free_space('/');
+                $softQuota = false;
+            } else {
+                $quota = \OCP\Util::computerFileSize($quota);
+            }
+
+            // make sure that we have the current size of the version history
+            $versionsSize = self::getVersionsSize($uid);
+
+            // calculate available space for version history
+            // subtract size of files and current versions size from quota
+            if ($quota >= 0) {
+                if ($softQuota) {
+                    $files_view = new View('/' . $uid . '/files');
+                    $rootInfo = $files_view->getFileInfo('/', false);
+                    $free = $quota - $rootInfo['size']; // remaining free space for user
+                    if ($free > 0) {
+                        $availableSpace = ($free * self::DEFAULTMAXSIZE / 100) - $versionsSize; // how much space can be used for versions
+                    } else {
+                        $availableSpace = $free - $versionsSize;
+                    }
+                } else {
+                    $availableSpace = $quota;
+                }
+            } else {
+                $availableSpace = PHP_INT_MAX;
+            }
+
+            $allVersions = Storage::getVersions($uid, $filename);
+
+            $time = time();
+            list($toDelete, $sizeOfDeletedVersions) = self::getExpireList($time, $allVersions, $availableSpace <= 0);
+
+            $availableSpace = $availableSpace + $sizeOfDeletedVersions;
+            $versionsSize = $versionsSize - $sizeOfDeletedVersions;
+
+            // if still not enough free space we rearrange the versions from all files
+            if ($availableSpace <= 0) {
+                $result = Storage::getAllVersions($uid);
+                $allVersions = $result['all'];
+
+                foreach ($result['by_file'] as $versions) {
+                    list($toDeleteNew, $size) = self::getExpireList($time, $versions, $availableSpace <= 0);
+                    $toDelete = array_merge($toDelete, $toDeleteNew);
+                    $sizeOfDeletedVersions += $size;
+                }
+                $availableSpace = $availableSpace + $sizeOfDeletedVersions;
+                $versionsSize = $versionsSize - $sizeOfDeletedVersions;
+            }
+
+            foreach($toDelete as $key => $path) {
+                \OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
+                self::deleteVersion($versionsFileview, $path);
+                \OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
+                unset($allVersions[$key]); // update array with the versions we keep
+                \OCP\Util::writeLog('files_versions', "Expire: " . $path, \OCP\Util::INFO);
+            }
+
+            // Check if enough space is available after versions are rearranged.
+            // If not we delete the oldest versions until we meet the size limit for versions,
+            // but always keep the two latest versions
+            $numOfVersions = count($allVersions) -2 ;
+            $i = 0;
+            // sort oldest first and make sure that we start at the first element
+            ksort($allVersions);
+            reset($allVersions);
+            while ($availableSpace < 0 && $i < $numOfVersions) {
+                $version = current($allVersions);
+                \OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
+                self::deleteVersion($versionsFileview, $version['path'] . '.v' . $version['version']);
+                \OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
+                \OCP\Util::writeLog('files_versions', 'running out of space! Delete oldest version: ' . $version['path'].'.v'.$version['version'] , \OCP\Util::INFO);
+                $versionsSize -= $version['size'];
+                $availableSpace += $version['size'];
+                next($allVersions);
+                $i++;
+            }
+
+            return $versionsSize; // finally return the new size of the version history
+        }
+
+        return false;
+    }
+
+    /**
+     * Create recursively missing directories inside of files_versions
+     * that match the given path to a file.
+     *
+     * @param string $filename $path to a file, relative to the user's
+     * "files" folder
+     * @param View $view view on data/user/
+     */
+    private static function createMissingDirectories($filename, $view) {
+        $dirname = Filesystem::normalizePath(dirname($filename));
+        $dirParts = explode('/', $dirname);
+        $dir = "/files_versions";
+        foreach ($dirParts as $part) {
+            $dir = $dir . '/' . $part;
+            if (!$view->file_exists($dir)) {
+                $view->mkdir($dir);
+            }
+        }
+    }
+
+    /**
+     * Static workaround
+     * @return Expiration
+     */
+    protected static function getExpiration(){
+        if (is_null(self::$application)) {
+            self::$application = new Application();
+        }
+        return self::$application->getContainer()->query('Expiration');
+    }
 
 }

Spacing +67 added lines, -67 removed lines

@@ -54,8 +54,8 @@ 
 
 class Storage {
 
-	const DEFAULTENABLED=true;
-	const DEFAULTMAXSIZE=50; // unit: percentage; 50% of available disk space/quota
+	const DEFAULTENABLED = true;
+	const DEFAULTMAXSIZE = 50; // unit: percentage; 50% of available disk space/quota
 	const VERSIONS_ROOT = 'files_versions/';
 
 	const DELETE_TRIGGER_MASTER_REMOVED = 0;
@@ -69,17 +69,17 @@ 
 
 	private static $max_versions_per_interval = array(
 		//first 10sec, one version every 2sec
-		1 => array('intervalEndsAfter' => 10,      'step' => 2),
+		1 => array('intervalEndsAfter' => 10, 'step' => 2),
 		//next minute, one version every 10sec
-		2 => array('intervalEndsAfter' => 60,      'step' => 10),
+		2 => array('intervalEndsAfter' => 60, 'step' => 10),
 		//next hour, one version every minute
-		3 => array('intervalEndsAfter' => 3600,    'step' => 60),
+		3 => array('intervalEndsAfter' => 3600, 'step' => 60),
 		//next 24h, one version every hour
-		4 => array('intervalEndsAfter' => 86400,   'step' => 3600),
+		4 => array('intervalEndsAfter' => 86400, 'step' => 3600),
 		//next 30days, one version per day
 		5 => array('intervalEndsAfter' => 2592000, 'step' => 86400),
 		//until the end one version per week
-		6 => array('intervalEndsAfter' => -1,      'step' => 604800),
+		6 => array('intervalEndsAfter' => -1, 'step' => 604800),
 	);
 
 	/** @var \OCA\Files_Versions\AppInfo\Application */
@@ -103,7 +103,7 @@ 
 			$uid = User::getUser();
 		}
 		Filesystem::initMountPoints($uid);
-		if ( $uid !== User::getUser() ) {
+		if ($uid !== User::getUser()) {
 			$info = Filesystem::getFileInfo($filename);
 			$ownerView = new View('/'.$uid.'/files');
 			try {
@@ -153,7 +153,7 @@ 
 	 * @return int versions size
 	 */
 	private static function getVersionsSize($user) {
-		$view = new View('/' . $user);
+		$view = new View('/'.$user);
 		$fileInfo = $view->getFileInfo('/files_versions');
 		return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
 	}
@@ -171,13 +171,13 @@ 
 		}
 
 		// we only handle existing files
-		if (! Filesystem::file_exists($filename) || Filesystem::is_dir($filename)) {
+		if (!Filesystem::file_exists($filename) || Filesystem::is_dir($filename)) {
 			return false;
 		}
 
 		list($uid, $filename) = self::getUidAndFilename($filename);
 
-		$files_view = new View('/'.$uid .'/files');
+		$files_view = new View('/'.$uid.'/files');
 		$users_view = new View('/'.$uid);
 
 		$eventDispatcher = \OC::$server->getEventDispatcher();
@@ -202,10 +202,10 @@ 
 		self::scheduleExpire($uid, $filename);
 
 		// store a new version of a file
-		$mtime = $users_view->filemtime('files/' . $filename);
-		$users_view->copy('files/' . $filename, 'files_versions/' . $filename . '.v' . $mtime);
+		$mtime = $users_view->filemtime('files/'.$filename);
+		$users_view->copy('files/'.$filename, 'files_versions/'.$filename.'.v'.$mtime);
 		// call getFileInfo to enforce a file cache entry for the new version
-		$users_view->getFileInfo('files_versions/' . $filename . '.v' . $mtime);
+		$users_view->getFileInfo('files_versions/'.$filename.'.v'.$mtime);
 	}
 
 
@@ -248,14 +248,14 @@ 
 
 		if (!Filesystem::file_exists($path)) {
 
-			$view = new View('/' . $uid . '/files_versions');
+			$view = new View('/'.$uid.'/files_versions');
 
 			$versions = self::getVersions($uid, $filename);
 			if (!empty($versions)) {
 				foreach ($versions as $v) {
-					\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
-					self::deleteVersion($view, $filename . '.v' . $v['version']);
-					\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
+					\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path.$v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
+					self::deleteVersion($view, $filename.'.v'.$v['version']);
+					\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path.$v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
 				}
 			}
 		}
@@ -289,33 +289,33 @@ 
 		$rootView = new View('');
 
 		// did we move a directory ?
-		if ($rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
+		if ($rootView->is_dir('/'.$targetOwner.'/files/'.$targetPath)) {
 			// does the directory exists for versions too ?
-			if ($rootView->is_dir('/' . $sourceOwner . '/files_versions/' . $sourcePath)) {
+			if ($rootView->is_dir('/'.$sourceOwner.'/files_versions/'.$sourcePath)) {
 				// create missing dirs if necessary
-				self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
+				self::createMissingDirectories($targetPath, new View('/'.$targetOwner));
 
 				// move the directory containing the versions
 				$rootView->$operation(
-					'/' . $sourceOwner . '/files_versions/' . $sourcePath,
-					'/' . $targetOwner . '/files_versions/' . $targetPath
+					'/'.$sourceOwner.'/files_versions/'.$sourcePath,
+					'/'.$targetOwner.'/files_versions/'.$targetPath
 				);
 			}
-		} else if ($versions = Storage::getVersions($sourceOwner, '/' . $sourcePath)) {
+		} else if ($versions = Storage::getVersions($sourceOwner, '/'.$sourcePath)) {
 			// create missing dirs if necessary
-			self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
+			self::createMissingDirectories($targetPath, new View('/'.$targetOwner));
 
 			foreach ($versions as $v) {
 				// move each version one by one to the target directory
 				$rootView->$operation(
-					'/' . $sourceOwner . '/files_versions/' . $sourcePath.'.v' . $v['version'],
-					'/' . $targetOwner . '/files_versions/' . $targetPath.'.v'.$v['version']
+					'/'.$sourceOwner.'/files_versions/'.$sourcePath.'.v'.$v['version'],
+					'/'.$targetOwner.'/files_versions/'.$targetPath.'.v'.$v['version']
 				);
 			}
 		}
 
 		// if we moved versions directly for a file, schedule expiration check for that file
-		if (!$rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
+		if (!$rootView->is_dir('/'.$targetOwner.'/files/'.$targetPath)) {
 			self::scheduleExpire($targetOwner, $targetPath);
 		}
 
@@ -331,14 +331,14 @@ 
 	public static function rollback($file, $revision) {
 
 		// add expected leading slash
-		$file = '/' . ltrim($file, '/');
+		$file = '/'.ltrim($file, '/');
 		list($uid, $filename) = self::getUidAndFilename($file);
 		if ($uid === null || trim($filename, '/') === '') {
 			return false;
 		}
 
 		$users_view = new View('/'.$uid);
-		$files_view = new View('/'. User::getUser().'/files');
+		$files_view = new View('/'.User::getUser().'/files');
 
 		$versionCreated = false;
 
@@ -356,7 +356,7 @@ 
 			$versionCreated = true;
 		}
 
-		$fileToRestore =  'files_versions' . $filename . '.v' . $revision;
+		$fileToRestore = 'files_versions'.$filename.'.v'.$revision;
 
 		// Restore encrypted version of the old file for the newly restored file
 		// This has to happen manually here since the file is manually copied below
@@ -372,7 +372,7 @@ 
 		);
 
 		// rollback
-		if (self::copyFileContents($users_view, $fileToRestore, 'files' . $filename)) {
+		if (self::copyFileContents($users_view, $fileToRestore, 'files'.$filename)) {
 			$files_view->touch($file, $revision);
 			Storage::scheduleExpire($uid, $file);
 			\OC_Hook::emit('\OCP\Versions', 'rollback', array(
@@ -440,12 +440,12 @@ 
 			return $versions;
 		}
 		// fetch for old versions
-		$view = new View('/' . $uid . '/');
+		$view = new View('/'.$uid.'/');
 
 		$pathinfo = pathinfo($filename);
 		$versionedFile = $pathinfo['basename'];
 
-		$dir = Filesystem::normalizePath(self::VERSIONS_ROOT . '/' . $pathinfo['dirname']);
+		$dir = Filesystem::normalizePath(self::VERSIONS_ROOT.'/'.$pathinfo['dirname']);
 
 		$dirContent = false;
 		if ($view->is_dir($dir)) {
@@ -465,7 +465,7 @@ 
 						$pathparts = pathinfo($entryName);
 						$timestamp = substr($pathparts['extension'], 1);
 						$filename = $pathparts['filename'];
-						$key = $timestamp . '#' . $filename;
+						$key = $timestamp.'#'.$filename;
 						$versions[$key]['version'] = $timestamp;
 						$versions[$key]['humanReadableTimestamp'] = self::getHumanReadableTimestamp($timestamp);
 						if (empty($userFullPath)) {
@@ -473,9 +473,9 @@ 
 						} else {
 							$versions[$key]['preview'] = \OC::$server->getURLGenerator('files_version.Preview.getPreview', ['file' => $userFullPath, 'version' => $timestamp]);
 						}
-						$versions[$key]['path'] = Filesystem::normalizePath($pathinfo['dirname'] . '/' . $filename);
+						$versions[$key]['path'] = Filesystem::normalizePath($pathinfo['dirname'].'/'.$filename);
 						$versions[$key]['name'] = $versionedFile;
-						$versions[$key]['size'] = $view->filesize($dir . '/' . $entryName);
+						$versions[$key]['size'] = $view->filesize($dir.'/'.$entryName);
 						$versions[$key]['mimetype'] = \OC::$server->getMimeTypeDetector()->detectPath($versionedFile);
 					}
 				}
@@ -493,7 +493,7 @@ 
 	 * Expire versions that older than max version retention time
 	 * @param string $uid
 	 */
-	public static function expireOlderThanMaxForUser($uid){
+	public static function expireOlderThanMaxForUser($uid) {
 		$expiration = self::getExpiration();
 		$threshold = $expiration->getMaxAgeAsTimestamp();
 		$versions = self::getAllVersions($uid);
@@ -503,7 +503,7 @@ 
 
 		$toDelete = [];
 		foreach (array_reverse($versions['all']) as $key => $version) {
-			if ((int)$version['version'] <$threshold) {
+			if ((int) $version['version'] < $threshold) {
 				$toDelete[$key] = $version;
 			} else {
 				//Versions are sorted by time - nothing mo to iterate.
@@ -511,11 +511,11 @@ 
 			}
 		}
 
-		$view = new View('/' . $uid . '/files_versions');
+		$view = new View('/'.$uid.'/files_versions');
 		if (!empty($toDelete)) {
 			foreach ($toDelete as $version) {
 				\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
-				self::deleteVersion($view, $version['path'] . '.v' . $version['version']);
+				self::deleteVersion($view, $version['path'].'.v'.$version['version']);
 				\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
 			}
 		}
@@ -531,19 +531,19 @@ 
 		$diff = time() - $timestamp;
 
 		if ($diff < 60) { // first minute
-			return  $diff . " seconds ago";
+			return  $diff." seconds ago";
 		} elseif ($diff < 3600) { //first hour
-			return round($diff / 60) . " minutes ago";
+			return round($diff / 60)." minutes ago";
 		} elseif ($diff < 86400) { // first day
-			return round($diff / 3600) . " hours ago";
+			return round($diff / 3600)." hours ago";
 		} elseif ($diff < 604800) { //first week
-			return round($diff / 86400) . " days ago";
+			return round($diff / 86400)." days ago";
 		} elseif ($diff < 2419200) { //first month
-			return round($diff / 604800) . " weeks ago";
+			return round($diff / 604800)." weeks ago";
 		} elseif ($diff < 29030400) { // first year
-			return round($diff / 2419200) . " months ago";
+			return round($diff / 2419200)." months ago";
 		} else {
-			return round($diff / 29030400) . " years ago";
+			return round($diff / 29030400)." years ago";
 		}
 
 	}
@@ -554,7 +554,7 @@ 
 	 * @return array with contains two arrays 'all' which contains all versions sorted by age and 'by_file' which contains all versions sorted by filename
 	 */
 	private static function getAllVersions($uid) {
-		$view = new View('/' . $uid . '/');
+		$view = new View('/'.$uid.'/');
 		$dirs = array(self::VERSIONS_ROOT);
 		$versions = array();
 
@@ -564,7 +564,7 @@ 
 
 			foreach ($files as $file) {
 				$fileData = $file->getData();
-				$filePath = $dir . '/' . $fileData['name'];
+				$filePath = $dir.'/'.$fileData['name'];
 				if ($file['type'] === 'dir') {
 					array_push($dirs, $filePath);
 				} else {
@@ -572,7 +572,7 @@ 
 					$relPathStart = strlen(self::VERSIONS_ROOT);
 					$version = substr($filePath, $versionsBegin + 2);
 					$relpath = substr($filePath, $relPathStart, $versionsBegin - $relPathStart);
-					$key = $version . '#' . $relpath;
+					$key = $version.'#'.$relpath;
 					$versions[$key] = array('path' => $relpath, 'timestamp' => $version);
 				}
 			}
@@ -613,13 +613,13 @@ 
 			list($toDelete, $size) = self::getAutoExpireList($time, $versions);
 		} else {
 			$size = 0;
-			$toDelete = [];  // versions we want to delete
+			$toDelete = []; // versions we want to delete
 		}
 
 		foreach ($versions as $key => $version) {
 			if ($expiration->isExpired($version['version'], $quotaExceeded) && !isset($toDelete[$key])) {
 				$size += $version['size'];
-				$toDelete[$key] = $version['path'] . '.v' . $version['version'];
+				$toDelete[$key] = $version['path'].'.v'.$version['version'];
 			}
 		}
 
@@ -634,7 +634,7 @@ 
 	 */
 	protected static function getAutoExpireList($time, $versions) {
 		$size = 0;
-		$toDelete = array();  // versions we want to delete
+		$toDelete = array(); // versions we want to delete
 
 		$interval = 1;
 		$step = Storage::$max_versions_per_interval[$interval]['step'];
@@ -656,9 +656,9 @@ 
 				if ($nextInterval === -1 || $prevTimestamp > $nextInterval) {
 					if ($version['version'] > $nextVersion) {
 						//distance between two version too small, mark to delete
-						$toDelete[$key] = $version['path'] . '.v' . $version['version'];
+						$toDelete[$key] = $version['path'].'.v'.$version['version'];
 						$size += $version['size'];
-						\OCP\Util::writeLog('files_versions', 'Mark to expire '. $version['path'] .' next version should be ' . $nextVersion . " or smaller. (prevTimestamp: " . $prevTimestamp . "; step: " . $step, \OCP\Util::INFO);
+						\OCP\Util::writeLog('files_versions', 'Mark to expire '.$version['path'].' next version should be '.$nextVersion." or smaller. (prevTimestamp: ".$prevTimestamp."; step: ".$step, \OCP\Util::INFO);
 					} else {
 						$nextVersion = $version['version'] - $step;
 						$prevTimestamp = $version['version'];
@@ -713,8 +713,8 @@ 
 			// get available disk space for user
 			$user = \OC::$server->getUserManager()->get($uid);
 			if (is_null($user)) {
-				\OCP\Util::writeLog('files_versions', 'Backends provided no user object for ' . $uid, \OCP\Util::ERROR);
-				throw new \OC\User\NoUserException('Backends provided no user object for ' . $uid);
+				\OCP\Util::writeLog('files_versions', 'Backends provided no user object for '.$uid, \OCP\Util::ERROR);
+				throw new \OC\User\NoUserException('Backends provided no user object for '.$uid);
 			}
 
 			\OC_Util::setupFS($uid);
@@ -731,7 +731,7 @@ 
 
 			$softQuota = true;
 			$quota = $user->getQuota();
-			if ( $quota === null || $quota === 'none' ) {
+			if ($quota === null || $quota === 'none') {
 				$quota = Filesystem::free_space('/');
 				$softQuota = false;
 			} else {
@@ -745,7 +745,7 @@ 
 			// subtract size of files and current versions size from quota
 			if ($quota >= 0) {
 				if ($softQuota) {
-					$files_view = new View('/' . $uid . '/files');
+					$files_view = new View('/'.$uid.'/files');
 					$rootInfo = $files_view->getFileInfo('/', false);
 					$free = $quota - $rootInfo['size']; // remaining free space for user
 					if ($free > 0) {
@@ -782,18 +782,18 @@ 
 				$versionsSize = $versionsSize - $sizeOfDeletedVersions;
 			}
 
-			foreach($toDelete as $key => $path) {
+			foreach ($toDelete as $key => $path) {
 				\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
 				self::deleteVersion($versionsFileview, $path);
 				\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
 				unset($allVersions[$key]); // update array with the versions we keep
-				\OCP\Util::writeLog('files_versions', "Expire: " . $path, \OCP\Util::INFO);
+				\OCP\Util::writeLog('files_versions', "Expire: ".$path, \OCP\Util::INFO);
 			}
 
 			// Check if enough space is available after versions are rearranged.
 			// If not we delete the oldest versions until we meet the size limit for versions,
 			// but always keep the two latest versions
-			$numOfVersions = count($allVersions) -2 ;
+			$numOfVersions = count($allVersions) - 2;
 			$i = 0;
 			// sort oldest first and make sure that we start at the first element
 			ksort($allVersions);
@@ -801,9 +801,9 @@ 
 			while ($availableSpace < 0 && $i < $numOfVersions) {
 				$version = current($allVersions);
 				\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
-				self::deleteVersion($versionsFileview, $version['path'] . '.v' . $version['version']);
+				self::deleteVersion($versionsFileview, $version['path'].'.v'.$version['version']);
 				\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
-				\OCP\Util::writeLog('files_versions', 'running out of space! Delete oldest version: ' . $version['path'].'.v'.$version['version'] , \OCP\Util::INFO);
+				\OCP\Util::writeLog('files_versions', 'running out of space! Delete oldest version: '.$version['path'].'.v'.$version['version'], \OCP\Util::INFO);
 				$versionsSize -= $version['size'];
 				$availableSpace += $version['size'];
 				next($allVersions);
@@ -829,7 +829,7 @@ 
 		$dirParts = explode('/', $dirname);
 		$dir = "/files_versions";
 		foreach ($dirParts as $part) {
-			$dir = $dir . '/' . $part;
+			$dir = $dir.'/'.$part;
 			if (!$view->file_exists($dir)) {
 				$view->mkdir($dir);
 			}
@@ -840,7 +840,7 @@ 
 	 * Static workaround
 	 * @return Expiration
 	 */
-	protected static function getExpiration(){
+	protected static function getExpiration() {
 		if (is_null(self::$application)) {
 			self::$application = new Application();
 		}

apps/user_ldap/lib/Wizard.php

Indentation +1305 added lines, -1305 removed lines

@@ -41,1311 +41,1311 @@
 use OC\ServerNotAvailableException;
 
 class Wizard extends LDAPUtility {
-	/** @var \OCP\IL10N */
-	static protected $l;
-	protected $access;
-	protected $cr;
-	protected $configuration;
-	protected $result;
-	protected $resultCache = array();
-
-	const LRESULT_PROCESSED_OK = 2;
-	const LRESULT_PROCESSED_INVALID = 3;
-	const LRESULT_PROCESSED_SKIP = 4;
-
-	const LFILTER_LOGIN      = 2;
-	const LFILTER_USER_LIST  = 3;
-	const LFILTER_GROUP_LIST = 4;
-
-	const LFILTER_MODE_ASSISTED = 2;
-	const LFILTER_MODE_RAW = 1;
-
-	const LDAP_NW_TIMEOUT = 4;
-
-	/**
-	 * Constructor
-	 * @param Configuration $configuration an instance of Configuration
-	 * @param ILDAPWrapper $ldap an instance of ILDAPWrapper
-	 * @param Access $access
-	 */
-	public function __construct(Configuration $configuration, ILDAPWrapper $ldap, Access $access) {
-		parent::__construct($ldap);
-		$this->configuration = $configuration;
-		if(is_null(Wizard::$l)) {
-			Wizard::$l = \OC::$server->getL10N('user_ldap');
-		}
-		$this->access = $access;
-		$this->result = new WizardResult();
-	}
-
-	public function  __destruct() {
-		if($this->result->hasChanges()) {
-			$this->configuration->saveConfiguration();
-		}
-	}
-
-	/**
-	 * counts entries in the LDAP directory
-	 *
-	 * @param string $filter the LDAP search filter
-	 * @param string $type a string being either 'users' or 'groups';
-	 * @return bool|int
-	 * @throws \Exception
-	 */
-	public function countEntries($filter, $type) {
-		$reqs = array('ldapHost', 'ldapPort', 'ldapBase');
-		if($type === 'users') {
-			$reqs[] = 'ldapUserFilter';
-		}
-		if(!$this->checkRequirements($reqs)) {
-			throw new \Exception('Requirements not met', 400);
-		}
-
-		$attr = array('dn'); // default
-		$limit = 1001;
-		if($type === 'groups') {
-			$result =  $this->access->countGroups($filter, $attr, $limit);
-		} else if($type === 'users') {
-			$result = $this->access->countUsers($filter, $attr, $limit);
-		} else if ($type === 'objects') {
-			$result = $this->access->countObjects($limit);
-		} else {
-			throw new \Exception('Internal error: Invalid object type', 500);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * formats the return value of a count operation to the string to be
-	 * inserted.
-	 *
-	 * @param bool|int $count
-	 * @return int|string
-	 */
-	private function formatCountResult($count) {
-		$formatted = ($count !== false) ? $count : 0;
-		if($formatted > 1000) {
-			$formatted = '> 1000';
-		}
-		return $formatted;
-	}
-
-	public function countGroups() {
-		$filter = $this->configuration->ldapGroupFilter;
-
-		if(empty($filter)) {
-			$output = self::$l->n('%s group found', '%s groups found', 0, array(0));
-			$this->result->addChange('ldap_group_count', $output);
-			return $this->result;
-		}
-
-		try {
-			$groupsTotal = $this->formatCountResult($this->countEntries($filter, 'groups'));
-		} catch (\Exception $e) {
-			//400 can be ignored, 500 is forwarded
-			if($e->getCode() === 500) {
-				throw $e;
-			}
-			return false;
-		}
-		$output = self::$l->n('%s group found', '%s groups found', $groupsTotal, array($groupsTotal));
-		$this->result->addChange('ldap_group_count', $output);
-		return $this->result;
-	}
-
-	/**
-	 * @return WizardResult
-	 * @throws \Exception
-	 */
-	public function countUsers() {
-		$filter = $this->access->getFilterForUserCount();
-
-		$usersTotal = $this->formatCountResult($this->countEntries($filter, 'users'));
-		$output = self::$l->n('%s user found', '%s users found', $usersTotal, array($usersTotal));
-		$this->result->addChange('ldap_user_count', $output);
-		return $this->result;
-	}
-
-	/**
-	 * counts any objects in the currently set base dn
-	 *
-	 * @return WizardResult
-	 * @throws \Exception
-	 */
-	public function countInBaseDN() {
-		// we don't need to provide a filter in this case
-		$total = $this->countEntries(null, 'objects');
-		if($total === false) {
-			throw new \Exception('invalid results received');
-		}
-		$this->result->addChange('ldap_test_base', $total);
-		return $this->result;
-	}
-
-	/**
-	 * counts users with a specified attribute
-	 * @param string $attr
-	 * @param bool $existsCheck
-	 * @return int|bool
-	 */
-	public function countUsersWithAttribute($attr, $existsCheck = false) {
-		if(!$this->checkRequirements(array('ldapHost',
-										   'ldapPort',
-										   'ldapBase',
-										   'ldapUserFilter',
-										   ))) {
-			return  false;
-		}
-
-		$filter = $this->access->combineFilterWithAnd(array(
-			$this->configuration->ldapUserFilter,
-			$attr . '=*'
-		));
-
-		$limit = ($existsCheck === false) ? null : 1;
-
-		return $this->access->countUsers($filter, array('dn'), $limit);
-	}
-
-	/**
-	 * detects the display name attribute. If a setting is already present that
-	 * returns at least one hit, the detection will be canceled.
-	 * @return WizardResult|bool
-	 * @throws \Exception
-	 */
-	public function detectUserDisplayNameAttribute() {
-		if(!$this->checkRequirements(array('ldapHost',
-										'ldapPort',
-										'ldapBase',
-										'ldapUserFilter',
-										))) {
-			return  false;
-		}
-
-		$attr = $this->configuration->ldapUserDisplayName;
-		if ($attr !== '' && $attr !== 'displayName') {
-			// most likely not the default value with upper case N,
-			// verify it still produces a result
-			$count = (int)$this->countUsersWithAttribute($attr, true);
-			if($count > 0) {
-				//no change, but we sent it back to make sure the user interface
-				//is still correct, even if the ajax call was cancelled meanwhile
-				$this->result->addChange('ldap_display_name', $attr);
-				return $this->result;
-			}
-		}
-
-		// first attribute that has at least one result wins
-		$displayNameAttrs = array('displayname', 'cn');
-		foreach ($displayNameAttrs as $attr) {
-			$count = (int)$this->countUsersWithAttribute($attr, true);
-
-			if($count > 0) {
-				$this->applyFind('ldap_display_name', $attr);
-				return $this->result;
-			}
-		};
-
-		throw new \Exception(self::$l->t('Could not detect user display name attribute. Please specify it yourself in advanced LDAP settings.'));
-	}
-
-	/**
-	 * detects the most often used email attribute for users applying to the
-	 * user list filter. If a setting is already present that returns at least
-	 * one hit, the detection will be canceled.
-	 * @return WizardResult|bool
-	 */
-	public function detectEmailAttribute() {
-		if(!$this->checkRequirements(array('ldapHost',
-										   'ldapPort',
-										   'ldapBase',
-										   'ldapUserFilter',
-										   ))) {
-			return  false;
-		}
-
-		$attr = $this->configuration->ldapEmailAttribute;
-		if ($attr !== '') {
-			$count = (int)$this->countUsersWithAttribute($attr, true);
-			if($count > 0) {
-				return false;
-			}
-			$writeLog = true;
-		} else {
-			$writeLog = false;
-		}
-
-		$emailAttributes = array('mail', 'mailPrimaryAddress');
-		$winner = '';
-		$maxUsers = 0;
-		foreach($emailAttributes as $attr) {
-			$count = $this->countUsersWithAttribute($attr);
-			if($count > $maxUsers) {
-				$maxUsers = $count;
-				$winner = $attr;
-			}
-		}
-
-		if($winner !== '') {
-			$this->applyFind('ldap_email_attr', $winner);
-			if($writeLog) {
-				\OCP\Util::writeLog('user_ldap', 'The mail attribute has ' .
-					'automatically been reset, because the original value ' .
-					'did not return any results.', \OCP\Util::INFO);
-			}
-		}
-
-		return $this->result;
-	}
-
-	/**
-	 * @return WizardResult
-	 * @throws \Exception
-	 */
-	public function determineAttributes() {
-		if(!$this->checkRequirements(array('ldapHost',
-										   'ldapPort',
-										   'ldapBase',
-										   'ldapUserFilter',
-										   ))) {
-			return  false;
-		}
-
-		$attributes = $this->getUserAttributes();
-
-		natcasesort($attributes);
-		$attributes = array_values($attributes);
-
-		$this->result->addOptions('ldap_loginfilter_attributes', $attributes);
-
-		$selected = $this->configuration->ldapLoginFilterAttributes;
-		if(is_array($selected) && !empty($selected)) {
-			$this->result->addChange('ldap_loginfilter_attributes', $selected);
-		}
-
-		return $this->result;
-	}
-
-	/**
-	 * detects the available LDAP attributes
-	 * @return array|false The instance's WizardResult instance
-	 * @throws \Exception
-	 */
-	private function getUserAttributes() {
-		if(!$this->checkRequirements(array('ldapHost',
-										   'ldapPort',
-										   'ldapBase',
-										   'ldapUserFilter',
-										   ))) {
-			return  false;
-		}
-		$cr = $this->getConnection();
-		if(!$cr) {
-			throw new \Exception('Could not connect to LDAP');
-		}
-
-		$base = $this->configuration->ldapBase[0];
-		$filter = $this->configuration->ldapUserFilter;
-		$rr = $this->ldap->search($cr, $base, $filter, array(), 1, 1);
-		if(!$this->ldap->isResource($rr)) {
-			return false;
-		}
-		$er = $this->ldap->firstEntry($cr, $rr);
-		$attributes = $this->ldap->getAttributes($cr, $er);
-		$pureAttributes = array();
-		for($i = 0; $i < $attributes['count']; $i++) {
-			$pureAttributes[] = $attributes[$i];
-		}
-
-		return $pureAttributes;
-	}
-
-	/**
-	 * detects the available LDAP groups
-	 * @return WizardResult|false the instance's WizardResult instance
-	 */
-	public function determineGroupsForGroups() {
-		return $this->determineGroups('ldap_groupfilter_groups',
-									  'ldapGroupFilterGroups',
-									  false);
-	}
-
-	/**
-	 * detects the available LDAP groups
-	 * @return WizardResult|false the instance's WizardResult instance
-	 */
-	public function determineGroupsForUsers() {
-		return $this->determineGroups('ldap_userfilter_groups',
-									  'ldapUserFilterGroups');
-	}
-
-	/**
-	 * detects the available LDAP groups
-	 * @param string $dbKey
-	 * @param string $confKey
-	 * @param bool $testMemberOf
-	 * @return WizardResult|false the instance's WizardResult instance
-	 * @throws \Exception
-	 */
-	private function determineGroups($dbKey, $confKey, $testMemberOf = true) {
-		if(!$this->checkRequirements(array('ldapHost',
-										   'ldapPort',
-										   'ldapBase',
-										   ))) {
-			return  false;
-		}
-		$cr = $this->getConnection();
-		if(!$cr) {
-			throw new \Exception('Could not connect to LDAP');
-		}
-
-		$this->fetchGroups($dbKey, $confKey);
-
-		if($testMemberOf) {
-			$this->configuration->hasMemberOfFilterSupport = $this->testMemberOf();
-			$this->result->markChange();
-			if(!$this->configuration->hasMemberOfFilterSupport) {
-				throw new \Exception('memberOf is not supported by the server');
-			}
-		}
-
-		return $this->result;
-	}
-
-	/**
-	 * fetches all groups from LDAP and adds them to the result object
-	 *
-	 * @param string $dbKey
-	 * @param string $confKey
-	 * @return array $groupEntries
-	 * @throws \Exception
-	 */
-	public function fetchGroups($dbKey, $confKey) {
-		$obclasses = array('posixGroup', 'group', 'zimbraDistributionList', 'groupOfNames', 'groupOfUniqueNames');
-
-		$filterParts = array();
-		foreach($obclasses as $obclass) {
-			$filterParts[] = 'objectclass='.$obclass;
-		}
-		//we filter for everything
-		//- that looks like a group and
-		//- has the group display name set
-		$filter = $this->access->combineFilterWithOr($filterParts);
-		$filter = $this->access->combineFilterWithAnd(array($filter, 'cn=*'));
-
-		$groupNames = array();
-		$groupEntries = array();
-		$limit = 400;
-		$offset = 0;
-		do {
-			// we need to request dn additionally here, otherwise memberOf
-			// detection will fail later
-			$result = $this->access->searchGroups($filter, array('cn', 'dn'), $limit, $offset);
-			foreach($result as $item) {
-				if(!isset($item['cn']) && !is_array($item['cn']) && !isset($item['cn'][0])) {
-					// just in case - no issue known
-					continue;
-				}
-				$groupNames[] = $item['cn'][0];
-				$groupEntries[] = $item;
-			}
-			$offset += $limit;
-		} while ($this->access->hasMoreResults());
-
-		if(count($groupNames) > 0) {
-			natsort($groupNames);
-			$this->result->addOptions($dbKey, array_values($groupNames));
-		} else {
-			throw new \Exception(self::$l->t('Could not find the desired feature'));
-		}
-
-		$setFeatures = $this->configuration->$confKey;
-		if(is_array($setFeatures) && !empty($setFeatures)) {
-			//something is already configured? pre-select it.
-			$this->result->addChange($dbKey, $setFeatures);
-		}
-		return $groupEntries;
-	}
-
-	public function determineGroupMemberAssoc() {
-		if(!$this->checkRequirements(array('ldapHost',
-										   'ldapPort',
-										   'ldapGroupFilter',
-										   ))) {
-			return  false;
-		}
-		$attribute = $this->detectGroupMemberAssoc();
-		if($attribute === false) {
-			return false;
-		}
-		$this->configuration->setConfiguration(array('ldapGroupMemberAssocAttr' => $attribute));
-		$this->result->addChange('ldap_group_member_assoc_attribute', $attribute);
-
-		return $this->result;
-	}
-
-	/**
-	 * Detects the available object classes
-	 * @return WizardResult|false the instance's WizardResult instance
-	 * @throws \Exception
-	 */
-	public function determineGroupObjectClasses() {
-		if(!$this->checkRequirements(array('ldapHost',
-										   'ldapPort',
-										   'ldapBase',
-										   ))) {
-			return  false;
-		}
-		$cr = $this->getConnection();
-		if(!$cr) {
-			throw new \Exception('Could not connect to LDAP');
-		}
-
-		$obclasses = array('groupOfNames', 'groupOfUniqueNames', 'group', 'posixGroup', '*');
-		$this->determineFeature($obclasses,
-								'objectclass',
-								'ldap_groupfilter_objectclass',
-								'ldapGroupFilterObjectclass',
-								false);
-
-		return $this->result;
-	}
-
-	/**
-	 * detects the available object classes
-	 * @return WizardResult
-	 * @throws \Exception
-	 */
-	public function determineUserObjectClasses() {
-		if(!$this->checkRequirements(array('ldapHost',
-										   'ldapPort',
-										   'ldapBase',
-										   ))) {
-			return  false;
-		}
-		$cr = $this->getConnection();
-		if(!$cr) {
-			throw new \Exception('Could not connect to LDAP');
-		}
-
-		$obclasses = array('inetOrgPerson', 'person', 'organizationalPerson',
-						   'user', 'posixAccount', '*');
-		$filter = $this->configuration->ldapUserFilter;
-		//if filter is empty, it is probably the first time the wizard is called
-		//then, apply suggestions.
-		$this->determineFeature($obclasses,
-								'objectclass',
-								'ldap_userfilter_objectclass',
-								'ldapUserFilterObjectclass',
-								empty($filter));
-
-		return $this->result;
-	}
-
-	/**
-	 * @return WizardResult|false
-	 * @throws \Exception
-	 */
-	public function getGroupFilter() {
-		if(!$this->checkRequirements(array('ldapHost',
-										   'ldapPort',
-										   'ldapBase',
-										   ))) {
-			return false;
-		}
-		//make sure the use display name is set
-		$displayName = $this->configuration->ldapGroupDisplayName;
-		if ($displayName === '') {
-			$d = $this->configuration->getDefaults();
-			$this->applyFind('ldap_group_display_name',
-							 $d['ldap_group_display_name']);
-		}
-		$filter = $this->composeLdapFilter(self::LFILTER_GROUP_LIST);
-
-		$this->applyFind('ldap_group_filter', $filter);
-		return $this->result;
-	}
-
-	/**
-	 * @return WizardResult|false
-	 * @throws \Exception
-	 */
-	public function getUserListFilter() {
-		if(!$this->checkRequirements(array('ldapHost',
-										   'ldapPort',
-										   'ldapBase',
-										   ))) {
-			return false;
-		}
-		//make sure the use display name is set
-		$displayName = $this->configuration->ldapUserDisplayName;
-		if ($displayName === '') {
-			$d = $this->configuration->getDefaults();
-			$this->applyFind('ldap_display_name', $d['ldap_display_name']);
-		}
-		$filter = $this->composeLdapFilter(self::LFILTER_USER_LIST);
-		if(!$filter) {
-			throw new \Exception('Cannot create filter');
-		}
-
-		$this->applyFind('ldap_userlist_filter', $filter);
-		return $this->result;
-	}
-
-	/**
-	 * @return bool|WizardResult
-	 * @throws \Exception
-	 */
-	public function getUserLoginFilter() {
-		if(!$this->checkRequirements(array('ldapHost',
-										   'ldapPort',
-										   'ldapBase',
-										   'ldapUserFilter',
-										   ))) {
-			return false;
-		}
-
-		$filter = $this->composeLdapFilter(self::LFILTER_LOGIN);
-		if(!$filter) {
-			throw new \Exception('Cannot create filter');
-		}
-
-		$this->applyFind('ldap_login_filter', $filter);
-		return $this->result;
-	}
-
-	/**
-	 * @return bool|WizardResult
-	 * @param string $loginName
-	 * @throws \Exception
-	 */
-	public function testLoginName($loginName) {
-		if(!$this->checkRequirements(array('ldapHost',
-			'ldapPort',
-			'ldapBase',
-			'ldapLoginFilter',
-		))) {
-			return false;
-		}
-
-		$cr = $this->access->connection->getConnectionResource();
-		if(!$this->ldap->isResource($cr)) {
-			throw new \Exception('connection error');
-		}
-
-		if(mb_strpos($this->access->connection->ldapLoginFilter, '%uid', 0, 'UTF-8')
-			=== false) {
-			throw new \Exception('missing placeholder');
-		}
-
-		$users = $this->access->countUsersByLoginName($loginName);
-		if($this->ldap->errno($cr) !== 0) {
-			throw new \Exception($this->ldap->error($cr));
-		}
-		$filter = str_replace('%uid', $loginName, $this->access->connection->ldapLoginFilter);
-		$this->result->addChange('ldap_test_loginname', $users);
-		$this->result->addChange('ldap_test_effective_filter', $filter);
-		return $this->result;
-	}
-
-	/**
-	 * Tries to determine the port, requires given Host, User DN and Password
-	 * @return WizardResult|false WizardResult on success, false otherwise
-	 * @throws \Exception
-	 */
-	public function guessPortAndTLS() {
-		if(!$this->checkRequirements(array('ldapHost',
-										   ))) {
-			return false;
-		}
-		$this->checkHost();
-		$portSettings = $this->getPortSettingsToTry();
-
-		if(!is_array($portSettings)) {
-			throw new \Exception(print_r($portSettings, true));
-		}
-
-		//proceed from the best configuration and return on first success
-		foreach($portSettings as $setting) {
-			$p = $setting['port'];
-			$t = $setting['tls'];
-			\OCP\Util::writeLog('user_ldap', 'Wiz: trying port '. $p . ', TLS '. $t, \OCP\Util::DEBUG);
-			//connectAndBind may throw Exception, it needs to be catched by the
-			//callee of this method
-
-			try {
-				$settingsFound = $this->connectAndBind($p, $t);
-			} catch (\Exception $e) {
-				// any reply other than -1 (= cannot connect) is already okay,
-				// because then we found the server
-				// unavailable startTLS returns -11
-				if($e->getCode() > 0) {
-					$settingsFound = true;
-				} else {
-					throw $e;
-				}
-			}
-
-			if ($settingsFound === true) {
-				$config = array(
-					'ldapPort' => $p,
-					'ldapTLS' => intval($t)
-				);
-				$this->configuration->setConfiguration($config);
-				\OCP\Util::writeLog('user_ldap', 'Wiz: detected Port ' . $p, \OCP\Util::DEBUG);
-				$this->result->addChange('ldap_port', $p);
-				return $this->result;
-			}
-		}
-
-		//custom port, undetected (we do not brute force)
-		return false;
-	}
-
-	/**
-	 * tries to determine a base dn from User DN or LDAP Host
-	 * @return WizardResult|false WizardResult on success, false otherwise
-	 */
-	public function guessBaseDN() {
-		if(!$this->checkRequirements(array('ldapHost',
-										   'ldapPort',
-										   ))) {
-			return false;
-		}
-
-		//check whether a DN is given in the agent name (99.9% of all cases)
-		$base = null;
-		$i = stripos($this->configuration->ldapAgentName, 'dc=');
-		if($i !== false) {
-			$base = substr($this->configuration->ldapAgentName, $i);
-			if($this->testBaseDN($base)) {
-				$this->applyFind('ldap_base', $base);
-				return $this->result;
-			}
-		}
-
-		//this did not help :(
-		//Let's see whether we can parse the Host URL and convert the domain to
-		//a base DN
-		$helper = new Helper(\OC::$server->getConfig());
-		$domain = $helper->getDomainFromURL($this->configuration->ldapHost);
-		if(!$domain) {
-			return false;
-		}
-
-		$dparts = explode('.', $domain);
-		while(count($dparts) > 0) {
-			$base2 = 'dc=' . implode(',dc=', $dparts);
-			if ($base !== $base2 && $this->testBaseDN($base2)) {
-				$this->applyFind('ldap_base', $base2);
-				return $this->result;
-			}
-			array_shift($dparts);
-		}
-
-		return false;
-	}
-
-	/**
-	 * sets the found value for the configuration key in the WizardResult
-	 * as well as in the Configuration instance
-	 * @param string $key the configuration key
-	 * @param string $value the (detected) value
-	 *
-	 */
-	private function applyFind($key, $value) {
-		$this->result->addChange($key, $value);
-		$this->configuration->setConfiguration(array($key => $value));
-	}
-
-	/**
-	 * Checks, whether a port was entered in the Host configuration
-	 * field. In this case the port will be stripped off, but also stored as
-	 * setting.
-	 */
-	private function checkHost() {
-		$host = $this->configuration->ldapHost;
-		$hostInfo = parse_url($host);
-
-		//removes Port from Host
-		if(is_array($hostInfo) && isset($hostInfo['port'])) {
-			$port = $hostInfo['port'];
-			$host = str_replace(':'.$port, '', $host);
-			$this->applyFind('ldap_host', $host);
-			$this->applyFind('ldap_port', $port);
-		}
-	}
-
-	/**
-	 * tries to detect the group member association attribute which is
-	 * one of 'uniqueMember', 'memberUid', 'member', 'gidNumber'
-	 * @return string|false, string with the attribute name, false on error
-	 * @throws \Exception
-	 */
-	private function detectGroupMemberAssoc() {
-		$possibleAttrs = array('uniqueMember', 'memberUid', 'member', 'gidNumber');
-		$filter = $this->configuration->ldapGroupFilter;
-		if(empty($filter)) {
-			return false;
-		}
-		$cr = $this->getConnection();
-		if(!$cr) {
-			throw new \Exception('Could not connect to LDAP');
-		}
-		$base = $this->configuration->ldapBase[0];
-		$rr = $this->ldap->search($cr, $base, $filter, $possibleAttrs, 0, 1000);
-		if(!$this->ldap->isResource($rr)) {
-			return false;
-		}
-		$er = $this->ldap->firstEntry($cr, $rr);
-		while(is_resource($er)) {
-			$this->ldap->getDN($cr, $er);
-			$attrs = $this->ldap->getAttributes($cr, $er);
-			$result = array();
-			$possibleAttrsCount = count($possibleAttrs);
-			for($i = 0; $i < $possibleAttrsCount; $i++) {
-				if(isset($attrs[$possibleAttrs[$i]])) {
-					$result[$possibleAttrs[$i]] = $attrs[$possibleAttrs[$i]]['count'];
-				}
-			}
-			if(!empty($result)) {
-				natsort($result);
-				return key($result);
-			}
-
-			$er = $this->ldap->nextEntry($cr, $er);
-		}
-
-		return false;
-	}
-
-	/**
-	 * Checks whether for a given BaseDN results will be returned
-	 * @param string $base the BaseDN to test
-	 * @return bool true on success, false otherwise
-	 * @throws \Exception
-	 */
-	private function testBaseDN($base) {
-		$cr = $this->getConnection();
-		if(!$cr) {
-			throw new \Exception('Could not connect to LDAP');
-		}
-
-		//base is there, let's validate it. If we search for anything, we should
-		//get a result set > 0 on a proper base
-		$rr = $this->ldap->search($cr, $base, 'objectClass=*', array('dn'), 0, 1);
-		if(!$this->ldap->isResource($rr)) {
-			$errorNo  = $this->ldap->errno($cr);
-			$errorMsg = $this->ldap->error($cr);
-			\OCP\Util::writeLog('user_ldap', 'Wiz: Could not search base '.$base.
-							' Error '.$errorNo.': '.$errorMsg, \OCP\Util::INFO);
-			return false;
-		}
-		$entries = $this->ldap->countEntries($cr, $rr);
-		return ($entries !== false) && ($entries > 0);
-	}
-
-	/**
-	 * Checks whether the server supports memberOf in LDAP Filter.
-	 * Note: at least in OpenLDAP, availability of memberOf is dependent on
-	 * a configured objectClass. I.e. not necessarily for all available groups
-	 * memberOf does work.
-	 *
-	 * @return bool true if it does, false otherwise
-	 * @throws \Exception
-	 */
-	private function testMemberOf() {
-		$cr = $this->getConnection();
-		if(!$cr) {
-			throw new \Exception('Could not connect to LDAP');
-		}
-		$result = $this->access->countUsers('memberOf=*', array('memberOf'), 1);
-		if(is_int($result) &&  $result > 0) {
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * creates an LDAP Filter from given configuration
-	 * @param integer $filterType int, for which use case the filter shall be created
-	 * can be any of self::LFILTER_USER_LIST, self::LFILTER_LOGIN or
-	 * self::LFILTER_GROUP_LIST
-	 * @return string|false string with the filter on success, false otherwise
-	 * @throws \Exception
-	 */
-	private function composeLdapFilter($filterType) {
-		$filter = '';
-		$parts = 0;
-		switch ($filterType) {
-			case self::LFILTER_USER_LIST:
-				$objcs = $this->configuration->ldapUserFilterObjectclass;
-				//glue objectclasses
-				if(is_array($objcs) && count($objcs) > 0) {
-					$filter .= '(|';
-					foreach($objcs as $objc) {
-						$filter .= '(objectclass=' . $objc . ')';
-					}
-					$filter .= ')';
-					$parts++;
-				}
-				//glue group memberships
-				if($this->configuration->hasMemberOfFilterSupport) {
-					$cns = $this->configuration->ldapUserFilterGroups;
-					if(is_array($cns) && count($cns) > 0) {
-						$filter .= '(|';
-						$cr = $this->getConnection();
-						if(!$cr) {
-							throw new \Exception('Could not connect to LDAP');
-						}
-						$base = $this->configuration->ldapBase[0];
-						foreach($cns as $cn) {
-							$rr = $this->ldap->search($cr, $base, 'cn=' . $cn, array('dn', 'primaryGroupToken'));
-							if(!$this->ldap->isResource($rr)) {
-								continue;
-							}
-							$er = $this->ldap->firstEntry($cr, $rr);
-							$attrs = $this->ldap->getAttributes($cr, $er);
-							$dn = $this->ldap->getDN($cr, $er);
-							if ($dn === false || $dn === '') {
-								continue;
-							}
-							$filterPart = '(memberof=' . $dn . ')';
-							if(isset($attrs['primaryGroupToken'])) {
-								$pgt = $attrs['primaryGroupToken'][0];
-								$primaryFilterPart = '(primaryGroupID=' . $pgt .')';
-								$filterPart = '(|' . $filterPart . $primaryFilterPart . ')';
-							}
-							$filter .= $filterPart;
-						}
-						$filter .= ')';
-					}
-					$parts++;
-				}
-				//wrap parts in AND condition
-				if($parts > 1) {
-					$filter = '(&' . $filter . ')';
-				}
-				if ($filter === '') {
-					$filter = '(objectclass=*)';
-				}
-				break;
-
-			case self::LFILTER_GROUP_LIST:
-				$objcs = $this->configuration->ldapGroupFilterObjectclass;
-				//glue objectclasses
-				if(is_array($objcs) && count($objcs) > 0) {
-					$filter .= '(|';
-					foreach($objcs as $objc) {
-						$filter .= '(objectclass=' . $objc . ')';
-					}
-					$filter .= ')';
-					$parts++;
-				}
-				//glue group memberships
-				$cns = $this->configuration->ldapGroupFilterGroups;
-				if(is_array($cns) && count($cns) > 0) {
-					$filter .= '(|';
-					foreach($cns as $cn) {
-						$filter .= '(cn=' . $cn . ')';
-					}
-					$filter .= ')';
-				}
-				$parts++;
-				//wrap parts in AND condition
-				if($parts > 1) {
-					$filter = '(&' . $filter . ')';
-				}
-				break;
-
-			case self::LFILTER_LOGIN:
-				$ulf = $this->configuration->ldapUserFilter;
-				$loginpart = '=%uid';
-				$filterUsername = '';
-				$userAttributes = $this->getUserAttributes();
-				$userAttributes = array_change_key_case(array_flip($userAttributes));
-				$parts = 0;
-
-				if($this->configuration->ldapLoginFilterUsername === '1') {
-					$attr = '';
-					if(isset($userAttributes['uid'])) {
-						$attr = 'uid';
-					} else if(isset($userAttributes['samaccountname'])) {
-						$attr = 'samaccountname';
-					} else if(isset($userAttributes['cn'])) {
-						//fallback
-						$attr = 'cn';
-					}
-					if ($attr !== '') {
-						$filterUsername = '(' . $attr . $loginpart . ')';
-						$parts++;
-					}
-				}
-
-				$filterEmail = '';
-				if($this->configuration->ldapLoginFilterEmail === '1') {
-					$filterEmail = '(|(mailPrimaryAddress=%uid)(mail=%uid))';
-					$parts++;
-				}
-
-				$filterAttributes = '';
-				$attrsToFilter = $this->configuration->ldapLoginFilterAttributes;
-				if(is_array($attrsToFilter) && count($attrsToFilter) > 0) {
-					$filterAttributes = '(|';
-					foreach($attrsToFilter as $attribute) {
-						$filterAttributes .= '(' . $attribute . $loginpart . ')';
-					}
-					$filterAttributes .= ')';
-					$parts++;
-				}
-
-				$filterLogin = '';
-				if($parts > 1) {
-					$filterLogin = '(|';
-				}
-				$filterLogin .= $filterUsername;
-				$filterLogin .= $filterEmail;
-				$filterLogin .= $filterAttributes;
-				if($parts > 1) {
-					$filterLogin .= ')';
-				}
-
-				$filter = '(&'.$ulf.$filterLogin.')';
-				break;
-		}
-
-		\OCP\Util::writeLog('user_ldap', 'Wiz: Final filter '.$filter, \OCP\Util::DEBUG);
-
-		return $filter;
-	}
-
-	/**
-	 * Connects and Binds to an LDAP Server
-	 *
-	 * @param int $port the port to connect with
-	 * @param bool $tls whether startTLS is to be used
-	 * @return bool
-	 * @throws \Exception
-	 */
-	private function connectAndBind($port, $tls) {
-		//connect, does not really trigger any server communication
-		$host = $this->configuration->ldapHost;
-		$hostInfo = parse_url($host);
-		if(!$hostInfo) {
-			throw new \Exception(self::$l->t('Invalid Host'));
-		}
-		\OCP\Util::writeLog('user_ldap', 'Wiz: Attempting to connect ', \OCP\Util::DEBUG);
-		$cr = $this->ldap->connect($host, $port);
-		if(!is_resource($cr)) {
-			throw new \Exception(self::$l->t('Invalid Host'));
-		}
-
-		//set LDAP options
-		$this->ldap->setOption($cr, LDAP_OPT_PROTOCOL_VERSION, 3);
-		$this->ldap->setOption($cr, LDAP_OPT_REFERRALS, 0);
-		$this->ldap->setOption($cr, LDAP_OPT_NETWORK_TIMEOUT, self::LDAP_NW_TIMEOUT);
-
-		try {
-			if($tls) {
-				$isTlsWorking = @$this->ldap->startTls($cr);
-				if(!$isTlsWorking) {
-					return false;
-				}
-			}
-
-			\OCP\Util::writeLog('user_ldap', 'Wiz: Attemping to Bind ', \OCP\Util::DEBUG);
-			//interesting part: do the bind!
-			$login = $this->ldap->bind($cr,
-				$this->configuration->ldapAgentName,
-				$this->configuration->ldapAgentPassword
-			);
-			$errNo = $this->ldap->errno($cr);
-			$error = ldap_error($cr);
-			$this->ldap->unbind($cr);
-		} catch(ServerNotAvailableException $e) {
-			return false;
-		}
-
-		if($login === true) {
-			$this->ldap->unbind($cr);
-			\OCP\Util::writeLog('user_ldap', 'Wiz: Bind successful to Port '. $port . ' TLS ' . intval($tls), \OCP\Util::DEBUG);
-			return true;
-		}
-
-		if($errNo === -1) {
-			//host, port or TLS wrong
-			return false;
-		}
-		throw new \Exception($error, $errNo);
-	}
-
-	/**
-	 * checks whether a valid combination of agent and password has been
-	 * provided (either two values or nothing for anonymous connect)
-	 * @return bool, true if everything is fine, false otherwise
-	 */
-	private function checkAgentRequirements() {
-		$agent = $this->configuration->ldapAgentName;
-		$pwd = $this->configuration->ldapAgentPassword;
-
-		return
-			($agent !== '' && $pwd !== '')
-			||  ($agent === '' && $pwd === '')
-		;
-	}
-
-	/**
-	 * @param array $reqs
-	 * @return bool
-	 */
-	private function checkRequirements($reqs) {
-		$this->checkAgentRequirements();
-		foreach($reqs as $option) {
-			$value = $this->configuration->$option;
-			if(empty($value)) {
-				return false;
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * does a cumulativeSearch on LDAP to get different values of a
-	 * specified attribute
-	 * @param string[] $filters array, the filters that shall be used in the search
-	 * @param string $attr the attribute of which a list of values shall be returned
-	 * @param int $dnReadLimit the amount of how many DNs should be analyzed.
-	 * The lower, the faster
-	 * @param string $maxF string. if not null, this variable will have the filter that
-	 * yields most result entries
-	 * @return array|false an array with the values on success, false otherwise
-	 */
-	public function cumulativeSearchOnAttribute($filters, $attr, $dnReadLimit = 3, &$maxF = null) {
-		$dnRead = array();
-		$foundItems = array();
-		$maxEntries = 0;
-		if(!is_array($this->configuration->ldapBase)
-		   || !isset($this->configuration->ldapBase[0])) {
-			return false;
-		}
-		$base = $this->configuration->ldapBase[0];
-		$cr = $this->getConnection();
-		if(!$this->ldap->isResource($cr)) {
-			return false;
-		}
-		$lastFilter = null;
-		if(isset($filters[count($filters)-1])) {
-			$lastFilter = $filters[count($filters)-1];
-		}
-		foreach($filters as $filter) {
-			if($lastFilter === $filter && count($foundItems) > 0) {
-				//skip when the filter is a wildcard and results were found
-				continue;
-			}
-			// 20k limit for performance and reason
-			$rr = $this->ldap->search($cr, $base, $filter, array($attr), 0, 20000);
-			if(!$this->ldap->isResource($rr)) {
-				continue;
-			}
-			$entries = $this->ldap->countEntries($cr, $rr);
-			$getEntryFunc = 'firstEntry';
-			if(($entries !== false) && ($entries > 0)) {
-				if(!is_null($maxF) && $entries > $maxEntries) {
-					$maxEntries = $entries;
-					$maxF = $filter;
-				}
-				$dnReadCount = 0;
-				do {
-					$entry = $this->ldap->$getEntryFunc($cr, $rr);
-					$getEntryFunc = 'nextEntry';
-					if(!$this->ldap->isResource($entry)) {
-						continue 2;
-					}
-					$rr = $entry; //will be expected by nextEntry next round
-					$attributes = $this->ldap->getAttributes($cr, $entry);
-					$dn = $this->ldap->getDN($cr, $entry);
-					if($dn === false || in_array($dn, $dnRead)) {
-						continue;
-					}
-					$newItems = array();
-					$state = $this->getAttributeValuesFromEntry($attributes,
-																$attr,
-																$newItems);
-					$dnReadCount++;
-					$foundItems = array_merge($foundItems, $newItems);
-					$this->resultCache[$dn][$attr] = $newItems;
-					$dnRead[] = $dn;
-				} while(($state === self::LRESULT_PROCESSED_SKIP
-						|| $this->ldap->isResource($entry))
-						&& ($dnReadLimit === 0 || $dnReadCount < $dnReadLimit));
-			}
-		}
-
-		return array_unique($foundItems);
-	}
-
-	/**
-	 * determines if and which $attr are available on the LDAP server
-	 * @param string[] $objectclasses the objectclasses to use as search filter
-	 * @param string $attr the attribute to look for
-	 * @param string $dbkey the dbkey of the setting the feature is connected to
-	 * @param string $confkey the confkey counterpart for the $dbkey as used in the
-	 * Configuration class
-	 * @param bool $po whether the objectClass with most result entries
-	 * shall be pre-selected via the result
-	 * @return array|false list of found items.
-	 * @throws \Exception
-	 */
-	private function determineFeature($objectclasses, $attr, $dbkey, $confkey, $po = false) {
-		$cr = $this->getConnection();
-		if(!$cr) {
-			throw new \Exception('Could not connect to LDAP');
-		}
-		$p = 'objectclass=';
-		foreach($objectclasses as $key => $value) {
-			$objectclasses[$key] = $p.$value;
-		}
-		$maxEntryObjC = '';
-
-		//how deep to dig?
-		//When looking for objectclasses, testing few entries is sufficient,
-		$dig = 3;
-
-		$availableFeatures =
-			$this->cumulativeSearchOnAttribute($objectclasses, $attr,
-											   $dig, $maxEntryObjC);
-		if(is_array($availableFeatures)
-		   && count($availableFeatures) > 0) {
-			natcasesort($availableFeatures);
-			//natcasesort keeps indices, but we must get rid of them for proper
-			//sorting in the web UI. Therefore: array_values
-			$this->result->addOptions($dbkey, array_values($availableFeatures));
-		} else {
-			throw new \Exception(self::$l->t('Could not find the desired feature'));
-		}
-
-		$setFeatures = $this->configuration->$confkey;
-		if(is_array($setFeatures) && !empty($setFeatures)) {
-			//something is already configured? pre-select it.
-			$this->result->addChange($dbkey, $setFeatures);
-		} else if ($po && $maxEntryObjC !== '') {
-			//pre-select objectclass with most result entries
-			$maxEntryObjC = str_replace($p, '', $maxEntryObjC);
-			$this->applyFind($dbkey, $maxEntryObjC);
-			$this->result->addChange($dbkey, $maxEntryObjC);
-		}
-
-		return $availableFeatures;
-	}
-
-	/**
-	 * appends a list of values fr
-	 * @param resource $result the return value from ldap_get_attributes
-	 * @param string $attribute the attribute values to look for
-	 * @param array &$known new values will be appended here
-	 * @return int, state on of the class constants LRESULT_PROCESSED_OK,
-	 * LRESULT_PROCESSED_INVALID or LRESULT_PROCESSED_SKIP
-	 */
-	private function getAttributeValuesFromEntry($result, $attribute, &$known) {
-		if(!is_array($result)
-		   || !isset($result['count'])
-		   || !$result['count'] > 0) {
-			return self::LRESULT_PROCESSED_INVALID;
-		}
-
-		// strtolower on all keys for proper comparison
-		$result = \OCP\Util::mb_array_change_key_case($result);
-		$attribute = strtolower($attribute);
-		if(isset($result[$attribute])) {
-			foreach($result[$attribute] as $key => $val) {
-				if($key === 'count') {
-					continue;
-				}
-				if(!in_array($val, $known)) {
-					$known[] = $val;
-				}
-			}
-			return self::LRESULT_PROCESSED_OK;
-		} else {
-			return self::LRESULT_PROCESSED_SKIP;
-		}
-	}
-
-	/**
-	 * @return bool|mixed
-	 */
-	private function getConnection() {
-		if(!is_null($this->cr)) {
-			return $this->cr;
-		}
-
-		$cr = $this->ldap->connect(
-			$this->configuration->ldapHost,
-			$this->configuration->ldapPort
-		);
-
-		$this->ldap->setOption($cr, LDAP_OPT_PROTOCOL_VERSION, 3);
-		$this->ldap->setOption($cr, LDAP_OPT_REFERRALS, 0);
-		$this->ldap->setOption($cr, LDAP_OPT_NETWORK_TIMEOUT, self::LDAP_NW_TIMEOUT);
-		if($this->configuration->ldapTLS === 1) {
-			$this->ldap->startTls($cr);
-		}
-
-		$lo = @$this->ldap->bind($cr,
-								 $this->configuration->ldapAgentName,
-								 $this->configuration->ldapAgentPassword);
-		if($lo === true) {
-			$this->$cr = $cr;
-			return $cr;
-		}
-
-		return false;
-	}
-
-	/**
-	 * @return array
-	 */
-	private function getDefaultLdapPortSettings() {
-		static $settings = array(
-								array('port' => 7636, 'tls' => false),
-								array('port' =>  636, 'tls' => false),
-								array('port' => 7389, 'tls' => true),
-								array('port' =>  389, 'tls' => true),
-								array('port' => 7389, 'tls' => false),
-								array('port' =>  389, 'tls' => false),
-						  );
-		return $settings;
-	}
-
-	/**
-	 * @return array
-	 */
-	private function getPortSettingsToTry() {
-		//389 ← LDAP / Unencrypted or StartTLS
-		//636 ← LDAPS / SSL
-		//7xxx ← UCS. need to be checked first, because both ports may be open
-		$host = $this->configuration->ldapHost;
-		$port = intval($this->configuration->ldapPort);
-		$portSettings = array();
-
-		//In case the port is already provided, we will check this first
-		if($port > 0) {
-			$hostInfo = parse_url($host);
-			if(!(is_array($hostInfo)
-				&& isset($hostInfo['scheme'])
-				&& stripos($hostInfo['scheme'], 'ldaps') !== false)) {
-				$portSettings[] = array('port' => $port, 'tls' => true);
-			}
-			$portSettings[] =array('port' => $port, 'tls' => false);
-		}
-
-		//default ports
-		$portSettings = array_merge($portSettings,
-		                            $this->getDefaultLdapPortSettings());
-
-		return $portSettings;
-	}
+    /** @var \OCP\IL10N */
+    static protected $l;
+    protected $access;
+    protected $cr;
+    protected $configuration;
+    protected $result;
+    protected $resultCache = array();
+
+    const LRESULT_PROCESSED_OK = 2;
+    const LRESULT_PROCESSED_INVALID = 3;
+    const LRESULT_PROCESSED_SKIP = 4;
+
+    const LFILTER_LOGIN      = 2;
+    const LFILTER_USER_LIST  = 3;
+    const LFILTER_GROUP_LIST = 4;
+
+    const LFILTER_MODE_ASSISTED = 2;
+    const LFILTER_MODE_RAW = 1;
+
+    const LDAP_NW_TIMEOUT = 4;
+
+    /**
+     * Constructor
+     * @param Configuration $configuration an instance of Configuration
+     * @param ILDAPWrapper $ldap an instance of ILDAPWrapper
+     * @param Access $access
+     */
+    public function __construct(Configuration $configuration, ILDAPWrapper $ldap, Access $access) {
+        parent::__construct($ldap);
+        $this->configuration = $configuration;
+        if(is_null(Wizard::$l)) {
+            Wizard::$l = \OC::$server->getL10N('user_ldap');
+        }
+        $this->access = $access;
+        $this->result = new WizardResult();
+    }
+
+    public function  __destruct() {
+        if($this->result->hasChanges()) {
+            $this->configuration->saveConfiguration();
+        }
+    }
+
+    /**
+     * counts entries in the LDAP directory
+     *
+     * @param string $filter the LDAP search filter
+     * @param string $type a string being either 'users' or 'groups';
+     * @return bool|int
+     * @throws \Exception
+     */
+    public function countEntries($filter, $type) {
+        $reqs = array('ldapHost', 'ldapPort', 'ldapBase');
+        if($type === 'users') {
+            $reqs[] = 'ldapUserFilter';
+        }
+        if(!$this->checkRequirements($reqs)) {
+            throw new \Exception('Requirements not met', 400);
+        }
+
+        $attr = array('dn'); // default
+        $limit = 1001;
+        if($type === 'groups') {
+            $result =  $this->access->countGroups($filter, $attr, $limit);
+        } else if($type === 'users') {
+            $result = $this->access->countUsers($filter, $attr, $limit);
+        } else if ($type === 'objects') {
+            $result = $this->access->countObjects($limit);
+        } else {
+            throw new \Exception('Internal error: Invalid object type', 500);
+        }
+
+        return $result;
+    }
+
+    /**
+     * formats the return value of a count operation to the string to be
+     * inserted.
+     *
+     * @param bool|int $count
+     * @return int|string
+     */
+    private function formatCountResult($count) {
+        $formatted = ($count !== false) ? $count : 0;
+        if($formatted > 1000) {
+            $formatted = '> 1000';
+        }
+        return $formatted;
+    }
+
+    public function countGroups() {
+        $filter = $this->configuration->ldapGroupFilter;
+
+        if(empty($filter)) {
+            $output = self::$l->n('%s group found', '%s groups found', 0, array(0));
+            $this->result->addChange('ldap_group_count', $output);
+            return $this->result;
+        }
+
+        try {
+            $groupsTotal = $this->formatCountResult($this->countEntries($filter, 'groups'));
+        } catch (\Exception $e) {
+            //400 can be ignored, 500 is forwarded
+            if($e->getCode() === 500) {
+                throw $e;
+            }
+            return false;
+        }
+        $output = self::$l->n('%s group found', '%s groups found', $groupsTotal, array($groupsTotal));
+        $this->result->addChange('ldap_group_count', $output);
+        return $this->result;
+    }
+
+    /**
+     * @return WizardResult
+     * @throws \Exception
+     */
+    public function countUsers() {
+        $filter = $this->access->getFilterForUserCount();
+
+        $usersTotal = $this->formatCountResult($this->countEntries($filter, 'users'));
+        $output = self::$l->n('%s user found', '%s users found', $usersTotal, array($usersTotal));
+        $this->result->addChange('ldap_user_count', $output);
+        return $this->result;
+    }
+
+    /**
+     * counts any objects in the currently set base dn
+     *
+     * @return WizardResult
+     * @throws \Exception
+     */
+    public function countInBaseDN() {
+        // we don't need to provide a filter in this case
+        $total = $this->countEntries(null, 'objects');
+        if($total === false) {
+            throw new \Exception('invalid results received');
+        }
+        $this->result->addChange('ldap_test_base', $total);
+        return $this->result;
+    }
+
+    /**
+     * counts users with a specified attribute
+     * @param string $attr
+     * @param bool $existsCheck
+     * @return int|bool
+     */
+    public function countUsersWithAttribute($attr, $existsCheck = false) {
+        if(!$this->checkRequirements(array('ldapHost',
+                                            'ldapPort',
+                                            'ldapBase',
+                                            'ldapUserFilter',
+                                            ))) {
+            return  false;
+        }
+
+        $filter = $this->access->combineFilterWithAnd(array(
+            $this->configuration->ldapUserFilter,
+            $attr . '=*'
+        ));
+
+        $limit = ($existsCheck === false) ? null : 1;
+
+        return $this->access->countUsers($filter, array('dn'), $limit);
+    }
+
+    /**
+     * detects the display name attribute. If a setting is already present that
+     * returns at least one hit, the detection will be canceled.
+     * @return WizardResult|bool
+     * @throws \Exception
+     */
+    public function detectUserDisplayNameAttribute() {
+        if(!$this->checkRequirements(array('ldapHost',
+                                        'ldapPort',
+                                        'ldapBase',
+                                        'ldapUserFilter',
+                                        ))) {
+            return  false;
+        }
+
+        $attr = $this->configuration->ldapUserDisplayName;
+        if ($attr !== '' && $attr !== 'displayName') {
+            // most likely not the default value with upper case N,
+            // verify it still produces a result
+            $count = (int)$this->countUsersWithAttribute($attr, true);
+            if($count > 0) {
+                //no change, but we sent it back to make sure the user interface
+                //is still correct, even if the ajax call was cancelled meanwhile
+                $this->result->addChange('ldap_display_name', $attr);
+                return $this->result;
+            }
+        }
+
+        // first attribute that has at least one result wins
+        $displayNameAttrs = array('displayname', 'cn');
+        foreach ($displayNameAttrs as $attr) {
+            $count = (int)$this->countUsersWithAttribute($attr, true);
+
+            if($count > 0) {
+                $this->applyFind('ldap_display_name', $attr);
+                return $this->result;
+            }
+        };
+
+        throw new \Exception(self::$l->t('Could not detect user display name attribute. Please specify it yourself in advanced LDAP settings.'));
+    }
+
+    /**
+     * detects the most often used email attribute for users applying to the
+     * user list filter. If a setting is already present that returns at least
+     * one hit, the detection will be canceled.
+     * @return WizardResult|bool
+     */
+    public function detectEmailAttribute() {
+        if(!$this->checkRequirements(array('ldapHost',
+                                            'ldapPort',
+                                            'ldapBase',
+                                            'ldapUserFilter',
+                                            ))) {
+            return  false;
+        }
+
+        $attr = $this->configuration->ldapEmailAttribute;
+        if ($attr !== '') {
+            $count = (int)$this->countUsersWithAttribute($attr, true);
+            if($count > 0) {
+                return false;
+            }
+            $writeLog = true;
+        } else {
+            $writeLog = false;
+        }
+
+        $emailAttributes = array('mail', 'mailPrimaryAddress');
+        $winner = '';
+        $maxUsers = 0;
+        foreach($emailAttributes as $attr) {
+            $count = $this->countUsersWithAttribute($attr);
+            if($count > $maxUsers) {
+                $maxUsers = $count;
+                $winner = $attr;
+            }
+        }
+
+        if($winner !== '') {
+            $this->applyFind('ldap_email_attr', $winner);
+            if($writeLog) {
+                \OCP\Util::writeLog('user_ldap', 'The mail attribute has ' .
+                    'automatically been reset, because the original value ' .
+                    'did not return any results.', \OCP\Util::INFO);
+            }
+        }
+
+        return $this->result;
+    }
+
+    /**
+     * @return WizardResult
+     * @throws \Exception
+     */
+    public function determineAttributes() {
+        if(!$this->checkRequirements(array('ldapHost',
+                                            'ldapPort',
+                                            'ldapBase',
+                                            'ldapUserFilter',
+                                            ))) {
+            return  false;
+        }
+
+        $attributes = $this->getUserAttributes();
+
+        natcasesort($attributes);
+        $attributes = array_values($attributes);
+
+        $this->result->addOptions('ldap_loginfilter_attributes', $attributes);
+
+        $selected = $this->configuration->ldapLoginFilterAttributes;
+        if(is_array($selected) && !empty($selected)) {
+            $this->result->addChange('ldap_loginfilter_attributes', $selected);
+        }
+
+        return $this->result;
+    }
+
+    /**
+     * detects the available LDAP attributes
+     * @return array|false The instance's WizardResult instance
+     * @throws \Exception
+     */
+    private function getUserAttributes() {
+        if(!$this->checkRequirements(array('ldapHost',
+                                            'ldapPort',
+                                            'ldapBase',
+                                            'ldapUserFilter',
+                                            ))) {
+            return  false;
+        }
+        $cr = $this->getConnection();
+        if(!$cr) {
+            throw new \Exception('Could not connect to LDAP');
+        }
+
+        $base = $this->configuration->ldapBase[0];
+        $filter = $this->configuration->ldapUserFilter;
+        $rr = $this->ldap->search($cr, $base, $filter, array(), 1, 1);
+        if(!$this->ldap->isResource($rr)) {
+            return false;
+        }
+        $er = $this->ldap->firstEntry($cr, $rr);
+        $attributes = $this->ldap->getAttributes($cr, $er);
+        $pureAttributes = array();
+        for($i = 0; $i < $attributes['count']; $i++) {
+            $pureAttributes[] = $attributes[$i];
+        }
+
+        return $pureAttributes;
+    }
+
+    /**
+     * detects the available LDAP groups
+     * @return WizardResult|false the instance's WizardResult instance
+     */
+    public function determineGroupsForGroups() {
+        return $this->determineGroups('ldap_groupfilter_groups',
+                                        'ldapGroupFilterGroups',
+                                        false);
+    }
+
+    /**
+     * detects the available LDAP groups
+     * @return WizardResult|false the instance's WizardResult instance
+     */
+    public function determineGroupsForUsers() {
+        return $this->determineGroups('ldap_userfilter_groups',
+                                        'ldapUserFilterGroups');
+    }
+
+    /**
+     * detects the available LDAP groups
+     * @param string $dbKey
+     * @param string $confKey
+     * @param bool $testMemberOf
+     * @return WizardResult|false the instance's WizardResult instance
+     * @throws \Exception
+     */
+    private function determineGroups($dbKey, $confKey, $testMemberOf = true) {
+        if(!$this->checkRequirements(array('ldapHost',
+                                            'ldapPort',
+                                            'ldapBase',
+                                            ))) {
+            return  false;
+        }
+        $cr = $this->getConnection();
+        if(!$cr) {
+            throw new \Exception('Could not connect to LDAP');
+        }
+
+        $this->fetchGroups($dbKey, $confKey);
+
+        if($testMemberOf) {
+            $this->configuration->hasMemberOfFilterSupport = $this->testMemberOf();
+            $this->result->markChange();
+            if(!$this->configuration->hasMemberOfFilterSupport) {
+                throw new \Exception('memberOf is not supported by the server');
+            }
+        }
+
+        return $this->result;
+    }
+
+    /**
+     * fetches all groups from LDAP and adds them to the result object
+     *
+     * @param string $dbKey
+     * @param string $confKey
+     * @return array $groupEntries
+     * @throws \Exception
+     */
+    public function fetchGroups($dbKey, $confKey) {
+        $obclasses = array('posixGroup', 'group', 'zimbraDistributionList', 'groupOfNames', 'groupOfUniqueNames');
+
+        $filterParts = array();
+        foreach($obclasses as $obclass) {
+            $filterParts[] = 'objectclass='.$obclass;
+        }
+        //we filter for everything
+        //- that looks like a group and
+        //- has the group display name set
+        $filter = $this->access->combineFilterWithOr($filterParts);
+        $filter = $this->access->combineFilterWithAnd(array($filter, 'cn=*'));
+
+        $groupNames = array();
+        $groupEntries = array();
+        $limit = 400;
+        $offset = 0;
+        do {
+            // we need to request dn additionally here, otherwise memberOf
+            // detection will fail later
+            $result = $this->access->searchGroups($filter, array('cn', 'dn'), $limit, $offset);
+            foreach($result as $item) {
+                if(!isset($item['cn']) && !is_array($item['cn']) && !isset($item['cn'][0])) {
+                    // just in case - no issue known
+                    continue;
+                }
+                $groupNames[] = $item['cn'][0];
+                $groupEntries[] = $item;
+            }
+            $offset += $limit;
+        } while ($this->access->hasMoreResults());
+
+        if(count($groupNames) > 0) {
+            natsort($groupNames);
+            $this->result->addOptions($dbKey, array_values($groupNames));
+        } else {
+            throw new \Exception(self::$l->t('Could not find the desired feature'));
+        }
+
+        $setFeatures = $this->configuration->$confKey;
+        if(is_array($setFeatures) && !empty($setFeatures)) {
+            //something is already configured? pre-select it.
+            $this->result->addChange($dbKey, $setFeatures);
+        }
+        return $groupEntries;
+    }
+
+    public function determineGroupMemberAssoc() {
+        if(!$this->checkRequirements(array('ldapHost',
+                                            'ldapPort',
+                                            'ldapGroupFilter',
+                                            ))) {
+            return  false;
+        }
+        $attribute = $this->detectGroupMemberAssoc();
+        if($attribute === false) {
+            return false;
+        }
+        $this->configuration->setConfiguration(array('ldapGroupMemberAssocAttr' => $attribute));
+        $this->result->addChange('ldap_group_member_assoc_attribute', $attribute);
+
+        return $this->result;
+    }
+
+    /**
+     * Detects the available object classes
+     * @return WizardResult|false the instance's WizardResult instance
+     * @throws \Exception
+     */
+    public function determineGroupObjectClasses() {
+        if(!$this->checkRequirements(array('ldapHost',
+                                            'ldapPort',
+                                            'ldapBase',
+                                            ))) {
+            return  false;
+        }
+        $cr = $this->getConnection();
+        if(!$cr) {
+            throw new \Exception('Could not connect to LDAP');
+        }
+
+        $obclasses = array('groupOfNames', 'groupOfUniqueNames', 'group', 'posixGroup', '*');
+        $this->determineFeature($obclasses,
+                                'objectclass',
+                                'ldap_groupfilter_objectclass',
+                                'ldapGroupFilterObjectclass',
+                                false);
+
+        return $this->result;
+    }
+
+    /**
+     * detects the available object classes
+     * @return WizardResult
+     * @throws \Exception
+     */
+    public function determineUserObjectClasses() {
+        if(!$this->checkRequirements(array('ldapHost',
+                                            'ldapPort',
+                                            'ldapBase',
+                                            ))) {
+            return  false;
+        }
+        $cr = $this->getConnection();
+        if(!$cr) {
+            throw new \Exception('Could not connect to LDAP');
+        }
+
+        $obclasses = array('inetOrgPerson', 'person', 'organizationalPerson',
+                            'user', 'posixAccount', '*');
+        $filter = $this->configuration->ldapUserFilter;
+        //if filter is empty, it is probably the first time the wizard is called
+        //then, apply suggestions.
+        $this->determineFeature($obclasses,
+                                'objectclass',
+                                'ldap_userfilter_objectclass',
+                                'ldapUserFilterObjectclass',
+                                empty($filter));
+
+        return $this->result;
+    }
+
+    /**
+     * @return WizardResult|false
+     * @throws \Exception
+     */
+    public function getGroupFilter() {
+        if(!$this->checkRequirements(array('ldapHost',
+                                            'ldapPort',
+                                            'ldapBase',
+                                            ))) {
+            return false;
+        }
+        //make sure the use display name is set
+        $displayName = $this->configuration->ldapGroupDisplayName;
+        if ($displayName === '') {
+            $d = $this->configuration->getDefaults();
+            $this->applyFind('ldap_group_display_name',
+                                $d['ldap_group_display_name']);
+        }
+        $filter = $this->composeLdapFilter(self::LFILTER_GROUP_LIST);
+
+        $this->applyFind('ldap_group_filter', $filter);
+        return $this->result;
+    }
+
+    /**
+     * @return WizardResult|false
+     * @throws \Exception
+     */
+    public function getUserListFilter() {
+        if(!$this->checkRequirements(array('ldapHost',
+                                            'ldapPort',
+                                            'ldapBase',
+                                            ))) {
+            return false;
+        }
+        //make sure the use display name is set
+        $displayName = $this->configuration->ldapUserDisplayName;
+        if ($displayName === '') {
+            $d = $this->configuration->getDefaults();
+            $this->applyFind('ldap_display_name', $d['ldap_display_name']);
+        }
+        $filter = $this->composeLdapFilter(self::LFILTER_USER_LIST);
+        if(!$filter) {
+            throw new \Exception('Cannot create filter');
+        }
+
+        $this->applyFind('ldap_userlist_filter', $filter);
+        return $this->result;
+    }
+
+    /**
+     * @return bool|WizardResult
+     * @throws \Exception
+     */
+    public function getUserLoginFilter() {
+        if(!$this->checkRequirements(array('ldapHost',
+                                            'ldapPort',
+                                            'ldapBase',
+                                            'ldapUserFilter',
+                                            ))) {
+            return false;
+        }
+
+        $filter = $this->composeLdapFilter(self::LFILTER_LOGIN);
+        if(!$filter) {
+            throw new \Exception('Cannot create filter');
+        }
+
+        $this->applyFind('ldap_login_filter', $filter);
+        return $this->result;
+    }
+
+    /**
+     * @return bool|WizardResult
+     * @param string $loginName
+     * @throws \Exception
+     */
+    public function testLoginName($loginName) {
+        if(!$this->checkRequirements(array('ldapHost',
+            'ldapPort',
+            'ldapBase',
+            'ldapLoginFilter',
+        ))) {
+            return false;
+        }
+
+        $cr = $this->access->connection->getConnectionResource();
+        if(!$this->ldap->isResource($cr)) {
+            throw new \Exception('connection error');
+        }
+
+        if(mb_strpos($this->access->connection->ldapLoginFilter, '%uid', 0, 'UTF-8')
+            === false) {
+            throw new \Exception('missing placeholder');
+        }
+
+        $users = $this->access->countUsersByLoginName($loginName);
+        if($this->ldap->errno($cr) !== 0) {
+            throw new \Exception($this->ldap->error($cr));
+        }
+        $filter = str_replace('%uid', $loginName, $this->access->connection->ldapLoginFilter);
+        $this->result->addChange('ldap_test_loginname', $users);
+        $this->result->addChange('ldap_test_effective_filter', $filter);
+        return $this->result;
+    }
+
+    /**
+     * Tries to determine the port, requires given Host, User DN and Password
+     * @return WizardResult|false WizardResult on success, false otherwise
+     * @throws \Exception
+     */
+    public function guessPortAndTLS() {
+        if(!$this->checkRequirements(array('ldapHost',
+                                            ))) {
+            return false;
+        }
+        $this->checkHost();
+        $portSettings = $this->getPortSettingsToTry();
+
+        if(!is_array($portSettings)) {
+            throw new \Exception(print_r($portSettings, true));
+        }
+
+        //proceed from the best configuration and return on first success
+        foreach($portSettings as $setting) {
+            $p = $setting['port'];
+            $t = $setting['tls'];
+            \OCP\Util::writeLog('user_ldap', 'Wiz: trying port '. $p . ', TLS '. $t, \OCP\Util::DEBUG);
+            //connectAndBind may throw Exception, it needs to be catched by the
+            //callee of this method
+
+            try {
+                $settingsFound = $this->connectAndBind($p, $t);
+            } catch (\Exception $e) {
+                // any reply other than -1 (= cannot connect) is already okay,
+                // because then we found the server
+                // unavailable startTLS returns -11
+                if($e->getCode() > 0) {
+                    $settingsFound = true;
+                } else {
+                    throw $e;
+                }
+            }
+
+            if ($settingsFound === true) {
+                $config = array(
+                    'ldapPort' => $p,
+                    'ldapTLS' => intval($t)
+                );
+                $this->configuration->setConfiguration($config);
+                \OCP\Util::writeLog('user_ldap', 'Wiz: detected Port ' . $p, \OCP\Util::DEBUG);
+                $this->result->addChange('ldap_port', $p);
+                return $this->result;
+            }
+        }
+
+        //custom port, undetected (we do not brute force)
+        return false;
+    }
+
+    /**
+     * tries to determine a base dn from User DN or LDAP Host
+     * @return WizardResult|false WizardResult on success, false otherwise
+     */
+    public function guessBaseDN() {
+        if(!$this->checkRequirements(array('ldapHost',
+                                            'ldapPort',
+                                            ))) {
+            return false;
+        }
+
+        //check whether a DN is given in the agent name (99.9% of all cases)
+        $base = null;
+        $i = stripos($this->configuration->ldapAgentName, 'dc=');
+        if($i !== false) {
+            $base = substr($this->configuration->ldapAgentName, $i);
+            if($this->testBaseDN($base)) {
+                $this->applyFind('ldap_base', $base);
+                return $this->result;
+            }
+        }
+
+        //this did not help :(
+        //Let's see whether we can parse the Host URL and convert the domain to
+        //a base DN
+        $helper = new Helper(\OC::$server->getConfig());
+        $domain = $helper->getDomainFromURL($this->configuration->ldapHost);
+        if(!$domain) {
+            return false;
+        }
+
+        $dparts = explode('.', $domain);
+        while(count($dparts) > 0) {
+            $base2 = 'dc=' . implode(',dc=', $dparts);
+            if ($base !== $base2 && $this->testBaseDN($base2)) {
+                $this->applyFind('ldap_base', $base2);
+                return $this->result;
+            }
+            array_shift($dparts);
+        }
+
+        return false;
+    }
+
+    /**
+     * sets the found value for the configuration key in the WizardResult
+     * as well as in the Configuration instance
+     * @param string $key the configuration key
+     * @param string $value the (detected) value
+     *
+     */
+    private function applyFind($key, $value) {
+        $this->result->addChange($key, $value);
+        $this->configuration->setConfiguration(array($key => $value));
+    }
+
+    /**
+     * Checks, whether a port was entered in the Host configuration
+     * field. In this case the port will be stripped off, but also stored as
+     * setting.
+     */
+    private function checkHost() {
+        $host = $this->configuration->ldapHost;
+        $hostInfo = parse_url($host);
+
+        //removes Port from Host
+        if(is_array($hostInfo) && isset($hostInfo['port'])) {
+            $port = $hostInfo['port'];
+            $host = str_replace(':'.$port, '', $host);
+            $this->applyFind('ldap_host', $host);
+            $this->applyFind('ldap_port', $port);
+        }
+    }
+
+    /**
+     * tries to detect the group member association attribute which is
+     * one of 'uniqueMember', 'memberUid', 'member', 'gidNumber'
+     * @return string|false, string with the attribute name, false on error
+     * @throws \Exception
+     */
+    private function detectGroupMemberAssoc() {
+        $possibleAttrs = array('uniqueMember', 'memberUid', 'member', 'gidNumber');
+        $filter = $this->configuration->ldapGroupFilter;
+        if(empty($filter)) {
+            return false;
+        }
+        $cr = $this->getConnection();
+        if(!$cr) {
+            throw new \Exception('Could not connect to LDAP');
+        }
+        $base = $this->configuration->ldapBase[0];
+        $rr = $this->ldap->search($cr, $base, $filter, $possibleAttrs, 0, 1000);
+        if(!$this->ldap->isResource($rr)) {
+            return false;
+        }
+        $er = $this->ldap->firstEntry($cr, $rr);
+        while(is_resource($er)) {
+            $this->ldap->getDN($cr, $er);
+            $attrs = $this->ldap->getAttributes($cr, $er);
+            $result = array();
+            $possibleAttrsCount = count($possibleAttrs);
+            for($i = 0; $i < $possibleAttrsCount; $i++) {
+                if(isset($attrs[$possibleAttrs[$i]])) {
+                    $result[$possibleAttrs[$i]] = $attrs[$possibleAttrs[$i]]['count'];
+                }
+            }
+            if(!empty($result)) {
+                natsort($result);
+                return key($result);
+            }
+
+            $er = $this->ldap->nextEntry($cr, $er);
+        }
+
+        return false;
+    }
+
+    /**
+     * Checks whether for a given BaseDN results will be returned
+     * @param string $base the BaseDN to test
+     * @return bool true on success, false otherwise
+     * @throws \Exception
+     */
+    private function testBaseDN($base) {
+        $cr = $this->getConnection();
+        if(!$cr) {
+            throw new \Exception('Could not connect to LDAP');
+        }
+
+        //base is there, let's validate it. If we search for anything, we should
+        //get a result set > 0 on a proper base
+        $rr = $this->ldap->search($cr, $base, 'objectClass=*', array('dn'), 0, 1);
+        if(!$this->ldap->isResource($rr)) {
+            $errorNo  = $this->ldap->errno($cr);
+            $errorMsg = $this->ldap->error($cr);
+            \OCP\Util::writeLog('user_ldap', 'Wiz: Could not search base '.$base.
+                            ' Error '.$errorNo.': '.$errorMsg, \OCP\Util::INFO);
+            return false;
+        }
+        $entries = $this->ldap->countEntries($cr, $rr);
+        return ($entries !== false) && ($entries > 0);
+    }
+
+    /**
+     * Checks whether the server supports memberOf in LDAP Filter.
+     * Note: at least in OpenLDAP, availability of memberOf is dependent on
+     * a configured objectClass. I.e. not necessarily for all available groups
+     * memberOf does work.
+     *
+     * @return bool true if it does, false otherwise
+     * @throws \Exception
+     */
+    private function testMemberOf() {
+        $cr = $this->getConnection();
+        if(!$cr) {
+            throw new \Exception('Could not connect to LDAP');
+        }
+        $result = $this->access->countUsers('memberOf=*', array('memberOf'), 1);
+        if(is_int($result) &&  $result > 0) {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * creates an LDAP Filter from given configuration
+     * @param integer $filterType int, for which use case the filter shall be created
+     * can be any of self::LFILTER_USER_LIST, self::LFILTER_LOGIN or
+     * self::LFILTER_GROUP_LIST
+     * @return string|false string with the filter on success, false otherwise
+     * @throws \Exception
+     */
+    private function composeLdapFilter($filterType) {
+        $filter = '';
+        $parts = 0;
+        switch ($filterType) {
+            case self::LFILTER_USER_LIST:
+                $objcs = $this->configuration->ldapUserFilterObjectclass;
+                //glue objectclasses
+                if(is_array($objcs) && count($objcs) > 0) {
+                    $filter .= '(|';
+                    foreach($objcs as $objc) {
+                        $filter .= '(objectclass=' . $objc . ')';
+                    }
+                    $filter .= ')';
+                    $parts++;
+                }
+                //glue group memberships
+                if($this->configuration->hasMemberOfFilterSupport) {
+                    $cns = $this->configuration->ldapUserFilterGroups;
+                    if(is_array($cns) && count($cns) > 0) {
+                        $filter .= '(|';
+                        $cr = $this->getConnection();
+                        if(!$cr) {
+                            throw new \Exception('Could not connect to LDAP');
+                        }
+                        $base = $this->configuration->ldapBase[0];
+                        foreach($cns as $cn) {
+                            $rr = $this->ldap->search($cr, $base, 'cn=' . $cn, array('dn', 'primaryGroupToken'));
+                            if(!$this->ldap->isResource($rr)) {
+                                continue;
+                            }
+                            $er = $this->ldap->firstEntry($cr, $rr);
+                            $attrs = $this->ldap->getAttributes($cr, $er);
+                            $dn = $this->ldap->getDN($cr, $er);
+                            if ($dn === false || $dn === '') {
+                                continue;
+                            }
+                            $filterPart = '(memberof=' . $dn . ')';
+                            if(isset($attrs['primaryGroupToken'])) {
+                                $pgt = $attrs['primaryGroupToken'][0];
+                                $primaryFilterPart = '(primaryGroupID=' . $pgt .')';
+                                $filterPart = '(|' . $filterPart . $primaryFilterPart . ')';
+                            }
+                            $filter .= $filterPart;
+                        }
+                        $filter .= ')';
+                    }
+                    $parts++;
+                }
+                //wrap parts in AND condition
+                if($parts > 1) {
+                    $filter = '(&' . $filter . ')';
+                }
+                if ($filter === '') {
+                    $filter = '(objectclass=*)';
+                }
+                break;
+
+            case self::LFILTER_GROUP_LIST:
+                $objcs = $this->configuration->ldapGroupFilterObjectclass;
+                //glue objectclasses
+                if(is_array($objcs) && count($objcs) > 0) {
+                    $filter .= '(|';
+                    foreach($objcs as $objc) {
+                        $filter .= '(objectclass=' . $objc . ')';
+                    }
+                    $filter .= ')';
+                    $parts++;
+                }
+                //glue group memberships
+                $cns = $this->configuration->ldapGroupFilterGroups;
+                if(is_array($cns) && count($cns) > 0) {
+                    $filter .= '(|';
+                    foreach($cns as $cn) {
+                        $filter .= '(cn=' . $cn . ')';
+                    }
+                    $filter .= ')';
+                }
+                $parts++;
+                //wrap parts in AND condition
+                if($parts > 1) {
+                    $filter = '(&' . $filter . ')';
+                }
+                break;
+
+            case self::LFILTER_LOGIN:
+                $ulf = $this->configuration->ldapUserFilter;
+                $loginpart = '=%uid';
+                $filterUsername = '';
+                $userAttributes = $this->getUserAttributes();
+                $userAttributes = array_change_key_case(array_flip($userAttributes));
+                $parts = 0;
+
+                if($this->configuration->ldapLoginFilterUsername === '1') {
+                    $attr = '';
+                    if(isset($userAttributes['uid'])) {
+                        $attr = 'uid';
+                    } else if(isset($userAttributes['samaccountname'])) {
+                        $attr = 'samaccountname';
+                    } else if(isset($userAttributes['cn'])) {
+                        //fallback
+                        $attr = 'cn';
+                    }
+                    if ($attr !== '') {
+                        $filterUsername = '(' . $attr . $loginpart . ')';
+                        $parts++;
+                    }
+                }
+
+                $filterEmail = '';
+                if($this->configuration->ldapLoginFilterEmail === '1') {
+                    $filterEmail = '(|(mailPrimaryAddress=%uid)(mail=%uid))';
+                    $parts++;
+                }
+
+                $filterAttributes = '';
+                $attrsToFilter = $this->configuration->ldapLoginFilterAttributes;
+                if(is_array($attrsToFilter) && count($attrsToFilter) > 0) {
+                    $filterAttributes = '(|';
+                    foreach($attrsToFilter as $attribute) {
+                        $filterAttributes .= '(' . $attribute . $loginpart . ')';
+                    }
+                    $filterAttributes .= ')';
+                    $parts++;
+                }
+
+                $filterLogin = '';
+                if($parts > 1) {
+                    $filterLogin = '(|';
+                }
+                $filterLogin .= $filterUsername;
+                $filterLogin .= $filterEmail;
+                $filterLogin .= $filterAttributes;
+                if($parts > 1) {
+                    $filterLogin .= ')';
+                }
+
+                $filter = '(&'.$ulf.$filterLogin.')';
+                break;
+        }
+
+        \OCP\Util::writeLog('user_ldap', 'Wiz: Final filter '.$filter, \OCP\Util::DEBUG);
+
+        return $filter;
+    }
+
+    /**
+     * Connects and Binds to an LDAP Server
+     *
+     * @param int $port the port to connect with
+     * @param bool $tls whether startTLS is to be used
+     * @return bool
+     * @throws \Exception
+     */
+    private function connectAndBind($port, $tls) {
+        //connect, does not really trigger any server communication
+        $host = $this->configuration->ldapHost;
+        $hostInfo = parse_url($host);
+        if(!$hostInfo) {
+            throw new \Exception(self::$l->t('Invalid Host'));
+        }
+        \OCP\Util::writeLog('user_ldap', 'Wiz: Attempting to connect ', \OCP\Util::DEBUG);
+        $cr = $this->ldap->connect($host, $port);
+        if(!is_resource($cr)) {
+            throw new \Exception(self::$l->t('Invalid Host'));
+        }
+
+        //set LDAP options
+        $this->ldap->setOption($cr, LDAP_OPT_PROTOCOL_VERSION, 3);
+        $this->ldap->setOption($cr, LDAP_OPT_REFERRALS, 0);
+        $this->ldap->setOption($cr, LDAP_OPT_NETWORK_TIMEOUT, self::LDAP_NW_TIMEOUT);
+
+        try {
+            if($tls) {
+                $isTlsWorking = @$this->ldap->startTls($cr);
+                if(!$isTlsWorking) {
+                    return false;
+                }
+            }
+
+            \OCP\Util::writeLog('user_ldap', 'Wiz: Attemping to Bind ', \OCP\Util::DEBUG);
+            //interesting part: do the bind!
+            $login = $this->ldap->bind($cr,
+                $this->configuration->ldapAgentName,
+                $this->configuration->ldapAgentPassword
+            );
+            $errNo = $this->ldap->errno($cr);
+            $error = ldap_error($cr);
+            $this->ldap->unbind($cr);
+        } catch(ServerNotAvailableException $e) {
+            return false;
+        }
+
+        if($login === true) {
+            $this->ldap->unbind($cr);
+            \OCP\Util::writeLog('user_ldap', 'Wiz: Bind successful to Port '. $port . ' TLS ' . intval($tls), \OCP\Util::DEBUG);
+            return true;
+        }
+
+        if($errNo === -1) {
+            //host, port or TLS wrong
+            return false;
+        }
+        throw new \Exception($error, $errNo);
+    }
+
+    /**
+     * checks whether a valid combination of agent and password has been
+     * provided (either two values or nothing for anonymous connect)
+     * @return bool, true if everything is fine, false otherwise
+     */
+    private function checkAgentRequirements() {
+        $agent = $this->configuration->ldapAgentName;
+        $pwd = $this->configuration->ldapAgentPassword;
+
+        return
+            ($agent !== '' && $pwd !== '')
+            ||  ($agent === '' && $pwd === '')
+        ;
+    }
+
+    /**
+     * @param array $reqs
+     * @return bool
+     */
+    private function checkRequirements($reqs) {
+        $this->checkAgentRequirements();
+        foreach($reqs as $option) {
+            $value = $this->configuration->$option;
+            if(empty($value)) {
+                return false;
+            }
+        }
+        return true;
+    }
+
+    /**
+     * does a cumulativeSearch on LDAP to get different values of a
+     * specified attribute
+     * @param string[] $filters array, the filters that shall be used in the search
+     * @param string $attr the attribute of which a list of values shall be returned
+     * @param int $dnReadLimit the amount of how many DNs should be analyzed.
+     * The lower, the faster
+     * @param string $maxF string. if not null, this variable will have the filter that
+     * yields most result entries
+     * @return array|false an array with the values on success, false otherwise
+     */
+    public function cumulativeSearchOnAttribute($filters, $attr, $dnReadLimit = 3, &$maxF = null) {
+        $dnRead = array();
+        $foundItems = array();
+        $maxEntries = 0;
+        if(!is_array($this->configuration->ldapBase)
+           || !isset($this->configuration->ldapBase[0])) {
+            return false;
+        }
+        $base = $this->configuration->ldapBase[0];
+        $cr = $this->getConnection();
+        if(!$this->ldap->isResource($cr)) {
+            return false;
+        }
+        $lastFilter = null;
+        if(isset($filters[count($filters)-1])) {
+            $lastFilter = $filters[count($filters)-1];
+        }
+        foreach($filters as $filter) {
+            if($lastFilter === $filter && count($foundItems) > 0) {
+                //skip when the filter is a wildcard and results were found
+                continue;
+            }
+            // 20k limit for performance and reason
+            $rr = $this->ldap->search($cr, $base, $filter, array($attr), 0, 20000);
+            if(!$this->ldap->isResource($rr)) {
+                continue;
+            }
+            $entries = $this->ldap->countEntries($cr, $rr);
+            $getEntryFunc = 'firstEntry';
+            if(($entries !== false) && ($entries > 0)) {
+                if(!is_null($maxF) && $entries > $maxEntries) {
+                    $maxEntries = $entries;
+                    $maxF = $filter;
+                }
+                $dnReadCount = 0;
+                do {
+                    $entry = $this->ldap->$getEntryFunc($cr, $rr);
+                    $getEntryFunc = 'nextEntry';
+                    if(!$this->ldap->isResource($entry)) {
+                        continue 2;
+                    }
+                    $rr = $entry; //will be expected by nextEntry next round
+                    $attributes = $this->ldap->getAttributes($cr, $entry);
+                    $dn = $this->ldap->getDN($cr, $entry);
+                    if($dn === false || in_array($dn, $dnRead)) {
+                        continue;
+                    }
+                    $newItems = array();
+                    $state = $this->getAttributeValuesFromEntry($attributes,
+                                                                $attr,
+                                                                $newItems);
+                    $dnReadCount++;
+                    $foundItems = array_merge($foundItems, $newItems);
+                    $this->resultCache[$dn][$attr] = $newItems;
+                    $dnRead[] = $dn;
+                } while(($state === self::LRESULT_PROCESSED_SKIP
+                        || $this->ldap->isResource($entry))
+                        && ($dnReadLimit === 0 || $dnReadCount < $dnReadLimit));
+            }
+        }
+
+        return array_unique($foundItems);
+    }
+
+    /**
+     * determines if and which $attr are available on the LDAP server
+     * @param string[] $objectclasses the objectclasses to use as search filter
+     * @param string $attr the attribute to look for
+     * @param string $dbkey the dbkey of the setting the feature is connected to
+     * @param string $confkey the confkey counterpart for the $dbkey as used in the
+     * Configuration class
+     * @param bool $po whether the objectClass with most result entries
+     * shall be pre-selected via the result
+     * @return array|false list of found items.
+     * @throws \Exception
+     */
+    private function determineFeature($objectclasses, $attr, $dbkey, $confkey, $po = false) {
+        $cr = $this->getConnection();
+        if(!$cr) {
+            throw new \Exception('Could not connect to LDAP');
+        }
+        $p = 'objectclass=';
+        foreach($objectclasses as $key => $value) {
+            $objectclasses[$key] = $p.$value;
+        }
+        $maxEntryObjC = '';
+
+        //how deep to dig?
+        //When looking for objectclasses, testing few entries is sufficient,
+        $dig = 3;
+
+        $availableFeatures =
+            $this->cumulativeSearchOnAttribute($objectclasses, $attr,
+                                                $dig, $maxEntryObjC);
+        if(is_array($availableFeatures)
+           && count($availableFeatures) > 0) {
+            natcasesort($availableFeatures);
+            //natcasesort keeps indices, but we must get rid of them for proper
+            //sorting in the web UI. Therefore: array_values
+            $this->result->addOptions($dbkey, array_values($availableFeatures));
+        } else {
+            throw new \Exception(self::$l->t('Could not find the desired feature'));
+        }
+
+        $setFeatures = $this->configuration->$confkey;
+        if(is_array($setFeatures) && !empty($setFeatures)) {
+            //something is already configured? pre-select it.
+            $this->result->addChange($dbkey, $setFeatures);
+        } else if ($po && $maxEntryObjC !== '') {
+            //pre-select objectclass with most result entries
+            $maxEntryObjC = str_replace($p, '', $maxEntryObjC);
+            $this->applyFind($dbkey, $maxEntryObjC);
+            $this->result->addChange($dbkey, $maxEntryObjC);
+        }
+
+        return $availableFeatures;
+    }
+
+    /**
+     * appends a list of values fr
+     * @param resource $result the return value from ldap_get_attributes
+     * @param string $attribute the attribute values to look for
+     * @param array &$known new values will be appended here
+     * @return int, state on of the class constants LRESULT_PROCESSED_OK,
+     * LRESULT_PROCESSED_INVALID or LRESULT_PROCESSED_SKIP
+     */
+    private function getAttributeValuesFromEntry($result, $attribute, &$known) {
+        if(!is_array($result)
+           || !isset($result['count'])
+           || !$result['count'] > 0) {
+            return self::LRESULT_PROCESSED_INVALID;
+        }
+
+        // strtolower on all keys for proper comparison
+        $result = \OCP\Util::mb_array_change_key_case($result);
+        $attribute = strtolower($attribute);
+        if(isset($result[$attribute])) {
+            foreach($result[$attribute] as $key => $val) {
+                if($key === 'count') {
+                    continue;
+                }
+                if(!in_array($val, $known)) {
+                    $known[] = $val;
+                }
+            }
+            return self::LRESULT_PROCESSED_OK;
+        } else {
+            return self::LRESULT_PROCESSED_SKIP;
+        }
+    }
+
+    /**
+     * @return bool|mixed
+     */
+    private function getConnection() {
+        if(!is_null($this->cr)) {
+            return $this->cr;
+        }
+
+        $cr = $this->ldap->connect(
+            $this->configuration->ldapHost,
+            $this->configuration->ldapPort
+        );
+
+        $this->ldap->setOption($cr, LDAP_OPT_PROTOCOL_VERSION, 3);
+        $this->ldap->setOption($cr, LDAP_OPT_REFERRALS, 0);
+        $this->ldap->setOption($cr, LDAP_OPT_NETWORK_TIMEOUT, self::LDAP_NW_TIMEOUT);
+        if($this->configuration->ldapTLS === 1) {
+            $this->ldap->startTls($cr);
+        }
+
+        $lo = @$this->ldap->bind($cr,
+                                    $this->configuration->ldapAgentName,
+                                    $this->configuration->ldapAgentPassword);
+        if($lo === true) {
+            $this->$cr = $cr;
+            return $cr;
+        }
+
+        return false;
+    }
+
+    /**
+     * @return array
+     */
+    private function getDefaultLdapPortSettings() {
+        static $settings = array(
+                                array('port' => 7636, 'tls' => false),
+                                array('port' =>  636, 'tls' => false),
+                                array('port' => 7389, 'tls' => true),
+                                array('port' =>  389, 'tls' => true),
+                                array('port' => 7389, 'tls' => false),
+                                array('port' =>  389, 'tls' => false),
+                            );
+        return $settings;
+    }
+
+    /**
+     * @return array
+     */
+    private function getPortSettingsToTry() {
+        //389 ← LDAP / Unencrypted or StartTLS
+        //636 ← LDAPS / SSL
+        //7xxx ← UCS. need to be checked first, because both ports may be open
+        $host = $this->configuration->ldapHost;
+        $port = intval($this->configuration->ldapPort);
+        $portSettings = array();
+
+        //In case the port is already provided, we will check this first
+        if($port > 0) {
+            $hostInfo = parse_url($host);
+            if(!(is_array($hostInfo)
+                && isset($hostInfo['scheme'])
+                && stripos($hostInfo['scheme'], 'ldaps') !== false)) {
+                $portSettings[] = array('port' => $port, 'tls' => true);
+            }
+            $portSettings[] =array('port' => $port, 'tls' => false);
+        }
+
+        //default ports
+        $portSettings = array_merge($portSettings,
+                                    $this->getDefaultLdapPortSettings());
+
+        return $portSettings;
+    }
 
 
 }

Spacing +152 added lines, -152 removed lines

@@ -71,7 +71,7 @@ 
 	public function __construct(Configuration $configuration, ILDAPWrapper $ldap, Access $access) {
 		parent::__construct($ldap);
 		$this->configuration = $configuration;
-		if(is_null(Wizard::$l)) {
+		if (is_null(Wizard::$l)) {
 			Wizard::$l = \OC::$server->getL10N('user_ldap');
 		}
 		$this->access = $access;
@@ -79,7 +79,7 @@ 
 	}
 
 	public function  __destruct() {
-		if($this->result->hasChanges()) {
+		if ($this->result->hasChanges()) {
 			$this->configuration->saveConfiguration();
 		}
 	}
@@ -94,18 +94,18 @@ 
 	 */
 	public function countEntries($filter, $type) {
 		$reqs = array('ldapHost', 'ldapPort', 'ldapBase');
-		if($type === 'users') {
+		if ($type === 'users') {
 			$reqs[] = 'ldapUserFilter';
 		}
-		if(!$this->checkRequirements($reqs)) {
+		if (!$this->checkRequirements($reqs)) {
 			throw new \Exception('Requirements not met', 400);
 		}
 
 		$attr = array('dn'); // default
 		$limit = 1001;
-		if($type === 'groups') {
-			$result =  $this->access->countGroups($filter, $attr, $limit);
-		} else if($type === 'users') {
+		if ($type === 'groups') {
+			$result = $this->access->countGroups($filter, $attr, $limit);
+		} else if ($type === 'users') {
 			$result = $this->access->countUsers($filter, $attr, $limit);
 		} else if ($type === 'objects') {
 			$result = $this->access->countObjects($limit);
@@ -125,7 +125,7 @@ 
 	 */
 	private function formatCountResult($count) {
 		$formatted = ($count !== false) ? $count : 0;
-		if($formatted > 1000) {
+		if ($formatted > 1000) {
 			$formatted = '> 1000';
 		}
 		return $formatted;
@@ -134,7 +134,7 @@ 
 	public function countGroups() {
 		$filter = $this->configuration->ldapGroupFilter;
 
-		if(empty($filter)) {
+		if (empty($filter)) {
 			$output = self::$l->n('%s group found', '%s groups found', 0, array(0));
 			$this->result->addChange('ldap_group_count', $output);
 			return $this->result;
@@ -144,7 +144,7 @@ 
 			$groupsTotal = $this->formatCountResult($this->countEntries($filter, 'groups'));
 		} catch (\Exception $e) {
 			//400 can be ignored, 500 is forwarded
-			if($e->getCode() === 500) {
+			if ($e->getCode() === 500) {
 				throw $e;
 			}
 			return false;
@@ -176,7 +176,7 @@ 
 	public function countInBaseDN() {
 		// we don't need to provide a filter in this case
 		$total = $this->countEntries(null, 'objects');
-		if($total === false) {
+		if ($total === false) {
 			throw new \Exception('invalid results received');
 		}
 		$this->result->addChange('ldap_test_base', $total);
@@ -190,7 +190,7 @@ 
 	 * @return int|bool
 	 */
 	public function countUsersWithAttribute($attr, $existsCheck = false) {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										   'ldapPort',
 										   'ldapBase',
 										   'ldapUserFilter',
@@ -200,7 +200,7 @@ 
 
 		$filter = $this->access->combineFilterWithAnd(array(
 			$this->configuration->ldapUserFilter,
-			$attr . '=*'
+			$attr.'=*'
 		));
 
 		$limit = ($existsCheck === false) ? null : 1;
@@ -215,7 +215,7 @@ 
 	 * @throws \Exception
 	 */
 	public function detectUserDisplayNameAttribute() {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										'ldapPort',
 										'ldapBase',
 										'ldapUserFilter',
@@ -227,8 +227,8 @@ 
 		if ($attr !== '' && $attr !== 'displayName') {
 			// most likely not the default value with upper case N,
 			// verify it still produces a result
-			$count = (int)$this->countUsersWithAttribute($attr, true);
-			if($count > 0) {
+			$count = (int) $this->countUsersWithAttribute($attr, true);
+			if ($count > 0) {
 				//no change, but we sent it back to make sure the user interface
 				//is still correct, even if the ajax call was cancelled meanwhile
 				$this->result->addChange('ldap_display_name', $attr);
@@ -239,9 +239,9 @@ 
 		// first attribute that has at least one result wins
 		$displayNameAttrs = array('displayname', 'cn');
 		foreach ($displayNameAttrs as $attr) {
-			$count = (int)$this->countUsersWithAttribute($attr, true);
+			$count = (int) $this->countUsersWithAttribute($attr, true);
 
-			if($count > 0) {
+			if ($count > 0) {
 				$this->applyFind('ldap_display_name', $attr);
 				return $this->result;
 			}
@@ -257,7 +257,7 @@ 
 	 * @return WizardResult|bool
 	 */
 	public function detectEmailAttribute() {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										   'ldapPort',
 										   'ldapBase',
 										   'ldapUserFilter',
@@ -267,8 +267,8 @@ 
 
 		$attr = $this->configuration->ldapEmailAttribute;
 		if ($attr !== '') {
-			$count = (int)$this->countUsersWithAttribute($attr, true);
-			if($count > 0) {
+			$count = (int) $this->countUsersWithAttribute($attr, true);
+			if ($count > 0) {
 				return false;
 			}
 			$writeLog = true;
@@ -279,19 +279,19 @@ 
 		$emailAttributes = array('mail', 'mailPrimaryAddress');
 		$winner = '';
 		$maxUsers = 0;
-		foreach($emailAttributes as $attr) {
+		foreach ($emailAttributes as $attr) {
 			$count = $this->countUsersWithAttribute($attr);
-			if($count > $maxUsers) {
+			if ($count > $maxUsers) {
 				$maxUsers = $count;
 				$winner = $attr;
 			}
 		}
 
-		if($winner !== '') {
+		if ($winner !== '') {
 			$this->applyFind('ldap_email_attr', $winner);
-			if($writeLog) {
-				\OCP\Util::writeLog('user_ldap', 'The mail attribute has ' .
-					'automatically been reset, because the original value ' .
+			if ($writeLog) {
+				\OCP\Util::writeLog('user_ldap', 'The mail attribute has '.
+					'automatically been reset, because the original value '.
 					'did not return any results.', \OCP\Util::INFO);
 			}
 		}
@@ -304,7 +304,7 @@ 
 	 * @throws \Exception
 	 */
 	public function determineAttributes() {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										   'ldapPort',
 										   'ldapBase',
 										   'ldapUserFilter',
@@ -320,7 +320,7 @@ 
 		$this->result->addOptions('ldap_loginfilter_attributes', $attributes);
 
 		$selected = $this->configuration->ldapLoginFilterAttributes;
-		if(is_array($selected) && !empty($selected)) {
+		if (is_array($selected) && !empty($selected)) {
 			$this->result->addChange('ldap_loginfilter_attributes', $selected);
 		}
 
@@ -333,7 +333,7 @@ 
 	 * @throws \Exception
 	 */
 	private function getUserAttributes() {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										   'ldapPort',
 										   'ldapBase',
 										   'ldapUserFilter',
@@ -341,20 +341,20 @@ 
 			return  false;
 		}
 		$cr = $this->getConnection();
-		if(!$cr) {
+		if (!$cr) {
 			throw new \Exception('Could not connect to LDAP');
 		}
 
 		$base = $this->configuration->ldapBase[0];
 		$filter = $this->configuration->ldapUserFilter;
 		$rr = $this->ldap->search($cr, $base, $filter, array(), 1, 1);
-		if(!$this->ldap->isResource($rr)) {
+		if (!$this->ldap->isResource($rr)) {
 			return false;
 		}
 		$er = $this->ldap->firstEntry($cr, $rr);
 		$attributes = $this->ldap->getAttributes($cr, $er);
 		$pureAttributes = array();
-		for($i = 0; $i < $attributes['count']; $i++) {
+		for ($i = 0; $i < $attributes['count']; $i++) {
 			$pureAttributes[] = $attributes[$i];
 		}
 
@@ -389,23 +389,23 @@ 
 	 * @throws \Exception
 	 */
 	private function determineGroups($dbKey, $confKey, $testMemberOf = true) {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										   'ldapPort',
 										   'ldapBase',
 										   ))) {
 			return  false;
 		}
 		$cr = $this->getConnection();
-		if(!$cr) {
+		if (!$cr) {
 			throw new \Exception('Could not connect to LDAP');
 		}
 
 		$this->fetchGroups($dbKey, $confKey);
 
-		if($testMemberOf) {
+		if ($testMemberOf) {
 			$this->configuration->hasMemberOfFilterSupport = $this->testMemberOf();
 			$this->result->markChange();
-			if(!$this->configuration->hasMemberOfFilterSupport) {
+			if (!$this->configuration->hasMemberOfFilterSupport) {
 				throw new \Exception('memberOf is not supported by the server');
 			}
 		}
@@ -425,7 +425,7 @@ 
 		$obclasses = array('posixGroup', 'group', 'zimbraDistributionList', 'groupOfNames', 'groupOfUniqueNames');
 
 		$filterParts = array();
-		foreach($obclasses as $obclass) {
+		foreach ($obclasses as $obclass) {
 			$filterParts[] = 'objectclass='.$obclass;
 		}
 		//we filter for everything
@@ -442,8 +442,8 @@ 
 			// we need to request dn additionally here, otherwise memberOf
 			// detection will fail later
 			$result = $this->access->searchGroups($filter, array('cn', 'dn'), $limit, $offset);
-			foreach($result as $item) {
-				if(!isset($item['cn']) && !is_array($item['cn']) && !isset($item['cn'][0])) {
+			foreach ($result as $item) {
+				if (!isset($item['cn']) && !is_array($item['cn']) && !isset($item['cn'][0])) {
 					// just in case - no issue known
 					continue;
 				}
@@ -453,7 +453,7 @@ 
 			$offset += $limit;
 		} while ($this->access->hasMoreResults());
 
-		if(count($groupNames) > 0) {
+		if (count($groupNames) > 0) {
 			natsort($groupNames);
 			$this->result->addOptions($dbKey, array_values($groupNames));
 		} else {
@@ -461,7 +461,7 @@ 
 		}
 
 		$setFeatures = $this->configuration->$confKey;
-		if(is_array($setFeatures) && !empty($setFeatures)) {
+		if (is_array($setFeatures) && !empty($setFeatures)) {
 			//something is already configured? pre-select it.
 			$this->result->addChange($dbKey, $setFeatures);
 		}
@@ -469,14 +469,14 @@ 
 	}
 
 	public function determineGroupMemberAssoc() {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										   'ldapPort',
 										   'ldapGroupFilter',
 										   ))) {
 			return  false;
 		}
 		$attribute = $this->detectGroupMemberAssoc();
-		if($attribute === false) {
+		if ($attribute === false) {
 			return false;
 		}
 		$this->configuration->setConfiguration(array('ldapGroupMemberAssocAttr' => $attribute));
@@ -491,14 +491,14 @@ 
 	 * @throws \Exception
 	 */
 	public function determineGroupObjectClasses() {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										   'ldapPort',
 										   'ldapBase',
 										   ))) {
 			return  false;
 		}
 		$cr = $this->getConnection();
-		if(!$cr) {
+		if (!$cr) {
 			throw new \Exception('Could not connect to LDAP');
 		}
 
@@ -518,14 +518,14 @@ 
 	 * @throws \Exception
 	 */
 	public function determineUserObjectClasses() {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										   'ldapPort',
 										   'ldapBase',
 										   ))) {
 			return  false;
 		}
 		$cr = $this->getConnection();
-		if(!$cr) {
+		if (!$cr) {
 			throw new \Exception('Could not connect to LDAP');
 		}
 
@@ -548,7 +548,7 @@ 
 	 * @throws \Exception
 	 */
 	public function getGroupFilter() {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										   'ldapPort',
 										   'ldapBase',
 										   ))) {
@@ -572,7 +572,7 @@ 
 	 * @throws \Exception
 	 */
 	public function getUserListFilter() {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										   'ldapPort',
 										   'ldapBase',
 										   ))) {
@@ -585,7 +585,7 @@ 
 			$this->applyFind('ldap_display_name', $d['ldap_display_name']);
 		}
 		$filter = $this->composeLdapFilter(self::LFILTER_USER_LIST);
-		if(!$filter) {
+		if (!$filter) {
 			throw new \Exception('Cannot create filter');
 		}
 
@@ -598,7 +598,7 @@ 
 	 * @throws \Exception
 	 */
 	public function getUserLoginFilter() {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										   'ldapPort',
 										   'ldapBase',
 										   'ldapUserFilter',
@@ -607,7 +607,7 @@ 
 		}
 
 		$filter = $this->composeLdapFilter(self::LFILTER_LOGIN);
-		if(!$filter) {
+		if (!$filter) {
 			throw new \Exception('Cannot create filter');
 		}
 
@@ -621,7 +621,7 @@ 
 	 * @throws \Exception
 	 */
 	public function testLoginName($loginName) {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 			'ldapPort',
 			'ldapBase',
 			'ldapLoginFilter',
@@ -630,17 +630,17 @@ 
 		}
 
 		$cr = $this->access->connection->getConnectionResource();
-		if(!$this->ldap->isResource($cr)) {
+		if (!$this->ldap->isResource($cr)) {
 			throw new \Exception('connection error');
 		}
 
-		if(mb_strpos($this->access->connection->ldapLoginFilter, '%uid', 0, 'UTF-8')
+		if (mb_strpos($this->access->connection->ldapLoginFilter, '%uid', 0, 'UTF-8')
 			=== false) {
 			throw new \Exception('missing placeholder');
 		}
 
 		$users = $this->access->countUsersByLoginName($loginName);
-		if($this->ldap->errno($cr) !== 0) {
+		if ($this->ldap->errno($cr) !== 0) {
 			throw new \Exception($this->ldap->error($cr));
 		}
 		$filter = str_replace('%uid', $loginName, $this->access->connection->ldapLoginFilter);
@@ -655,22 +655,22 @@ 
 	 * @throws \Exception
 	 */
 	public function guessPortAndTLS() {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										   ))) {
 			return false;
 		}
 		$this->checkHost();
 		$portSettings = $this->getPortSettingsToTry();
 
-		if(!is_array($portSettings)) {
+		if (!is_array($portSettings)) {
 			throw new \Exception(print_r($portSettings, true));
 		}
 
 		//proceed from the best configuration and return on first success
-		foreach($portSettings as $setting) {
+		foreach ($portSettings as $setting) {
 			$p = $setting['port'];
 			$t = $setting['tls'];
-			\OCP\Util::writeLog('user_ldap', 'Wiz: trying port '. $p . ', TLS '. $t, \OCP\Util::DEBUG);
+			\OCP\Util::writeLog('user_ldap', 'Wiz: trying port '.$p.', TLS '.$t, \OCP\Util::DEBUG);
 			//connectAndBind may throw Exception, it needs to be catched by the
 			//callee of this method
 
@@ -680,7 +680,7 @@ 
 				// any reply other than -1 (= cannot connect) is already okay,
 				// because then we found the server
 				// unavailable startTLS returns -11
-				if($e->getCode() > 0) {
+				if ($e->getCode() > 0) {
 					$settingsFound = true;
 				} else {
 					throw $e;
@@ -693,7 +693,7 @@ 
 					'ldapTLS' => intval($t)
 				);
 				$this->configuration->setConfiguration($config);
-				\OCP\Util::writeLog('user_ldap', 'Wiz: detected Port ' . $p, \OCP\Util::DEBUG);
+				\OCP\Util::writeLog('user_ldap', 'Wiz: detected Port '.$p, \OCP\Util::DEBUG);
 				$this->result->addChange('ldap_port', $p);
 				return $this->result;
 			}
@@ -708,7 +708,7 @@ 
 	 * @return WizardResult|false WizardResult on success, false otherwise
 	 */
 	public function guessBaseDN() {
-		if(!$this->checkRequirements(array('ldapHost',
+		if (!$this->checkRequirements(array('ldapHost',
 										   'ldapPort',
 										   ))) {
 			return false;
@@ -717,9 +717,9 @@ 
 		//check whether a DN is given in the agent name (99.9% of all cases)
 		$base = null;
 		$i = stripos($this->configuration->ldapAgentName, 'dc=');
-		if($i !== false) {
+		if ($i !== false) {
 			$base = substr($this->configuration->ldapAgentName, $i);
-			if($this->testBaseDN($base)) {
+			if ($this->testBaseDN($base)) {
 				$this->applyFind('ldap_base', $base);
 				return $this->result;
 			}
@@ -730,13 +730,13 @@ 
 		//a base DN
 		$helper = new Helper(\OC::$server->getConfig());
 		$domain = $helper->getDomainFromURL($this->configuration->ldapHost);
-		if(!$domain) {
+		if (!$domain) {
 			return false;
 		}
 
 		$dparts = explode('.', $domain);
-		while(count($dparts) > 0) {
-			$base2 = 'dc=' . implode(',dc=', $dparts);
+		while (count($dparts) > 0) {
+			$base2 = 'dc='.implode(',dc=', $dparts);
 			if ($base !== $base2 && $this->testBaseDN($base2)) {
 				$this->applyFind('ldap_base', $base2);
 				return $this->result;
@@ -769,7 +769,7 @@ 
 		$hostInfo = parse_url($host);
 
 		//removes Port from Host
-		if(is_array($hostInfo) && isset($hostInfo['port'])) {
+		if (is_array($hostInfo) && isset($hostInfo['port'])) {
 			$port = $hostInfo['port'];
 			$host = str_replace(':'.$port, '', $host);
 			$this->applyFind('ldap_host', $host);
@@ -786,30 +786,30 @@ 
 	private function detectGroupMemberAssoc() {
 		$possibleAttrs = array('uniqueMember', 'memberUid', 'member', 'gidNumber');
 		$filter = $this->configuration->ldapGroupFilter;
-		if(empty($filter)) {
+		if (empty($filter)) {
 			return false;
 		}
 		$cr = $this->getConnection();
-		if(!$cr) {
+		if (!$cr) {
 			throw new \Exception('Could not connect to LDAP');
 		}
 		$base = $this->configuration->ldapBase[0];
 		$rr = $this->ldap->search($cr, $base, $filter, $possibleAttrs, 0, 1000);
-		if(!$this->ldap->isResource($rr)) {
+		if (!$this->ldap->isResource($rr)) {
 			return false;
 		}
 		$er = $this->ldap->firstEntry($cr, $rr);
-		while(is_resource($er)) {
+		while (is_resource($er)) {
 			$this->ldap->getDN($cr, $er);
 			$attrs = $this->ldap->getAttributes($cr, $er);
 			$result = array();
 			$possibleAttrsCount = count($possibleAttrs);
-			for($i = 0; $i < $possibleAttrsCount; $i++) {
-				if(isset($attrs[$possibleAttrs[$i]])) {
+			for ($i = 0; $i < $possibleAttrsCount; $i++) {
+				if (isset($attrs[$possibleAttrs[$i]])) {
 					$result[$possibleAttrs[$i]] = $attrs[$possibleAttrs[$i]]['count'];
 				}
 			}
-			if(!empty($result)) {
+			if (!empty($result)) {
 				natsort($result);
 				return key($result);
 			}
@@ -828,14 +828,14 @@ 
 	 */
 	private function testBaseDN($base) {
 		$cr = $this->getConnection();
-		if(!$cr) {
+		if (!$cr) {
 			throw new \Exception('Could not connect to LDAP');
 		}
 
 		//base is there, let's validate it. If we search for anything, we should
 		//get a result set > 0 on a proper base
 		$rr = $this->ldap->search($cr, $base, 'objectClass=*', array('dn'), 0, 1);
-		if(!$this->ldap->isResource($rr)) {
+		if (!$this->ldap->isResource($rr)) {
 			$errorNo  = $this->ldap->errno($cr);
 			$errorMsg = $this->ldap->error($cr);
 			\OCP\Util::writeLog('user_ldap', 'Wiz: Could not search base '.$base.
@@ -857,11 +857,11 @@ 
 	 */
 	private function testMemberOf() {
 		$cr = $this->getConnection();
-		if(!$cr) {
+		if (!$cr) {
 			throw new \Exception('Could not connect to LDAP');
 		}
 		$result = $this->access->countUsers('memberOf=*', array('memberOf'), 1);
-		if(is_int($result) &&  $result > 0) {
+		if (is_int($result) && $result > 0) {
 			return true;
 		}
 		return false;
@@ -882,27 +882,27 @@ 
 			case self::LFILTER_USER_LIST:
 				$objcs = $this->configuration->ldapUserFilterObjectclass;
 				//glue objectclasses
-				if(is_array($objcs) && count($objcs) > 0) {
+				if (is_array($objcs) && count($objcs) > 0) {
 					$filter .= '(|';
-					foreach($objcs as $objc) {
-						$filter .= '(objectclass=' . $objc . ')';
+					foreach ($objcs as $objc) {
+						$filter .= '(objectclass='.$objc.')';
 					}
 					$filter .= ')';
 					$parts++;
 				}
 				//glue group memberships
-				if($this->configuration->hasMemberOfFilterSupport) {
+				if ($this->configuration->hasMemberOfFilterSupport) {
 					$cns = $this->configuration->ldapUserFilterGroups;
-					if(is_array($cns) && count($cns) > 0) {
+					if (is_array($cns) && count($cns) > 0) {
 						$filter .= '(|';
 						$cr = $this->getConnection();
-						if(!$cr) {
+						if (!$cr) {
 							throw new \Exception('Could not connect to LDAP');
 						}
 						$base = $this->configuration->ldapBase[0];
-						foreach($cns as $cn) {
-							$rr = $this->ldap->search($cr, $base, 'cn=' . $cn, array('dn', 'primaryGroupToken'));
-							if(!$this->ldap->isResource($rr)) {
+						foreach ($cns as $cn) {
+							$rr = $this->ldap->search($cr, $base, 'cn='.$cn, array('dn', 'primaryGroupToken'));
+							if (!$this->ldap->isResource($rr)) {
 								continue;
 							}
 							$er = $this->ldap->firstEntry($cr, $rr);
@@ -911,11 +911,11 @@ 
 							if ($dn === false || $dn === '') {
 								continue;
 							}
-							$filterPart = '(memberof=' . $dn . ')';
-							if(isset($attrs['primaryGroupToken'])) {
+							$filterPart = '(memberof='.$dn.')';
+							if (isset($attrs['primaryGroupToken'])) {
 								$pgt = $attrs['primaryGroupToken'][0];
-								$primaryFilterPart = '(primaryGroupID=' . $pgt .')';
-								$filterPart = '(|' . $filterPart . $primaryFilterPart . ')';
+								$primaryFilterPart = '(primaryGroupID='.$pgt.')';
+								$filterPart = '(|'.$filterPart.$primaryFilterPart.')';
 							}
 							$filter .= $filterPart;
 						}
@@ -924,8 +924,8 @@ 
 					$parts++;
 				}
 				//wrap parts in AND condition
-				if($parts > 1) {
-					$filter = '(&' . $filter . ')';
+				if ($parts > 1) {
+					$filter = '(&'.$filter.')';
 				}
 				if ($filter === '') {
 					$filter = '(objectclass=*)';
@@ -935,27 +935,27 @@ 
 			case self::LFILTER_GROUP_LIST:
 				$objcs = $this->configuration->ldapGroupFilterObjectclass;
 				//glue objectclasses
-				if(is_array($objcs) && count($objcs) > 0) {
+				if (is_array($objcs) && count($objcs) > 0) {
 					$filter .= '(|';
-					foreach($objcs as $objc) {
-						$filter .= '(objectclass=' . $objc . ')';
+					foreach ($objcs as $objc) {
+						$filter .= '(objectclass='.$objc.')';
 					}
 					$filter .= ')';
 					$parts++;
 				}
 				//glue group memberships
 				$cns = $this->configuration->ldapGroupFilterGroups;
-				if(is_array($cns) && count($cns) > 0) {
+				if (is_array($cns) && count($cns) > 0) {
 					$filter .= '(|';
-					foreach($cns as $cn) {
-						$filter .= '(cn=' . $cn . ')';
+					foreach ($cns as $cn) {
+						$filter .= '(cn='.$cn.')';
 					}
 					$filter .= ')';
 				}
 				$parts++;
 				//wrap parts in AND condition
-				if($parts > 1) {
-					$filter = '(&' . $filter . ')';
+				if ($parts > 1) {
+					$filter = '(&'.$filter.')';
 				}
 				break;
 
@@ -967,47 +967,47 @@ 
 				$userAttributes = array_change_key_case(array_flip($userAttributes));
 				$parts = 0;
 
-				if($this->configuration->ldapLoginFilterUsername === '1') {
+				if ($this->configuration->ldapLoginFilterUsername === '1') {
 					$attr = '';
-					if(isset($userAttributes['uid'])) {
+					if (isset($userAttributes['uid'])) {
 						$attr = 'uid';
-					} else if(isset($userAttributes['samaccountname'])) {
+					} else if (isset($userAttributes['samaccountname'])) {
 						$attr = 'samaccountname';
-					} else if(isset($userAttributes['cn'])) {
+					} else if (isset($userAttributes['cn'])) {
 						//fallback
 						$attr = 'cn';
 					}
 					if ($attr !== '') {
-						$filterUsername = '(' . $attr . $loginpart . ')';
+						$filterUsername = '('.$attr.$loginpart.')';
 						$parts++;
 					}
 				}
 
 				$filterEmail = '';
-				if($this->configuration->ldapLoginFilterEmail === '1') {
+				if ($this->configuration->ldapLoginFilterEmail === '1') {
 					$filterEmail = '(|(mailPrimaryAddress=%uid)(mail=%uid))';
 					$parts++;
 				}
 
 				$filterAttributes = '';
 				$attrsToFilter = $this->configuration->ldapLoginFilterAttributes;
-				if(is_array($attrsToFilter) && count($attrsToFilter) > 0) {
+				if (is_array($attrsToFilter) && count($attrsToFilter) > 0) {
 					$filterAttributes = '(|';
-					foreach($attrsToFilter as $attribute) {
-						$filterAttributes .= '(' . $attribute . $loginpart . ')';
+					foreach ($attrsToFilter as $attribute) {
+						$filterAttributes .= '('.$attribute.$loginpart.')';
 					}
 					$filterAttributes .= ')';
 					$parts++;
 				}
 
 				$filterLogin = '';
-				if($parts > 1) {
+				if ($parts > 1) {
 					$filterLogin = '(|';
 				}
 				$filterLogin .= $filterUsername;
 				$filterLogin .= $filterEmail;
 				$filterLogin .= $filterAttributes;
-				if($parts > 1) {
+				if ($parts > 1) {
 					$filterLogin .= ')';
 				}
 
@@ -1032,12 +1032,12 @@ 
 		//connect, does not really trigger any server communication
 		$host = $this->configuration->ldapHost;
 		$hostInfo = parse_url($host);
-		if(!$hostInfo) {
+		if (!$hostInfo) {
 			throw new \Exception(self::$l->t('Invalid Host'));
 		}
 		\OCP\Util::writeLog('user_ldap', 'Wiz: Attempting to connect ', \OCP\Util::DEBUG);
 		$cr = $this->ldap->connect($host, $port);
-		if(!is_resource($cr)) {
+		if (!is_resource($cr)) {
 			throw new \Exception(self::$l->t('Invalid Host'));
 		}
 
@@ -1047,9 +1047,9 @@ 
 		$this->ldap->setOption($cr, LDAP_OPT_NETWORK_TIMEOUT, self::LDAP_NW_TIMEOUT);
 
 		try {
-			if($tls) {
+			if ($tls) {
 				$isTlsWorking = @$this->ldap->startTls($cr);
-				if(!$isTlsWorking) {
+				if (!$isTlsWorking) {
 					return false;
 				}
 			}
@@ -1063,17 +1063,17 @@ 
 			$errNo = $this->ldap->errno($cr);
 			$error = ldap_error($cr);
 			$this->ldap->unbind($cr);
-		} catch(ServerNotAvailableException $e) {
+		} catch (ServerNotAvailableException $e) {
 			return false;
 		}
 
-		if($login === true) {
+		if ($login === true) {
 			$this->ldap->unbind($cr);
-			\OCP\Util::writeLog('user_ldap', 'Wiz: Bind successful to Port '. $port . ' TLS ' . intval($tls), \OCP\Util::DEBUG);
+			\OCP\Util::writeLog('user_ldap', 'Wiz: Bind successful to Port '.$port.' TLS '.intval($tls), \OCP\Util::DEBUG);
 			return true;
 		}
 
-		if($errNo === -1) {
+		if ($errNo === -1) {
 			//host, port or TLS wrong
 			return false;
 		}
@@ -1101,9 +1101,9 @@ 
 	 */
 	private function checkRequirements($reqs) {
 		$this->checkAgentRequirements();
-		foreach($reqs as $option) {
+		foreach ($reqs as $option) {
 			$value = $this->configuration->$option;
-			if(empty($value)) {
+			if (empty($value)) {
 				return false;
 			}
 		}
@@ -1125,33 +1125,33 @@ 
 		$dnRead = array();
 		$foundItems = array();
 		$maxEntries = 0;
-		if(!is_array($this->configuration->ldapBase)
+		if (!is_array($this->configuration->ldapBase)
 		   || !isset($this->configuration->ldapBase[0])) {
 			return false;
 		}
 		$base = $this->configuration->ldapBase[0];
 		$cr = $this->getConnection();
-		if(!$this->ldap->isResource($cr)) {
+		if (!$this->ldap->isResource($cr)) {
 			return false;
 		}
 		$lastFilter = null;
-		if(isset($filters[count($filters)-1])) {
-			$lastFilter = $filters[count($filters)-1];
+		if (isset($filters[count($filters) - 1])) {
+			$lastFilter = $filters[count($filters) - 1];
 		}
-		foreach($filters as $filter) {
-			if($lastFilter === $filter && count($foundItems) > 0) {
+		foreach ($filters as $filter) {
+			if ($lastFilter === $filter && count($foundItems) > 0) {
 				//skip when the filter is a wildcard and results were found
 				continue;
 			}
 			// 20k limit for performance and reason
 			$rr = $this->ldap->search($cr, $base, $filter, array($attr), 0, 20000);
-			if(!$this->ldap->isResource($rr)) {
+			if (!$this->ldap->isResource($rr)) {
 				continue;
 			}
 			$entries = $this->ldap->countEntries($cr, $rr);
 			$getEntryFunc = 'firstEntry';
-			if(($entries !== false) && ($entries > 0)) {
-				if(!is_null($maxF) && $entries > $maxEntries) {
+			if (($entries !== false) && ($entries > 0)) {
+				if (!is_null($maxF) && $entries > $maxEntries) {
 					$maxEntries = $entries;
 					$maxF = $filter;
 				}
@@ -1159,13 +1159,13 @@ 
 				do {
 					$entry = $this->ldap->$getEntryFunc($cr, $rr);
 					$getEntryFunc = 'nextEntry';
-					if(!$this->ldap->isResource($entry)) {
+					if (!$this->ldap->isResource($entry)) {
 						continue 2;
 					}
 					$rr = $entry; //will be expected by nextEntry next round
 					$attributes = $this->ldap->getAttributes($cr, $entry);
 					$dn = $this->ldap->getDN($cr, $entry);
-					if($dn === false || in_array($dn, $dnRead)) {
+					if ($dn === false || in_array($dn, $dnRead)) {
 						continue;
 					}
 					$newItems = array();
@@ -1176,7 +1176,7 @@ 
 					$foundItems = array_merge($foundItems, $newItems);
 					$this->resultCache[$dn][$attr] = $newItems;
 					$dnRead[] = $dn;
-				} while(($state === self::LRESULT_PROCESSED_SKIP
+				} while (($state === self::LRESULT_PROCESSED_SKIP
 						|| $this->ldap->isResource($entry))
 						&& ($dnReadLimit === 0 || $dnReadCount < $dnReadLimit));
 			}
@@ -1199,11 +1199,11 @@ 
 	 */
 	private function determineFeature($objectclasses, $attr, $dbkey, $confkey, $po = false) {
 		$cr = $this->getConnection();
-		if(!$cr) {
+		if (!$cr) {
 			throw new \Exception('Could not connect to LDAP');
 		}
 		$p = 'objectclass=';
-		foreach($objectclasses as $key => $value) {
+		foreach ($objectclasses as $key => $value) {
 			$objectclasses[$key] = $p.$value;
 		}
 		$maxEntryObjC = '';
@@ -1215,7 +1215,7 @@ 
 		$availableFeatures =
 			$this->cumulativeSearchOnAttribute($objectclasses, $attr,
 											   $dig, $maxEntryObjC);
-		if(is_array($availableFeatures)
+		if (is_array($availableFeatures)
 		   && count($availableFeatures) > 0) {
 			natcasesort($availableFeatures);
 			//natcasesort keeps indices, but we must get rid of them for proper
@@ -1226,7 +1226,7 @@ 
 		}
 
 		$setFeatures = $this->configuration->$confkey;
-		if(is_array($setFeatures) && !empty($setFeatures)) {
+		if (is_array($setFeatures) && !empty($setFeatures)) {
 			//something is already configured? pre-select it.
 			$this->result->addChange($dbkey, $setFeatures);
 		} else if ($po && $maxEntryObjC !== '') {
@@ -1248,7 +1248,7 @@ 
 	 * LRESULT_PROCESSED_INVALID or LRESULT_PROCESSED_SKIP
 	 */
 	private function getAttributeValuesFromEntry($result, $attribute, &$known) {
-		if(!is_array($result)
+		if (!is_array($result)
 		   || !isset($result['count'])
 		   || !$result['count'] > 0) {
 			return self::LRESULT_PROCESSED_INVALID;
@@ -1257,12 +1257,12 @@ 
 		// strtolower on all keys for proper comparison
 		$result = \OCP\Util::mb_array_change_key_case($result);
 		$attribute = strtolower($attribute);
-		if(isset($result[$attribute])) {
-			foreach($result[$attribute] as $key => $val) {
-				if($key === 'count') {
+		if (isset($result[$attribute])) {
+			foreach ($result[$attribute] as $key => $val) {
+				if ($key === 'count') {
 					continue;
 				}
-				if(!in_array($val, $known)) {
+				if (!in_array($val, $known)) {
 					$known[] = $val;
 				}
 			}
@@ -1276,7 +1276,7 @@ 
 	 * @return bool|mixed
 	 */
 	private function getConnection() {
-		if(!is_null($this->cr)) {
+		if (!is_null($this->cr)) {
 			return $this->cr;
 		}
 
@@ -1288,14 +1288,14 @@ 
 		$this->ldap->setOption($cr, LDAP_OPT_PROTOCOL_VERSION, 3);
 		$this->ldap->setOption($cr, LDAP_OPT_REFERRALS, 0);
 		$this->ldap->setOption($cr, LDAP_OPT_NETWORK_TIMEOUT, self::LDAP_NW_TIMEOUT);
-		if($this->configuration->ldapTLS === 1) {
+		if ($this->configuration->ldapTLS === 1) {
 			$this->ldap->startTls($cr);
 		}
 
 		$lo = @$this->ldap->bind($cr,
 								 $this->configuration->ldapAgentName,
 								 $this->configuration->ldapAgentPassword);
-		if($lo === true) {
+		if ($lo === true) {
 			$this->$cr = $cr;
 			return $cr;
 		}
@@ -1330,14 +1330,14 @@ 
 		$portSettings = array();
 
 		//In case the port is already provided, we will check this first
-		if($port > 0) {
+		if ($port > 0) {
 			$hostInfo = parse_url($host);
-			if(!(is_array($hostInfo)
+			if (!(is_array($hostInfo)
 				&& isset($hostInfo['scheme'])
 				&& stripos($hostInfo['scheme'], 'ldaps') !== false)) {
 				$portSettings[] = array('port' => $port, 'tls' => true);
 			}
-			$portSettings[] =array('port' => $port, 'tls' => false);
+			$portSettings[] = array('port' => $port, 'tls' => false);
 		}
 
 		//default ports

apps/user_ldap/lib/Jobs/CleanUp.php

Indentation +192 added lines, -192 removed lines

@@ -43,197 +43,197 @@
  * @package OCA\User_LDAP\Jobs;
  */
 class CleanUp extends TimedJob {
-	/** @var int $limit amount of users that should be checked per run */
-	protected $limit = 50;
-
-	/** @var int $defaultIntervalMin default interval in minutes */
-	protected $defaultIntervalMin = 51;
-
-	/** @var User_LDAP|User_Proxy $userBackend */
-	protected $userBackend;
-
-	/** @var \OCP\IConfig $ocConfig */
-	protected $ocConfig;
-
-	/** @var \OCP\IDBConnection $db */
-	protected $db;
-
-	/** @var Helper $ldapHelper */
-	protected $ldapHelper;
-
-	/** @var \OCA\User_LDAP\Mapping\UserMapping */
-	protected $mapping;
-
-	/** @var \OCA\User_LDAP\User\DeletedUsersIndex */
-	protected $dui;
-
-	public function __construct() {
-		$minutes = \OC::$server->getConfig()->getSystemValue(
-			'ldapUserCleanupInterval', (string)$this->defaultIntervalMin);
-		$this->setInterval((int)$minutes * 60);
-	}
-
-	/**
-	 * assigns the instances passed to run() to the class properties
-	 * @param array $arguments
-	 */
-	public function setArguments($arguments) {
-		//Dependency Injection is not possible, because the constructor will
-		//only get values that are serialized to JSON. I.e. whatever we would
-		//pass in app.php we do add here, except something else is passed e.g.
-		//in tests.
-
-		if(isset($arguments['helper'])) {
-			$this->ldapHelper = $arguments['helper'];
-		} else {
-			$this->ldapHelper = new Helper(\OC::$server->getConfig());
-		}
-
-		if(isset($arguments['ocConfig'])) {
-			$this->ocConfig = $arguments['ocConfig'];
-		} else {
-			$this->ocConfig = \OC::$server->getConfig();
-		}
-
-		if(isset($arguments['userBackend'])) {
-			$this->userBackend = $arguments['userBackend'];
-		} else {
-			$this->userBackend =  new User_Proxy(
-				$this->ldapHelper->getServerConfigurationPrefixes(true),
-				new LDAP(),
-				$this->ocConfig,
-				\OC::$server->getNotificationManager(),
-				\OC::$server->getUserSession(),
-				\OC::$server->query('LDAPUserPluginManager')
-			);
-		}
-
-		if(isset($arguments['db'])) {
-			$this->db = $arguments['db'];
-		} else {
-			$this->db = \OC::$server->getDatabaseConnection();
-		}
-
-		if(isset($arguments['mapping'])) {
-			$this->mapping = $arguments['mapping'];
-		} else {
-			$this->mapping = new UserMapping($this->db);
-		}
-
-		if(isset($arguments['deletedUsersIndex'])) {
-			$this->dui = $arguments['deletedUsersIndex'];
-		} else {
-			$this->dui = new DeletedUsersIndex(
-				$this->ocConfig, $this->db, $this->mapping);
-		}
-	}
-
-	/**
-	 * makes the background job do its work
-	 * @param array $argument
-	 */
-	public function run($argument) {
-		$this->setArguments($argument);
-
-		if(!$this->isCleanUpAllowed()) {
-			return;
-		}
-		$users = $this->mapping->getList($this->getOffset(), $this->limit);
-		if(!is_array($users)) {
-			//something wrong? Let's start from the beginning next time and
-			//abort
-			$this->setOffset(true);
-			return;
-		}
-		$resetOffset = $this->isOffsetResetNecessary(count($users));
-		$this->checkUsers($users);
-		$this->setOffset($resetOffset);
-	}
-
-	/**
-	 * checks whether next run should start at 0 again
-	 * @param int $resultCount
-	 * @return bool
-	 */
-	public function isOffsetResetNecessary($resultCount) {
-		return ($resultCount < $this->limit) ? true : false;
-	}
-
-	/**
-	 * checks whether cleaning up LDAP users is allowed
-	 * @return bool
-	 */
-	public function isCleanUpAllowed() {
-		try {
-			if($this->ldapHelper->haveDisabledConfigurations()) {
-				return false;
-			}
-		} catch (\Exception $e) {
-			return false;
-		}
-
-		$enabled = $this->isCleanUpEnabled();
-
-		return $enabled;
-	}
-
-	/**
-	 * checks whether clean up is enabled by configuration
-	 * @return bool
-	 */
-	private function isCleanUpEnabled() {
-		return (bool)$this->ocConfig->getSystemValue(
-			'ldapUserCleanupInterval', (string)$this->defaultIntervalMin);
-	}
-
-	/**
-	 * checks users whether they are still existing
-	 * @param array $users result from getMappedUsers()
-	 */
-	private function checkUsers(array $users) {
-		foreach($users as $user) {
-			$this->checkUser($user);
-		}
-	}
-
-	/**
-	 * checks whether a user is still existing in LDAP
-	 * @param string[] $user
-	 */
-	private function checkUser(array $user) {
-		if($this->userBackend->userExistsOnLDAP($user['name'])) {
-			//still available, all good
-
-			return;
-		}
-
-		$this->dui->markUser($user['name']);
-	}
-
-	/**
-	 * gets the offset to fetch users from the mappings table
-	 * @return int
-	 */
-	private function getOffset() {
-		return (int)$this->ocConfig->getAppValue('user_ldap', 'cleanUpJobOffset', 0);
-	}
-
-	/**
-	 * sets the new offset for the next run
-	 * @param bool $reset whether the offset should be set to 0
-	 */
-	public function setOffset($reset = false) {
-		$newOffset = $reset ? 0 :
-			$this->getOffset() + $this->limit;
-		$this->ocConfig->setAppValue('user_ldap', 'cleanUpJobOffset', $newOffset);
-	}
-
-	/**
-	 * returns the chunk size (limit in DB speak)
-	 * @return int
-	 */
-	public function getChunkSize() {
-		return $this->limit;
-	}
+    /** @var int $limit amount of users that should be checked per run */
+    protected $limit = 50;
+
+    /** @var int $defaultIntervalMin default interval in minutes */
+    protected $defaultIntervalMin = 51;
+
+    /** @var User_LDAP|User_Proxy $userBackend */
+    protected $userBackend;
+
+    /** @var \OCP\IConfig $ocConfig */
+    protected $ocConfig;
+
+    /** @var \OCP\IDBConnection $db */
+    protected $db;
+
+    /** @var Helper $ldapHelper */
+    protected $ldapHelper;
+
+    /** @var \OCA\User_LDAP\Mapping\UserMapping */
+    protected $mapping;
+
+    /** @var \OCA\User_LDAP\User\DeletedUsersIndex */
+    protected $dui;
+
+    public function __construct() {
+        $minutes = \OC::$server->getConfig()->getSystemValue(
+            'ldapUserCleanupInterval', (string)$this->defaultIntervalMin);
+        $this->setInterval((int)$minutes * 60);
+    }
+
+    /**
+     * assigns the instances passed to run() to the class properties
+     * @param array $arguments
+     */
+    public function setArguments($arguments) {
+        //Dependency Injection is not possible, because the constructor will
+        //only get values that are serialized to JSON. I.e. whatever we would
+        //pass in app.php we do add here, except something else is passed e.g.
+        //in tests.
+
+        if(isset($arguments['helper'])) {
+            $this->ldapHelper = $arguments['helper'];
+        } else {
+            $this->ldapHelper = new Helper(\OC::$server->getConfig());
+        }
+
+        if(isset($arguments['ocConfig'])) {
+            $this->ocConfig = $arguments['ocConfig'];
+        } else {
+            $this->ocConfig = \OC::$server->getConfig();
+        }
+
+        if(isset($arguments['userBackend'])) {
+            $this->userBackend = $arguments['userBackend'];
+        } else {
+            $this->userBackend =  new User_Proxy(
+                $this->ldapHelper->getServerConfigurationPrefixes(true),
+                new LDAP(),
+                $this->ocConfig,
+                \OC::$server->getNotificationManager(),
+                \OC::$server->getUserSession(),
+                \OC::$server->query('LDAPUserPluginManager')
+            );
+        }
+
+        if(isset($arguments['db'])) {
+            $this->db = $arguments['db'];
+        } else {
+            $this->db = \OC::$server->getDatabaseConnection();
+        }
+
+        if(isset($arguments['mapping'])) {
+            $this->mapping = $arguments['mapping'];
+        } else {
+            $this->mapping = new UserMapping($this->db);
+        }
+
+        if(isset($arguments['deletedUsersIndex'])) {
+            $this->dui = $arguments['deletedUsersIndex'];
+        } else {
+            $this->dui = new DeletedUsersIndex(
+                $this->ocConfig, $this->db, $this->mapping);
+        }
+    }
+
+    /**
+     * makes the background job do its work
+     * @param array $argument
+     */
+    public function run($argument) {
+        $this->setArguments($argument);
+
+        if(!$this->isCleanUpAllowed()) {
+            return;
+        }
+        $users = $this->mapping->getList($this->getOffset(), $this->limit);
+        if(!is_array($users)) {
+            //something wrong? Let's start from the beginning next time and
+            //abort
+            $this->setOffset(true);
+            return;
+        }
+        $resetOffset = $this->isOffsetResetNecessary(count($users));
+        $this->checkUsers($users);
+        $this->setOffset($resetOffset);
+    }
+
+    /**
+     * checks whether next run should start at 0 again
+     * @param int $resultCount
+     * @return bool
+     */
+    public function isOffsetResetNecessary($resultCount) {
+        return ($resultCount < $this->limit) ? true : false;
+    }
+
+    /**
+     * checks whether cleaning up LDAP users is allowed
+     * @return bool
+     */
+    public function isCleanUpAllowed() {
+        try {
+            if($this->ldapHelper->haveDisabledConfigurations()) {
+                return false;
+            }
+        } catch (\Exception $e) {
+            return false;
+        }
+
+        $enabled = $this->isCleanUpEnabled();
+
+        return $enabled;
+    }
+
+    /**
+     * checks whether clean up is enabled by configuration
+     * @return bool
+     */
+    private function isCleanUpEnabled() {
+        return (bool)$this->ocConfig->getSystemValue(
+            'ldapUserCleanupInterval', (string)$this->defaultIntervalMin);
+    }
+
+    /**
+     * checks users whether they are still existing
+     * @param array $users result from getMappedUsers()
+     */
+    private function checkUsers(array $users) {
+        foreach($users as $user) {
+            $this->checkUser($user);
+        }
+    }
+
+    /**
+     * checks whether a user is still existing in LDAP
+     * @param string[] $user
+     */
+    private function checkUser(array $user) {
+        if($this->userBackend->userExistsOnLDAP($user['name'])) {
+            //still available, all good
+
+            return;
+        }
+
+        $this->dui->markUser($user['name']);
+    }
+
+    /**
+     * gets the offset to fetch users from the mappings table
+     * @return int
+     */
+    private function getOffset() {
+        return (int)$this->ocConfig->getAppValue('user_ldap', 'cleanUpJobOffset', 0);
+    }
+
+    /**
+     * sets the new offset for the next run
+     * @param bool $reset whether the offset should be set to 0
+     */
+    public function setOffset($reset = false) {
+        $newOffset = $reset ? 0 :
+            $this->getOffset() + $this->limit;
+        $this->ocConfig->setAppValue('user_ldap', 'cleanUpJobOffset', $newOffset);
+    }
+
+    /**
+     * returns the chunk size (limit in DB speak)
+     * @return int
+     */
+    public function getChunkSize() {
+        return $this->limit;
+    }
 
 }

Spacing +18 added lines, -19 removed lines

@@ -69,8 +69,8 @@ 
 
 	public function __construct() {
 		$minutes = \OC::$server->getConfig()->getSystemValue(
-			'ldapUserCleanupInterval', (string)$this->defaultIntervalMin);
-		$this->setInterval((int)$minutes * 60);
+			'ldapUserCleanupInterval', (string) $this->defaultIntervalMin);
+		$this->setInterval((int) $minutes * 60);
 	}
 
 	/**
@@ -83,22 +83,22 @@ 
 		//pass in app.php we do add here, except something else is passed e.g.
 		//in tests.
 
-		if(isset($arguments['helper'])) {
+		if (isset($arguments['helper'])) {
 			$this->ldapHelper = $arguments['helper'];
 		} else {
 			$this->ldapHelper = new Helper(\OC::$server->getConfig());
 		}
 
-		if(isset($arguments['ocConfig'])) {
+		if (isset($arguments['ocConfig'])) {
 			$this->ocConfig = $arguments['ocConfig'];
 		} else {
 			$this->ocConfig = \OC::$server->getConfig();
 		}
 
-		if(isset($arguments['userBackend'])) {
+		if (isset($arguments['userBackend'])) {
 			$this->userBackend = $arguments['userBackend'];
 		} else {
-			$this->userBackend =  new User_Proxy(
+			$this->userBackend = new User_Proxy(
 				$this->ldapHelper->getServerConfigurationPrefixes(true),
 				new LDAP(),
 				$this->ocConfig,
@@ -108,19 +108,19 @@ 
 			);
 		}
 
-		if(isset($arguments['db'])) {
+		if (isset($arguments['db'])) {
 			$this->db = $arguments['db'];
 		} else {
 			$this->db = \OC::$server->getDatabaseConnection();
 		}
 
-		if(isset($arguments['mapping'])) {
+		if (isset($arguments['mapping'])) {
 			$this->mapping = $arguments['mapping'];
 		} else {
 			$this->mapping = new UserMapping($this->db);
 		}
 
-		if(isset($arguments['deletedUsersIndex'])) {
+		if (isset($arguments['deletedUsersIndex'])) {
 			$this->dui = $arguments['deletedUsersIndex'];
 		} else {
 			$this->dui = new DeletedUsersIndex(
@@ -135,11 +135,11 @@ 
 	public function run($argument) {
 		$this->setArguments($argument);
 
-		if(!$this->isCleanUpAllowed()) {
+		if (!$this->isCleanUpAllowed()) {
 			return;
 		}
 		$users = $this->mapping->getList($this->getOffset(), $this->limit);
-		if(!is_array($users)) {
+		if (!is_array($users)) {
 			//something wrong? Let's start from the beginning next time and
 			//abort
 			$this->setOffset(true);
@@ -165,7 +165,7 @@ 
 	 */
 	public function isCleanUpAllowed() {
 		try {
-			if($this->ldapHelper->haveDisabledConfigurations()) {
+			if ($this->ldapHelper->haveDisabledConfigurations()) {
 				return false;
 			}
 		} catch (\Exception $e) {
@@ -182,8 +182,8 @@ 
 	 * @return bool
 	 */
 	private function isCleanUpEnabled() {
-		return (bool)$this->ocConfig->getSystemValue(
-			'ldapUserCleanupInterval', (string)$this->defaultIntervalMin);
+		return (bool) $this->ocConfig->getSystemValue(
+			'ldapUserCleanupInterval', (string) $this->defaultIntervalMin);
 	}
 
 	/**
@@ -191,7 +191,7 @@ 
 	 * @param array $users result from getMappedUsers()
 	 */
 	private function checkUsers(array $users) {
-		foreach($users as $user) {
+		foreach ($users as $user) {
 			$this->checkUser($user);
 		}
 	}
@@ -201,7 +201,7 @@ 
 	 * @param string[] $user
 	 */
 	private function checkUser(array $user) {
-		if($this->userBackend->userExistsOnLDAP($user['name'])) {
+		if ($this->userBackend->userExistsOnLDAP($user['name'])) {
 			//still available, all good
 
 			return;
@@ -215,7 +215,7 @@ 
 	 * @return int
 	 */
 	private function getOffset() {
-		return (int)$this->ocConfig->getAppValue('user_ldap', 'cleanUpJobOffset', 0);
+		return (int) $this->ocConfig->getAppValue('user_ldap', 'cleanUpJobOffset', 0);
 	}
 
 	/**
@@ -223,8 +223,7 @@ 
 	 * @param bool $reset whether the offset should be set to 0
 	 */
 	public function setOffset($reset = false) {
-		$newOffset = $reset ? 0 :
-			$this->getOffset() + $this->limit;
+		$newOffset = $reset ? 0 : $this->getOffset() + $this->limit;
 		$this->ocConfig->setAppValue('user_ldap', 'cleanUpJobOffset', $newOffset);
 	}