nextcloud / server

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 +470 added lines, -470 removed lines

@@ -57,474 +57,474 @@
  * @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;
-
-	/** \OCP\Share\IManager */
-	private static $shareManager;
-
-	/**
-	 * 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 $file
-	 * @since 4.0.0
-	 */
-	public static function addScript($application, $file = null) {
-		\OC_Util::addScript($application, $file);
-	}
-
-	/**
-	 * Add a translation JS file
-	 * @param string $application application id
-	 * @param string $languageCode language code, defaults to the current locale
-	 * @since 8.0.0
-	 */
-	public static function addTranslations($application, $languageCode = null) {
-		\OC_Util::addTranslations($application, $languageCode);
-	}
-
-	/**
-	 * Add a custom element to the header
-	 * If $text is null then the element will be written as empty element.
-	 * So use "" to get a closing tag.
-	 * @param string $tag tag name of the element
-	 * @param array $attributes array of attributes for the element
-	 * @param string $text the text content for the element
-	 * @since 4.0.0
-	 */
-	public static function addHeader($tag, $attributes, $text = null) {
-		\OC_Util::addHeader($tag, $attributes, $text);
-	}
-
-	/**
-	 * Creates an absolute url to the given app and file.
-	 * @param string $app app
-	 * @param string $file file
-	 * @param array $args array with param=>value, will be appended to the returned url
-	 * 	The value of $args will be urlencoded
-	 * @return string the url
-	 * @since 4.0.0 - parameter $args was added in 4.5.0
-	 */
-	public static function linkToAbsolute($app, $file, $args = []) {
-		$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: 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
-	 */
-	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
-	 */
-	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|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);
-	}
-
-	/**
-	 * 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
-	 * @return boolean
-	 * @since 7.0.0
-	 */
-	public static function isPublicLinkPasswordRequired() {
-		return \OC_Util::isPublicLinkPasswordRequired();
-	}
-
-	/**
-	 * check if share API enforces a default expire date
-	 * @return boolean
-	 * @since 8.0.0
-	 */
-	public static function isDefaultExpireDateEnforced() {
-		return \OC_Util::isDefaultExpireDateEnforced();
-	}
-
-	protected static $needUpgradeCache = null;
-
-	/**
-	 * Checks whether the current version needs upgrade.
-	 *
-	 * @return bool true if upgrade is needed, false otherwise
-	 * @since 7.0.0
-	 */
-	public static function needUpgrade() {
-		if (!isset(self::$needUpgradeCache)) {
-			self::$needUpgradeCache = \OC_Util::needUpgrade(\OC::$server->getSystemConfig());
-		}
-		return self::$needUpgradeCache;
-	}
-
-	/**
-	 * is this Internet explorer ?
-	 *
-	 * @return boolean
-	 * @since 14.0.0
-	 */
-	public static function isIe() {
-		return \OC_Util::isIe();
-	}
+    /**
+     * @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;
+
+    /** \OCP\Share\IManager */
+    private static $shareManager;
+
+    /**
+     * 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 $file
+     * @since 4.0.0
+     */
+    public static function addScript($application, $file = null) {
+        \OC_Util::addScript($application, $file);
+    }
+
+    /**
+     * Add a translation JS file
+     * @param string $application application id
+     * @param string $languageCode language code, defaults to the current locale
+     * @since 8.0.0
+     */
+    public static function addTranslations($application, $languageCode = null) {
+        \OC_Util::addTranslations($application, $languageCode);
+    }
+
+    /**
+     * Add a custom element to the header
+     * If $text is null then the element will be written as empty element.
+     * So use "" to get a closing tag.
+     * @param string $tag tag name of the element
+     * @param array $attributes array of attributes for the element
+     * @param string $text the text content for the element
+     * @since 4.0.0
+     */
+    public static function addHeader($tag, $attributes, $text = null) {
+        \OC_Util::addHeader($tag, $attributes, $text);
+    }
+
+    /**
+     * Creates an absolute url to the given app and file.
+     * @param string $app app
+     * @param string $file file
+     * @param array $args array with param=>value, will be appended to the returned url
+     * 	The value of $args will be urlencoded
+     * @return string the url
+     * @since 4.0.0 - parameter $args was added in 4.5.0
+     */
+    public static function linkToAbsolute($app, $file, $args = []) {
+        $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: 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
+     */
+    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
+     */
+    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|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);
+    }
+
+    /**
+     * 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
+     * @return boolean
+     * @since 7.0.0
+     */
+    public static function isPublicLinkPasswordRequired() {
+        return \OC_Util::isPublicLinkPasswordRequired();
+    }
+
+    /**
+     * check if share API enforces a default expire date
+     * @return boolean
+     * @since 8.0.0
+     */
+    public static function isDefaultExpireDateEnforced() {
+        return \OC_Util::isDefaultExpireDateEnforced();
+    }
+
+    protected static $needUpgradeCache = null;
+
+    /**
+     * Checks whether the current version needs upgrade.
+     *
+     * @return bool true if upgrade is needed, false otherwise
+     * @since 7.0.0
+     */
+    public static function needUpgrade() {
+        if (!isset(self::$needUpgradeCache)) {
+            self::$needUpgradeCache = \OC_Util::needUpgrade(\OC::$server->getSystemConfig());
+        }
+        return self::$needUpgradeCache;
+    }
+
+    /**
+     * is this Internet explorer ?
+     *
+     * @return boolean
+     * @since 14.0.0
+     */
+    public static function isIe() {
+        return \OC_Util::isIe();
+    }
 }

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/Http/FileDisplayResponse.php

Spacing +2 added lines, -2 removed lines

@@ -51,7 +51,7 @@ 
 		$this->file = $file;
 		$this->setStatus($statusCode);
 		$this->setHeaders(array_merge($this->getHeaders(), $headers));
-		$this->addHeader('Content-Disposition', 'inline; filename="' . rawurldecode($file->getName()) . '"');
+		$this->addHeader('Content-Disposition', 'inline; filename="'.rawurldecode($file->getName()).'"');
 
 		$this->setETag($file->getEtag());
 		$lastModified = new \DateTime();
@@ -65,7 +65,7 @@ 
 	 */
 	public function callback(IOutput $output) {
 		if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
-			$output->setHeader('Content-Length: ' . $this->file->getSize());
+			$output->setHeader('Content-Length: '.$this->file->getSize());
 			$output->setOutput($this->file->getContent());
 		}
 	}

Indentation +32 added lines, -32 removed lines

@@ -32,40 +32,40 @@
  */
 class FileDisplayResponse extends Response implements ICallbackResponse {
 
-	/** @var \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile */
-	private $file;
+    /** @var \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile */
+    private $file;
 
-	/**
-	 * FileDisplayResponse constructor.
-	 *
-	 * @param \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile $file
-	 * @param int $statusCode
-	 * @param array $headers
-	 * @since 11.0.0
-	 */
-	public function __construct($file, $statusCode = Http::STATUS_OK,
-								$headers = []) {
-		parent::__construct();
+    /**
+     * FileDisplayResponse constructor.
+     *
+     * @param \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile $file
+     * @param int $statusCode
+     * @param array $headers
+     * @since 11.0.0
+     */
+    public function __construct($file, $statusCode = Http::STATUS_OK,
+                                $headers = []) {
+        parent::__construct();
 
-		$this->file = $file;
-		$this->setStatus($statusCode);
-		$this->setHeaders(array_merge($this->getHeaders(), $headers));
-		$this->addHeader('Content-Disposition', 'inline; filename="' . rawurldecode($file->getName()) . '"');
+        $this->file = $file;
+        $this->setStatus($statusCode);
+        $this->setHeaders(array_merge($this->getHeaders(), $headers));
+        $this->addHeader('Content-Disposition', 'inline; filename="' . rawurldecode($file->getName()) . '"');
 
-		$this->setETag($file->getEtag());
-		$lastModified = new \DateTime();
-		$lastModified->setTimestamp($file->getMTime());
-		$this->setLastModified($lastModified);
-	}
+        $this->setETag($file->getEtag());
+        $lastModified = new \DateTime();
+        $lastModified->setTimestamp($file->getMTime());
+        $this->setLastModified($lastModified);
+    }
 
-	/**
-	 * @param IOutput $output
-	 * @since 11.0.0
-	 */
-	public function callback(IOutput $output) {
-		if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
-			$output->setHeader('Content-Length: ' . $this->file->getSize());
-			$output->setOutput($this->file->getContent());
-		}
-	}
+    /**
+     * @param IOutput $output
+     * @since 11.0.0
+     */
+    public function callback(IOutput $output) {
+        if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
+            $output->setHeader('Content-Length: ' . $this->file->getSize());
+            $output->setOutput($this->file->getContent());
+        }
+    }
 }

lib/public/AppFramework/Http/JSONResponse.php

