nextcloud / server

lib/public/Files/StorageConnectionException.php

Indentation +11 added lines, -11 removed lines

@@ -27,15 +27,15 @@
  */
 class StorageConnectionException extends StorageNotAvailableException {
 
-	/**
-	 * StorageConnectionException constructor.
-	 *
-	 * @param string $message
-	 * @param \Exception|null $previous
-	 * @since 9.0.0
-	 */
-	public function __construct($message = '', \Exception $previous = null) {
-		$l = \OC::$server->getL10N('core');
-		parent::__construct($l->t('Storage connection error. %s', [$message]), self::STATUS_NETWORK_ERROR, $previous);
-	}
+    /**
+     * StorageConnectionException constructor.
+     *
+     * @param string $message
+     * @param \Exception|null $previous
+     * @since 9.0.0
+     */
+    public function __construct($message = '', \Exception $previous = null) {
+        $l = \OC::$server->getL10N('core');
+        parent::__construct($l->t('Storage connection error. %s', [$message]), self::STATUS_NETWORK_ERROR, $previous);
+    }
 }

core/Controller/ContactsMenuController.php

Indentation +37 added lines, -37 removed lines

@@ -33,46 +33,46 @@
 
 class ContactsMenuController extends Controller {
 
-	/** @var Manager */
-	private $manager;
+    /** @var Manager */
+    private $manager;
 
-	/** @var IUserSession */
-	private $userSession;
+    /** @var IUserSession */
+    private $userSession;
 
-	/**
-	 * @param IRequest $request
-	 * @param IUserSession $userSession
-	 * @param Manager $manager
-	 */
-	public function __construct(IRequest $request, IUserSession $userSession, Manager $manager) {
-		parent::__construct('core', $request);
-		$this->userSession = $userSession;
-		$this->manager = $manager;
-	}
+    /**
+     * @param IRequest $request
+     * @param IUserSession $userSession
+     * @param Manager $manager
+     */
+    public function __construct(IRequest $request, IUserSession $userSession, Manager $manager) {
+        parent::__construct('core', $request);
+        $this->userSession = $userSession;
+        $this->manager = $manager;
+    }
 
-	/**
-	 * @NoAdminRequired
-	 *
-	 * @param string|null filter
-	 * @return \JsonSerializable[]
-	 */
-	public function index($filter = null) {
-		return $this->manager->getEntries($this->userSession->getUser(), $filter);
-	}
+    /**
+     * @NoAdminRequired
+     *
+     * @param string|null filter
+     * @return \JsonSerializable[]
+     */
+    public function index($filter = null) {
+        return $this->manager->getEntries($this->userSession->getUser(), $filter);
+    }
 
-	/**
-	 * @NoAdminRequired
-	 *
-	 * @param integer $shareType
-	 * @param string $shareWith
-	 * @return JSONResponse|\JsonSerializable
-	 */
-	public function findOne($shareType, $shareWith) {
-		$contact = $this->manager->findOne($this->userSession->getUser(), $shareType, $shareWith);
+    /**
+     * @NoAdminRequired
+     *
+     * @param integer $shareType
+     * @param string $shareWith
+     * @return JSONResponse|\JsonSerializable
+     */
+    public function findOne($shareType, $shareWith) {
+        $contact = $this->manager->findOne($this->userSession->getUser(), $shareType, $shareWith);
 
-		if ($contact) {
-			return $contact;
-		}
-		return new JSONResponse([], Http::STATUS_NOT_FOUND);
-	}
+        if ($contact) {
+            return $contact;
+        }
+        return new JSONResponse([], Http::STATUS_NOT_FOUND);
+    }
 }

apps/files_external/lib/Lib/InsufficientDataForMeaningfulAnswerException.php

Indentation +11 added lines, -11 removed lines

@@ -29,15 +29,15 @@
  * Authentication mechanism or backend has insufficient data
  */
 class InsufficientDataForMeaningfulAnswerException extends StorageNotAvailableException {
-	/**
-	 * StorageNotAvailableException constructor.
-	 *
-	 * @param string $message
-	 * @param int $code
-	 * @param \Exception|null $previous
-	 * @since 6.0.0
-	 */
-	public function __construct($message = '', $code = self::STATUS_INDETERMINATE, \Exception $previous = null) {
-		parent::__construct($message, $code, $previous);
-	}
+    /**
+     * StorageNotAvailableException constructor.
+     *
+     * @param string $message
+     * @param int $code
+     * @param \Exception|null $previous
+     * @since 6.0.0
+     */
+    public function __construct($message = '', $code = self::STATUS_INDETERMINATE, \Exception $previous = null) {
+        parent::__construct($message, $code, $previous);
+    }
 }

apps/files_external/lib/Lib/IdentifierTrait.php

Indentation +62 added lines, -62 removed lines

