nextcloud / server

lib/public/Federation/ICloudIdManager.php

Indentation +26 added lines, -26 removed lines

@@ -26,32 +26,32 @@
  * @since 12.0.0
  */
 interface ICloudIdManager {
-	/**
-	 * @param string $cloudId
-	 * @return ICloudId
-	 *
-	 * @since 12.0.0
-	 */
-	public function resolveCloudId($cloudId);
+    /**
+     * @param string $cloudId
+     * @return ICloudId
+     *
+     * @since 12.0.0
+     */
+    public function resolveCloudId($cloudId);
 
-	/**
-	 * Get the cloud id for a remote user
-	 *
-	 * @param string $user
-	 * @param string $remote
-	 * @return ICloudId
-	 *
-	 * @since 12.0.0
-	 */
-	public function getCloudId($user, $remote);
+    /**
+     * Get the cloud id for a remote user
+     *
+     * @param string $user
+     * @param string $remote
+     * @return ICloudId
+     *
+     * @since 12.0.0
+     */
+    public function getCloudId($user, $remote);
 
-	/**
-	 * Check if the input is a correctly formatted cloud id
-	 *
-	 * @param string $cloudId
-	 * @return bool
-	 *
-	 * @since 12.0.0
-	 */
-	public function isValidCloudId($cloudId);
+    /**
+     * Check if the input is a correctly formatted cloud id
+     *
+     * @param string $cloudId
+     * @return bool
+     *
+     * @since 12.0.0
+     */
+    public function isValidCloudId($cloudId);
 }

lib/public/L10N/IFactory.php

Indentation +46 added lines, -46 removed lines

@@ -25,56 +25,56 @@
  * @since 8.2.0
  */
 interface IFactory {
-	/**
-	 * Get a language instance
-	 *
-	 * @param string $app
-	 * @param string|null $lang
-	 * @return \OCP\IL10N
-	 * @since 8.2.0
-	 */
-	public function get($app, $lang = null);
+    /**
+     * Get a language instance
+     *
+     * @param string $app
+     * @param string|null $lang
+     * @return \OCP\IL10N
+     * @since 8.2.0
+     */
+    public function get($app, $lang = null);
 
-	/**
-	 * Find the best language
-	 *
-	 * @param string|null $app App id or null for core
-	 * @return string language If nothing works it returns 'en'
-	 * @since 9.0.0
-	 */
-	public function findLanguage($app = null);
+    /**
+     * Find the best language
+     *
+     * @param string|null $app App id or null for core
+     * @return string language If nothing works it returns 'en'
+     * @since 9.0.0
+     */
+    public function findLanguage($app = null);
 
-	/**
-	 * Find all available languages for an app
-	 *
-	 * @param string|null $app App id or null for core
-	 * @return string[] an array of available languages
-	 * @since 9.0.0
-	 */
-	public function findAvailableLanguages($app = null);
+    /**
+     * Find all available languages for an app
+     *
+     * @param string|null $app App id or null for core
+     * @return string[] an array of available languages
+     * @since 9.0.0
+     */
+    public function findAvailableLanguages($app = null);
 
-	/**
-	 * @param string|null $app App id or null for core
-	 * @param string $lang
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function languageExists($app, $lang);
+    /**
+     * @param string|null $app App id or null for core
+     * @param string $lang
+     * @return bool
+     * @since 9.0.0
+     */
+    public function languageExists($app, $lang);
 
-	/**
-	 * @param string|null $app App id or null for core
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function setLanguageFromRequest($app = null);
+    /**
+     * @param string|null $app App id or null for core
+     * @return string
+     * @since 9.0.0
+     */
+    public function setLanguageFromRequest($app = null);
 
 
-	/**
-	 * Creates a function from the plural string
-	 *
-	 * @param string $string
-	 * @return string Unique function name
-	 * @since 9.0.0
-	 */
-	public function createPluralFunction($string);
+    /**
+     * Creates a function from the plural string
+     *
+     * @param string $string
+     * @return string Unique function name
+     * @since 9.0.0
+     */
+    public function createPluralFunction($string);
 }

lib/public/Util.php

Indentation +648 added lines, -648 removed lines

@@ -57,654 +57,654 @@
  * @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();
