nextcloud / server

lib/public/Util.php

Indentation +524 added lines, -524 removed lines

@@ -57,530 +57,530 @@
  * @since 4.0.0
  */
 class Util {
-	// consts for Logging
-	const DEBUG=0;
-	const INFO=1;
-	const WARN=2;
-	const ERROR=3;
-	const FATAL=4;
-
-	/** \OCP\Share\IManager */
-	private static $shareManager;
-
-	/**
-	 * 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;
+
+    /** \OCP\Share\IManager */
+    private static $shareManager;
+
+    /**
+     * 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) {
-		\OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
-	}
+    /**
+     * Set current update channel
+     * @param string $channel
+     * @since 8.1.0
+     */
+    public static function setChannel($channel) {
+        \OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
+    }
 	
-	/**
-	 * Get current update channel
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public static function getChannel() {
-		return \OC_Util::getChannel();
-	}
-
-	/**
-	 * write a message in the log
-	 * @param string $app
-	 * @param string $message
-	 * @param int $level
-	 * @since 4.0.0
-	 * @deprecated 13.0.0 use log of \OCP\ILogger
-	 */
-	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
-	 * @deprecated 9.1.0 Use \OC::$server->getShareManager()->sharingDisabledForUser
-	 */
-	public static function isSharingDisabledForUser() {
-		if (self::$shareManager === null) {
-			self::$shareManager = \OC::$server->getShareManager();
-		}
-
-		$user = \OC::$server->getUserSession()->getUser();
-		if ($user !== null) {
-			$user = $user->getUID();
-		}
-
-		return self::$shareManager->sharingDisabledForUser($user);
-	}
-
-	/**
-	 * get l10n object
-	 * @param string $application
-	 * @param string|null $language
-	 * @return \OCP\IL10N
-	 * @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);
-	}
-
-	/**
-	 * 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 name without an eventual port number
-	 * @return string the server hostname
-	 * @since 5.0.0
-	 */
-	public static function getServerHostName() {
-		$host_name = \OC::$server->getRequest()->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';
-	}
-
-	/**
-	 * 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 float 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 mixed $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
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function isValidFileName($file) {
-		return \OC_Util::isValidFileName($file);
-	}
-
-	/**
-	 * Compare two strings to provide a natural sort
-	 * @param string $a first string to compare
-	 * @param string $b second string to compare
-	 * @return int -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->getSystemConfig());
-		}		
-		return self::$needUpgradeCache;
-	}
+    /**
+     * Get current update channel
+     * @return string
+     * @since 8.1.0
+     */
+    public static function getChannel() {
+        return \OC_Util::getChannel();
+    }
+
+    /**
+     * write a message in the log
+     * @param string $app
+     * @param string $message
+     * @param int $level
+     * @since 4.0.0
+     * @deprecated 13.0.0 use log of \OCP\ILogger
+     */
+    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
+     * @deprecated 9.1.0 Use \OC::$server->getShareManager()->sharingDisabledForUser
+     */
+    public static function isSharingDisabledForUser() {
+        if (self::$shareManager === null) {
+            self::$shareManager = \OC::$server->getShareManager();
+        }
+
+        $user = \OC::$server->getUserSession()->getUser();
+        if ($user !== null) {
+            $user = $user->getUID();
+        }
+
+        return self::$shareManager->sharingDisabledForUser($user);
+    }
+
+    /**
+     * get l10n object
+     * @param string $application
+     * @param string|null $language
+     * @return \OCP\IL10N
+     * @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);
+    }
+
+    /**
+     * 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 name without an eventual port number
+     * @return string the server hostname
+     * @since 5.0.0
+     */
+    public static function getServerHostName() {
+        $host_name = \OC::$server->getRequest()->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';
+    }
+
+    /**
+     * 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 float 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 mixed $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
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function isValidFileName($file) {
+        return \OC_Util::isValidFileName($file);
+    }
+
+    /**
+     * Compare two strings to provide a natural sort
+     * @param string $a first string to compare
+     * @param string $b second string to compare
+     * @return int -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->getSystemConfig());
+        }		
+        return self::$needUpgradeCache;
+    }
 }

Spacing +22 added lines, -22 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;
 
 	/** \OCP\Share\IManager */
 	private static $shareManager;
@@ -102,7 +102,7 @@ 
 	 * @since 4.0.0
 	 * @deprecated 13.0.0 use log of \OCP\ILogger
 	 */
-	public static function writeLog( $app, $message, $level ) {
+	public static function writeLog($app, $message, $level) {
 		$context = ['app' => $app];
 		\OC::$server->getLogger()->log($level, $message, $context);
 	}
@@ -115,7 +115,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]);
 	}
 