@@ -28,76 +28,76 @@
  */
 trait IdentifierTrait {
 
-	/** @var string */
-	protected $identifier;
+    /** @var string */
+    protected $identifier;
 
-	/** @var string[] */
-	protected $identifierAliases = [];
+    /** @var string[] */
+    protected $identifierAliases = [];
 
-	/** @var IdentifierTrait */
-	protected $deprecateTo = null;
+    /** @var IdentifierTrait */
+    protected $deprecateTo = null;
 
-	/**
-	 * @return string
-	 */
-	public function getIdentifier() {
-		return $this->identifier;
-	}
+    /**
+     * @return string
+     */
+    public function getIdentifier() {
+        return $this->identifier;
+    }
 
-	/**
-	 * @param string $identifier
-	 * @return $this
-	 */
-	public function setIdentifier($identifier) {
-		$this->identifier = $identifier;
-		$this->identifierAliases[] = $identifier;
-		return $this;
-	}
+    /**
+     * @param string $identifier
+     * @return $this
+     */
+    public function setIdentifier($identifier) {
+        $this->identifier = $identifier;
+        $this->identifierAliases[] = $identifier;
+        return $this;
+    }
 
-	/**
-	 * @return string[]
-	 */
-	public function getIdentifierAliases() {
-		return $this->identifierAliases;
-	}
+    /**
+     * @return string[]
+     */
+    public function getIdentifierAliases() {
+        return $this->identifierAliases;
+    }
 
-	/**
-	 * @param string $alias
-	 * @return $this
-	 */
-	public function addIdentifierAlias($alias) {
-		$this->identifierAliases[] = $alias;
-		return $this;
-	}
+    /**
+     * @param string $alias
+     * @return $this
+     */
+    public function addIdentifierAlias($alias) {
+        $this->identifierAliases[] = $alias;
+        return $this;
+    }
 
-	/**
-	 * @return object|null
-	 */
-	public function getDeprecateTo() {
-		return $this->deprecateTo;
-	}
+    /**
+     * @return object|null
+     */
+    public function getDeprecateTo() {
+        return $this->deprecateTo;
+    }
 
-	/**
-	 * @param object $destinationObject
-	 * @return self
-	 */
-	public function deprecateTo($destinationObject) {
-		$this->deprecateTo = $destinationObject;
-		return $this;
-	}
+    /**
+     * @param object $destinationObject
+     * @return self
+     */
+    public function deprecateTo($destinationObject) {
+        $this->deprecateTo = $destinationObject;
+        return $this;
+    }
 
-	/**
-	 * @return array
-	 */
-	public function jsonSerializeIdentifier() {
-		$data = [
-			'identifier' => $this->identifier,
-			'identifierAliases' => $this->identifierAliases,
-		];
-		if ($this->deprecateTo) {
-			$data['deprecateTo'] = $this->deprecateTo->getIdentifier();
-		}
-		return $data;
-	}
+    /**
+     * @return array
+     */
+    public function jsonSerializeIdentifier() {
+        $data = [
+            'identifier' => $this->identifier,
+            'identifierAliases' => $this->identifierAliases,
+        ];
+        if ($this->deprecateTo) {
+            $data['deprecateTo'] = $this->deprecateTo->getIdentifier();
+        }
+        return $data;
+    }
 
 }

lib/public/Util.php

Spacing +2 added lines, -2 removed lines

@@ -304,9 +304,9 @@
 	 */
 	public static function linkToRemote($service) {
 		$urlGenerator = \OC::$server->getURLGenerator();
-		$remoteBase = $urlGenerator->linkTo('', 'remote.php') . '/' . $service;
+		$remoteBase = $urlGenerator->linkTo('', 'remote.php').'/'.$service;
 		return $urlGenerator->getAbsoluteURL(
-			$remoteBase . (($service[strlen($service) - 1] != '/') ? '/' : '')
+			$remoteBase.(($service[strlen($service) - 1] != '/') ? '/' : '')
 		);
 	}
 

Indentation +549 added lines, -549 removed lines