-	}
-
-	/**
-	 * 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
-	 * @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);
-	}
-
-	/**
-	 * 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
+     * @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);
+    }
+
+    /**
+     * 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;
+    }
 }

lib/public/IUserManager.php

Indentation +123 added lines, -123 removed lines

@@ -41,127 +41,127 @@
  * @since 8.0.0
  */
 interface IUserManager {
-		/**
-	 * register a user backend
-	 *
-	 * @param \OCP\UserInterface $backend
-	 * @since 8.0.0
-	 */
-	public function registerBackend($backend);
-
-	/**
-	 * Get the active backends
-	 * @return \OCP\UserInterface[]
-	 * @since 8.0.0
-	 */
-	public function getBackends();
-
-	/**
-	 * remove a user backend
-	 *
-	 * @param \OCP\UserInterface $backend
-	 * @since 8.0.0
-	 */
-	public function removeBackend($backend);
-
-	/**
-	 * remove all user backends
-	 * @since 8.0.0
-	 */
-	public function clearBackends() ;
-
-	/**
-	 * get a user by user id
-	 *
-	 * @param string $uid
-	 * @return \OCP\IUser|null Either the user or null if the specified user does not exist
-	 * @since 8.0.0
-	 */
-	public function get($uid);
-
-	/**
-	 * check if a user exists
-	 *
-	 * @param string $uid
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function userExists($uid);
-
-	/**
-	 * Check if the password is valid for the user
-	 *
-	 * @param string $loginName
-	 * @param string $password
-	 * @return mixed the User object on success, false otherwise
-	 * @since 8.0.0
-	 */
-	public function checkPassword($loginName, $password);
-
-	/**
-	 * search by user id
-	 *
-	 * @param string $pattern
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OCP\IUser[]
-	 * @since 8.0.0
-	 */
-	public function search($pattern, $limit = null, $offset = null);
-
-	/**
-	 * search by displayName
-	 *
-	 * @param string $pattern
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OCP\IUser[]
-	 * @since 8.0.0
-	 */
-	public function searchDisplayName($pattern, $limit = null, $offset = null);
-
-	/**
-	 * @param string $uid
-	 * @param string $password
-	 * @throws \Exception
-	 * @return bool|\OCP\IUser the created user of false
-	 * @since 8.0.0
-	 */
-	public function createUser($uid, $password);
-
-	/**
-	 * returns how many users per backend exist (if supported by backend)
-	 *
-	 * @return array an array of backend class as key and count number as value
-	 * @since 8.0.0
-	 */
-	public function countUsers();
-
-	/**
-	 * @param \Closure $callback
-	 * @param string $search
-	 * @since 9.0.0
-	 */
-	public function callForAllUsers(\Closure $callback, $search = '');
-
-	/**
-	 * returns how many users have logged in once
-	 *
-	 * @return int
-	 * @since 11.0.0
-	 */
-	public function countSeenUsers();
-
-	/**
-	 * @param \Closure $callback
-	 * @since 11.0.0
-	 */
-	public function callForSeenUsers(\Closure $callback);
-
-	/**
-	 * @param string $email
-	 * @return IUser[]
-	 * @since 9.1.0
-	 */
-	public function getByEmail($email);
+        /**
+         * register a user backend
+         *
+         * @param \OCP\UserInterface $backend
+         * @since 8.0.0
+         */
+    public function registerBackend($backend);
+
+    /**
+     * Get the active backends
+     * @return \OCP\UserInterface[]
+     * @since 8.0.0
+     */
+    public function getBackends();
+
+    /**
+     * remove a user backend
+     *
+     * @param \OCP\UserInterface $backend
+     * @since 8.0.0
+     */
+    public function removeBackend($backend);
+
+    /**
+     * remove all user backends
+     * @since 8.0.0
+     */
+    public function clearBackends() ;
+
+    /**
+     * get a user by user id
+     *
+     * @param string $uid
+     * @return \OCP\IUser|null Either the user or null if the specified user does not exist
+     * @since 8.0.0
+     */
+    public function get($uid);
+
+    /**
+     * check if a user exists
+     *
+     * @param string $uid
+     * @return bool
+     * @since 8.0.0
+     */
+    public function userExists($uid);
+
+    /**
+     * Check if the password is valid for the user
+     *
+     * @param string $loginName
+     * @param string $password
+     * @return mixed the User object on success, false otherwise
+     * @since 8.0.0
+     */
+    public function checkPassword($loginName, $password);
+
+    /**
+     * search by user id
+     *
+     * @param string $pattern
+     * @param int $limit
+     * @param int $offset
+     * @return \OCP\IUser[]
+     * @since 8.0.0
+     */
+    public function search($pattern, $limit = null, $offset = null);
+
+    /**
+     * search by displayName
+     *
+     * @param string $pattern
+     * @param int $limit
+     * @param int $offset
+     * @return \OCP\IUser[]
+     * @since 8.0.0
+     */
+    public function searchDisplayName($pattern, $limit = null, $offset = null);
+
+    /**
+     * @param string $uid
+     * @param string $password
+     * @throws \Exception
+     * @return bool|\OCP\IUser the created user of false
+     * @since 8.0.0
+     */
+    public function createUser($uid, $password);
+
+    /**
+     * returns how many users per backend exist (if supported by backend)
+     *
+     * @return array an array of backend class as key and count number as value
+     * @since 8.0.0
+     */
+    public function countUsers();
+
+    /**
+     * @param \Closure $callback
+     * @param string $search
+     * @since 9.0.0
+     */
+    public function callForAllUsers(\Closure $callback, $search = '');
+
+    /**
+     * returns how many users have logged in once
+     *
+     * @return int
+     * @since 11.0.0
+     */
+    public function countSeenUsers();
+
+    /**
+     * @param \Closure $callback
+     * @since 11.0.0
+     */
+    public function callForSeenUsers(\Closure $callback);
+
+    /**
+     * @param string $email
+     * @return IUser[]
+     * @since 9.1.0
+     */
+    public function getByEmail($email);
 }

