nextcloud / server

lib/public/Template.php

Indentation +87 added lines, -87 removed lines

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

lib/public/ITagManager.php

Indentation +13 added lines, -13 removed lines

@@ -48,17 +48,17 @@
  */
 interface ITagManager {
 
-	/**
-	 * Create a new \OCP\ITags instance and load tags from db for the current user.
-	 *
-	 * @see \OCP\ITags
-	 * @param string $type The type identifier e.g. 'contact' or 'event'.
-	 * @param array $defaultTags An array of default tags to be used if none are stored.
-	 * @param boolean $includeShared Whether to include tags for items shared with this user by others.
-	 * @param string $userId user for which to retrieve the tags, defaults to the currently
-	 * logged in user
-	 * @return \OCP\ITags
-	 * @since 6.0.0 - parameter $includeShared and $userId were added in 8.0.0
-	*/
-	public function load($type, $defaultTags = [], $includeShared = false, $userId = null);
+    /**
+     * Create a new \OCP\ITags instance and load tags from db for the current user.
+     *
+     * @see \OCP\ITags
+     * @param string $type The type identifier e.g. 'contact' or 'event'.
+     * @param array $defaultTags An array of default tags to be used if none are stored.
+     * @param boolean $includeShared Whether to include tags for items shared with this user by others.
+     * @param string $userId user for which to retrieve the tags, defaults to the currently
+     * logged in user
+     * @return \OCP\ITags
+     * @since 6.0.0 - parameter $includeShared and $userId were added in 8.0.0
+     */
+    public function load($type, $defaultTags = [], $includeShared = false, $userId = null);
 }

lib/public/IURLGenerator.php

Indentation +59 added lines, -59 removed lines

@@ -35,71 +35,71 @@
  * @since 6.0.0
  */
 interface IURLGenerator {
-	/**
-	 * Returns the URL for a route
-	 * @param string $routeName the name of the route
-	 * @param array $arguments an array with arguments which will be filled into the url
-	 * @return string the url
-	 * @since 6.0.0
-	 */
-	public function linkToRoute(string $routeName, array $arguments = []): string;
+    /**
+     * Returns the URL for a route
+     * @param string $routeName the name of the route
+     * @param array $arguments an array with arguments which will be filled into the url
+     * @return string the url
+     * @since 6.0.0
+     */
+    public function linkToRoute(string $routeName, array $arguments = []): string;
 
-	/**
-	 * Returns the absolute URL for a route
-	 * @param string $routeName the name of the route
-	 * @param array $arguments an array with arguments which will be filled into the url
-	 * @return string the absolute url
-	 * @since 8.0.0
-	 */
-	public function linkToRouteAbsolute(string $routeName, array $arguments = []): string;
+    /**
+     * Returns the absolute URL for a route
+     * @param string $routeName the name of the route
+     * @param array $arguments an array with arguments which will be filled into the url
+     * @return string the absolute url
+     * @since 8.0.0
+     */
+    public function linkToRouteAbsolute(string $routeName, array $arguments = []): string;
 
-	/**
-	 * @param string $routeName
-	 * @param array $arguments
-	 * @return string
-	 * @since 15.0.0
-	 */
-	public function linkToOCSRouteAbsolute(string $routeName, array $arguments = []): string;
+    /**
+     * @param string $routeName
+     * @param array $arguments
+     * @return string
+     * @since 15.0.0
+     */
+    public function linkToOCSRouteAbsolute(string $routeName, array $arguments = []): string;
 
-	/**
-	 * Returns an URL for an image or file
-	 * @param string $appName the name of the app
-	 * @param string $file the name of the 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 6.0.0
-	 */
-	public function linkTo(string $appName, string $file, array $args = []): string;
+    /**
+     * Returns an URL for an image or file
+     * @param string $appName the name of the app
+     * @param string $file the name of the 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 6.0.0
+     */
+    public function linkTo(string $appName, string $file, array $args = []): string;
 
-	/**
-	 * Returns the link to an image, like linkTo but only with prepending img/
-	 * @param string $appName the name of the app
-	 * @param string $file the name of the file
-	 * @return string the url
-	 * @since 6.0.0
-	 */
-	public function imagePath(string $appName, string $file): string;
+    /**
+     * Returns the link to an image, like linkTo but only with prepending img/
+     * @param string $appName the name of the app
+     * @param string $file the name of the file
+     * @return string the url
+     * @since 6.0.0
+     */
+    public function imagePath(string $appName, string $file): string;
 
 
-	/**
-	 * Makes an URL absolute
-	 * @param string $url the url in the ownCloud host
-	 * @return string the absolute version of the url
-	 * @since 6.0.0
-	 */
-	public function getAbsoluteURL(string $url): string;
+    /**
+     * Makes an URL absolute
+     * @param string $url the url in the ownCloud host
+     * @return string the absolute version of the url
+     * @since 6.0.0
+     */
+    public function getAbsoluteURL(string $url): string;
 
-	/**
-	 * @param string $key
-	 * @return string url to the online documentation
-	 * @since 8.0.0
-	 */
-	public function linkToDocs(string $key): string;
+    /**
+     * @param string $key
+     * @return string url to the online documentation
+     * @since 8.0.0
+     */
+    public function linkToDocs(string $key): string;
 
-	/**
-	 * @return string base url of the current request
-	 * @since 13.0.0
-	 */
-	public function getBaseUrl(): string;
+    /**
+     * @return string base url of the current request
+     * @since 13.0.0
+     */
+    public function getBaseUrl(): string;
 }

lib/public/Util.php

Indentation +469 added lines, -469 removed lines

