nextcloud / server

lib/private/user.php

Doc Comments +1 added lines

@@ -245,6 +245,7 @@
 
 	/**
 	 * Sets user id for session and triggers emit
+	 * @param string $uid
 	 */
 	public static function setUserId($uid) {
 		$userSession = \OC::$server->getUserSession();

Indentation +586 added lines, -586 removed lines

@@ -57,590 +57,590 @@
  */
 class OC_User {
 
-	/**
-	 * @return \OC\User\Session
-	 */
-	public static function getUserSession() {
-		return OC::$server->getUserSession();
-	}
-
-	private static $_backends = array();
-
-	private static $_usedBackends = array();
-
-	private static $_setupedBackends = array();
-
-	// bool, stores if a user want to access a resource anonymously, e.g if he opens a public link
-	private static $incognitoMode = false;
-
-	/**
-	 * Adds the backend to the list of used backends
-	 *
-	 * @param string|\OCP\UserInterface $backend default: database The backend to use for user management
-	 * @return bool
-	 *
-	 * Set the User Authentication Module
-	 */
-	public static function useBackend($backend = 'database') {
-		if ($backend instanceof \OCP\UserInterface) {
-			self::$_usedBackends[get_class($backend)] = $backend;
-			\OC::$server->getUserManager()->registerBackend($backend);
-		} else {
-			// You'll never know what happens
-			if (null === $backend OR !is_string($backend)) {
-				$backend = 'database';
-			}
-
-			// Load backend
-			switch ($backend) {
-				case 'database':
-				case 'mysql':
-				case 'sqlite':
-					\OCP\Util::writeLog('core', 'Adding user backend ' . $backend . '.', \OCP\Util::DEBUG);
-					self::$_usedBackends[$backend] = new OC_User_Database();
-					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
-					break;
-				case 'dummy':
-					self::$_usedBackends[$backend] = new \Test\Util\User\Dummy();
-					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
-					break;
-				default:
-					\OCP\Util::writeLog('core', 'Adding default user backend ' . $backend . '.', \OCP\Util::DEBUG);
-					$className = 'OC_USER_' . strToUpper($backend);
-					self::$_usedBackends[$backend] = new $className();
-					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
-					break;
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * remove all used backends
-	 */
-	public static function clearBackends() {
-		self::$_usedBackends = array();
-		\OC::$server->getUserManager()->clearBackends();
-	}
-
-	/**
-	 * setup the configured backends in config.php
-	 */
-	public static function setupBackends() {
-		OC_App::loadApps(array('prelogin'));
-		$backends = \OC::$server->getSystemConfig()->getValue('user_backends', array());
-		foreach ($backends as $i => $config) {
-			$class = $config['class'];
-			$arguments = $config['arguments'];
-			if (class_exists($class)) {
-				if (array_search($i, self::$_setupedBackends) === false) {
-					// make a reflection object
-					$reflectionObj = new ReflectionClass($class);
-
-					// use Reflection to create a new instance, using the $args
-					$backend = $reflectionObj->newInstanceArgs($arguments);
-					self::useBackend($backend);
-					self::$_setupedBackends[] = $i;
-				} else {
-					\OCP\Util::writeLog('core', 'User backend ' . $class . ' already initialized.', \OCP\Util::DEBUG);
-				}
-			} else {
-				\OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', \OCP\Util::ERROR);
-			}
-		}
-	}
-
-	/**
-	 * Try to login a user
-	 *
-	 * @param string $loginname The login name of the user to log in
-	 * @param string $password The password of the user
-	 * @return boolean|null
-	 *
-	 * Log in a user and regenerate a new session - if the password is ok
-	 */
-	public static function login($loginname, $password) {
-		$result = self::getUserSession()->login($loginname, $password);
-		if ($result) {
-			// Refresh the token
-			\OC::$server->getCsrfTokenManager()->refreshToken();
-			//we need to pass the user name, which may differ from login name
-			$user = self::getUserSession()->getUser()->getUID();
-			OC_Util::setupFS($user);
-			//trigger creation of user home and /files folder
-			\OC::$server->getUserFolder($user);
-		}
-		return $result;
-	}
-
-	/**
-	 * Try to login a user using the magic cookie (remember login)
-	 *
-	 * @param string $uid The username of the user to log in
-	 * @param string $token
-	 * @return bool
-	 */
-	public static function loginWithCookie($uid, $token) {
-		return self::getUserSession()->loginWithCookie($uid, $token);
-	}
-
-	/**
-	 * Try to login a user, assuming authentication
-	 * has already happened (e.g. via Single Sign On).
-	 *
-	 * Log in a user and regenerate a new session.
-	 *
-	 * @param \OCP\Authentication\IApacheBackend $backend
-	 * @return bool
-	 */
-	public static function loginWithApache(\OCP\Authentication\IApacheBackend $backend) {
-
-		$uid = $backend->getCurrentUserId();
-		$run = true;
-		OC_Hook::emit("OC_User", "pre_login", array("run" => &$run, "uid" => $uid));
-
-		if ($uid) {
-			if (self::getUser() !== $uid) {
-				self::setUserId($uid);
-				self::setDisplayName($uid);
-				self::getUserSession()->setLoginName($uid);
-				// setup the filesystem
-				OC_Util::setupFS($uid);
-				// first call the post_login hooks, the login-process needs to be
-				// completed before we can safely create the users folder.
-				// For example encryption needs to initialize the users keys first
-				// before we can create the user folder with the skeleton files
-				OC_Hook::emit("OC_User", "post_login", array("uid" => $uid, 'password' => ''));
-				//trigger creation of user home and /files folder
-				\OC::$server->getUserFolder($uid);
-
-			}
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Verify with Apache whether user is authenticated.
-	 *
-	 * @return boolean|null
-	 *          true: authenticated
-	 *          false: not authenticated
-	 *          null: not handled / no backend available
-	 */
-	public static function handleApacheAuth() {
-		$backend = self::findFirstActiveUsedBackend();
-		if ($backend) {
-			OC_App::loadApps();
-
-			//setup extra user backends
-			self::setupBackends();
-			self::unsetMagicInCookie();
-
-			return self::loginWithApache($backend);
-		}
-
-		return null;
-	}
-
-
-	/**
-	 * Sets user id for session and triggers emit
-	 */
-	public static function setUserId($uid) {
-		$userSession = \OC::$server->getUserSession();
-		$userManager = \OC::$server->getUserManager();
-		if ($user = $userManager->get($uid)) {
-			$userSession->setUser($user);
-		} else {
-			\OC::$server->getSession()->set('user_id', $uid);
-		}
-	}
-
-	/**
-	 * Sets user display name for session
-	 *
-	 * @param string $uid
-	 * @param string $displayName
-	 * @return bool Whether the display name could get set
-	 */
-	public static function setDisplayName($uid, $displayName = null) {
-		if (is_null($displayName)) {
-			$displayName = $uid;
-		}
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->setDisplayName($displayName);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Logs the current user out and kills all the session data
-	 *
-	 * Logout, destroys session
-	 */
-	public static function logout() {
-		self::getUserSession()->logout();
-	}
-
-	/**
-	 * Tries to login the user with HTTP Basic Authentication
-	 */
-	public static function tryBasicAuthLogin() {
-		if (!empty($_SERVER['PHP_AUTH_USER']) && !empty($_SERVER['PHP_AUTH_PW'])) {
-			$result = \OC_User::login($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']);
-			if($result === true) {
-				/**
-				 * Add DAV authenticated. This should in an ideal world not be
-				 * necessary but the iOS App reads cookies from anywhere instead
-				 * only the DAV endpoint.
-				 * This makes sure that the cookies will be valid for the whole scope
-				 * @see https://github.com/owncloud/core/issues/22893
-				 */
-				\OC::$server->getSession()->set(
-					\OCA\DAV\Connector\Sabre\Auth::DAV_AUTHENTICATED,
-					\OC::$server->getUserSession()->getUser()->getUID()
-				);
-			}
-		}
-	}
-
-	/**
-	 * Check if the user is logged in, considers also the HTTP basic credentials
-	 *
-	 * @return bool
-	 */
-	public static function isLoggedIn() {
-		if (\OC::$server->getSession()->get('user_id') !== null && self::$incognitoMode === false) {
-			return self::userExists(\OC::$server->getSession()->get('user_id'));
-		}
-
-		return false;
-	}
-
-	/**
-	 * set incognito mode, e.g. if a user wants to open a public link
-	 *
-	 * @param bool $status
-	 */
-	public static function setIncognitoMode($status) {
-		self::$incognitoMode = $status;
-	}
-
-	/**
-	 * get incognito mode status
-	 *
-	 * @return bool
-	 */
-	public static function isIncognitoMode() {
-		return self::$incognitoMode;
-	}
-
-	/**
-	 * Supplies an attribute to the logout hyperlink. The default behaviour
-	 * is to return an href with '?logout=true' appended. However, it can
-	 * supply any attribute(s) which are valid for <a>.
-	 *
-	 * @return string with one or more HTML attributes.
-	 */
-	public static function getLogoutAttribute() {
-		$backend = self::findFirstActiveUsedBackend();
-		if ($backend) {
-			return $backend->getLogoutAttribute();
-		}
-
-		return 'href="' . link_to('', 'index.php') . '?logout=true&amp;requesttoken=' . urlencode(\OCP\Util::callRegister()) . '"';
-	}
-
-	/**
-	 * Check if the user is an admin user
-	 *
-	 * @param string $uid uid of the admin
-	 * @return bool
-	 */
-	public static function isAdminUser($uid) {
-		if (OC_Group::inGroup($uid, 'admin') && self::$incognitoMode === false) {
-			return true;
-		}
-		return false;
-	}
-
-
-	/**
-	 * get the user id of the user currently logged in.
-	 *
-	 * @return string|bool uid or false
-	 */
-	public static function getUser() {
-		$uid = \OC::$server->getSession() ? \OC::$server->getSession()->get('user_id') : null;
-		if (!is_null($uid) && self::$incognitoMode === false) {
-			return $uid;
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * get the display name of the user currently logged in.
-	 *
-	 * @param string $uid
-	 * @return string uid or false
-	 */
-	public static function getDisplayName($uid = null) {
-		if ($uid) {
-			$user = \OC::$server->getUserManager()->get($uid);
-			if ($user) {
-				return $user->getDisplayName();
-			} else {
-				return $uid;
-			}
-		} else {
-			$user = self::getUserSession()->getUser();
-			if ($user) {
-				return $user->getDisplayName();
-			} else {
-				return false;
-			}
-		}
-	}
-
-	/**
-	 * Autogenerate a password
-	 *
-	 * @return string
-	 *
-	 * generates a password
-	 */
-	public static function generatePassword() {
-		return \OC::$server->getSecureRandom()->generate(30);
-	}
-
-	/**
-	 * Set password
-	 *
-	 * @param string $uid The username
-	 * @param string $password The new password
-	 * @param string $recoveryPassword for the encryption app to reset encryption keys
-	 * @return bool
-	 *
-	 * Change the password of a user
-	 */
-	public static function setPassword($uid, $password, $recoveryPassword = null) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->setPassword($password, $recoveryPassword);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Check whether user can change his avatar
-	 *
-	 * @param string $uid The username
-	 * @return bool
-	 *
-	 * Check whether a specified user can change his avatar
-	 */
-	public static function canUserChangeAvatar($uid) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->canChangeAvatar();
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Check whether user can change his password
-	 *
-	 * @param string $uid The username
-	 * @return bool
-	 *
-	 * Check whether a specified user can change his password
-	 */
-	public static function canUserChangePassword($uid) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->canChangePassword();
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Check whether user can change his display name
-	 *
-	 * @param string $uid The username
-	 * @return bool
-	 *
-	 * Check whether a specified user can change his display name
-	 */
-	public static function canUserChangeDisplayName($uid) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->canChangeDisplayName();
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Check if the password is correct
-	 *
-	 * @param string $uid The username
-	 * @param string $password The password
-	 * @return string|false user id a string on success, false otherwise
-	 *
-	 * Check if the password is correct without logging in the user
-	 * returns the user id or false
-	 */
-	public static function checkPassword($uid, $password) {
-		$manager = \OC::$server->getUserManager();
-		$username = $manager->checkPassword($uid, $password);
-		if ($username !== false) {
-			return $username->getUID();
-		}
-		return false;
-	}
-
-	/**
-	 * @param string $uid The username
-	 * @return string
-	 *
-	 * returns the path to the users home directory
-	 * @deprecated Use \OC::$server->getUserManager->getHome()
-	 */
-	public static function getHome($uid) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->getHome();
-		} else {
-			return \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $uid;
-		}
-	}
-
-	/**
-	 * Get a list of all users
-	 *
-	 * @return array an array of all uids
-	 *
-	 * Get a list of all users.
-	 * @param string $search
-	 * @param integer $limit
-	 * @param integer $offset
-	 */
-	public static function getUsers($search = '', $limit = null, $offset = null) {
-		$users = \OC::$server->getUserManager()->search($search, $limit, $offset);
-		$uids = array();
-		foreach ($users as $user) {
-			$uids[] = $user->getUID();
-		}
-		return $uids;
-	}
-
-	/**
-	 * Get a list of all users display name
-	 *
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array associative array with all display names (value) and corresponding uids (key)
-	 *
-	 * Get a list of all display names and user ids.
-	 * @deprecated Use \OC::$server->getUserManager->searchDisplayName($search, $limit, $offset) instead.
-	 */
-	public static function getDisplayNames($search = '', $limit = null, $offset = null) {
-		$displayNames = array();
-		$users = \OC::$server->getUserManager()->searchDisplayName($search, $limit, $offset);
-		foreach ($users as $user) {
-			$displayNames[$user->getUID()] = $user->getDisplayName();
-		}
-		return $displayNames;
-	}
-
-	/**
-	 * check if a user exists
-	 *
-	 * @param string $uid the username
-	 * @return boolean
-	 */
-	public static function userExists($uid) {
-		return \OC::$server->getUserManager()->userExists($uid);
-	}
-
-	/**
-	 * disables a user
-	 *
-	 * @param string $uid the user to disable
-	 */
-	public static function disableUser($uid) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			$user->setEnabled(false);
-		}
-	}
-
-	/**
-	 * enable a user
-	 *
-	 * @param string $uid
-	 */
-	public static function enableUser($uid) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			$user->setEnabled(true);
-		}
-	}
-
-	/**
-	 * checks if a user is enabled
-	 *
-	 * @param string $uid
-	 * @return bool
-	 */
-	public static function isEnabled($uid) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->isEnabled();
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Set cookie value to use in next page load
-	 *
-	 * @param string $username username to be set
-	 * @param string $token
-	 */
-	public static function setMagicInCookie($username, $token) {
-		self::getUserSession()->setMagicInCookie($username, $token);
-	}
-
-	/**
-	 * Remove cookie for "remember username"
-	 */
-	public static function unsetMagicInCookie() {
-		self::getUserSession()->unsetMagicInCookie();
-	}
-
-	/**
-	 * Returns the first active backend from self::$_usedBackends.
-	 *
-	 * @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
-	 */
-	private static function findFirstActiveUsedBackend() {
-		foreach (self::$_usedBackends as $backend) {
-			if ($backend instanceof OCP\Authentication\IApacheBackend) {
-				if ($backend->isSessionActive()) {
-					return $backend;
-				}
-			}
-		}
-
-		return null;
-	}
+    /**
+     * @return \OC\User\Session
+     */
+    public static function getUserSession() {
+        return OC::$server->getUserSession();
+    }
+
+    private static $_backends = array();
+
+    private static $_usedBackends = array();
+
+    private static $_setupedBackends = array();
+
+    // bool, stores if a user want to access a resource anonymously, e.g if he opens a public link
+    private static $incognitoMode = false;
+
+    /**
+     * Adds the backend to the list of used backends
+     *
+     * @param string|\OCP\UserInterface $backend default: database The backend to use for user management
+     * @return bool
+     *
+     * Set the User Authentication Module
+     */
+    public static function useBackend($backend = 'database') {
+        if ($backend instanceof \OCP\UserInterface) {
+            self::$_usedBackends[get_class($backend)] = $backend;
+            \OC::$server->getUserManager()->registerBackend($backend);
+        } else {
+            // You'll never know what happens
+            if (null === $backend OR !is_string($backend)) {
+                $backend = 'database';
+            }
+
+            // Load backend
+            switch ($backend) {
+                case 'database':
+                case 'mysql':
+                case 'sqlite':
+                    \OCP\Util::writeLog('core', 'Adding user backend ' . $backend . '.', \OCP\Util::DEBUG);
+                    self::$_usedBackends[$backend] = new OC_User_Database();
+                    \OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
+                    break;
+                case 'dummy':
+                    self::$_usedBackends[$backend] = new \Test\Util\User\Dummy();
+                    \OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
+                    break;
+                default:
+                    \OCP\Util::writeLog('core', 'Adding default user backend ' . $backend . '.', \OCP\Util::DEBUG);
+                    $className = 'OC_USER_' . strToUpper($backend);
+                    self::$_usedBackends[$backend] = new $className();
+                    \OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
+                    break;
+            }
+        }
+        return true;
+    }
+
+    /**
+     * remove all used backends
+     */
+    public static function clearBackends() {
+        self::$_usedBackends = array();
+        \OC::$server->getUserManager()->clearBackends();
+    }
+
+    /**
+     * setup the configured backends in config.php
+     */
+    public static function setupBackends() {
+        OC_App::loadApps(array('prelogin'));
+        $backends = \OC::$server->getSystemConfig()->getValue('user_backends', array());
+        foreach ($backends as $i => $config) {
+            $class = $config['class'];
+            $arguments = $config['arguments'];
+            if (class_exists($class)) {
+                if (array_search($i, self::$_setupedBackends) === false) {
+                    // make a reflection object
+                    $reflectionObj = new ReflectionClass($class);
+
+                    // use Reflection to create a new instance, using the $args
+                    $backend = $reflectionObj->newInstanceArgs($arguments);
+                    self::useBackend($backend);
+                    self::$_setupedBackends[] = $i;
+                } else {
+                    \OCP\Util::writeLog('core', 'User backend ' . $class . ' already initialized.', \OCP\Util::DEBUG);
+                }
+            } else {
+                \OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', \OCP\Util::ERROR);
+            }
+        }
+    }
+
+    /**
+     * Try to login a user
+     *
+     * @param string $loginname The login name of the user to log in
+     * @param string $password The password of the user
+     * @return boolean|null
+     *
+     * Log in a user and regenerate a new session - if the password is ok
+     */
+    public static function login($loginname, $password) {
+        $result = self::getUserSession()->login($loginname, $password);
+        if ($result) {
+            // Refresh the token
+            \OC::$server->getCsrfTokenManager()->refreshToken();
+            //we need to pass the user name, which may differ from login name
+            $user = self::getUserSession()->getUser()->getUID();
+            OC_Util::setupFS($user);
+            //trigger creation of user home and /files folder
+            \OC::$server->getUserFolder($user);
+        }
+        return $result;
+    }
+
+    /**
+     * Try to login a user using the magic cookie (remember login)
+     *
+     * @param string $uid The username of the user to log in
+     * @param string $token
+     * @return bool
+     */
+    public static function loginWithCookie($uid, $token) {
+        return self::getUserSession()->loginWithCookie($uid, $token);
+    }
+
+    /**
+     * Try to login a user, assuming authentication
+     * has already happened (e.g. via Single Sign On).
+     *
+     * Log in a user and regenerate a new session.
+     *
+     * @param \OCP\Authentication\IApacheBackend $backend
+     * @return bool
+     */
+    public static function loginWithApache(\OCP\Authentication\IApacheBackend $backend) {
+
+        $uid = $backend->getCurrentUserId();
+        $run = true;
+        OC_Hook::emit("OC_User", "pre_login", array("run" => &$run, "uid" => $uid));
+
+        if ($uid) {
+            if (self::getUser() !== $uid) {
+                self::setUserId($uid);
+                self::setDisplayName($uid);
+                self::getUserSession()->setLoginName($uid);
+                // setup the filesystem
+                OC_Util::setupFS($uid);
+                // first call the post_login hooks, the login-process needs to be
+                // completed before we can safely create the users folder.
+                // For example encryption needs to initialize the users keys first
+                // before we can create the user folder with the skeleton files
+                OC_Hook::emit("OC_User", "post_login", array("uid" => $uid, 'password' => ''));
+                //trigger creation of user home and /files folder
+                \OC::$server->getUserFolder($uid);
+
+            }
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Verify with Apache whether user is authenticated.
+     *
+     * @return boolean|null
+     *          true: authenticated
+     *          false: not authenticated
+     *          null: not handled / no backend available
+     */
+    public static function handleApacheAuth() {
+        $backend = self::findFirstActiveUsedBackend();
+        if ($backend) {
+            OC_App::loadApps();
+
+            //setup extra user backends
+            self::setupBackends();
+            self::unsetMagicInCookie();
+
+            return self::loginWithApache($backend);
+        }
+
+        return null;
+    }
+
+
+    /**
+     * Sets user id for session and triggers emit
+     */
+    public static function setUserId($uid) {
+        $userSession = \OC::$server->getUserSession();
+        $userManager = \OC::$server->getUserManager();
+        if ($user = $userManager->get($uid)) {
+            $userSession->setUser($user);
+        } else {
+            \OC::$server->getSession()->set('user_id', $uid);
+        }
+    }
+
+    /**
+     * Sets user display name for session
+     *
+     * @param string $uid
+     * @param string $displayName
+     * @return bool Whether the display name could get set
+     */
+    public static function setDisplayName($uid, $displayName = null) {
+        if (is_null($displayName)) {
+            $displayName = $uid;
+        }
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->setDisplayName($displayName);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Logs the current user out and kills all the session data
+     *
+     * Logout, destroys session
+     */
+    public static function logout() {
+        self::getUserSession()->logout();
+    }
+
+    /**
+     * Tries to login the user with HTTP Basic Authentication
+     */
+    public static function tryBasicAuthLogin() {
+        if (!empty($_SERVER['PHP_AUTH_USER']) && !empty($_SERVER['PHP_AUTH_PW'])) {
+            $result = \OC_User::login($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']);
+            if($result === true) {
+                /**
+                 * Add DAV authenticated. This should in an ideal world not be
+                 * necessary but the iOS App reads cookies from anywhere instead
+                 * only the DAV endpoint.
+                 * This makes sure that the cookies will be valid for the whole scope
+                 * @see https://github.com/owncloud/core/issues/22893
+                 */
+                \OC::$server->getSession()->set(
+                    \OCA\DAV\Connector\Sabre\Auth::DAV_AUTHENTICATED,
+                    \OC::$server->getUserSession()->getUser()->getUID()
+                );
+            }
+        }
+    }
+
+    /**
+     * Check if the user is logged in, considers also the HTTP basic credentials
+     *
+     * @return bool
+     */
+    public static function isLoggedIn() {
+        if (\OC::$server->getSession()->get('user_id') !== null && self::$incognitoMode === false) {
+            return self::userExists(\OC::$server->getSession()->get('user_id'));
+        }
+
+        return false;
+    }
+
+    /**
+     * set incognito mode, e.g. if a user wants to open a public link
+     *
+     * @param bool $status
+     */
+    public static function setIncognitoMode($status) {
+        self::$incognitoMode = $status;
+    }
+
+    /**
+     * get incognito mode status
+     *
+     * @return bool
+     */
+    public static function isIncognitoMode() {
+        return self::$incognitoMode;
+    }
+
+    /**
+     * Supplies an attribute to the logout hyperlink. The default behaviour
+     * is to return an href with '?logout=true' appended. However, it can
+     * supply any attribute(s) which are valid for <a>.
+     *
+     * @return string with one or more HTML attributes.
+     */
+    public static function getLogoutAttribute() {
+        $backend = self::findFirstActiveUsedBackend();
+        if ($backend) {
+            return $backend->getLogoutAttribute();
+        }
+
+        return 'href="' . link_to('', 'index.php') . '?logout=true&amp;requesttoken=' . urlencode(\OCP\Util::callRegister()) . '"';
+    }
+
+    /**
+     * Check if the user is an admin user
+     *
+     * @param string $uid uid of the admin
+     * @return bool
+     */
+    public static function isAdminUser($uid) {
+        if (OC_Group::inGroup($uid, 'admin') && self::$incognitoMode === false) {
+            return true;
+        }
+        return false;
+    }
+
+
+    /**
+     * get the user id of the user currently logged in.
+     *
+     * @return string|bool uid or false
+     */
+    public static function getUser() {
+        $uid = \OC::$server->getSession() ? \OC::$server->getSession()->get('user_id') : null;
+        if (!is_null($uid) && self::$incognitoMode === false) {
+            return $uid;
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * get the display name of the user currently logged in.
+     *
+     * @param string $uid
+     * @return string uid or false
+     */
+    public static function getDisplayName($uid = null) {
+        if ($uid) {
+            $user = \OC::$server->getUserManager()->get($uid);
+            if ($user) {
+                return $user->getDisplayName();
+            } else {
+                return $uid;
+            }
+        } else {
+            $user = self::getUserSession()->getUser();
+            if ($user) {
+                return $user->getDisplayName();
+            } else {
+                return false;
+            }
+        }
+    }
+
+    /**
+     * Autogenerate a password
+     *
+     * @return string
+     *
+     * generates a password
+     */
+    public static function generatePassword() {
+        return \OC::$server->getSecureRandom()->generate(30);
+    }
+
+    /**
+     * Set password
+     *
+     * @param string $uid The username
+     * @param string $password The new password
+     * @param string $recoveryPassword for the encryption app to reset encryption keys
+     * @return bool
+     *
+     * Change the password of a user
+     */
+    public static function setPassword($uid, $password, $recoveryPassword = null) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->setPassword($password, $recoveryPassword);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Check whether user can change his avatar
+     *
+     * @param string $uid The username
+     * @return bool
+     *
+     * Check whether a specified user can change his avatar
+     */
+    public static function canUserChangeAvatar($uid) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->canChangeAvatar();
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Check whether user can change his password
+     *
+     * @param string $uid The username
+     * @return bool
+     *
+     * Check whether a specified user can change his password
+     */
+    public static function canUserChangePassword($uid) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->canChangePassword();
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Check whether user can change his display name
+     *
+     * @param string $uid The username
+     * @return bool
+     *
+     * Check whether a specified user can change his display name
+     */
+    public static function canUserChangeDisplayName($uid) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->canChangeDisplayName();
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Check if the password is correct
+     *
+     * @param string $uid The username
+     * @param string $password The password
+     * @return string|false user id a string on success, false otherwise
+     *
+     * Check if the password is correct without logging in the user
+     * returns the user id or false
+     */
+    public static function checkPassword($uid, $password) {
+        $manager = \OC::$server->getUserManager();
+        $username = $manager->checkPassword($uid, $password);
+        if ($username !== false) {
+            return $username->getUID();
+        }
+        return false;
+    }
+
+    /**
+     * @param string $uid The username
+     * @return string
+     *
+     * returns the path to the users home directory
+     * @deprecated Use \OC::$server->getUserManager->getHome()
+     */
+    public static function getHome($uid) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->getHome();
+        } else {
+            return \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $uid;
+        }
+    }
+
+    /**
+     * Get a list of all users
+     *
+     * @return array an array of all uids
+     *
+     * Get a list of all users.
+     * @param string $search
+     * @param integer $limit
+     * @param integer $offset
+     */
+    public static function getUsers($search = '', $limit = null, $offset = null) {
+        $users = \OC::$server->getUserManager()->search($search, $limit, $offset);
+        $uids = array();
+        foreach ($users as $user) {
+            $uids[] = $user->getUID();
+        }
+        return $uids;
+    }
+
+    /**
+     * Get a list of all users display name
+     *
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array associative array with all display names (value) and corresponding uids (key)
+     *
+     * Get a list of all display names and user ids.
+     * @deprecated Use \OC::$server->getUserManager->searchDisplayName($search, $limit, $offset) instead.
+     */
+    public static function getDisplayNames($search = '', $limit = null, $offset = null) {
+        $displayNames = array();
+        $users = \OC::$server->getUserManager()->searchDisplayName($search, $limit, $offset);
+        foreach ($users as $user) {
+            $displayNames[$user->getUID()] = $user->getDisplayName();
+        }
+        return $displayNames;
+    }
+
+    /**
+     * check if a user exists
+     *
+     * @param string $uid the username
+     * @return boolean
+     */
+    public static function userExists($uid) {
+        return \OC::$server->getUserManager()->userExists($uid);
+    }
+
+    /**
+     * disables a user
+     *
+     * @param string $uid the user to disable
+     */
+    public static function disableUser($uid) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            $user->setEnabled(false);
+        }
+    }
+
+    /**
+     * enable a user
+     *
+     * @param string $uid
+     */
+    public static function enableUser($uid) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            $user->setEnabled(true);
+        }
+    }
+
+    /**
+     * checks if a user is enabled
+     *
+     * @param string $uid
+     * @return bool
+     */
+    public static function isEnabled($uid) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->isEnabled();
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Set cookie value to use in next page load
+     *
+     * @param string $username username to be set
+     * @param string $token
+     */
+    public static function setMagicInCookie($username, $token) {
+        self::getUserSession()->setMagicInCookie($username, $token);
+    }
+
+    /**
+     * Remove cookie for "remember username"
+     */
+    public static function unsetMagicInCookie() {
+        self::getUserSession()->unsetMagicInCookie();
+    }
+
+    /**
+     * Returns the first active backend from self::$_usedBackends.
+     *
+     * @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
+     */
+    private static function findFirstActiveUsedBackend() {
+        foreach (self::$_usedBackends as $backend) {
+            if ($backend instanceof OCP\Authentication\IApacheBackend) {
+                if ($backend->isSessionActive()) {
+                    return $backend;
+                }
+            }
+        }
+
+        return null;
+    }
 }

Spacing +8 added lines, -8 removed lines

@@ -96,7 +96,7 @@ 
 				case 'database':
 				case 'mysql':
 				case 'sqlite':
-					\OCP\Util::writeLog('core', 'Adding user backend ' . $backend . '.', \OCP\Util::DEBUG);
+					\OCP\Util::writeLog('core', 'Adding user backend '.$backend.'.', \OCP\Util::DEBUG);
 					self::$_usedBackends[$backend] = new OC_User_Database();
 					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
 					break;
@@ -105,8 +105,8 @@ 
 					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
 					break;
 				default:
-					\OCP\Util::writeLog('core', 'Adding default user backend ' . $backend . '.', \OCP\Util::DEBUG);
-					$className = 'OC_USER_' . strToUpper($backend);
+					\OCP\Util::writeLog('core', 'Adding default user backend '.$backend.'.', \OCP\Util::DEBUG);
+					$className = 'OC_USER_'.strToUpper($backend);
 					self::$_usedBackends[$backend] = new $className();
 					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
 					break;
@@ -142,10 +142,10 @@ 
 					self::useBackend($backend);
 					self::$_setupedBackends[] = $i;
 				} else {
-					\OCP\Util::writeLog('core', 'User backend ' . $class . ' already initialized.', \OCP\Util::DEBUG);
+					\OCP\Util::writeLog('core', 'User backend '.$class.' already initialized.', \OCP\Util::DEBUG);
 				}
 			} else {
-				\OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', 'User backend '.$class.' not found.', \OCP\Util::ERROR);
 			}
 		}
 	}