lib/public/Http/Client/IResponse.php

Indentation +21 added lines, -21 removed lines

@@ -31,28 +31,28 @@
  * @since 8.1.0
  */
 interface IResponse {
-	/**
-	 * @return string|resource
-	 * @since 8.1.0
-	 */
-	public function getBody();
+    /**
+     * @return string|resource
+     * @since 8.1.0
+     */
+    public function getBody();
 
-	/**
-	 * @return int
-	 * @since 8.1.0
-	 */
-	public function getStatusCode();
+    /**
+     * @return int
+     * @since 8.1.0
+     */
+    public function getStatusCode();
 
-	/**
-	 * @param $key
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function getHeader($key);
+    /**
+     * @param $key
+     * @return string
+     * @since 8.1.0
+     */
+    public function getHeader($key);
 
-	/**
-	 * @return array
-	 * @since 8.1.0
-	 */
-	public function getHeaders();
+    /**
+     * @return array
+     * @since 8.1.0
+     */
+    public function getHeaders();
 }

lib/public/Http/Client/IClient.php

Indentation +169 added lines, -169 removed lines

@@ -31,178 +31,178 @@
  */
 interface IClient {
 
-	/**
-	 * Sends a GET request
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'query' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 * @return IResponse
-	 * @throws \Exception If the request could not get completed
-	 * @since 8.1.0
-	 */
-	public function get($uri, array $options = []);
+    /**
+     * Sends a GET request
+     * @param string $uri
+     * @param array $options Array such as
+     *              'query' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     * @return IResponse
+     * @throws \Exception If the request could not get completed
+     * @since 8.1.0
+     */
+    public function get($uri, array $options = []);
 
-	/**
-	 * Sends a HEAD request
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 * @return IResponse
-	 * @throws \Exception If the request could not get completed
-	 * @since 8.1.0
-	 */
-	public function head($uri, $options = []);
+    /**
+     * Sends a HEAD request
+     * @param string $uri
+     * @param array $options Array such as
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     * @return IResponse
+     * @throws \Exception If the request could not get completed
+     * @since 8.1.0
+     */
+    public function head($uri, $options = []);
 
-	/**
-	 * Sends a POST request
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'body' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 * @return IResponse
-	 * @throws \Exception If the request could not get completed
-	 * @since 8.1.0
-	 */
-	public function post($uri, array $options = []);
+    /**
+     * Sends a POST request
+     * @param string $uri
+     * @param array $options Array such as
+     *              'body' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     * @return IResponse
+     * @throws \Exception If the request could not get completed
+     * @since 8.1.0
+     */
+    public function post($uri, array $options = []);
 
-	/**
-	 * Sends a PUT request
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'body' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 * @return IResponse
-	 * @throws \Exception If the request could not get completed
-	 * @since 8.1.0
-	 */
-	public function put($uri, array $options = []);
+    /**
+     * Sends a PUT request
+     * @param string $uri
+     * @param array $options Array such as
+     *              'body' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     * @return IResponse
+     * @throws \Exception If the request could not get completed
+     * @since 8.1.0
+     */
+    public function put($uri, array $options = []);
 
-	/**
-	 * Sends a DELETE request
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'body' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 * @return IResponse
-	 * @throws \Exception If the request could not get completed
-	 * @since 8.1.0
-	 */
-	public function delete($uri, array $options = []);
+    /**
+     * Sends a DELETE request
+     * @param string $uri
+     * @param array $options Array such as
+     *              'body' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     * @return IResponse
+     * @throws \Exception If the request could not get completed
+     * @since 8.1.0
+     */
+    public function delete($uri, array $options = []);
 
-	/**
-	 * Sends a options request
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'body' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 * @return IResponse
-	 * @throws \Exception If the request could not get completed
-	 * @since 8.1.0
-	 */
-	public function options($uri, array $options = []);
+    /**
+     * Sends a options request
+     * @param string $uri
+     * @param array $options Array such as
+     *              'body' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     * @return IResponse
+     * @throws \Exception If the request could not get completed
+     * @since 8.1.0
+     */
+    public function options($uri, array $options = []);
 }

lib/public/Http/Client/IClientService.php

Indentation +5 added lines, -5 removed lines

@@ -30,9 +30,9 @@
  * @since 8.1.0
  */
 interface IClientService {
-	/**
-	 * @return IClient
-	 * @since 8.1.0
-	 */
-	public function newClient();
+    /**
+     * @return IClient
+     * @since 8.1.0
+     */
+    public function newClient();
 }