@@ -56,473 +56,473 @@
  * @since 4.0.0
  */
 class Util {
-	/**
-	 * @deprecated 14.0.0 use \OCP\ILogger::DEBUG
-	 */
-	const DEBUG=0;
-	/**
-	 * @deprecated 14.0.0 use \OCP\ILogger::INFO
-	 */
-	const INFO=1;
-	/**
-	 * @deprecated 14.0.0 use \OCP\ILogger::WARN
-	 */
-	const WARN=2;
-	/**
-	 * @deprecated 14.0.0 use \OCP\ILogger::ERROR
-	 */
-	const ERROR=3;
-	/**
-	 * @deprecated 14.0.0 use \OCP\ILogger::FATAL
-	 */
-	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
-	 */
-	static public function connectHook($signalClass, $signalName, $slotClass, $slotName) {
-		return \OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName);
-	}
-
-	/**
-	 * Emits a signal. To get data from the slot use references!
-	 * @param string $signalclass class name of emitter
-	 * @param string $signalname name of signal
-	 * @param array $params default: array() array with additional data
-	 * @return bool true if slots exists or false if not
-	 *
-	 * TODO: write example
-	 * @since 4.0.0
-	 */
-	static public function emitHook($signalclass, $signalname, $params = []) {
-		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
+     */
+    const DEBUG=0;
+    /**
+     * @deprecated 14.0.0 use \OCP\ILogger::INFO
+     */
+    const INFO=1;
+    /**
+     * @deprecated 14.0.0 use \OCP\ILogger::WARN
+     */
+    const WARN=2;
+    /**
+     * @deprecated 14.0.0 use \OCP\ILogger::ERROR
+     */
+    const ERROR=3;
+    /**
+     * @deprecated 14.0.0 use \OCP\ILogger::FATAL
+     */
+    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
+     */
+    static public function connectHook($signalClass, $signalName, $slotClass, $slotName) {
+        return \OC_Hook::connect($signalClass, $signalName, $slotClass, $slotName);
+    }
+
+    /**
+     * Emits a signal. To get data from the slot use references!
+     * @param string $signalclass class name of emitter
+     * @param string $signalname name of signal
+     * @param array $params default: array() array with additional data
+     * @return bool true if slots exists or false if not
+     *
+     * TODO: write example
+     * @since 4.0.0
+     */
+    static public function emitHook($signalclass, $signalname, $params = []) {
+        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/Contacts/IManager.php

Indentation +119 added lines, -119 removed lines

@@ -53,132 +53,132 @@
  */
 interface IManager {
 
-	/**
-	 * This function is used to search and find contacts within the users address books.
-	 * In case $pattern is empty all contacts will be returned.
-	 *
-	 * Example:
-	 *  Following function shows how to search for contacts for the name and the email address.
-	 *
-	 *		public static function getMatchingRecipient($term) {
-	 *			$cm = \OC::$server->getContactsManager();
-	 *			// The API is not active -> nothing to do
-	 *			if (!$cm->isEnabled()) {
-	 *				return array();
-	 *			}
-	 *
-	 *			$result = $cm->search($term, array('FN', 'EMAIL'));
-	 *			$receivers = array();
-	 *			foreach ($result as $r) {
-	 *				$id = $r['id'];
-	 *				$fn = $r['FN'];
-	 *				$email = $r['EMAIL'];
-	 *				if (!is_array($email)) {
-	 *					$email = array($email);
-	 *				}
-	 *
-	 *				// loop through all email addresses of this contact
-	 *				foreach ($email as $e) {
-	 *				$displayName = $fn . " <$e>";
-	 *				$receivers[] = array(
-	 *					'id'    => $id,
-	 *					'label' => $displayName,
-	 *					'value' => $displayName);
-	 *				}
-	 *			}
-	 *
-	 *			return $receivers;
-	 *		}
-	 *
-	 *
-	 * @param string $pattern which should match within the $searchProperties
-	 * @param array $searchProperties defines the properties within the query pattern should match
-	 * @param array $options = array() to define the search behavior
-	 * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
-	 * @return array an array of contacts which are arrays of key-value-pairs
-	 * @since 6.0.0
-	 */
-	public function search($pattern, $searchProperties = [], $options = []);
+    /**
+     * This function is used to search and find contacts within the users address books.
+     * In case $pattern is empty all contacts will be returned.
+     *
+     * Example:
+     *  Following function shows how to search for contacts for the name and the email address.
+     *
+     *		public static function getMatchingRecipient($term) {
+     *			$cm = \OC::$server->getContactsManager();
+     *			// The API is not active -> nothing to do
+     *			if (!$cm->isEnabled()) {
+     *				return array();
+     *			}
+     *
+     *			$result = $cm->search($term, array('FN', 'EMAIL'));
+     *			$receivers = array();
+     *			foreach ($result as $r) {
+     *				$id = $r['id'];
+     *				$fn = $r['FN'];
+     *				$email = $r['EMAIL'];
+     *				if (!is_array($email)) {
+     *					$email = array($email);
+     *				}
+     *
+     *				// loop through all email addresses of this contact
+     *				foreach ($email as $e) {
+     *				$displayName = $fn . " <$e>";
+     *				$receivers[] = array(
+     *					'id'    => $id,
+     *					'label' => $displayName,
+     *					'value' => $displayName);
+     *				}
+     *			}
+     *
+     *			return $receivers;
+     *		}
+     *
+     *
+     * @param string $pattern which should match within the $searchProperties
+     * @param array $searchProperties defines the properties within the query pattern should match
+     * @param array $options = array() to define the search behavior
+     * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped
+     * @return array an array of contacts which are arrays of key-value-pairs
+     * @since 6.0.0
+     */
+    public function search($pattern, $searchProperties = [], $options = []);
 
-	/**
-	 * This function can be used to delete the contact identified by the given id
-	 *
-	 * @param object $id the unique identifier to a contact
-	 * @param string $address_book_key identifier of the address book in which the contact shall be deleted
-	 * @return bool successful or not
-	 * @since 6.0.0
-	 */
-	public function delete($id, $address_book_key);
+    /**
+     * This function can be used to delete the contact identified by the given id
+     *
+     * @param object $id the unique identifier to a contact
+     * @param string $address_book_key identifier of the address book in which the contact shall be deleted
+     * @return bool successful or not
+     * @since 6.0.0
+     */
+    public function delete($id, $address_book_key);
 
-	/**
-	 * This function is used to create a new contact if 'id' is not given or not present.
-	 * Otherwise the contact will be updated by replacing the entire data set.
-	 *
-	 * @param array $properties this array if key-value-pairs defines a contact
-	 * @param string $address_book_key identifier of the address book in which the contact shall be created or updated
-	 * @return array an array representing the contact just created or updated
-	 * @since 6.0.0
-	 */
-	public function createOrUpdate($properties, $address_book_key);
+    /**
+     * This function is used to create a new contact if 'id' is not given or not present.
+     * Otherwise the contact will be updated by replacing the entire data set.
+     *
+     * @param array $properties this array if key-value-pairs defines a contact
+     * @param string $address_book_key identifier of the address book in which the contact shall be created or updated
+     * @return array an array representing the contact just created or updated
+     * @since 6.0.0
+     */
+    public function createOrUpdate($properties, $address_book_key);
 
-	/**
-	 * Check if contacts are available (e.g. contacts app enabled)
-	 *
-	 * @return bool true if enabled, false if not
-	 * @since 6.0.0
-	 */
-	public function isEnabled();
+    /**
+     * Check if contacts are available (e.g. contacts app enabled)
+     *
+     * @return bool true if enabled, false if not
+     * @since 6.0.0
+     */
+    public function isEnabled();
 
-	/**
-	 * Registers an address book
-	 *
-	 * @param \OCP\IAddressBook $address_book
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function registerAddressBook(\OCP\IAddressBook $address_book);
+    /**
+     * Registers an address book
+     *
+     * @param \OCP\IAddressBook $address_book
+     * @return void
+     * @since 6.0.0
+     */
+    public function registerAddressBook(\OCP\IAddressBook $address_book);
 
-	/**
-	 * Unregisters an address book
-	 *
-	 * @param \OCP\IAddressBook $address_book
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function unregisterAddressBook(\OCP\IAddressBook $address_book);
+    /**
+     * Unregisters an address book
+     *
+     * @param \OCP\IAddressBook $address_book
+     * @return void
+     * @since 6.0.0
+     */
+    public function unregisterAddressBook(\OCP\IAddressBook $address_book);
 
-	/**
-	 * In order to improve lazy loading a closure can be registered which will be called in case
-	 * address books are actually requested
-	 *
-	 * @param \Closure $callable
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function register(\Closure $callable);
+    /**
+     * In order to improve lazy loading a closure can be registered which will be called in case
+     * address books are actually requested
+     *
+     * @param \Closure $callable
+     * @return void
+     * @since 6.0.0
+     */
+    public function register(\Closure $callable);
 
-	/**
-	 * Return a list of the user's addressbooks display names
-	 * 
-	 * @return array
-	 * @since 6.0.0
-	 * @deprecated 16.0.0 - Use `$this->getUserAddressBooks()` instead
-	 */
-	public function getAddressBooks();
+    /**
+     * Return a list of the user's addressbooks display names
+     * 
+     * @return array
+     * @since 6.0.0
+     * @deprecated 16.0.0 - Use `$this->getUserAddressBooks()` instead
+     */
+    public function getAddressBooks();
 
-	/**
-	 * Return a list of the user's addressbooks
-	 * 
-	 * @return IAddressBook[]
-	 * @since 16.0.0
-	 */
-	public function getUserAddressBooks();
+    /**
+     * Return a list of the user's addressbooks
+     * 
+     * @return IAddressBook[]
+     * @since 16.0.0
+     */
+    public function getUserAddressBooks();
 
-	/**
-	 * removes all registered address book instances
-	 * 
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function clear();
+    /**
+     * removes all registered address book instances
+     * 
+     * @return void
+     * @since 6.0.0
+     */
+    public function clear();
 }

lib/public/IDBConnection.php

Indentation +252 added lines, -252 removed lines

@@ -48,256 +48,256 @@
  */
 interface IDBConnection {
 
-	const ADD_MISSING_INDEXES_EVENT = self::class . '::ADD_MISSING_INDEXES';
-	const CHECK_MISSING_INDEXES_EVENT = self::class . '::CHECK_MISSING_INDEXES';
-
-	/**
-	 * Gets the QueryBuilder for the connection.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder
-	 * @since 8.2.0
-	 */
-	public function getQueryBuilder();
-
-	/**
-	 * Used to abstract the ownCloud database access away
-	 * @param string $sql the sql query with ? placeholder for params
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
-	 * @since 6.0.0
-	 */
-	public function prepare($sql, $limit=null, $offset=null);
-
-	/**
-	 * Executes an, optionally parameterized, SQL query.
-	 *
-	 * If the query is parameterized, a prepared statement is used.
-	 * If an SQLLogger is configured, the execution is logged.
-	 *
-	 * @param string $query The SQL query to execute.
-	 * @param string[] $params The parameters to bind to the query, if any.
-	 * @param array $types The types the previous parameters are in.
-	 * @return \Doctrine\DBAL\Driver\Statement The executed statement.
-	 * @since 8.0.0
-	 */
-	public function executeQuery($query, array $params = [], $types = []);
-
-	/**
-	 * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
-	 * and returns the number of affected rows.
-	 *
-	 * This method supports PDO binding types as well as DBAL mapping types.
-	 *
-	 * @param string $query The SQL query.
-	 * @param array $params The query parameters.
-	 * @param array $types The parameter types.
-	 * @return integer The number of affected rows.
-	 * @since 8.0.0
-	 */
-	public function executeUpdate($query, array $params = [], array $types = []);
-
-	/**
-	 * Used to get the id of the just inserted element
-	 * @param string $table the name of the table where we inserted the item
-	 * @return int the id of the inserted element
-	 * @since 6.0.0
-	 */
-	public function lastInsertId($table = null);
-
-	/**
-	 * 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
-	 * @since 6.0.0 - parameter $compare was added in 8.1.0, return type changed from boolean in 8.1.0
-	 * @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);
-
-
-	/**
-	 *
-	 * Insert a row if the row does not exist. Eventual conflicts during insert will be ignored.
-	 *
-	 * Implementation is not fully finished and should not be used!
-	 *
-	 * @param string $table The table name (will replace *PREFIX* with the actual prefix)
-	 * @param array $values data that should be inserted into the table  (column name => value)
-	 * @return int number of inserted rows
-	 * @since 16.0.0
-	 */
-	public function insertIgnoreConflict(string $table,array $values) : int;
-
-	/**
-	 * Insert or update a row value
-	 *
-	 * @param string $table
-	 * @param array $keys (column name => value)
-	 * @param array $values (column name => value)
-	 * @param array $updatePreconditionValues ensure values match preconditions (column name => value)
-	 * @return int number of new rows
-	 * @throws \Doctrine\DBAL\DBALException
-	 * @throws PreconditionNotMetException
-	 * @since 9.0.0
-	 */
-	public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []);
-
-	/**
-	 * Create an exclusive read+write lock on a table
-	 *
-	 * Important Note: Due to the nature how locks work on different DBs, it is
-	 * only possible to lock one table at a time. You should also NOT start a
-	 * transaction while holding a lock.
-	 *
-	 * @param string $tableName
-	 * @since 9.1.0
-	 */
-	public function lockTable($tableName);
-
-	/**
-	 * Release a previous acquired lock again
-	 *
-	 * @since 9.1.0
-	 */
-	public function unlockTable();
-
-	/**
-	 * Start a transaction
-	 * @since 6.0.0
-	 */
-	public function beginTransaction();
-
-	/**
-	 * Check if a transaction is active
-	 *
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function inTransaction();
-
-	/**
-	 * Commit the database changes done during a transaction that is in progress
-	 * @since 6.0.0
-	 */
-	public function commit();
-
-	/**
-	 * Rollback the database changes done during a transaction that is in progress
-	 * @since 6.0.0
-	 */
-	public function rollBack();
-
-	/**
-	 * Gets the error code and message as a string for logging
-	 * @return string
-	 * @since 6.0.0
-	 */
-	public function getError();
-
-	/**
-	 * Fetch the SQLSTATE associated with the last database operation.
-	 *
-	 * @return integer The last error code.
-	 * @since 8.0.0
-	 */
-	public function errorCode();
-
-	/**
-	 * Fetch extended error information associated with the last database operation.
-	 *
-	 * @return array The last error information.
-	 * @since 8.0.0
-	 */
-	public function errorInfo();
-
-	/**
-	 * Establishes the connection with the database.
-	 *
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function connect();
-
-	/**
-	 * Close the database connection
-	 * @since 8.0.0
-	 */
-	public function close();
-
-	/**
-	 * Quotes a given input parameter.
-	 *
-	 * @param mixed $input Parameter to be quoted.
-	 * @param int $type Type of the parameter.
-	 * @return string The quoted parameter.
-	 * @since 8.0.0
-	 */
-	public function quote($input, $type = IQueryBuilder::PARAM_STR);
-
-	/**
-	 * Gets the DatabasePlatform instance that provides all the metadata about
-	 * the platform this driver connects to.
-	 *
-	 * @return \Doctrine\DBAL\Platforms\AbstractPlatform The database platform.
-	 * @since 8.0.0
-	 */
-	public function getDatabasePlatform();
-
-	/**
-	 * Drop a table from the database if it exists
-	 *
-	 * @param string $table table name without the prefix
-	 * @since 8.0.0
-	 */
-	public function dropTable($table);
-
-	/**
-	 * Check if a table exists
-	 *
-	 * @param string $table table name without the prefix
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function tableExists($table);
-
-	/**
-	 * Escape a parameter to be used in a LIKE query
-	 *
-	 * @param string $param
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function escapeLikeParameter($param);
-
-	/**
-	 * Check whether or not the current database support 4byte wide unicode
-	 *
-	 * @return bool
-	 * @since 11.0.0
-	 */
-	public function supports4ByteText();
-
-	/**
-	 * Create the schema of the connected database
-	 *
-	 * @return Schema
-	 * @since 13.0.0
-	 */
-	public function createSchema();
-
-	/**
-	 * Migrate the database to the given schema
-	 *
-	 * @param Schema $toSchema
-	 * @since 13.0.0
-	 */
-	public function migrateToSchema(Schema $toSchema);
+    const ADD_MISSING_INDEXES_EVENT = self::class . '::ADD_MISSING_INDEXES';
+    const CHECK_MISSING_INDEXES_EVENT = self::class . '::CHECK_MISSING_INDEXES';
+
+    /**
+     * Gets the QueryBuilder for the connection.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder
+     * @since 8.2.0
+     */
+    public function getQueryBuilder();
+
+    /**
+     * Used to abstract the ownCloud database access away
+     * @param string $sql the sql query with ? placeholder for params
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
+     * @since 6.0.0
+     */
+    public function prepare($sql, $limit=null, $offset=null);
+
+    /**
+     * Executes an, optionally parameterized, SQL query.
+     *
+     * If the query is parameterized, a prepared statement is used.
+     * If an SQLLogger is configured, the execution is logged.
+     *
+     * @param string $query The SQL query to execute.
+     * @param string[] $params The parameters to bind to the query, if any.
+     * @param array $types The types the previous parameters are in.
+     * @return \Doctrine\DBAL\Driver\Statement The executed statement.
+     * @since 8.0.0
+     */
+    public function executeQuery($query, array $params = [], $types = []);
+
+    /**
+     * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
+     * and returns the number of affected rows.
+     *
+     * This method supports PDO binding types as well as DBAL mapping types.
+     *
+     * @param string $query The SQL query.
+     * @param array $params The query parameters.
+     * @param array $types The parameter types.
+     * @return integer The number of affected rows.
+     * @since 8.0.0
+     */
+    public function executeUpdate($query, array $params = [], array $types = []);
+
+    /**
+     * Used to get the id of the just inserted element
+     * @param string $table the name of the table where we inserted the item
+     * @return int the id of the inserted element
+     * @since 6.0.0
+     */
+    public function lastInsertId($table = null);
+
+    /**
+     * 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
+     * @since 6.0.0 - parameter $compare was added in 8.1.0, return type changed from boolean in 8.1.0
+     * @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);
+
+
+    /**
+     *
+     * Insert a row if the row does not exist. Eventual conflicts during insert will be ignored.
+     *
+     * Implementation is not fully finished and should not be used!
+     *
+     * @param string $table The table name (will replace *PREFIX* with the actual prefix)
+     * @param array $values data that should be inserted into the table  (column name => value)
+     * @return int number of inserted rows
+     * @since 16.0.0
+     */
+    public function insertIgnoreConflict(string $table,array $values) : int;
+
+    /**
+     * Insert or update a row value
+     *
+     * @param string $table
+     * @param array $keys (column name => value)
+     * @param array $values (column name => value)
+     * @param array $updatePreconditionValues ensure values match preconditions (column name => value)
+     * @return int number of new rows
+     * @throws \Doctrine\DBAL\DBALException
+     * @throws PreconditionNotMetException
+     * @since 9.0.0
+     */
+    public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []);
+
+    /**
+     * Create an exclusive read+write lock on a table
+     *
+     * Important Note: Due to the nature how locks work on different DBs, it is
+     * only possible to lock one table at a time. You should also NOT start a
+     * transaction while holding a lock.
+     *
+     * @param string $tableName
+     * @since 9.1.0
+     */
+    public function lockTable($tableName);
+
+    /**
+     * Release a previous acquired lock again
+     *
+     * @since 9.1.0
+     */
+    public function unlockTable();
+
+    /**
+     * Start a transaction
+     * @since 6.0.0
+     */
+    public function beginTransaction();
+
+    /**
+     * Check if a transaction is active
+     *
+     * @return bool
+     * @since 8.2.0
+     */
+    public function inTransaction();
+
+    /**
+     * Commit the database changes done during a transaction that is in progress
+     * @since 6.0.0
+     */
+    public function commit();
+
+    /**
+     * Rollback the database changes done during a transaction that is in progress
+     * @since 6.0.0
+     */
+    public function rollBack();
+
+    /**
+     * Gets the error code and message as a string for logging
+     * @return string
+     * @since 6.0.0
+     */
+    public function getError();
+
+    /**
+     * Fetch the SQLSTATE associated with the last database operation.
+     *
+     * @return integer The last error code.
+     * @since 8.0.0
+     */
+    public function errorCode();
+
+    /**
+     * Fetch extended error information associated with the last database operation.
+     *
+     * @return array The last error information.
+     * @since 8.0.0
+     */
+    public function errorInfo();
+
+    /**
+     * Establishes the connection with the database.
+     *
+     * @return bool
+     * @since 8.0.0
+     */
+    public function connect();
+
+    /**
+     * Close the database connection
+     * @since 8.0.0
+     */
+    public function close();
+
+    /**
+     * Quotes a given input parameter.
+     *
+     * @param mixed $input Parameter to be quoted.
+     * @param int $type Type of the parameter.
+     * @return string The quoted parameter.
+     * @since 8.0.0
+     */
+    public function quote($input, $type = IQueryBuilder::PARAM_STR);
+
+    /**
+     * Gets the DatabasePlatform instance that provides all the metadata about
+     * the platform this driver connects to.
+     *
+     * @return \Doctrine\DBAL\Platforms\AbstractPlatform The database platform.
+     * @since 8.0.0
+     */
+    public function getDatabasePlatform();
+
+    /**
+     * Drop a table from the database if it exists
+     *
+     * @param string $table table name without the prefix
+     * @since 8.0.0
+     */
+    public function dropTable($table);
+
+    /**
+     * Check if a table exists
+     *
+     * @param string $table table name without the prefix
+     * @return bool
+     * @since 8.0.0
+     */
+    public function tableExists($table);
+
+    /**
+     * Escape a parameter to be used in a LIKE query
+     *
+     * @param string $param
+     * @return string
+     * @since 9.0.0
+     */
+    public function escapeLikeParameter($param);
+
+    /**
+     * Check whether or not the current database support 4byte wide unicode
+     *
+     * @return bool
+     * @since 11.0.0
+     */
+    public function supports4ByteText();
+
+    /**
+     * Create the schema of the connected database
+     *
+     * @return Schema
+     * @since 13.0.0
+     */
+    public function createSchema();
+
+    /**
+     * Migrate the database to the given schema
+     *
+     * @param Schema $toSchema
+     * @since 13.0.0
+     */
+    public function migrateToSchema(Schema $toSchema);
 }