@@ -156,8 +156,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);
 	}
 
 	/**
@@ -166,8 +166,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);
 	}
 
 	/**
@@ -189,7 +189,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);
 	}
 
@@ -202,7 +202,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)
@@ -215,11 +215,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] != '/') ? '/' : '')
 		);
 	}
 
@@ -242,7 +242,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);
 	}
 
@@ -256,7 +256,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);
 	}
 
@@ -315,7 +315,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);
 	}
 
@@ -386,7 +386,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;
@@ -398,7 +398,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();
 		}
@@ -579,7 +579,7 @@ 
 	 */
 	public static function needUpgrade() {
 		if (!isset(self::$needUpgradeCache)) {
-			self::$needUpgradeCache=\OC_Util::needUpgrade(\OC::$server->getSystemConfig());
+			self::$needUpgradeCache = \OC_Util::needUpgrade(\OC::$server->getSystemConfig());
 		}		
 		return self::$needUpgradeCache;
 	}

lib/public/IServerContainer.php

Indentation +496 added lines, -496 removed lines

@@ -57,500 +57,500 @@
  */
 interface IServerContainer extends IContainer {
 
-	/**
-	 * The calendar manager will act as a broker between consumers for calendar information and
-	 * providers which actual deliver the calendar information.
-	 *
-	 * @return \OCP\Calendar\IManager
-	 * @since 13.0.0
-	 */
-	public function getCalendarManager();
-
-	/**
-	 * The contacts manager will act as a broker between consumers for contacts information and
-	 * providers which actual deliver the contact information.
-	 *
-	 * @return \OCP\Contacts\IManager
-	 * @since 6.0.0
-	 */
-	public function getContactsManager();
-
-	/**
-	 * The current request object holding all information about the request currently being processed
-	 * is returned from this method.
-	 * In case the current execution was not initiated by a web request null is returned
-	 *
-	 * @return \OCP\IRequest
-	 * @since 6.0.0
-	 */
-	public function getRequest();
-
-	/**
-	 * Returns the preview manager which can create preview images for a given file
-	 *
-	 * @return \OCP\IPreview
-	 * @since 6.0.0
-	 */
-	public function getPreviewManager();
-
-	/**
-	 * Returns the tag manager which can get and set tags for different object types
-	 *
-	 * @see \OCP\ITagManager::load()
-	 * @return \OCP\ITagManager
-	 * @since 6.0.0
-	 */
-	public function getTagManager();
-
-	/**
-	 * Returns the root folder of ownCloud's data directory
-	 *
-	 * @return \OCP\Files\IRootFolder
-	 * @since 6.0.0 - between 6.0.0 and 8.0.0 this returned \OCP\Files\Folder
-	 */
-	public function getRootFolder();
-
-	/**
-	 * Returns a view to ownCloud's files folder
-	 *
-	 * @param string $userId user ID
-	 * @return \OCP\Files\Folder
-	 * @since 6.0.0 - parameter $userId was added in 8.0.0
-	 * @see getUserFolder in \OCP\Files\IRootFolder
-	 */
-	public function getUserFolder($userId = null);
-
-	/**
-	 * Returns an app-specific view in ownClouds data directory
-	 *
-	 * @return \OCP\Files\Folder
-	 * @since 6.0.0
-	 * @deprecated 9.2.0 use IAppData
-	 */
-	public function getAppFolder();
-
-	/**
-	 * Returns a user manager
-	 *
-	 * @return \OCP\IUserManager
-	 * @since 8.0.0
-	 */
-	public function getUserManager();
-
-	/**
-	 * Returns a group manager
-	 *
-	 * @return \OCP\IGroupManager
-	 * @since 8.0.0
-	 */
-	public function getGroupManager();
-
-	/**
-	 * Returns the user session
-	 *
-	 * @return \OCP\IUserSession
-	 * @since 6.0.0
-	 */
-	public function getUserSession();
-
-	/**
-	 * Returns the navigation manager
-	 *
-	 * @return \OCP\INavigationManager
-	 * @since 6.0.0
-	 */
-	public function getNavigationManager();
-
-	/**
-	 * Returns the config manager
-	 *
-	 * @return \OCP\IConfig
-	 * @since 6.0.0
-	 */
-	public function getConfig();
-
-	/**
-	 * Returns a Crypto instance
-	 *
-	 * @return \OCP\Security\ICrypto
-	 * @since 8.0.0
-	 */
-	public function getCrypto();
-
-	/**
-	 * Returns a Hasher instance
-	 *
-	 * @return \OCP\Security\IHasher
-	 * @since 8.0.0
-	 */
-	public function getHasher();
-
-	/**
-	 * Returns a SecureRandom instance
-	 *
-	 * @return \OCP\Security\ISecureRandom
-	 * @since 8.1.0
-	 */
-	public function getSecureRandom();
-
-	/**
-	 * Returns a CredentialsManager instance
-	 *
-	 * @return \OCP\Security\ICredentialsManager
-	 * @since 9.0.0
-	 */
-	public function getCredentialsManager();
-
-	/**
-	 * Returns the app config manager
-	 *
-	 * @return \OCP\IAppConfig
-	 * @since 7.0.0
-	 */
-	public function getAppConfig();
-
-	/**
-	 * @return \OCP\L10N\IFactory
-	 * @since 8.2.0
-	 */
-	public function getL10NFactory();
-
-	/**
-	 * get an L10N instance
-	 * @param string $app appid
-	 * @param string $lang
-	 * @return \OCP\IL10N
-	 * @since 6.0.0 - parameter $lang was added in 8.0.0
-	 */
-	public function getL10N($app, $lang = null);
-
-	/**
-	 * @return \OC\Encryption\Manager
-	 * @since 8.1.0
-	 */
-	public function getEncryptionManager();
-
-	/**
-	 * @return \OC\Encryption\File
-	 * @since 8.1.0
-	 */
-	public function getEncryptionFilesHelper();
-
-	/**
-	 * @return \OCP\Encryption\Keys\IStorage
-	 * @since 8.1.0
-	 */
-	public function getEncryptionKeyStorage();
-
-	/**
-	 * Returns the URL generator
-	 *
-	 * @return \OCP\IURLGenerator
-	 * @since 6.0.0
-	 */
-	public function getURLGenerator();
-
-	/**
-	 * Returns the Helper
-	 *
-	 * @return \OCP\IHelper
-	 * @since 6.0.0
-	 */
-	public function getHelper();
-
-	/**
-	 * Returns an ICache instance
-	 *
-	 * @return \OCP\ICache
-	 * @since 6.0.0
-	 */
-	public function getCache();
-
-	/**
-	 * Returns an \OCP\CacheFactory instance
-	 *
-	 * @return \OCP\ICacheFactory
-	 * @since 7.0.0
-	 */
-	public function getMemCacheFactory();
-
-	/**
-	 * Returns the current session
-	 *
-	 * @return \OCP\ISession
-	 * @since 6.0.0
-	 */
-	public function getSession();
-
-	/**
-	 * Returns the activity manager
-	 *
-	 * @return \OCP\Activity\IManager
-	 * @since 6.0.0
-	 */
-	public function getActivityManager();
-
-	/**
-	 * Returns the current session
-	 *
-	 * @return \OCP\IDBConnection
-	 * @since 6.0.0
-	 */
-	public function getDatabaseConnection();
-
-	/**
-	 * Returns an avatar manager, used for avatar functionality
-	 *
-	 * @return \OCP\IAvatarManager
-	 * @since 6.0.0
-	 */
-	public function getAvatarManager();
-
-	/**
-	 * Returns an job list for controlling background jobs
-	 *
-	 * @return \OCP\BackgroundJob\IJobList
-	 * @since 7.0.0
-	 */
-	public function getJobList();
-
-	/**
-	 * Returns a logger instance
-	 *
-	 * @return \OCP\ILogger
-	 * @since 8.0.0
-	 */
-	public function getLogger();
-
-	/**
-	 * Returns a router for generating and matching urls
-	 *
-	 * @return \OCP\Route\IRouter
-	 * @since 7.0.0
-	 */
-	public function getRouter();
-
-	/**
-	 * Returns a search instance
-	 *
-	 * @return \OCP\ISearch
-	 * @since 7.0.0
-	 */
-	public function getSearch();
-
-	/**
-	 * Get the certificate manager for the user
-	 *
-	 * @param string $userId (optional) if not specified the current loggedin user is used, use null to get the system certificate manager
-	 * @return \OCP\ICertificateManager | null if $userId is null and no user is logged in
-	 * @since 8.0.0
-	 */
-	public function getCertificateManager($userId = null);
-
-	/**
-	 * Create a new event source
-	 *
-	 * @return \OCP\IEventSource
-	 * @since 8.0.0
-	 */
-	public function createEventSource();
-
-	/**
-	 * Returns an instance of the HTTP helper class
-	 * @return \OC\HTTPHelper
-	 * @deprecated 8.1.0 Use \OCP\Http\Client\IClientService
-	 * @since 8.0.0
-	 */
-	public function getHTTPHelper();
-
-	/**
-	 * Returns an instance of the HTTP client service
-	 *
-	 * @return \OCP\Http\Client\IClientService
-	 * @since 8.1.0
-	 */
-	public function getHTTPClientService();
-
-	/**
-	 * Get the active event logger
-	 *
-	 * @return \OCP\Diagnostics\IEventLogger
-	 * @since 8.0.0
-	 */
-	public function getEventLogger();
-
-	/**
-	 * Get the active query logger
-	 *
-	 * The returned logger only logs data when debug mode is enabled
-	 *
-	 * @return \OCP\Diagnostics\IQueryLogger
-	 * @since 8.0.0
-	 */
-	public function getQueryLogger();
-
-	/**
-	 * Get the manager for temporary files and folders
-	 *
-	 * @return \OCP\ITempManager
-	 * @since 8.0.0
-	 */
-	public function getTempManager();
-
-	/**
-	 * Get the app manager
-	 *
-	 * @return \OCP\App\IAppManager
-	 * @since 8.0.0
-	 */
-	public function getAppManager();
-
-	/**
-	 * Get the webroot
-	 *
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function getWebRoot();
-
-	/**
-	 * @return \OCP\Files\Config\IMountProviderCollection
-	 * @since 8.0.0
-	 */
-	public function getMountProviderCollection();
-
-	/**
-	 * Get the IniWrapper
-	 *
-	 * @return \bantu\IniGetWrapper\IniGetWrapper
-	 * @since 8.0.0
-	 */
-	public function getIniWrapper();
-	/**
-	 * @return \OCP\Command\IBus
-	 * @since 8.1.0
-	 */
-	public function getCommandBus();
-
-	/**
-	 * Creates a new mailer
-	 *
-	 * @return \OCP\Mail\IMailer
-	 * @since 8.1.0
-	 */
-	public function getMailer();
-
-	/**
-	 * Get the locking provider
-	 *
-	 * @return \OCP\Lock\ILockingProvider
-	 * @since 8.1.0
-	 */
-	public function getLockingProvider();
-
-	/**
-	 * @return \OCP\Files\Mount\IMountManager
-	 * @since 8.2.0
-	 */
-	public function getMountManager();
-
-	/**
-	 * Get the MimeTypeDetector
-	 *
-	 * @return \OCP\Files\IMimeTypeDetector
-	 * @since 8.2.0
-	 */
-	public function getMimeTypeDetector();
-
-	/**
-	 * Get the MimeTypeLoader
-	 *
-	 * @return \OCP\Files\IMimeTypeLoader
-	 * @since 8.2.0
-	 */
-	public function getMimeTypeLoader();
-
-	/**
-	 * Get the EventDispatcher
-	 *
-	 * @return EventDispatcherInterface
-	 * @since 8.2.0
-	 */
-	public function getEventDispatcher();
-
-	/**
-	 * Get the Notification Manager
-	 *
-	 * @return \OCP\Notification\IManager
-	 * @since 9.0.0
-	 */
-	public function getNotificationManager();
-
-	/**
-	 * @return \OCP\Comments\ICommentsManager
-	 * @since 9.0.0
-	 */
-	public function getCommentsManager();
-
-	/**
-	 * Returns the system-tag manager
-	 *
-	 * @return \OCP\SystemTag\ISystemTagManager
-	 *
-	 * @since 9.0.0
-	 */
-	public function getSystemTagManager();
-
-	/**
-	 * Returns the system-tag object mapper
-	 *
-	 * @return \OCP\SystemTag\ISystemTagObjectMapper
-	 *
-	 * @since 9.0.0
-	 */
-	public function getSystemTagObjectMapper();
-
-	/**
-	 * Returns the share manager
-	 *
-	 * @return \OCP\Share\IManager
-	 * @since 9.0.0
-	 */
-	public function getShareManager();
-
-	/**
-	 * @return IContentSecurityPolicyManager
-	 * @since 9.0.0
-	 */
-	public function getContentSecurityPolicyManager();
-
-	/**
-	 * @return \OCP\IDateTimeZone
-	 * @since 8.0.0
-	 */
-	public function getDateTimeZone();
-
-	/**
-	 * @return \OCP\IDateTimeFormatter
-	 * @since 8.0.0
-	 */
-	public function getDateTimeFormatter();
-
-	/**
-	 * @return \OCP\Federation\ICloudIdManager
-	 * @since 12.0.0
-	 */
-	public function getCloudIdManager();
-
-	/**
-	 * @return \OCP\Remote\Api\IApiFactory
-	 * @since 13.0.0
-	 */
-	public function getRemoteApiFactory();
-
-	/**
-	 * @return \OCP\Remote\IInstanceFactory
-	 * @since 13.0.0
-	 */
-	public function getRemoteInstanceFactory();
+    /**
+     * The calendar manager will act as a broker between consumers for calendar information and
+     * providers which actual deliver the calendar information.
+     *
+     * @return \OCP\Calendar\IManager
+     * @since 13.0.0
+     */
+    public function getCalendarManager();
+
+    /**
+     * The contacts manager will act as a broker between consumers for contacts information and
+     * providers which actual deliver the contact information.
+     *
+     * @return \OCP\Contacts\IManager
+     * @since 6.0.0
+     */
+    public function getContactsManager();
+
+    /**
+     * The current request object holding all information about the request currently being processed
+     * is returned from this method.
+     * In case the current execution was not initiated by a web request null is returned
+     *
+     * @return \OCP\IRequest
+     * @since 6.0.0
+     */
+    public function getRequest();
+
+    /**
+     * Returns the preview manager which can create preview images for a given file
+     *
+     * @return \OCP\IPreview
+     * @since 6.0.0
+     */
+    public function getPreviewManager();
+
+    /**
+     * Returns the tag manager which can get and set tags for different object types
+     *
+     * @see \OCP\ITagManager::load()
+     * @return \OCP\ITagManager
+     * @since 6.0.0
+     */
+    public function getTagManager();
+
+    /**
+     * Returns the root folder of ownCloud's data directory
+     *
+     * @return \OCP\Files\IRootFolder
+     * @since 6.0.0 - between 6.0.0 and 8.0.0 this returned \OCP\Files\Folder
+     */
+    public function getRootFolder();
+
+    /**
+     * Returns a view to ownCloud's files folder
+     *
+     * @param string $userId user ID
+     * @return \OCP\Files\Folder
+     * @since 6.0.0 - parameter $userId was added in 8.0.0
+     * @see getUserFolder in \OCP\Files\IRootFolder
+     */
+    public function getUserFolder($userId = null);
+
+    /**
+     * Returns an app-specific view in ownClouds data directory
+     *
+     * @return \OCP\Files\Folder
+     * @since 6.0.0
+     * @deprecated 9.2.0 use IAppData
+     */
+    public function getAppFolder();
+
+    /**
+     * Returns a user manager
+     *
+     * @return \OCP\IUserManager
+     * @since 8.0.0
+     */
+    public function getUserManager();
+
+    /**
+     * Returns a group manager
+     *
+     * @return \OCP\IGroupManager
+     * @since 8.0.0
+     */
+    public function getGroupManager();
+
+    /**
+     * Returns the user session
+     *
+     * @return \OCP\IUserSession
+     * @since 6.0.0
+     */
+    public function getUserSession();
+
+    /**
+     * Returns the navigation manager
+     *
+     * @return \OCP\INavigationManager
+     * @since 6.0.0
+     */
+    public function getNavigationManager();
+
+    /**
+     * Returns the config manager
+     *
+     * @return \OCP\IConfig
+     * @since 6.0.0
+     */
+    public function getConfig();
+
+    /**
+     * Returns a Crypto instance
+     *
+     * @return \OCP\Security\ICrypto
+     * @since 8.0.0
+     */
+    public function getCrypto();
+
+    /**
+     * Returns a Hasher instance
+     *
+     * @return \OCP\Security\IHasher
+     * @since 8.0.0
+     */
+    public function getHasher();
+
+    /**
+     * Returns a SecureRandom instance
+     *
+     * @return \OCP\Security\ISecureRandom
+     * @since 8.1.0
+     */
+    public function getSecureRandom();
+
+    /**
+     * Returns a CredentialsManager instance
+     *
+     * @return \OCP\Security\ICredentialsManager
+     * @since 9.0.0
+     */
+    public function getCredentialsManager();
+
+    /**
+     * Returns the app config manager
+     *
+     * @return \OCP\IAppConfig
+     * @since 7.0.0
+     */
+    public function getAppConfig();
+
+    /**
+     * @return \OCP\L10N\IFactory
+     * @since 8.2.0
+     */
+    public function getL10NFactory();
+
+    /**
+     * get an L10N instance
+     * @param string $app appid
+     * @param string $lang
+     * @return \OCP\IL10N
+     * @since 6.0.0 - parameter $lang was added in 8.0.0
+     */
+    public function getL10N($app, $lang = null);
+
+    /**
+     * @return \OC\Encryption\Manager
+     * @since 8.1.0
+     */
+    public function getEncryptionManager();
+
+    /**
+     * @return \OC\Encryption\File
+     * @since 8.1.0
+     */
+    public function getEncryptionFilesHelper();
+
+    /**
+     * @return \OCP\Encryption\Keys\IStorage
+     * @since 8.1.0
+     */
+    public function getEncryptionKeyStorage();
+
+    /**
+     * Returns the URL generator
+     *
+     * @return \OCP\IURLGenerator
+     * @since 6.0.0
+     */
+    public function getURLGenerator();
+
+    /**
+     * Returns the Helper
+     *
+     * @return \OCP\IHelper
+     * @since 6.0.0
+     */
+    public function getHelper();
+
+    /**
+     * Returns an ICache instance
+     *
+     * @return \OCP\ICache
+     * @since 6.0.0
+     */
+    public function getCache();
+
+    /**
+     * Returns an \OCP\CacheFactory instance
+     *
+     * @return \OCP\ICacheFactory
+     * @since 7.0.0
+     */
+    public function getMemCacheFactory();
+
+    /**
+     * Returns the current session
+     *
+     * @return \OCP\ISession
+     * @since 6.0.0
+     */
+    public function getSession();
+
+    /**
+     * Returns the activity manager
+     *
+     * @return \OCP\Activity\IManager
+     * @since 6.0.0
+     */
+    public function getActivityManager();
+
+    /**
+     * Returns the current session
+     *
+     * @return \OCP\IDBConnection
+     * @since 6.0.0
+     */
+    public function getDatabaseConnection();
+
+    /**
+     * Returns an avatar manager, used for avatar functionality
+     *
+     * @return \OCP\IAvatarManager
+     * @since 6.0.0
+     */
+    public function getAvatarManager();
+
+    /**
+     * Returns an job list for controlling background jobs
+     *
+     * @return \OCP\BackgroundJob\IJobList
+     * @since 7.0.0
+     */
+    public function getJobList();
+
+    /**
+     * Returns a logger instance
+     *
+     * @return \OCP\ILogger
+     * @since 8.0.0
+     */
+    public function getLogger();
+
+    /**
+     * Returns a router for generating and matching urls
+     *
+     * @return \OCP\Route\IRouter
+     * @since 7.0.0
+     */
+    public function getRouter();
+
+    /**
+     * Returns a search instance
+     *
+     * @return \OCP\ISearch
+     * @since 7.0.0
+     */
+    public function getSearch();
+
+    /**
+     * Get the certificate manager for the user
+     *
+     * @param string $userId (optional) if not specified the current loggedin user is used, use null to get the system certificate manager
+     * @return \OCP\ICertificateManager | null if $userId is null and no user is logged in
+     * @since 8.0.0
+     */
+    public function getCertificateManager($userId = null);
+
+    /**
+     * Create a new event source
+     *
+     * @return \OCP\IEventSource
+     * @since 8.0.0
+     */
+    public function createEventSource();
+
+    /**
+     * Returns an instance of the HTTP helper class
+     * @return \OC\HTTPHelper
+     * @deprecated 8.1.0 Use \OCP\Http\Client\IClientService
+     * @since 8.0.0
+     */
+    public function getHTTPHelper();
+
+    /**
+     * Returns an instance of the HTTP client service
+     *
+     * @return \OCP\Http\Client\IClientService
+     * @since 8.1.0
+     */
+    public function getHTTPClientService();
+
+    /**
+     * Get the active event logger
+     *
+     * @return \OCP\Diagnostics\IEventLogger
+     * @since 8.0.0
+     */
+    public function getEventLogger();
+
+    /**
+     * Get the active query logger
+     *
+     * The returned logger only logs data when debug mode is enabled
+     *
+     * @return \OCP\Diagnostics\IQueryLogger
+     * @since 8.0.0
+     */
+    public function getQueryLogger();
+
+    /**
+     * Get the manager for temporary files and folders
+     *
+     * @return \OCP\ITempManager
+     * @since 8.0.0
+     */
+    public function getTempManager();
+
+    /**
+     * Get the app manager
+     *
+     * @return \OCP\App\IAppManager
+     * @since 8.0.0
+     */
+    public function getAppManager();
+
+    /**
+     * Get the webroot
+     *
+     * @return string
+     * @since 8.0.0
+     */
+    public function getWebRoot();
+
+    /**
+     * @return \OCP\Files\Config\IMountProviderCollection
+     * @since 8.0.0
+     */
+    public function getMountProviderCollection();
+
+    /**
+     * Get the IniWrapper
+     *
+     * @return \bantu\IniGetWrapper\IniGetWrapper
+     * @since 8.0.0
+     */
+    public function getIniWrapper();
+    /**
+     * @return \OCP\Command\IBus
+     * @since 8.1.0
+     */
+    public function getCommandBus();
+
+    /**
+     * Creates a new mailer
+     *
+     * @return \OCP\Mail\IMailer
+     * @since 8.1.0
+     */
+    public function getMailer();
+
+    /**
+     * Get the locking provider
+     *
+     * @return \OCP\Lock\ILockingProvider
+     * @since 8.1.0
+     */
+    public function getLockingProvider();
+
+    /**
+     * @return \OCP\Files\Mount\IMountManager
+     * @since 8.2.0
+     */
+    public function getMountManager();
+
+    /**
+     * Get the MimeTypeDetector
+     *
+     * @return \OCP\Files\IMimeTypeDetector
+     * @since 8.2.0
+     */
+    public function getMimeTypeDetector();
+
+    /**
+     * Get the MimeTypeLoader
+     *
+     * @return \OCP\Files\IMimeTypeLoader
+     * @since 8.2.0
+     */
+    public function getMimeTypeLoader();
+
+    /**
+     * Get the EventDispatcher
+     *
+     * @return EventDispatcherInterface
+     * @since 8.2.0
+     */
+    public function getEventDispatcher();
+
+    /**
+     * Get the Notification Manager
+     *
+     * @return \OCP\Notification\IManager
+     * @since 9.0.0
+     */
+    public function getNotificationManager();
+
+    /**
+     * @return \OCP\Comments\ICommentsManager
+     * @since 9.0.0
+     */
+    public function getCommentsManager();
+
+    /**
+     * Returns the system-tag manager
+     *
+     * @return \OCP\SystemTag\ISystemTagManager
+     *
+     * @since 9.0.0
+     */
+    public function getSystemTagManager();
+
+    /**
+     * Returns the system-tag object mapper
+     *
+     * @return \OCP\SystemTag\ISystemTagObjectMapper
+     *
+     * @since 9.0.0
+     */
+    public function getSystemTagObjectMapper();
+
+    /**
+     * Returns the share manager
+     *
+     * @return \OCP\Share\IManager
+     * @since 9.0.0
+     */
+    public function getShareManager();
+
+    /**
+     * @return IContentSecurityPolicyManager
+     * @since 9.0.0
+     */
+    public function getContentSecurityPolicyManager();
+
+    /**
+     * @return \OCP\IDateTimeZone
+     * @since 8.0.0
+     */
+    public function getDateTimeZone();
+
+    /**
+     * @return \OCP\IDateTimeFormatter
+     * @since 8.0.0
+     */
+    public function getDateTimeFormatter();
+
+    /**
+     * @return \OCP\Federation\ICloudIdManager
+     * @since 12.0.0
+     */
+    public function getCloudIdManager();
+
+    /**
+     * @return \OCP\Remote\Api\IApiFactory
+     * @since 13.0.0
+     */
+    public function getRemoteApiFactory();
+
+    /**
+     * @return \OCP\Remote\IInstanceFactory
+     * @since 13.0.0
+     */
+    public function getRemoteInstanceFactory();
 }