lib/public/IConfig.php

Indentation +183 added lines, -183 removed lines

@@ -41,187 +41,187 @@
  * @since 6.0.0
  */
 interface IConfig {
-	/**
-	 * @since 8.2.0
-	 */
-	const SENSITIVE_VALUE = '***REMOVED SENSITIVE VALUE***';
-
-	/**
-	 * Sets and deletes system wide values
-	 *
-	 * @param array $configs Associative array with `key => value` pairs
-	 *                       If value is null, the config key will be deleted
-	 * @since 8.0.0
-	 */
-	public function setSystemValues(array $configs);
-
-	/**
-	 * Sets a new system wide value
-	 *
-	 * @param string $key the key of the value, under which will be saved
-	 * @param mixed $value the value that should be stored
-	 * @since 8.0.0
-	 */
-	public function setSystemValue($key, $value);
-
-	/**
-	 * Looks up a system wide defined value
-	 *
-	 * @param string $key the key of the value, under which it was saved
-	 * @param mixed $default the default value to be returned if the value isn't set
-	 * @return mixed the value or $default
-	 * @since 6.0.0 - parameter $default was added in 7.0.0
-	 */
-	public function getSystemValue($key, $default = '');
-
-	/**
-	 * Looks up a system wide defined value and filters out sensitive data
-	 *
-	 * @param string $key the key of the value, under which it was saved
-	 * @param mixed $default the default value to be returned if the value isn't set
-	 * @return mixed the value or $default
-	 * @since 8.2.0
-	 */
-	public function getFilteredSystemValue($key, $default = '');
-
-	/**
-	 * Delete a system wide defined value
-	 *
-	 * @param string $key the key of the value, under which it was saved
-	 * @since 8.0.0
-	 */
-	public function deleteSystemValue($key);
-
-	/**
-	 * Get all keys stored for an app
-	 *
-	 * @param string $appName the appName that we stored the value under
-	 * @return string[] the keys stored for the app
-	 * @since 8.0.0
-	 */
-	public function getAppKeys($appName);
-
-	/**
-	 * Writes a new app wide value
-	 *
-	 * @param string $appName the appName that we want to store the value under
-	 * @param string|float|int $key the key of the value, under which will be saved
-	 * @param string $value the value that should be stored
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function setAppValue($appName, $key, $value);
-
-	/**
-	 * Looks up an app wide defined value
-	 *
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key of the value, under which it was saved
-	 * @param string $default the default value to be returned if the value isn't set
-	 * @return string the saved value
-	 * @since 6.0.0 - parameter $default was added in 7.0.0
-	 */
-	public function getAppValue($appName, $key, $default = '');
-
-	/**
-	 * Delete an app wide defined value
-	 *
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key of the value, under which it was saved
-	 * @since 8.0.0
-	 */
-	public function deleteAppValue($appName, $key);
-
-	/**
-	 * Removes all keys in appconfig belonging to the app
-	 *
-	 * @param string $appName the appName the configs are stored under
-	 * @since 8.0.0
-	 */
-	public function deleteAppValues($appName);
-
-
-	/**
-	 * Set a user defined value
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we want to store the value under
-	 * @param string $key the key under which the value is being stored
-	 * @param string $value the value that you want to store
-	 * @param string $preCondition only update if the config value was previously the value passed as $preCondition
-	 * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met
-	 * @throws \UnexpectedValueException when trying to store an unexpected value
-	 * @since 6.0.0 - parameter $precondition was added in 8.0.0
-	 */
-	public function setUserValue($userId, $appName, $key, $value, $preCondition = null);
-
-	/**
-	 * Shortcut for getting a user defined value
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key under which the value is being stored
-	 * @param mixed $default the default value to be returned if the value isn't set
-	 * @return string
-	 * @since 6.0.0 - parameter $default was added in 7.0.0
-	 */
-	public function getUserValue($userId, $appName, $key, $default = '');
-
-	/**
-	 * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs.
-	 *
-	 * @param string $appName app to get the value for
-	 * @param string $key the key to get the value for
-	 * @param array $userIds the user IDs to fetch the values for
-	 * @return array Mapped values: userId => value
-	 * @since 8.0.0
-	 */
-	public function getUserValueForUsers($appName, $key, $userIds);
-
-	/**
-	 * Get the keys of all stored by an app for the user
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we stored the value under
-	 * @return string[]
-	 * @since 8.0.0
-	 */
-	public function getUserKeys($userId, $appName);
-
-	/**
-	 * Delete a user value
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key under which the value is being stored
-	 * @since 8.0.0
-	 */
-	public function deleteUserValue($userId, $appName, $key);
-
-	/**
-	 * Delete all user values
-	 *
-	 * @param string $userId the userId of the user that we want to remove all values from
-	 * @since 8.0.0
-	 */
-	public function deleteAllUserValues($userId);
-
-	/**
-	 * Delete all user related values of one app
-	 *
-	 * @param string $appName the appName of the app that we want to remove all values from
-	 * @since 8.0.0
-	 */
-	public function deleteAppFromAllUsers($appName);
-
-	/**
-	 * Determines the users that have the given value set for a specific app-key-pair
-	 *
-	 * @param string $appName the app to get the user for
-	 * @param string $key the key to get the user for
-	 * @param string $value the value to get the user for
-	 * @return array of user IDs
-	 * @since 8.0.0
-	 */
-	public function getUsersForUserValue($appName, $key, $value);
+    /**
+     * @since 8.2.0
+     */
+    const SENSITIVE_VALUE = '***REMOVED SENSITIVE VALUE***';
+
+    /**
+     * Sets and deletes system wide values
+     *
+     * @param array $configs Associative array with `key => value` pairs
+     *                       If value is null, the config key will be deleted
+     * @since 8.0.0
+     */
+    public function setSystemValues(array $configs);
+
+    /**
+     * Sets a new system wide value
+     *
+     * @param string $key the key of the value, under which will be saved
+     * @param mixed $value the value that should be stored
+     * @since 8.0.0
+     */
+    public function setSystemValue($key, $value);
+
+    /**
+     * Looks up a system wide defined value
+     *
+     * @param string $key the key of the value, under which it was saved
+     * @param mixed $default the default value to be returned if the value isn't set
+     * @return mixed the value or $default
+     * @since 6.0.0 - parameter $default was added in 7.0.0
+     */
+    public function getSystemValue($key, $default = '');
+
+    /**
+     * Looks up a system wide defined value and filters out sensitive data
+     *
+     * @param string $key the key of the value, under which it was saved
+     * @param mixed $default the default value to be returned if the value isn't set
+     * @return mixed the value or $default
+     * @since 8.2.0
+     */
+    public function getFilteredSystemValue($key, $default = '');
+
+    /**
+     * Delete a system wide defined value
+     *
+     * @param string $key the key of the value, under which it was saved
+     * @since 8.0.0
+     */
+    public function deleteSystemValue($key);
+
+    /**
+     * Get all keys stored for an app
+     *
+     * @param string $appName the appName that we stored the value under
+     * @return string[] the keys stored for the app
+     * @since 8.0.0
+     */
+    public function getAppKeys($appName);
+
+    /**
+     * Writes a new app wide value
+     *
+     * @param string $appName the appName that we want to store the value under
+     * @param string|float|int $key the key of the value, under which will be saved
+     * @param string $value the value that should be stored
+     * @return void
+     * @since 6.0.0
+     */
+    public function setAppValue($appName, $key, $value);
+
+    /**
+     * Looks up an app wide defined value
+     *
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key of the value, under which it was saved
+     * @param string $default the default value to be returned if the value isn't set
+     * @return string the saved value
+     * @since 6.0.0 - parameter $default was added in 7.0.0
+     */
+    public function getAppValue($appName, $key, $default = '');
+
+    /**
+     * Delete an app wide defined value
+     *
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key of the value, under which it was saved
+     * @since 8.0.0
+     */
+    public function deleteAppValue($appName, $key);
+
+    /**
+     * Removes all keys in appconfig belonging to the app
+     *
+     * @param string $appName the appName the configs are stored under
+     * @since 8.0.0
+     */
+    public function deleteAppValues($appName);
+
+
+    /**
+     * Set a user defined value
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we want to store the value under
+     * @param string $key the key under which the value is being stored
+     * @param string $value the value that you want to store
+     * @param string $preCondition only update if the config value was previously the value passed as $preCondition
+     * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met
+     * @throws \UnexpectedValueException when trying to store an unexpected value
+     * @since 6.0.0 - parameter $precondition was added in 8.0.0
+     */
+    public function setUserValue($userId, $appName, $key, $value, $preCondition = null);
+
+    /**
+     * Shortcut for getting a user defined value
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key under which the value is being stored
+     * @param mixed $default the default value to be returned if the value isn't set
+     * @return string
+     * @since 6.0.0 - parameter $default was added in 7.0.0
+     */
+    public function getUserValue($userId, $appName, $key, $default = '');
+
+    /**
+     * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs.
+     *
+     * @param string $appName app to get the value for
+     * @param string $key the key to get the value for
+     * @param array $userIds the user IDs to fetch the values for
+     * @return array Mapped values: userId => value
+     * @since 8.0.0
+     */
+    public function getUserValueForUsers($appName, $key, $userIds);
+
+    /**
+     * Get the keys of all stored by an app for the user
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we stored the value under
+     * @return string[]
+     * @since 8.0.0
+     */
+    public function getUserKeys($userId, $appName);
+
+    /**
+     * Delete a user value
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key under which the value is being stored
+     * @since 8.0.0
+     */
+    public function deleteUserValue($userId, $appName, $key);
+
+    /**
+     * Delete all user values
+     *
+     * @param string $userId the userId of the user that we want to remove all values from
+     * @since 8.0.0
+     */
+    public function deleteAllUserValues($userId);
+
+    /**
+     * Delete all user related values of one app
+     *
+     * @param string $appName the appName of the app that we want to remove all values from
+     * @since 8.0.0
+     */
+    public function deleteAppFromAllUsers($appName);
+
+    /**
+     * Determines the users that have the given value set for a specific app-key-pair
+     *
+     * @param string $appName the app to get the user for
+     * @param string $key the key to get the user for
+     * @param string $value the value to get the user for
+     * @return array of user IDs
+     * @since 8.0.0
+     */
+    public function getUsersForUserValue($appName, $key, $value);
 }