lib/private/DB/ConnectionFactory.php

Indentation +194 added lines, -194 removed lines

@@ -39,219 +39,219 @@
  * Takes care of creating and configuring Doctrine connections.
  */
 class ConnectionFactory {
-	/** @var string default database name */
-	const DEFAULT_DBNAME = 'owncloud';
+    /** @var string default database name */
+    const DEFAULT_DBNAME = 'owncloud';
 
-	/** @var string default database table prefix */
-	const DEFAULT_DBTABLEPREFIX = 'oc_';
+    /** @var string default database table prefix */
+    const DEFAULT_DBTABLEPREFIX = 'oc_';
 
-	/**
-	 * @var array
-	 *
-	 * Array mapping DBMS type to default connection parameters passed to
-	 * \Doctrine\DBAL\DriverManager::getConnection().
-	 */
-	protected $defaultConnectionParams = [
-		'mysql' => [
-			'adapter' => AdapterMySQL::class,
-			'charset' => 'UTF8',
-			'driver' => 'pdo_mysql',
-			'wrapperClass' => Connection::class,
-		],
-		'oci' => [
-			'adapter' => AdapterOCI8::class,
-			'charset' => 'AL32UTF8',
-			'driver' => 'oci8',
-			'wrapperClass' => OracleConnection::class,
-		],
-		'pgsql' => [
-			'adapter' => AdapterPgSql::class,
-			'driver' => 'pdo_pgsql',
-			'wrapperClass' => Connection::class,
-		],
-		'sqlite3' => [
-			'adapter' => AdapterSqlite::class,
-			'driver' => 'pdo_sqlite',
-			'wrapperClass' => Connection::class,
-		],
-	];
+    /**
+     * @var array
+     *
+     * Array mapping DBMS type to default connection parameters passed to
+     * \Doctrine\DBAL\DriverManager::getConnection().
+     */
+    protected $defaultConnectionParams = [
+        'mysql' => [
+            'adapter' => AdapterMySQL::class,
+            'charset' => 'UTF8',
+            'driver' => 'pdo_mysql',
+            'wrapperClass' => Connection::class,
+        ],
+        'oci' => [
+            'adapter' => AdapterOCI8::class,
+            'charset' => 'AL32UTF8',
+            'driver' => 'oci8',
+            'wrapperClass' => OracleConnection::class,
+        ],
+        'pgsql' => [
+            'adapter' => AdapterPgSql::class,
+            'driver' => 'pdo_pgsql',
+            'wrapperClass' => Connection::class,
+        ],
+        'sqlite3' => [
+            'adapter' => AdapterSqlite::class,
+            'driver' => 'pdo_sqlite',
+            'wrapperClass' => Connection::class,
+        ],
+    ];
 
-	/** @var SystemConfig */
-	private $config;
+    /** @var SystemConfig */
+    private $config;
 
-	/**
-	 * ConnectionFactory constructor.
-	 *
-	 * @param SystemConfig $systemConfig
-	 */
-	public function __construct(SystemConfig $systemConfig) {
-		$this->config = $systemConfig;
-		if ($this->config->getValue('mysql.utf8mb4', false)) {
-			$this->defaultConnectionParams['mysql']['charset'] = 'utf8mb4';
-		}
-	}
+    /**
+     * ConnectionFactory constructor.
+     *
+     * @param SystemConfig $systemConfig
+     */
+    public function __construct(SystemConfig $systemConfig) {
+        $this->config = $systemConfig;
+        if ($this->config->getValue('mysql.utf8mb4', false)) {
+            $this->defaultConnectionParams['mysql']['charset'] = 'utf8mb4';
+        }
+    }
 
-	/**
-	 * @brief Get default connection parameters for a given DBMS.
-	 * @param string $type DBMS type
-	 * @throws \InvalidArgumentException If $type is invalid
-	 * @return array Default connection parameters.
-	 */
-	public function getDefaultConnectionParams($type) {
-		$normalizedType = $this->normalizeType($type);
-		if (!isset($this->defaultConnectionParams[$normalizedType])) {
-			throw new \InvalidArgumentException("Unsupported type: $type");
-		}
-		$result = $this->defaultConnectionParams[$normalizedType];
-		// \PDO::MYSQL_ATTR_FOUND_ROWS may not be defined, e.g. when the MySQL
-		// driver is missing. In this case, we won't be able to connect anyway.
-		if ($normalizedType === 'mysql' && defined('\PDO::MYSQL_ATTR_FOUND_ROWS')) {
-			$result['driverOptions'] = [
-				\PDO::MYSQL_ATTR_FOUND_ROWS => true,
-			];
-		}
-		return $result;
-	}
+    /**
+     * @brief Get default connection parameters for a given DBMS.
+     * @param string $type DBMS type
+     * @throws \InvalidArgumentException If $type is invalid
+     * @return array Default connection parameters.
+     */
+    public function getDefaultConnectionParams($type) {
+        $normalizedType = $this->normalizeType($type);
+        if (!isset($this->defaultConnectionParams[$normalizedType])) {
+            throw new \InvalidArgumentException("Unsupported type: $type");
+        }
+        $result = $this->defaultConnectionParams[$normalizedType];
+        // \PDO::MYSQL_ATTR_FOUND_ROWS may not be defined, e.g. when the MySQL
+        // driver is missing. In this case, we won't be able to connect anyway.
+        if ($normalizedType === 'mysql' && defined('\PDO::MYSQL_ATTR_FOUND_ROWS')) {
+            $result['driverOptions'] = [
+                \PDO::MYSQL_ATTR_FOUND_ROWS => true,
+            ];
+        }
+        return $result;
+    }
 
-	/**
-	 * @brief Get default connection parameters for a given DBMS.
-	 * @param string $type DBMS type
-	 * @param array $additionalConnectionParams Additional connection parameters
-	 * @return \OC\DB\Connection
-	 */
-	public function getConnection($type, $additionalConnectionParams) {
-		$normalizedType = $this->normalizeType($type);
-		$eventManager = new EventManager();
-		$eventManager->addEventSubscriber(new SetTransactionIsolationLevel());
-		switch ($normalizedType) {
-			case 'mysql':
-				$eventManager->addEventSubscriber(
-					new SQLSessionInit("SET SESSION AUTOCOMMIT=1"));
-				break;
-			case 'oci':
-				$eventManager->addEventSubscriber(new OracleSessionInit);
-				// the driverOptions are unused in dbal and need to be mapped to the parameters
-				if (isset($additionalConnectionParams['driverOptions'])) {
-					$additionalConnectionParams = array_merge($additionalConnectionParams, $additionalConnectionParams['driverOptions']);
-				}
-				$host = $additionalConnectionParams['host'];
-				$port = isset($additionalConnectionParams['port']) ? $additionalConnectionParams['port'] : null;
-				$dbName = $additionalConnectionParams['dbname'];
+    /**
+     * @brief Get default connection parameters for a given DBMS.
+     * @param string $type DBMS type
+     * @param array $additionalConnectionParams Additional connection parameters
+     * @return \OC\DB\Connection
+     */
+    public function getConnection($type, $additionalConnectionParams) {
+        $normalizedType = $this->normalizeType($type);
+        $eventManager = new EventManager();
+        $eventManager->addEventSubscriber(new SetTransactionIsolationLevel());
+        switch ($normalizedType) {
+            case 'mysql':
+                $eventManager->addEventSubscriber(
+                    new SQLSessionInit("SET SESSION AUTOCOMMIT=1"));
+                break;
+            case 'oci':
+                $eventManager->addEventSubscriber(new OracleSessionInit);
+                // the driverOptions are unused in dbal and need to be mapped to the parameters
+                if (isset($additionalConnectionParams['driverOptions'])) {
+                    $additionalConnectionParams = array_merge($additionalConnectionParams, $additionalConnectionParams['driverOptions']);
+                }
+                $host = $additionalConnectionParams['host'];
+                $port = isset($additionalConnectionParams['port']) ? $additionalConnectionParams['port'] : null;
+                $dbName = $additionalConnectionParams['dbname'];
 
-				// we set the connect string as dbname and unset the host to coerce doctrine into using it as connect string
-				if ($host === '') {
-					$additionalConnectionParams['dbname'] = $dbName; // use dbname as easy connect name
-				} else {
-					$additionalConnectionParams['dbname'] = '//' . $host . (!empty($port) ? ":{$port}" : "") . '/' . $dbName;
-				}
-				unset($additionalConnectionParams['host']);
-				break;
+                // we set the connect string as dbname and unset the host to coerce doctrine into using it as connect string
+                if ($host === '') {
+                    $additionalConnectionParams['dbname'] = $dbName; // use dbname as easy connect name
+                } else {
+                    $additionalConnectionParams['dbname'] = '//' . $host . (!empty($port) ? ":{$port}" : "") . '/' . $dbName;
+                }
+                unset($additionalConnectionParams['host']);
+                break;
 
-			case 'sqlite3':
-				$journalMode = $additionalConnectionParams['sqlite.journal_mode'];
-				$additionalConnectionParams['platform'] = new OCSqlitePlatform();
-				$eventManager->addEventSubscriber(new SQLiteSessionInit(true, $journalMode));
-				break;
-		}
-		/** @var Connection $connection */
-		$connection = DriverManager::getConnection(
-			array_merge($this->getDefaultConnectionParams($type), $additionalConnectionParams),
-			new Configuration(),
-			$eventManager
-		);
-		return $connection;
-	}
+            case 'sqlite3':
+                $journalMode = $additionalConnectionParams['sqlite.journal_mode'];
+                $additionalConnectionParams['platform'] = new OCSqlitePlatform();
+                $eventManager->addEventSubscriber(new SQLiteSessionInit(true, $journalMode));
+                break;
+        }
+        /** @var Connection $connection */
+        $connection = DriverManager::getConnection(
+            array_merge($this->getDefaultConnectionParams($type), $additionalConnectionParams),
+            new Configuration(),
+            $eventManager
+        );
+        return $connection;
+    }
 
-	/**
-	 * @brief Normalize DBMS type
-	 * @param string $type DBMS type
-	 * @return string Normalized DBMS type
-	 */
-	public function normalizeType($type) {
-		return $type === 'sqlite' ? 'sqlite3' : $type;
-	}
+    /**
+     * @brief Normalize DBMS type
+     * @param string $type DBMS type
+     * @return string Normalized DBMS type
+     */
+    public function normalizeType($type) {
+        return $type === 'sqlite' ? 'sqlite3' : $type;
+    }
 
-	/**
-	 * Checks whether the specified DBMS type is valid.
-	 *
-	 * @param string $type
-	 * @return bool
-	 */
-	public function isValidType($type) {
-		$normalizedType = $this->normalizeType($type);
-		return isset($this->defaultConnectionParams[$normalizedType]);
-	}
+    /**
+     * Checks whether the specified DBMS type is valid.
+     *
+     * @param string $type
+     * @return bool
+     */
+    public function isValidType($type) {
+        $normalizedType = $this->normalizeType($type);
+        return isset($this->defaultConnectionParams[$normalizedType]);
+    }
 
-	/**
-	 * Create the connection parameters for the config
-	 *
-	 * @return array
-	 */
-	public function createConnectionParams() {
-		$type = $this->config->getValue('dbtype', 'sqlite');
+    /**
+     * Create the connection parameters for the config
+     *
+     * @return array
+     */
+    public function createConnectionParams() {
+        $type = $this->config->getValue('dbtype', 'sqlite');
 
-		$connectionParams = [
-			'user' => $this->config->getValue('dbuser', ''),
-			'password' => $this->config->getValue('dbpassword', ''),
-		];
-		$name = $this->config->getValue('dbname', self::DEFAULT_DBNAME);
+        $connectionParams = [
+            'user' => $this->config->getValue('dbuser', ''),
+            'password' => $this->config->getValue('dbpassword', ''),
+        ];
+        $name = $this->config->getValue('dbname', self::DEFAULT_DBNAME);
 
-		if ($this->normalizeType($type) === 'sqlite3') {
-			$dataDir = $this->config->getValue("datadirectory", \OC::$SERVERROOT . '/data');
-			$connectionParams['path'] = $dataDir . '/' . $name . '.db';
-		} else {
-			$host = $this->config->getValue('dbhost', '');
-			$connectionParams = array_merge($connectionParams, $this->splitHostFromPortAndSocket($host));
-			$connectionParams['dbname'] = $name;
-		}
+        if ($this->normalizeType($type) === 'sqlite3') {
+            $dataDir = $this->config->getValue("datadirectory", \OC::$SERVERROOT . '/data');
+            $connectionParams['path'] = $dataDir . '/' . $name . '.db';
+        } else {
+            $host = $this->config->getValue('dbhost', '');
+            $connectionParams = array_merge($connectionParams, $this->splitHostFromPortAndSocket($host));
+            $connectionParams['dbname'] = $name;
+        }
 
-		$connectionParams['tablePrefix'] = $this->config->getValue('dbtableprefix', self::DEFAULT_DBTABLEPREFIX);
-		$connectionParams['sqlite.journal_mode'] = $this->config->getValue('sqlite.journal_mode', 'WAL');
+        $connectionParams['tablePrefix'] = $this->config->getValue('dbtableprefix', self::DEFAULT_DBTABLEPREFIX);
+        $connectionParams['sqlite.journal_mode'] = $this->config->getValue('sqlite.journal_mode', 'WAL');
 
-		//additional driver options, eg. for mysql ssl
-		$driverOptions = $this->config->getValue('dbdriveroptions', null);
-		if ($driverOptions) {
-			$connectionParams['driverOptions'] = $driverOptions;
-		}
+        //additional driver options, eg. for mysql ssl
+        $driverOptions = $this->config->getValue('dbdriveroptions', null);
+        if ($driverOptions) {
+            $connectionParams['driverOptions'] = $driverOptions;
+        }
 
-		// set default table creation options
-		$connectionParams['defaultTableOptions'] = [
-			'collate' => 'utf8_bin',
-			'tablePrefix' => $connectionParams['tablePrefix']
-		];
+        // set default table creation options
+        $connectionParams['defaultTableOptions'] = [
+            'collate' => 'utf8_bin',
+            'tablePrefix' => $connectionParams['tablePrefix']
+        ];
 
-		if ($this->config->getValue('mysql.utf8mb4', false)) {
-			$connectionParams['defaultTableOptions'] = [
-				'collate' => 'utf8mb4_bin',
-				'charset' => 'utf8mb4',
-				'row_format' => 'compressed',
-				'tablePrefix' => $connectionParams['tablePrefix']
-			];
-		}
+        if ($this->config->getValue('mysql.utf8mb4', false)) {
+            $connectionParams['defaultTableOptions'] = [
+                'collate' => 'utf8mb4_bin',
+                'charset' => 'utf8mb4',
+                'row_format' => 'compressed',
+                'tablePrefix' => $connectionParams['tablePrefix']
+            ];
+        }
 
-		return $connectionParams;
-	}
+        return $connectionParams;
+    }
 
-	/**
-	 * @param string $host
-	 * @return array
-	 */
-	protected function splitHostFromPortAndSocket($host): array {
-		$params = [
-			'host' => $host,
-		];
+    /**
+     * @param string $host
+     * @return array
+     */
+    protected function splitHostFromPortAndSocket($host): array {
+        $params = [
+            'host' => $host,
+        ];
 
-		$matches = [];
-		if (preg_match('/^(.*):([^\]:]+)$/', $host, $matches)) {
-			// Host variable carries a port or socket.
-			$params['host'] = $matches[1];
-			if (is_numeric($matches[2])) {
-				$params['port'] = (int) $matches[2];
-			} else {
-				$params['unix_socket'] = $matches[2];
-			}
-		}
+        $matches = [];
+        if (preg_match('/^(.*):([^\]:]+)$/', $host, $matches)) {
+            // Host variable carries a port or socket.
+            $params['host'] = $matches[1];
+            if (is_numeric($matches[2])) {
+                $params['port'] = (int) $matches[2];
+            } else {
+                $params['unix_socket'] = $matches[2];
+            }
+        }
 
-		return $params;
-	}
+        return $params;
+    }
 }