Spacing +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
 	public function render() {
 		$response = json_encode($this->data, JSON_HEX_TAG);
 		if ($response === false) {
-			throw new \Exception(sprintf('Could not json_encode due to invalid ' .
+			throw new \Exception(sprintf('Could not json_encode due to invalid '.
 				'non UTF-8 characters in the array: %s', var_export($this->data, true)));
 		}
 

Indentation +50 added lines, -50 removed lines

@@ -41,64 +41,64 @@
  */
 class JSONResponse extends Response {
 
-	/**
-	 * response data
-	 * @var array|object
-	 */
-	protected $data;
+    /**
+     * response data
+     * @var array|object
+     */
+    protected $data;
 
 
-	/**
-	 * constructor of JSONResponse
-	 * @param array|object $data the object or array that should be transformed
-	 * @param int $statusCode the Http status code, defaults to 200
-	 * @since 6.0.0
-	 */
-	public function __construct($data = [], $statusCode = Http::STATUS_OK) {
-		parent::__construct();
+    /**
+     * constructor of JSONResponse
+     * @param array|object $data the object or array that should be transformed
+     * @param int $statusCode the Http status code, defaults to 200
+     * @since 6.0.0
+     */
+    public function __construct($data = [], $statusCode = Http::STATUS_OK) {
+        parent::__construct();
 
-		$this->data = $data;
-		$this->setStatus($statusCode);
-		$this->addHeader('Content-Type', 'application/json; charset=utf-8');
-	}
+        $this->data = $data;
+        $this->setStatus($statusCode);
+        $this->addHeader('Content-Type', 'application/json; charset=utf-8');
+    }
 
 
-	/**
-	 * Returns the rendered json
-	 * @return string the rendered json
-	 * @since 6.0.0
-	 * @throws \Exception If data could not get encoded
-	 */
-	public function render() {
-		$response = json_encode($this->data, JSON_HEX_TAG);
-		if ($response === false) {
-			throw new \Exception(sprintf('Could not json_encode due to invalid ' .
-				'non UTF-8 characters in the array: %s', var_export($this->data, true)));
-		}
+    /**
+     * Returns the rendered json
+     * @return string the rendered json
+     * @since 6.0.0
+     * @throws \Exception If data could not get encoded
+     */
+    public function render() {
+        $response = json_encode($this->data, JSON_HEX_TAG);
+        if ($response === false) {
+            throw new \Exception(sprintf('Could not json_encode due to invalid ' .
+                'non UTF-8 characters in the array: %s', var_export($this->data, true)));
+        }
 
-		return $response;
-	}
+        return $response;
+    }
 
-	/**
-	 * Sets values in the data json array
-	 * @param array|object $data an array or object which will be transformed
-	 *                             to JSON
-	 * @return JSONResponse Reference to this object
-	 * @since 6.0.0 - return value was added in 7.0.0
-	 */
-	public function setData($data) {
-		$this->data = $data;
+    /**
+     * Sets values in the data json array
+     * @param array|object $data an array or object which will be transformed
+     *                             to JSON
+     * @return JSONResponse Reference to this object
+     * @since 6.0.0 - return value was added in 7.0.0
+     */
+    public function setData($data) {
+        $this->data = $data;
 
-		return $this;
-	}
+        return $this;
+    }
 
 
-	/**
-	 * Used to get the set parameters
-	 * @return array the data
-	 * @since 6.0.0
-	 */
-	public function getData() {
-		return $this->data;
-	}
+    /**
+     * Used to get the set parameters
+     * @return array the data
+     * @since 6.0.0
+     */
+    public function getData() {
+        return $this->data;
+    }
 }

lib/private/Archive/ZIP.php

Spacing +3 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
 			$result = $this->zip->addFromString($path, $source);
 		}
 		if ($result) {
-			$this->zip->close();//close and reopen to save the zip
+			$this->zip->close(); //close and reopen to save the zip
 			$this->zip->open($this->path);
 		}
 		return $result;
@@ -130,7 +130,7 @@ 
 	public function getFiles() {
 		$fileCount = $this->zip->numFiles;
 		$files = [];
-		for ($i = 0;$i < $fileCount;$i++) {
+		for ($i = 0; $i < $fileCount; $i++) {
 			$files[] = $this->zip->getNameIndex($i);
 		}
 		return $files;
@@ -204,7 +204,7 @@ 
 				$this->extractFile($path, $tmpFile);
 			}
 			$handle = fopen($tmpFile, $mode);
-			return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
+			return CallbackWrapper::wrap($handle, null, null, function() use ($path, $tmpFile) {
 				$this->writeBack($tmpFile, $path);
 			});
 		}

Indentation +192 added lines, -192 removed lines

@@ -36,199 +36,199 @@
 use OCP\ILogger;
 
 class ZIP extends Archive {
-	/**
-	 * @var \ZipArchive zip
-	 */
-	private $zip = null;
-	private $path;
+    /**
+     * @var \ZipArchive zip
+     */
+    private $zip = null;
+    private $path;
 
-	/**
-	 * @param string $source
-	 */
-	public function __construct($source) {
-		$this->path = $source;
-		$this->zip = new \ZipArchive();
-		if ($this->zip->open($source, \ZipArchive::CREATE)) {
-		} else {
-			\OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, ILogger::WARN);
-		}
-	}
-	/**
-	 * add an empty folder to the archive
-	 * @param string $path
-	 * @return bool
-	 */
-	public function addFolder($path) {
-		return $this->zip->addEmptyDir($path);
-	}
-	/**
-	 * add a file to the archive
-	 * @param string $path
-	 * @param string $source either a local file or string data
-	 * @return bool
-	 */
-	public function addFile($path, $source = '') {
-		if ($source and $source[0] == '/' and file_exists($source)) {
-			$result = $this->zip->addFile($source, $path);
-		} else {
-			$result = $this->zip->addFromString($path, $source);
-		}
-		if ($result) {
-			$this->zip->close();//close and reopen to save the zip
-			$this->zip->open($this->path);
-		}
-		return $result;
-	}
-	/**
-	 * rename a file or folder in the archive
-	 * @param string $source
-	 * @param string $dest
-	 * @return boolean|null
-	 */
-	public function rename($source, $dest) {
-		$source = $this->stripPath($source);
-		$dest = $this->stripPath($dest);
-		$this->zip->renameName($source, $dest);
-	}
-	/**
-	 * get the uncompressed size of a file in the archive
-	 * @param string $path
-	 * @return int
-	 */
-	public function filesize($path) {
-		$stat = $this->zip->statName($path);
-		return $stat['size'];
-	}
-	/**
-	 * get the last modified time of a file in the archive
-	 * @param string $path
-	 * @return int
-	 */
-	public function mtime($path) {
-		return filemtime($this->path);
-	}
-	/**
-	 * get the files in a folder
-	 * @param string $path
-	 * @return array
-	 */
-	public function getFolder($path) {
-		$files = $this->getFiles();
-		$folderContent = [];
-		$pathLength = strlen($path);
-		foreach ($files as $file) {
-			if (substr($file, 0, $pathLength) == $path and $file != $path) {
-				if (strrpos(substr($file, 0, -1), '/') <= $pathLength) {
-					$folderContent[] = substr($file, $pathLength);
-				}
-			}
-		}
-		return $folderContent;
-	}
-	/**
-	 * get all files in the archive
-	 * @return array
-	 */
-	public function getFiles() {
-		$fileCount = $this->zip->numFiles;
-		$files = [];
-		for ($i = 0;$i < $fileCount;$i++) {
-			$files[] = $this->zip->getNameIndex($i);
-		}
-		return $files;
-	}
-	/**
-	 * get the content of a file
-	 * @param string $path
-	 * @return string
-	 */
-	public function getFile($path) {
-		return $this->zip->getFromName($path);
-	}
-	/**
-	 * extract a single file from the archive
-	 * @param string $path
-	 * @param string $dest
-	 * @return boolean|null
-	 */
-	public function extractFile($path, $dest) {
-		$fp = $this->zip->getStream($path);
-		file_put_contents($dest, $fp);
-	}
-	/**
-	 * extract the archive
-	 * @param string $dest
-	 * @return bool
-	 */
-	public function extract($dest) {
-		return $this->zip->extractTo($dest);
-	}
-	/**
-	 * check if a file or folder exists in the archive
-	 * @param string $path
-	 * @return bool
-	 */
-	public function fileExists($path) {
-		return ($this->zip->locateName($path) !== false) or ($this->zip->locateName($path.'/') !== false);
-	}
-	/**
-	 * remove a file or folder from the archive
-	 * @param string $path
-	 * @return bool
-	 */
-	public function remove($path) {
-		if ($this->fileExists($path.'/')) {
-			return $this->zip->deleteName($path.'/');
-		} else {
-			return $this->zip->deleteName($path);
-		}
-	}
-	/**
-	 * get a file handler
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource
-	 */
-	public function getStream($path, $mode) {
-		if ($mode == 'r' or $mode == 'rb') {
-			return $this->zip->getStream($path);
-		} else {
-			//since we can't directly get a writable stream,
-			//make a temp copy of the file and put it back
-			//in the archive when the stream is closed
-			if (strrpos($path, '.') !== false) {
-				$ext = substr($path, strrpos($path, '.'));
-			} else {
-				$ext = '';
-			}
-			$tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext);
-			if ($this->fileExists($path)) {
-				$this->extractFile($path, $tmpFile);
-			}
-			$handle = fopen($tmpFile, $mode);
-			return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
-				$this->writeBack($tmpFile, $path);
-			});
-		}
-	}
+    /**
+     * @param string $source
+     */
+    public function __construct($source) {
+        $this->path = $source;
+        $this->zip = new \ZipArchive();
+        if ($this->zip->open($source, \ZipArchive::CREATE)) {
+        } else {
+            \OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, ILogger::WARN);
+        }
+    }
+    /**
+     * add an empty folder to the archive
+     * @param string $path
+     * @return bool
+     */
+    public function addFolder($path) {
+        return $this->zip->addEmptyDir($path);
+    }
+    /**
+     * add a file to the archive
+     * @param string $path
+     * @param string $source either a local file or string data
+     * @return bool
+     */
+    public function addFile($path, $source = '') {
+        if ($source and $source[0] == '/' and file_exists($source)) {
+            $result = $this->zip->addFile($source, $path);
+        } else {
+            $result = $this->zip->addFromString($path, $source);
+        }
+        if ($result) {
+            $this->zip->close();//close and reopen to save the zip
+            $this->zip->open($this->path);
+        }
+        return $result;
+    }
+    /**
+     * rename a file or folder in the archive
+     * @param string $source
+     * @param string $dest
+     * @return boolean|null
+     */
+    public function rename($source, $dest) {
+        $source = $this->stripPath($source);
+        $dest = $this->stripPath($dest);
+        $this->zip->renameName($source, $dest);
+    }
+    /**
+     * get the uncompressed size of a file in the archive
+     * @param string $path
+     * @return int
+     */
+    public function filesize($path) {
+        $stat = $this->zip->statName($path);
+        return $stat['size'];
+    }
+    /**
+     * get the last modified time of a file in the archive
+     * @param string $path
+     * @return int
+     */
+    public function mtime($path) {
+        return filemtime($this->path);
+    }
+    /**
+     * get the files in a folder
+     * @param string $path
+     * @return array
+     */
+    public function getFolder($path) {
+        $files = $this->getFiles();
+        $folderContent = [];
+        $pathLength = strlen($path);
+        foreach ($files as $file) {
+            if (substr($file, 0, $pathLength) == $path and $file != $path) {
+                if (strrpos(substr($file, 0, -1), '/') <= $pathLength) {
+                    $folderContent[] = substr($file, $pathLength);
+                }
+            }
+        }
+        return $folderContent;
+    }
+    /**
+     * get all files in the archive
+     * @return array
+     */
+    public function getFiles() {
+        $fileCount = $this->zip->numFiles;
+        $files = [];
+        for ($i = 0;$i < $fileCount;$i++) {
+            $files[] = $this->zip->getNameIndex($i);
+        }
+        return $files;
+    }
+    /**
+     * get the content of a file
+     * @param string $path
+     * @return string
+     */
+    public function getFile($path) {
+        return $this->zip->getFromName($path);
+    }
+    /**
+     * extract a single file from the archive
+     * @param string $path
+     * @param string $dest
+     * @return boolean|null
+     */
+    public function extractFile($path, $dest) {
+        $fp = $this->zip->getStream($path);
+        file_put_contents($dest, $fp);
+    }
+    /**
+     * extract the archive
+     * @param string $dest
+     * @return bool
+     */
+    public function extract($dest) {
+        return $this->zip->extractTo($dest);
+    }
+    /**
+     * check if a file or folder exists in the archive
+     * @param string $path
+     * @return bool
+     */
+    public function fileExists($path) {
+        return ($this->zip->locateName($path) !== false) or ($this->zip->locateName($path.'/') !== false);
+    }
+    /**
+     * remove a file or folder from the archive
+     * @param string $path
+     * @return bool
+     */
+    public function remove($path) {
+        if ($this->fileExists($path.'/')) {
+            return $this->zip->deleteName($path.'/');
+        } else {
+            return $this->zip->deleteName($path);
+        }
+    }
+    /**
+     * get a file handler
+     * @param string $path
+     * @param string $mode
+     * @return resource
+     */
+    public function getStream($path, $mode) {
+        if ($mode == 'r' or $mode == 'rb') {
+            return $this->zip->getStream($path);
+        } else {
+            //since we can't directly get a writable stream,
+            //make a temp copy of the file and put it back
+            //in the archive when the stream is closed
+            if (strrpos($path, '.') !== false) {
+                $ext = substr($path, strrpos($path, '.'));
+            } else {
+                $ext = '';
+            }
+            $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext);
+            if ($this->fileExists($path)) {
+                $this->extractFile($path, $tmpFile);
+            }
+            $handle = fopen($tmpFile, $mode);
+            return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
+                $this->writeBack($tmpFile, $path);
+            });
+        }
+    }
 