@@ -55,553 +55,553 @@
  * @since 4.0.0
  */
 class Util {
-	/**
-	 * @deprecated 14.0.0 use \OCP\ILogger::DEBUG
-	 */
-	public const DEBUG = 0;
-	/**
-	 * @deprecated 14.0.0 use \OCP\ILogger::INFO
-	 */
-	public const INFO = 1;
-	/**
-	 * @deprecated 14.0.0 use \OCP\ILogger::WARN
-	 */
-	public const WARN = 2;
-	/**
-	 * @deprecated 14.0.0 use \OCP\ILogger::ERROR
-	 */
-	public const ERROR = 3;
-	/**
-	 * @deprecated 14.0.0 use \OCP\ILogger::FATAL
-	 */
-	public const FATAL = 4;
-
-	/** @var \OCP\Share\IManager */
-	private static $shareManager;
-
-	/** @var array */
-	private static $scripts = [];
-
-	/** @var array */
-	private static $scriptDeps = [];
-
-	/** @var array */
-	private static $sortedScriptDeps = [];
-
-	/**
-	 * get the current installed version of Nextcloud
-	 * @return array
-	 * @since 4.0.0
-	 */
-	public static function getVersion() {
-		return \OC_Util::getVersion();
-	}
-
-	/**
-	 * @since 17.0.0
-	 */
-	public static function hasExtendedSupport(): bool {
-		try {
-			/** @var \OCP\Support\Subscription\IRegistry */
-			$subscriptionRegistry = \OC::$server->query(\OCP\Support\Subscription\IRegistry::class);
-			return $subscriptionRegistry->delegateHasExtendedSupport();
-		} catch (AppFramework\QueryException $e) {
-		}
-		return \OC::$server->getConfig()->getSystemValueBool('extendedSupport', false);
-	}
-
-	/**
-	 * Set current update channel
-	 * @param string $channel
-	 * @since 8.1.0
-	 */
-	public static function setChannel($channel) {
-		\OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
-	}
-
-	/**
-	 * Get current update channel
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public static function getChannel() {
-		return \OC_Util::getChannel();
-	}
-
-	/**
-	 * write a message in the log
-	 * @param string $app
-	 * @param string $message
-	 * @param int $level
-	 * @since 4.0.0
-	 * @deprecated 13.0.0 use log of \OCP\ILogger
-	 */
-	public static function writeLog($app, $message, $level) {
-		$context = ['app' => $app];
-		\OC::$server->getLogger()->log($level, $message, $context);
-	}
-
-	/**
-	 * 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|null $file
-	 * @param string $afterAppId
-	 * @since 4.0.0
-	 */
-	public static function addScript(string $application, string $file = null, string $afterAppId = 'core'): void {
-		if (!empty($application)) {
-			$path = "$application/js/$file";
-		} else {
-			$path = "js/$file";
-		}
-
-		// Inject js translations if we load a script for
-		// a specific app that is not core, as those js files
-		// need separate handling
-		if ($application !== 'core'
-			&& $file !== null
-			&& strpos($file, 'l10n') === false) {
-			self::addTranslations($application);
-		}
-
-		// store app in dependency list
-		if (!array_key_exists($application, self::$scriptDeps)) {
-			self::$scriptDeps[$application] = new AppScriptDependency($application, [$afterAppId]);
-		} else {
-			self::$scriptDeps[$application]->addDep($afterAppId);
-		}
-
-		self::$scripts[$application][] = $path;
-	}
-
-	/**
-	 * Return the list of scripts injected to the page
-	 *
-	 * @return array
-	 * @since 24.0.0
-	 */
-	public static function getScripts(): array {
-		// Sort scriptDeps into sortedScriptDeps
-		$scriptSort = \OC::$server->get(AppScriptSort::class);
-		$sortedScripts = $scriptSort->sort(self::$scripts, self::$scriptDeps);
-
-		// Flatten array and remove duplicates
-		$sortedScripts = $sortedScripts ? array_merge(...array_values(($sortedScripts))) : [];
-
-		// Override core-common and core-main order
-		array_unshift($sortedScripts, 'core/js/common', 'core/js/main');
-
-		return array_unique($sortedScripts);
-	}
-
-	/**
-	 * 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) {
-		if (is_null($languageCode)) {
-			$languageCode = \OC::$server->getL10NFactory()->findLanguage($application);
-		}
-		if (!empty($application)) {
-			$path = "$application/l10n/$languageCode";
-		} else {
-			$path = "l10n/$languageCode";
-		}
-		self::$scripts[$application][] = $path;
-	}
-
-	/**
-	 * Add a custom element to the header
-	 * If $text is null then the element will be written as empty element.
-	 * So use "" to get a closing tag.
-	 * @param string $tag tag name of the element
-	 * @param array $attributes array of attributes for the element
-	 * @param string $text the text content for the element
-	 * @since 4.0.0
-	 */
-	public static function addHeader($tag, $attributes, $text = null) {
-		\OC_Util::addHeader($tag, $attributes, $text);
-	}
-
-	/**
-	 * Creates an absolute url to the given app and file.
-	 * @param string $app app
-	 * @param string $file file
-	 * @param array $args array with param=>value, will be appended to the returned url
-	 * 	The value of $args will be urlencoded
-	 * @return string the url
-	 * @since 4.0.0 - parameter $args was added in 4.5.0
-	 */
-	public static function linkToAbsolute($app, $file, $args = []) {
-		$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
-	 * @deprecated 15.0.0 - use OCP\IURLGenerator
-	 */
-	public static function linkToPublic($service) {
-		$urlGenerator = \OC::$server->getURLGenerator();
-		if ($service === 'files') {
-			return $urlGenerator->getAbsoluteURL('/s');
-		}
-		return $urlGenerator->getAbsoluteURL($urlGenerator->linkTo('', 'public.php').'?service='.$service);
-	}
-
-	/**
-	 * Returns the server host name without an eventual port number
-	 * @return string the server hostname
-	 * @since 5.0.0
-	 */
-	public static function getServerHostName() {
-		$host_name = \OC::$server->getRequest()->getServerHost();
-		// strip away port number (if existing)
-		$colon_pos = strpos($host_name, ':');
-		if ($colon_pos != false) {
-			$host_name = substr($host_name, 0, $colon_pos);
-		}
-		return $host_name;
-	}
-
-	/**
-	 * Returns the default email address
-	 * @param string $user_part the user part of the address
-	 * @return string the default email address
-	 *
-	 * Assembles a default email address (using the server hostname
-	 * and the given user part, and returns it
-	 * Example: when given lostpassword-noreply as $user_part param,
-	 *     and is currently accessed via http(s)://example.com/,
-	 *     it would return 'lostpassword-noreply@example.com'
-	 *
-	 * If the configuration value 'mail_from_address' is set in
-	 * config.php, this value will override the $user_part that
-	 * is passed to this function
-	 * @since 5.0.0
-	 */
-	public static function getDefaultEmailAddress($user_part) {
-		$config = \OC::$server->getConfig();
-		$user_part = $config->getSystemValue('mail_from_address', $user_part);
-		$host_name = self::getServerHostName();
-		$host_name = $config->getSystemValue('mail_domain', $host_name);
-		$defaultEmailAddress = $user_part.'@'.$host_name;
-
-		$mailer = \OC::$server->getMailer();
-		if ($mailer->validateMailAddress($defaultEmailAddress)) {
-			return $defaultEmailAddress;
-		}
-
-		// in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
-		return $user_part.'@localhost.localdomain';
-	}
-
-	/**
-	 * Make a human file size (2048 to 2 kB)
-	 * @param int $bytes file size in bytes
-	 * @return string a human readable file size
-	 * @since 4.0.0
-	 */
-	public static function humanFileSize($bytes) {
-		return \OC_Helper::humanFileSize($bytes);
-	}
-
-	/**
-	 * Make a computer file size (2 kB to 2048)
-	 * @param string $str file size in a fancy format
-	 * @return float a file size in bytes
-	 *
-	 * Inspired by: https://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
-	 * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::addListener
-	 */
-	public static 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
-	 * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTypedEvent
-	 */
-	public static function emitHook($signalclass, $signalname, $params = []) {
-		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;
-	}
-
-	/**
-	 * 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|string[] $value
-	 * @return string|string[] 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);
-	}
-
-	/**
-	 * performs a search in a nested array
-	 *
-	 * @param array $haystack the array to be searched
-	 * @param string $needle the search string
-	 * @param mixed $index optional, only search this key name
-	 * @return mixed the key of the matching field, otherwise false
-	 * @since 4.5.0
-	 * @deprecated 15.0.0
-	 */
-	public static function recursiveArraySearch($haystack, $needle, $index = null) {
-		return \OC_Helper::recursiveArraySearch($haystack, $needle, $index);
-	}
-
-	/**
-	 * calculates the maximum upload size respecting system settings, free space and user quota
-	 *
-	 * @param string $dir the current folder where the user currently operates
-	 * @param int $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
-	 * @return int number of bytes representing
-	 * @since 5.0.0
-	 */
-	public static function maxUploadFilesize($dir, $free = null) {
-		return \OC_Helper::maxUploadFilesize($dir, $free);
-	}
-
-	/**
-	 * Calculate free space left within user quota
-	 * @param string $dir the current folder where the user currently operates
-	 * @return int number of bytes representing
-	 * @since 7.0.0
-	 */
-	public static function freeSpace($dir) {
-		return \OC_Helper::freeSpace($dir);
-	}
-
-	/**
-	 * Calculate PHP upload limit
-	 *
-	 * @return int number of bytes representing
-	 * @since 7.0.0
-	 */
-	public static function uploadLimit() {
-		return \OC_Helper::uploadLimit();
-	}
-
-	/**
-	 * Returns whether the given file name is valid
-	 * @param string $file file name to check
-	 * @return bool true if the file name is valid, false otherwise
-	 * @deprecated 8.1.0 use \OC\Files\View::verifyPath()
-	 * @since 7.0.0
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function isValidFileName($file) {
-		return \OC_Util::isValidFileName($file);
-	}
-
-	/**
-	 * Compare two strings to provide a natural sort
-	 * @param string $a first string to compare
-	 * @param string $b second string to compare
-	 * @return int -1 if $b comes before $a, 1 if $a comes before $b
-	 * or 0 if the strings are identical
-	 * @since 7.0.0
-	 */
-	public static function naturalSortCompare($a, $b) {
-		return \OC\NaturalSort::getInstance()->compare($a, $b);
-	}
-
-	/**
-	 * Check if a password is required for each public link
-	 *
-	 * @param bool $checkGroupMembership Check group membership exclusion
-	 * @return boolean
-	 * @since 7.0.0
-	 */
-	public static function isPublicLinkPasswordRequired(bool $checkGroupMembership = true) {
-		return \OC_Util::isPublicLinkPasswordRequired($checkGroupMembership);
-	}
-
-	/**
-	 * check if share API enforces a default expire date
-	 * @return boolean
-	 * @since 8.0.0
-	 */
-	public static function isDefaultExpireDateEnforced() {
-		return \OC_Util::isDefaultExpireDateEnforced();
-	}
-
-	protected static $needUpgradeCache = null;
-
-	/**
-	 * Checks whether the current version needs upgrade.
-	 *
-	 * @return bool true if upgrade is needed, false otherwise
-	 * @since 7.0.0
-	 */
-	public static function needUpgrade() {
-		if (!isset(self::$needUpgradeCache)) {
-			self::$needUpgradeCache = \OC_Util::needUpgrade(\OC::$server->getSystemConfig());
-		}
-		return self::$needUpgradeCache;
-	}
-
-	/**
-	 * Sometimes a string has to be shortened to fit within a certain maximum
-	 * data length in bytes. substr() you may break multibyte characters,
-	 * because it operates on single byte level. mb_substr() operates on
-	 * characters, so does not ensure that the shortend string satisfies the
-	 * max length in bytes.
-	 *
-	 * For example, json_encode is messing with multibyte characters a lot,
-	 * replacing them with something along "\u1234".
-	 *
-	 * This function shortens the string with by $accurancy (-5) from
-	 * $dataLength characters, until it fits within $dataLength bytes.
-	 *
-	 * @since 23.0.0
-	 */
-	public static function shortenMultibyteString(string $subject, int $dataLength, int $accuracy = 5): string {
-		$temp = mb_substr($subject, 0, $dataLength);
-		// json encodes encapsulates the string in double quotes, they need to be substracted
-		while ((strlen(json_encode($temp)) - 2) > $dataLength) {
-			$temp = mb_substr($temp, 0, -$accuracy);
-		}
-		return $temp;
-	}
+    /**
+     * @deprecated 14.0.0 use \OCP\ILogger::DEBUG
+     */
+    public const DEBUG = 0;
+    /**
+     * @deprecated 14.0.0 use \OCP\ILogger::INFO
+     */
+    public const INFO = 1;
+    /**
+     * @deprecated 14.0.0 use \OCP\ILogger::WARN
+     */
+    public const WARN = 2;
+    /**
+     * @deprecated 14.0.0 use \OCP\ILogger::ERROR
+     */
+    public const ERROR = 3;
+    /**
+     * @deprecated 14.0.0 use \OCP\ILogger::FATAL
+     */
+    public const FATAL = 4;
+
+    /** @var \OCP\Share\IManager */
+    private static $shareManager;
+
+    /** @var array */
+    private static $scripts = [];
+
+    /** @var array */
+    private static $scriptDeps = [];
+
+    /** @var array */
+    private static $sortedScriptDeps = [];
+
+    /**
+     * get the current installed version of Nextcloud
+     * @return array
+     * @since 4.0.0
+     */
+    public static function getVersion() {
+        return \OC_Util::getVersion();
+    }
+
+    /**
+     * @since 17.0.0
+     */
+    public static function hasExtendedSupport(): bool {
+        try {
+            /** @var \OCP\Support\Subscription\IRegistry */
+            $subscriptionRegistry = \OC::$server->query(\OCP\Support\Subscription\IRegistry::class);
+            return $subscriptionRegistry->delegateHasExtendedSupport();
+        } catch (AppFramework\QueryException $e) {
+        }
+        return \OC::$server->getConfig()->getSystemValueBool('extendedSupport', false);
+    }
+
+    /**
+     * Set current update channel
+     * @param string $channel
+     * @since 8.1.0
+     */
+    public static function setChannel($channel) {
+        \OC::$server->getConfig()->setSystemValue('updater.release.channel', $channel);
+    }
+
+    /**
+     * Get current update channel
+     * @return string
+     * @since 8.1.0
+     */
+    public static function getChannel() {
+        return \OC_Util::getChannel();
+    }
+
+    /**
+     * write a message in the log
+     * @param string $app
+     * @param string $message
+     * @param int $level
+     * @since 4.0.0
+     * @deprecated 13.0.0 use log of \OCP\ILogger
+     */
+    public static function writeLog($app, $message, $level) {
+        $context = ['app' => $app];
+        \OC::$server->getLogger()->log($level, $message, $context);
+    }
+
+    /**
+     * 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|null $file
+     * @param string $afterAppId
+     * @since 4.0.0
+     */
+    public static function addScript(string $application, string $file = null, string $afterAppId = 'core'): void {
+        if (!empty($application)) {
+            $path = "$application/js/$file";
+        } else {
+            $path = "js/$file";
+        }
+
+        // Inject js translations if we load a script for
+        // a specific app that is not core, as those js files
+        // need separate handling
+        if ($application !== 'core'
+            && $file !== null
+            && strpos($file, 'l10n') === false) {
+            self::addTranslations($application);
+        }
+
+        // store app in dependency list
+        if (!array_key_exists($application, self::$scriptDeps)) {
+            self::$scriptDeps[$application] = new AppScriptDependency($application, [$afterAppId]);
+        } else {
+            self::$scriptDeps[$application]->addDep($afterAppId);
+        }
+
+        self::$scripts[$application][] = $path;
+    }
+
+    /**
+     * Return the list of scripts injected to the page
+     *
+     * @return array
+     * @since 24.0.0
+     */
+    public static function getScripts(): array {
+        // Sort scriptDeps into sortedScriptDeps
+        $scriptSort = \OC::$server->get(AppScriptSort::class);
+        $sortedScripts = $scriptSort->sort(self::$scripts, self::$scriptDeps);
+
+        // Flatten array and remove duplicates
+        $sortedScripts = $sortedScripts ? array_merge(...array_values(($sortedScripts))) : [];
+
+        // Override core-common and core-main order
+        array_unshift($sortedScripts, 'core/js/common', 'core/js/main');
+
+        return array_unique($sortedScripts);
+    }
+
+    /**
+     * 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) {
+        if (is_null($languageCode)) {
+            $languageCode = \OC::$server->getL10NFactory()->findLanguage($application);
+        }
+        if (!empty($application)) {
+            $path = "$application/l10n/$languageCode";
+        } else {
+            $path = "l10n/$languageCode";
+        }
+        self::$scripts[$application][] = $path;
+    }
+
+    /**
+     * Add a custom element to the header
+     * If $text is null then the element will be written as empty element.
+     * So use "" to get a closing tag.
+     * @param string $tag tag name of the element
+     * @param array $attributes array of attributes for the element
+     * @param string $text the text content for the element
+     * @since 4.0.0
+     */
+    public static function addHeader($tag, $attributes, $text = null) {
+        \OC_Util::addHeader($tag, $attributes, $text);
+    }
+
+    /**
+     * Creates an absolute url to the given app and file.
+     * @param string $app app
+     * @param string $file file
+     * @param array $args array with param=>value, will be appended to the returned url
+     * 	The value of $args will be urlencoded
+     * @return string the url
+     * @since 4.0.0 - parameter $args was added in 4.5.0
+     */
+    public static function linkToAbsolute($app, $file, $args = []) {
+        $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
+     * @deprecated 15.0.0 - use OCP\IURLGenerator
+     */
+    public static function linkToPublic($service) {
+        $urlGenerator = \OC::$server->getURLGenerator();
+        if ($service === 'files') {
+            return $urlGenerator->getAbsoluteURL('/s');
+        }
+        return $urlGenerator->getAbsoluteURL($urlGenerator->linkTo('', 'public.php').'?service='.$service);
+    }
+
+    /**
+     * Returns the server host name without an eventual port number
+     * @return string the server hostname
+     * @since 5.0.0
+     */
+    public static function getServerHostName() {
+        $host_name = \OC::$server->getRequest()->getServerHost();
+        // strip away port number (if existing)
+        $colon_pos = strpos($host_name, ':');
+        if ($colon_pos != false) {
+            $host_name = substr($host_name, 0, $colon_pos);
+        }
+        return $host_name;
+    }
+
+    /**
+     * Returns the default email address
+     * @param string $user_part the user part of the address
+     * @return string the default email address
+     *
+     * Assembles a default email address (using the server hostname
+     * and the given user part, and returns it
+     * Example: when given lostpassword-noreply as $user_part param,
+     *     and is currently accessed via http(s)://example.com/,
+     *     it would return 'lostpassword-noreply@example.com'
+     *
+     * If the configuration value 'mail_from_address' is set in
+     * config.php, this value will override the $user_part that
+     * is passed to this function
+     * @since 5.0.0
+     */
+    public static function getDefaultEmailAddress($user_part) {
+        $config = \OC::$server->getConfig();
+        $user_part = $config->getSystemValue('mail_from_address', $user_part);
+        $host_name = self::getServerHostName();
+        $host_name = $config->getSystemValue('mail_domain', $host_name);
+        $defaultEmailAddress = $user_part.'@'.$host_name;
+
+        $mailer = \OC::$server->getMailer();
+        if ($mailer->validateMailAddress($defaultEmailAddress)) {
+            return $defaultEmailAddress;
+        }
+
+        // in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
+        return $user_part.'@localhost.localdomain';
+    }
+
+    /**
+     * Make a human file size (2048 to 2 kB)
+     * @param int $bytes file size in bytes
+     * @return string a human readable file size
+     * @since 4.0.0
+     */
+    public static function humanFileSize($bytes) {
+        return \OC_Helper::humanFileSize($bytes);
+    }
+
+    /**
+     * Make a computer file size (2 kB to 2048)
+     * @param string $str file size in a fancy format
+     * @return float a file size in bytes
+     *
+     * Inspired by: https://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
+     * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::addListener
+     */
+    public static 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
+     * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTypedEvent
+     */
+    public static function emitHook($signalclass, $signalname, $params = []) {
+        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;
+    }
+
+    /**
+     * 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|string[] $value
+     * @return string|string[] 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);
+    }
+
+    /**
+     * performs a search in a nested array
+     *
+     * @param array $haystack the array to be searched
+     * @param string $needle the search string
+     * @param mixed $index optional, only search this key name
+     * @return mixed the key of the matching field, otherwise false
+     * @since 4.5.0
+     * @deprecated 15.0.0
+     */
+    public static function recursiveArraySearch($haystack, $needle, $index = null) {
+        return \OC_Helper::recursiveArraySearch($haystack, $needle, $index);
+    }
+
+    /**
+     * calculates the maximum upload size respecting system settings, free space and user quota
+     *
+     * @param string $dir the current folder where the user currently operates
+     * @param int $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
+     * @return int number of bytes representing
+     * @since 5.0.0
+     */
+    public static function maxUploadFilesize($dir, $free = null) {
+        return \OC_Helper::maxUploadFilesize($dir, $free);
+    }
+
+    /**
+     * Calculate free space left within user quota
+     * @param string $dir the current folder where the user currently operates
+     * @return int number of bytes representing
+     * @since 7.0.0
+     */
+    public static function freeSpace($dir) {
+        return \OC_Helper::freeSpace($dir);
+    }
+
+    /**
+     * Calculate PHP upload limit
+     *
+     * @return int number of bytes representing
+     * @since 7.0.0
+     */
+    public static function uploadLimit() {
+        return \OC_Helper::uploadLimit();
+    }
+
+    /**
+     * Returns whether the given file name is valid
+     * @param string $file file name to check
+     * @return bool true if the file name is valid, false otherwise
+     * @deprecated 8.1.0 use \OC\Files\View::verifyPath()
+     * @since 7.0.0
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function isValidFileName($file) {
+        return \OC_Util::isValidFileName($file);
+    }
+
+    /**
+     * Compare two strings to provide a natural sort
+     * @param string $a first string to compare
+     * @param string $b second string to compare
+     * @return int -1 if $b comes before $a, 1 if $a comes before $b
+     * or 0 if the strings are identical
+     * @since 7.0.0
+     */
+    public static function naturalSortCompare($a, $b) {
+        return \OC\NaturalSort::getInstance()->compare($a, $b);
+    }
+
+    /**
+     * Check if a password is required for each public link
+     *
+     * @param bool $checkGroupMembership Check group membership exclusion
+     * @return boolean
+     * @since 7.0.0
+     */
+    public static function isPublicLinkPasswordRequired(bool $checkGroupMembership = true) {
+        return \OC_Util::isPublicLinkPasswordRequired($checkGroupMembership);
+    }
+
+    /**
+     * check if share API enforces a default expire date
+     * @return boolean
+     * @since 8.0.0
+     */
+    public static function isDefaultExpireDateEnforced() {
+        return \OC_Util::isDefaultExpireDateEnforced();
+    }
+
+    protected static $needUpgradeCache = null;
+
+    /**
+     * Checks whether the current version needs upgrade.
+     *
+     * @return bool true if upgrade is needed, false otherwise
+     * @since 7.0.0
+     */
+    public static function needUpgrade() {
+        if (!isset(self::$needUpgradeCache)) {
+            self::$needUpgradeCache = \OC_Util::needUpgrade(\OC::$server->getSystemConfig());
+        }
+        return self::$needUpgradeCache;
+    }
+
+    /**
+     * Sometimes a string has to be shortened to fit within a certain maximum
+     * data length in bytes. substr() you may break multibyte characters,
+     * because it operates on single byte level. mb_substr() operates on
+     * characters, so does not ensure that the shortend string satisfies the
+     * max length in bytes.
+     *
+     * For example, json_encode is messing with multibyte characters a lot,
+     * replacing them with something along "\u1234".
+     *
+     * This function shortens the string with by $accurancy (-5) from
+     * $dataLength characters, until it fits within $dataLength bytes.
+     *
+     * @since 23.0.0
+     */
+    public static function shortenMultibyteString(string $subject, int $dataLength, int $accuracy = 5): string {
+        $temp = mb_substr($subject, 0, $dataLength);
+        // json encodes encapsulates the string in double quotes, they need to be substracted
+        while ((strlen(json_encode($temp)) - 2) > $dataLength) {
+            $temp = mb_substr($temp, 0, -$accuracy);
+        }
+        return $temp;
+    }
 }

lib/public/AppFramework/Controller.php

Spacing +2 added lines, -2 removed lines

@@ -78,7 +78,7 @@ 
 
 		// default responders
 		$this->responders = [
-			'json' => function ($data) {
+			'json' => function($data) {
 				if ($data instanceof DataResponse) {
 					$response = new JSONResponse(
 						$data->getData(),
@@ -153,6 +153,6 @@ 
 			return $responder($response);
 		}
 		throw new \DomainException('No responder registered for format '.
-			$format . '!');
+			$format.'!');
 	}
 }

Indentation +118 added lines, -118 removed lines

@@ -45,122 +45,122 @@
  */
 abstract class Controller {
 
-	/**
-	 * app name
-	 * @var string
-	 * @since 7.0.0
-	 */
-	protected $appName;
-
-	/**
-	 * current request
-	 * @var \OCP\IRequest
-	 * @since 6.0.0
-	 */
-	protected $request;
-
-	/**
-	 * @var array
-	 * @since 7.0.0
-	 */
-	private $responders;
-
-	/**
-	 * constructor of the controller
-	 * @param string $appName the name of the app
-	 * @param IRequest $request an instance of the request
-	 * @since 6.0.0 - parameter $appName was added in 7.0.0 - parameter $app was removed in 7.0.0
-	 */
-	public function __construct($appName,
-								IRequest $request) {
-		$this->appName = $appName;
-		$this->request = $request;
-
-		// default responders
-		$this->responders = [
-			'json' => function ($data) {
-				if ($data instanceof DataResponse) {
-					$response = new JSONResponse(
-						$data->getData(),
-						$data->getStatus()
-					);
-					$dataHeaders = $data->getHeaders();
-					$headers = $response->getHeaders();
-					// do not overwrite Content-Type if it already exists
-					if (isset($dataHeaders['Content-Type'])) {
-						unset($headers['Content-Type']);
-					}
-					$response->setHeaders(array_merge($dataHeaders, $headers));
-
-					if ($data->getETag() !== null) {
-						$response->setETag($data->getETag());
-					}
-					if ($data->getLastModified() !== null) {
-						$response->setLastModified($data->getLastModified());
-					}
-
-					return $response;
-				}
-				return new JSONResponse($data);
-			}
-		];
-	}
-
-
-	/**
-	 * Parses an HTTP accept header and returns the supported responder type
-	 * @param string $acceptHeader
-	 * @param string $default
-	 * @return string the responder type
-	 * @since 7.0.0
-	 * @since 9.1.0 Added default parameter
-	 */
-	public function getResponderByHTTPHeader($acceptHeader, $default = 'json') {
-		$headers = explode(',', $acceptHeader);
-
-		// return the first matching responder
-		foreach ($headers as $header) {
-			$header = strtolower(trim($header));
-
-			$responder = str_replace('application/', '', $header);
-
-			if (array_key_exists($responder, $this->responders)) {
-				return $responder;
-			}
-		}
-
-		// no matching header return default
-		return $default;
-	}
-
-
-	/**
-	 * Registers a formatter for a type
-	 * @param string $format
-	 * @param \Closure $responder
-	 * @since 7.0.0
-	 */
-	protected function registerResponder($format, \Closure $responder) {
-		$this->responders[$format] = $responder;
-	}
-
-
-	/**
-	 * Serializes and formats a response
-	 * @param mixed $response the value that was returned from a controller and
-	 * is not a Response instance
-	 * @param string $format the format for which a formatter has been registered
-	 * @throws \DomainException if format does not match a registered formatter
-	 * @return Response
-	 * @since 7.0.0
-	 */
-	public function buildResponse($response, $format = 'json') {
-		if (array_key_exists($format, $this->responders)) {
-			$responder = $this->responders[$format];
-
-			return $responder($response);
-		}
-		throw new \DomainException('No responder registered for format '.
-			$format . '!');
-	}
+    /**
+     * app name
+     * @var string
+     * @since 7.0.0
+     */
+    protected $appName;
+
+    /**
+     * current request
+     * @var \OCP\IRequest
+     * @since 6.0.0
+     */
+    protected $request;
+
+    /**
+     * @var array
+     * @since 7.0.0
+     */
+    private $responders;
+
+    /**
+     * constructor of the controller
+     * @param string $appName the name of the app
+     * @param IRequest $request an instance of the request
+     * @since 6.0.0 - parameter $appName was added in 7.0.0 - parameter $app was removed in 7.0.0
+     */
+    public function __construct($appName,
+                                IRequest $request) {
+        $this->appName = $appName;
+        $this->request = $request;
+
+        // default responders
+        $this->responders = [
+            'json' => function ($data) {
+                if ($data instanceof DataResponse) {
+                    $response = new JSONResponse(
+                        $data->getData(),
+                        $data->getStatus()
+                    );
+                    $dataHeaders = $data->getHeaders();
+                    $headers = $response->getHeaders();
+                    // do not overwrite Content-Type if it already exists
+                    if (isset($dataHeaders['Content-Type'])) {
+                        unset($headers['Content-Type']);
+                    }
+                    $response->setHeaders(array_merge($dataHeaders, $headers));
+
+                    if ($data->getETag() !== null) {
+                        $response->setETag($data->getETag());
+                    }
+                    if ($data->getLastModified() !== null) {
+                        $response->setLastModified($data->getLastModified());
+                    }
+
+                    return $response;
+                }
+                return new JSONResponse($data);
+            }
+        ];
+    }
+
+
+    /**
+     * Parses an HTTP accept header and returns the supported responder type
+     * @param string $acceptHeader
+     * @param string $default
+     * @return string the responder type
+     * @since 7.0.0
+     * @since 9.1.0 Added default parameter
+     */
+    public function getResponderByHTTPHeader($acceptHeader, $default = 'json') {
+        $headers = explode(',', $acceptHeader);
+
+        // return the first matching responder
+        foreach ($headers as $header) {
+            $header = strtolower(trim($header));
+
+            $responder = str_replace('application/', '', $header);
+
+            if (array_key_exists($responder, $this->responders)) {
+                return $responder;
+            }
+        }
+
+        // no matching header return default
+        return $default;
+    }
+
+
+    /**
+     * Registers a formatter for a type
+     * @param string $format
+     * @param \Closure $responder
+     * @since 7.0.0
+     */
+    protected function registerResponder($format, \Closure $responder) {
+        $this->responders[$format] = $responder;
+    }
+
+
+    /**
+     * Serializes and formats a response
+     * @param mixed $response the value that was returned from a controller and
+     * is not a Response instance
+     * @param string $format the format for which a formatter has been registered
+     * @throws \DomainException if format does not match a registered formatter
+     * @return Response
+     * @since 7.0.0
+     */
+    public function buildResponse($response, $format = 'json') {
+        if (array_key_exists($format, $this->responders)) {
+            $responder = $this->responders[$format];
+
+            return $responder($response);
+        }
+        throw new \DomainException('No responder registered for format '.
+            $format . '!');
+    }
 }

lib/public/AppFramework/Middleware.php

Indentation +57 added lines, -57 removed lines

@@ -42,67 +42,67 @@
 abstract class Middleware {
 
 
-	/**
-	 * This is being run in normal order before the controller is being
-	 * called which allows several modifications and checks
-	 *
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 * @since 6.0.0
-	 */
-	public function beforeController($controller, $methodName) {
-	}
+    /**
+     * This is being run in normal order before the controller is being
+     * called which allows several modifications and checks
+     *
+     * @param Controller $controller the controller that is being called
+     * @param string $methodName the name of the method that will be called on
+     *                           the controller
+     * @since 6.0.0
+     */
+    public function beforeController($controller, $methodName) {
+    }
 
 
-	/**
-	 * This is being run when either the beforeController method or the
-	 * controller method itself is throwing an exception. The middleware is
-	 * asked in reverse order to handle the exception and to return a response.
-	 * If the response is null, it is assumed that the exception could not be
-	 * handled and the error will be thrown again
-	 *
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 * @param \Exception $exception the thrown exception
-	 * @throws \Exception the passed in exception if it can't handle it
-	 * @return Response a Response object in case that the exception was handled
-	 * @since 6.0.0
-	 */
-	public function afterException($controller, $methodName, \Exception $exception) {
-		throw $exception;
-	}
+    /**
+     * This is being run when either the beforeController method or the
+     * controller method itself is throwing an exception. The middleware is
+     * asked in reverse order to handle the exception and to return a response.
+     * If the response is null, it is assumed that the exception could not be
+     * handled and the error will be thrown again
+     *
+     * @param Controller $controller the controller that is being called
+     * @param string $methodName the name of the method that will be called on
+     *                           the controller
+     * @param \Exception $exception the thrown exception
+     * @throws \Exception the passed in exception if it can't handle it
+     * @return Response a Response object in case that the exception was handled
+     * @since 6.0.0
+     */
+    public function afterException($controller, $methodName, \Exception $exception) {
+        throw $exception;
+    }
 
 
-	/**
-	 * This is being run after a successful controllermethod call and allows
-	 * the manipulation of a Response object. The middleware is run in reverse order
-	 *
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 * @param Response $response the generated response from the controller
-	 * @return Response a Response object
-	 * @since 6.0.0
-	 */
-	public function afterController($controller, $methodName, Response $response) {
-		return $response;
-	}
+    /**
+     * This is being run after a successful controllermethod call and allows
+     * the manipulation of a Response object. The middleware is run in reverse order
+     *
+     * @param Controller $controller the controller that is being called
+     * @param string $methodName the name of the method that will be called on
+     *                           the controller
+     * @param Response $response the generated response from the controller
+     * @return Response a Response object
+     * @since 6.0.0
+     */
+    public function afterController($controller, $methodName, Response $response) {
+        return $response;
+    }
 
 
-	/**
-	 * This is being run after the response object has been rendered and
-	 * allows the manipulation of the output. The middleware is run in reverse order
-	 *
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 * @param string $output the generated output from a response
-	 * @return string the output that should be printed
-	 * @since 6.0.0
-	 */
-	public function beforeOutput($controller, $methodName, $output) {
-		return $output;
-	}
+    /**
+     * This is being run after the response object has been rendered and
+     * allows the manipulation of the output. The middleware is run in reverse order
+     *
+     * @param Controller $controller the controller that is being called
+     * @param string $methodName the name of the method that will be called on
+     *                           the controller
+     * @param string $output the generated output from a response
+     * @return string the output that should be printed
+     * @since 6.0.0
+     */
+    public function beforeOutput($controller, $methodName, $output) {
+        return $output;
+    }
 }

lib/public/AppFramework/OCS/OCSNotFoundException.php

Indentation +10 added lines, -10 removed lines

@@ -32,14 +32,14 @@
  * @since 9.1.0
  */
 class OCSNotFoundException extends OCSException {
-	/**
-	 * OCSNotFoundException constructor.
-	 *
-	 * @param string $message
-	 * @param Exception|null $previous
-	 * @since 9.1.0
-	 */
-	public function __construct($message = '', Exception $previous = null) {
-		parent::__construct($message, Http::STATUS_NOT_FOUND, $previous);
-	}
+    /**
+     * OCSNotFoundException constructor.
+     *
+     * @param string $message
+     * @param Exception|null $previous
+     * @since 9.1.0
+     */
+    public function __construct($message = '', Exception $previous = null) {
+        parent::__construct($message, Http::STATUS_NOT_FOUND, $previous);
+    }
 }

lib/public/AppFramework/OCS/OCSForbiddenException.php

Indentation +10 added lines, -10 removed lines

@@ -32,14 +32,14 @@
  * @since 9.1.0
  */
 class OCSForbiddenException extends OCSException {
-	/**
-	 * OCSForbiddenException constructor.
-	 *
-	 * @param string $message
-	 * @param Exception|null $previous
-	 * @since 9.1.0
-	 */
-	public function __construct($message = '', Exception $previous = null) {
-		parent::__construct($message, Http::STATUS_FORBIDDEN, $previous);
-	}
+    /**
+     * OCSForbiddenException constructor.
+     *
+     * @param string $message
+     * @param Exception|null $previous
+     * @since 9.1.0
+     */
+    public function __construct($message = '', Exception $previous = null) {
+        parent::__construct($message, Http::STATUS_FORBIDDEN, $previous);
+    }
 }