lib/public/Comments/ICommentsManager.php

Indentation +224 added lines, -224 removed lines

@@ -33,245 +33,245 @@
  */
 interface ICommentsManager {
 
-	/**
-	 * @const DELETED_USER type and id for a user that has been deleted
-	 * @see deleteReferencesOfActor
-	 * @since 9.0.0
-	 *
-	 * To be used as replacement for user type actors in deleteReferencesOfActor().
-	 *
-	 * User interfaces shall show "Deleted user" as display name, if needed.
-	 */
-	const DELETED_USER = 'deleted_users';
+    /**
+     * @const DELETED_USER type and id for a user that has been deleted
+     * @see deleteReferencesOfActor
+     * @since 9.0.0
+     *
+     * To be used as replacement for user type actors in deleteReferencesOfActor().
+     *
+     * User interfaces shall show "Deleted user" as display name, if needed.
+     */
+    const DELETED_USER = 'deleted_users';
 
-	/**
-	 * returns a comment instance
-	 *
-	 * @param string $id the ID of the comment
-	 * @return IComment
-	 * @throws NotFoundException
-	 * @since 9.0.0
-	 */
-	public function get($id);
+    /**
+     * returns a comment instance
+     *
+     * @param string $id the ID of the comment
+     * @return IComment
+     * @throws NotFoundException
+     * @since 9.0.0
+     */
+    public function get($id);
 
-	/**
-	 * returns the comment specified by the id and all it's child comments
-	 *
-	 * @param string $id
-	 * @param int $limit max number of entries to return, 0 returns all
-	 * @param int $offset the start entry
-	 * @return array
-	 * @since 9.0.0
-	 *
-	 * The return array looks like this
-	 * [
-	 * 	 'comment' => IComment, // root comment
-	 *   'replies' =>
-	 *   [
-	 *     0 =>
-	 *     [
-	 *       'comment' => IComment,
-	 *       'replies' =>
-	 *       [
-	 *         0 =>
-	 *         [
-	 *           'comment' => IComment,
-	 *           'replies' => [ … ]
-	 *         ],
-	 *         …
-	 *       ]
-	 *     ]
-	 *     1 =>
-	 *     [
-	 *       'comment' => IComment,
-	 *       'replies'=> [ … ]
-	 *     ],
-	 *     …
-	 *   ]
-	 * ]
-	 */
-	public function getTree($id, $limit = 0, $offset = 0);
+    /**
+     * returns the comment specified by the id and all it's child comments
+     *
+     * @param string $id
+     * @param int $limit max number of entries to return, 0 returns all
+     * @param int $offset the start entry
+     * @return array
+     * @since 9.0.0
+     *
+     * The return array looks like this
+     * [
+     * 	 'comment' => IComment, // root comment
+     *   'replies' =>
+     *   [
+     *     0 =>
+     *     [
+     *       'comment' => IComment,
+     *       'replies' =>
+     *       [
+     *         0 =>
+     *         [
+     *           'comment' => IComment,
+     *           'replies' => [ … ]
+     *         ],
+     *         …
+     *       ]
+     *     ]
+     *     1 =>
+     *     [
+     *       'comment' => IComment,
+     *       'replies'=> [ … ]
+     *     ],
+     *     …
+     *   ]
+     * ]
+     */
+    public function getTree($id, $limit = 0, $offset = 0);
 
-	/**
-	 * returns comments for a specific object (e.g. a file).
-	 *
-	 * The sort order is always newest to oldest.
-	 *
-	 * @param string $objectType the object type, e.g. 'files'
-	 * @param string $objectId the id of the object
-	 * @param int $limit optional, number of maximum comments to be returned. if
-	 * not specified, all comments are returned.
-	 * @param int $offset optional, starting point
-	 * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
-	 * that may be returned
-	 * @return IComment[]
-	 * @since 9.0.0
-	 */
-	public function getForObject(
-			$objectType,
-			$objectId,
-			$limit = 0,
-			$offset = 0,
-			\DateTime $notOlderThan = null
-	);
+    /**
+     * returns comments for a specific object (e.g. a file).
+     *
+     * The sort order is always newest to oldest.
+     *
+     * @param string $objectType the object type, e.g. 'files'
+     * @param string $objectId the id of the object
+     * @param int $limit optional, number of maximum comments to be returned. if
+     * not specified, all comments are returned.
+     * @param int $offset optional, starting point
+     * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
+     * that may be returned
+     * @return IComment[]
+     * @since 9.0.0
+     */
+    public function getForObject(
+            $objectType,
+            $objectId,
+            $limit = 0,
+            $offset = 0,
+            \DateTime $notOlderThan = null
+    );
 
-	/**
-	 * @param $objectType string the object type, e.g. 'files'
-	 * @param $objectId string the id of the object
-	 * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
-	 * that may be returned
-	 * @return Int
-	 * @since 9.0.0
-	 */
-	public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null);
+    /**
+     * @param $objectType string the object type, e.g. 'files'
+     * @param $objectId string the id of the object
+     * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
+     * that may be returned
+     * @return Int
+     * @since 9.0.0
+     */
+    public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null);
 