-	/**
-	 * write back temporary files
-	 */
-	public function writeBack($tmpFile, $path) {
-		$this->addFile($path, $tmpFile);
-		unlink($tmpFile);
-	}
+    /**
+     * write back temporary files
+     */
+    public function writeBack($tmpFile, $path) {
+        $this->addFile($path, $tmpFile);
+        unlink($tmpFile);
+    }
 
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	private function stripPath($path) {
-		if (!$path || $path[0] == '/') {
-			return substr($path, 1);
-		} else {
-			return $path;
-		}
-	}
+    /**
+     * @param string $path
+     * @return string
+     */
+    private function stripPath($path) {
+        if (!$path || $path[0] == '/') {
+            return substr($path, 1);
+        } else {
+            return $path;
+        }
+    }
 }

lib/private/App/CodeChecker/NodeVisitor.php

Spacing +7 added lines, -7 removed lines

@@ -214,28 +214,28 @@ 
 		$alias = strtolower($alias);
 
 		foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) {
-			if (strpos($blackListedClassName, $name . '\\') === 0) {
+			if (strpos($blackListedClassName, $name.'\\') === 0) {
 				$aliasedClassName = str_replace($name, $alias, $blackListedClassName);
 				$this->blackListedClassNames[$aliasedClassName] = $blackListedClassName;
 			}
 		}
 
 		foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) {
-			if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) {
+			if (strpos($blackListedConstant, $name.'\\') === 0 || strpos($blackListedConstant, $name.'::') === 0) {
 				$aliasedConstantName = str_replace($name, $alias, $blackListedConstant);
 				$this->blackListedConstants[$aliasedConstantName] = $blackListedConstant;
 			}
 		}
 
 		foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) {
-			if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) {
+			if (strpos($blackListedFunction, $name.'\\') === 0 || strpos($blackListedFunction, $name.'::') === 0) {
 				$aliasedFunctionName = str_replace($name, $alias, $blackListedFunction);
 				$this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction;
 			}
 		}
 
 		foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) {
-			if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) {
+			if (strpos($blackListedMethod, $name.'\\') === 0 || strpos($blackListedMethod, $name.'::') === 0) {
 				$aliasedMethodName = str_replace($name, $alias, $blackListedMethod);
 				$this->blackListedMethods[$aliasedMethodName] = $blackListedMethod;
 			}
@@ -256,7 +256,7 @@ 
 	}
 
 	private function checkBlackListConstant($class, $constantName, Node $node) {
-		$name = $class . '::' . $constantName;
+		$name = $class.'::'.$constantName;
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedConstants[$lowerName])) {
@@ -270,7 +270,7 @@ 
 	}
 
 	private function checkBlackListFunction($class, $functionName, Node $node) {
-		$name = $class . '::' . $functionName;
+		$name = $class.'::'.$functionName;
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedFunctions[$lowerName])) {
@@ -284,7 +284,7 @@ 
 	}
 
 	private function checkBlackListMethod($class, $functionName, Node $node) {
-		$name = $class . '::' . $functionName;
+		$name = $class.'::'.$functionName;
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedMethods[$lowerName])) {

Indentation +276 added lines, -276 removed lines

@@ -30,280 +30,280 @@
 use PhpParser\NodeVisitorAbstract;
 
 class NodeVisitor extends NodeVisitorAbstract {
-	/** @var ICheck */
-	protected $list;
-
-	/** @var string */
-	protected $blackListDescription;
-	/** @var string[] */
-	protected $blackListedClassNames;
-	/** @var string[] */
-	protected $blackListedConstants;
-	/** @var string[] */
-	protected $blackListedFunctions;
-	/** @var string[] */
-	protected $blackListedMethods;
-	/** @var bool */
-	protected $checkEqualOperatorUsage;
-	/** @var string[] */
-	protected $errorMessages;
-
-	/**
-	 * @param ICheck $list
-	 */
-	public function __construct(ICheck $list) {
-		$this->list = $list;
-
-		$this->blackListedClassNames = [];
-		foreach ($list->getClasses() as $class => $blackListInfo) {
-			if (is_numeric($class) && is_string($blackListInfo)) {
-				$class = $blackListInfo;
-				$blackListInfo = null;
-			}
-
-			$class = strtolower($class);
-			$this->blackListedClassNames[$class] = $class;
-		}
-
-		$this->blackListedConstants = [];
-		foreach ($list->getConstants() as $constantName => $blackListInfo) {
-			$constantName = strtolower($constantName);
-			$this->blackListedConstants[$constantName] = $constantName;
-		}
-
-		$this->blackListedFunctions = [];
-		foreach ($list->getFunctions() as $functionName => $blackListInfo) {
-			$functionName = strtolower($functionName);
-			$this->blackListedFunctions[$functionName] = $functionName;
-		}
-
-		$this->blackListedMethods = [];
-		foreach ($list->getMethods() as $functionName => $blackListInfo) {
-			$functionName = strtolower($functionName);
-			$this->blackListedMethods[$functionName] = $functionName;
-		}
-
-		$this->checkEqualOperatorUsage = $list->checkStrongComparisons();
-
-		$this->errorMessages = [
-			CodeChecker::CLASS_EXTENDS_NOT_ALLOWED => "%s class must not be extended",
-			CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED => "%s interface must not be implemented",
-			CodeChecker::STATIC_CALL_NOT_ALLOWED => "Static method of %s class must not be called",
-			CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED => "Constant of %s class must not not be fetched",
-			CodeChecker::CLASS_NEW_NOT_ALLOWED => "%s class must not be instantiated",
-			CodeChecker::CLASS_USE_NOT_ALLOWED => "%s class must not be imported with a use statement",
-			CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED => "Method of %s class must not be called",
-
-			CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED => "is discouraged",
-		];
-	}
-
-	/** @var array */
-	public $errors = [];
-
-	public function enterNode(Node $node) {
-		if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) {
-			$this->errors[] = [
-				'disallowedToken' => '==',
-				'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason('==', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED)
-			];
-		}
-		if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) {
-			$this->errors[] = [
-				'disallowedToken' => '!=',
-				'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason('!=', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED)
-			];
-		}
-		if ($node instanceof Node\Stmt\Class_) {
-			if (!is_null($node->extends)) {
-				$this->checkBlackList($node->extends->toString(), CodeChecker::CLASS_EXTENDS_NOT_ALLOWED, $node);
-			}
-			foreach ($node->implements as $implements) {
-				$this->checkBlackList($implements->toString(), CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED, $node);
-			}
-		}
-		if ($node instanceof Node\Expr\StaticCall) {
-			if (!is_null($node->class)) {
-				if ($node->class instanceof Name) {
-					$this->checkBlackList($node->class->toString(), CodeChecker::STATIC_CALL_NOT_ALLOWED, $node);
-
-					$this->checkBlackListFunction($node->class->toString(), $node->name, $node);
-					$this->checkBlackListMethod($node->class->toString(), $node->name, $node);
-				}
-
-				if ($node->class instanceof Node\Expr\Variable) {
-					/**
-					 * TODO: find a way to detect something like this:
-					 *       $c = "OC_API";
-					 *       $n = $c::call();
-					 */
-					// $this->checkBlackListMethod($node->class->..., $node->name, $node);
-				}
-			}
-		}
-		if ($node instanceof Node\Expr\MethodCall) {
-			if (!is_null($node->var)) {
-				if ($node->var instanceof Node\Expr\Variable) {
-					/**
-					 * TODO: find a way to detect something like this:
-					 *       $c = new OC_API();
-					 *       $n = $c::call();
-					 *       $n = $c->call();
-					 */
-					// $this->checkBlackListMethod($node->var->..., $node->name, $node);
-				}
-			}
-		}
-		if ($node instanceof Node\Expr\ClassConstFetch) {
-			if (!is_null($node->class)) {
-				if ($node->class instanceof Name) {
-					$this->checkBlackList($node->class->toString(), CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, $node);
-				}
-				if ($node->class instanceof Node\Expr\Variable || $node->class instanceof Node\Expr\PropertyFetch) {
-					/**
-					 * TODO: find a way to detect something like this:
-					 *       $c = "OC_API";
-					 *       $n = $i::ADMIN_AUTH;
-					 */
-				} else {
-					$this->checkBlackListConstant($node->class->toString(), $node->name, $node);
-				}
-			}
-		}
-		if ($node instanceof Node\Expr\New_) {
-			if (!is_null($node->class)) {
-				if ($node->class instanceof Name) {
-					$this->checkBlackList($node->class->toString(), CodeChecker::CLASS_NEW_NOT_ALLOWED, $node);
-				}
-				if ($node->class instanceof Node\Expr\Variable) {
-					/**
-					 * TODO: find a way to detect something like this:
-					 *       $c = "OC_API";
-					 *       $n = new $i;
-					 */
-				}
-			}
-		}
-		if ($node instanceof Node\Stmt\UseUse) {
-			$this->checkBlackList($node->name->toString(), CodeChecker::CLASS_USE_NOT_ALLOWED, $node);
-			if ($node->alias) {
-				$this->addUseNameToBlackList($node->name->toString(), $node->alias);
-			} else {
-				$this->addUseNameToBlackList($node->name->toString(), $node->name->getLast());
-			}
-		}
-	}
-
-	/**
-	 * Check whether an alias was introduced for a namespace of a blacklisted class
-	 *
-	 * Example:
-	 * - Blacklist entry:      OCP\AppFramework\IApi
-	 * - Name:                 OCP\AppFramework
-	 * - Alias:                OAF
-	 * =>  new blacklist entry:  OAF\IApi
-	 *
-	 * @param string $name
-	 * @param string $alias
-	 */
-	private function addUseNameToBlackList($name, $alias) {
-		$name = strtolower($name);
-		$alias = strtolower($alias);
-
-		foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) {
-			if (strpos($blackListedClassName, $name . '\\') === 0) {
-				$aliasedClassName = str_replace($name, $alias, $blackListedClassName);
-				$this->blackListedClassNames[$aliasedClassName] = $blackListedClassName;
-			}
-		}
-
-		foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) {
-			if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) {
-				$aliasedConstantName = str_replace($name, $alias, $blackListedConstant);
-				$this->blackListedConstants[$aliasedConstantName] = $blackListedConstant;
-			}
-		}
-
-		foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) {
-			if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) {
-				$aliasedFunctionName = str_replace($name, $alias, $blackListedFunction);
-				$this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction;
-			}
-		}
-
-		foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) {
-			if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) {
-				$aliasedMethodName = str_replace($name, $alias, $blackListedMethod);
-				$this->blackListedMethods[$aliasedMethodName] = $blackListedMethod;
-			}
-		}
-	}
-
-	private function checkBlackList($name, $errorCode, Node $node) {
-		$lowerName = strtolower($name);
-
-		if (isset($this->blackListedClassNames[$lowerName])) {
-			$this->errors[] = [
-				'disallowedToken' => $name,
-				'errorCode' => $errorCode,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason($this->blackListedClassNames[$lowerName], $errorCode)
-			];
-		}
-	}
-
-	private function checkBlackListConstant($class, $constantName, Node $node) {
-		$name = $class . '::' . $constantName;
-		$lowerName = strtolower($name);
-
-		if (isset($this->blackListedConstants[$lowerName])) {
-			$this->errors[] = [
-				'disallowedToken' => $name,
-				'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason($this->blackListedConstants[$lowerName], CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED)
-			];
-		}
-	}
-
-	private function checkBlackListFunction($class, $functionName, Node $node) {
-		$name = $class . '::' . $functionName;
-		$lowerName = strtolower($name);
-
-		if (isset($this->blackListedFunctions[$lowerName])) {
-			$this->errors[] = [
-				'disallowedToken' => $name,
-				'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason($this->blackListedFunctions[$lowerName], CodeChecker::STATIC_CALL_NOT_ALLOWED)
-			];
-		}
-	}
-
-	private function checkBlackListMethod($class, $functionName, Node $node) {
-		$name = $class . '::' . $functionName;
-		$lowerName = strtolower($name);
-
-		if (isset($this->blackListedMethods[$lowerName])) {
-			$this->errors[] = [
-				'disallowedToken' => $name,
-				'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason($this->blackListedMethods[$lowerName], CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED)
-			];
-		}
-	}
-
-	private function buildReason($name, $errorCode) {
-		if (isset($this->errorMessages[$errorCode])) {
-			$desc = $this->list->getDescription($errorCode, $name);
-			return sprintf($this->errorMessages[$errorCode], $desc);
-		}
-
-		return "$name usage not allowed - error: $errorCode";
-	}
+    /** @var ICheck */
+    protected $list;
+
+    /** @var string */
+    protected $blackListDescription;
+    /** @var string[] */
+    protected $blackListedClassNames;
+    /** @var string[] */
+    protected $blackListedConstants;
+    /** @var string[] */
+    protected $blackListedFunctions;
+    /** @var string[] */
+    protected $blackListedMethods;
+    /** @var bool */
+    protected $checkEqualOperatorUsage;
+    /** @var string[] */
+    protected $errorMessages;
+
+    /**
+     * @param ICheck $list
+     */
+    public function __construct(ICheck $list) {
+        $this->list = $list;
+
+        $this->blackListedClassNames = [];
+        foreach ($list->getClasses() as $class => $blackListInfo) {
+            if (is_numeric($class) && is_string($blackListInfo)) {
+                $class = $blackListInfo;
+                $blackListInfo = null;
+            }
+
+            $class = strtolower($class);
+            $this->blackListedClassNames[$class] = $class;
+        }
+
+        $this->blackListedConstants = [];
+        foreach ($list->getConstants() as $constantName => $blackListInfo) {
+            $constantName = strtolower($constantName);
+            $this->blackListedConstants[$constantName] = $constantName;
+        }
+
+        $this->blackListedFunctions = [];
+        foreach ($list->getFunctions() as $functionName => $blackListInfo) {
+            $functionName = strtolower($functionName);
+            $this->blackListedFunctions[$functionName] = $functionName;
+        }
+
+        $this->blackListedMethods = [];
+        foreach ($list->getMethods() as $functionName => $blackListInfo) {
+            $functionName = strtolower($functionName);
+            $this->blackListedMethods[$functionName] = $functionName;
+        }
+
+        $this->checkEqualOperatorUsage = $list->checkStrongComparisons();
+
+        $this->errorMessages = [
+            CodeChecker::CLASS_EXTENDS_NOT_ALLOWED => "%s class must not be extended",
+            CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED => "%s interface must not be implemented",
+            CodeChecker::STATIC_CALL_NOT_ALLOWED => "Static method of %s class must not be called",
+            CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED => "Constant of %s class must not not be fetched",
+            CodeChecker::CLASS_NEW_NOT_ALLOWED => "%s class must not be instantiated",
+            CodeChecker::CLASS_USE_NOT_ALLOWED => "%s class must not be imported with a use statement",
+            CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED => "Method of %s class must not be called",
+
+            CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED => "is discouraged",
+        ];
+    }
+
+    /** @var array */
+    public $errors = [];
+
+    public function enterNode(Node $node) {
+        if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) {
+            $this->errors[] = [
+                'disallowedToken' => '==',
+                'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason('==', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED)
+            ];
+        }
+        if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) {
+            $this->errors[] = [
+                'disallowedToken' => '!=',
+                'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason('!=', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED)
+            ];
+        }
+        if ($node instanceof Node\Stmt\Class_) {
+            if (!is_null($node->extends)) {
+                $this->checkBlackList($node->extends->toString(), CodeChecker::CLASS_EXTENDS_NOT_ALLOWED, $node);
+            }
+            foreach ($node->implements as $implements) {
+                $this->checkBlackList($implements->toString(), CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED, $node);
+            }
+        }
+        if ($node instanceof Node\Expr\StaticCall) {
+            if (!is_null($node->class)) {
+                if ($node->class instanceof Name) {
+                    $this->checkBlackList($node->class->toString(), CodeChecker::STATIC_CALL_NOT_ALLOWED, $node);
+
+                    $this->checkBlackListFunction($node->class->toString(), $node->name, $node);
+                    $this->checkBlackListMethod($node->class->toString(), $node->name, $node);
+                }
+
+                if ($node->class instanceof Node\Expr\Variable) {
+                    /**
+                     * TODO: find a way to detect something like this:
+                     *       $c = "OC_API";
+                     *       $n = $c::call();
+                     */
+                    // $this->checkBlackListMethod($node->class->..., $node->name, $node);
+                }
+            }
+        }
+        if ($node instanceof Node\Expr\MethodCall) {
+            if (!is_null($node->var)) {
+                if ($node->var instanceof Node\Expr\Variable) {
+                    /**
+                     * TODO: find a way to detect something like this:
+                     *       $c = new OC_API();
+                     *       $n = $c::call();
+                     *       $n = $c->call();
+                     */
+                    // $this->checkBlackListMethod($node->var->..., $node->name, $node);
+                }
+            }
+        }
+        if ($node instanceof Node\Expr\ClassConstFetch) {
+            if (!is_null($node->class)) {
+                if ($node->class instanceof Name) {
+                    $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, $node);
+                }
+                if ($node->class instanceof Node\Expr\Variable || $node->class instanceof Node\Expr\PropertyFetch) {
+                    /**
+                     * TODO: find a way to detect something like this:
+                     *       $c = "OC_API";
+                     *       $n = $i::ADMIN_AUTH;
+                     */
+                } else {
+                    $this->checkBlackListConstant($node->class->toString(), $node->name, $node);
+                }
+            }
+        }
+        if ($node instanceof Node\Expr\New_) {
+            if (!is_null($node->class)) {
+                if ($node->class instanceof Name) {
+                    $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_NEW_NOT_ALLOWED, $node);
+                }
+                if ($node->class instanceof Node\Expr\Variable) {
+                    /**
+                     * TODO: find a way to detect something like this:
+                     *       $c = "OC_API";
+                     *       $n = new $i;
+                     */
+                }
+            }
+        }
+        if ($node instanceof Node\Stmt\UseUse) {
+            $this->checkBlackList($node->name->toString(), CodeChecker::CLASS_USE_NOT_ALLOWED, $node);
+            if ($node->alias) {
+                $this->addUseNameToBlackList($node->name->toString(), $node->alias);
+            } else {
+                $this->addUseNameToBlackList($node->name->toString(), $node->name->getLast());
+            }
+        }
+    }
+
+    /**
+     * Check whether an alias was introduced for a namespace of a blacklisted class
+     *
+     * Example:
+     * - Blacklist entry:      OCP\AppFramework\IApi
+     * - Name:                 OCP\AppFramework
+     * - Alias:                OAF
+     * =>  new blacklist entry:  OAF\IApi
+     *
+     * @param string $name
+     * @param string $alias
+     */
+    private function addUseNameToBlackList($name, $alias) {
+        $name = strtolower($name);
+        $alias = strtolower($alias);
+
+        foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) {
+            if (strpos($blackListedClassName, $name . '\\') === 0) {
+                $aliasedClassName = str_replace($name, $alias, $blackListedClassName);
+                $this->blackListedClassNames[$aliasedClassName] = $blackListedClassName;
+            }
+        }
+
+        foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) {
+            if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) {
+                $aliasedConstantName = str_replace($name, $alias, $blackListedConstant);
+                $this->blackListedConstants[$aliasedConstantName] = $blackListedConstant;
+            }
+        }
+
+        foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) {
+            if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) {
+                $aliasedFunctionName = str_replace($name, $alias, $blackListedFunction);
+                $this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction;
+            }
+        }
+
+        foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) {
+            if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) {
+                $aliasedMethodName = str_replace($name, $alias, $blackListedMethod);
+                $this->blackListedMethods[$aliasedMethodName] = $blackListedMethod;
+            }
+        }
+    }
+
+    private function checkBlackList($name, $errorCode, Node $node) {
+        $lowerName = strtolower($name);
+
+        if (isset($this->blackListedClassNames[$lowerName])) {
+            $this->errors[] = [
+                'disallowedToken' => $name,
+                'errorCode' => $errorCode,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason($this->blackListedClassNames[$lowerName], $errorCode)
+            ];
+        }
+    }
+
+    private function checkBlackListConstant($class, $constantName, Node $node) {
+        $name = $class . '::' . $constantName;
+        $lowerName = strtolower($name);
+
+        if (isset($this->blackListedConstants[$lowerName])) {
+            $this->errors[] = [
+                'disallowedToken' => $name,
+                'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason($this->blackListedConstants[$lowerName], CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED)
+            ];
+        }
+    }
+
+    private function checkBlackListFunction($class, $functionName, Node $node) {
+        $name = $class . '::' . $functionName;
+        $lowerName = strtolower($name);
+
+        if (isset($this->blackListedFunctions[$lowerName])) {
+            $this->errors[] = [
+                'disallowedToken' => $name,
+                'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason($this->blackListedFunctions[$lowerName], CodeChecker::STATIC_CALL_NOT_ALLOWED)
+            ];
+        }
+    }
+
+    private function checkBlackListMethod($class, $functionName, Node $node) {
+        $name = $class . '::' . $functionName;
+        $lowerName = strtolower($name);
+
+        if (isset($this->blackListedMethods[$lowerName])) {
+            $this->errors[] = [
+                'disallowedToken' => $name,
+                'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason($this->blackListedMethods[$lowerName], CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED)
+            ];
+        }
+    }
+
+    private function buildReason($name, $errorCode) {
+        if (isset($this->errorMessages[$errorCode])) {
+            $desc = $this->list->getDescription($errorCode, $name);
+            return sprintf($this->errorMessages[$errorCode], $desc);
+        }
+
+        return "$name usage not allowed - error: $errorCode";
+    }
 }