@@ -291,7 +291,7 @@ 
 	public static function tryBasicAuthLogin() {
 		if (!empty($_SERVER['PHP_AUTH_USER']) && !empty($_SERVER['PHP_AUTH_PW'])) {
 			$result = \OC_User::login($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']);
-			if($result === true) {
+			if ($result === true) {
 				/**
 				 * Add DAV authenticated. This should in an ideal world not be
 				 * necessary but the iOS App reads cookies from anywhere instead
@@ -351,7 +351,7 @@ 
 			return $backend->getLogoutAttribute();
 		}
 
-		return 'href="' . link_to('', 'index.php') . '?logout=true&requesttoken=' . urlencode(\OCP\Util::callRegister()) . '"';
+		return 'href="'.link_to('', 'index.php').'?logout=true&requesttoken='.urlencode(\OCP\Util::callRegister()).'"';
 	}
 
 	/**
@@ -518,7 +518,7 @@ 
 		if ($user) {
 			return $user->getHome();
 		} else {
-			return \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $uid;
+			return \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT.'/data').'/'.$uid;
 		}
 	}
 

lib/private/user/session.php

Doc Comments +1 added lines, -1 removed lines

@@ -143,7 +143,7 @@
 	/**
 	 * get the current active user
 	 *
-	 * @return \OCP\IUser|null Current user, otherwise null
+	 * @return null|User Current user, otherwise null
 	 */
 	public function getUser() {
 		// FIXME: This is a quick'n dirty work-around for the incognito mode as

Indentation +241 added lines, -241 removed lines

@@ -54,266 +54,266 @@
  * @package OC\User
  */
 class Session implements IUserSession, Emitter {
-	/**
-	 * @var \OC\User\Manager $manager
-	 */
-	private $manager;
+    /**
+     * @var \OC\User\Manager $manager
+     */
+    private $manager;
 
-	/**
-	 * @var \OC\Session\Session $session
-	 */
-	private $session;
+    /**
+     * @var \OC\Session\Session $session
+     */
+    private $session;
 
-	/**
-	 * @var \OC\User\User $activeUser
-	 */
-	protected $activeUser;
+    /**
+     * @var \OC\User\User $activeUser
+     */
+    protected $activeUser;
 
-	/**
-	 * @param \OCP\IUserManager $manager
-	 * @param \OCP\ISession $session
-	 */
-	public function __construct(\OCP\IUserManager $manager, \OCP\ISession $session) {
-		$this->manager = $manager;
-		$this->session = $session;
-	}
+    /**
+     * @param \OCP\IUserManager $manager
+     * @param \OCP\ISession $session
+     */
+    public function __construct(\OCP\IUserManager $manager, \OCP\ISession $session) {
+        $this->manager = $manager;
+        $this->session = $session;
+    }
 
-	/**
-	 * @param string $scope
-	 * @param string $method
-	 * @param callable $callback
-	 */
-	public function listen($scope, $method, callable $callback) {
-		$this->manager->listen($scope, $method, $callback);
-	}
+    /**
+     * @param string $scope
+     * @param string $method
+     * @param callable $callback
+     */
+    public function listen($scope, $method, callable $callback) {
+        $this->manager->listen($scope, $method, $callback);
+    }
 
-	/**
-	 * @param string $scope optional
-	 * @param string $method optional
-	 * @param callable $callback optional
-	 */
-	public function removeListener($scope = null, $method = null, callable $callback = null) {
-		$this->manager->removeListener($scope, $method, $callback);
-	}
+    /**
+     * @param string $scope optional
+     * @param string $method optional
+     * @param callable $callback optional
+     */
+    public function removeListener($scope = null, $method = null, callable $callback = null) {
+        $this->manager->removeListener($scope, $method, $callback);
+    }
 
-	/**
-	 * get the manager object
-	 *
-	 * @return \OC\User\Manager
-	 */
-	public function getManager() {
-		return $this->manager;
-	}
+    /**
+     * get the manager object
+     *
+     * @return \OC\User\Manager
+     */
+    public function getManager() {
+        return $this->manager;
+    }
 
-	/**
-	 * get the session object
-	 *
-	 * @return \OCP\ISession
-	 */
-	public function getSession() {
-		return $this->session;
-	}
+    /**
+     * get the session object
+     *
+     * @return \OCP\ISession
+     */
+    public function getSession() {
+        return $this->session;
+    }
 
-	/**
-	 * set the session object
-	 *
-	 * @param \OCP\ISession $session
-	 */
-	public function setSession(\OCP\ISession $session) {
-		if ($this->session instanceof \OCP\ISession) {
-			$this->session->close();
-		}
-		$this->session = $session;
-		$this->activeUser = null;
-	}
+    /**
+     * set the session object
+     *
+     * @param \OCP\ISession $session
+     */
+    public function setSession(\OCP\ISession $session) {
+        if ($this->session instanceof \OCP\ISession) {
+            $this->session->close();
+        }
+        $this->session = $session;
+        $this->activeUser = null;
+    }
 
-	/**
-	 * set the currently active user
-	 *
-	 * @param \OC\User\User|null $user
-	 */
-	public function setUser($user) {
-		if (is_null($user)) {
-			$this->session->remove('user_id');
-		} else {
-			$this->session->set('user_id', $user->getUID());
-		}
-		$this->activeUser = $user;
-	}
+    /**
+     * set the currently active user
+     *
+     * @param \OC\User\User|null $user
+     */
+    public function setUser($user) {
+        if (is_null($user)) {
+            $this->session->remove('user_id');
+        } else {
+            $this->session->set('user_id', $user->getUID());
+        }
+        $this->activeUser = $user;
+    }
 
-	/**
-	 * get the current active user
-	 *
-	 * @return \OCP\IUser|null Current user, otherwise null
-	 */
-	public function getUser() {
-		// FIXME: This is a quick'n dirty work-around for the incognito mode as
-		// described at https://github.com/owncloud/core/pull/12912#issuecomment-67391155
-		if (\OC_User::isIncognitoMode()) {
-			return null;
-		}
-		if ($this->activeUser) {
-			return $this->activeUser;
-		} else {
-			$uid = $this->session->get('user_id');
-			if ($uid !== null) {
-				$this->activeUser = $this->manager->get($uid);
-				return $this->activeUser;
-			} else {
-				return null;
-			}
-		}
-	}
+    /**
+     * get the current active user
+     *
+     * @return \OCP\IUser|null Current user, otherwise null
+     */
+    public function getUser() {
+        // FIXME: This is a quick'n dirty work-around for the incognito mode as
+        // described at https://github.com/owncloud/core/pull/12912#issuecomment-67391155
+        if (\OC_User::isIncognitoMode()) {
+            return null;
+        }
+        if ($this->activeUser) {
+            return $this->activeUser;
+        } else {
+            $uid = $this->session->get('user_id');
+            if ($uid !== null) {
+                $this->activeUser = $this->manager->get($uid);
+                return $this->activeUser;
+            } else {
+                return null;
+            }
+        }
+    }
 
-	/**
-	 * Checks whether the user is logged in
-	 *
-	 * @return bool if logged in
-	 */
-	public function isLoggedIn() {
-		return $this->getUser() !== null;
-	}
+    /**
+     * Checks whether the user is logged in
+     *
+     * @return bool if logged in
+     */
+    public function isLoggedIn() {
+        return $this->getUser() !== null;
+    }
 
-	/**
-	 * set the login name
-	 *
-	 * @param string|null $loginName for the logged in user
-	 */
-	public function setLoginName($loginName) {
-		if (is_null($loginName)) {
-			$this->session->remove('loginname');
-		} else {
-			$this->session->set('loginname', $loginName);
-		}
-	}
+    /**
+     * set the login name
+     *
+     * @param string|null $loginName for the logged in user
+     */
+    public function setLoginName($loginName) {
+        if (is_null($loginName)) {
+            $this->session->remove('loginname');
+        } else {
+            $this->session->set('loginname', $loginName);
+        }
+    }
 
-	/**
-	 * get the login name of the current user
-	 *
-	 * @return string
-	 */
-	public function getLoginName() {
-		if ($this->activeUser) {
-			return $this->session->get('loginname');
-		} else {
-			$uid = $this->session->get('user_id');
-			if ($uid) {
-				$this->activeUser = $this->manager->get($uid);
-				return $this->session->get('loginname');
-			} else {
-				return null;
-			}
-		}
-	}
+    /**
+     * get the login name of the current user
+     *
+     * @return string
+     */
+    public function getLoginName() {
+        if ($this->activeUser) {
+            return $this->session->get('loginname');
+        } else {
+            $uid = $this->session->get('user_id');
+            if ($uid) {
+                $this->activeUser = $this->manager->get($uid);
+                return $this->session->get('loginname');
+            } else {
+                return null;
+            }
+        }
+    }
 
-	/**
-	 * try to login with the provided credentials
-	 *
-	 * @param string $uid
-	 * @param string $password
-	 * @return boolean|null
-	 * @throws LoginException
-	 */
-	public function login($uid, $password) {
-		$this->session->regenerateId();
-		$this->manager->emit('\OC\User', 'preLogin', array($uid, $password));
-		$user = $this->manager->checkPassword($uid, $password);
-		if ($user !== false) {
-			if (!is_null($user)) {
-				if ($user->isEnabled()) {
-					$this->setUser($user);
-					$this->setLoginName($uid);
-					$this->manager->emit('\OC\User', 'postLogin', array($user, $password));
-					if ($this->isLoggedIn()) {
-						return true;
-					} else {
-						throw new LoginException('Login canceled by app');
-					}
-				} else {
-					return false;
-				}
-			}
-		} else {
-			return false;
-		}
-	}
+    /**
+     * try to login with the provided credentials
+     *
+     * @param string $uid
+     * @param string $password
+     * @return boolean|null
+     * @throws LoginException
+     */
+    public function login($uid, $password) {
+        $this->session->regenerateId();
+        $this->manager->emit('\OC\User', 'preLogin', array($uid, $password));
+        $user = $this->manager->checkPassword($uid, $password);
+        if ($user !== false) {
+            if (!is_null($user)) {
+                if ($user->isEnabled()) {
+                    $this->setUser($user);
+                    $this->setLoginName($uid);
+                    $this->manager->emit('\OC\User', 'postLogin', array($user, $password));
+                    if ($this->isLoggedIn()) {
+                        return true;
+                    } else {
+                        throw new LoginException('Login canceled by app');
+                    }
+                } else {
+                    return false;
+                }
+            }
+        } else {
+            return false;
+        }
+    }
 
-	/**
-	 * perform login using the magic cookie (remember login)
-	 *
-	 * @param string $uid the username
-	 * @param string $currentToken
-	 * @return bool
-	 */
-	public function loginWithCookie($uid, $currentToken) {
-		$this->session->regenerateId();
-		$this->manager->emit('\OC\User', 'preRememberedLogin', array($uid));
-		$user = $this->manager->get($uid);
-		if (is_null($user)) {
-			// user does not exist
-			return false;
-		}
+    /**
+     * perform login using the magic cookie (remember login)
+     *
+     * @param string $uid the username
+     * @param string $currentToken
+     * @return bool
+     */
+    public function loginWithCookie($uid, $currentToken) {
+        $this->session->regenerateId();
+        $this->manager->emit('\OC\User', 'preRememberedLogin', array($uid));
+        $user = $this->manager->get($uid);
+        if (is_null($user)) {
+            // user does not exist
+            return false;
+        }
 
-		// get stored tokens
-		$tokens = \OC::$server->getConfig()->getUserKeys($uid, 'login_token');
-		// test cookies token against stored tokens
-		if (!in_array($currentToken, $tokens, true)) {
-			return false;
-		}
-		// replace successfully used token with a new one
-		\OC::$server->getConfig()->deleteUserValue($uid, 'login_token', $currentToken);
-		$newToken = \OC::$server->getSecureRandom()->generate(32);
-		\OC::$server->getConfig()->setUserValue($uid, 'login_token', $newToken, time());
-		$this->setMagicInCookie($user->getUID(), $newToken);
+        // get stored tokens
+        $tokens = \OC::$server->getConfig()->getUserKeys($uid, 'login_token');
+        // test cookies token against stored tokens
+        if (!in_array($currentToken, $tokens, true)) {
+            return false;
+        }
+        // replace successfully used token with a new one
+        \OC::$server->getConfig()->deleteUserValue($uid, 'login_token', $currentToken);
+        $newToken = \OC::$server->getSecureRandom()->generate(32);
+        \OC::$server->getConfig()->setUserValue($uid, 'login_token', $newToken, time());
+        $this->setMagicInCookie($user->getUID(), $newToken);
 
-		//login
-		$this->setUser($user);
-		$this->manager->emit('\OC\User', 'postRememberedLogin', array($user));
-		return true;
-	}
+        //login
+        $this->setUser($user);
+        $this->manager->emit('\OC\User', 'postRememberedLogin', array($user));
+        return true;
+    }
 
-	/**
-	 * logout the user from the session
-	 */
-	public function logout() {
-		$this->manager->emit('\OC\User', 'logout');
-		$this->setUser(null);
-		$this->setLoginName(null);
-		$this->unsetMagicInCookie();
-		$this->session->clear();
-	}
+    /**
+     * logout the user from the session
+     */
+    public function logout() {
+        $this->manager->emit('\OC\User', 'logout');
+        $this->setUser(null);
+        $this->setLoginName(null);
+        $this->unsetMagicInCookie();
+        $this->session->clear();
+    }
 
-	/**
-	 * Set cookie value to use in next page load
-	 *
-	 * @param string $username username to be set
-	 * @param string $token
-	 */
-	public function setMagicInCookie($username, $token) {
-		$secureCookie = \OC::$server->getRequest()->getServerProtocol() === 'https';
-		$expires = time() + \OC::$server->getConfig()->getSystemValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15);
-		setcookie("oc_username", $username, $expires, \OC::$WEBROOT, '', $secureCookie, true);
-		setcookie("oc_token", $token, $expires, \OC::$WEBROOT, '', $secureCookie, true);
-		setcookie("oc_remember_login", "1", $expires, \OC::$WEBROOT, '', $secureCookie, true);
-	}
+    /**
+     * Set cookie value to use in next page load
+     *
+     * @param string $username username to be set
+     * @param string $token
+     */
+    public function setMagicInCookie($username, $token) {
+        $secureCookie = \OC::$server->getRequest()->getServerProtocol() === 'https';
+        $expires = time() + \OC::$server->getConfig()->getSystemValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15);
+        setcookie("oc_username", $username, $expires, \OC::$WEBROOT, '', $secureCookie, true);
+        setcookie("oc_token", $token, $expires, \OC::$WEBROOT, '', $secureCookie, true);
+        setcookie("oc_remember_login", "1", $expires, \OC::$WEBROOT, '', $secureCookie, true);
+    }
 
-	/**
-	 * Remove cookie for "remember username"
-	 */
-	public function unsetMagicInCookie() {
-		//TODO: DI for cookies and IRequest
-		$secureCookie = \OC::$server->getRequest()->getServerProtocol() === 'https';
+    /**
+     * Remove cookie for "remember username"
+     */
+    public function unsetMagicInCookie() {
+        //TODO: DI for cookies and IRequest
+        $secureCookie = \OC::$server->getRequest()->getServerProtocol() === 'https';
 
-		unset($_COOKIE["oc_username"]); //TODO: DI
-		unset($_COOKIE["oc_token"]);
-		unset($_COOKIE["oc_remember_login"]);
-		setcookie('oc_username', '', time() - 3600, \OC::$WEBROOT, '',$secureCookie, true);
-		setcookie('oc_token', '', time() - 3600, \OC::$WEBROOT, '', $secureCookie, true);
-		setcookie('oc_remember_login', '', time() - 3600, \OC::$WEBROOT, '', $secureCookie, true);
-		// old cookies might be stored under /webroot/ instead of /webroot
-		// and Firefox doesn't like it!
-		setcookie('oc_username', '', time() - 3600, \OC::$WEBROOT . '/', '', $secureCookie, true);
-		setcookie('oc_token', '', time() - 3600, \OC::$WEBROOT . '/', '', $secureCookie, true);
-		setcookie('oc_remember_login', '', time() - 3600, \OC::$WEBROOT . '/', '', $secureCookie, true);
-	}
+        unset($_COOKIE["oc_username"]); //TODO: DI
+        unset($_COOKIE["oc_token"]);
+        unset($_COOKIE["oc_remember_login"]);
+        setcookie('oc_username', '', time() - 3600, \OC::$WEBROOT, '',$secureCookie, true);
+        setcookie('oc_token', '', time() - 3600, \OC::$WEBROOT, '', $secureCookie, true);
+        setcookie('oc_remember_login', '', time() - 3600, \OC::$WEBROOT, '', $secureCookie, true);
+        // old cookies might be stored under /webroot/ instead of /webroot
+        // and Firefox doesn't like it!
+        setcookie('oc_username', '', time() - 3600, \OC::$WEBROOT . '/', '', $secureCookie, true);
+        setcookie('oc_token', '', time() - 3600, \OC::$WEBROOT . '/', '', $secureCookie, true);
+        setcookie('oc_remember_login', '', time() - 3600, \OC::$WEBROOT . '/', '', $secureCookie, true);
+    }
 }

Spacing +4 added lines, -4 removed lines

@@ -307,13 +307,13 @@
 		unset($_COOKIE["oc_username"]); //TODO: DI
 		unset($_COOKIE["oc_token"]);
 		unset($_COOKIE["oc_remember_login"]);
-		setcookie('oc_username', '', time() - 3600, \OC::$WEBROOT, '',$secureCookie, true);
+		setcookie('oc_username', '', time() - 3600, \OC::$WEBROOT, '', $secureCookie, true);
 		setcookie('oc_token', '', time() - 3600, \OC::$WEBROOT, '', $secureCookie, true);
 		setcookie('oc_remember_login', '', time() - 3600, \OC::$WEBROOT, '', $secureCookie, true);
 		// old cookies might be stored under /webroot/ instead of /webroot
 		// and Firefox doesn't like it!
-		setcookie('oc_username', '', time() - 3600, \OC::$WEBROOT . '/', '', $secureCookie, true);
-		setcookie('oc_token', '', time() - 3600, \OC::$WEBROOT . '/', '', $secureCookie, true);
-		setcookie('oc_remember_login', '', time() - 3600, \OC::$WEBROOT . '/', '', $secureCookie, true);
+		setcookie('oc_username', '', time() - 3600, \OC::$WEBROOT.'/', '', $secureCookie, true);
+		setcookie('oc_token', '', time() - 3600, \OC::$WEBROOT.'/', '', $secureCookie, true);
+		setcookie('oc_remember_login', '', time() - 3600, \OC::$WEBROOT.'/', '', $secureCookie, true);
 	}
 }

lib/public/app/managerevent.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 	 * DispatcherEvent constructor.
 	 *
 	 * @param string $event
-	 * @param $appID
+	 * @param string $appID
 	 * @param \OCP\IGroup[] $groups
 	 * @since 9.0.0
 	 */

Indentation +47 added lines, -47 removed lines

@@ -32,56 +32,56 @@
  */
 class ManagerEvent extends Event {
 
-	const EVENT_APP_ENABLE = 'OCP\App\IAppManager::enableApp';
-	const EVENT_APP_ENABLE_FOR_GROUPS = 'OCP\App\IAppManager::enableAppForGroups';
-	const EVENT_APP_DISABLE = 'OCP\App\IAppManager::disableApp';
+    const EVENT_APP_ENABLE = 'OCP\App\IAppManager::enableApp';
+    const EVENT_APP_ENABLE_FOR_GROUPS = 'OCP\App\IAppManager::enableAppForGroups';
+    const EVENT_APP_DISABLE = 'OCP\App\IAppManager::disableApp';
 
-	/** @var string */
-	protected $event;
-	/** @var string */
-	protected $appID;
-	/** @var \OCP\IGroup[] */
-	protected $groups;
+    /** @var string */
+    protected $event;
+    /** @var string */
+    protected $appID;
+    /** @var \OCP\IGroup[] */
+    protected $groups;
 
-	/**
-	 * DispatcherEvent constructor.
-	 *
-	 * @param string $event
-	 * @param $appID
-	 * @param \OCP\IGroup[] $groups
-	 * @since 9.0.0
-	 */
-	public function __construct($event, $appID, array $groups = null) {
-		$this->event = $event;
-		$this->appID = $appID;
-		$this->groups = $groups;
-	}
+    /**
+     * DispatcherEvent constructor.
+     *
+     * @param string $event
+     * @param $appID
+     * @param \OCP\IGroup[] $groups
+     * @since 9.0.0
+     */
+    public function __construct($event, $appID, array $groups = null) {
+        $this->event = $event;
+        $this->appID = $appID;
+        $this->groups = $groups;
+    }
 
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getEvent() {
-		return $this->event;
-	}
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getEvent() {
+        return $this->event;
+    }
 
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getAppID() {
-		return $this->appID;
-	}
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getAppID() {
+        return $this->appID;
+    }
 
-	/**
-	 * returns the group Ids
-	 * @return string[]
-	 * @since 9.0.0
-	 */
-	public function getGroups() {
-		return array_map(function ($group) {
-			/** @var \OCP\IGroup $group */
-			return $group->getGID();
-		}, $this->groups);
-	}
+    /**
+     * returns the group Ids
+     * @return string[]
+     * @since 9.0.0
+     */
+    public function getGroups() {
+        return array_map(function ($group) {
+            /** @var \OCP\IGroup $group */
+            return $group->getGID();
+        }, $this->groups);
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 	 * @since 9.0.0
 	 */
 	public function getGroups() {
-		return array_map(function ($group) {
+		return array_map(function($group) {
 			/** @var \OCP\IGroup $group */
 			return $group->getGID();
 		}, $this->groups);

lib/public/appframework/db/mapper.php

Doc Comments +1 added lines, -1 removed lines

@@ -335,7 +335,7 @@
 	 * Returns an db result and throws exceptions when there are more or less
 	 * results
 	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
+	 * @param string[] $params the parameters of the sql query
 	 * @param int $limit the maximum number of rows
 	 * @param int $offset from which row we want to start
 	 * @throws DoesNotExistException if the item does not exist

Indentation +309 added lines, -309 removed lines

@@ -38,315 +38,315 @@
  */
 abstract class Mapper {
 
-	protected $tableName;
-	protected $entityClass;
-	protected $db;
-
-	/**
-	 * @param IDBConnection $db Instance of the Db abstraction layer
-	 * @param string $tableName the name of the table. set this to allow entity
-	 * @param string $entityClass the name of the entity that the sql should be
-	 * mapped to queries without using sql
-	 * @since 7.0.0
-	 */
-	public function __construct(IDBConnection $db, $tableName, $entityClass=null){
-		$this->db = $db;
-		$this->tableName = '*PREFIX*' . $tableName;
-
-		// if not given set the entity name to the class without the mapper part
-		// cache it here for later use since reflection is slow
-		if($entityClass === null) {
-			$this->entityClass = str_replace('Mapper', '', get_class($this));
-		} else {
-			$this->entityClass = $entityClass;
-		}
-	}
-
-
-	/**
-	 * @return string the table name
-	 * @since 7.0.0
-	 */
-	public function getTableName(){
-		return $this->tableName;
-	}
-
-
-	/**
-	 * Deletes an entity from the table
-	 * @param Entity $entity the entity that should be deleted
-	 * @return Entity the deleted entity
-	 * @since 7.0.0 - return value added in 8.1.0
-	 */
-	public function delete(Entity $entity){
-		$sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
-		$stmt = $this->execute($sql, [$entity->getId()]);
-		$stmt->closeCursor();
-		return $entity;
-	}
-
-
-	/**
-	 * Creates a new entry in the db from an entity
-	 * @param Entity $entity the entity that should be created
-	 * @return Entity the saved entity with the set id
-	 * @since 7.0.0
-	 */
-	public function insert(Entity $entity){
-		// get updated fields to save, fields have to be set using a setter to
-		// be saved
-		$properties = $entity->getUpdatedFields();
-		$values = '';
-		$columns = '';
-		$params = [];
-
-		// build the fields
-		$i = 0;
-		foreach($properties as $property => $updated) {
-			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
-
-			$columns .= '`' . $column . '`';
-			$values .= '?';
-
-			// only append colon if there are more entries
-			if($i < count($properties)-1){
-				$columns .= ',';
-				$values .= ',';
-			}
-
-			$params[] = $entity->$getter();
-			$i++;
-
-		}
-
-		$sql = 'INSERT INTO `' . $this->tableName . '`(' .
-				$columns . ') VALUES(' . $values . ')';
-
-		$stmt = $this->execute($sql, $params);
-
-		$entity->setId((int) $this->db->lastInsertId($this->tableName));
-
-		$stmt->closeCursor();
-
-		return $entity;
-	}
-
-
-
-	/**
-	 * Updates an entry in the db from an entity
-	 * @throws \InvalidArgumentException if entity has no id
-	 * @param Entity $entity the entity that should be created
-	 * @return Entity the saved entity with the set id
-	 * @since 7.0.0 - return value was added in 8.0.0
-	 */
-	public function update(Entity $entity){
-		// if entity wasn't changed it makes no sense to run a db query
-		$properties = $entity->getUpdatedFields();
-		if(count($properties) === 0) {
-			return $entity;
-		}
-
-		// entity needs an id
-		$id = $entity->getId();
-		if($id === null){
-			throw new \InvalidArgumentException(
-				'Entity which should be updated has no id');
-		}
-
-		// get updated fields to save, fields have to be set using a setter to
-		// be saved
-		// do not update the id field
-		unset($properties['id']);
-
-		$columns = '';
-		$params = [];
-
-		// build the fields
-		$i = 0;
-		foreach($properties as $property => $updated) {
-
-			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
-
-			$columns .= '`' . $column . '` = ?';
-
-			// only append colon if there are more entries
-			if($i < count($properties)-1){
-				$columns .= ',';
-			}
-
-			$params[] = $entity->$getter();
-			$i++;
-		}
-
-		$sql = 'UPDATE `' . $this->tableName . '` SET ' .
-				$columns . ' WHERE `id` = ?';
-		$params[] = $id;
-
-		$stmt = $this->execute($sql, $params);
-		$stmt->closeCursor();
-
-		return $entity;
-	}
-
-	/**
-	 * Checks if an array is associative
-	 * @param array $array
-	 * @return bool true if associative
-	 * @since 8.1.0
-	 */
-	private function isAssocArray(array $array) {
-		return array_values($array) !== $array;
-	}
-
-	/**
-	 * Returns the correct PDO constant based on the value type
-	 * @param $value
-	 * @return int PDO constant
-	 * @since 8.1.0
-	 */
-	private function getPDOType($value) {
-		switch (gettype($value)) {
-			case 'integer':
-				return \PDO::PARAM_INT;
-			case 'boolean':
-				return \PDO::PARAM_BOOL;
-			default:
-				return \PDO::PARAM_STR;
-		}
-	}
-
-
-	/**
-	 * Runs an sql query
-	 * @param string $sql the prepare string
-	 * @param array $params the params which should replace the ? in the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @return \PDOStatement the database query result
-	 * @since 7.0.0
-	 */
-	protected function execute($sql, array $params=[], $limit=null, $offset=null){
-		if ($this->db instanceof IDb) {
-			$query = $this->db->prepareQuery($sql, $limit, $offset);
-		} else {
-			$query = $this->db->prepare($sql, $limit, $offset);
-		}
-
-		if ($this->isAssocArray($params)) {
-			foreach ($params as $key => $param) {
-				$pdoConstant = $this->getPDOType($param);
-				$query->bindValue($key, $param, $pdoConstant);
-			}
-		} else {
-			$index = 1;  // bindParam is 1 indexed
-			foreach ($params as $param) {
-				$pdoConstant = $this->getPDOType($param);
-				$query->bindValue($index, $param, $pdoConstant);
-				$index++;
-			}
-		}
-
-		$result = $query->execute();
-
-		// this is only for backwards compatibility reasons and can be removed
-		// in owncloud 10. IDb returns a StatementWrapper from execute, PDO,
-		// Doctrine and IDbConnection don't so this needs to be done in order
-		// to stay backwards compatible for the things that rely on the
-		// StatementWrapper being returned
-		if ($result instanceof \OC_DB_StatementWrapper) {
-			return $result;
-		}
-
-		return $query;
-	}
-
-
-	/**
-	 * Returns an db result and throws exceptions when there are more or less
-	 * results
-	 * @see findEntity
-	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @throws DoesNotExistException if the item does not exist
-	 * @throws MultipleObjectsReturnedException if more than one item exist
-	 * @return array the result as row
-	 * @since 7.0.0
-	 */
-	protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
-		$stmt = $this->execute($sql, $params, $limit, $offset);
-		$row = $stmt->fetch();
-
-		if($row === false || $row === null){
-			$stmt->closeCursor();
-			throw new DoesNotExistException('No matching entry found');
-		}
-		$row2 = $stmt->fetch();
-		$stmt->closeCursor();
-		//MDB2 returns null, PDO and doctrine false when no row is available
-		if( ! ($row2 === false || $row2 === null )) {
-			throw new MultipleObjectsReturnedException('More than one result');
-		} else {
-			return $row;
-		}
-	}
-
-
-	/**
-	 * Creates an entity from a row. Automatically determines the entity class
-	 * from the current mapper name (MyEntityMapper -> MyEntity)
-	 * @param array $row the row which should be converted to an entity
-	 * @return Entity the entity
-	 * @since 7.0.0
-	 */
-	protected function mapRowToEntity($row) {
-		return call_user_func($this->entityClass .'::fromRow', $row);
-	}
-
-
-	/**
-	 * Runs a sql query and returns an array of entities
-	 * @param string $sql the prepare string
-	 * @param array $params the params which should replace the ? in the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @return array all fetched entities
-	 * @since 7.0.0
-	 */
-	protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
-		$stmt = $this->execute($sql, $params, $limit, $offset);
-
-		$entities = [];
-
-		while($row = $stmt->fetch()){
-			$entities[] = $this->mapRowToEntity($row);
-		}
-
-		$stmt->closeCursor();
-
-		return $entities;
-	}
-
-
-	/**
-	 * Returns an db result and throws exceptions when there are more or less
-	 * results
-	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @throws DoesNotExistException if the item does not exist
-	 * @throws MultipleObjectsReturnedException if more than one item exist
-	 * @return Entity the entity
-	 * @since 7.0.0
-	 */
-	protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
-		return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));
-	}
+    protected $tableName;
+    protected $entityClass;
+    protected $db;
+
+    /**
+     * @param IDBConnection $db Instance of the Db abstraction layer
+     * @param string $tableName the name of the table. set this to allow entity
+     * @param string $entityClass the name of the entity that the sql should be
+     * mapped to queries without using sql
+     * @since 7.0.0
+     */
+    public function __construct(IDBConnection $db, $tableName, $entityClass=null){
+        $this->db = $db;
+        $this->tableName = '*PREFIX*' . $tableName;
+
+        // if not given set the entity name to the class without the mapper part
+        // cache it here for later use since reflection is slow
+        if($entityClass === null) {
+            $this->entityClass = str_replace('Mapper', '', get_class($this));
+        } else {
+            $this->entityClass = $entityClass;
+        }
+    }
+
+
+    /**
+     * @return string the table name
+     * @since 7.0.0
+     */
+    public function getTableName(){
+        return $this->tableName;
+    }
+
+
+    /**
+     * Deletes an entity from the table
+     * @param Entity $entity the entity that should be deleted
+     * @return Entity the deleted entity
+     * @since 7.0.0 - return value added in 8.1.0
+     */
+    public function delete(Entity $entity){
+        $sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
+        $stmt = $this->execute($sql, [$entity->getId()]);
+        $stmt->closeCursor();
+        return $entity;
+    }
+
+
+    /**
+     * Creates a new entry in the db from an entity
+     * @param Entity $entity the entity that should be created
+     * @return Entity the saved entity with the set id
+     * @since 7.0.0
+     */
+    public function insert(Entity $entity){
+        // get updated fields to save, fields have to be set using a setter to
+        // be saved
+        $properties = $entity->getUpdatedFields();
+        $values = '';
+        $columns = '';
+        $params = [];
+
+        // build the fields
+        $i = 0;
+        foreach($properties as $property => $updated) {
+            $column = $entity->propertyToColumn($property);
+            $getter = 'get' . ucfirst($property);
+
+            $columns .= '`' . $column . '`';
+            $values .= '?';
+
+            // only append colon if there are more entries
+            if($i < count($properties)-1){
+                $columns .= ',';
+                $values .= ',';
+            }
+
+            $params[] = $entity->$getter();
+            $i++;
+
+        }
+
+        $sql = 'INSERT INTO `' . $this->tableName . '`(' .
+                $columns . ') VALUES(' . $values . ')';
+
+        $stmt = $this->execute($sql, $params);
+
+        $entity->setId((int) $this->db->lastInsertId($this->tableName));
+
+        $stmt->closeCursor();
+
+        return $entity;
+    }
+
+
+
+    /**
+     * Updates an entry in the db from an entity
+     * @throws \InvalidArgumentException if entity has no id
+     * @param Entity $entity the entity that should be created
+     * @return Entity the saved entity with the set id
+     * @since 7.0.0 - return value was added in 8.0.0
+     */
+    public function update(Entity $entity){
+        // if entity wasn't changed it makes no sense to run a db query
+        $properties = $entity->getUpdatedFields();
+        if(count($properties) === 0) {
+            return $entity;
+        }
+
+        // entity needs an id
+        $id = $entity->getId();
+        if($id === null){
+            throw new \InvalidArgumentException(
+                'Entity which should be updated has no id');
+        }
+
+        // get updated fields to save, fields have to be set using a setter to
+        // be saved
+        // do not update the id field
+        unset($properties['id']);
+
+        $columns = '';
+        $params = [];
+
+        // build the fields
+        $i = 0;
+        foreach($properties as $property => $updated) {
+
+            $column = $entity->propertyToColumn($property);
+            $getter = 'get' . ucfirst($property);
+
+            $columns .= '`' . $column . '` = ?';
+
+            // only append colon if there are more entries
+            if($i < count($properties)-1){
+                $columns .= ',';
+            }
+
+            $params[] = $entity->$getter();
+            $i++;
+        }
+
+        $sql = 'UPDATE `' . $this->tableName . '` SET ' .
+                $columns . ' WHERE `id` = ?';
+        $params[] = $id;
+
+        $stmt = $this->execute($sql, $params);
+        $stmt->closeCursor();
+
+        return $entity;
+    }
+
+    /**
+     * Checks if an array is associative
+     * @param array $array
+     * @return bool true if associative
+     * @since 8.1.0
+     */
+    private function isAssocArray(array $array) {
+        return array_values($array) !== $array;
+    }
+
+    /**
+     * Returns the correct PDO constant based on the value type
+     * @param $value
+     * @return int PDO constant
+     * @since 8.1.0
+     */
+    private function getPDOType($value) {
+        switch (gettype($value)) {
+            case 'integer':
+                return \PDO::PARAM_INT;
+            case 'boolean':
+                return \PDO::PARAM_BOOL;
+            default:
+                return \PDO::PARAM_STR;
+        }
+    }
+
+
+    /**
+     * Runs an sql query
+     * @param string $sql the prepare string
+     * @param array $params the params which should replace the ? in the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @return \PDOStatement the database query result
+     * @since 7.0.0
+     */
+    protected function execute($sql, array $params=[], $limit=null, $offset=null){
+        if ($this->db instanceof IDb) {
+            $query = $this->db->prepareQuery($sql, $limit, $offset);
+        } else {
+            $query = $this->db->prepare($sql, $limit, $offset);
+        }
+
+        if ($this->isAssocArray($params)) {
+            foreach ($params as $key => $param) {
+                $pdoConstant = $this->getPDOType($param);
+                $query->bindValue($key, $param, $pdoConstant);
+            }
+        } else {
+            $index = 1;  // bindParam is 1 indexed
+            foreach ($params as $param) {
+                $pdoConstant = $this->getPDOType($param);
+                $query->bindValue($index, $param, $pdoConstant);
+                $index++;
+            }
+        }
+
+        $result = $query->execute();
+
+        // this is only for backwards compatibility reasons and can be removed
+        // in owncloud 10. IDb returns a StatementWrapper from execute, PDO,
+        // Doctrine and IDbConnection don't so this needs to be done in order
+        // to stay backwards compatible for the things that rely on the
+        // StatementWrapper being returned
+        if ($result instanceof \OC_DB_StatementWrapper) {
+            return $result;
+        }
+
+        return $query;
+    }
+
+
+    /**
+     * Returns an db result and throws exceptions when there are more or less
+     * results
+     * @see findEntity
+     * @param string $sql the sql query
+     * @param array $params the parameters of the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @throws DoesNotExistException if the item does not exist
+     * @throws MultipleObjectsReturnedException if more than one item exist
+     * @return array the result as row
+     * @since 7.0.0
+     */
+    protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
+        $stmt = $this->execute($sql, $params, $limit, $offset);
+        $row = $stmt->fetch();
+
+        if($row === false || $row === null){
+            $stmt->closeCursor();
+            throw new DoesNotExistException('No matching entry found');
+        }
+        $row2 = $stmt->fetch();
+        $stmt->closeCursor();
+        //MDB2 returns null, PDO and doctrine false when no row is available
+        if( ! ($row2 === false || $row2 === null )) {
+            throw new MultipleObjectsReturnedException('More than one result');
+        } else {
+            return $row;
+        }
+    }
+
+
+    /**
+     * Creates an entity from a row. Automatically determines the entity class
+     * from the current mapper name (MyEntityMapper -> MyEntity)
+     * @param array $row the row which should be converted to an entity
+     * @return Entity the entity
+     * @since 7.0.0
+     */
+    protected function mapRowToEntity($row) {
+        return call_user_func($this->entityClass .'::fromRow', $row);
+    }
+
+
+    /**
+     * Runs a sql query and returns an array of entities
+     * @param string $sql the prepare string
+     * @param array $params the params which should replace the ? in the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @return array all fetched entities
+     * @since 7.0.0
+     */
+    protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
+        $stmt = $this->execute($sql, $params, $limit, $offset);
+
+        $entities = [];
+
+        while($row = $stmt->fetch()){
+            $entities[] = $this->mapRowToEntity($row);
+        }
+
+        $stmt->closeCursor();
+
+        return $entities;
+    }
+
+
+    /**
+     * Returns an db result and throws exceptions when there are more or less
+     * results
+     * @param string $sql the sql query
+     * @param array $params the parameters of the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @throws DoesNotExistException if the item does not exist
+     * @throws MultipleObjectsReturnedException if more than one item exist
+     * @return Entity the entity
+     * @since 7.0.0
+     */
+    protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
+        return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));
+    }
 
 
 }