lib/private/DB/Connection.php

Indentation +406 added lines, -406 removed lines

@@ -48,410 +48,410 @@
 use OCP\PreConditionNotMetException;
 
 class Connection extends ReconnectWrapper implements IDBConnection {
-	/**
-	 * @var string $tablePrefix
-	 */
-	protected $tablePrefix;
-
-	/**
-	 * @var \OC\DB\Adapter $adapter
-	 */
-	protected $adapter;
-
-	protected $lockedTable = null;
-
-	public function connect() {
-		try {
-			return parent::connect();
-		} catch (DBALException $e) {
-			// throw a new exception to prevent leaking info from the stacktrace
-			throw new DBALException('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
-		}
-	}
-
-	/**
-	 * Returns a QueryBuilder for the connection.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder
-	 */
-	public function getQueryBuilder() {
-		return new QueryBuilder(
-			$this,
-			\OC::$server->getSystemConfig(),
-			\OC::$server->getLogger()
-		);
-	}
-
-	/**
-	 * Gets the QueryBuilder for the connection.
-	 *
-	 * @return \Doctrine\DBAL\Query\QueryBuilder
-	 * @deprecated please use $this->getQueryBuilder() instead
-	 */
-	public function createQueryBuilder() {
-		$backtrace = $this->getCallerBacktrace();
-		\OC::$server->getLogger()->debug('Doctrine QueryBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
-		return parent::createQueryBuilder();
-	}
-
-	/**
-	 * Gets the ExpressionBuilder for the connection.
-	 *
-	 * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder
-	 * @deprecated please use $this->getQueryBuilder()->expr() instead
-	 */
-	public function getExpressionBuilder() {
-		$backtrace = $this->getCallerBacktrace();
-		\OC::$server->getLogger()->debug('Doctrine ExpressionBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
-		return parent::getExpressionBuilder();
-	}
-
-	/**
-	 * Get the file and line that called the method where `getCallerBacktrace()` was used
-	 *
-	 * @return string
-	 */
-	protected function getCallerBacktrace() {
-		$traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
-
-		// 0 is the method where we use `getCallerBacktrace`
-		// 1 is the target method which uses the method we want to log
-		if (isset($traces[1])) {
-			return $traces[1]['file'] . ':' . $traces[1]['line'];
-		}
-
-		return '';
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getPrefix() {
-		return $this->tablePrefix;
-	}
-
-	/**
-	 * Initializes a new instance of the Connection class.
-	 *
-	 * @param array $params  The connection parameters.
-	 * @param \Doctrine\DBAL\Driver $driver
-	 * @param \Doctrine\DBAL\Configuration $config
-	 * @param \Doctrine\Common\EventManager $eventManager
-	 * @throws \Exception
-	 */
-	public function __construct(array $params, Driver $driver, Configuration $config = null,
-		EventManager $eventManager = null)
-	{
-		if (!isset($params['adapter'])) {
-			throw new \Exception('adapter not set');
-		}
-		if (!isset($params['tablePrefix'])) {
-			throw new \Exception('tablePrefix not set');
-		}
-		parent::__construct($params, $driver, $config, $eventManager);
-		$this->adapter = new $params['adapter']($this);
-		$this->tablePrefix = $params['tablePrefix'];
-	}
-
-	/**
-	 * Prepares an SQL statement.
-	 *
-	 * @param string $statement The SQL statement to prepare.
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
-	 */
-	public function prepare( $statement, $limit=null, $offset=null ) {
-		if ($limit === -1) {
-			$limit = null;
-		}
-		if (!is_null($limit)) {
-			$platform = $this->getDatabasePlatform();
-			$statement = $platform->modifyLimitQuery($statement, $limit, $offset);
-		}
-		$statement = $this->replaceTablePrefix($statement);
-		$statement = $this->adapter->fixupStatement($statement);
-
-		return parent::prepare($statement);
-	}
-
-	/**
-	 * Executes an, optionally parametrized, SQL query.
-	 *
-	 * If the query is parametrized, a prepared statement is used.
-	 * If an SQLLogger is configured, the execution is logged.
-	 *
-	 * @param string                                      $query  The SQL query to execute.
-	 * @param array                                       $params The parameters to bind to the query, if any.
-	 * @param array                                       $types  The types the previous parameters are in.
-	 * @param \Doctrine\DBAL\Cache\QueryCacheProfile|null $qcp    The query cache profile, optional.
-	 *
-	 * @return \Doctrine\DBAL\Driver\Statement The executed statement.
-	 *
-	 * @throws \Doctrine\DBAL\DBALException
-	 */
-	public function executeQuery($query, array $params = [], $types = [], QueryCacheProfile $qcp = null)
-	{
-		$query = $this->replaceTablePrefix($query);
-		$query = $this->adapter->fixupStatement($query);
-		return parent::executeQuery($query, $params, $types, $qcp);
-	}
-
-	/**
-	 * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
-	 * and returns the number of affected rows.
-	 *
-	 * This method supports PDO binding types as well as DBAL mapping types.
-	 *
-	 * @param string $query  The SQL query.
-	 * @param array  $params The query parameters.
-	 * @param array  $types  The parameter types.
-	 *
-	 * @return integer The number of affected rows.
-	 *
-	 * @throws \Doctrine\DBAL\DBALException
-	 */
-	public function executeUpdate($query, array $params = [], array $types = [])
-	{
-		$query = $this->replaceTablePrefix($query);
-		$query = $this->adapter->fixupStatement($query);
-		return parent::executeUpdate($query, $params, $types);
-	}
-
-	/**
-	 * Returns the ID of the last inserted row, or the last value from a sequence object,
-	 * depending on the underlying driver.
-	 *
-	 * Note: This method may not return a meaningful or consistent result across different drivers,
-	 * because the underlying database may not even support the notion of AUTO_INCREMENT/IDENTITY
-	 * columns or sequences.
-	 *
-	 * @param string $seqName Name of the sequence object from which the ID should be returned.
-	 * @return string A string representation of the last inserted ID.
-	 */
-	public function lastInsertId($seqName = null) {
-		if ($seqName) {
-			$seqName = $this->replaceTablePrefix($seqName);
-		}
-		return $this->adapter->lastInsertId($seqName);
-	}
-
-	// internal use
-	public function realLastInsertId($seqName = null) {
-		return parent::lastInsertId($seqName);
-	}
-
-	/**
-	 * 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) {
-		return $this->adapter->insertIfNotExist($table, $input, $compare);
-	}
-
-	public function insertIgnoreConflict(string $table, array $values) : int {
-		return $this->adapter->insertIgnoreConflict($table, $values);
-	}
-
-	private function getType($value) {
-		if (is_bool($value)) {
-			return IQueryBuilder::PARAM_BOOL;
-		} else if (is_int($value)) {
-			return IQueryBuilder::PARAM_INT;
-		} else {
-			return IQueryBuilder::PARAM_STR;
-		}
-	}
-
-	/**
-	 * Insert or update a row value
-	 *
-	 * @param string $table
-	 * @param array $keys (column name => value)
-	 * @param array $values (column name => value)
-	 * @param array $updatePreconditionValues ensure values match preconditions (column name => value)
-	 * @return int number of new rows
-	 * @throws \Doctrine\DBAL\DBALException
-	 * @throws PreConditionNotMetException
-	 * @suppress SqlInjectionChecker
-	 */
-	public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []) {
-		try {
-			$insertQb = $this->getQueryBuilder();
-			$insertQb->insert($table)
-				->values(
-					array_map(function($value) use ($insertQb) {
-						return $insertQb->createNamedParameter($value, $this->getType($value));
-					}, array_merge($keys, $values))
-				);
-			return $insertQb->execute();
-		} catch (ConstraintViolationException $e) {
-			// value already exists, try update
-			$updateQb = $this->getQueryBuilder();
-			$updateQb->update($table);
-			foreach ($values as $name => $value) {
-				$updateQb->set($name, $updateQb->createNamedParameter($value, $this->getType($value)));
-			}
-			$where = $updateQb->expr()->andX();
-			$whereValues = array_merge($keys, $updatePreconditionValues);
-			foreach ($whereValues as $name => $value) {
-				$where->add($updateQb->expr()->eq(
-					$name,
-					$updateQb->createNamedParameter($value, $this->getType($value)),
-					$this->getType($value)
-				));
-			}
-			$updateQb->where($where);
-			$affected = $updateQb->execute();
-
-			if ($affected === 0 && !empty($updatePreconditionValues)) {
-				throw new PreConditionNotMetException();
-			}
-
-			return 0;
-		}
-	}
-
-	/**
-	 * Create an exclusive read+write lock on a table
-	 *
-	 * @param string $tableName
-	 * @throws \BadMethodCallException When trying to acquire a second lock
-	 * @since 9.1.0
-	 */
-	public function lockTable($tableName) {
-		if ($this->lockedTable !== null) {
-			throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
-		}
-
-		$tableName = $this->tablePrefix . $tableName;
-		$this->lockedTable = $tableName;
-		$this->adapter->lockTable($tableName);
-	}
-
-	/**
-	 * Release a previous acquired lock again
-	 *
-	 * @since 9.1.0
-	 */
-	public function unlockTable() {
-		$this->adapter->unlockTable();
-		$this->lockedTable = null;
-	}
-
-	/**
-	 * returns the error code and message as a string for logging
-	 * works with DoctrineException
-	 * @return string
-	 */
-	public function getError() {
-		$msg = $this->errorCode() . ': ';
-		$errorInfo = $this->errorInfo();
-		if (is_array($errorInfo)) {
-			$msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
-			$msg .= 'Driver Code = '.$errorInfo[1] . ', ';
-			$msg .= 'Driver Message = '.$errorInfo[2];
-		}
-		return $msg;
-	}
-
-	/**
-	 * Drop a table from the database if it exists
-	 *
-	 * @param string $table table name without the prefix
-	 */
-	public function dropTable($table) {
-		$table = $this->tablePrefix . trim($table);
-		$schema = $this->getSchemaManager();
-		if($schema->tablesExist([$table])) {
-			$schema->dropTable($table);
-		}
-	}
-
-	/**
-	 * Check if a table exists
-	 *
-	 * @param string $table table name without the prefix
-	 * @return bool
-	 */
-	public function tableExists($table){
-		$table = $this->tablePrefix . trim($table);
-		$schema = $this->getSchemaManager();
-		return $schema->tablesExist([$table]);
-	}
-
-	// internal use
-	/**
-	 * @param string $statement
-	 * @return string
-	 */
-	protected function replaceTablePrefix($statement) {
-		return str_replace( '*PREFIX*', $this->tablePrefix, $statement );
-	}
-
-	/**
-	 * Check if a transaction is active
-	 *
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function inTransaction() {
-		return $this->getTransactionNestingLevel() > 0;
-	}
-
-	/**
-	 * Escape a parameter to be used in a LIKE query
-	 *
-	 * @param string $param
-	 * @return string
-	 */
-	public function escapeLikeParameter($param) {
-		return addcslashes($param, '\\_%');
-	}
-
-	/**
-	 * Check whether or not the current database support 4byte wide unicode
-	 *
-	 * @return bool
-	 * @since 11.0.0
-	 */
-	public function supports4ByteText() {
-		if (!$this->getDatabasePlatform() instanceof MySqlPlatform) {
-			return true;
-		}
-		return $this->getParams()['charset'] === 'utf8mb4';
-	}
-
-
-	/**
-	 * Create the schema of the connected database
-	 *
-	 * @return Schema
-	 */
-	public function createSchema() {
-		$schemaManager = new MDB2SchemaManager($this);
-		$migrator = $schemaManager->getMigrator();
-		return $migrator->createSchema();
-	}
-
-	/**
-	 * Migrate the database to the given schema
-	 *
-	 * @param Schema $toSchema
-	 */
-	public function migrateToSchema(Schema $toSchema) {
-		$schemaManager = new MDB2SchemaManager($this);
-		$migrator = $schemaManager->getMigrator();
-		$migrator->migrate($toSchema);
-	}
+    /**
+     * @var string $tablePrefix
+     */
+    protected $tablePrefix;
+
+    /**
+     * @var \OC\DB\Adapter $adapter
+     */
+    protected $adapter;
+
+    protected $lockedTable = null;
+
+    public function connect() {
+        try {
+            return parent::connect();
+        } catch (DBALException $e) {
+            // throw a new exception to prevent leaking info from the stacktrace
+            throw new DBALException('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
+        }
+    }
+
+    /**
+     * Returns a QueryBuilder for the connection.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder
+     */
+    public function getQueryBuilder() {
+        return new QueryBuilder(
+            $this,
+            \OC::$server->getSystemConfig(),
+            \OC::$server->getLogger()
+        );
+    }
+
+    /**
+     * Gets the QueryBuilder for the connection.
+     *
+     * @return \Doctrine\DBAL\Query\QueryBuilder
+     * @deprecated please use $this->getQueryBuilder() instead
+     */
+    public function createQueryBuilder() {
+        $backtrace = $this->getCallerBacktrace();
+        \OC::$server->getLogger()->debug('Doctrine QueryBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
+        return parent::createQueryBuilder();
+    }
+
+    /**
+     * Gets the ExpressionBuilder for the connection.
+     *
+     * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder
+     * @deprecated please use $this->getQueryBuilder()->expr() instead
+     */
+    public function getExpressionBuilder() {
+        $backtrace = $this->getCallerBacktrace();
+        \OC::$server->getLogger()->debug('Doctrine ExpressionBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
+        return parent::getExpressionBuilder();
+    }
+
+    /**
+     * Get the file and line that called the method where `getCallerBacktrace()` was used
+     *
+     * @return string
+     */
+    protected function getCallerBacktrace() {
+        $traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
+
+        // 0 is the method where we use `getCallerBacktrace`
+        // 1 is the target method which uses the method we want to log
+        if (isset($traces[1])) {
+            return $traces[1]['file'] . ':' . $traces[1]['line'];
+        }
+
+        return '';
+    }
+
+    /**
+     * @return string
+     */
+    public function getPrefix() {
+        return $this->tablePrefix;
+    }
+
+    /**
+     * Initializes a new instance of the Connection class.
+     *
+     * @param array $params  The connection parameters.
+     * @param \Doctrine\DBAL\Driver $driver
+     * @param \Doctrine\DBAL\Configuration $config
+     * @param \Doctrine\Common\EventManager $eventManager
+     * @throws \Exception
+     */
+    public function __construct(array $params, Driver $driver, Configuration $config = null,
+        EventManager $eventManager = null)
+    {
+        if (!isset($params['adapter'])) {
+            throw new \Exception('adapter not set');
+        }
+        if (!isset($params['tablePrefix'])) {
+            throw new \Exception('tablePrefix not set');
+        }
+        parent::__construct($params, $driver, $config, $eventManager);
+        $this->adapter = new $params['adapter']($this);
+        $this->tablePrefix = $params['tablePrefix'];
+    }
+
+    /**
+     * Prepares an SQL statement.
+     *
+     * @param string $statement The SQL statement to prepare.
+     * @param int $limit
+     * @param int $offset
+     * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
+     */
+    public function prepare( $statement, $limit=null, $offset=null ) {
+        if ($limit === -1) {
+            $limit = null;
+        }
+        if (!is_null($limit)) {
+            $platform = $this->getDatabasePlatform();
+            $statement = $platform->modifyLimitQuery($statement, $limit, $offset);
+        }
+        $statement = $this->replaceTablePrefix($statement);
+        $statement = $this->adapter->fixupStatement($statement);
+
+        return parent::prepare($statement);
+    }
+
+    /**
+     * Executes an, optionally parametrized, SQL query.
+     *
+     * If the query is parametrized, a prepared statement is used.
+     * If an SQLLogger is configured, the execution is logged.
+     *
+     * @param string                                      $query  The SQL query to execute.
+     * @param array                                       $params The parameters to bind to the query, if any.
+     * @param array                                       $types  The types the previous parameters are in.
+     * @param \Doctrine\DBAL\Cache\QueryCacheProfile|null $qcp    The query cache profile, optional.
+     *
+     * @return \Doctrine\DBAL\Driver\Statement The executed statement.
+     *
+     * @throws \Doctrine\DBAL\DBALException
+     */
+    public function executeQuery($query, array $params = [], $types = [], QueryCacheProfile $qcp = null)
+    {
+        $query = $this->replaceTablePrefix($query);
+        $query = $this->adapter->fixupStatement($query);
+        return parent::executeQuery($query, $params, $types, $qcp);
+    }
+
+    /**
+     * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
+     * and returns the number of affected rows.
+     *
+     * This method supports PDO binding types as well as DBAL mapping types.
+     *
+     * @param string $query  The SQL query.
+     * @param array  $params The query parameters.
+     * @param array  $types  The parameter types.
+     *
+     * @return integer The number of affected rows.
+     *
+     * @throws \Doctrine\DBAL\DBALException
+     */
+    public function executeUpdate($query, array $params = [], array $types = [])
+    {
+        $query = $this->replaceTablePrefix($query);
+        $query = $this->adapter->fixupStatement($query);
+        return parent::executeUpdate($query, $params, $types);
+    }
+
+    /**
+     * Returns the ID of the last inserted row, or the last value from a sequence object,
+     * depending on the underlying driver.
+     *
+     * Note: This method may not return a meaningful or consistent result across different drivers,
+     * because the underlying database may not even support the notion of AUTO_INCREMENT/IDENTITY
+     * columns or sequences.
+     *
+     * @param string $seqName Name of the sequence object from which the ID should be returned.
+     * @return string A string representation of the last inserted ID.
+     */
+    public function lastInsertId($seqName = null) {
+        if ($seqName) {
+            $seqName = $this->replaceTablePrefix($seqName);
+        }
+        return $this->adapter->lastInsertId($seqName);
+    }
+
+    // internal use
+    public function realLastInsertId($seqName = null) {
+        return parent::lastInsertId($seqName);
+    }
+
+    /**
+     * 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) {
+        return $this->adapter->insertIfNotExist($table, $input, $compare);
+    }
+
+    public function insertIgnoreConflict(string $table, array $values) : int {
+        return $this->adapter->insertIgnoreConflict($table, $values);
+    }
+
+    private function getType($value) {
+        if (is_bool($value)) {
+            return IQueryBuilder::PARAM_BOOL;
+        } else if (is_int($value)) {
+            return IQueryBuilder::PARAM_INT;
+        } else {
+            return IQueryBuilder::PARAM_STR;
+        }
+    }
+
+    /**
+     * Insert or update a row value
+     *
+     * @param string $table
+     * @param array $keys (column name => value)
+     * @param array $values (column name => value)
+     * @param array $updatePreconditionValues ensure values match preconditions (column name => value)
+     * @return int number of new rows
+     * @throws \Doctrine\DBAL\DBALException
+     * @throws PreConditionNotMetException
+     * @suppress SqlInjectionChecker
+     */
+    public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []) {
+        try {
+            $insertQb = $this->getQueryBuilder();
+            $insertQb->insert($table)
+                ->values(
+                    array_map(function($value) use ($insertQb) {
+                        return $insertQb->createNamedParameter($value, $this->getType($value));
+                    }, array_merge($keys, $values))
+                );
+            return $insertQb->execute();
+        } catch (ConstraintViolationException $e) {
+            // value already exists, try update
+            $updateQb = $this->getQueryBuilder();
+            $updateQb->update($table);
+            foreach ($values as $name => $value) {
+                $updateQb->set($name, $updateQb->createNamedParameter($value, $this->getType($value)));
+            }
+            $where = $updateQb->expr()->andX();
+            $whereValues = array_merge($keys, $updatePreconditionValues);
+            foreach ($whereValues as $name => $value) {
+                $where->add($updateQb->expr()->eq(
+                    $name,
+                    $updateQb->createNamedParameter($value, $this->getType($value)),
+                    $this->getType($value)
+                ));
+            }
+            $updateQb->where($where);
+            $affected = $updateQb->execute();
+
+            if ($affected === 0 && !empty($updatePreconditionValues)) {
+                throw new PreConditionNotMetException();
+            }
+
+            return 0;
+        }
+    }
+
+    /**
+     * Create an exclusive read+write lock on a table
+     *
+     * @param string $tableName
+     * @throws \BadMethodCallException When trying to acquire a second lock
+     * @since 9.1.0
+     */
+    public function lockTable($tableName) {
+        if ($this->lockedTable !== null) {
+            throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
+        }
+
+        $tableName = $this->tablePrefix . $tableName;
+        $this->lockedTable = $tableName;
+        $this->adapter->lockTable($tableName);
+    }
+
+    /**
+     * Release a previous acquired lock again
+     *
+     * @since 9.1.0
+     */
+    public function unlockTable() {
+        $this->adapter->unlockTable();
+        $this->lockedTable = null;
+    }
+
+    /**
+     * returns the error code and message as a string for logging
+     * works with DoctrineException
+     * @return string
+     */
+    public function getError() {
+        $msg = $this->errorCode() . ': ';
+        $errorInfo = $this->errorInfo();
+        if (is_array($errorInfo)) {
+            $msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
+            $msg .= 'Driver Code = '.$errorInfo[1] . ', ';
+            $msg .= 'Driver Message = '.$errorInfo[2];
+        }
+        return $msg;
+    }
+
+    /**
+     * Drop a table from the database if it exists
+     *
+     * @param string $table table name without the prefix
+     */
+    public function dropTable($table) {
+        $table = $this->tablePrefix . trim($table);
+        $schema = $this->getSchemaManager();
+        if($schema->tablesExist([$table])) {
+            $schema->dropTable($table);
+        }
+    }
+
+    /**
+     * Check if a table exists
+     *
+     * @param string $table table name without the prefix
+     * @return bool
+     */
+    public function tableExists($table){
+        $table = $this->tablePrefix . trim($table);
+        $schema = $this->getSchemaManager();
+        return $schema->tablesExist([$table]);
+    }
+
+    // internal use
+    /**
+     * @param string $statement
+     * @return string
+     */
+    protected function replaceTablePrefix($statement) {
+        return str_replace( '*PREFIX*', $this->tablePrefix, $statement );
+    }
+
+    /**
+     * Check if a transaction is active
+     *
+     * @return bool
+     * @since 8.2.0
+     */
+    public function inTransaction() {
+        return $this->getTransactionNestingLevel() > 0;
+    }
+
+    /**
+     * Escape a parameter to be used in a LIKE query
+     *
+     * @param string $param
+     * @return string
+     */
+    public function escapeLikeParameter($param) {
+        return addcslashes($param, '\\_%');
+    }
+
+    /**
+     * Check whether or not the current database support 4byte wide unicode
+     *
+     * @return bool
+     * @since 11.0.0
+     */
+    public function supports4ByteText() {
+        if (!$this->getDatabasePlatform() instanceof MySqlPlatform) {
+            return true;
+        }
+        return $this->getParams()['charset'] === 'utf8mb4';
+    }
+
+
+    /**
+     * Create the schema of the connected database
+     *
+     * @return Schema
+     */
+    public function createSchema() {
+        $schemaManager = new MDB2SchemaManager($this);
+        $migrator = $schemaManager->getMigrator();
+        return $migrator->createSchema();
+    }
+
+    /**
+     * Migrate the database to the given schema
+     *
+     * @param Schema $toSchema
+     */
+    public function migrateToSchema(Schema $toSchema) {
+        $schemaManager = new MDB2SchemaManager($this);
+        $migrator = $schemaManager->getMigrator();
+        $migrator->migrate($toSchema);
+    }
 }

lib/private/DB/OracleConnection.php

Indentation +71 added lines, -71 removed lines

@@ -27,80 +27,80 @@
 namespace OC\DB;
 
 class OracleConnection extends Connection {
-	/**
-	 * Quote the keys of the array
-	 */
-	private function quoteKeys(array $data) {
-		$return = [];
-		$c = $this->getDatabasePlatform()->getIdentifierQuoteCharacter();
-		foreach($data as $key => $value) {
-			if ($key[0] !== $c) {
-				$return[$this->quoteIdentifier($key)] = $value;
-			} else {
-				$return[$key] = $value;
-			}
-		}
-		return $return;
-	}
+    /**
+     * Quote the keys of the array
+     */
+    private function quoteKeys(array $data) {
+        $return = [];
+        $c = $this->getDatabasePlatform()->getIdentifierQuoteCharacter();
+        foreach($data as $key => $value) {
+            if ($key[0] !== $c) {
+                $return[$this->quoteIdentifier($key)] = $value;
+            } else {
+                $return[$key] = $value;
+            }
+        }
+        return $return;
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function insert($tableName, array $data, array $types = []) {
-		if ($tableName[0] !== $this->getDatabasePlatform()->getIdentifierQuoteCharacter()) {
-			$tableName = $this->quoteIdentifier($tableName);
-		}
-		$data = $this->quoteKeys($data);
-		return parent::insert($tableName, $data, $types);
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function insert($tableName, array $data, array $types = []) {
+        if ($tableName[0] !== $this->getDatabasePlatform()->getIdentifierQuoteCharacter()) {
+            $tableName = $this->quoteIdentifier($tableName);
+        }
+        $data = $this->quoteKeys($data);
+        return parent::insert($tableName, $data, $types);
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function update($tableName, array $data, array $identifier, array $types = []) {
-		if ($tableName[0] !== $this->getDatabasePlatform()->getIdentifierQuoteCharacter()) {
-			$tableName = $this->quoteIdentifier($tableName);
-		}
-		$data = $this->quoteKeys($data);
-		$identifier = $this->quoteKeys($identifier);
-		return parent::update($tableName, $data, $identifier, $types);
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function update($tableName, array $data, array $identifier, array $types = []) {
+        if ($tableName[0] !== $this->getDatabasePlatform()->getIdentifierQuoteCharacter()) {
+            $tableName = $this->quoteIdentifier($tableName);
+        }
+        $data = $this->quoteKeys($data);
+        $identifier = $this->quoteKeys($identifier);
+        return parent::update($tableName, $data, $identifier, $types);
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function delete($tableExpression, array $identifier, array $types = []) {
-		if ($tableExpression[0] !== $this->getDatabasePlatform()->getIdentifierQuoteCharacter()) {
-			$tableExpression = $this->quoteIdentifier($tableExpression);
-		}
-		$identifier = $this->quoteKeys($identifier);
-		return parent::delete($tableExpression, $identifier);
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function delete($tableExpression, array $identifier, array $types = []) {
+        if ($tableExpression[0] !== $this->getDatabasePlatform()->getIdentifierQuoteCharacter()) {
+            $tableExpression = $this->quoteIdentifier($tableExpression);
+        }
+        $identifier = $this->quoteKeys($identifier);
+        return parent::delete($tableExpression, $identifier);
+    }
 
-	/**
-	 * Drop a table from the database if it exists
-	 *
-	 * @param string $table table name without the prefix
-	 */
-	public function dropTable($table) {
-		$table = $this->tablePrefix . trim($table);
-		$table = $this->quoteIdentifier($table);
-		$schema = $this->getSchemaManager();
-		if($schema->tablesExist([$table])) {
-			$schema->dropTable($table);
-		}
-	}
+    /**
+     * Drop a table from the database if it exists
+     *
+     * @param string $table table name without the prefix
+     */
+    public function dropTable($table) {
+        $table = $this->tablePrefix . trim($table);
+        $table = $this->quoteIdentifier($table);
+        $schema = $this->getSchemaManager();
+        if($schema->tablesExist([$table])) {
+            $schema->dropTable($table);
+        }
+    }
 
-	/**
-	 * Check if a table exists
-	 *
-	 * @param string $table table name without the prefix
-	 * @return bool
-	 */
-	public function tableExists($table){
-		$table = $this->tablePrefix . trim($table);
-		$table = $this->quoteIdentifier($table);
-		$schema = $this->getSchemaManager();
-		return $schema->tablesExist([$table]);
-	}
+    /**
+     * Check if a table exists
+     *
+     * @param string $table table name without the prefix
+     * @return bool
+     */
+    public function tableExists($table){
+        $table = $this->tablePrefix . trim($table);
+        $table = $this->quoteIdentifier($table);
+        $schema = $this->getSchemaManager();
+        return $schema->tablesExist([$table]);
+    }
 }