lib/private/Files/FileInfo.php

Spacing +3 added lines, -3 removed lines

@@ -151,7 +151,7 @@ 
 	 * @return int|null
 	 */
 	public function getId() {
-		return isset($this->data['fileid']) ? (int)  $this->data['fileid'] : null;
+		return isset($this->data['fileid']) ? (int) $this->data['fileid'] : null;
 	}
 
 	/**
@@ -181,7 +181,7 @@ 
 	public function getEtag() {
 		$this->updateEntryfromSubMounts();
 		if (count($this->childEtags) > 0) {
-			$combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags);
+			$combinedEtag = $this->data['etag'].'::'.implode('::', $this->childEtags);
 			return md5($combinedEtag);
 		} else {
 			return $this->data['etag'];
@@ -377,7 +377,7 @@ 
 			$relativeEntryPath = substr($entryPath, strlen($this->getPath()));
 			// attach the permissions to propagate etag on permision changes of submounts
 			$permissions = isset($data['permissions']) ? $data['permissions'] : 0;
-			$this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions;
+			$this->childEtags[] = $relativeEntryPath.'/'.$data['etag'].$permissions;
 		}
 	}
 

Indentation +376 added lines, -376 removed lines

@@ -38,380 +38,380 @@
 use OCP\IUser;
 
 class FileInfo implements \OCP\Files\FileInfo, \ArrayAccess {
-	/**
-	 * @var array $data
-	 */
-	private $data;
-
-	/**
-	 * @var string $path
-	 */
-	private $path;
-
-	/**
-	 * @var \OC\Files\Storage\Storage $storage
-	 */
-	private $storage;
-
-	/**
-	 * @var string $internalPath
-	 */
-	private $internalPath;
-
-	/**
-	 * @var \OCP\Files\Mount\IMountPoint
-	 */
-	private $mount;
-
-	/**
-	 * @var IUser
-	 */
-	private $owner;
-
-	/**
-	 * @var string[]
-	 */
-	private $childEtags = [];
-
-	/**
-	 * @var IMountPoint[]
-	 */
-	private $subMounts = [];
-
-	private $subMountsUsed = false;
-
-	/**
-	 * The size of the file/folder without any sub mount
-	 *
-	 * @var int
-	 */
-	private $rawSize = 0;
-
-	/**
-	 * @param string|boolean $path
-	 * @param Storage\Storage $storage
-	 * @param string $internalPath
-	 * @param array|ICacheEntry $data
-	 * @param \OCP\Files\Mount\IMountPoint $mount
-	 * @param \OCP\IUser|null $owner
-	 */
-	public function __construct($path, $storage, $internalPath, $data, $mount, $owner = null) {
-		$this->path = $path;
-		$this->storage = $storage;
-		$this->internalPath = $internalPath;
-		$this->data = $data;
-		$this->mount = $mount;
-		$this->owner = $owner;
-		$this->rawSize = $this->data['size'] ?? 0;
-	}
-
-	public function offsetSet($offset, $value) {
-		$this->data[$offset] = $value;
-	}
-
-	public function offsetExists($offset) {
-		return isset($this->data[$offset]);
-	}
-
-	public function offsetUnset($offset) {
-		unset($this->data[$offset]);
-	}
-
-	public function offsetGet($offset) {
-		if ($offset === 'type') {
-			return $this->getType();
-		} elseif ($offset === 'etag') {
-			return $this->getEtag();
-		} elseif ($offset === 'size') {
-			return $this->getSize();
-		} elseif ($offset === 'mtime') {
-			return $this->getMTime();
-		} elseif ($offset === 'permissions') {
-			return $this->getPermissions();
-		} elseif (isset($this->data[$offset])) {
-			return $this->data[$offset];
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getPath() {
-		return $this->path;
-	}
-
-	/**
-	 * @return \OCP\Files\Storage
-	 */
-	public function getStorage() {
-		return $this->storage;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getInternalPath() {
-		return $this->internalPath;
-	}
-
-	/**
-	 * Get FileInfo ID or null in case of part file
-	 *
-	 * @return int|null
-	 */
-	public function getId() {
-		return isset($this->data['fileid']) ? (int)  $this->data['fileid'] : null;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getMimetype() {
-		return $this->data['mimetype'];
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getMimePart() {
-		return $this->data['mimepart'];
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getName() {
-		return isset($this->data['name']) ? $this->data['name'] : basename($this->getPath());
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getEtag() {
-		$this->updateEntryfromSubMounts();
-		if (count($this->childEtags) > 0) {
-			$combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags);
-			return md5($combinedEtag);
-		} else {
-			return $this->data['etag'];
-		}
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getSize($includeMounts = true) {
-		if ($includeMounts) {
-			$this->updateEntryfromSubMounts();
-			return isset($this->data['size']) ? 0 + $this->data['size'] : 0;
-		} else {
-			return $this->rawSize;
-		}
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getMTime() {
-		$this->updateEntryfromSubMounts();
-		return (int) $this->data['mtime'];
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isEncrypted() {
-		return $this->data['encrypted'];
-	}
-
-	/**
-	 * Return the currently version used for the HMAC in the encryption app
-	 *
-	 * @return int
-	 */
-	public function getEncryptedVersion() {
-		return isset($this->data['encryptedVersion']) ? (int) $this->data['encryptedVersion'] : 1;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getPermissions() {
-		$perms = (int) $this->data['permissions'];
-		if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) {
-			$perms = $perms & ~\OCP\Constants::PERMISSION_SHARE;
-		}
-		return (int) $perms;
-	}
-
-	/**
-	 * @return string \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER
-	 */
-	public function getType() {
-		if (!isset($this->data['type'])) {
-			$this->data['type'] = ($this->getMimetype() === 'httpd/unix-directory') ? self::TYPE_FOLDER : self::TYPE_FILE;
-		}
-		return $this->data['type'];
-	}
-
-	public function getData() {
-		return $this->data;
-	}
-
-	/**
-	 * @param int $permissions
-	 * @return bool
-	 */
-	protected function checkPermissions($permissions) {
-		return ($this->getPermissions() & $permissions) === $permissions;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isReadable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_READ);
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isUpdateable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE);
-	}
-
-	/**
-	 * Check whether new files or folders can be created inside this folder
-	 *
-	 * @return bool
-	 */
-	public function isCreatable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_CREATE);
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isDeletable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_DELETE);
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function isShareable() {
-		return $this->checkPermissions(\OCP\Constants::PERMISSION_SHARE);
-	}
-
-	/**
-	 * Check if a file or folder is shared
-	 *
-	 * @return bool
-	 */
-	public function isShared() {
-		$sid = $this->getStorage()->getId();
-		if (!is_null($sid)) {
-			$sid = explode(':', $sid);
-			return ($sid[0] === 'shared');
-		}
-
-		return false;
-	}
-
-	public function isMounted() {
-		$storage = $this->getStorage();
-		if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
-			return false;
-		}
-		$sid = $storage->getId();
-		if (!is_null($sid)) {
-			$sid = explode(':', $sid);
-			return ($sid[0] !== 'home' and $sid[0] !== 'shared');
-		}
-
-		return false;
-	}
-
-	/**
-	 * Get the mountpoint the file belongs to
-	 *
-	 * @return \OCP\Files\Mount\IMountPoint
-	 */
-	public function getMountPoint() {
-		return $this->mount;
-	}
-
-	/**
-	 * Get the owner of the file
-	 *
-	 * @return \OCP\IUser
-	 */
-	public function getOwner() {
-		return $this->owner;
-	}
-
-	/**
-	 * @param IMountPoint[] $mounts
-	 */
-	public function setSubMounts(array $mounts) {
-		$this->subMounts = $mounts;
-	}
-
-	private function updateEntryfromSubMounts() {
-		if ($this->subMountsUsed) {
-			return;
-		}
-		$this->subMountsUsed = true;
-		foreach ($this->subMounts as $mount) {
-			$subStorage = $mount->getStorage();
-			if ($subStorage) {
-				$subCache = $subStorage->getCache('');
-				$rootEntry = $subCache->get('');
-				$this->addSubEntry($rootEntry, $mount->getMountPoint());
-			}
-		}
-	}
-
-	/**
-	 * Add a cache entry which is the child of this folder
-	 *
-	 * Sets the size, etag and size to for cross-storage childs
-	 *
-	 * @param array|ICacheEntry $data cache entry for the child
-	 * @param string $entryPath full path of the child entry
-	 */
-	public function addSubEntry($data, $entryPath) {
-		$this->data['size'] += isset($data['size']) ? $data['size'] : 0;
-		if (isset($data['mtime'])) {
-			$this->data['mtime'] = max($this->data['mtime'], $data['mtime']);
-		}
-		if (isset($data['etag'])) {
-			// prefix the etag with the relative path of the subentry to propagate etag on mount moves
-			$relativeEntryPath = substr($entryPath, strlen($this->getPath()));
-			// attach the permissions to propagate etag on permision changes of submounts
-			$permissions = isset($data['permissions']) ? $data['permissions'] : 0;
-			$this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions;
-		}
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getChecksum() {
-		return $this->data['checksum'];
-	}
-
-	public function getExtension(): string {
-		return pathinfo($this->getName(), PATHINFO_EXTENSION);
-	}
-
-	public function getCreationTime(): int {
-		return (int) $this->data['creation_time'];
-	}
-
-	public function getUploadTime(): int {
-		return (int) $this->data['upload_time'];
-	}
+    /**
+     * @var array $data
+     */
+    private $data;
+
+    /**
+     * @var string $path
+     */
+    private $path;
+
+    /**
+     * @var \OC\Files\Storage\Storage $storage
+     */
+    private $storage;
+
+    /**
+     * @var string $internalPath
+     */
+    private $internalPath;
+
+    /**
+     * @var \OCP\Files\Mount\IMountPoint
+     */
+    private $mount;
+
+    /**
+     * @var IUser
+     */
+    private $owner;
+
+    /**
+     * @var string[]
+     */
+    private $childEtags = [];
+
+    /**
+     * @var IMountPoint[]
+     */
+    private $subMounts = [];
+
+    private $subMountsUsed = false;
+
+    /**
+     * The size of the file/folder without any sub mount
+     *
+     * @var int
+     */
+    private $rawSize = 0;
+
+    /**
+     * @param string|boolean $path
+     * @param Storage\Storage $storage
+     * @param string $internalPath
+     * @param array|ICacheEntry $data
+     * @param \OCP\Files\Mount\IMountPoint $mount
+     * @param \OCP\IUser|null $owner
+     */
+    public function __construct($path, $storage, $internalPath, $data, $mount, $owner = null) {
+        $this->path = $path;
+        $this->storage = $storage;
+        $this->internalPath = $internalPath;
+        $this->data = $data;
+        $this->mount = $mount;
+        $this->owner = $owner;
+        $this->rawSize = $this->data['size'] ?? 0;
+    }
+
+    public function offsetSet($offset, $value) {
+        $this->data[$offset] = $value;
+    }
+
+    public function offsetExists($offset) {
+        return isset($this->data[$offset]);
+    }
+
+    public function offsetUnset($offset) {
+        unset($this->data[$offset]);
+    }
+
+    public function offsetGet($offset) {
+        if ($offset === 'type') {
+            return $this->getType();
+        } elseif ($offset === 'etag') {
+            return $this->getEtag();
+        } elseif ($offset === 'size') {
+            return $this->getSize();
+        } elseif ($offset === 'mtime') {
+            return $this->getMTime();
+        } elseif ($offset === 'permissions') {
+            return $this->getPermissions();
+        } elseif (isset($this->data[$offset])) {
+            return $this->data[$offset];
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public function getPath() {
+        return $this->path;
+    }
+
+    /**
+     * @return \OCP\Files\Storage
+     */
+    public function getStorage() {
+        return $this->storage;
+    }
+
+    /**
+     * @return string
+     */
+    public function getInternalPath() {
+        return $this->internalPath;
+    }
+
+    /**
+     * Get FileInfo ID or null in case of part file
+     *
+     * @return int|null
+     */
+    public function getId() {
+        return isset($this->data['fileid']) ? (int)  $this->data['fileid'] : null;
+    }
+
+    /**
+     * @return string
+     */
+    public function getMimetype() {
+        return $this->data['mimetype'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getMimePart() {
+        return $this->data['mimepart'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getName() {
+        return isset($this->data['name']) ? $this->data['name'] : basename($this->getPath());
+    }
+
+    /**
+     * @return string
+     */
+    public function getEtag() {
+        $this->updateEntryfromSubMounts();
+        if (count($this->childEtags) > 0) {
+            $combinedEtag = $this->data['etag'] . '::' . implode('::', $this->childEtags);
+            return md5($combinedEtag);
+        } else {
+            return $this->data['etag'];
+        }
+    }
+
+    /**
+     * @return int
+     */
+    public function getSize($includeMounts = true) {
+        if ($includeMounts) {
+            $this->updateEntryfromSubMounts();
+            return isset($this->data['size']) ? 0 + $this->data['size'] : 0;
+        } else {
+            return $this->rawSize;
+        }
+    }
+
+    /**
+     * @return int
+     */
+    public function getMTime() {
+        $this->updateEntryfromSubMounts();
+        return (int) $this->data['mtime'];
+    }
+
+    /**
+     * @return bool
+     */
+    public function isEncrypted() {
+        return $this->data['encrypted'];
+    }
+
+    /**
+     * Return the currently version used for the HMAC in the encryption app
+     *
+     * @return int
+     */
+    public function getEncryptedVersion() {
+        return isset($this->data['encryptedVersion']) ? (int) $this->data['encryptedVersion'] : 1;
+    }
+
+    /**
+     * @return int
+     */
+    public function getPermissions() {
+        $perms = (int) $this->data['permissions'];
+        if (\OCP\Util::isSharingDisabledForUser() || ($this->isShared() && !\OC\Share\Share::isResharingAllowed())) {
+            $perms = $perms & ~\OCP\Constants::PERMISSION_SHARE;
+        }
+        return (int) $perms;
+    }
+
+    /**
+     * @return string \OCP\Files\FileInfo::TYPE_FILE|\OCP\Files\FileInfo::TYPE_FOLDER
+     */
+    public function getType() {
+        if (!isset($this->data['type'])) {
+            $this->data['type'] = ($this->getMimetype() === 'httpd/unix-directory') ? self::TYPE_FOLDER : self::TYPE_FILE;
+        }
+        return $this->data['type'];
+    }
+
+    public function getData() {
+        return $this->data;
+    }
+
+    /**
+     * @param int $permissions
+     * @return bool
+     */
+    protected function checkPermissions($permissions) {
+        return ($this->getPermissions() & $permissions) === $permissions;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isReadable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_READ);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isUpdateable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_UPDATE);
+    }
+
+    /**
+     * Check whether new files or folders can be created inside this folder
+     *
+     * @return bool
+     */
+    public function isCreatable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_CREATE);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isDeletable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_DELETE);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isShareable() {
+        return $this->checkPermissions(\OCP\Constants::PERMISSION_SHARE);
+    }
+
+    /**
+     * Check if a file or folder is shared
+     *
+     * @return bool
+     */
+    public function isShared() {
+        $sid = $this->getStorage()->getId();
+        if (!is_null($sid)) {
+            $sid = explode(':', $sid);
+            return ($sid[0] === 'shared');
+        }
+
+        return false;
+    }
+
+    public function isMounted() {
+        $storage = $this->getStorage();
+        if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
+            return false;
+        }
+        $sid = $storage->getId();
+        if (!is_null($sid)) {
+            $sid = explode(':', $sid);
+            return ($sid[0] !== 'home' and $sid[0] !== 'shared');
+        }
+
+        return false;
+    }
+
+    /**
+     * Get the mountpoint the file belongs to
+     *
+     * @return \OCP\Files\Mount\IMountPoint
+     */
+    public function getMountPoint() {
+        return $this->mount;
+    }
+
+    /**
+     * Get the owner of the file
+     *
+     * @return \OCP\IUser
+     */
+    public function getOwner() {
+        return $this->owner;
+    }
+
+    /**
+     * @param IMountPoint[] $mounts
+     */
+    public function setSubMounts(array $mounts) {
+        $this->subMounts = $mounts;
+    }
+
+    private function updateEntryfromSubMounts() {
+        if ($this->subMountsUsed) {
+            return;
+        }
+        $this->subMountsUsed = true;
+        foreach ($this->subMounts as $mount) {
+            $subStorage = $mount->getStorage();
+            if ($subStorage) {
+                $subCache = $subStorage->getCache('');
+                $rootEntry = $subCache->get('');
+                $this->addSubEntry($rootEntry, $mount->getMountPoint());
+            }
+        }
+    }
+
+    /**
+     * Add a cache entry which is the child of this folder
+     *
+     * Sets the size, etag and size to for cross-storage childs
+     *
+     * @param array|ICacheEntry $data cache entry for the child
+     * @param string $entryPath full path of the child entry
+     */
+    public function addSubEntry($data, $entryPath) {
+        $this->data['size'] += isset($data['size']) ? $data['size'] : 0;
+        if (isset($data['mtime'])) {
+            $this->data['mtime'] = max($this->data['mtime'], $data['mtime']);
+        }
+        if (isset($data['etag'])) {
+            // prefix the etag with the relative path of the subentry to propagate etag on mount moves
+            $relativeEntryPath = substr($entryPath, strlen($this->getPath()));
+            // attach the permissions to propagate etag on permision changes of submounts
+            $permissions = isset($data['permissions']) ? $data['permissions'] : 0;
+            $this->childEtags[] = $relativeEntryPath . '/' . $data['etag'] . $permissions;
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getChecksum() {
+        return $this->data['checksum'];
+    }
+
+    public function getExtension(): string {
+        return pathinfo($this->getName(), PATHINFO_EXTENSION);
+    }
+
+    public function getCreationTime(): int {
+        return (int) $this->data['creation_time'];
+    }
+
+    public function getUploadTime(): int {
+        return (int) $this->data['upload_time'];
+    }
 }

lib/private/Files/Storage/CommonTest.php

Indentation +47 added lines, -47 removed lines

@@ -33,53 +33,53 @@
 namespace OC\Files\Storage;
 
 class CommonTest extends \OC\Files\Storage\Common {
-	/**
-	 * underlying local storage used for missing functions
-	 * @var \OC\Files\Storage\Local
-	 */
-	private $storage;
+    /**
+     * underlying local storage used for missing functions
+     * @var \OC\Files\Storage\Local
+     */
+    private $storage;
 
-	public function __construct($params) {
-		$this->storage = new \OC\Files\Storage\Local($params);
-	}
+    public function __construct($params) {
+        $this->storage = new \OC\Files\Storage\Local($params);
+    }
 
-	public function getId() {
-		return 'test::'.$this->storage->getId();
-	}
-	public function mkdir($path) {
-		return $this->storage->mkdir($path);
-	}
-	public function rmdir($path) {
-		return $this->storage->rmdir($path);
-	}
-	public function opendir($path) {
-		return $this->storage->opendir($path);
-	}
-	public function stat($path) {
-		return $this->storage->stat($path);
-	}
-	public function filetype($path) {
-		return @$this->storage->filetype($path);
-	}
-	public function isReadable($path) {
-		return $this->storage->isReadable($path);
-	}
-	public function isUpdatable($path) {
-		return $this->storage->isUpdatable($path);
-	}
-	public function file_exists($path) {
-		return $this->storage->file_exists($path);
-	}
-	public function unlink($path) {
-		return $this->storage->unlink($path);
-	}
-	public function fopen($path, $mode) {
-		return $this->storage->fopen($path, $mode);
-	}
-	public function free_space($path) {
-		return $this->storage->free_space($path);
-	}
-	public function touch($path, $mtime = null) {
-		return $this->storage->touch($path, $mtime);
-	}
+    public function getId() {
+        return 'test::'.$this->storage->getId();
+    }
+    public function mkdir($path) {
+        return $this->storage->mkdir($path);
+    }
+    public function rmdir($path) {
+        return $this->storage->rmdir($path);
+    }
+    public function opendir($path) {
+        return $this->storage->opendir($path);
+    }
+    public function stat($path) {
+        return $this->storage->stat($path);
+    }
+    public function filetype($path) {
+        return @$this->storage->filetype($path);
+    }
+    public function isReadable($path) {
+        return $this->storage->isReadable($path);
+    }
+    public function isUpdatable($path) {
+        return $this->storage->isUpdatable($path);
+    }
+    public function file_exists($path) {
+        return $this->storage->file_exists($path);
+    }
+    public function unlink($path) {
+        return $this->storage->unlink($path);
+    }
+    public function fopen($path, $mode) {
+        return $this->storage->fopen($path, $mode);
+    }
+    public function free_space($path) {
+        return $this->storage->free_space($path);
+    }
+    public function touch($path, $mtime = null) {
+        return $this->storage->touch($path, $mtime);
+    }
 }

lib/private/DB/AdapterSqlite.php

Spacing +2 added lines, -2 removed lines

@@ -64,14 +64,14 @@
 		if (empty($compare)) {
 			$compare = array_keys($input);
 		}
-		$fieldList = '`' . implode('`,`', array_keys($input)) . '`';
+		$fieldList = '`'.implode('`,`', array_keys($input)).'`';
 		$query = "INSERT INTO `$table` ($fieldList) SELECT "
 			. str_repeat('?,', count($input) - 1).'? '
 			. " WHERE NOT EXISTS (SELECT 1 FROM `$table` WHERE ";
 
 		$inserts = array_values($input);
 		foreach ($compare as $key) {
-			$query .= '`' . $key . '`';
+			$query .= '`'.$key.'`';
 			if (is_null($input[$key])) {
 				$query .= ' IS NULL AND ';
 			} else {

Indentation +61 added lines, -61 removed lines

@@ -31,70 +31,70 @@
 
 class AdapterSqlite extends Adapter {
 
-	/**
-	 * @param string $tableName
-	 */
-	public function lockTable($tableName) {
-		$this->conn->executeUpdate('BEGIN EXCLUSIVE TRANSACTION');
-	}
+    /**
+     * @param string $tableName
+     */
+    public function lockTable($tableName) {
+        $this->conn->executeUpdate('BEGIN EXCLUSIVE TRANSACTION');
+    }
 
-	public function unlockTable() {
-		$this->conn->executeUpdate('COMMIT TRANSACTION');
-	}
+    public function unlockTable() {
+        $this->conn->executeUpdate('COMMIT TRANSACTION');
+    }
 
-	public function fixupStatement($statement) {
-		$statement = preg_replace('/`(\w+)` ILIKE \?/', 'LOWER($1) LIKE LOWER(?)', $statement);
-		$statement = str_replace('`', '"', $statement);
-		$statement = str_ireplace('NOW()', 'datetime(\'now\')', $statement);
-		$statement = str_ireplace('GREATEST(', 'MAX(', $statement);
-		$statement = str_ireplace('UNIX_TIMESTAMP()', 'strftime(\'%s\',\'now\')', $statement);
-		return $statement;
-	}
+    public function fixupStatement($statement) {
+        $statement = preg_replace('/`(\w+)` ILIKE \?/', 'LOWER($1) LIKE LOWER(?)', $statement);
+        $statement = str_replace('`', '"', $statement);
+        $statement = str_ireplace('NOW()', 'datetime(\'now\')', $statement);
+        $statement = str_ireplace('GREATEST(', 'MAX(', $statement);
+        $statement = str_ireplace('UNIX_TIMESTAMP()', 'strftime(\'%s\',\'now\')', $statement);
+        return $statement;
+    }
 
-	/**
-	 * Insert a row if the matching row does not exists. To accomplish proper race condition avoidance
-	 * it is needed that there is also a unique constraint on the values. Then this method will
-	 * catch the exception and return 0.
-	 *
-	 * @param string $table The table name (will replace *PREFIX* with the actual prefix)
-	 * @param array $input data that should be inserted into the table  (column name => value)
-	 * @param array|null $compare List of values that should be checked for "if not exists"
-	 *				If this is null or an empty array, all keys of $input will be compared
-	 *				Please note: text fields (clob) must not be used in the compare array
-	 * @return int number of inserted rows
-	 * @throws \Doctrine\DBAL\DBALException
-	 * @deprecated 15.0.0 - use unique index and "try { $db->insert() } catch (UniqueConstraintViolationException $e) {}" instead, because it is more reliable and does not have the risk for deadlocks - see https://github.com/nextcloud/server/pull/12371
-	 */
-	public function insertIfNotExist($table, $input, array $compare = null) {
-		if (empty($compare)) {
-			$compare = array_keys($input);
-		}
-		$fieldList = '`' . implode('`,`', array_keys($input)) . '`';
-		$query = "INSERT INTO `$table` ($fieldList) SELECT "
-			. str_repeat('?,', count($input) - 1).'? '
-			. " WHERE NOT EXISTS (SELECT 1 FROM `$table` WHERE ";
+    /**
+     * Insert a row if the matching row does not exists. To accomplish proper race condition avoidance
+     * it is needed that there is also a unique constraint on the values. Then this method will
+     * catch the exception and return 0.
+     *
+     * @param string $table The table name (will replace *PREFIX* with the actual prefix)
+     * @param array $input data that should be inserted into the table  (column name => value)
+     * @param array|null $compare List of values that should be checked for "if not exists"
+     *				If this is null or an empty array, all keys of $input will be compared
+     *				Please note: text fields (clob) must not be used in the compare array
+     * @return int number of inserted rows
+     * @throws \Doctrine\DBAL\DBALException
+     * @deprecated 15.0.0 - use unique index and "try { $db->insert() } catch (UniqueConstraintViolationException $e) {}" instead, because it is more reliable and does not have the risk for deadlocks - see https://github.com/nextcloud/server/pull/12371
+     */
+    public function insertIfNotExist($table, $input, array $compare = null) {
+        if (empty($compare)) {
+            $compare = array_keys($input);
+        }
+        $fieldList = '`' . implode('`,`', array_keys($input)) . '`';
+        $query = "INSERT INTO `$table` ($fieldList) SELECT "
+            . str_repeat('?,', count($input) - 1).'? '
+            . " WHERE NOT EXISTS (SELECT 1 FROM `$table` WHERE ";
 
-		$inserts = array_values($input);
-		foreach ($compare as $key) {
-			$query .= '`' . $key . '`';
-			if (is_null($input[$key])) {
-				$query .= ' IS NULL AND ';
-			} else {
-				$inserts[] = $input[$key];
-				$query .= ' = ? AND ';
-			}
-		}
-		$query = substr($query, 0, -5);
-		$query .= ')';
+        $inserts = array_values($input);
+        foreach ($compare as $key) {
+            $query .= '`' . $key . '`';
+            if (is_null($input[$key])) {
+                $query .= ' IS NULL AND ';
+            } else {
+                $inserts[] = $input[$key];
+                $query .= ' = ? AND ';
+            }
+        }
+        $query = substr($query, 0, -5);
+        $query .= ')';
 
-		try {
-			return $this->conn->executeUpdate($query, $inserts);
-		} catch (UniqueConstraintViolationException $e) {
-			// if this is thrown then a concurrent insert happened between the insert and the sub-select in the insert, that should have avoided it
-			// it's fine to ignore this then
-			//
-			// more discussions about this can be found at https://github.com/nextcloud/server/pull/12315
-			return 0;
-		}
-	}
+        try {
+            return $this->conn->executeUpdate($query, $inserts);
+        } catch (UniqueConstraintViolationException $e) {
+            // if this is thrown then a concurrent insert happened between the insert and the sub-select in the insert, that should have avoided it
+            // it's fine to ignore this then
+            //
+            // more discussions about this can be found at https://github.com/nextcloud/server/pull/12315
+            return 0;
+        }
+    }
 }