Spacing +31 added lines, -31 removed lines

@@ -49,13 +49,13 @@ 
 	 * mapped to queries without using sql
 	 * @since 7.0.0
 	 */
-	public function __construct(IDBConnection $db, $tableName, $entityClass=null){
+	public function __construct(IDBConnection $db, $tableName, $entityClass = null) {
 		$this->db = $db;
-		$this->tableName = '*PREFIX*' . $tableName;
+		$this->tableName = '*PREFIX*'.$tableName;
 
 		// if not given set the entity name to the class without the mapper part
 		// cache it here for later use since reflection is slow
-		if($entityClass === null) {
+		if ($entityClass === null) {
 			$this->entityClass = str_replace('Mapper', '', get_class($this));
 		} else {
 			$this->entityClass = $entityClass;
@@ -67,7 +67,7 @@ 
 	 * @return string the table name
 	 * @since 7.0.0
 	 */
-	public function getTableName(){
+	public function getTableName() {
 		return $this->tableName;
 	}
 
@@ -78,8 +78,8 @@ 
 	 * @return Entity the deleted entity
 	 * @since 7.0.0 - return value added in 8.1.0
 	 */
-	public function delete(Entity $entity){
-		$sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
+	public function delete(Entity $entity) {
+		$sql = 'DELETE FROM `'.$this->tableName.'` WHERE `id` = ?';
 		$stmt = $this->execute($sql, [$entity->getId()]);
 		$stmt->closeCursor();
 		return $entity;
@@ -92,7 +92,7 @@ 
 	 * @return Entity the saved entity with the set id
 	 * @since 7.0.0
 	 */
-	public function insert(Entity $entity){
+	public function insert(Entity $entity) {
 		// get updated fields to save, fields have to be set using a setter to
 		// be saved
 		$properties = $entity->getUpdatedFields();
@@ -102,15 +102,15 @@ 
 
 		// build the fields
 		$i = 0;
-		foreach($properties as $property => $updated) {
+		foreach ($properties as $property => $updated) {
 			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
+			$getter = 'get'.ucfirst($property);
 
-			$columns .= '`' . $column . '`';
+			$columns .= '`'.$column.'`';
 			$values .= '?';
 
 			// only append colon if there are more entries
-			if($i < count($properties)-1){
+			if ($i < count($properties) - 1) {
 				$columns .= ',';
 				$values .= ',';
 			}
@@ -120,8 +120,8 @@ 
 
 		}
 
-		$sql = 'INSERT INTO `' . $this->tableName . '`(' .
-				$columns . ') VALUES(' . $values . ')';
+		$sql = 'INSERT INTO `'.$this->tableName.'`('.
+				$columns.') VALUES('.$values.')';
 
 		$stmt = $this->execute($sql, $params);
 
@@ -141,16 +141,16 @@ 
 	 * @return Entity the saved entity with the set id
 	 * @since 7.0.0 - return value was added in 8.0.0
 	 */
-	public function update(Entity $entity){
+	public function update(Entity $entity) {
 		// if entity wasn't changed it makes no sense to run a db query
 		$properties = $entity->getUpdatedFields();
-		if(count($properties) === 0) {
+		if (count($properties) === 0) {
 			return $entity;
 		}
 
 		// entity needs an id
 		$id = $entity->getId();
-		if($id === null){
+		if ($id === null) {
 			throw new \InvalidArgumentException(
 				'Entity which should be updated has no id');
 		}
@@ -165,15 +165,15 @@ 
 
 		// build the fields
 		$i = 0;
-		foreach($properties as $property => $updated) {
+		foreach ($properties as $property => $updated) {
 
 			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
+			$getter = 'get'.ucfirst($property);
 
-			$columns .= '`' . $column . '` = ?';
+			$columns .= '`'.$column.'` = ?';
 
 			// only append colon if there are more entries
-			if($i < count($properties)-1){
+			if ($i < count($properties) - 1) {
 				$columns .= ',';
 			}
 
@@ -181,8 +181,8 @@ 
 			$i++;
 		}
 
-		$sql = 'UPDATE `' . $this->tableName . '` SET ' .
-				$columns . ' WHERE `id` = ?';
+		$sql = 'UPDATE `'.$this->tableName.'` SET '.
+				$columns.' WHERE `id` = ?';
 		$params[] = $id;
 
 		$stmt = $this->execute($sql, $params);
@@ -228,7 +228,7 @@ 
 	 * @return \PDOStatement the database query result
 	 * @since 7.0.0
 	 */
-	protected function execute($sql, array $params=[], $limit=null, $offset=null){
+	protected function execute($sql, array $params = [], $limit = null, $offset = null) {
 		if ($this->db instanceof IDb) {
 			$query = $this->db->prepareQuery($sql, $limit, $offset);
 		} else {
@@ -241,7 +241,7 @@ 
 				$query->bindValue($key, $param, $pdoConstant);
 			}
 		} else {
-			$index = 1;  // bindParam is 1 indexed
+			$index = 1; // bindParam is 1 indexed
 			foreach ($params as $param) {
 				$pdoConstant = $this->getPDOType($param);
 				$query->bindValue($index, $param, $pdoConstant);
@@ -277,18 +277,18 @@ 
 	 * @return array the result as row
 	 * @since 7.0.0
 	 */
-	protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
+	protected function findOneQuery($sql, array $params = [], $limit = null, $offset = null) {
 		$stmt = $this->execute($sql, $params, $limit, $offset);
 		$row = $stmt->fetch();
 
-		if($row === false || $row === null){
+		if ($row === false || $row === null) {
 			$stmt->closeCursor();
 			throw new DoesNotExistException('No matching entry found');
 		}
 		$row2 = $stmt->fetch();
 		$stmt->closeCursor();
 		//MDB2 returns null, PDO and doctrine false when no row is available
-		if( ! ($row2 === false || $row2 === null )) {
+		if (!($row2 === false || $row2 === null)) {
 			throw new MultipleObjectsReturnedException('More than one result');
 		} else {
 			return $row;
@@ -304,7 +304,7 @@ 
 	 * @since 7.0.0
 	 */
 	protected function mapRowToEntity($row) {
-		return call_user_func($this->entityClass .'::fromRow', $row);
+		return call_user_func($this->entityClass.'::fromRow', $row);
 	}
 
 
@@ -317,12 +317,12 @@ 
 	 * @return array all fetched entities
 	 * @since 7.0.0
 	 */
-	protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
+	protected function findEntities($sql, array $params = [], $limit = null, $offset = null) {
 		$stmt = $this->execute($sql, $params, $limit, $offset);
 
 		$entities = [];
 
-		while($row = $stmt->fetch()){
+		while ($row = $stmt->fetch()) {
 			$entities[] = $this->mapRowToEntity($row);
 		}
 
@@ -344,7 +344,7 @@ 
 	 * @return Entity the entity
 	 * @since 7.0.0
 	 */
-	protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
+	protected function findEntity($sql, array $params = [], $limit = null, $offset = null) {
 		return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));
 	}
 

lib/public/files.php

Doc Comments +2 added lines, -1 removed lines

@@ -46,6 +46,7 @@ 
 class Files {
 	/**
 	 * Recusive deletion of folders
+	 * @param string $dir
 	 * @return bool
 	 * @since 5.0.0
 	 */
@@ -67,7 +68,7 @@ 
 	/**
 	 * Search for files by mimetype
 	 * @param string $mimetype
-	 * @return array
+	 * @return \OC\Files\FileInfo[]
 	 * @since 6.0.0
 	 */
 	static public function searchByMime( $mimetype ) {

Indentation +81 added lines, -81 removed lines

@@ -44,92 +44,92 @@
  * @since 5.0.0
  */
 class Files {
-	/**
-	 * Recusive deletion of folders
-	 * @return bool
-	 * @since 5.0.0
-	 */
-	static function rmdirr( $dir ) {
-		return \OC_Helper::rmdirr( $dir );
-	}
+    /**
+     * Recusive deletion of folders
+     * @return bool
+     * @since 5.0.0
+     */
+    static function rmdirr( $dir ) {
+        return \OC_Helper::rmdirr( $dir );
+    }
 
-	/**
-	 * Get the mimetype form a local file
-	 * @param string $path
-	 * @return string
-	 * does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead
-	 * @since 5.0.0
-	 */
-	static function getMimeType( $path ) {
-		return \OC::$server->getMimeTypeDetector()->detect($path);
-	}
+    /**
+     * Get the mimetype form a local file
+     * @param string $path
+     * @return string
+     * does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead
+     * @since 5.0.0
+     */
+    static function getMimeType( $path ) {
+        return \OC::$server->getMimeTypeDetector()->detect($path);
+    }
 
-	/**
-	 * Search for files by mimetype
-	 * @param string $mimetype
-	 * @return array
-	 * @since 6.0.0
-	 */
-	static public function searchByMime( $mimetype ) {
-		return(\OC\Files\Filesystem::searchByMime( $mimetype ));
-	}
+    /**
+     * Search for files by mimetype
+     * @param string $mimetype
+     * @return array
+     * @since 6.0.0
+     */
+    static public function searchByMime( $mimetype ) {
+        return(\OC\Files\Filesystem::searchByMime( $mimetype ));
+    }
 
-	/**
-	 * Copy the contents of one stream to another
-	 * @param resource $source
-	 * @param resource $target
-	 * @return int the number of bytes copied
-	 * @since 5.0.0
-	 */
-	public static function streamCopy( $source, $target ) {
-		list($count, ) = \OC_Helper::streamCopy( $source, $target );
-		return $count;
-	}
+    /**
+     * Copy the contents of one stream to another
+     * @param resource $source
+     * @param resource $target
+     * @return int the number of bytes copied
+     * @since 5.0.0
+     */
+    public static function streamCopy( $source, $target ) {
+        list($count, ) = \OC_Helper::streamCopy( $source, $target );
+        return $count;
+    }
 
-	/**
-	 * Create a temporary file with an unique filename
-	 * @param string $postfix
-	 * @return string
-	 *
-	 * temporary files are automatically cleaned up after the script is finished
-	 * @deprecated 8.1.0 use getTemporaryFile() of \OCP\ITempManager - \OC::$server->getTempManager()
-	 * @since 5.0.0
-	 */
-	public static function tmpFile( $postfix='' ) {
-		return \OC::$server->getTempManager()->getTemporaryFile($postfix);
-	}
+    /**
+     * Create a temporary file with an unique filename
+     * @param string $postfix
+     * @return string
+     *
+     * temporary files are automatically cleaned up after the script is finished
+     * @deprecated 8.1.0 use getTemporaryFile() of \OCP\ITempManager - \OC::$server->getTempManager()
+     * @since 5.0.0
+     */
+    public static function tmpFile( $postfix='' ) {
+        return \OC::$server->getTempManager()->getTemporaryFile($postfix);
+    }
 
-	/**
-	 * Create a temporary folder with an unique filename
-	 * @return string
-	 *
-	 * temporary files are automatically cleaned up after the script is finished
-	 * @deprecated 8.1.0 use getTemporaryFolder() of \OCP\ITempManager - \OC::$server->getTempManager()
-	 * @since 5.0.0
-	 */
-	public static function tmpFolder() {
-		return \OC::$server->getTempManager()->getTemporaryFolder();
-	}
+    /**
+     * Create a temporary folder with an unique filename
+     * @return string
+     *
+     * temporary files are automatically cleaned up after the script is finished
+     * @deprecated 8.1.0 use getTemporaryFolder() of \OCP\ITempManager - \OC::$server->getTempManager()
+     * @since 5.0.0
+     */
+    public static function tmpFolder() {
+        return \OC::$server->getTempManager()->getTemporaryFolder();
+    }
 
-	/**
-	 * Adds a suffix to the name in case the file exists
-	 * @param string $path
-	 * @param string $filename
-	 * @return string
-	 * @since 5.0.0
-	 */
-	public static function buildNotExistingFileName( $path, $filename ) {
-		return(\OC_Helper::buildNotExistingFileName( $path, $filename ));
-	}
+    /**
+     * Adds a suffix to the name in case the file exists
+     * @param string $path
+     * @param string $filename
+     * @return string
+     * @since 5.0.0
+     */
+    public static function buildNotExistingFileName( $path, $filename ) {
+        return(\OC_Helper::buildNotExistingFileName( $path, $filename ));
+    }
 
-	/**
-	 * Gets the Storage for an app - creates the needed folder if they are not
-	 * existant
-	 * @param string $app
-	 * @return \OC\Files\View
-	 * @since 5.0.0
-	 */
-	public static function getStorage( $app ) {
-		return \OC_App::getStorage( $app );
-	}
+    /**
+     * Gets the Storage for an app - creates the needed folder if they are not
+     * existant
+     * @param string $app
+     * @return \OC\Files\View
+     * @since 5.0.0
+     */
+    public static function getStorage( $app ) {
+        return \OC_App::getStorage( $app );
+    }
 }

Spacing +12 added lines, -12 removed lines

@@ -50,8 +50,8 @@ 
 	 * @return bool
 	 * @since 5.0.0
 	 */
-	static function rmdirr( $dir ) {
-		return \OC_Helper::rmdirr( $dir );
+	static function rmdirr($dir) {
+		return \OC_Helper::rmdirr($dir);
 	}
 
 	/**
@@ -61,7 +61,7 @@ 
 	 * does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead
 	 * @since 5.0.0
 	 */
-	static function getMimeType( $path ) {
+	static function getMimeType($path) {
 		return \OC::$server->getMimeTypeDetector()->detect($path);
 	}
 
@@ -71,8 +71,8 @@ 
 	 * @return array
 	 * @since 6.0.0
 	 */
-	static public function searchByMime( $mimetype ) {
-		return(\OC\Files\Filesystem::searchByMime( $mimetype ));
+	static public function searchByMime($mimetype) {
+		return(\OC\Files\Filesystem::searchByMime($mimetype));
 	}
 
 	/**
@@ -82,8 +82,8 @@ 
 	 * @return int the number of bytes copied
 	 * @since 5.0.0
 	 */
-	public static function streamCopy( $source, $target ) {
-		list($count, ) = \OC_Helper::streamCopy( $source, $target );
+	public static function streamCopy($source, $target) {
+		list($count,) = \OC_Helper::streamCopy($source, $target);
 		return $count;
 	}
 
@@ -96,7 +96,7 @@ 
 	 * @deprecated 8.1.0 use getTemporaryFile() of \OCP\ITempManager - \OC::$server->getTempManager()
 	 * @since 5.0.0
 	 */
-	public static function tmpFile( $postfix='' ) {
+	public static function tmpFile($postfix = '') {
 		return \OC::$server->getTempManager()->getTemporaryFile($postfix);
 	}
 
@@ -119,8 +119,8 @@ 
 	 * @return string
 	 * @since 5.0.0
 	 */
-	public static function buildNotExistingFileName( $path, $filename ) {
-		return(\OC_Helper::buildNotExistingFileName( $path, $filename ));
+	public static function buildNotExistingFileName($path, $filename) {
+		return(\OC_Helper::buildNotExistingFileName($path, $filename));
 	}
 
 	/**
@@ -130,7 +130,7 @@ 
 	 * @return \OC\Files\View
 	 * @since 5.0.0
 	 */
-	public static function getStorage( $app ) {
-		return \OC_App::getStorage( $app );
+	public static function getStorage($app) {
+		return \OC_App::getStorage($app);
 	}
 }

lib/public/files/storagetimeoutexception.php

Doc Comments -1 removed lines

@@ -30,7 +30,6 @@
 	 * StorageTimeoutException constructor.
 	 *
 	 * @param string $message
-	 * @param int $code
 	 * @param \Exception $previous
 	 * @since 9.0.0
 	 */

Indentation +12 added lines, -12 removed lines

@@ -27,16 +27,16 @@
  */
 class StorageTimeoutException extends StorageNotAvailableException {
 
-	/**
-	 * StorageTimeoutException constructor.
-	 *
-	 * @param string $message
-	 * @param int $code
-	 * @param \Exception $previous
-	 * @since 9.0.0
-	 */
-	public function __construct($message = '', \Exception $previous = null) {
-		$l = \OC::$server->getL10N('core');
-		parent::__construct($l->t('Storage connection timeout. %s', $message), self::STATUS_TIMEOUT, $previous);
-	}
+    /**
+     * StorageTimeoutException constructor.
+     *
+     * @param string $message
+     * @param int $code
+     * @param \Exception $previous
+     * @since 9.0.0
+     */
+    public function __construct($message = '', \Exception $previous = null) {
+        $l = \OC::$server->getL10N('core');
+        parent::__construct($l->t('Storage connection timeout. %s', $message), self::STATUS_TIMEOUT, $previous);
+    }
 }

lib/public/template.php

Doc Comments +2 added lines, -2 removed lines

@@ -100,8 +100,8 @@
 /**
  * Return the relative date in relation to today. Returns something like "last hour" or "two month ago"
  * @param int $timestamp unix timestamp
- * @param boolean $dateOnly
- * @return \OC_L10N_String human readable interpretation of the timestamp
+ * @param integer $dateOnly
+ * @return string human readable interpretation of the timestamp
  *
  * @deprecated 8.0.0 Use \OCP\Template::relative_modified_date() instead
  */

Indentation +94 added lines, -94 removed lines

@@ -50,7 +50,7 @@ 
  * @deprecated 8.0.0 Use \OCP\Template::image_path() instead
  */
 function image_path( $app, $image ) {
-	return(\image_path( $app, $image ));
+    return(\image_path( $app, $image ));
 }
 
 
@@ -61,7 +61,7 @@ 
  * @deprecated 8.0.0 Use \OCP\Template::mimetype_icon() instead
  */
 function mimetype_icon( $mimetype ) {
-	return(\mimetype_icon( $mimetype ));
+    return(\mimetype_icon( $mimetype ));
 }
 
 /**
@@ -71,7 +71,7 @@ 
  * @deprecated 8.0.0 Use \OCP\Template::preview_icon() instead
  */
 function preview_icon( $path ) {
-	return(\preview_icon( $path ));
+    return(\preview_icon( $path ));
 }
 
 /**
@@ -83,7 +83,7 @@ 
  * @deprecated 8.0.0 Use \OCP\Template::publicPreview_icon() instead
  */
 function publicPreview_icon ( $path, $token ) {
-	return(\publicPreview_icon( $path, $token ));
+    return(\publicPreview_icon( $path, $token ));
 }
 
 /**
@@ -94,7 +94,7 @@ 
  * @deprecated 8.0.0 Use \OCP\Template::human_file_size() instead
  */
 function human_file_size( $bytes ) {
-	return(\human_file_size( $bytes ));
+    return(\human_file_size( $bytes ));
 }
 
 
@@ -107,7 +107,7 @@ 
  * @deprecated 8.0.0 Use \OCP\Template::relative_modified_date() instead
  */
 function relative_modified_date( $timestamp, $dateOnly = false ) {
-	return(\relative_modified_date($timestamp, null, $dateOnly));
+    return(\relative_modified_date($timestamp, null, $dateOnly));
 }
 
 
@@ -118,7 +118,7 @@ 
  * @deprecated 8.0.0 Use \OCP\Template::human_file_size() instead
  */
 function simple_file_size($bytes) {
-	return(\human_file_size($bytes));
+    return(\human_file_size($bytes));
 }
 
 
@@ -131,7 +131,7 @@ 
  * @deprecated 8.0.0 Use \OCP\Template::html_select_options() instead
  */
 function html_select_options($options, $selected, $params=array()) {
-	return(\html_select_options($options, $selected, $params));
+    return(\html_select_options($options, $selected, $params));
 }
 
 
@@ -142,90 +142,90 @@ 
  * @since 8.0.0
  */
 class Template extends \OC_Template {
-	/**
-	 * Make OC_Helper::imagePath available as a simple function
-	 *
-	 * @see \OCP\IURLGenerator::imagePath
-	 *
-	 * @param string $app
-	 * @param string $image
-	 * @return string to the image
-	 * @since 8.0.0
-	 */
-	public static function image_path($app, $image) {
-		return \image_path($app, $image);
-	}
-
-
-	/**
-	 * Make OC_Helper::mimetypeIcon available as a simple function
-	 *
-	 * @param string $mimetype
-	 * @return string to the image of this file type.
-	 * @since 8.0.0
-	 */
-	public static function mimetype_icon($mimetype) {
-		return \mimetype_icon($mimetype);
-	}
-
-	/**
-	 * Make preview_icon available as a simple function
-	 *
-	 * @param string $path path to file
-	 * @return string to the preview of the image
-	 * @since 8.0.0
-	 */
-	public static function preview_icon($path) {
-		return \preview_icon($path);
-	}
-
-	/**
-	 * Make publicpreview_icon available as a simple function
-	 * Returns the path to the preview of the image.
-	 *
-	 * @param string $path of file
-	 * @param string $token
-	 * @return string link to the preview
-	 * @since 8.0.0
-	 */
-	public static function publicPreview_icon($path, $token) {
-		return \publicPreview_icon($path, $token);
-	}
-
-	/**
-	 * Make OC_Helper::humanFileSize available as a simple function
-	 * Example: 2048 to 2 kB.
-	 *
-	 * @param int $bytes in bytes
-	 * @return string size as string
-	 * @since 8.0.0
-	 */
-	public static function human_file_size($bytes) {
-		return \human_file_size($bytes);
-	}
-
-	/**
-	 * Return the relative date in relation to today. Returns something like "last hour" or "two month ago"
-	 *
-	 * @param int $timestamp unix timestamp
-	 * @param boolean $dateOnly
-	 * @return string human readable interpretation of the timestamp
-	 * @since 8.0.0
-	 */
-	public static function relative_modified_date($timestamp, $dateOnly = false) {
-		return \relative_modified_date($timestamp, null, $dateOnly);
-	}
-
-	/**
-	 * Generate html code for an options block.
-	 *
-	 * @param array $options the options
-	 * @param mixed $selected which one is selected?
-	 * @param array $params the parameters
-	 * @return string html options
-	 * @since 8.0.0
-	 */
-	public static function html_select_options($options, $selected, $params=array()) {
-		return \html_select_options($options, $selected, $params);
-	}
+    /**
+     * Make OC_Helper::imagePath available as a simple function
+     *
+     * @see \OCP\IURLGenerator::imagePath
+     *
+     * @param string $app
+     * @param string $image
+     * @return string to the image
+     * @since 8.0.0
+     */
+    public static function image_path($app, $image) {
+        return \image_path($app, $image);
+    }
+
+
+    /**
+     * Make OC_Helper::mimetypeIcon available as a simple function
+     *
+     * @param string $mimetype
+     * @return string to the image of this file type.
+     * @since 8.0.0
+     */
+    public static function mimetype_icon($mimetype) {
+        return \mimetype_icon($mimetype);
+    }
+
+    /**
+     * Make preview_icon available as a simple function
+     *
+     * @param string $path path to file
+     * @return string to the preview of the image
+     * @since 8.0.0
+     */
+    public static function preview_icon($path) {
+        return \preview_icon($path);
+    }
+
+    /**
+     * Make publicpreview_icon available as a simple function
+     * Returns the path to the preview of the image.
+     *
+     * @param string $path of file
+     * @param string $token
+     * @return string link to the preview
+     * @since 8.0.0
+     */
+    public static function publicPreview_icon($path, $token) {
+        return \publicPreview_icon($path, $token);
+    }
+
+    /**
+     * Make OC_Helper::humanFileSize available as a simple function
+     * Example: 2048 to 2 kB.
+     *
+     * @param int $bytes in bytes
+     * @return string size as string
+     * @since 8.0.0
+     */
+    public static function human_file_size($bytes) {
+        return \human_file_size($bytes);
+    }
+
+    /**
+     * Return the relative date in relation to today. Returns something like "last hour" or "two month ago"
+     *
+     * @param int $timestamp unix timestamp
+     * @param boolean $dateOnly
+     * @return string human readable interpretation of the timestamp
+     * @since 8.0.0
+     */
+    public static function relative_modified_date($timestamp, $dateOnly = false) {
+        return \relative_modified_date($timestamp, null, $dateOnly);
+    }
+
+    /**
+     * Generate html code for an options block.
+     *
+     * @param array $options the options
+     * @param mixed $selected which one is selected?
+     * @param array $params the parameters
+     * @return string html options
+     * @since 8.0.0
+     */
+    public static function html_select_options($options, $selected, $params=array()) {
+        return \html_select_options($options, $selected, $params);
+    }
 }

Spacing +13 added lines, -13 removed lines

@@ -49,8 +49,8 @@ 
  * @see \OCP\IURLGenerator::imagePath
  * @deprecated 8.0.0 Use \OCP\Template::image_path() instead
  */
-function image_path( $app, $image ) {
-	return(\image_path( $app, $image ));
+function image_path($app, $image) {
+	return(\image_path($app, $image));
 }
 
 
@@ -60,8 +60,8 @@ 
  * @return string to the image of this file type.
  * @deprecated 8.0.0 Use \OCP\Template::mimetype_icon() instead
  */
-function mimetype_icon( $mimetype ) {
-	return(\mimetype_icon( $mimetype ));
+function mimetype_icon($mimetype) {
+	return(\mimetype_icon($mimetype));
 }
 
 /**
@@ -70,8 +70,8 @@ 
  * @return string to the preview of the image
  * @deprecated 8.0.0 Use \OCP\Template::preview_icon() instead
  */
-function preview_icon( $path ) {
-	return(\preview_icon( $path ));
+function preview_icon($path) {
+	return(\preview_icon($path));
 }
 
 /**
@@ -82,8 +82,8 @@ 
  * @return string link to the preview
  * @deprecated 8.0.0 Use \OCP\Template::publicPreview_icon() instead
  */
-function publicPreview_icon ( $path, $token ) {
-	return(\publicPreview_icon( $path, $token ));
+function publicPreview_icon($path, $token) {
+	return(\publicPreview_icon($path, $token));
 }
 
 /**
@@ -93,8 +93,8 @@ 
  * @return string size as string
  * @deprecated 8.0.0 Use \OCP\Template::human_file_size() instead
  */
-function human_file_size( $bytes ) {
-	return(\human_file_size( $bytes ));
+function human_file_size($bytes) {
+	return(\human_file_size($bytes));
 }
 
 
@@ -106,7 +106,7 @@ 
  *
  * @deprecated 8.0.0 Use \OCP\Template::relative_modified_date() instead
  */
-function relative_modified_date( $timestamp, $dateOnly = false ) {
+function relative_modified_date($timestamp, $dateOnly = false) {
 	return(\relative_modified_date($timestamp, null, $dateOnly));
 }
 
@@ -130,7 +130,7 @@ 
  * @return string html options
  * @deprecated 8.0.0 Use \OCP\Template::html_select_options() instead
  */
-function html_select_options($options, $selected, $params=array()) {
+function html_select_options($options, $selected, $params = array()) {
 	return(\html_select_options($options, $selected, $params));
 }
 
@@ -225,7 +225,7 @@ 
 	 * @return string html options
 	 * @since 8.0.0
 	 */
-	public static function html_select_options($options, $selected, $params=array()) {
+	public static function html_select_options($options, $selected, $params = array()) {
 		return \html_select_options($options, $selected, $params);
 	}
 }

lib/public/util.php

Doc Comments +1 added lines, -1 removed lines

@@ -544,7 +544,7 @@
 	 * @param array $input The array to work on
 	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
 	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @return array
+	 * @return string
 	 * @since 4.5.0
 	 */
 	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {

Indentation +641 added lines, -641 removed lines

@@ -57,647 +57,647 @@
  * @since 4.0.0
  */
 class Util {
-	// consts for Logging
-	const DEBUG=0;
-	const INFO=1;
-	const WARN=2;
-	const ERROR=3;
-	const FATAL=4;
-
-	/**
-	 * get the current installed version of ownCloud
-	 * @return array
-	 * @since 4.0.0
-	 */
-	public static function getVersion() {
-		return(\OC_Util::getVersion());
-	}
+    // consts for Logging
+    const DEBUG=0;
+    const INFO=1;
+    const WARN=2;
+    const ERROR=3;
+    const FATAL=4;
+
+    /**
+     * get the current installed version of ownCloud
+     * @return array
+     * @since 4.0.0
+     */
+    public static function getVersion() {
+        return(\OC_Util::getVersion());
+    }
 	
-	/**
-	 * Set current update channel
-	 * @param string $channel
-	 * @since 8.1.0
-	 */
-	public static function setChannel($channel) {
-		//Flush timestamp to reload version.php
-		\OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
-		\OC::$server->getSession()->set('OC_Version_Timestamp', 0);
-	}
+    /**
+     * Set current update channel
+     * @param string $channel
+     * @since 8.1.0
+     */
+    public static function setChannel($channel) {
+        //Flush timestamp to reload version.php
+        \OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
+        \OC::$server->getSession()->set('OC_Version_Timestamp', 0);
+    }
 	
-	/**
-	 * Get current update channel
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public static function getChannel() {
-		return \OC_Util::getChannel();
-	}
-
-	/**
-	 * send an email
-	 * @param string $toaddress
-	 * @param string $toname
-	 * @param string $subject
-	 * @param string $mailtext
-	 * @param string $fromaddress
-	 * @param string $fromname
-	 * @param int $html
-	 * @param string $altbody
-	 * @param string $ccaddress
-	 * @param string $ccname
-	 * @param string $bcc
-	 * @deprecated 8.1.0 Use \OCP\Mail\IMailer instead
-	 * @since 4.0.0
-	 */
-	public static function sendMail($toaddress, $toname, $subject, $mailtext, $fromaddress, $fromname,
-		$html = 0, $altbody = '', $ccaddress = '', $ccname = '', $bcc = '') {
-		$mailer = \OC::$server->getMailer();
-		$message = $mailer->createMessage();
-		$message->setTo([$toaddress => $toname]);
-		$message->setSubject($subject);
-		$message->setPlainBody($mailtext);
-		$message->setFrom([$fromaddress => $fromname]);
-		if($html === 1) {
-			$message->setHTMLBody($altbody);
-		}
-
-		if($altbody === '') {
-			$message->setHTMLBody($mailtext);
-			$message->setPlainBody('');
-		} else {
-			$message->setHtmlBody($mailtext);
-			$message->setPlainBody($altbody);
-		}
-
-		if(!empty($ccaddress)) {
-			if(!empty($ccname)) {
-				$message->setCc([$ccaddress => $ccname]);
-			} else {
-				$message->setCc([$ccaddress]);
-			}
-		}
-		if(!empty($bcc)) {
-			$message->setBcc([$bcc]);
-		}
-
-		$mailer->send($message);
-	}
-
-	/**
-	 * write a message in the log
-	 * @param string $app
-	 * @param string $message
-	 * @param int $level
-	 * @since 4.0.0
-	 */
-	public static function writeLog( $app, $message, $level ) {
-		$context = ['app' => $app];
-		\OC::$server->getLogger()->log($level, $message, $context);
-	}
-
-	/**
-	 * write exception into the log
-	 * @param string $app app name
-	 * @param \Exception $ex exception to log
-	 * @param int $level log level, defaults to \OCP\Util::FATAL
-	 * @since ....0.0 - parameter $level was added in 7.0.0
-	 * @deprecated 8.2.0 use logException of \OCP\ILogger
-	 */
-	public static function logException( $app, \Exception $ex, $level = \OCP\Util::FATAL ) {
-		\OC::$server->getLogger()->logException($ex, ['app' => $app]);
-	}
-
-	/**
-	 * check if sharing is disabled for the current user
-	 *
-	 * @return boolean
-	 * @since 7.0.0
-	 */
-	public static function isSharingDisabledForUser() {
-		return \OC_Util::isSharingDisabledForUser(
-				\OC::$server->getConfig(),
-				\OC::$server->getGroupManager(),
-				\OC::$server->getUserSession()->getUser()
-		);
-	}
-
-	/**
-	 * get l10n object
-	 * @param string $application
-	 * @param string|null $language
-	 * @return \OC_L10N
-	 * @since 6.0.0 - parameter $language was added in 8.0.0
-	 */
-	public static function getL10N($application, $language = null) {
-		return \OC::$server->getL10N($application, $language);
-	}
-
-	/**
-	 * add a css file
-	 * @param string $application
-	 * @param string $file
-	 * @since 4.0.0
-	 */
-	public static function addStyle( $application, $file = null ) {
-		\OC_Util::addStyle( $application, $file );
-	}
-
-	/**
-	 * add a javascript file
-	 * @param string $application
-	 * @param string $file
-	 * @since 4.0.0
-	 */
-	public static function addScript( $application, $file = null ) {
-		\OC_Util::addScript( $application, $file );
-	}
-
-	/**
-	 * Add a translation JS file
-	 * @param string $application application id
-	 * @param string $languageCode language code, defaults to the current locale
-	 * @since 8.0.0
-	 */
-	public static function addTranslations($application, $languageCode = null) {
-		\OC_Util::addTranslations($application, $languageCode);
-	}
-
-	/**
-	 * Add a custom element to the header
-	 * If $text is null then the element will be written as empty element.
-	 * So use "" to get a closing tag.
-	 * @param string $tag tag name of the element
-	 * @param array $attributes array of attributes for the element
-	 * @param string $text the text content for the element
-	 * @since 4.0.0
-	 */
-	public static function addHeader($tag, $attributes, $text=null) {
-		\OC_Util::addHeader($tag, $attributes, $text);
-	}
-
-	/**
-	 * formats a timestamp in the "right" way
-	 * @param int $timestamp $timestamp
-	 * @param bool $dateOnly option to omit time from the result
-	 * @param DateTimeZone|string $timeZone where the given timestamp shall be converted to
-	 * @return string timestamp
-	 *
-	 * @deprecated 8.0.0 Use \OC::$server->query('DateTimeFormatter') instead
-	 * @since 4.0.0
-	 */
-	public static function formatDate($timestamp, $dateOnly=false, $timeZone = null) {
-		return(\OC_Util::formatDate($timestamp, $dateOnly, $timeZone));
-	}
-
-	/**
-	 * check if some encrypted files are stored
-	 * @return bool
-	 *
-	 * @deprecated 8.1.0 No longer required
-	 * @since 6.0.0
-	 */
-	public static function encryptedFiles() {
-		return false;
-	}
-
-	/**
-	 * Creates an absolute url to the given app and file.
-	 * @param string $app app
-	 * @param string $file file
-	 * @param array $args array with param=>value, will be appended to the returned url
-	 * 	The value of $args will be urlencoded
-	 * @return string the url
-	 * @since 4.0.0 - parameter $args was added in 4.5.0
-	 */
-	public static function linkToAbsolute( $app, $file, $args = array() ) {
-		$urlGenerator = \OC::$server->getURLGenerator();
-		return $urlGenerator->getAbsoluteURL(
-			$urlGenerator->linkTo($app, $file, $args)
-		);
-	}
-
-	/**
-	 * Creates an absolute url for remote use.
-	 * @param string $service id
-	 * @return string the url
-	 * @since 4.0.0
-	 */
-	public static function linkToRemote( $service ) {
-		$urlGenerator = \OC::$server->getURLGenerator();
-		$remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
-		return $urlGenerator->getAbsoluteURL(
-			$remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
-		);
-	}
-
-	/**
-	 * Creates an absolute url for public use
-	 * @param string $service id
-	 * @return string the url
-	 * @since 4.5.0
-	 */
-	public static function linkToPublic($service) {
-		return \OC_Helper::linkToPublic($service);
-	}
-
-	/**
-	 * Creates an url using a defined route
-	 * @param string $route
-	 * @param array $parameters
-	 * @internal param array $args with param=>value, will be appended to the returned url
-	 * @return string the url
-	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkToRoute($route, $parameters)
-	 * @since 5.0.0
-	 */
-	public static function linkToRoute( $route, $parameters = array() ) {
-		return \OC::$server->getURLGenerator()->linkToRoute($route, $parameters);
-	}
-
-	/**
-	 * Creates an url to the given app and file
-	 * @param string $app app
-	 * @param string $file file
-	 * @param array $args array with param=>value, will be appended to the returned url
-	 * 	The value of $args will be urlencoded
-	 * @return string the url
-	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkTo($app, $file, $args)
-	 * @since 4.0.0 - parameter $args was added in 4.5.0
-	 */
-	public static function linkTo( $app, $file, $args = array() ) {
-		return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
-	}
-
-	/**
-	 * Returns the server host, even if the website uses one or more reverse proxy
-	 * @return string the server host
-	 * @deprecated 8.1.0 Use \OCP\IRequest::getServerHost
-	 * @since 4.0.0
-	 */
-	public static function getServerHost() {
-		return \OC::$server->getRequest()->getServerHost();
-	}
-
-	/**
-	 * Returns the server host name without an eventual port number
-	 * @return string the server hostname
-	 * @since 5.0.0
-	 */
-	public static function getServerHostName() {
-		$host_name = self::getServerHost();
-		// strip away port number (if existing)
-		$colon_pos = strpos($host_name, ':');
-		if ($colon_pos != FALSE) {
-			$host_name = substr($host_name, 0, $colon_pos);
-		}
-		return $host_name;
-	}
-
-	/**
-	 * Returns the default email address
-	 * @param string $user_part the user part of the address
-	 * @return string the default email address
-	 *
-	 * Assembles a default email address (using the server hostname
-	 * and the given user part, and returns it
-	 * Example: when given lostpassword-noreply as $user_part param,
-	 *     and is currently accessed via http(s)://example.com/,
-	 *     it would return 'lostpassword-noreply@example.com'
-	 *
-	 * If the configuration value 'mail_from_address' is set in
-	 * config.php, this value will override the $user_part that
-	 * is passed to this function
-	 * @since 5.0.0
-	 */
-	public static function getDefaultEmailAddress($user_part) {
-		$config = \OC::$server->getConfig();
-		$user_part = $config->getSystemValue('mail_from_address', $user_part);
-		$host_name = self::getServerHostName();
-		$host_name = $config->getSystemValue('mail_domain', $host_name);
-		$defaultEmailAddress = $user_part.'@'.$host_name;
-
-		$mailer = \OC::$server->getMailer();
-		if ($mailer->validateMailAddress($defaultEmailAddress)) {
-			return $defaultEmailAddress;
-		}
-
-		// in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
-		return $user_part.'@localhost.localdomain';
-	}
-
-	/**
-	 * Returns the server protocol. It respects reverse proxy servers and load balancers
-	 * @return string the server protocol
-	 * @deprecated 8.1.0 Use \OCP\IRequest::getServerProtocol
-	 * @since 4.5.0
-	 */
-	public static function getServerProtocol() {
-		return \OC::$server->getRequest()->getServerProtocol();
-	}
-
-	/**
-	 * Returns the request uri, even if the website uses one or more reverse proxies
-	 * @return string the request uri
-	 * @deprecated 8.1.0 Use \OCP\IRequest::getRequestUri
-	 * @since 5.0.0
-	 */
-	public static function getRequestUri() {
-		return \OC::$server->getRequest()->getRequestUri();
-	}
-
-	/**
-	 * Returns the script name, even if the website uses one or more reverse proxies
-	 * @return string the script name
-	 * @deprecated 8.1.0 Use \OCP\IRequest::getScriptName
-	 * @since 5.0.0
-	 */
-	public static function getScriptName() {
-		return \OC::$server->getRequest()->getScriptName();
-	}
-
-	/**
-	 * Creates path to an image
-	 * @param string $app app
-	 * @param string $image image name
-	 * @return string the url
-	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->imagePath($app, $image)
-	 * @since 4.0.0
-	 */
-	public static function imagePath( $app, $image ) {
-		return \OC::$server->getURLGenerator()->imagePath($app, $image);
-	}
-
-	/**
-	 * Make a human file size (2048 to 2 kB)
-	 * @param int $bytes file size in bytes
-	 * @return string a human readable file size
-	 * @since 4.0.0
-	 */
-	public static function humanFileSize( $bytes ) {
-		return(\OC_Helper::humanFileSize( $bytes ));
-	}
-
-	/**
-	 * Make a computer file size (2 kB to 2048)
-	 * @param string $str file size in a fancy format
-	 * @return int a file size in bytes
-	 *
-	 * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
-	 * @since 4.0.0
-	 */
-	public static function computerFileSize( $str ) {
-		return(\OC_Helper::computerFileSize( $str ));
-	}
-
-	/**
-	 * connects a function to a hook
-	 *
-	 * @param string $signalClass class name of emitter
-	 * @param string $signalName name of signal
-	 * @param string|object $slotClass class name of slot
-	 * @param string $slotName name of slot
-	 * @return bool
-	 *
-	 * This function makes it very easy to connect to use hooks.
-	 *
-	 * TODO: write example
-	 * @since 4.0.0
-	 */
-	static public function connectHook($signalClass, $signalName, $slotClass, $slotName ) {
-		return(\OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName ));
-	}
-
-	/**
-	 * Emits a signal. To get data from the slot use references!
-	 * @param string $signalclass class name of emitter
-	 * @param string $signalname name of signal
-	 * @param array $params default: array() array with additional data
-	 * @return bool true if slots exists or false if not
-	 *
-	 * TODO: write example
-	 * @since 4.0.0
-	 */
-	static public function emitHook( $signalclass, $signalname, $params = array()) {
-		return(\OC_Hook::emit( $signalclass, $signalname, $params ));
-	}
-
-	/**
-	 * Cached encrypted CSRF token. Some static unit-tests of ownCloud compare
-	 * multiple OC_Template elements which invoke `callRegister`. If the value
-	 * would not be cached these unit-tests would fail.
-	 * @var string
-	 */
-	private static $token = '';
-
-	/**
-	 * Register an get/post call. This is important to prevent CSRF attacks
-	 * @since 4.5.0
-	 */
-	public static function callRegister() {
-		if(self::$token === '') {
-			self::$token = \OC::$server->getCsrfTokenManager()->getToken()->getEncryptedValue();
-		}
-		return self::$token;
-	}
-
-	/**
-	 * Check an ajax get/post call if the request token is valid. exit if not.
-	 * @since 4.5.0
-	 * @deprecated 9.0.0 Use annotations based on the app framework.
-	 */
-	public static function callCheck() {
-		if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
-			header('Location: '.\OC::$WEBROOT);
-			exit();
-		}
-
-		if (!(\OC::$server->getRequest()->passesCSRFCheck())) {
-			exit();
-		}
-	}
-
-	/**
-	 * Used to sanitize HTML
-	 *
-	 * This function is used to sanitize HTML and should be applied on any
-	 * string or array of strings before displaying it on a web page.
-	 *
-	 * @param string|array $value
-	 * @return string|array an array of sanitized strings or a single sanitized string, depends on the input parameter.
-	 * @since 4.5.0
-	 */
-	public static function sanitizeHTML($value) {
-		return \OC_Util::sanitizeHTML($value);
-	}
-
-	/**
-	 * Public function to encode url parameters
-	 *
-	 * This function is used to encode path to file before output.
-	 * Encoding is done according to RFC 3986 with one exception:
-	 * Character '/' is preserved as is.
-	 *
-	 * @param string $component part of URI to encode
-	 * @return string
-	 * @since 6.0.0
-	 */
-	public static function encodePath($component) {
-		return(\OC_Util::encodePath($component));
-	}
-
-	/**
-	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
-	 *
-	 * @param array $input The array to work on
-	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @return array
-	 * @since 4.5.0
-	 */
-	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
-		return(\OC_Helper::mb_array_change_key_case($input, $case, $encoding));
-	}
-
-	/**
-	 * replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
-	 *
-	 * @param string $string The input string. Opposite to the PHP build-in function does not accept an array.
-	 * @param string $replacement The replacement string.
-	 * @param int $start If start is positive, the replacing will begin at the start'th offset into string. If start is negative, the replacing will begin at the start'th character from the end of string.
-	 * @param int $length Length of the part to be replaced
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @return string
-	 * @since 4.5.0
-	 * @deprecated 8.2.0 Use substr_replace() instead.
-	 */
-	public static function mb_substr_replace($string, $replacement, $start, $length = null, $encoding = 'UTF-8') {
-		return substr_replace($string, $replacement, $start, $length);
-	}
-
-	/**
-	 * Replace all occurrences of the search string with the replacement string
-	 *
-	 * @param string $search The value being searched for, otherwise known as the needle. String.
-	 * @param string $replace The replacement string.
-	 * @param string $subject The string or array being searched and replaced on, otherwise known as the haystack.
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @param int $count If passed, this will be set to the number of replacements performed.
-	 * @return string
-	 * @since 4.5.0
-	 * @deprecated 8.2.0 Use str_replace() instead.
-	 */
-	public static function mb_str_replace($search, $replace, $subject, $encoding = 'UTF-8', &$count = null) {
-		return str_replace($search, $replace, $subject, $count);
-	}
-
-	/**
-	 * performs a search in a nested array
-	 *
-	 * @param array $haystack the array to be searched
-	 * @param string $needle the search string
-	 * @param int $index optional, only search this key name
-	 * @return mixed the key of the matching field, otherwise false
-	 * @since 4.5.0
-	 */
-	public static function recursiveArraySearch($haystack, $needle, $index = null) {
-		return(\OC_Helper::recursiveArraySearch($haystack, $needle, $index));
-	}
-
-	/**
-	 * calculates the maximum upload size respecting system settings, free space and user quota
-	 *
-	 * @param string $dir the current folder where the user currently operates
-	 * @param int $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
-	 * @return int number of bytes representing
-	 * @since 5.0.0
-	 */
-	public static function maxUploadFilesize($dir, $free = null) {
-		return \OC_Helper::maxUploadFilesize($dir, $free);
-	}
-
-	/**
-	 * Calculate free space left within user quota
-	 * @param string $dir the current folder where the user currently operates
-	 * @return int number of bytes representing
-	 * @since 7.0.0
-	 */
-	public static function freeSpace($dir) {
-		return \OC_Helper::freeSpace($dir);
-	}
-
-	/**
-	 * Calculate PHP upload limit
-	 *
-	 * @return int number of bytes representing
-	 * @since 7.0.0
-	 */
-	public static function uploadLimit() {
-		return \OC_Helper::uploadLimit();
-	}
-
-	/**
-	 * Returns whether the given file name is valid
-	 * @param string $file file name to check
-	 * @return bool true if the file name is valid, false otherwise
-	 * @deprecated 8.1.0 use \OC\Files\View::verifyPath()
-	 * @since 7.0.0
-	 */
-	public static function isValidFileName($file) {
-		return \OC_Util::isValidFileName($file);
-	}
-
-	/**
-	 * Generates a cryptographic secure pseudo-random string
-	 * @param int $length of the random string
-	 * @return string
-	 * @deprecated 8.0.0 Use \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate($length); instead
-	 * @since 7.0.0
-	 */
-	public static function generateRandomBytes($length = 30) {
-		return \OC::$server->getSecureRandom()->generate($length, \OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_DIGITS);
-	}
-
-	/**
-	 * Compare two strings to provide a natural sort
-	 * @param string $a first string to compare
-	 * @param string $b second string to compare
-	 * @return -1 if $b comes before $a, 1 if $a comes before $b
-	 * or 0 if the strings are identical
-	 * @since 7.0.0
-	 */
-	public static function naturalSortCompare($a, $b) {
-		return \OC\NaturalSort::getInstance()->compare($a, $b);
-	}
-
-	/**
-	 * check if a password is required for each public link
-	 * @return boolean
-	 * @since 7.0.0
-	 */
-	public static function isPublicLinkPasswordRequired() {
-		return \OC_Util::isPublicLinkPasswordRequired();
-	}
-
-	/**
-	 * check if share API enforces a default expire date
-	 * @return boolean
-	 * @since 8.0.0
-	 */
-	public static function isDefaultExpireDateEnforced() {
-		return \OC_Util::isDefaultExpireDateEnforced();
-	}
-
-	protected static $needUpgradeCache = null;
-
-	/**
-	 * Checks whether the current version needs upgrade.
-	 *
-	 * @return bool true if upgrade is needed, false otherwise
-	 * @since 7.0.0
-	 */
-	public static function needUpgrade() {
-		if (!isset(self::$needUpgradeCache)) {
-			self::$needUpgradeCache=\OC_Util::needUpgrade(\OC::$server->getConfig());
-		}		
-		return self::$needUpgradeCache;
-	}
+    /**
+     * Get current update channel
+     * @return string
+     * @since 8.1.0
+     */
+    public static function getChannel() {
+        return \OC_Util::getChannel();
+    }
+
+    /**
+     * send an email
+     * @param string $toaddress
+     * @param string $toname
+     * @param string $subject
+     * @param string $mailtext
+     * @param string $fromaddress
+     * @param string $fromname
+     * @param int $html
+     * @param string $altbody
+     * @param string $ccaddress
+     * @param string $ccname
+     * @param string $bcc
+     * @deprecated 8.1.0 Use \OCP\Mail\IMailer instead
+     * @since 4.0.0
+     */
+    public static function sendMail($toaddress, $toname, $subject, $mailtext, $fromaddress, $fromname,
+        $html = 0, $altbody = '', $ccaddress = '', $ccname = '', $bcc = '') {
+        $mailer = \OC::$server->getMailer();
+        $message = $mailer->createMessage();
+        $message->setTo([$toaddress => $toname]);
+        $message->setSubject($subject);
+        $message->setPlainBody($mailtext);
+        $message->setFrom([$fromaddress => $fromname]);
+        if($html === 1) {
+            $message->setHTMLBody($altbody);
+        }
+
+        if($altbody === '') {
+            $message->setHTMLBody($mailtext);
+            $message->setPlainBody('');
+        } else {
+            $message->setHtmlBody($mailtext);
+            $message->setPlainBody($altbody);
+        }
+
+        if(!empty($ccaddress)) {
+            if(!empty($ccname)) {
+                $message->setCc([$ccaddress => $ccname]);
+            } else {
+                $message->setCc([$ccaddress]);
+            }
+        }
+        if(!empty($bcc)) {
+            $message->setBcc([$bcc]);
+        }
+
+        $mailer->send($message);
+    }
+
+    /**
+     * write a message in the log
+     * @param string $app
+     * @param string $message
+     * @param int $level
+     * @since 4.0.0
+     */
+    public static function writeLog( $app, $message, $level ) {
+        $context = ['app' => $app];
+        \OC::$server->getLogger()->log($level, $message, $context);
+    }
+
+    /**
+     * write exception into the log
+     * @param string $app app name
+     * @param \Exception $ex exception to log
+     * @param int $level log level, defaults to \OCP\Util::FATAL
+     * @since ....0.0 - parameter $level was added in 7.0.0
+     * @deprecated 8.2.0 use logException of \OCP\ILogger
+     */
+    public static function logException( $app, \Exception $ex, $level = \OCP\Util::FATAL ) {
+        \OC::$server->getLogger()->logException($ex, ['app' => $app]);
+    }
+
+    /**
+     * check if sharing is disabled for the current user
+     *
+     * @return boolean
+     * @since 7.0.0
+     */
+    public static function isSharingDisabledForUser() {
+        return \OC_Util::isSharingDisabledForUser(
+                \OC::$server->getConfig(),
+                \OC::$server->getGroupManager(),
+                \OC::$server->getUserSession()->getUser()
+        );
+    }
+
+    /**
+     * get l10n object
+     * @param string $application
+     * @param string|null $language
+     * @return \OC_L10N
+     * @since 6.0.0 - parameter $language was added in 8.0.0
+     */
+    public static function getL10N($application, $language = null) {
+        return \OC::$server->getL10N($application, $language);
+    }
+
+    /**
+     * add a css file
+     * @param string $application
+     * @param string $file
+     * @since 4.0.0
+     */
+    public static function addStyle( $application, $file = null ) {
+        \OC_Util::addStyle( $application, $file );
+    }
+
+    /**
+     * add a javascript file
+     * @param string $application
+     * @param string $file
+     * @since 4.0.0
+     */
+    public static function addScript( $application, $file = null ) {
+        \OC_Util::addScript( $application, $file );
+    }
+
+    /**
+     * Add a translation JS file
+     * @param string $application application id
+     * @param string $languageCode language code, defaults to the current locale
+     * @since 8.0.0
+     */
+    public static function addTranslations($application, $languageCode = null) {
+        \OC_Util::addTranslations($application, $languageCode);
+    }
+
+    /**
+     * Add a custom element to the header
+     * If $text is null then the element will be written as empty element.
+     * So use "" to get a closing tag.
+     * @param string $tag tag name of the element
+     * @param array $attributes array of attributes for the element
+     * @param string $text the text content for the element
+     * @since 4.0.0
+     */
+    public static function addHeader($tag, $attributes, $text=null) {
+        \OC_Util::addHeader($tag, $attributes, $text);
+    }
+
+    /**
+     * formats a timestamp in the "right" way
+     * @param int $timestamp $timestamp
+     * @param bool $dateOnly option to omit time from the result
+     * @param DateTimeZone|string $timeZone where the given timestamp shall be converted to
+     * @return string timestamp
+     *
+     * @deprecated 8.0.0 Use \OC::$server->query('DateTimeFormatter') instead
+     * @since 4.0.0
+     */
+    public static function formatDate($timestamp, $dateOnly=false, $timeZone = null) {
+        return(\OC_Util::formatDate($timestamp, $dateOnly, $timeZone));
+    }
+
+    /**
+     * check if some encrypted files are stored
+     * @return bool
+     *
+     * @deprecated 8.1.0 No longer required
+     * @since 6.0.0
+     */
+    public static function encryptedFiles() {
+        return false;
+    }
+
+    /**
+     * Creates an absolute url to the given app and file.
+     * @param string $app app
+     * @param string $file file
+     * @param array $args array with param=>value, will be appended to the returned url
+     * 	The value of $args will be urlencoded
+     * @return string the url
+     * @since 4.0.0 - parameter $args was added in 4.5.0
+     */
+    public static function linkToAbsolute( $app, $file, $args = array() ) {
+        $urlGenerator = \OC::$server->getURLGenerator();
+        return $urlGenerator->getAbsoluteURL(
+            $urlGenerator->linkTo($app, $file, $args)
+        );
+    }
+
+    /**
+     * Creates an absolute url for remote use.
+     * @param string $service id
+     * @return string the url
+     * @since 4.0.0
+     */
+    public static function linkToRemote( $service ) {
+        $urlGenerator = \OC::$server->getURLGenerator();
+        $remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
+        return $urlGenerator->getAbsoluteURL(
+            $remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
+        );
+    }
+
+    /**
+     * Creates an absolute url for public use
+     * @param string $service id
+     * @return string the url
+     * @since 4.5.0
+     */
+    public static function linkToPublic($service) {
+        return \OC_Helper::linkToPublic($service);
+    }
+
+    /**
+     * Creates an url using a defined route
+     * @param string $route
+     * @param array $parameters
+     * @internal param array $args with param=>value, will be appended to the returned url
+     * @return string the url
+     * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkToRoute($route, $parameters)
+     * @since 5.0.0
+     */
+    public static function linkToRoute( $route, $parameters = array() ) {
+        return \OC::$server->getURLGenerator()->linkToRoute($route, $parameters);
+    }
+
+    /**
+     * Creates an url to the given app and file
+     * @param string $app app
+     * @param string $file file
+     * @param array $args array with param=>value, will be appended to the returned url
+     * 	The value of $args will be urlencoded
+     * @return string the url
+     * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkTo($app, $file, $args)
+     * @since 4.0.0 - parameter $args was added in 4.5.0
+     */
+    public static function linkTo( $app, $file, $args = array() ) {
+        return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
+    }
+
+    /**
+     * Returns the server host, even if the website uses one or more reverse proxy
+     * @return string the server host
+     * @deprecated 8.1.0 Use \OCP\IRequest::getServerHost
+     * @since 4.0.0
+     */
+    public static function getServerHost() {
+        return \OC::$server->getRequest()->getServerHost();
+    }
+
+    /**
+     * Returns the server host name without an eventual port number
+     * @return string the server hostname
+     * @since 5.0.0
+     */
+    public static function getServerHostName() {
+        $host_name = self::getServerHost();
+        // strip away port number (if existing)
+        $colon_pos = strpos($host_name, ':');
+        if ($colon_pos != FALSE) {
+            $host_name = substr($host_name, 0, $colon_pos);
+        }
+        return $host_name;
+    }
+
+    /**
+     * Returns the default email address
+     * @param string $user_part the user part of the address
+     * @return string the default email address
+     *
+     * Assembles a default email address (using the server hostname
+     * and the given user part, and returns it
+     * Example: when given lostpassword-noreply as $user_part param,
+     *     and is currently accessed via http(s)://example.com/,
+     *     it would return 'lostpassword-noreply@example.com'
+     *
+     * If the configuration value 'mail_from_address' is set in
+     * config.php, this value will override the $user_part that
+     * is passed to this function
+     * @since 5.0.0
+     */
+    public static function getDefaultEmailAddress($user_part) {
+        $config = \OC::$server->getConfig();
+        $user_part = $config->getSystemValue('mail_from_address', $user_part);
+        $host_name = self::getServerHostName();
+        $host_name = $config->getSystemValue('mail_domain', $host_name);
+        $defaultEmailAddress = $user_part.'@'.$host_name;
+
+        $mailer = \OC::$server->getMailer();
+        if ($mailer->validateMailAddress($defaultEmailAddress)) {
+            return $defaultEmailAddress;
+        }
+
+        // in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
+        return $user_part.'@localhost.localdomain';
+    }
+
+    /**
+     * Returns the server protocol. It respects reverse proxy servers and load balancers
+     * @return string the server protocol
+     * @deprecated 8.1.0 Use \OCP\IRequest::getServerProtocol
+     * @since 4.5.0
+     */
+    public static function getServerProtocol() {
+        return \OC::$server->getRequest()->getServerProtocol();
+    }
+
+    /**
+     * Returns the request uri, even if the website uses one or more reverse proxies
+     * @return string the request uri
+     * @deprecated 8.1.0 Use \OCP\IRequest::getRequestUri
+     * @since 5.0.0
+     */
+    public static function getRequestUri() {
+        return \OC::$server->getRequest()->getRequestUri();
+    }
+
+    /**
+     * Returns the script name, even if the website uses one or more reverse proxies
+     * @return string the script name
+     * @deprecated 8.1.0 Use \OCP\IRequest::getScriptName
+     * @since 5.0.0
+     */
+    public static function getScriptName() {
+        return \OC::$server->getRequest()->getScriptName();
+    }
+
+    /**
+     * Creates path to an image
+     * @param string $app app
+     * @param string $image image name
+     * @return string the url
+     * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->imagePath($app, $image)
+     * @since 4.0.0
+     */
+    public static function imagePath( $app, $image ) {
+        return \OC::$server->getURLGenerator()->imagePath($app, $image);
+    }
+
+    /**
+     * Make a human file size (2048 to 2 kB)
+     * @param int $bytes file size in bytes
+     * @return string a human readable file size
+     * @since 4.0.0
+     */
+    public static function humanFileSize( $bytes ) {
+        return(\OC_Helper::humanFileSize( $bytes ));
+    }
+
+    /**
+     * Make a computer file size (2 kB to 2048)
+     * @param string $str file size in a fancy format
+     * @return int a file size in bytes
+     *
+     * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
+     * @since 4.0.0
+     */
+    public static function computerFileSize( $str ) {
+        return(\OC_Helper::computerFileSize( $str ));
+    }
+
+    /**
+     * connects a function to a hook
+     *
+     * @param string $signalClass class name of emitter
+     * @param string $signalName name of signal
+     * @param string|object $slotClass class name of slot
+     * @param string $slotName name of slot
+     * @return bool
+     *
+     * This function makes it very easy to connect to use hooks.
+     *
+     * TODO: write example
+     * @since 4.0.0
+     */
+    static public function connectHook($signalClass, $signalName, $slotClass, $slotName ) {
+        return(\OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName ));
+    }
+
+    /**
+     * Emits a signal. To get data from the slot use references!
+     * @param string $signalclass class name of emitter
+     * @param string $signalname name of signal
+     * @param array $params default: array() array with additional data
+     * @return bool true if slots exists or false if not
+     *
+     * TODO: write example
+     * @since 4.0.0
+     */
+    static public function emitHook( $signalclass, $signalname, $params = array()) {
+        return(\OC_Hook::emit( $signalclass, $signalname, $params ));
+    }
+
+    /**
+     * Cached encrypted CSRF token. Some static unit-tests of ownCloud compare
+     * multiple OC_Template elements which invoke `callRegister`. If the value
+     * would not be cached these unit-tests would fail.
+     * @var string
+     */
+    private static $token = '';
+
+    /**
+     * Register an get/post call. This is important to prevent CSRF attacks
+     * @since 4.5.0
+     */
+    public static function callRegister() {
+        if(self::$token === '') {
+            self::$token = \OC::$server->getCsrfTokenManager()->getToken()->getEncryptedValue();
+        }
+        return self::$token;
+    }
+
+    /**
+     * Check an ajax get/post call if the request token is valid. exit if not.
+     * @since 4.5.0
+     * @deprecated 9.0.0 Use annotations based on the app framework.
+     */
+    public static function callCheck() {
+        if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
+            header('Location: '.\OC::$WEBROOT);
+            exit();
+        }
+
+        if (!(\OC::$server->getRequest()->passesCSRFCheck())) {
+            exit();
+        }
+    }
+
+    /**
+     * Used to sanitize HTML
+     *
+     * This function is used to sanitize HTML and should be applied on any
+     * string or array of strings before displaying it on a web page.
+     *
+     * @param string|array $value
+     * @return string|array an array of sanitized strings or a single sanitized string, depends on the input parameter.
+     * @since 4.5.0
+     */
+    public static function sanitizeHTML($value) {
+        return \OC_Util::sanitizeHTML($value);
+    }
+
+    /**
+     * Public function to encode url parameters
+     *
+     * This function is used to encode path to file before output.
+     * Encoding is done according to RFC 3986 with one exception:
+     * Character '/' is preserved as is.
+     *
+     * @param string $component part of URI to encode
+     * @return string
+     * @since 6.0.0
+     */
+    public static function encodePath($component) {
+        return(\OC_Util::encodePath($component));
+    }
+
+    /**
+     * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+     *
+     * @param array $input The array to work on
+     * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+     * @return array
+     * @since 4.5.0
+     */
+    public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
+        return(\OC_Helper::mb_array_change_key_case($input, $case, $encoding));
+    }
+
+    /**
+     * replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
+     *
+     * @param string $string The input string. Opposite to the PHP build-in function does not accept an array.
+     * @param string $replacement The replacement string.
+     * @param int $start If start is positive, the replacing will begin at the start'th offset into string. If start is negative, the replacing will begin at the start'th character from the end of string.
+     * @param int $length Length of the part to be replaced
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+     * @return string
+     * @since 4.5.0
+     * @deprecated 8.2.0 Use substr_replace() instead.
+     */
+    public static function mb_substr_replace($string, $replacement, $start, $length = null, $encoding = 'UTF-8') {
+        return substr_replace($string, $replacement, $start, $length);
+    }
+
+    /**
+     * Replace all occurrences of the search string with the replacement string
+     *
+     * @param string $search The value being searched for, otherwise known as the needle. String.
+     * @param string $replace The replacement string.
+     * @param string $subject The string or array being searched and replaced on, otherwise known as the haystack.
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+     * @param int $count If passed, this will be set to the number of replacements performed.
+     * @return string
+     * @since 4.5.0
+     * @deprecated 8.2.0 Use str_replace() instead.
+     */
+    public static function mb_str_replace($search, $replace, $subject, $encoding = 'UTF-8', &$count = null) {
+        return str_replace($search, $replace, $subject, $count);
+    }
+
+    /**
+     * performs a search in a nested array
+     *
+     * @param array $haystack the array to be searched
+     * @param string $needle the search string
+     * @param int $index optional, only search this key name
+     * @return mixed the key of the matching field, otherwise false
+     * @since 4.5.0
+     */
+    public static function recursiveArraySearch($haystack, $needle, $index = null) {
+        return(\OC_Helper::recursiveArraySearch($haystack, $needle, $index));
+    }
+
+    /**
+     * calculates the maximum upload size respecting system settings, free space and user quota
+     *
+     * @param string $dir the current folder where the user currently operates
+     * @param int $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
+     * @return int number of bytes representing
+     * @since 5.0.0
+     */
+    public static function maxUploadFilesize($dir, $free = null) {
+        return \OC_Helper::maxUploadFilesize($dir, $free);
+    }
+
+    /**
+     * Calculate free space left within user quota
+     * @param string $dir the current folder where the user currently operates
+     * @return int number of bytes representing
+     * @since 7.0.0
+     */
+    public static function freeSpace($dir) {
+        return \OC_Helper::freeSpace($dir);
+    }
+
+    /**
+     * Calculate PHP upload limit
+     *
+     * @return int number of bytes representing
+     * @since 7.0.0
+     */
+    public static function uploadLimit() {
+        return \OC_Helper::uploadLimit();
+    }
+
+    /**
+     * Returns whether the given file name is valid
+     * @param string $file file name to check
+     * @return bool true if the file name is valid, false otherwise
+     * @deprecated 8.1.0 use \OC\Files\View::verifyPath()
+     * @since 7.0.0
+     */
+    public static function isValidFileName($file) {
+        return \OC_Util::isValidFileName($file);
+    }
+
+    /**
+     * Generates a cryptographic secure pseudo-random string
+     * @param int $length of the random string
+     * @return string
+     * @deprecated 8.0.0 Use \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate($length); instead
+     * @since 7.0.0
+     */
+    public static function generateRandomBytes($length = 30) {
+        return \OC::$server->getSecureRandom()->generate($length, \OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_DIGITS);
+    }
+
+    /**
+     * Compare two strings to provide a natural sort
+     * @param string $a first string to compare
+     * @param string $b second string to compare
+     * @return -1 if $b comes before $a, 1 if $a comes before $b
+     * or 0 if the strings are identical
+     * @since 7.0.0
+     */
+    public static function naturalSortCompare($a, $b) {
+        return \OC\NaturalSort::getInstance()->compare($a, $b);
+    }
+
+    /**
+     * check if a password is required for each public link
+     * @return boolean
+     * @since 7.0.0
+     */
+    public static function isPublicLinkPasswordRequired() {
+        return \OC_Util::isPublicLinkPasswordRequired();
+    }
+
+    /**
+     * check if share API enforces a default expire date
+     * @return boolean
+     * @since 8.0.0
+     */
+    public static function isDefaultExpireDateEnforced() {
+        return \OC_Util::isDefaultExpireDateEnforced();
+    }
+
+    protected static $needUpgradeCache = null;
+
+    /**
+     * Checks whether the current version needs upgrade.
+     *
+     * @return bool true if upgrade is needed, false otherwise
+     * @since 7.0.0
+     */
+    public static function needUpgrade() {
+        if (!isset(self::$needUpgradeCache)) {
+            self::$needUpgradeCache=\OC_Util::needUpgrade(\OC::$server->getConfig());
+        }		
+        return self::$needUpgradeCache;
+    }
 }

Spacing +36 added lines, -36 removed lines

@@ -58,11 +58,11 @@ 
  */
 class Util {
 	// consts for Logging
-	const DEBUG=0;
-	const INFO=1;
-	const WARN=2;
-	const ERROR=3;
-	const FATAL=4;
+	const DEBUG = 0;
+	const INFO = 1;
+	const WARN = 2;
+	const ERROR = 3;
+	const FATAL = 4;
 
 	/**
 	 * get the current installed version of ownCloud
@@ -117,11 +117,11 @@ 
 		$message->setSubject($subject);
 		$message->setPlainBody($mailtext);
 		$message->setFrom([$fromaddress => $fromname]);
-		if($html === 1) {
+		if ($html === 1) {
 			$message->setHTMLBody($altbody);
 		}
 
-		if($altbody === '') {
+		if ($altbody === '') {
 			$message->setHTMLBody($mailtext);
 			$message->setPlainBody('');
 		} else {
@@ -129,14 +129,14 @@ 
 			$message->setPlainBody($altbody);
 		}
 
-		if(!empty($ccaddress)) {
-			if(!empty($ccname)) {
+		if (!empty($ccaddress)) {
+			if (!empty($ccname)) {
 				$message->setCc([$ccaddress => $ccname]);
 			} else {
 				$message->setCc([$ccaddress]);
 			}
 		}
-		if(!empty($bcc)) {
+		if (!empty($bcc)) {
 			$message->setBcc([$bcc]);
 		}
 
@@ -150,7 +150,7 @@ 
 	 * @param int $level
 	 * @since 4.0.0
 	 */
-	public static function writeLog( $app, $message, $level ) {
+	public static function writeLog($app, $message, $level) {
 		$context = ['app' => $app];
 		\OC::$server->getLogger()->log($level, $message, $context);
 	}
@@ -163,7 +163,7 @@ 
 	 * @since ....0.0 - parameter $level was added in 7.0.0
 	 * @deprecated 8.2.0 use logException of \OCP\ILogger
 	 */
-	public static function logException( $app, \Exception $ex, $level = \OCP\Util::FATAL ) {
+	public static function logException($app, \Exception $ex, $level = \OCP\Util::FATAL) {
 		\OC::$server->getLogger()->logException($ex, ['app' => $app]);
 	}
 
@@ -198,8 +198,8 @@ 
 	 * @param string $file
 	 * @since 4.0.0
 	 */
-	public static function addStyle( $application, $file = null ) {
-		\OC_Util::addStyle( $application, $file );
+	public static function addStyle($application, $file = null) {
+		\OC_Util::addStyle($application, $file);
 	}
 
 	/**
@@ -208,8 +208,8 @@ 
 	 * @param string $file
 	 * @since 4.0.0
 	 */
-	public static function addScript( $application, $file = null ) {
-		\OC_Util::addScript( $application, $file );
+	public static function addScript($application, $file = null) {
+		\OC_Util::addScript($application, $file);
 	}
 
 	/**
@@ -231,7 +231,7 @@ 
 	 * @param string $text the text content for the element
 	 * @since 4.0.0
 	 */
-	public static function addHeader($tag, $attributes, $text=null) {
+	public static function addHeader($tag, $attributes, $text = null) {
 		\OC_Util::addHeader($tag, $attributes, $text);
 	}
 
@@ -245,7 +245,7 @@ 
 	 * @deprecated 8.0.0 Use \OC::$server->query('DateTimeFormatter') instead
 	 * @since 4.0.0
 	 */
-	public static function formatDate($timestamp, $dateOnly=false, $timeZone = null) {
+	public static function formatDate($timestamp, $dateOnly = false, $timeZone = null) {
 		return(\OC_Util::formatDate($timestamp, $dateOnly, $timeZone));
 	}
 
@@ -269,7 +269,7 @@ 
 	 * @return string the url
 	 * @since 4.0.0 - parameter $args was added in 4.5.0
 	 */
-	public static function linkToAbsolute( $app, $file, $args = array() ) {
+	public static function linkToAbsolute($app, $file, $args = array()) {
 		$urlGenerator = \OC::$server->getURLGenerator();
 		return $urlGenerator->getAbsoluteURL(
 			$urlGenerator->linkTo($app, $file, $args)
@@ -282,11 +282,11 @@ 
 	 * @return string the url
 	 * @since 4.0.0
 	 */
-	public static function linkToRemote( $service ) {
+	public static function linkToRemote($service) {
 		$urlGenerator = \OC::$server->getURLGenerator();
-		$remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
+		$remoteBase = $urlGenerator->linkTo('', 'remote.php').'/'.$service;
 		return $urlGenerator->getAbsoluteURL(
-			$remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
+			$remoteBase.(($service[strlen($service) - 1] != '/') ? '/' : '')
 		);
 	}
 
@@ -309,7 +309,7 @@ 
 	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkToRoute($route, $parameters)
 	 * @since 5.0.0
 	 */
-	public static function linkToRoute( $route, $parameters = array() ) {
+	public static function linkToRoute($route, $parameters = array()) {
 		return \OC::$server->getURLGenerator()->linkToRoute($route, $parameters);
 	}
 
@@ -323,7 +323,7 @@ 
 	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->linkTo($app, $file, $args)
 	 * @since 4.0.0 - parameter $args was added in 4.5.0
 	 */
-	public static function linkTo( $app, $file, $args = array() ) {
+	public static function linkTo($app, $file, $args = array()) {
 		return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
 	}
 
@@ -422,7 +422,7 @@ 
 	 * @deprecated 8.1.0 Use \OC::$server->getURLGenerator()->imagePath($app, $image)
 	 * @since 4.0.0
 	 */
-	public static function imagePath( $app, $image ) {
+	public static function imagePath($app, $image) {
 		return \OC::$server->getURLGenerator()->imagePath($app, $image);
 	}
 
@@ -432,8 +432,8 @@ 
 	 * @return string a human readable file size
 	 * @since 4.0.0
 	 */
-	public static function humanFileSize( $bytes ) {
-		return(\OC_Helper::humanFileSize( $bytes ));
+	public static function humanFileSize($bytes) {
+		return(\OC_Helper::humanFileSize($bytes));
 	}
 
 	/**
@@ -444,8 +444,8 @@ 
 	 * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
 	 * @since 4.0.0
 	 */
-	public static function computerFileSize( $str ) {
-		return(\OC_Helper::computerFileSize( $str ));
+	public static function computerFileSize($str) {
+		return(\OC_Helper::computerFileSize($str));
 	}
 
 	/**
@@ -462,8 +462,8 @@ 
 	 * TODO: write example
 	 * @since 4.0.0
 	 */
-	static public function connectHook($signalClass, $signalName, $slotClass, $slotName ) {
-		return(\OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName ));
+	static public function connectHook($signalClass, $signalName, $slotClass, $slotName) {
+		return(\OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName));
 	}
 
 	/**
@@ -476,8 +476,8 @@ 
 	 * TODO: write example
 	 * @since 4.0.0
 	 */
-	static public function emitHook( $signalclass, $signalname, $params = array()) {
-		return(\OC_Hook::emit( $signalclass, $signalname, $params ));
+	static public function emitHook($signalclass, $signalname, $params = array()) {
+		return(\OC_Hook::emit($signalclass, $signalname, $params));
 	}
 
 	/**
@@ -493,7 +493,7 @@ 
 	 * @since 4.5.0
 	 */
 	public static function callRegister() {
-		if(self::$token === '') {
+		if (self::$token === '') {
 			self::$token = \OC::$server->getCsrfTokenManager()->getToken()->getEncryptedValue();
 		}
 		return self::$token;
@@ -505,7 +505,7 @@ 
 	 * @deprecated 9.0.0 Use annotations based on the app framework.
 	 */
 	public static function callCheck() {
-		if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
+		if (!\OC::$server->getRequest()->passesStrictCookieCheck()) {
 			header('Location: '.\OC::$WEBROOT);
 			exit();
 		}
@@ -696,7 +696,7 @@ 
 	 */
 	public static function needUpgrade() {
 		if (!isset(self::$needUpgradeCache)) {
-			self::$needUpgradeCache=\OC_Util::needUpgrade(\OC::$server->getConfig());
+			self::$needUpgradeCache = \OC_Util::needUpgrade(\OC::$server->getConfig());
 		}		
 		return self::$needUpgradeCache;
 	}

resources/updater-fixes/apps/encryption/lib/crypto/encryption.php

Doc Comments +1 added lines, -1 removed lines

@@ -369,7 +369,7 @@
 	 * @param string $path path to the file which should be updated
 	 * @param string $uid of the user who performs the operation
 	 * @param array $accessList who has access to the file contains the key 'users' and 'public'
-	 * @return boolean
+	 * @return null|boolean
 	 */
 	public function update($path, $uid, array $accessList) {
 

Indentation +518 added lines, -518 removed lines

@@ -43,522 +43,522 @@
 
 class Encryption implements IEncryptionModule {
 
-	const ID = 'OC_DEFAULT_MODULE';
-	const DISPLAY_NAME = 'Default encryption module';
-
-	/**
-	 * @var Crypt
-	 */
-	private $crypt;
-
-	/** @var string */
-	private $cipher;
-
-	/** @var string */
-	private $path;
-
-	/** @var string */
-	private $user;
-
-	/** @var string */
-	private $fileKey;
-
-	/** @var string */
-	private $writeCache;
-
-	/** @var KeyManager */
-	private $keyManager;
-
-	/** @var array */
-	private $accessList;
-
-	/** @var boolean */
-	private $isWriteOperation;
-
-	/** @var Util */
-	private $util;
-
-	/** @var  Session */
-	private $session;
-
-	/** @var  ILogger */
-	private $logger;
-
-	/** @var IL10N */
-	private $l;
-
-	/** @var EncryptAll */
-	private $encryptAll;
-
-	/** @var  bool */
-	private $useMasterPassword;
-
-	/** @var DecryptAll  */
-	private $decryptAll;
-
-	/** @var int unencrypted block size if block contains signature */
-	private $unencryptedBlockSizeSigned = 6072;
-
-	/** @var int unencrypted block size */
-	private $unencryptedBlockSize = 6126;
-
-	/** @var int Current version of the file */
-	private $version = 0;
-
-	/** @var array remember encryption signature version */
-	private static $rememberVersion = [];
-
-
-	/**
-	 *
-	 * @param Crypt $crypt
-	 * @param KeyManager $keyManager
-	 * @param Util $util
-	 * @param Session $session
-	 * @param EncryptAll $encryptAll
-	 * @param DecryptAll $decryptAll
-	 * @param ILogger $logger
-	 * @param IL10N $il10n
-	 */
-	public function __construct(Crypt $crypt,
-								KeyManager $keyManager,
-								Util $util,
-								Session $session,
-								EncryptAll $encryptAll,
-								DecryptAll $decryptAll,
-								ILogger $logger,
-								IL10N $il10n) {
-		$this->crypt = $crypt;
-		$this->keyManager = $keyManager;
-		$this->util = $util;
-		$this->session = $session;
-		$this->encryptAll = $encryptAll;
-		$this->decryptAll = $decryptAll;
-		$this->logger = $logger;
-		$this->l = $il10n;
-		$this->useMasterPassword = $util->isMasterKeyEnabled();
-	}
-
-	/**
-	 * @return string defining the technical unique id
-	 */
-	public function getId() {
-		return self::ID;
-	}
-
-	/**
-	 * In comparison to getKey() this function returns a human readable (maybe translated) name
-	 *
-	 * @return string
-	 */
-	public function getDisplayName() {
-		return self::DISPLAY_NAME;
-	}
-
-	/**
-	 * start receiving chunks from a file. This is the place where you can
-	 * perform some initial step before starting encrypting/decrypting the
-	 * chunks
-	 *
-	 * @param string $path to the file
-	 * @param string $user who read/write the file
-	 * @param string $mode php stream open mode
-	 * @param array $header contains the header data read from the file
-	 * @param array $accessList who has access to the file contains the key 'users' and 'public'
-	 *
-	 * @return array $header contain data as key-value pairs which should be
-	 *                       written to the header, in case of a write operation
-	 *                       or if no additional data is needed return a empty array
-	 */
-	public function begin($path, $user, $mode, array $header, array $accessList) {
-		$this->path = $this->getPathToRealFile($path);
-		$this->accessList = $accessList;
-		$this->user = $user;
-		$this->isWriteOperation = false;
-		$this->writeCache = '';
-
-		if ($this->session->decryptAllModeActivated()) {
-			$encryptedFileKey = $this->keyManager->getEncryptedFileKey($this->path);
-			$shareKey = $this->keyManager->getShareKey($this->path, $this->session->getDecryptAllUid());
-			$this->fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey,
-				$shareKey,
-				$this->session->getDecryptAllKey());
-		} else {
-			$this->fileKey = $this->keyManager->getFileKey($this->path, $this->user);
-		}
-
-		// always use the version from the original file, also part files
-		// need to have a correct version number if they get moved over to the
-		// final location
-		$this->version = (int)$this->keyManager->getVersion($this->stripPartFileExtension($path), new View());
-
-		if (
-			$mode === 'w'
-			|| $mode === 'w+'
-			|| $mode === 'wb'
-			|| $mode === 'wb+'
-		) {
-			$this->isWriteOperation = true;
-			if (empty($this->fileKey)) {
-				$this->fileKey = $this->crypt->generateFileKey();
-			}
-		} else {
-			// if we read a part file we need to increase the version by 1
-			// because the version number was also increased by writing
-			// the part file
-			if(Scanner::isPartialFile($path)) {
-				$this->version = $this->version + 1;
-			}
-		}
-
-		if ($this->isWriteOperation) {
-			$this->cipher = $this->crypt->getCipher();
-		} elseif (isset($header['cipher'])) {
-			$this->cipher = $header['cipher'];
-		} else {
-			// if we read a file without a header we fall-back to the legacy cipher
-			// which was used in <=oC6
-			$this->cipher = $this->crypt->getLegacyCipher();
-		}
-
-		return array('cipher' => $this->cipher, 'signed' => 'true');
-	}
-
-	/**
-	 * last chunk received. This is the place where you can perform some final
-	 * operation and return some remaining data if something is left in your
-	 * buffer.
-	 *
-	 * @param string $path to the file
-	 * @param int $position
-	 * @return string remained data which should be written to the file in case
-	 *                of a write operation
-	 * @throws PublicKeyMissingException
-	 * @throws \Exception
-	 * @throws \OCA\Encryption\Exceptions\MultiKeyEncryptException
-	 */
-	public function end($path, $position = 0) {
-		$result = '';
-		if ($this->isWriteOperation) {
-			$this->keyManager->setVersion($path, $this->version + 1, new View());
-			// in case of a part file we remember the new signature versions
-			// the version will be set later on update.
-			// This way we make sure that other apps listening to the pre-hooks
-			// still get the old version which should be the correct value for them
-			if (Scanner::isPartialFile($path)) {
-				self::$rememberVersion[$this->stripPartFileExtension($path)] = $this->version + 1;
-			}
-			if (!empty($this->writeCache)) {
-				$result = $this->crypt->symmetricEncryptFileContent($this->writeCache, $this->fileKey, $this->version + 1, $position);
-				$this->writeCache = '';
-			}
-			$publicKeys = array();
-			if ($this->useMasterPassword === true) {
-				$publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
-			} else {
-				foreach ($this->accessList['users'] as $uid) {
-					try {
-						$publicKeys[$uid] = $this->keyManager->getPublicKey($uid);
-					} catch (PublicKeyMissingException $e) {
-						$this->logger->warning(
-							'no public key found for user "{uid}", user will not be able to read the file',
-							['app' => 'encryption', 'uid' => $uid]
-						);
-						// if the public key of the owner is missing we should fail
-						if ($uid === $this->user) {
-							throw $e;
-						}
-					}
-				}
-			}
-
-			$publicKeys = $this->keyManager->addSystemKeys($this->accessList, $publicKeys, $this->user);
-			$encryptedKeyfiles = $this->crypt->multiKeyEncrypt($this->fileKey, $publicKeys);
-			$this->keyManager->setAllFileKeys($this->path, $encryptedKeyfiles);
-		}
-		return $result;
-	}
-
-	/**
-	 * encrypt data
-	 *
-	 * @param string $data you want to encrypt
-	 * @param int $position
-	 * @return string encrypted data
-	 */
-	public function encrypt($data, $position = 0) {
-		// If extra data is left over from the last round, make sure it
-		// is integrated into the next block
-		if ($this->writeCache) {
-
-			// Concat writeCache to start of $data
-			$data = $this->writeCache . $data;
-
-			// Clear the write cache, ready for reuse - it has been
-			// flushed and its old contents processed
-			$this->writeCache = '';
-
-		}
-
-		$encrypted = '';
-		// While there still remains some data to be processed & written
-		while (strlen($data) > 0) {
-
-			// Remaining length for this iteration, not of the
-			// entire file (may be greater than 8192 bytes)
-			$remainingLength = strlen($data);
-
-			// If data remaining to be written is less than the
-			// size of 1 6126 byte block
-			if ($remainingLength < $this->unencryptedBlockSizeSigned) {
-
-				// Set writeCache to contents of $data
-				// The writeCache will be carried over to the
-				// next write round, and added to the start of
-				// $data to ensure that written blocks are
-				// always the correct length. If there is still
-				// data in writeCache after the writing round
-				// has finished, then the data will be written
-				// to disk by $this->flush().
-				$this->writeCache = $data;
-
-				// Clear $data ready for next round
-				$data = '';
-
-			} else {
-
-				// Read the chunk from the start of $data
-				$chunk = substr($data, 0, $this->unencryptedBlockSizeSigned);
-
-				$encrypted .= $this->crypt->symmetricEncryptFileContent($chunk, $this->fileKey, $this->version + 1, $position);
-
-				// Remove the chunk we just processed from
-				// $data, leaving only unprocessed data in $data
-				// var, for handling on the next round
-				$data = substr($data, $this->unencryptedBlockSizeSigned);
-
-			}
-
-		}
-
-		return $encrypted;
-	}
-
-	/**
-	 * decrypt data
-	 *
-	 * @param string $data you want to decrypt
-	 * @param int $position
-	 * @return string decrypted data
-	 * @throws DecryptionFailedException
-	 */
-	public function decrypt($data, $position = 0) {
-		if (empty($this->fileKey)) {
-			$msg = 'Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.';
-			$hint = $this->l->t('Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
-			$this->logger->error($msg);
-
-			throw new DecryptionFailedException($msg, $hint);
-		}
-
-		return $this->crypt->symmetricDecryptFileContent($data, $this->fileKey, $this->cipher, $this->version, $position);
-	}
-
-	/**
-	 * update encrypted file, e.g. give additional users access to the file
-	 *
-	 * @param string $path path to the file which should be updated
-	 * @param string $uid of the user who performs the operation
-	 * @param array $accessList who has access to the file contains the key 'users' and 'public'
-	 * @return boolean
-	 */
-	public function update($path, $uid, array $accessList) {
-
-		if (empty($accessList)) {
-			if (isset(self::$rememberVersion[$path])) {
-				$this->keyManager->setVersion($path, self::$rememberVersion[$path], new View());
-				unset(self::$rememberVersion[$path]);
-			}
-			return;
-		}
-
-		$fileKey = $this->keyManager->getFileKey($path, $uid);
-
-		if (!empty($fileKey)) {
-
-			$publicKeys = array();
-			if ($this->useMasterPassword === true) {
-				$publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
-			} else {
-				foreach ($accessList['users'] as $user) {
-					try {
-						$publicKeys[$user] = $this->keyManager->getPublicKey($user);
-					} catch (PublicKeyMissingException $e) {
-						$this->logger->warning('Could not encrypt file for ' . $user . ': ' . $e->getMessage());
-					}
-				}
-			}
-
-			$publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $uid);
-
-			$encryptedFileKey = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
-
-			$this->keyManager->deleteAllFileKeys($path);
-
-			$this->keyManager->setAllFileKeys($path, $encryptedFileKey);
-
-		} else {
-			$this->logger->debug('no file key found, we assume that the file "{file}" is not encrypted',
-				array('file' => $path, 'app' => 'encryption'));
-
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * should the file be encrypted or not
-	 *
-	 * @param string $path
-	 * @return boolean
-	 */
-	public function shouldEncrypt($path) {
-		if ($this->util->shouldEncryptHomeStorage() === false) {
-			$storage = $this->util->getStorage($path);
-			if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
-				return false;
-			}
-		}
-		$parts = explode('/', $path);
-		if (count($parts) < 4) {
-			return false;
-		}
-
-		if ($parts[2] == 'files') {
-			return true;
-		}
-		if ($parts[2] == 'files_versions') {
-			return true;
-		}
-		if ($parts[2] == 'files_trashbin') {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * get size of the unencrypted payload per block.
-	 * ownCloud read/write files with a block size of 8192 byte
-	 *
-	 * @param bool $signed
-	 * @return int
-	 */
-	public function getUnencryptedBlockSize($signed = false) {
-		if ($signed === false) {
-			return $this->unencryptedBlockSize;
-		}
-
-		return $this->unencryptedBlockSizeSigned;
-	}
-
-	/**
-	 * check if the encryption module is able to read the file,
-	 * e.g. if all encryption keys exists
-	 *
-	 * @param string $path
-	 * @param string $uid user for whom we want to check if he can read the file
-	 * @return bool
-	 * @throws DecryptionFailedException
-	 */
-	public function isReadable($path, $uid) {
-		$fileKey = $this->keyManager->getFileKey($path, $uid);
-		if (empty($fileKey)) {
-			$owner = $this->util->getOwner($path);
-			if ($owner !== $uid) {
-				// if it is a shared file we throw a exception with a useful
-				// error message because in this case it means that the file was
-				// shared with the user at a point where the user didn't had a
-				// valid private/public key
-				$msg = 'Encryption module "' . $this->getDisplayName() .
-					'" is not able to read ' . $path;
-				$hint = $this->l->t('Can not read this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
-				$this->logger->warning($msg);
-				throw new DecryptionFailedException($msg, $hint);
-			}
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Initial encryption of all files
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output write some status information to the terminal during encryption
-	 */
-	public function encryptAll(InputInterface $input, OutputInterface $output) {
-		$this->encryptAll->encryptAll($input, $output);
-	}
-
-	/**
-	 * prepare module to perform decrypt all operation
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output
-	 * @param string $user
-	 * @return bool
-	 */
-	public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '') {
-		return $this->decryptAll->prepare($input, $output, $user);
-	}
-
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	protected function getPathToRealFile($path) {
-		$realPath = $path;
-		$parts = explode('/', $path);
-		if ($parts[2] === 'files_versions') {
-			$realPath = '/' . $parts[1] . '/files/' . implode('/', array_slice($parts, 3));
-			$length = strrpos($realPath, '.');
-			$realPath = substr($realPath, 0, $length);
-		}
-
-		return $realPath;
-	}
-
-	/**
-	 * remove .part file extension and the ocTransferId from the file to get the
-	 * original file name
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	protected function stripPartFileExtension($path) {
-		if (pathinfo($path, PATHINFO_EXTENSION) === 'part') {
-			$pos = strrpos($path, '.', -6);
-			$path = substr($path, 0, $pos);
-		}
-
-		return $path;
-	}
-
-	/**
-	 * Check if the module is ready to be used by that specific user.
-	 * In case a module is not ready - because e.g. key pairs have not been generated
-	 * upon login this method can return false before any operation starts and might
-	 * cause issues during operations.
-	 *
-	 * @param string $user
-	 * @return boolean
-	 * @since 9.1.0
-	 */
-	public function isReadyForUser($user) {
-		return $this->keyManager->userHasKeys($user);
-	}
+    const ID = 'OC_DEFAULT_MODULE';
+    const DISPLAY_NAME = 'Default encryption module';
+
+    /**
+     * @var Crypt
+     */
+    private $crypt;
+
+    /** @var string */
+    private $cipher;
+
+    /** @var string */
+    private $path;
+
+    /** @var string */
+    private $user;
+
+    /** @var string */
+    private $fileKey;
+
+    /** @var string */
+    private $writeCache;
+
+    /** @var KeyManager */
+    private $keyManager;
+
+    /** @var array */
+    private $accessList;
+
+    /** @var boolean */
+    private $isWriteOperation;
+
+    /** @var Util */
+    private $util;
+
+    /** @var  Session */
+    private $session;
+
+    /** @var  ILogger */
+    private $logger;
+
+    /** @var IL10N */
+    private $l;
+
+    /** @var EncryptAll */
+    private $encryptAll;
+
+    /** @var  bool */
+    private $useMasterPassword;
+
+    /** @var DecryptAll  */
+    private $decryptAll;
+
+    /** @var int unencrypted block size if block contains signature */
+    private $unencryptedBlockSizeSigned = 6072;
+
+    /** @var int unencrypted block size */
+    private $unencryptedBlockSize = 6126;
+
+    /** @var int Current version of the file */
+    private $version = 0;
+
+    /** @var array remember encryption signature version */
+    private static $rememberVersion = [];
+
+
+    /**
+     *
+     * @param Crypt $crypt
+     * @param KeyManager $keyManager
+     * @param Util $util
+     * @param Session $session
+     * @param EncryptAll $encryptAll
+     * @param DecryptAll $decryptAll
+     * @param ILogger $logger
+     * @param IL10N $il10n
+     */
+    public function __construct(Crypt $crypt,
+                                KeyManager $keyManager,
+                                Util $util,
+                                Session $session,
+                                EncryptAll $encryptAll,
+                                DecryptAll $decryptAll,
+                                ILogger $logger,
+                                IL10N $il10n) {
+        $this->crypt = $crypt;
+        $this->keyManager = $keyManager;
+        $this->util = $util;
+        $this->session = $session;
+        $this->encryptAll = $encryptAll;
+        $this->decryptAll = $decryptAll;
+        $this->logger = $logger;
+        $this->l = $il10n;
+        $this->useMasterPassword = $util->isMasterKeyEnabled();
+    }
+
+    /**
+     * @return string defining the technical unique id
+     */
+    public function getId() {
+        return self::ID;
+    }
+
+    /**
+     * In comparison to getKey() this function returns a human readable (maybe translated) name
+     *
+     * @return string
+     */
+    public function getDisplayName() {
+        return self::DISPLAY_NAME;
+    }
+
+    /**
+     * start receiving chunks from a file. This is the place where you can
+     * perform some initial step before starting encrypting/decrypting the
+     * chunks
+     *
+     * @param string $path to the file
+     * @param string $user who read/write the file
+     * @param string $mode php stream open mode
+     * @param array $header contains the header data read from the file
+     * @param array $accessList who has access to the file contains the key 'users' and 'public'
+     *
+     * @return array $header contain data as key-value pairs which should be
+     *                       written to the header, in case of a write operation
+     *                       or if no additional data is needed return a empty array
+     */
+    public function begin($path, $user, $mode, array $header, array $accessList) {
+        $this->path = $this->getPathToRealFile($path);
+        $this->accessList = $accessList;
+        $this->user = $user;
+        $this->isWriteOperation = false;
+        $this->writeCache = '';
+
+        if ($this->session->decryptAllModeActivated()) {
+            $encryptedFileKey = $this->keyManager->getEncryptedFileKey($this->path);
+            $shareKey = $this->keyManager->getShareKey($this->path, $this->session->getDecryptAllUid());
+            $this->fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey,
+                $shareKey,
+                $this->session->getDecryptAllKey());
+        } else {
+            $this->fileKey = $this->keyManager->getFileKey($this->path, $this->user);
+        }
+
+        // always use the version from the original file, also part files
+        // need to have a correct version number if they get moved over to the
+        // final location
+        $this->version = (int)$this->keyManager->getVersion($this->stripPartFileExtension($path), new View());
+
+        if (
+            $mode === 'w'
+            || $mode === 'w+'
+            || $mode === 'wb'
+            || $mode === 'wb+'
+        ) {
+            $this->isWriteOperation = true;
+            if (empty($this->fileKey)) {
+                $this->fileKey = $this->crypt->generateFileKey();
+            }
+        } else {
+            // if we read a part file we need to increase the version by 1
+            // because the version number was also increased by writing
+            // the part file
+            if(Scanner::isPartialFile($path)) {
+                $this->version = $this->version + 1;
+            }
+        }
+
+        if ($this->isWriteOperation) {
+            $this->cipher = $this->crypt->getCipher();
+        } elseif (isset($header['cipher'])) {
+            $this->cipher = $header['cipher'];
+        } else {
+            // if we read a file without a header we fall-back to the legacy cipher
+            // which was used in <=oC6
+            $this->cipher = $this->crypt->getLegacyCipher();
+        }
+
+        return array('cipher' => $this->cipher, 'signed' => 'true');
+    }
+
+    /**
+     * last chunk received. This is the place where you can perform some final
+     * operation and return some remaining data if something is left in your
+     * buffer.
+     *
+     * @param string $path to the file
+     * @param int $position
+     * @return string remained data which should be written to the file in case
+     *                of a write operation
+     * @throws PublicKeyMissingException
+     * @throws \Exception
+     * @throws \OCA\Encryption\Exceptions\MultiKeyEncryptException
+     */
+    public function end($path, $position = 0) {
+        $result = '';
+        if ($this->isWriteOperation) {
+            $this->keyManager->setVersion($path, $this->version + 1, new View());
+            // in case of a part file we remember the new signature versions
+            // the version will be set later on update.
+            // This way we make sure that other apps listening to the pre-hooks
+            // still get the old version which should be the correct value for them
+            if (Scanner::isPartialFile($path)) {
+                self::$rememberVersion[$this->stripPartFileExtension($path)] = $this->version + 1;
+            }
+            if (!empty($this->writeCache)) {
+                $result = $this->crypt->symmetricEncryptFileContent($this->writeCache, $this->fileKey, $this->version + 1, $position);
+                $this->writeCache = '';
+            }
+            $publicKeys = array();
+            if ($this->useMasterPassword === true) {
+                $publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
+            } else {
+                foreach ($this->accessList['users'] as $uid) {
+                    try {
+                        $publicKeys[$uid] = $this->keyManager->getPublicKey($uid);
+                    } catch (PublicKeyMissingException $e) {
+                        $this->logger->warning(
+                            'no public key found for user "{uid}", user will not be able to read the file',
+                            ['app' => 'encryption', 'uid' => $uid]
+                        );
+                        // if the public key of the owner is missing we should fail
+                        if ($uid === $this->user) {
+                            throw $e;
+                        }
+                    }
+                }
+            }
+
+            $publicKeys = $this->keyManager->addSystemKeys($this->accessList, $publicKeys, $this->user);
+            $encryptedKeyfiles = $this->crypt->multiKeyEncrypt($this->fileKey, $publicKeys);
+            $this->keyManager->setAllFileKeys($this->path, $encryptedKeyfiles);
+        }
+        return $result;
+    }
+
+    /**
+     * encrypt data
+     *
+     * @param string $data you want to encrypt
+     * @param int $position
+     * @return string encrypted data
+     */
+    public function encrypt($data, $position = 0) {
+        // If extra data is left over from the last round, make sure it
+        // is integrated into the next block
+        if ($this->writeCache) {
+
+            // Concat writeCache to start of $data
+            $data = $this->writeCache . $data;
+
+            // Clear the write cache, ready for reuse - it has been
+            // flushed and its old contents processed
+            $this->writeCache = '';
+
+        }
+
+        $encrypted = '';
+        // While there still remains some data to be processed & written
+        while (strlen($data) > 0) {
+
+            // Remaining length for this iteration, not of the
+            // entire file (may be greater than 8192 bytes)
+            $remainingLength = strlen($data);
+
+            // If data remaining to be written is less than the
+            // size of 1 6126 byte block
+            if ($remainingLength < $this->unencryptedBlockSizeSigned) {
+
+                // Set writeCache to contents of $data
+                // The writeCache will be carried over to the
+                // next write round, and added to the start of
+                // $data to ensure that written blocks are
+                // always the correct length. If there is still
+                // data in writeCache after the writing round
+                // has finished, then the data will be written
+                // to disk by $this->flush().
+                $this->writeCache = $data;
+
+                // Clear $data ready for next round
+                $data = '';
+
+            } else {
+
+                // Read the chunk from the start of $data
+                $chunk = substr($data, 0, $this->unencryptedBlockSizeSigned);
+
+                $encrypted .= $this->crypt->symmetricEncryptFileContent($chunk, $this->fileKey, $this->version + 1, $position);
+
+                // Remove the chunk we just processed from
+                // $data, leaving only unprocessed data in $data
+                // var, for handling on the next round
+                $data = substr($data, $this->unencryptedBlockSizeSigned);
+
+            }
+
+        }
+
+        return $encrypted;
+    }
+
+    /**
+     * decrypt data
+     *
+     * @param string $data you want to decrypt
+     * @param int $position
+     * @return string decrypted data
+     * @throws DecryptionFailedException
+     */
+    public function decrypt($data, $position = 0) {
+        if (empty($this->fileKey)) {
+            $msg = 'Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.';
+            $hint = $this->l->t('Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
+            $this->logger->error($msg);
+
+            throw new DecryptionFailedException($msg, $hint);
+        }
+
+        return $this->crypt->symmetricDecryptFileContent($data, $this->fileKey, $this->cipher, $this->version, $position);
+    }
+
+    /**
+     * update encrypted file, e.g. give additional users access to the file
+     *
+     * @param string $path path to the file which should be updated
+     * @param string $uid of the user who performs the operation
+     * @param array $accessList who has access to the file contains the key 'users' and 'public'
+     * @return boolean
+     */
+    public function update($path, $uid, array $accessList) {
+
+        if (empty($accessList)) {
+            if (isset(self::$rememberVersion[$path])) {
+                $this->keyManager->setVersion($path, self::$rememberVersion[$path], new View());
+                unset(self::$rememberVersion[$path]);
+            }
+            return;
+        }
+
+        $fileKey = $this->keyManager->getFileKey($path, $uid);
+
+        if (!empty($fileKey)) {
+
+            $publicKeys = array();
+            if ($this->useMasterPassword === true) {
+                $publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
+            } else {
+                foreach ($accessList['users'] as $user) {
+                    try {
+                        $publicKeys[$user] = $this->keyManager->getPublicKey($user);
+                    } catch (PublicKeyMissingException $e) {
+                        $this->logger->warning('Could not encrypt file for ' . $user . ': ' . $e->getMessage());
+                    }
+                }
+            }
+
+            $publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $uid);
+
+            $encryptedFileKey = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
+
+            $this->keyManager->deleteAllFileKeys($path);
+
+            $this->keyManager->setAllFileKeys($path, $encryptedFileKey);
+
+        } else {
+            $this->logger->debug('no file key found, we assume that the file "{file}" is not encrypted',
+                array('file' => $path, 'app' => 'encryption'));
+
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * should the file be encrypted or not
+     *
+     * @param string $path
+     * @return boolean
+     */
+    public function shouldEncrypt($path) {
+        if ($this->util->shouldEncryptHomeStorage() === false) {
+            $storage = $this->util->getStorage($path);
+            if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
+                return false;
+            }
+        }
+        $parts = explode('/', $path);
+        if (count($parts) < 4) {
+            return false;
+        }
+
+        if ($parts[2] == 'files') {
+            return true;
+        }
+        if ($parts[2] == 'files_versions') {
+            return true;
+        }
+        if ($parts[2] == 'files_trashbin') {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * get size of the unencrypted payload per block.
+     * ownCloud read/write files with a block size of 8192 byte
+     *
+     * @param bool $signed
+     * @return int
+     */
+    public function getUnencryptedBlockSize($signed = false) {
+        if ($signed === false) {
+            return $this->unencryptedBlockSize;
+        }
+
+        return $this->unencryptedBlockSizeSigned;
+    }
+
+    /**
+     * check if the encryption module is able to read the file,
+     * e.g. if all encryption keys exists
+     *
+     * @param string $path
+     * @param string $uid user for whom we want to check if he can read the file
+     * @return bool
+     * @throws DecryptionFailedException
+     */
+    public function isReadable($path, $uid) {
+        $fileKey = $this->keyManager->getFileKey($path, $uid);
+        if (empty($fileKey)) {
+            $owner = $this->util->getOwner($path);
+            if ($owner !== $uid) {
+                // if it is a shared file we throw a exception with a useful
+                // error message because in this case it means that the file was
+                // shared with the user at a point where the user didn't had a
+                // valid private/public key
+                $msg = 'Encryption module "' . $this->getDisplayName() .
+                    '" is not able to read ' . $path;
+                $hint = $this->l->t('Can not read this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
+                $this->logger->warning($msg);
+                throw new DecryptionFailedException($msg, $hint);
+            }
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Initial encryption of all files
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output write some status information to the terminal during encryption
+     */
+    public function encryptAll(InputInterface $input, OutputInterface $output) {
+        $this->encryptAll->encryptAll($input, $output);
+    }
+
+    /**
+     * prepare module to perform decrypt all operation
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @param string $user
+     * @return bool
+     */
+    public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '') {
+        return $this->decryptAll->prepare($input, $output, $user);
+    }
+
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    protected function getPathToRealFile($path) {
+        $realPath = $path;
+        $parts = explode('/', $path);
+        if ($parts[2] === 'files_versions') {
+            $realPath = '/' . $parts[1] . '/files/' . implode('/', array_slice($parts, 3));
+            $length = strrpos($realPath, '.');
+            $realPath = substr($realPath, 0, $length);
+        }
+
+        return $realPath;
+    }
+
+    /**
+     * remove .part file extension and the ocTransferId from the file to get the
+     * original file name
+     *
+     * @param string $path
+     * @return string
+     */
+    protected function stripPartFileExtension($path) {
+        if (pathinfo($path, PATHINFO_EXTENSION) === 'part') {
+            $pos = strrpos($path, '.', -6);
+            $path = substr($path, 0, $pos);
+        }
+
+        return $path;
+    }
+
+    /**
+     * Check if the module is ready to be used by that specific user.
+     * In case a module is not ready - because e.g. key pairs have not been generated
+     * upon login this method can return false before any operation starts and might
+     * cause issues during operations.
+     *
+     * @param string $user
+     * @return boolean
+     * @since 9.1.0
+     */
+    public function isReadyForUser($user) {
+        return $this->keyManager->userHasKeys($user);
+    }
 }

Spacing +7 added lines, -7 removed lines

@@ -190,7 +190,7 @@ 
 		// always use the version from the original file, also part files
 		// need to have a correct version number if they get moved over to the
 		// final location
-		$this->version = (int)$this->keyManager->getVersion($this->stripPartFileExtension($path), new View());
+		$this->version = (int) $this->keyManager->getVersion($this->stripPartFileExtension($path), new View());
 
 		if (
 			$mode === 'w'
@@ -206,7 +206,7 @@ 
 			// if we read a part file we need to increase the version by 1
 			// because the version number was also increased by writing
 			// the part file
-			if(Scanner::isPartialFile($path)) {
+			if (Scanner::isPartialFile($path)) {
 				$this->version = $this->version + 1;
 			}
 		}
@@ -292,7 +292,7 @@ 
 		if ($this->writeCache) {
 
 			// Concat writeCache to start of $data
-			$data = $this->writeCache . $data;
+			$data = $this->writeCache.$data;
 
 			// Clear the write cache, ready for reuse - it has been
 			// flushed and its old contents processed
@@ -394,7 +394,7 @@ 
 					try {
 						$publicKeys[$user] = $this->keyManager->getPublicKey($user);
 					} catch (PublicKeyMissingException $e) {
-						$this->logger->warning('Could not encrypt file for ' . $user . ': ' . $e->getMessage());
+						$this->logger->warning('Could not encrypt file for '.$user.': '.$e->getMessage());
 					}
 				}
 			}
@@ -481,8 +481,8 @@ 
 				// error message because in this case it means that the file was
 				// shared with the user at a point where the user didn't had a
 				// valid private/public key
-				$msg = 'Encryption module "' . $this->getDisplayName() .
-					'" is not able to read ' . $path;
+				$msg = 'Encryption module "'.$this->getDisplayName().
+					'" is not able to read '.$path;
 				$hint = $this->l->t('Can not read this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
 				$this->logger->warning($msg);
 				throw new DecryptionFailedException($msg, $hint);
@@ -524,7 +524,7 @@ 
 		$realPath = $path;
 		$parts = explode('/', $path);
 		if ($parts[2] === 'files_versions') {
-			$realPath = '/' . $parts[1] . '/files/' . implode('/', array_slice($parts, 3));
+			$realPath = '/'.$parts[1].'/files/'.implode('/', array_slice($parts, 3));
 			$length = strrpos($realPath, '.');
 			$realPath = substr($realPath, 0, $length);
 		}