-	/**
-	 * creates a new comment and returns it. At this point of time, it is not
-	 * saved in the used data storage. Use save() after setting other fields
-	 * of the comment (e.g. message or verb).
-	 *
-	 * @param string $actorType the actor type (e.g. 'users')
-	 * @param string $actorId a user id
-	 * @param string $objectType the object type the comment is attached to
-	 * @param string $objectId the object id the comment is attached to
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function create($actorType, $actorId, $objectType, $objectId);
+    /**
+     * creates a new comment and returns it. At this point of time, it is not
+     * saved in the used data storage. Use save() after setting other fields
+     * of the comment (e.g. message or verb).
+     *
+     * @param string $actorType the actor type (e.g. 'users')
+     * @param string $actorId a user id
+     * @param string $objectType the object type the comment is attached to
+     * @param string $objectId the object id the comment is attached to
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function create($actorType, $actorId, $objectType, $objectId);
 
-	/**
-	 * permanently deletes the comment specified by the ID
-	 *
-	 * When the comment has child comments, their parent ID will be changed to
-	 * the parent ID of the item that is to be deleted.
-	 *
-	 * @param string $id
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function delete($id);
+    /**
+     * permanently deletes the comment specified by the ID
+     *
+     * When the comment has child comments, their parent ID will be changed to
+     * the parent ID of the item that is to be deleted.
+     *
+     * @param string $id
+     * @return bool
+     * @since 9.0.0
+     */
+    public function delete($id);
 
-	/**
-	 * saves the comment permanently
-	 *
-	 * if the supplied comment has an empty ID, a new entry comment will be
-	 * saved and the instance updated with the new ID.
-	 *
-	 * Otherwise, an existing comment will be updated.
-	 *
-	 * Throws NotFoundException when a comment that is to be updated does not
-	 * exist anymore at this point of time.
-	 *
-	 * @param IComment $comment
-	 * @return bool
-	 * @throws NotFoundException
-	 * @since 9.0.0
-	 */
-	public function save(IComment $comment);
+    /**
+     * saves the comment permanently
+     *
+     * if the supplied comment has an empty ID, a new entry comment will be
+     * saved and the instance updated with the new ID.
+     *
+     * Otherwise, an existing comment will be updated.
+     *
+     * Throws NotFoundException when a comment that is to be updated does not
+     * exist anymore at this point of time.
+     *
+     * @param IComment $comment
+     * @return bool
+     * @throws NotFoundException
+     * @since 9.0.0
+     */
+    public function save(IComment $comment);
 
-	/**
-	 * removes references to specific actor (e.g. on user delete) of a comment.
-	 * The comment itself must not get lost/deleted.
-	 *
-	 * A 'users' type actor (type and id) should get replaced by the
-	 * value of the DELETED_USER constant of this interface.
-	 *
-	 * @param string $actorType the actor type (e.g. 'users')
-	 * @param string $actorId a user id
-	 * @return boolean
-	 * @since 9.0.0
-	 */
-	public function deleteReferencesOfActor($actorType, $actorId);
+    /**
+     * removes references to specific actor (e.g. on user delete) of a comment.
+     * The comment itself must not get lost/deleted.
+     *
+     * A 'users' type actor (type and id) should get replaced by the
+     * value of the DELETED_USER constant of this interface.
+     *
+     * @param string $actorType the actor type (e.g. 'users')
+     * @param string $actorId a user id
+     * @return boolean
+     * @since 9.0.0
+     */
+    public function deleteReferencesOfActor($actorType, $actorId);
 
-	/**
-	 * deletes all comments made of a specific object (e.g. on file delete)
-	 *
-	 * @param string $objectType the object type (e.g. 'files')
-	 * @param string $objectId e.g. the file id
-	 * @return boolean
-	 * @since 9.0.0
-	 */
-	public function deleteCommentsAtObject($objectType, $objectId);
+    /**
+     * deletes all comments made of a specific object (e.g. on file delete)
+     *
+     * @param string $objectType the object type (e.g. 'files')
+     * @param string $objectId e.g. the file id
+     * @return boolean
+     * @since 9.0.0
+     */
+    public function deleteCommentsAtObject($objectType, $objectId);
 
-	/**
-	 * sets the read marker for a given file to the specified date for the
-	 * provided user
-	 *
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @param \DateTime $dateTime
-	 * @param \OCP\IUser $user
-	 * @since 9.0.0
-	 */
-	public function setReadMark($objectType, $objectId, \DateTime $dateTime, \OCP\IUser $user);
+    /**
+     * sets the read marker for a given file to the specified date for the
+     * provided user
+     *
+     * @param string $objectType
+     * @param string $objectId
+     * @param \DateTime $dateTime
+     * @param \OCP\IUser $user
+     * @since 9.0.0
+     */
+    public function setReadMark($objectType, $objectId, \DateTime $dateTime, \OCP\IUser $user);
 
-	/**
-	 * returns the read marker for a given file to the specified date for the
-	 * provided user. It returns null, when the marker is not present, i.e.
-	 * no comments were marked as read.
-	 *
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @param \OCP\IUser $user
-	 * @return \DateTime|null
-	 * @since 9.0.0
-	 */
-	public function getReadMark($objectType, $objectId, \OCP\IUser $user);
+    /**
+     * returns the read marker for a given file to the specified date for the
+     * provided user. It returns null, when the marker is not present, i.e.
+     * no comments were marked as read.
+     *
+     * @param string $objectType
+     * @param string $objectId
+     * @param \OCP\IUser $user
+     * @return \DateTime|null
+     * @since 9.0.0
+     */
+    public function getReadMark($objectType, $objectId, \OCP\IUser $user);
 
-	/**
-	 * deletes the read markers for the specified user
-	 *
-	 * @param \OCP\IUser $user
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function deleteReadMarksFromUser(\OCP\IUser $user);
+    /**
+     * deletes the read markers for the specified user
+     *
+     * @param \OCP\IUser $user
+     * @return bool
+     * @since 9.0.0
+     */
+    public function deleteReadMarksFromUser(\OCP\IUser $user);
 
-	/**
-	 * deletes the read markers on the specified object
-	 *
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function deleteReadMarksOnObject($objectType, $objectId);
+    /**
+     * deletes the read markers on the specified object
+     *
+     * @param string $objectType
+     * @param string $objectId
+     * @return bool
+     * @since 9.0.0
+     */
+    public function deleteReadMarksOnObject($objectType, $objectId);
 
-	/**
-	 * registers an Entity to the manager, so event notifications can be send
-	 * to consumers of the comments infrastructure
-	 *
-	 * @param \Closure $closure
-	 * @since 11.0.0
-	 */
-	public function registerEventHandler(\Closure $closure);
+    /**
+     * registers an Entity to the manager, so event notifications can be send
+     * to consumers of the comments infrastructure
+     *
+     * @param \Closure $closure
+     * @since 11.0.0
+     */
+    public function registerEventHandler(\Closure $closure);
 
-	/**
-	 * registers a method that resolves an ID to a display name for a given type
-	 *
-	 * @param string $type
-	 * @param \Closure $closure
-	 * @throws \OutOfBoundsException
-	 * @since 11.0.0
-	 *
-	 * Only one resolver shall be registered per type. Otherwise a
-	 * \OutOfBoundsException has to thrown.
-	 */
-	public function registerDisplayNameResolver($type, \Closure $closure);
+    /**
+     * registers a method that resolves an ID to a display name for a given type
+     *
+     * @param string $type
+     * @param \Closure $closure
+     * @throws \OutOfBoundsException
+     * @since 11.0.0
+     *
+     * Only one resolver shall be registered per type. Otherwise a
+     * \OutOfBoundsException has to thrown.
+     */
+    public function registerDisplayNameResolver($type, \Closure $closure);
 
-	/**
-	 * resolves a given ID of a given Type to a display name.
-	 *
-	 * @param string $type
-	 * @param string $id
-	 * @return string
-	 * @throws \OutOfBoundsException
-	 * @since 11.0.0
-	 *
-	 * If a provided type was not registered, an \OutOfBoundsException shall
-	 * be thrown. It is upon the resolver discretion what to return of the
-	 * provided ID is unknown. It must be ensured that a string is returned.
-	 */
-	public function resolveDisplayName($type, $id);
+    /**
+     * resolves a given ID of a given Type to a display name.
+     *
+     * @param string $type
+     * @param string $id
+     * @return string
+     * @throws \OutOfBoundsException
+     * @since 11.0.0
+     *
+     * If a provided type was not registered, an \OutOfBoundsException shall
+     * be thrown. It is upon the resolver discretion what to return of the
+     * provided ID is unknown. It must be ensured that a string is returned.
+     */
+    public function resolveDisplayName($type, $id);
 
 }