nextcloud / server

lib/private/legacy/template/functions.php

Doc Comments +2 added lines, -1 removed lines

@@ -183,7 +183,7 @@ 
  * make preview_icon available as a simple function
  * Returns the path to the preview of the image.
  * @param string $path path of file
- * @return link to the preview
+ * @return string to the preview
  */
 function preview_icon( $path ) {
 	return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]);
@@ -191,6 +191,7 @@ 
 
 /**
  * @param string $path
+ * @param string $token
  */
 function publicPreview_icon ( $path, $token ) {
 	return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]);

Indentation +81 added lines, -81 removed lines

@@ -34,7 +34,7 @@ 
  * @param string $string the string which will be escaped and printed
  */
 function p($string) {
-	print(\OCP\Util::sanitizeHTML($string));
+    print(\OCP\Util::sanitizeHTML($string));
 }
 
 /**
@@ -43,7 +43,7 @@ 
  * @param string|array $string the string which will be printed as it is
  */
 function print_unescaped($string) {
-	print($string);
+    print($string);
 }
 
 /**
@@ -53,13 +53,13 @@ 
  * if an array is given it will add all scripts
  */
 function script($app, $file = null) {
-	if(is_array($file)) {
-		foreach($file as $f) {
-			OC_Util::addScript($app, $f);
-		}
-	} else {
-		OC_Util::addScript($app, $file);
-	}
+    if(is_array($file)) {
+        foreach($file as $f) {
+            OC_Util::addScript($app, $f);
+        }
+    } else {
+        OC_Util::addScript($app, $file);
+    }
 }
 
 /**
@@ -69,13 +69,13 @@ 
  * if an array is given it will add all scripts
  */
 function vendor_script($app, $file = null) {
-	if(is_array($file)) {
-		foreach($file as $f) {
-			OC_Util::addVendorScript($app, $f);
-		}
-	} else {
-		OC_Util::addVendorScript($app, $file);
-	}
+    if(is_array($file)) {
+        foreach($file as $f) {
+            OC_Util::addVendorScript($app, $f);
+        }
+    } else {
+        OC_Util::addVendorScript($app, $file);
+    }
 }
 
 /**
@@ -85,13 +85,13 @@ 
  * if an array is given it will add all styles
  */
 function style($app, $file = null) {
-	if(is_array($file)) {
-		foreach($file as $f) {
-			OC_Util::addStyle($app, $f);
-		}
-	} else {
-		OC_Util::addStyle($app, $file);
-	}
+    if(is_array($file)) {
+        foreach($file as $f) {
+            OC_Util::addStyle($app, $f);
+        }
+    } else {
+        OC_Util::addStyle($app, $file);
+    }
 }
 
 /**
@@ -101,13 +101,13 @@ 
  * if an array is given it will add all styles
  */
 function vendor_style($app, $file = null) {
-	if(is_array($file)) {
-		foreach($file as $f) {
-			OC_Util::addVendorStyle($app, $f);
-		}
-	} else {
-		OC_Util::addVendorStyle($app, $file);
-	}
+    if(is_array($file)) {
+        foreach($file as $f) {
+            OC_Util::addVendorStyle($app, $f);
+        }
+    } else {
+        OC_Util::addVendorStyle($app, $file);
+    }
 }
 
 /**
@@ -116,7 +116,7 @@ 
  * if an array is given it will add all styles
  */
 function translation($app) {
-	OC_Util::addTranslations($app);
+    OC_Util::addTranslations($app);
 }
 
 /**
@@ -126,15 +126,15 @@ 
  * if an array is given it will add all components
  */
 function component($app, $file) {
-	if(is_array($file)) {
-		foreach($file as $f) {
-			$url = link_to($app, 'component/' . $f . '.html');
-			OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url));
-		}
-	} else {
-		$url = link_to($app, 'component/' . $file . '.html');
-		OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url));
-	}
+    if(is_array($file)) {
+        foreach($file as $f) {
+            $url = link_to($app, 'component/' . $f . '.html');
+            OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url));
+        }
+    } else {
+        $url = link_to($app, 'component/' . $file . '.html');
+        OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url));
+    }
 }
 
 /**
@@ -147,7 +147,7 @@ 
  * For further information have a look at \OCP\IURLGenerator::linkTo
  */
 function link_to( $app, $file, $args = array() ) {
-	return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
+    return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
 }
 
 /**
@@ -155,7 +155,7 @@ 
  * @return string url to the online documentation
  */
 function link_to_docs($key) {
-	return \OC::$server->getURLGenerator()->linkToDocs($key);
+    return \OC::$server->getURLGenerator()->linkToDocs($key);
 }
 
 /**
@@ -167,7 +167,7 @@ 
  * For further information have a look at \OCP\IURLGenerator::imagePath
  */
 function image_path( $app, $image ) {
-	return \OC::$server->getURLGenerator()->imagePath( $app, $image );
+    return \OC::$server->getURLGenerator()->imagePath( $app, $image );
 }
 
 /**
@@ -176,7 +176,7 @@ 
  * @return string link to the image
  */
 function mimetype_icon( $mimetype ) {
-	return \OC::$server->getMimeTypeDetector()->mimeTypeIcon( $mimetype );
+    return \OC::$server->getMimeTypeDetector()->mimeTypeIcon( $mimetype );
 }
 
 /**
@@ -186,14 +186,14 @@ 
  * @return link to the preview
  */
 function preview_icon( $path ) {
-	return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]);
+    return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]);
 }
 
 /**
  * @param string $path
  */
 function publicPreview_icon ( $path, $token ) {
-	return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]);
+    return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]);
 }
 
 /**
@@ -204,7 +204,7 @@ 
  * For further information have a look at OC_Helper::humanFileSize
  */
 function human_file_size( $bytes ) {
-	return OC_Helper::humanFileSize( $bytes );
+    return OC_Helper::humanFileSize( $bytes );
 }
 
 /**
@@ -213,9 +213,9 @@ 
  * @return $timestamp without time value
  */
 function strip_time($timestamp){
-	$date = new \DateTime("@{$timestamp}");
-	$date->setTime(0, 0, 0);
-	return intval($date->format('U'));
+    $date = new \DateTime("@{$timestamp}");
+    $date->setTime(0, 0, 0);
+    return intval($date->format('U'));
 }
 
 /**
@@ -227,39 +227,39 @@ 
  * @return string timestamp
  */
 function relative_modified_date($timestamp, $fromTime = null, $dateOnly = false) {
-	/** @var \OC\DateTimeFormatter $formatter */
-	$formatter = \OC::$server->query('DateTimeFormatter');
+    /** @var \OC\DateTimeFormatter $formatter */
+    $formatter = \OC::$server->query('DateTimeFormatter');
 
-	if ($dateOnly){
-		return $formatter->formatDateSpan($timestamp, $fromTime);
-	}
-	return $formatter->formatTimeSpan($timestamp, $fromTime);
+    if ($dateOnly){
+        return $formatter->formatDateSpan($timestamp, $fromTime);
+    }
+    return $formatter->formatTimeSpan($timestamp, $fromTime);
 }
 
 function html_select_options($options, $selected, $params=array()) {
-	if (!is_array($selected)) {
-		$selected=array($selected);
-	}
-	if (isset($params['combine']) && $params['combine']) {
-		$options = array_combine($options, $options);
-	}
-	$value_name = $label_name = false;
-	if (isset($params['value'])) {
-		$value_name = $params['value'];
-	}
-	if (isset($params['label'])) {
-		$label_name = $params['label'];
-	}
-	$html = '';
-	foreach($options as $value => $label) {
-		if ($value_name && is_array($label)) {
-			$value = $label[$value_name];
-		}
-		if ($label_name && is_array($label)) {
-			$label = $label[$label_name];
-		}
-		$select = in_array($value, $selected) ? ' selected="selected"' : '';
-		$html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n";
-	}
-	return $html;
+    if (!is_array($selected)) {
+        $selected=array($selected);
+    }
+    if (isset($params['combine']) && $params['combine']) {
+        $options = array_combine($options, $options);
+    }
+    $value_name = $label_name = false;
+    if (isset($params['value'])) {
+        $value_name = $params['value'];
+    }
+    if (isset($params['label'])) {
+        $label_name = $params['label'];
+    }
+    $html = '';
+    foreach($options as $value => $label) {
+        if ($value_name && is_array($label)) {
+            $value = $label[$value_name];
+        }
+        if ($label_name && is_array($label)) {
+            $label = $label[$label_name];
+        }
+        $select = in_array($value, $selected) ? ' selected="selected"' : '';
+        $html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n";
+    }
+    return $html;
 }

Spacing +27 added lines, -27 removed lines

@@ -53,8 +53,8 @@ 
  * if an array is given it will add all scripts
  */
 function script($app, $file = null) {
-	if(is_array($file)) {
-		foreach($file as $f) {
+	if (is_array($file)) {
+		foreach ($file as $f) {
 			OC_Util::addScript($app, $f);
 		}
 	} else {
@@ -69,8 +69,8 @@ 
  * if an array is given it will add all scripts
  */
 function vendor_script($app, $file = null) {
-	if(is_array($file)) {
-		foreach($file as $f) {
+	if (is_array($file)) {
+		foreach ($file as $f) {
 			OC_Util::addVendorScript($app, $f);
 		}
 	} else {
@@ -85,8 +85,8 @@ 
  * if an array is given it will add all styles
  */
 function style($app, $file = null) {
-	if(is_array($file)) {
-		foreach($file as $f) {
+	if (is_array($file)) {
+		foreach ($file as $f) {
 			OC_Util::addStyle($app, $f);
 		}
 	} else {
@@ -101,8 +101,8 @@ 
  * if an array is given it will add all styles
  */
 function vendor_style($app, $file = null) {
-	if(is_array($file)) {
-		foreach($file as $f) {
+	if (is_array($file)) {
+		foreach ($file as $f) {
 			OC_Util::addVendorStyle($app, $f);
 		}
 	} else {
@@ -126,13 +126,13 @@ 
  * if an array is given it will add all components
  */
 function component($app, $file) {
-	if(is_array($file)) {
-		foreach($file as $f) {
-			$url = link_to($app, 'component/' . $f . '.html');
+	if (is_array($file)) {
+		foreach ($file as $f) {
+			$url = link_to($app, 'component/'.$f.'.html');
 			OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url));
 		}
 	} else {
-		$url = link_to($app, 'component/' . $file . '.html');
+		$url = link_to($app, 'component/'.$file.'.html');
 		OC_Util::addHeader('link', array('rel' => 'import', 'href' => $url));
 	}
 }
@@ -146,7 +146,7 @@ 
  *
  * For further information have a look at \OCP\IURLGenerator::linkTo
  */
-function link_to( $app, $file, $args = array() ) {
+function link_to($app, $file, $args = array()) {
 	return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
 }
 
@@ -166,8 +166,8 @@ 
  *
  * For further information have a look at \OCP\IURLGenerator::imagePath
  */
-function image_path( $app, $image ) {
-	return \OC::$server->getURLGenerator()->imagePath( $app, $image );
+function image_path($app, $image) {
+	return \OC::$server->getURLGenerator()->imagePath($app, $image);
 }
 
 /**
@@ -175,8 +175,8 @@ 
  * @param string $mimetype mimetype
  * @return string link to the image
  */
-function mimetype_icon( $mimetype ) {
-	return \OC::$server->getMimeTypeDetector()->mimeTypeIcon( $mimetype );
+function mimetype_icon($mimetype) {
+	return \OC::$server->getMimeTypeDetector()->mimeTypeIcon($mimetype);
 }
 
 /**
@@ -185,14 +185,14 @@ 
  * @param string $path path of file
  * @return link to the preview
  */
-function preview_icon( $path ) {
+function preview_icon($path) {
 	return \OC::$server->getURLGenerator()->linkToRoute('core.Preview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path]);
 }
 
 /**
  * @param string $path
  */
-function publicPreview_icon ( $path, $token ) {
+function publicPreview_icon($path, $token) {
 	return \OC::$server->getURLGenerator()->linkToRoute('files_sharing.PublicPreview.getPreview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]);
 }
 
@@ -203,8 +203,8 @@ 
  *
  * For further information have a look at OC_Helper::humanFileSize
  */
-function human_file_size( $bytes ) {
-	return OC_Helper::humanFileSize( $bytes );
+function human_file_size($bytes) {
+	return OC_Helper::humanFileSize($bytes);
 }
 
 /**
@@ -212,7 +212,7 @@ 
  * @param int $timestamp UNIX timestamp to strip
  * @return $timestamp without time value
  */
-function strip_time($timestamp){
+function strip_time($timestamp) {
 	$date = new \DateTime("@{$timestamp}");
 	$date->setTime(0, 0, 0);
 	return intval($date->format('U'));
@@ -230,15 +230,15 @@ 
 	/** @var \OC\DateTimeFormatter $formatter */
 	$formatter = \OC::$server->query('DateTimeFormatter');
 
-	if ($dateOnly){
+	if ($dateOnly) {
 		return $formatter->formatDateSpan($timestamp, $fromTime);
 	}
 	return $formatter->formatTimeSpan($timestamp, $fromTime);
 }
 
-function html_select_options($options, $selected, $params=array()) {
+function html_select_options($options, $selected, $params = array()) {
 	if (!is_array($selected)) {
-		$selected=array($selected);
+		$selected = array($selected);
 	}
 	if (isset($params['combine']) && $params['combine']) {
 		$options = array_combine($options, $options);
@@ -251,7 +251,7 @@ 
 		$label_name = $params['label'];
 	}
 	$html = '';
-	foreach($options as $value => $label) {
+	foreach ($options as $value => $label) {
 		if ($value_name && is_array($label)) {
 			$value = $label[$value_name];
 		}
@@ -259,7 +259,7 @@ 
 			$label = $label[$label_name];
 		}
 		$select = in_array($value, $selected) ? ' selected="selected"' : '';
-		$html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n";
+		$html .= '<option value="'.\OCP\Util::sanitizeHTML($value).'"'.$select.'>'.\OCP\Util::sanitizeHTML($label).'</option>'."\n";
 	}
 	return $html;
 }

lib/private/Memcache/APCu.php

Doc Comments +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
 	 * Set a value in the cache if it's not already stored
 	 *
 	 * @param string $key
-	 * @param mixed $value
+	 * @param integer $value
 	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
 	 * @return bool
 	 */

Indentation +125 added lines, -125 removed lines

@@ -30,140 +30,140 @@
 use OCP\IMemcache;
 
 class APCu extends Cache implements IMemcache {
-	use CASTrait {
-		cas as casEmulated;
-	}
+    use CASTrait {
+        cas as casEmulated;
+    }
 
-	use CADTrait;
+    use CADTrait;
 
-	public function get($key) {
-		$result = apcu_fetch($this->getPrefix() . $key, $success);
-		if (!$success) {
-			return null;
-		}
-		return $result;
-	}
+    public function get($key) {
+        $result = apcu_fetch($this->getPrefix() . $key, $success);
+        if (!$success) {
+            return null;
+        }
+        return $result;
+    }
 
-	public function set($key, $value, $ttl = 0) {
-		return apcu_store($this->getPrefix() . $key, $value, $ttl);
-	}
+    public function set($key, $value, $ttl = 0) {
+        return apcu_store($this->getPrefix() . $key, $value, $ttl);
+    }
 
-	public function hasKey($key) {
-		return apcu_exists($this->getPrefix() . $key);
-	}
+    public function hasKey($key) {
+        return apcu_exists($this->getPrefix() . $key);
+    }
 
-	public function remove($key) {
-		return apcu_delete($this->getPrefix() . $key);
-	}
+    public function remove($key) {
+        return apcu_delete($this->getPrefix() . $key);
+    }
 
-	public function clear($prefix = '') {
-		$ns = $this->getPrefix() . $prefix;
-		$ns = preg_quote($ns, '/');
-		if(class_exists('\APCIterator')) {
-			$iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
-		} else {
-			$iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
-		}
-		return apcu_delete($iter);
-	}
+    public function clear($prefix = '') {
+        $ns = $this->getPrefix() . $prefix;
+        $ns = preg_quote($ns, '/');
+        if(class_exists('\APCIterator')) {
+            $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
+        } else {
+            $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
+        }
+        return apcu_delete($iter);
+    }
 
-	/**
-	 * Set a value in the cache if it's not already stored
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
-	 * @return bool
-	 */
-	public function add($key, $value, $ttl = 0) {
-		return apcu_add($this->getPrefix() . $key, $value, $ttl);
-	}
+    /**
+     * Set a value in the cache if it's not already stored
+     *
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
+     * @return bool
+     */
+    public function add($key, $value, $ttl = 0) {
+        return apcu_add($this->getPrefix() . $key, $value, $ttl);
+    }
 
-	/**
-	 * Increase a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function inc($key, $step = 1) {
-		$this->add($key, 0);
-		/**
-		 * TODO - hack around a PHP 7 specific issue in APCu
-		 *
-		 * on PHP 7 the apcu_inc method on a non-existing object will increment
-		 * "0" and result in "1" as value - therefore we check for existence
-		 * first
-		 *
-		 * on PHP 5.6 this is not the case
-		 *
-		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
-		 * for details
-		 */
-		return apcu_exists($this->getPrefix() . $key)
-			? apcu_inc($this->getPrefix() . $key, $step)
-			: false;
-	}
+    /**
+     * Increase a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function inc($key, $step = 1) {
+        $this->add($key, 0);
+        /**
+         * TODO - hack around a PHP 7 specific issue in APCu
+         *
+         * on PHP 7 the apcu_inc method on a non-existing object will increment
+         * "0" and result in "1" as value - therefore we check for existence
+         * first
+         *
+         * on PHP 5.6 this is not the case
+         *
+         * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
+         * for details
+         */
+        return apcu_exists($this->getPrefix() . $key)
+            ? apcu_inc($this->getPrefix() . $key, $step)
+            : false;
+    }
 
-	/**
-	 * Decrease a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function dec($key, $step = 1) {
-		/**
-		 * TODO - hack around a PHP 7 specific issue in APCu
-		 *
-		 * on PHP 7 the apcu_dec method on a non-existing object will decrement
-		 * "0" and result in "-1" as value - therefore we check for existence
-		 * first
-		 *
-		 * on PHP 5.6 this is not the case
-		 *
-		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
-		 * for details
-		 */
-		return apcu_exists($this->getPrefix() . $key)
-			? apcu_dec($this->getPrefix() . $key, $step)
-			: false;
-	}
+    /**
+     * Decrease a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function dec($key, $step = 1) {
+        /**
+         * TODO - hack around a PHP 7 specific issue in APCu
+         *
+         * on PHP 7 the apcu_dec method on a non-existing object will decrement
+         * "0" and result in "-1" as value - therefore we check for existence
+         * first
+         *
+         * on PHP 5.6 this is not the case
+         *
+         * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
+         * for details
+         */
+        return apcu_exists($this->getPrefix() . $key)
+            ? apcu_dec($this->getPrefix() . $key, $step)
+            : false;
+    }
 
-	/**
-	 * Compare and set
-	 *
-	 * @param string $key
-	 * @param mixed $old
-	 * @param mixed $new
-	 * @return bool
-	 */
-	public function cas($key, $old, $new) {
-		// apc only does cas for ints
-		if (is_int($old) and is_int($new)) {
-			return apcu_cas($this->getPrefix() . $key, $old, $new);
-		} else {
-			return $this->casEmulated($key, $old, $new);
-		}
-	}
+    /**
+     * Compare and set
+     *
+     * @param string $key
+     * @param mixed $old
+     * @param mixed $new
+     * @return bool
+     */
+    public function cas($key, $old, $new) {
+        // apc only does cas for ints
+        if (is_int($old) and is_int($new)) {
+            return apcu_cas($this->getPrefix() . $key, $old, $new);
+        } else {
+            return $this->casEmulated($key, $old, $new);
+        }
+    }
 
-	/**
-	 * @return bool
-	 */
-	static public function isAvailable() {
-		if (!extension_loaded('apcu')) {
-			return false;
-		} elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) {
-			return false;
-		} elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) {
-			return false;
-		} elseif (
-				version_compare(phpversion('apc'), '4.0.6') === -1 &&
-				version_compare(phpversion('apcu'), '5.1.0') === -1
-		) {
-			return false;
-		} else {
-			return true;
-		}
-	}
+    /**
+     * @return bool
+     */
+    static public function isAvailable() {
+        if (!extension_loaded('apcu')) {
+            return false;
+        } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) {
+            return false;
+        } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) {
+            return false;
+        } elseif (
+                version_compare(phpversion('apc'), '4.0.6') === -1 &&
+                version_compare(phpversion('apcu'), '5.1.0') === -1
+        ) {
+            return false;
+        } else {
+            return true;
+        }
+    }
 }

Spacing +14 added lines, -14 removed lines

@@ -37,7 +37,7 @@ 
 	use CADTrait;
 
 	public function get($key) {
-		$result = apcu_fetch($this->getPrefix() . $key, $success);
+		$result = apcu_fetch($this->getPrefix().$key, $success);
 		if (!$success) {
 			return null;
 		}
@@ -45,24 +45,24 @@ 
 	}
 
 	public function set($key, $value, $ttl = 0) {
-		return apcu_store($this->getPrefix() . $key, $value, $ttl);
+		return apcu_store($this->getPrefix().$key, $value, $ttl);
 	}
 
 	public function hasKey($key) {
-		return apcu_exists($this->getPrefix() . $key);
+		return apcu_exists($this->getPrefix().$key);
 	}
 
 	public function remove($key) {
-		return apcu_delete($this->getPrefix() . $key);
+		return apcu_delete($this->getPrefix().$key);
 	}
 
 	public function clear($prefix = '') {
-		$ns = $this->getPrefix() . $prefix;
+		$ns = $this->getPrefix().$prefix;
 		$ns = preg_quote($ns, '/');
-		if(class_exists('\APCIterator')) {
-			$iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
+		if (class_exists('\APCIterator')) {
+			$iter = new \APCIterator('user', '/^'.$ns.'/', APC_ITER_KEY);
 		} else {
-			$iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
+			$iter = new \APCUIterator('/^'.$ns.'/', APC_ITER_KEY);
 		}
 		return apcu_delete($iter);
 	}
@@ -76,7 +76,7 @@ 
 	 * @return bool
 	 */
 	public function add($key, $value, $ttl = 0) {
-		return apcu_add($this->getPrefix() . $key, $value, $ttl);
+		return apcu_add($this->getPrefix().$key, $value, $ttl);
 	}
 
 	/**
@@ -100,8 +100,8 @@ 
 		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
 		 * for details
 		 */
-		return apcu_exists($this->getPrefix() . $key)
-			? apcu_inc($this->getPrefix() . $key, $step)
+		return apcu_exists($this->getPrefix().$key)
+			? apcu_inc($this->getPrefix().$key, $step)
 			: false;
 	}
 
@@ -125,8 +125,8 @@ 
 		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
 		 * for details
 		 */
-		return apcu_exists($this->getPrefix() . $key)
-			? apcu_dec($this->getPrefix() . $key, $step)
+		return apcu_exists($this->getPrefix().$key)
+			? apcu_dec($this->getPrefix().$key, $step)
 			: false;
 	}
 
@@ -141,7 +141,7 @@ 
 	public function cas($key, $old, $new) {
 		// apc only does cas for ints
 		if (is_int($old) and is_int($new)) {
-			return apcu_cas($this->getPrefix() . $key, $old, $new);
+			return apcu_cas($this->getPrefix().$key, $old, $new);
 		} else {
 			return $this->casEmulated($key, $old, $new);
 		}

lib/private/Memcache/ArrayCache.php

Doc Comments +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
 	 * Set a value in the cache if it's not already stored
 	 *
 	 * @param string $key
-	 * @param mixed $value
+	 * @param integer $value
 	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
 	 * @return bool
 	 */

Indentation +117 added lines, -117 removed lines

@@ -27,133 +27,133 @@
 use OCP\IMemcache;
 
 class ArrayCache extends Cache implements IMemcache {
-	/** @var array Array with the cached data */
-	protected $cachedData = array();
+    /** @var array Array with the cached data */
+    protected $cachedData = array();
 
-	use CADTrait;
+    use CADTrait;
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function get($key) {
-		if ($this->hasKey($key)) {
-			return $this->cachedData[$key];
-		}
-		return null;
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function get($key) {
+        if ($this->hasKey($key)) {
+            return $this->cachedData[$key];
+        }
+        return null;
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function set($key, $value, $ttl = 0) {
-		$this->cachedData[$key] = $value;
-		return true;
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function set($key, $value, $ttl = 0) {
+        $this->cachedData[$key] = $value;
+        return true;
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function hasKey($key) {
-		return isset($this->cachedData[$key]);
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function hasKey($key) {
+        return isset($this->cachedData[$key]);
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function remove($key) {
-		unset($this->cachedData[$key]);
-		return true;
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function remove($key) {
+        unset($this->cachedData[$key]);
+        return true;
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function clear($prefix = '') {
-		if ($prefix === '') {
-			$this->cachedData = [];
-			return true;
-		}
+    /**
+     * {@inheritDoc}
+     */
+    public function clear($prefix = '') {
+        if ($prefix === '') {
+            $this->cachedData = [];
+            return true;
+        }
 
-		foreach ($this->cachedData as $key => $value) {
-			if (strpos($key, $prefix) === 0) {
-				$this->remove($key);
-			}
-		}
-		return true;
-	}
+        foreach ($this->cachedData as $key => $value) {
+            if (strpos($key, $prefix) === 0) {
+                $this->remove($key);
+            }
+        }
+        return true;
+    }
 
-	/**
-	 * Set a value in the cache if it's not already stored
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
-	 * @return bool
-	 */
-	public function add($key, $value, $ttl = 0) {
-		// since this cache is not shared race conditions aren't an issue
-		if ($this->hasKey($key)) {
-			return false;
-		} else {
-			return $this->set($key, $value, $ttl);
-		}
-	}
+    /**
+     * Set a value in the cache if it's not already stored
+     *
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
+     * @return bool
+     */
+    public function add($key, $value, $ttl = 0) {
+        // since this cache is not shared race conditions aren't an issue
+        if ($this->hasKey($key)) {
+            return false;
+        } else {
+            return $this->set($key, $value, $ttl);
+        }
+    }
 
-	/**
-	 * Increase a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function inc($key, $step = 1) {
-		$oldValue = $this->get($key);
-		if (is_int($oldValue)) {
-			$this->set($key, $oldValue + $step);
-			return $oldValue + $step;
-		} else {
-			$success = $this->add($key, $step);
-			return ($success) ? $step : false;
-		}
-	}
+    /**
+     * Increase a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function inc($key, $step = 1) {
+        $oldValue = $this->get($key);
+        if (is_int($oldValue)) {
+            $this->set($key, $oldValue + $step);
+            return $oldValue + $step;
+        } else {
+            $success = $this->add($key, $step);
+            return ($success) ? $step : false;
+        }
+    }
 
-	/**
-	 * Decrease a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function dec($key, $step = 1) {
-		$oldValue = $this->get($key);
-		if (is_int($oldValue)) {
-			$this->set($key, $oldValue - $step);
-			return $oldValue - $step;
-		} else {
-			return false;
-		}
-	}
+    /**
+     * Decrease a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function dec($key, $step = 1) {
+        $oldValue = $this->get($key);
+        if (is_int($oldValue)) {
+            $this->set($key, $oldValue - $step);
+            return $oldValue - $step;
+        } else {
+            return false;
+        }
+    }
 
-	/**
-	 * Compare and set
-	 *
-	 * @param string $key
-	 * @param mixed $old
-	 * @param mixed $new
-	 * @return bool
-	 */
-	public function cas($key, $old, $new) {
-		if ($this->get($key) === $old) {
-			return $this->set($key, $new);
-		} else {
-			return false;
-		}
-	}
+    /**
+     * Compare and set
+     *
+     * @param string $key
+     * @param mixed $old
+     * @param mixed $new
+     * @return bool
+     */
+    public function cas($key, $old, $new) {
+        if ($this->get($key) === $old) {
+            return $this->set($key, $new);
+        } else {
+            return false;
+        }
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	static public function isAvailable() {
-		return true;
-	}
+    /**
+     * {@inheritDoc}
+     */
+    static public function isAvailable() {
+        return true;
+    }
 }

lib/private/User/Session.php

Doc Comments +4 added lines, -1 removed lines

@@ -311,7 +311,7 @@ 
 	 * @param OC\Security\Bruteforce\Throttler $throttler
 	 * @throws LoginException
 	 * @throws PasswordLoginForbiddenException
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function logClientIn($user,
 								$password,
@@ -361,6 +361,9 @@ 
 		return $this->config->getSystemValue('token_auth_enforced', false);
 	}
 
+	/**
+	 * @param string $username
+	 */
 	protected function isTwoFactorEnforced($username) {
 		Util::emitHook(
 			'\OCA\Files_Sharing\API\Server2Server',

Indentation +782 added lines, -782 removed lines

@@ -75,788 +75,788 @@
  */
 class Session implements IUserSession, Emitter {
 
-	/** @var IUserManager $manager */
-	private $manager;
-
-	/** @var ISession $session */
-	private $session;
-
-	/** @var ITimeFactory */
-	private $timeFacory;
-
-	/** @var IProvider */
-	private $tokenProvider;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var User $activeUser */
-	protected $activeUser;
-
-	/** @var ISecureRandom */
-	private $random;
-
-	/**
-	 * @param IUserManager $manager
-	 * @param ISession $session
-	 * @param ITimeFactory $timeFacory
-	 * @param IProvider $tokenProvider
-	 * @param IConfig $config
-	 * @param ISecureRandom $random
-	 */
-	public function __construct(IUserManager $manager,
-								ISession $session,
-								ITimeFactory $timeFacory,
-								$tokenProvider,
-								IConfig $config,
-								ISecureRandom $random) {
-		$this->manager = $manager;
-		$this->session = $session;
-		$this->timeFacory = $timeFacory;
-		$this->tokenProvider = $tokenProvider;
-		$this->config = $config;
-		$this->random = $random;
-	}
-
-	/**
-	 * @param IProvider $provider
-	 */
-	public function setTokenProvider(IProvider $provider) {
-		$this->tokenProvider = $provider;
-	}
-
-	/**
-	 * @param string $scope
-	 * @param string $method
-	 * @param callable $callback
-	 */
-	public function listen($scope, $method, callable $callback) {
-		$this->manager->listen($scope, $method, $callback);
-	}
-
-	/**
-	 * @param string $scope optional
-	 * @param string $method optional
-	 * @param callable $callback optional
-	 */
-	public function removeListener($scope = null, $method = null, callable $callback = null) {
-		$this->manager->removeListener($scope, $method, $callback);
-	}
-
-	/**
-	 * get the manager object
-	 *
-	 * @return Manager
-	 */
-	public function getManager() {
-		return $this->manager;
-	}
-
-	/**
-	 * get the session object
-	 *
-	 * @return ISession
-	 */
-	public function getSession() {
-		return $this->session;
-	}
-
-	/**
-	 * set the session object
-	 *
-	 * @param ISession $session
-	 */
-	public function setSession(ISession $session) {
-		if ($this->session instanceof ISession) {
-			$this->session->close();
-		}
-		$this->session = $session;
-		$this->activeUser = null;
-	}
-
-	/**
-	 * set the currently active user
-	 *
-	 * @param IUser|null $user
-	 */
-	public function setUser($user) {
-		if (is_null($user)) {
-			$this->session->remove('user_id');
-		} else {
-			$this->session->set('user_id', $user->getUID());
-		}
-		$this->activeUser = $user;
-	}
-
-	/**
-	 * get the current active user
-	 *
-	 * @return IUser|null Current user, otherwise null
-	 */
-	public function getUser() {
-		// FIXME: This is a quick'n dirty work-around for the incognito mode as
-		// described at https://github.com/owncloud/core/pull/12912#issuecomment-67391155
-		if (OC_User::isIncognitoMode()) {
-			return null;
-		}
-		if (is_null($this->activeUser)) {
-			$uid = $this->session->get('user_id');
-			if (is_null($uid)) {
-				return null;
-			}
-			$this->activeUser = $this->manager->get($uid);
-			if (is_null($this->activeUser)) {
-				return null;
-			}
-			$this->validateSession();
-		}
-		return $this->activeUser;
-	}
-
-	/**
-	 * Validate whether the current session is valid
-	 *
-	 * - For token-authenticated clients, the token validity is checked
-	 * - For browsers, the session token validity is checked
-	 */
-	protected function validateSession() {
-		$token = null;
-		$appPassword = $this->session->get('app_password');
-
-		if (is_null($appPassword)) {
-			try {
-				$token = $this->session->getId();
-			} catch (SessionNotAvailableException $ex) {
-				return;
-			}
-		} else {
-			$token = $appPassword;
-		}
-
-		if (!$this->validateToken($token)) {
-			// Session was invalidated
-			$this->logout();
-		}
-	}
-
-	/**
-	 * Checks whether the user is logged in
-	 *
-	 * @return bool if logged in
-	 */
-	public function isLoggedIn() {
-		$user = $this->getUser();
-		if (is_null($user)) {
-			return false;
-		}
-
-		return $user->isEnabled();
-	}
-
-	/**
-	 * set the login name
-	 *
-	 * @param string|null $loginName for the logged in user
-	 */
-	public function setLoginName($loginName) {
-		if (is_null($loginName)) {
-			$this->session->remove('loginname');
-		} else {
-			$this->session->set('loginname', $loginName);
-		}
-	}
-
-	/**
-	 * get the login name of the current user
-	 *
-	 * @return string
-	 */
-	public function getLoginName() {
-		if ($this->activeUser) {
-			return $this->session->get('loginname');
-		} else {
-			$uid = $this->session->get('user_id');
-			if ($uid) {
-				$this->activeUser = $this->manager->get($uid);
-				return $this->session->get('loginname');
-			} else {
-				return null;
-			}
-		}
-	}
-
-	/**
-	 * set the token id
-	 *
-	 * @param int|null $token that was used to log in
-	 */
-	protected function setToken($token) {
-		if ($token === null) {
-			$this->session->remove('token-id');
-		} else {
-			$this->session->set('token-id', $token);
-		}
-	}
-
-	/**
-	 * try to log in with the provided credentials
-	 *
-	 * @param string $uid
-	 * @param string $password
-	 * @return boolean|null
-	 * @throws LoginException
-	 */
-	public function login($uid, $password) {
-		$this->session->regenerateId();
-		if ($this->validateToken($password, $uid)) {
-			return $this->loginWithToken($password);
-		}
-		return $this->loginWithPassword($uid, $password);
-	}
-
-	/**
-	 * Tries to log in a client
-	 *
-	 * Checks token auth enforced
-	 * Checks 2FA enabled
-	 *
-	 * @param string $user
-	 * @param string $password
-	 * @param IRequest $request
-	 * @param OC\Security\Bruteforce\Throttler $throttler
-	 * @throws LoginException
-	 * @throws PasswordLoginForbiddenException
-	 * @return boolean
-	 */
-	public function logClientIn($user,
-								$password,
-								IRequest $request,
-								OC\Security\Bruteforce\Throttler $throttler) {
-		$currentDelay = $throttler->sleepDelay($request->getRemoteAddress(), 'login');
-
-		if ($this->manager instanceof PublicEmitter) {
-			$this->manager->emit('\OC\User', 'preLogin', array($user, $password));
-		}
-
-		$isTokenPassword = $this->isTokenPassword($password);
-		if (!$isTokenPassword && $this->isTokenAuthEnforced()) {
-			throw new PasswordLoginForbiddenException();
-		}
-		if (!$isTokenPassword && $this->isTwoFactorEnforced($user)) {
-			throw new PasswordLoginForbiddenException();
-		}
-		if (!$this->login($user, $password) ) {
-			$users = $this->manager->getByEmail($user);
-			if (count($users) === 1) {
-				return $this->login($users[0]->getUID(), $password);
-			}
-
-			$throttler->registerAttempt('login', $request->getRemoteAddress(), ['uid' => $user]);
-			if($currentDelay === 0) {
-				$throttler->sleepDelay($request->getRemoteAddress(), 'login');
-			}
-			return false;
-		}
-
-		if ($isTokenPassword) {
-			$this->session->set('app_password', $password);
-		} else if($this->supportsCookies($request)) {
-			// Password login, but cookies supported -> create (browser) session token
-			$this->createSessionToken($request, $this->getUser()->getUID(), $user, $password);
-		}
-
-		return true;
-	}
-
-	protected function supportsCookies(IRequest $request) {
-		if (!is_null($request->getCookie('cookie_test'))) {
-			return true;
-		}
-		setcookie('cookie_test', 'test', $this->timeFacory->getTime() + 3600);
-		return false;
-	}
-
-	private function isTokenAuthEnforced() {
-		return $this->config->getSystemValue('token_auth_enforced', false);
-	}
-
-	protected function isTwoFactorEnforced($username) {
-		Util::emitHook(
-			'\OCA\Files_Sharing\API\Server2Server',
-			'preLoginNameUsedAsUserName',
-			array('uid' => &$username)
-		);
-		$user = $this->manager->get($username);
-		if (is_null($user)) {
-			$users = $this->manager->getByEmail($username);
-			if (empty($users)) {
-				return false;
-			}
-			if (count($users) !== 1) {
-				return true;
-			}
-			$user = $users[0];
-		}
-		// DI not possible due to cyclic dependencies :'-/
-		return OC::$server->getTwoFactorAuthManager()->isTwoFactorAuthenticated($user);
-	}
-
-	/**
-	 * Check if the given 'password' is actually a device token
-	 *
-	 * @param string $password
-	 * @return boolean
-	 */
-	public function isTokenPassword($password) {
-		try {
-			$this->tokenProvider->getToken($password);
-			return true;
-		} catch (InvalidTokenException $ex) {
-			return false;
-		}
-	}
-
-	protected function prepareUserLogin($firstTimeLogin) {
-		// TODO: mock/inject/use non-static
-		// Refresh the token
-		\OC::$server->getCsrfTokenManager()->refreshToken();
-		//we need to pass the user name, which may differ from login name
-		$user = $this->getUser()->getUID();
-		OC_Util::setupFS($user);
-
-		if ($firstTimeLogin) {
-			// TODO: lock necessary?
-			//trigger creation of user home and /files folder
-			$userFolder = \OC::$server->getUserFolder($user);
-
-			// copy skeleton
-			\OC_Util::copySkeleton($user, $userFolder);
-
-			// trigger any other initialization
-			\OC::$server->getEventDispatcher()->dispatch(IUser::class . '::firstLogin', new GenericEvent($this->getUser()));
-		}
-	}
-
-	/**
-	 * Tries to login the user with HTTP Basic Authentication
-	 *
-	 * @todo do not allow basic auth if the user is 2FA enforced
-	 * @param IRequest $request
-	 * @param OC\Security\Bruteforce\Throttler $throttler
-	 * @return boolean if the login was successful
-	 */
-	public function tryBasicAuthLogin(IRequest $request,
-									  OC\Security\Bruteforce\Throttler $throttler) {
-		if (!empty($request->server['PHP_AUTH_USER']) && !empty($request->server['PHP_AUTH_PW'])) {
-			try {
-				if ($this->logClientIn($request->server['PHP_AUTH_USER'], $request->server['PHP_AUTH_PW'], $request, $throttler)) {
-					/**
-					 * Add DAV authenticated. This should in an ideal world not be
-					 * necessary but the iOS App reads cookies from anywhere instead
-					 * only the DAV endpoint.
-					 * This makes sure that the cookies will be valid for the whole scope
-					 * @see https://github.com/owncloud/core/issues/22893
-					 */
-					$this->session->set(
-						Auth::DAV_AUTHENTICATED, $this->getUser()->getUID()
-					);
-
-					// Set the last-password-confirm session to make the sudo mode work
-					 $this->session->set('last-password-confirm', $this->timeFacory->getTime());
-
-					return true;
-				}
-			} catch (PasswordLoginForbiddenException $ex) {
-				// Nothing to do
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * Log an user in via login name and password
-	 *
-	 * @param string $uid
-	 * @param string $password
-	 * @return boolean
-	 * @throws LoginException if an app canceld the login process or the user is not enabled
-	 */
-	private function loginWithPassword($uid, $password) {
-		$user = $this->manager->checkPassword($uid, $password);
-		if ($user === false) {
-			// Password check failed
-			return false;
-		}
-
-		if ($user->isEnabled()) {
-			$this->setUser($user);
-			$this->setLoginName($uid);
-			$this->setToken(null);
-			$firstTimeLogin = $user->updateLastLoginTimestamp();
-			$this->manager->emit('\OC\User', 'postLogin', [$user, $password]);
-			if ($this->isLoggedIn()) {
-				$this->prepareUserLogin($firstTimeLogin);
-				return true;
-			} else {
-				// injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
-				$message = \OC::$server->getL10N('lib')->t('Login canceled by app');
-				throw new LoginException($message);
-			}
-		} else {
-			// injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
-			$message = \OC::$server->getL10N('lib')->t('User disabled');
-			throw new LoginException($message);
-		}
-	}
-
-	/**
-	 * Log an user in with a given token (id)
-	 *
-	 * @param string $token
-	 * @return boolean
-	 * @throws LoginException if an app canceled the login process or the user is not enabled
-	 */
-	private function loginWithToken($token) {
-		try {
-			$dbToken = $this->tokenProvider->getToken($token);
-		} catch (InvalidTokenException $ex) {
-			return false;
-		}
-		$uid = $dbToken->getUID();
-
-		// When logging in with token, the password must be decrypted first before passing to login hook
-		$password = '';
-		try {
-			$password = $this->tokenProvider->getPassword($dbToken, $token);
-		} catch (PasswordlessTokenException $ex) {
-			// Ignore and use empty string instead
-		}
-
-		$user = $this->manager->get($uid);
-		if (is_null($user)) {
-			// user does not exist
-			return false;
-		}
-		if (!$user->isEnabled()) {
-			// disabled users can not log in
-			// injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
-			$message = \OC::$server->getL10N('lib')->t('User disabled');
-			throw new LoginException($message);
-		}
-
-		//login
-		$this->setUser($user);
-		$this->setLoginName($dbToken->getLoginName());
-		$this->setToken($dbToken->getId());
-		\OC::$server->getLockdownManager()->setToken($dbToken);
-		$this->manager->emit('\OC\User', 'postLogin', array($user, $password));
-
-		if ($this->isLoggedIn()) {
-			$this->prepareUserLogin(false); // token login cant be the first
-		} else {
-			// injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
-			$message = \OC::$server->getL10N('lib')->t('Login canceled by app');
-			throw new LoginException($message);
-		}
-
-		return true;
-	}
-
-	/**
-	 * Create a new session token for the given user credentials
-	 *
-	 * @param IRequest $request
-	 * @param string $uid user UID
-	 * @param string $loginName login name
-	 * @param string $password
-	 * @param int $remember
-	 * @return boolean
-	 */
-	public function createSessionToken(IRequest $request, $uid, $loginName, $password = null, $remember = IToken::DO_NOT_REMEMBER) {
-		if (is_null($this->manager->get($uid))) {
-			// User does not exist
-			return false;
-		}
-		$name = isset($request->server['HTTP_USER_AGENT']) ? $request->server['HTTP_USER_AGENT'] : 'unknown browser';
-		try {
-			$sessionId = $this->session->getId();
-			$pwd = $this->getPassword($password);
-			$this->tokenProvider->generateToken($sessionId, $uid, $loginName, $pwd, $name, IToken::TEMPORARY_TOKEN, $remember);
-			return true;
-		} catch (SessionNotAvailableException $ex) {
-			// This can happen with OCC, where a memory session is used
-			// if a memory session is used, we shouldn't create a session token anyway
-			return false;
-		}
-	}
-
-	/**
-	 * Checks if the given password is a token.
-	 * If yes, the password is extracted from the token.
-	 * If no, the same password is returned.
-	 *
-	 * @param string $password either the login password or a device token
-	 * @return string|null the password or null if none was set in the token
-	 */
-	private function getPassword($password) {
-		if (is_null($password)) {
-			// This is surely no token ;-)
-			return null;
-		}
-		try {
-			$token = $this->tokenProvider->getToken($password);
-			try {
-				return $this->tokenProvider->getPassword($token, $password);
-			} catch (PasswordlessTokenException $ex) {
-				return null;
-			}
-		} catch (InvalidTokenException $ex) {
-			return $password;
-		}
-	}
-
-	/**
-	 * @param IToken $dbToken
-	 * @param string $token
-	 * @return boolean
-	 */
-	private function checkTokenCredentials(IToken $dbToken, $token) {
-		// Check whether login credentials are still valid and the user was not disabled
-		// This check is performed each 5 minutes
-		$lastCheck = $dbToken->getLastCheck() ? : 0;
-		$now = $this->timeFacory->getTime();
-		if ($lastCheck > ($now - 60 * 5)) {
-			// Checked performed recently, nothing to do now
-			return true;
-		}
-
-		try {
-			$pwd = $this->tokenProvider->getPassword($dbToken, $token);
-		} catch (InvalidTokenException $ex) {
-			// An invalid token password was used -> log user out
-			return false;
-		} catch (PasswordlessTokenException $ex) {
-			// Token has no password
-
-			if (!is_null($this->activeUser) && !$this->activeUser->isEnabled()) {
-				$this->tokenProvider->invalidateToken($token);
-				return false;
-			}
-
-			$dbToken->setLastCheck($now);
-			return true;
-		}
-
-		if ($this->manager->checkPassword($dbToken->getLoginName(), $pwd) === false
-			|| (!is_null($this->activeUser) && !$this->activeUser->isEnabled())) {
-			$this->tokenProvider->invalidateToken($token);
-			// Password has changed or user was disabled -> log user out
-			return false;
-		}
-		$dbToken->setLastCheck($now);
-		return true;
-	}
-
-	/**
-	 * Check if the given token exists and performs password/user-enabled checks
-	 *
-	 * Invalidates the token if checks fail
-	 *
-	 * @param string $token
-	 * @param string $user login name
-	 * @return boolean
-	 */
-	private function validateToken($token, $user = null) {
-		try {
-			$dbToken = $this->tokenProvider->getToken($token);
-		} catch (InvalidTokenException $ex) {
-			return false;
-		}
-
-		// Check if login names match
-		if (!is_null($user) && $dbToken->getLoginName() !== $user) {
-			// TODO: this makes it imposssible to use different login names on browser and client
-			// e.g. login by e-mail 'user@example.com' on browser for generating the token will not
-			//      allow to use the client token with the login name 'user'.
-			return false;
-		}
-
-		if (!$this->checkTokenCredentials($dbToken, $token)) {
-			return false;
-		}
-
-		$this->tokenProvider->updateTokenActivity($dbToken);
-
-		return true;
-	}
-
-	/**
-	 * Tries to login the user with auth token header
-	 *
-	 * @param IRequest $request
-	 * @todo check remember me cookie
-	 * @return boolean
-	 */
-	public function tryTokenLogin(IRequest $request) {
-		$authHeader = $request->getHeader('Authorization');
-		if (strpos($authHeader, 'token ') === false) {
-			// No auth header, let's try session id
-			try {
-				$token = $this->session->getId();
-			} catch (SessionNotAvailableException $ex) {
-				return false;
-			}
-		} else {
-			$token = substr($authHeader, 6);
-		}
-
-		if (!$this->loginWithToken($token)) {
-			return false;
-		}
-		if(!$this->validateToken($token)) {
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * perform login using the magic cookie (remember login)
-	 *
-	 * @param string $uid the username
-	 * @param string $currentToken
-	 * @param string $oldSessionId
-	 * @return bool
-	 */
-	public function loginWithCookie($uid, $currentToken, $oldSessionId) {
-		$this->session->regenerateId();
-		$this->manager->emit('\OC\User', 'preRememberedLogin', array($uid));
-		$user = $this->manager->get($uid);
-		if (is_null($user)) {
-			// user does not exist
-			return false;
-		}
-
-		// get stored tokens
-		$tokens = $this->config->getUserKeys($uid, 'login_token');
-		// test cookies token against stored tokens
-		if (!in_array($currentToken, $tokens, true)) {
-			return false;
-		}
-		// replace successfully used token with a new one
-		$this->config->deleteUserValue($uid, 'login_token', $currentToken);
-		$newToken = $this->random->generate(32);
-		$this->config->setUserValue($uid, 'login_token', $newToken, $this->timeFacory->getTime());
-
-		try {
-			$sessionId = $this->session->getId();
-			$this->tokenProvider->renewSessionToken($oldSessionId, $sessionId);
-		} catch (SessionNotAvailableException $ex) {
-			return false;
-		} catch (InvalidTokenException $ex) {
-			\OC::$server->getLogger()->warning('Renewing session token failed', ['app' => 'core']);
-			return false;
-		}
-
-		$this->setMagicInCookie($user->getUID(), $newToken);
-		$token = $this->tokenProvider->getToken($sessionId);
-
-		//login
-		$this->setUser($user);
-		$this->setLoginName($token->getLoginName());
-		$this->setToken($token->getId());
-		$user->updateLastLoginTimestamp();
-		$this->manager->emit('\OC\User', 'postRememberedLogin', [$user]);
-		return true;
-	}
-
-	/**
-	 * @param IUser $user
-	 */
-	public function createRememberMeToken(IUser $user) {
-		$token = $this->random->generate(32);
-		$this->config->setUserValue($user->getUID(), 'login_token', $token, $this->timeFacory->getTime());
-		$this->setMagicInCookie($user->getUID(), $token);
-	}
-
-	/**
-	 * logout the user from the session
-	 */
-	public function logout() {
-		$this->manager->emit('\OC\User', 'logout');
-		$user = $this->getUser();
-		if (!is_null($user)) {
-			try {
-				$this->tokenProvider->invalidateToken($this->session->getId());
-			} catch (SessionNotAvailableException $ex) {
-
-			}
-		}
-		$this->setUser(null);
-		$this->setLoginName(null);
-		$this->setToken(null);
-		$this->unsetMagicInCookie();
-		$this->session->clear();
-	}
-
-	/**
-	 * Set cookie value to use in next page load
-	 *
-	 * @param string $username username to be set
-	 * @param string $token
-	 */
-	public function setMagicInCookie($username, $token) {
-		$secureCookie = OC::$server->getRequest()->getServerProtocol() === 'https';
-		$webRoot = \OC::$WEBROOT;
-		if ($webRoot === '') {
-			$webRoot = '/';
-		}
-
-		$expires = $this->timeFacory->getTime() + $this->config->getSystemValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15);
-		setcookie('nc_username', $username, $expires, $webRoot, '', $secureCookie, true);
-		setcookie('nc_token', $token, $expires, $webRoot, '', $secureCookie, true);
-		try {
-			setcookie('nc_session_id', $this->session->getId(), $expires, $webRoot, '', $secureCookie, true);
-		} catch (SessionNotAvailableException $ex) {
-			// ignore
-		}
-	}
-
-	/**
-	 * Remove cookie for "remember username"
-	 */
-	public function unsetMagicInCookie() {
-		//TODO: DI for cookies and IRequest
-		$secureCookie = OC::$server->getRequest()->getServerProtocol() === 'https';
-
-		unset($_COOKIE['nc_username']); //TODO: DI
-		unset($_COOKIE['nc_token']);
-		unset($_COOKIE['nc_session_id']);
-		setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
-		setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
-		setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
-		// old cookies might be stored under /webroot/ instead of /webroot
-		// and Firefox doesn't like it!
-		setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
-		setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
-		setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
-	}
-
-	/**
-	 * Update password of the browser session token if there is one
-	 *
-	 * @param string $password
-	 */
-	public function updateSessionTokenPassword($password) {
-		try {
-			$sessionId = $this->session->getId();
-			$token = $this->tokenProvider->getToken($sessionId);
-			$this->tokenProvider->setPassword($token, $sessionId, $password);
-		} catch (SessionNotAvailableException $ex) {
-			// Nothing to do
-		} catch (InvalidTokenException $ex) {
-			// Nothing to do
-		}
-	}
+    /** @var IUserManager $manager */
+    private $manager;
+
+    /** @var ISession $session */
+    private $session;
+
+    /** @var ITimeFactory */
+    private $timeFacory;
+
+    /** @var IProvider */
+    private $tokenProvider;
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var User $activeUser */
+    protected $activeUser;
+
+    /** @var ISecureRandom */
+    private $random;
+
+    /**
+     * @param IUserManager $manager
+     * @param ISession $session
+     * @param ITimeFactory $timeFacory
+     * @param IProvider $tokenProvider
+     * @param IConfig $config
+     * @param ISecureRandom $random
+     */
+    public function __construct(IUserManager $manager,
+                                ISession $session,
+                                ITimeFactory $timeFacory,
+                                $tokenProvider,
+                                IConfig $config,
+                                ISecureRandom $random) {
+        $this->manager = $manager;
+        $this->session = $session;
+        $this->timeFacory = $timeFacory;
+        $this->tokenProvider = $tokenProvider;
+        $this->config = $config;
+        $this->random = $random;
+    }
+
+    /**
+     * @param IProvider $provider
+     */
+    public function setTokenProvider(IProvider $provider) {
+        $this->tokenProvider = $provider;
+    }
+
+    /**
+     * @param string $scope
+     * @param string $method
+     * @param callable $callback
+     */
+    public function listen($scope, $method, callable $callback) {
+        $this->manager->listen($scope, $method, $callback);
+    }
+
+    /**
+     * @param string $scope optional
+     * @param string $method optional
+     * @param callable $callback optional
+     */
+    public function removeListener($scope = null, $method = null, callable $callback = null) {
+        $this->manager->removeListener($scope, $method, $callback);
+    }
+
+    /**
+     * get the manager object
+     *
+     * @return Manager
+     */
+    public function getManager() {
+        return $this->manager;
+    }
+
+    /**
+     * get the session object
+     *
+     * @return ISession
+     */
+    public function getSession() {
+        return $this->session;
+    }
+
+    /**
+     * set the session object
+     *
+     * @param ISession $session
+     */
+    public function setSession(ISession $session) {
+        if ($this->session instanceof ISession) {
+            $this->session->close();
+        }
+        $this->session = $session;
+        $this->activeUser = null;
+    }
+
+    /**
+     * set the currently active user
+     *
+     * @param IUser|null $user
+     */
+    public function setUser($user) {
+        if (is_null($user)) {
+            $this->session->remove('user_id');
+        } else {
+            $this->session->set('user_id', $user->getUID());
+        }
+        $this->activeUser = $user;
+    }
+
+    /**
+     * get the current active user
+     *
+     * @return IUser|null Current user, otherwise null
+     */
+    public function getUser() {
+        // FIXME: This is a quick'n dirty work-around for the incognito mode as
+        // described at https://github.com/owncloud/core/pull/12912#issuecomment-67391155
+        if (OC_User::isIncognitoMode()) {
+            return null;
+        }
+        if (is_null($this->activeUser)) {
+            $uid = $this->session->get('user_id');
+            if (is_null($uid)) {
+                return null;
+            }
+            $this->activeUser = $this->manager->get($uid);
+            if (is_null($this->activeUser)) {
+                return null;
+            }
+            $this->validateSession();
+        }
+        return $this->activeUser;
+    }
+
+    /**
+     * Validate whether the current session is valid
+     *
+     * - For token-authenticated clients, the token validity is checked
+     * - For browsers, the session token validity is checked
+     */
+    protected function validateSession() {
+        $token = null;
+        $appPassword = $this->session->get('app_password');
+
+        if (is_null($appPassword)) {
+            try {
+                $token = $this->session->getId();
+            } catch (SessionNotAvailableException $ex) {
+                return;
+            }
+        } else {
+            $token = $appPassword;
+        }
+
+        if (!$this->validateToken($token)) {
+            // Session was invalidated
+            $this->logout();
+        }
+    }
+
+    /**
+     * Checks whether the user is logged in
+     *
+     * @return bool if logged in
+     */
+    public function isLoggedIn() {
+        $user = $this->getUser();
+        if (is_null($user)) {
+            return false;
+        }
+
+        return $user->isEnabled();
+    }
+
+    /**
+     * set the login name
+     *
+     * @param string|null $loginName for the logged in user
+     */
+    public function setLoginName($loginName) {
+        if (is_null($loginName)) {
+            $this->session->remove('loginname');
+        } else {
+            $this->session->set('loginname', $loginName);
+        }
+    }
+
+    /**
+     * get the login name of the current user
+     *
+     * @return string
+     */
+    public function getLoginName() {
+        if ($this->activeUser) {
+            return $this->session->get('loginname');
+        } else {
+            $uid = $this->session->get('user_id');
+            if ($uid) {
+                $this->activeUser = $this->manager->get($uid);
+                return $this->session->get('loginname');
+            } else {
+                return null;
+            }
+        }
+    }
+
+    /**
+     * set the token id
+     *
+     * @param int|null $token that was used to log in
+     */
+    protected function setToken($token) {
+        if ($token === null) {
+            $this->session->remove('token-id');
+        } else {
+            $this->session->set('token-id', $token);
+        }
+    }
+
+    /**
+     * try to log in with the provided credentials
+     *
+     * @param string $uid
+     * @param string $password
+     * @return boolean|null
+     * @throws LoginException
+     */
+    public function login($uid, $password) {
+        $this->session->regenerateId();
+        if ($this->validateToken($password, $uid)) {
+            return $this->loginWithToken($password);
+        }
+        return $this->loginWithPassword($uid, $password);
+    }
+
+    /**
+     * Tries to log in a client
+     *
+     * Checks token auth enforced
+     * Checks 2FA enabled
+     *
+     * @param string $user
+     * @param string $password
+     * @param IRequest $request
+     * @param OC\Security\Bruteforce\Throttler $throttler
+     * @throws LoginException
+     * @throws PasswordLoginForbiddenException
+     * @return boolean
+     */
+    public function logClientIn($user,
+                                $password,
+                                IRequest $request,
+                                OC\Security\Bruteforce\Throttler $throttler) {
+        $currentDelay = $throttler->sleepDelay($request->getRemoteAddress(), 'login');
+
+        if ($this->manager instanceof PublicEmitter) {
+            $this->manager->emit('\OC\User', 'preLogin', array($user, $password));
+        }
+
+        $isTokenPassword = $this->isTokenPassword($password);
+        if (!$isTokenPassword && $this->isTokenAuthEnforced()) {
+            throw new PasswordLoginForbiddenException();
+        }
+        if (!$isTokenPassword && $this->isTwoFactorEnforced($user)) {
+            throw new PasswordLoginForbiddenException();
+        }
+        if (!$this->login($user, $password) ) {
+            $users = $this->manager->getByEmail($user);
+            if (count($users) === 1) {
+                return $this->login($users[0]->getUID(), $password);
+            }
+
+            $throttler->registerAttempt('login', $request->getRemoteAddress(), ['uid' => $user]);
+            if($currentDelay === 0) {
+                $throttler->sleepDelay($request->getRemoteAddress(), 'login');
+            }
+            return false;
+        }
+
+        if ($isTokenPassword) {
+            $this->session->set('app_password', $password);
+        } else if($this->supportsCookies($request)) {
+            // Password login, but cookies supported -> create (browser) session token
+            $this->createSessionToken($request, $this->getUser()->getUID(), $user, $password);
+        }
+
+        return true;
+    }
+
+    protected function supportsCookies(IRequest $request) {
+        if (!is_null($request->getCookie('cookie_test'))) {
+            return true;
+        }
+        setcookie('cookie_test', 'test', $this->timeFacory->getTime() + 3600);
+        return false;
+    }
+
+    private function isTokenAuthEnforced() {
+        return $this->config->getSystemValue('token_auth_enforced', false);
+    }
+
+    protected function isTwoFactorEnforced($username) {
+        Util::emitHook(
+            '\OCA\Files_Sharing\API\Server2Server',
+            'preLoginNameUsedAsUserName',
+            array('uid' => &$username)
+        );
+        $user = $this->manager->get($username);
+        if (is_null($user)) {
+            $users = $this->manager->getByEmail($username);
+            if (empty($users)) {
+                return false;
+            }
+            if (count($users) !== 1) {
+                return true;
+            }
+            $user = $users[0];
+        }
+        // DI not possible due to cyclic dependencies :'-/
+        return OC::$server->getTwoFactorAuthManager()->isTwoFactorAuthenticated($user);
+    }
+
+    /**
+     * Check if the given 'password' is actually a device token
+     *
+     * @param string $password
+     * @return boolean
+     */
+    public function isTokenPassword($password) {
+        try {
+            $this->tokenProvider->getToken($password);
+            return true;
+        } catch (InvalidTokenException $ex) {
+            return false;
+        }
+    }
+
+    protected function prepareUserLogin($firstTimeLogin) {
+        // TODO: mock/inject/use non-static
+        // Refresh the token
+        \OC::$server->getCsrfTokenManager()->refreshToken();
+        //we need to pass the user name, which may differ from login name
+        $user = $this->getUser()->getUID();
+        OC_Util::setupFS($user);
+
+        if ($firstTimeLogin) {
+            // TODO: lock necessary?
+            //trigger creation of user home and /files folder
+            $userFolder = \OC::$server->getUserFolder($user);
+
+            // copy skeleton
+            \OC_Util::copySkeleton($user, $userFolder);
+
+            // trigger any other initialization
+            \OC::$server->getEventDispatcher()->dispatch(IUser::class . '::firstLogin', new GenericEvent($this->getUser()));
+        }
+    }
+
+    /**
+     * Tries to login the user with HTTP Basic Authentication
+     *
+     * @todo do not allow basic auth if the user is 2FA enforced
+     * @param IRequest $request
+     * @param OC\Security\Bruteforce\Throttler $throttler
+     * @return boolean if the login was successful
+     */
+    public function tryBasicAuthLogin(IRequest $request,
+                                        OC\Security\Bruteforce\Throttler $throttler) {
+        if (!empty($request->server['PHP_AUTH_USER']) && !empty($request->server['PHP_AUTH_PW'])) {
+            try {
+                if ($this->logClientIn($request->server['PHP_AUTH_USER'], $request->server['PHP_AUTH_PW'], $request, $throttler)) {
+                    /**
+                     * Add DAV authenticated. This should in an ideal world not be
+                     * necessary but the iOS App reads cookies from anywhere instead
+                     * only the DAV endpoint.
+                     * This makes sure that the cookies will be valid for the whole scope
+                     * @see https://github.com/owncloud/core/issues/22893
+                     */
+                    $this->session->set(
+                        Auth::DAV_AUTHENTICATED, $this->getUser()->getUID()
+                    );
+
+                    // Set the last-password-confirm session to make the sudo mode work
+                        $this->session->set('last-password-confirm', $this->timeFacory->getTime());
+
+                    return true;
+                }
+            } catch (PasswordLoginForbiddenException $ex) {
+                // Nothing to do
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Log an user in via login name and password
+     *
+     * @param string $uid
+     * @param string $password
+     * @return boolean
+     * @throws LoginException if an app canceld the login process or the user is not enabled
+     */
+    private function loginWithPassword($uid, $password) {
+        $user = $this->manager->checkPassword($uid, $password);
+        if ($user === false) {
+            // Password check failed
+            return false;
+        }
+
+        if ($user->isEnabled()) {
+            $this->setUser($user);
+            $this->setLoginName($uid);
+            $this->setToken(null);
+            $firstTimeLogin = $user->updateLastLoginTimestamp();
+            $this->manager->emit('\OC\User', 'postLogin', [$user, $password]);
+            if ($this->isLoggedIn()) {
+                $this->prepareUserLogin($firstTimeLogin);
+                return true;
+            } else {
+                // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
+                $message = \OC::$server->getL10N('lib')->t('Login canceled by app');
+                throw new LoginException($message);
+            }
+        } else {
+            // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
+            $message = \OC::$server->getL10N('lib')->t('User disabled');
+            throw new LoginException($message);
+        }
+    }
+
+    /**
+     * Log an user in with a given token (id)
+     *
+     * @param string $token
+     * @return boolean
+     * @throws LoginException if an app canceled the login process or the user is not enabled
+     */
+    private function loginWithToken($token) {
+        try {
+            $dbToken = $this->tokenProvider->getToken($token);
+        } catch (InvalidTokenException $ex) {
+            return false;
+        }
+        $uid = $dbToken->getUID();
+
+        // When logging in with token, the password must be decrypted first before passing to login hook
+        $password = '';
+        try {
+            $password = $this->tokenProvider->getPassword($dbToken, $token);
+        } catch (PasswordlessTokenException $ex) {
+            // Ignore and use empty string instead
+        }
+
+        $user = $this->manager->get($uid);
+        if (is_null($user)) {
+            // user does not exist
+            return false;
+        }
+        if (!$user->isEnabled()) {
+            // disabled users can not log in
+            // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
+            $message = \OC::$server->getL10N('lib')->t('User disabled');
+            throw new LoginException($message);
+        }
+
+        //login
+        $this->setUser($user);
+        $this->setLoginName($dbToken->getLoginName());
+        $this->setToken($dbToken->getId());
+        \OC::$server->getLockdownManager()->setToken($dbToken);
+        $this->manager->emit('\OC\User', 'postLogin', array($user, $password));
+
+        if ($this->isLoggedIn()) {
+            $this->prepareUserLogin(false); // token login cant be the first
+        } else {
+            // injecting l10n does not work - there is a circular dependency between session and \OCP\L10N\IFactory
+            $message = \OC::$server->getL10N('lib')->t('Login canceled by app');
+            throw new LoginException($message);
+        }
+
+        return true;
+    }
+
+    /**
+     * Create a new session token for the given user credentials
+     *
+     * @param IRequest $request
+     * @param string $uid user UID
+     * @param string $loginName login name
+     * @param string $password
+     * @param int $remember
+     * @return boolean
+     */
+    public function createSessionToken(IRequest $request, $uid, $loginName, $password = null, $remember = IToken::DO_NOT_REMEMBER) {
+        if (is_null($this->manager->get($uid))) {
+            // User does not exist
+            return false;
+        }
+        $name = isset($request->server['HTTP_USER_AGENT']) ? $request->server['HTTP_USER_AGENT'] : 'unknown browser';
+        try {
+            $sessionId = $this->session->getId();
+            $pwd = $this->getPassword($password);
+            $this->tokenProvider->generateToken($sessionId, $uid, $loginName, $pwd, $name, IToken::TEMPORARY_TOKEN, $remember);
+            return true;
+        } catch (SessionNotAvailableException $ex) {
+            // This can happen with OCC, where a memory session is used
+            // if a memory session is used, we shouldn't create a session token anyway
+            return false;
+        }
+    }
+
+    /**
+     * Checks if the given password is a token.
+     * If yes, the password is extracted from the token.
+     * If no, the same password is returned.
+     *
+     * @param string $password either the login password or a device token
+     * @return string|null the password or null if none was set in the token
+     */
+    private function getPassword($password) {
+        if (is_null($password)) {
+            // This is surely no token ;-)
+            return null;
+        }
+        try {
+            $token = $this->tokenProvider->getToken($password);
+            try {
+                return $this->tokenProvider->getPassword($token, $password);
+            } catch (PasswordlessTokenException $ex) {
+                return null;
+            }
+        } catch (InvalidTokenException $ex) {
+            return $password;
+        }
+    }
+
+    /**
+     * @param IToken $dbToken
+     * @param string $token
+     * @return boolean
+     */
+    private function checkTokenCredentials(IToken $dbToken, $token) {
+        // Check whether login credentials are still valid and the user was not disabled
+        // This check is performed each 5 minutes
+        $lastCheck = $dbToken->getLastCheck() ? : 0;
+        $now = $this->timeFacory->getTime();
+        if ($lastCheck > ($now - 60 * 5)) {
+            // Checked performed recently, nothing to do now
+            return true;
+        }
+
+        try {
+            $pwd = $this->tokenProvider->getPassword($dbToken, $token);
+        } catch (InvalidTokenException $ex) {
+            // An invalid token password was used -> log user out
+            return false;
+        } catch (PasswordlessTokenException $ex) {
+            // Token has no password
+
+            if (!is_null($this->activeUser) && !$this->activeUser->isEnabled()) {
+                $this->tokenProvider->invalidateToken($token);
+                return false;
+            }
+
+            $dbToken->setLastCheck($now);
+            return true;
+        }
+
+        if ($this->manager->checkPassword($dbToken->getLoginName(), $pwd) === false
+            || (!is_null($this->activeUser) && !$this->activeUser->isEnabled())) {
+            $this->tokenProvider->invalidateToken($token);
+            // Password has changed or user was disabled -> log user out
+            return false;
+        }
+        $dbToken->setLastCheck($now);
+        return true;
+    }
+
+    /**
+     * Check if the given token exists and performs password/user-enabled checks
+     *
+     * Invalidates the token if checks fail
+     *
+     * @param string $token
+     * @param string $user login name
+     * @return boolean
+     */
+    private function validateToken($token, $user = null) {
+        try {
+            $dbToken = $this->tokenProvider->getToken($token);
+        } catch (InvalidTokenException $ex) {
+            return false;
+        }
+
+        // Check if login names match
+        if (!is_null($user) && $dbToken->getLoginName() !== $user) {
+            // TODO: this makes it imposssible to use different login names on browser and client
+            // e.g. login by e-mail 'user@example.com' on browser for generating the token will not
+            //      allow to use the client token with the login name 'user'.
+            return false;
+        }
+
+        if (!$this->checkTokenCredentials($dbToken, $token)) {
+            return false;
+        }
+
+        $this->tokenProvider->updateTokenActivity($dbToken);
+
+        return true;
+    }
+
+    /**
+     * Tries to login the user with auth token header
+     *
+     * @param IRequest $request
+     * @todo check remember me cookie
+     * @return boolean
+     */
+    public function tryTokenLogin(IRequest $request) {
+        $authHeader = $request->getHeader('Authorization');
+        if (strpos($authHeader, 'token ') === false) {
+            // No auth header, let's try session id
+            try {
+                $token = $this->session->getId();
+            } catch (SessionNotAvailableException $ex) {
+                return false;
+            }
+        } else {
+            $token = substr($authHeader, 6);
+        }
+
+        if (!$this->loginWithToken($token)) {
+            return false;
+        }
+        if(!$this->validateToken($token)) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * perform login using the magic cookie (remember login)
+     *
+     * @param string $uid the username
+     * @param string $currentToken
+     * @param string $oldSessionId
+     * @return bool
+     */
+    public function loginWithCookie($uid, $currentToken, $oldSessionId) {
+        $this->session->regenerateId();
+        $this->manager->emit('\OC\User', 'preRememberedLogin', array($uid));
+        $user = $this->manager->get($uid);
+        if (is_null($user)) {
+            // user does not exist
+            return false;
+        }
+
+        // get stored tokens
+        $tokens = $this->config->getUserKeys($uid, 'login_token');
+        // test cookies token against stored tokens
+        if (!in_array($currentToken, $tokens, true)) {
+            return false;
+        }
+        // replace successfully used token with a new one
+        $this->config->deleteUserValue($uid, 'login_token', $currentToken);
+        $newToken = $this->random->generate(32);
+        $this->config->setUserValue($uid, 'login_token', $newToken, $this->timeFacory->getTime());
+
+        try {
+            $sessionId = $this->session->getId();
+            $this->tokenProvider->renewSessionToken($oldSessionId, $sessionId);
+        } catch (SessionNotAvailableException $ex) {
+            return false;
+        } catch (InvalidTokenException $ex) {
+            \OC::$server->getLogger()->warning('Renewing session token failed', ['app' => 'core']);
+            return false;
+        }
+
+        $this->setMagicInCookie($user->getUID(), $newToken);
+        $token = $this->tokenProvider->getToken($sessionId);
+
+        //login
+        $this->setUser($user);
+        $this->setLoginName($token->getLoginName());
+        $this->setToken($token->getId());
+        $user->updateLastLoginTimestamp();
+        $this->manager->emit('\OC\User', 'postRememberedLogin', [$user]);
+        return true;
+    }
+
+    /**
+     * @param IUser $user
+     */
+    public function createRememberMeToken(IUser $user) {
+        $token = $this->random->generate(32);
+        $this->config->setUserValue($user->getUID(), 'login_token', $token, $this->timeFacory->getTime());
+        $this->setMagicInCookie($user->getUID(), $token);
+    }
+
+    /**
+     * logout the user from the session
+     */
+    public function logout() {
+        $this->manager->emit('\OC\User', 'logout');
+        $user = $this->getUser();
+        if (!is_null($user)) {
+            try {
+                $this->tokenProvider->invalidateToken($this->session->getId());
+            } catch (SessionNotAvailableException $ex) {
+
+            }
+        }
+        $this->setUser(null);
+        $this->setLoginName(null);
+        $this->setToken(null);
+        $this->unsetMagicInCookie();
+        $this->session->clear();
+    }
+
+    /**
+     * Set cookie value to use in next page load
+     *
+     * @param string $username username to be set
+     * @param string $token
+     */
+    public function setMagicInCookie($username, $token) {
+        $secureCookie = OC::$server->getRequest()->getServerProtocol() === 'https';
+        $webRoot = \OC::$WEBROOT;
+        if ($webRoot === '') {
+            $webRoot = '/';
+        }
+
+        $expires = $this->timeFacory->getTime() + $this->config->getSystemValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15);
+        setcookie('nc_username', $username, $expires, $webRoot, '', $secureCookie, true);
+        setcookie('nc_token', $token, $expires, $webRoot, '', $secureCookie, true);
+        try {
+            setcookie('nc_session_id', $this->session->getId(), $expires, $webRoot, '', $secureCookie, true);
+        } catch (SessionNotAvailableException $ex) {
+            // ignore
+        }
+    }
+
+    /**
+     * Remove cookie for "remember username"
+     */
+    public function unsetMagicInCookie() {
+        //TODO: DI for cookies and IRequest
+        $secureCookie = OC::$server->getRequest()->getServerProtocol() === 'https';
+
+        unset($_COOKIE['nc_username']); //TODO: DI
+        unset($_COOKIE['nc_token']);
+        unset($_COOKIE['nc_session_id']);
+        setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
+        setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
+        setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
+        // old cookies might be stored under /webroot/ instead of /webroot
+        // and Firefox doesn't like it!
+        setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
+        setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
+        setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
+    }
+
+    /**
+     * Update password of the browser session token if there is one
+     *
+     * @param string $password
+     */
+    public function updateSessionTokenPassword($password) {
+        try {
+            $sessionId = $this->session->getId();
+            $token = $this->tokenProvider->getToken($sessionId);
+            $this->tokenProvider->setPassword($token, $sessionId, $password);
+        } catch (SessionNotAvailableException $ex) {
+            // Nothing to do
+        } catch (InvalidTokenException $ex) {
+            // Nothing to do
+        }
+    }
 
 
 }

Spacing +9 added lines, -9 removed lines

@@ -345,14 +345,14 @@ 
 		if (!$isTokenPassword && $this->isTwoFactorEnforced($user)) {
 			throw new PasswordLoginForbiddenException();
 		}
-		if (!$this->login($user, $password) ) {
+		if (!$this->login($user, $password)) {
 			$users = $this->manager->getByEmail($user);
 			if (count($users) === 1) {
 				return $this->login($users[0]->getUID(), $password);
 			}
 
 			$throttler->registerAttempt('login', $request->getRemoteAddress(), ['uid' => $user]);
-			if($currentDelay === 0) {
+			if ($currentDelay === 0) {
 				$throttler->sleepDelay($request->getRemoteAddress(), 'login');
 			}
 			return false;
@@ -360,7 +360,7 @@ 
 
 		if ($isTokenPassword) {
 			$this->session->set('app_password', $password);
-		} else if($this->supportsCookies($request)) {
+		} else if ($this->supportsCookies($request)) {
 			// Password login, but cookies supported -> create (browser) session token
 			$this->createSessionToken($request, $this->getUser()->getUID(), $user, $password);
 		}
@@ -433,7 +433,7 @@ 
 			\OC_Util::copySkeleton($user, $userFolder);
 
 			// trigger any other initialization
-			\OC::$server->getEventDispatcher()->dispatch(IUser::class . '::firstLogin', new GenericEvent($this->getUser()));
+			\OC::$server->getEventDispatcher()->dispatch(IUser::class.'::firstLogin', new GenericEvent($this->getUser()));
 		}
 	}
 
@@ -623,7 +623,7 @@ 
 	private function checkTokenCredentials(IToken $dbToken, $token) {
 		// Check whether login credentials are still valid and the user was not disabled
 		// This check is performed each 5 minutes
-		$lastCheck = $dbToken->getLastCheck() ? : 0;
+		$lastCheck = $dbToken->getLastCheck() ?: 0;
 		$now = $this->timeFacory->getTime();
 		if ($lastCheck > ($now - 60 * 5)) {
 			// Checked performed recently, nothing to do now
@@ -713,7 +713,7 @@ 
 		if (!$this->loginWithToken($token)) {
 			return false;
 		}
-		if(!$this->validateToken($token)) {
+		if (!$this->validateToken($token)) {
 			return false;
 		}
 		return true;
@@ -836,9 +836,9 @@ 
 		setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT, '', $secureCookie, true);
 		// old cookies might be stored under /webroot/ instead of /webroot
 		// and Firefox doesn't like it!
-		setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
-		setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
-		setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT . '/', '', $secureCookie, true);
+		setcookie('nc_username', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT.'/', '', $secureCookie, true);
+		setcookie('nc_token', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT.'/', '', $secureCookie, true);
+		setcookie('nc_session_id', '', $this->timeFacory->getTime() - 3600, OC::$WEBROOT.'/', '', $secureCookie, true);
 	}
 
 	/**

apps/dav/lib/Connector/Sabre/DavAclPlugin.php

Doc Comments +3 added lines

@@ -47,6 +47,9 @@
 		$this->allowUnauthenticatedAccess = false;
 	}
 
+	/**
+	 * @param string $privileges
+	 */
 	function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) {
 		$access = parent::checkPrivileges($uri, $privileges, $recursion, false);
 		if($access === false && $throwExceptions) {

Unused Use Statements -3 removed lines

@@ -25,14 +25,11 @@
 
 use Sabre\CalDAV\Principal\User;
 use Sabre\DAV\Exception\NotFound;
-use Sabre\DAV\IFile;
 use Sabre\DAV\INode;
 use \Sabre\DAV\PropFind;
 use \Sabre\DAV\PropPatch;
-use Sabre\DAVACL\Exception\NeedPrivileges;
 use \Sabre\HTTP\RequestInterface;
 use \Sabre\HTTP\ResponseInterface;
-use Sabre\HTTP\URLUtil;
 
 /**
  * Class DavAclPlugin is a wrapper around \Sabre\DAVACL\Plugin that returns 404

Indentation +41 added lines, -41 removed lines

@@ -43,50 +43,50 @@
  * @package OCA\DAV\Connector\Sabre
  */
 class DavAclPlugin extends \Sabre\DAVACL\Plugin {
-	public function __construct() {
-		$this->hideNodesFromListings = true;
-		$this->allowUnauthenticatedAccess = false;
-	}
+    public function __construct() {
+        $this->hideNodesFromListings = true;
+        $this->allowUnauthenticatedAccess = false;
+    }
 
-	function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) {
-		$access = parent::checkPrivileges($uri, $privileges, $recursion, false);
-		if($access === false && $throwExceptions) {
-			/** @var INode $node */
-			$node = $this->server->tree->getNodeForPath($uri);
+    function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) {
+        $access = parent::checkPrivileges($uri, $privileges, $recursion, false);
+        if($access === false && $throwExceptions) {
+            /** @var INode $node */
+            $node = $this->server->tree->getNodeForPath($uri);
 
-			switch(get_class($node)) {
-				case 'OCA\DAV\CardDAV\AddressBook':
-					$type = 'Addressbook';
-					break;
-				default:
-					$type = 'Node';
-					break;
-			}
-			throw new NotFound(
-				sprintf(
-					"%s with name '%s' could not be found",
-					$type,
-					$node->getName()
-				)
-			);
-		}
+            switch(get_class($node)) {
+                case 'OCA\DAV\CardDAV\AddressBook':
+                    $type = 'Addressbook';
+                    break;
+                default:
+                    $type = 'Node';
+                    break;
+            }
+            throw new NotFound(
+                sprintf(
+                    "%s with name '%s' could not be found",
+                    $type,
+                    $node->getName()
+                )
+            );
+        }
 
-		return $access;
-	}
+        return $access;
+    }
 
-	public function propFind(PropFind $propFind, INode $node) {
-		// If the node is neither readable nor writable then fail unless its of
-		// the standard user-principal
-		if(!($node instanceof User)) {
-			$path = $propFind->getPath();
-			$readPermissions = $this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, false);
-			$writePermissions = $this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, false);
-			if ($readPermissions === false && $writePermissions === false) {
-				$this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, true);
-				$this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, true);
-			}
-		}
+    public function propFind(PropFind $propFind, INode $node) {
+        // If the node is neither readable nor writable then fail unless its of
+        // the standard user-principal
+        if(!($node instanceof User)) {
+            $path = $propFind->getPath();
+            $readPermissions = $this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, false);
+            $writePermissions = $this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, false);
+            if ($readPermissions === false && $writePermissions === false) {
+                $this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, true);
+                $this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, true);
+            }
+        }
 
-		return parent::propFind($propFind, $node);
-	}
+        return parent::propFind($propFind, $node);
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -50,11 +50,11 @@ 
 
 	function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) {
 		$access = parent::checkPrivileges($uri, $privileges, $recursion, false);
-		if($access === false && $throwExceptions) {
+		if ($access === false && $throwExceptions) {
 			/** @var INode $node */
 			$node = $this->server->tree->getNodeForPath($uri);
 
-			switch(get_class($node)) {
+			switch (get_class($node)) {
 				case 'OCA\DAV\CardDAV\AddressBook':
 					$type = 'Addressbook';
 					break;
@@ -77,7 +77,7 @@ 
 	public function propFind(PropFind $propFind, INode $node) {
 		// If the node is neither readable nor writable then fail unless its of
 		// the standard user-principal
-		if(!($node instanceof User)) {
+		if (!($node instanceof User)) {
 			$path = $propFind->getPath();
 			$readPermissions = $this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, false);
 			$writePermissions = $this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, false);

lib/private/Files/Storage/Storage.php

Doc Comments +3 added lines

@@ -100,6 +100,7 @@ 
 	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
 	 * @param \OCP\Lock\ILockingProvider $provider
 	 * @throws \OCP\Lock\LockedException
+	 * @return void
 	 */
 	public function acquireLock($path, $type, ILockingProvider $provider);
 
@@ -108,6 +109,7 @@ 
 	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
 	 * @param \OCP\Lock\ILockingProvider $provider
 	 * @throws \OCP\Lock\LockedException
+	 * @return void
 	 */
 	public function releaseLock($path, $type, ILockingProvider $provider);
 
@@ -116,6 +118,7 @@ 
 	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
 	 * @param \OCP\Lock\ILockingProvider $provider
 	 * @throws \OCP\Lock\LockedException
+	 * @return void
 	 */
 	public function changeLock($path, $type, ILockingProvider $provider);
 }

Indentation +75 added lines, -75 removed lines

@@ -32,90 +32,90 @@
  */
 interface Storage extends \OCP\Files\Storage {
 
-	/**
-	 * get a cache instance for the storage
-	 *
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the cache
-	 * @return \OC\Files\Cache\Cache
-	 */
-	public function getCache($path = '', $storage = null);
+    /**
+     * get a cache instance for the storage
+     *
+     * @param string $path
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the cache
+     * @return \OC\Files\Cache\Cache
+     */
+    public function getCache($path = '', $storage = null);
 
-	/**
-	 * get a scanner instance for the storage
-	 *
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner
-	 * @return \OC\Files\Cache\Scanner
-	 */
-	public function getScanner($path = '', $storage = null);
+    /**
+     * get a scanner instance for the storage
+     *
+     * @param string $path
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner
+     * @return \OC\Files\Cache\Scanner
+     */
+    public function getScanner($path = '', $storage = null);
 
 
-	/**
-	 * get the user id of the owner of a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function getOwner($path);
+    /**
+     * get the user id of the owner of a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public function getOwner($path);
 
-	/**
-	 * get a watcher instance for the cache
-	 *
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
-	 * @return \OC\Files\Cache\Watcher
-	 */
-	public function getWatcher($path = '', $storage = null);
+    /**
+     * get a watcher instance for the cache
+     *
+     * @param string $path
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
+     * @return \OC\Files\Cache\Watcher
+     */
+    public function getWatcher($path = '', $storage = null);
 
-	/**
-	 * get a propagator instance for the cache
-	 *
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
-	 * @return \OC\Files\Cache\Propagator
-	 */
-	public function getPropagator($storage = null);
+    /**
+     * get a propagator instance for the cache
+     *
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
+     * @return \OC\Files\Cache\Propagator
+     */
+    public function getPropagator($storage = null);
 
-	/**
-	 * get a updater instance for the cache
-	 *
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
-	 * @return \OC\Files\Cache\Updater
-	 */
-	public function getUpdater($storage = null);
+    /**
+     * get a updater instance for the cache
+     *
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the watcher
+     * @return \OC\Files\Cache\Updater
+     */
+    public function getUpdater($storage = null);
 
-	/**
-	 * @return \OC\Files\Cache\Storage
-	 */
-	public function getStorageCache();
+    /**
+     * @return \OC\Files\Cache\Storage
+     */
+    public function getStorageCache();
 
-	/**
-	 * @param string $path
-	 * @return array
-	 */
-	public function getMetaData($path);
+    /**
+     * @param string $path
+     * @return array
+     */
+    public function getMetaData($path);
 
-	/**
-	 * @param string $path The path of the file to acquire the lock for
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function acquireLock($path, $type, ILockingProvider $provider);
+    /**
+     * @param string $path The path of the file to acquire the lock for
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     */
+    public function acquireLock($path, $type, ILockingProvider $provider);
 
-	/**
-	 * @param string $path The path of the file to release the lock for
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function releaseLock($path, $type, ILockingProvider $provider);
+    /**
+     * @param string $path The path of the file to release the lock for
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     */
+    public function releaseLock($path, $type, ILockingProvider $provider);
 
-	/**
-	 * @param string $path The path of the file to change the lock for
-	 * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
-	 * @param \OCP\Lock\ILockingProvider $provider
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function changeLock($path, $type, ILockingProvider $provider);
+    /**
+     * @param string $path The path of the file to change the lock for
+     * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
+     * @param \OCP\Lock\ILockingProvider $provider
+     * @throws \OCP\Lock\LockedException
+     */
+    public function changeLock($path, $type, ILockingProvider $provider);
 }

lib/private/AppFramework/DependencyInjection/DIContainer.php

Unused Use Statements -1 removed lines

@@ -46,7 +46,6 @@
 use OC\AppFramework\Utility\TimeFactory;
 use OC\Core\Middleware\TwoFactorMiddleware;
 use OC\RichObjectStrings\Validator;
-use OC\Security\Bruteforce\Throttler;
 use OCP\AppFramework\IApi;
 use OCP\AppFramework\IAppContainer;
 use OCP\Federation\ICloudIdManager;

Indentation +483 added lines, -483 removed lines

@@ -56,510 +56,510 @@
 
 class DIContainer extends SimpleContainer implements IAppContainer {
 
-	/**
-	 * @var array
-	 */
-	private $middleWares = array();
-
-	/**
-	 * Put your class dependencies in here
-	 * @param string $appName the name of the app
-	 */
-	public function __construct($appName, $urlParams = array()){
-		parent::__construct();
-		$this['AppName'] = $appName;
-		$this['urlParams'] = $urlParams;
-
-		/** @var \OC\ServerContainer $server */
-		$server = $this->getServer();
-		$server->registerAppContainer($appName, $this);
-
-		// aliases
-		$this->registerAlias('appName', 'AppName');
-		$this->registerAlias('webRoot', 'WebRoot');
-		$this->registerAlias('userId', 'UserId');
-
-		/**
-		 * Core services
-		 */
-		$this->registerService('OCP\\IAppConfig', function($c) {
-			return $this->getServer()->getAppConfig();
-		});
-
-		$this->registerService('OCP\\App\\IAppManager', function($c) {
-			return $this->getServer()->getAppManager();
-		});
-
-		$this->registerService('OCP\\AppFramework\\Http\\IOutput', function($c){
-			return new Output($this->getServer()->getWebRoot());
-		});
-
-		$this->registerService(\OCP\Authentication\LoginCredentials\IStore::class, function() {
-			return $this->getServer()->query(\OCP\Authentication\LoginCredentials\IStore::class);
-		});
-
-		$this->registerService('OCP\\IAvatarManager', function($c) {
-			return $this->getServer()->getAvatarManager();
-		});
-
-		$this->registerService('OCP\\Activity\\IManager', function($c) {
-			return $this->getServer()->getActivityManager();
-		});
-		$this->registerService(\OCP\Activity\IEventMerger::class, function($c) {
-			return $this->getServer()->query(\OCP\Activity\IEventMerger::class);
-		});
-
-		$this->registerService('OCP\\ICache', function($c) {
-			return $this->getServer()->getCache();
-		});
-
-		$this->registerService('OCP\\ICacheFactory', function($c) {
-			return $this->getServer()->getMemCacheFactory();
-		});
-
-		$this->registerService('OC\\CapabilitiesManager', function($c) {
-			return $this->getServer()->getCapabilitiesManager();
-		});
-
-		$this->registerService('OCP\Comments\ICommentsManager', function($c) {
-			return $this->getServer()->getCommentsManager();
-		});
-
-		$this->registerService('OCP\\IConfig', function($c) {
-			return $this->getServer()->getConfig();
-		});
-
-		$this->registerService('OCP\\Contacts\\IManager', function($c) {
-			return $this->getServer()->getContactsManager();
-		});
-
-		$this->registerService('OCP\\IDateTimeZone', function($c) {
-			return $this->getServer()->getDateTimeZone();
-		});
-
-		$this->registerService('OCP\\IDateTimeFormatter', function($c) {
-			return $this->getServer()->getDateTimeFormatter();
-		});
-
-		$this->registerService('OCP\\IDBConnection', function($c) {
-			return $this->getServer()->getDatabaseConnection();
-		});
-
-		$this->registerService('OCP\\Diagnostics\\IEventLogger', function($c) {
-			return $this->getServer()->getEventLogger();
-		});
-
-		$this->registerService('OCP\\Diagnostics\\IQueryLogger', function($c) {
-			return $this->getServer()->getQueryLogger();
-		});
-
-		$this->registerService(ICloudIdManager::class, function($c) {
-			return $this->getServer()->getCloudIdManager();
-		});
-
-		$this->registerService('OCP\\Files\\IMimeTypeDetector', function($c) {
-			return $this->getServer()->getMimeTypeDetector();
-		});
-
-		$this->registerService('OCP\\Files\\Config\\IMountProviderCollection', function($c) {
-			return $this->getServer()->getMountProviderCollection();
-		});
-
-		$this->registerService('OCP\\Files\\Config\\IUserMountCache', function($c) {
-			return $this->getServer()->getUserMountCache();
-		});
+    /**
+     * @var array
+     */
+    private $middleWares = array();
+
+    /**
+     * Put your class dependencies in here
+     * @param string $appName the name of the app
+     */
+    public function __construct($appName, $urlParams = array()){
+        parent::__construct();
+        $this['AppName'] = $appName;
+        $this['urlParams'] = $urlParams;
+
+        /** @var \OC\ServerContainer $server */
+        $server = $this->getServer();
+        $server->registerAppContainer($appName, $this);
+
+        // aliases
+        $this->registerAlias('appName', 'AppName');
+        $this->registerAlias('webRoot', 'WebRoot');
+        $this->registerAlias('userId', 'UserId');
+
+        /**
+         * Core services
+         */
+        $this->registerService('OCP\\IAppConfig', function($c) {
+            return $this->getServer()->getAppConfig();
+        });
+
+        $this->registerService('OCP\\App\\IAppManager', function($c) {
+            return $this->getServer()->getAppManager();
+        });
+
+        $this->registerService('OCP\\AppFramework\\Http\\IOutput', function($c){
+            return new Output($this->getServer()->getWebRoot());
+        });
+
+        $this->registerService(\OCP\Authentication\LoginCredentials\IStore::class, function() {
+            return $this->getServer()->query(\OCP\Authentication\LoginCredentials\IStore::class);
+        });
+
+        $this->registerService('OCP\\IAvatarManager', function($c) {
+            return $this->getServer()->getAvatarManager();
+        });
+
+        $this->registerService('OCP\\Activity\\IManager', function($c) {
+            return $this->getServer()->getActivityManager();
+        });
+        $this->registerService(\OCP\Activity\IEventMerger::class, function($c) {
+            return $this->getServer()->query(\OCP\Activity\IEventMerger::class);
+        });
+
+        $this->registerService('OCP\\ICache', function($c) {
+            return $this->getServer()->getCache();
+        });
+
+        $this->registerService('OCP\\ICacheFactory', function($c) {
+            return $this->getServer()->getMemCacheFactory();
+        });
+
+        $this->registerService('OC\\CapabilitiesManager', function($c) {
+            return $this->getServer()->getCapabilitiesManager();
+        });
+
+        $this->registerService('OCP\Comments\ICommentsManager', function($c) {
+            return $this->getServer()->getCommentsManager();
+        });
+
+        $this->registerService('OCP\\IConfig', function($c) {
+            return $this->getServer()->getConfig();
+        });
+
+        $this->registerService('OCP\\Contacts\\IManager', function($c) {
+            return $this->getServer()->getContactsManager();
+        });
+
+        $this->registerService('OCP\\IDateTimeZone', function($c) {
+            return $this->getServer()->getDateTimeZone();
+        });
+
+        $this->registerService('OCP\\IDateTimeFormatter', function($c) {
+            return $this->getServer()->getDateTimeFormatter();
+        });
+
+        $this->registerService('OCP\\IDBConnection', function($c) {
+            return $this->getServer()->getDatabaseConnection();
+        });
+
+        $this->registerService('OCP\\Diagnostics\\IEventLogger', function($c) {
+            return $this->getServer()->getEventLogger();
+        });
+
+        $this->registerService('OCP\\Diagnostics\\IQueryLogger', function($c) {
+            return $this->getServer()->getQueryLogger();
+        });
+
+        $this->registerService(ICloudIdManager::class, function($c) {
+            return $this->getServer()->getCloudIdManager();
+        });
+
+        $this->registerService('OCP\\Files\\IMimeTypeDetector', function($c) {
+            return $this->getServer()->getMimeTypeDetector();
+        });
+
+        $this->registerService('OCP\\Files\\Config\\IMountProviderCollection', function($c) {
+            return $this->getServer()->getMountProviderCollection();
+        });
+
+        $this->registerService('OCP\\Files\\Config\\IUserMountCache', function($c) {
+            return $this->getServer()->getUserMountCache();
+        });
 
-		$this->registerService('OCP\\Files\\IRootFolder', function($c) {
-			return $this->getServer()->getRootFolder();
-		});
+        $this->registerService('OCP\\Files\\IRootFolder', function($c) {
+            return $this->getServer()->getRootFolder();
+        });
 
-		$this->registerService('OCP\\Files\\Folder', function() {
-			return $this->getServer()->getUserFolder();
-		});
+        $this->registerService('OCP\\Files\\Folder', function() {
+            return $this->getServer()->getUserFolder();
+        });
 
-		$this->registerService('OCP\\Http\\Client\\IClientService', function($c) {
-			return $this->getServer()->getHTTPClientService();
-		});
+        $this->registerService('OCP\\Http\\Client\\IClientService', function($c) {
+            return $this->getServer()->getHTTPClientService();
+        });
 
-		$this->registerService(IAppData::class, function (SimpleContainer $c) {
-			return $this->getServer()->getAppDataDir($c->query('AppName'));
-		});
+        $this->registerService(IAppData::class, function (SimpleContainer $c) {
+            return $this->getServer()->getAppDataDir($c->query('AppName'));
+        });
 
-		$this->registerService('OCP\\IGroupManager', function($c) {
-			return $this->getServer()->getGroupManager();
-		});
+        $this->registerService('OCP\\IGroupManager', function($c) {
+            return $this->getServer()->getGroupManager();
+        });
 
-		$this->registerService('OCP\\Http\\Client\\IClientService', function() {
-			return $this->getServer()->getHTTPClientService();
-		});
+        $this->registerService('OCP\\Http\\Client\\IClientService', function() {
+            return $this->getServer()->getHTTPClientService();
+        });
 
-		$this->registerService('OCP\\IL10N', function($c) {
-			return $this->getServer()->getL10N($c->query('AppName'));
-		});
+        $this->registerService('OCP\\IL10N', function($c) {
+            return $this->getServer()->getL10N($c->query('AppName'));
+        });
 
-		$this->registerService('OCP\\L10N\\IFactory', function($c) {
-			return $this->getServer()->getL10NFactory();
-		});
+        $this->registerService('OCP\\L10N\\IFactory', function($c) {
+            return $this->getServer()->getL10NFactory();
+        });
 
-		$this->registerService('OCP\\ILogger', function($c) {
-			return $this->getServer()->getLogger();
-		});
+        $this->registerService('OCP\\ILogger', function($c) {
+            return $this->getServer()->getLogger();
+        });
 
-		$this->registerService('OCP\\BackgroundJob\\IJobList', function($c) {
-			return $this->getServer()->getJobList();
-		});
+        $this->registerService('OCP\\BackgroundJob\\IJobList', function($c) {
+            return $this->getServer()->getJobList();
+        });
 
-		$this->registerAlias('OCP\\AppFramework\\Utility\\IControllerMethodReflector', 'OC\AppFramework\Utility\ControllerMethodReflector');
-		$this->registerAlias('ControllerMethodReflector', 'OCP\\AppFramework\\Utility\\IControllerMethodReflector');
+        $this->registerAlias('OCP\\AppFramework\\Utility\\IControllerMethodReflector', 'OC\AppFramework\Utility\ControllerMethodReflector');
+        $this->registerAlias('ControllerMethodReflector', 'OCP\\AppFramework\\Utility\\IControllerMethodReflector');
 
-		$this->registerService('OCP\\Files\\IMimeTypeDetector', function($c) {
-			return $this->getServer()->getMimeTypeDetector();
-		});
+        $this->registerService('OCP\\Files\\IMimeTypeDetector', function($c) {
+            return $this->getServer()->getMimeTypeDetector();
+        });
 
-		$this->registerService('OCP\\Mail\\IMailer', function() {
-			return $this->getServer()->getMailer();
-		});
+        $this->registerService('OCP\\Mail\\IMailer', function() {
+            return $this->getServer()->getMailer();
+        });
 
-		$this->registerService('OCP\\INavigationManager', function($c) {
-			return $this->getServer()->getNavigationManager();
-		});
+        $this->registerService('OCP\\INavigationManager', function($c) {
+            return $this->getServer()->getNavigationManager();
+        });
 
-		$this->registerService('OCP\\Notification\IManager', function($c) {
-			return $this->getServer()->getNotificationManager();
-		});
+        $this->registerService('OCP\\Notification\IManager', function($c) {
+            return $this->getServer()->getNotificationManager();
+        });
 
-		$this->registerService('OCP\\IPreview', function($c) {
-			return $this->getServer()->getPreviewManager();
-		});
+        $this->registerService('OCP\\IPreview', function($c) {
+            return $this->getServer()->getPreviewManager();
+        });
 
-		$this->registerService('OCP\\IRequest', function () {
-			return $this->getServer()->getRequest();
-		});
-		$this->registerAlias('Request', 'OCP\\IRequest');
+        $this->registerService('OCP\\IRequest', function () {
+            return $this->getServer()->getRequest();
+        });
+        $this->registerAlias('Request', 'OCP\\IRequest');
 
-		$this->registerService('OCP\\ITagManager', function($c) {
-			return $this->getServer()->getTagManager();
-		});
+        $this->registerService('OCP\\ITagManager', function($c) {
+            return $this->getServer()->getTagManager();
+        });
 
-		$this->registerService('OCP\\ITempManager', function($c) {
-			return $this->getServer()->getTempManager();
-		});
+        $this->registerService('OCP\\ITempManager', function($c) {
+            return $this->getServer()->getTempManager();
+        });
 
-		$this->registerAlias('OCP\\AppFramework\\Utility\\ITimeFactory', 'OC\AppFramework\Utility\TimeFactory');
-		$this->registerAlias('TimeFactory', 'OCP\\AppFramework\\Utility\\ITimeFactory');
+        $this->registerAlias('OCP\\AppFramework\\Utility\\ITimeFactory', 'OC\AppFramework\Utility\TimeFactory');
+        $this->registerAlias('TimeFactory', 'OCP\\AppFramework\\Utility\\ITimeFactory');
 
 
-		$this->registerService('OCP\\Route\\IRouter', function($c) {
-			return $this->getServer()->getRouter();
-		});
-
-		$this->registerService('OCP\\ISearch', function($c) {
-			return $this->getServer()->getSearch();
-		});
+        $this->registerService('OCP\\Route\\IRouter', function($c) {
+            return $this->getServer()->getRouter();
+        });
+
+        $this->registerService('OCP\\ISearch', function($c) {
+            return $this->getServer()->getSearch();
+        });
 
-		$this->registerService('OCP\\ISearch', function($c) {
-			return $this->getServer()->getSearch();
-		});
-
-		$this->registerService('OCP\\Security\\ICrypto', function($c) {
-			return $this->getServer()->getCrypto();
-		});
-
-		$this->registerService('OCP\\Security\\IHasher', function($c) {
-			return $this->getServer()->getHasher();
-		});
-
-		$this->registerService('OCP\\Security\\ICredentialsManager', function($c) {
-			return $this->getServer()->getCredentialsManager();
-		});
-
-		$this->registerService('OCP\\Security\\ISecureRandom', function($c) {
-			return $this->getServer()->getSecureRandom();
-		});
-
-		$this->registerService('OCP\\Share\\IManager', function($c) {
-			return $this->getServer()->getShareManager();
-		});
-
-		$this->registerService('OCP\\SystemTag\\ISystemTagManager', function() {
-			return $this->getServer()->getSystemTagManager();
-		});
-
-		$this->registerService('OCP\\SystemTag\\ISystemTagObjectMapper', function() {
-			return $this->getServer()->getSystemTagObjectMapper();
-		});
-
-		$this->registerService('OCP\\IURLGenerator', function($c) {
-			return $this->getServer()->getURLGenerator();
-		});
-
-		$this->registerService('OCP\\IUserManager', function($c) {
-			return $this->getServer()->getUserManager();
-		});
-
-		$this->registerService('OCP\\IUserSession', function($c) {
-			return $this->getServer()->getUserSession();
-		});
-		$this->registerAlias(\OC\User\Session::class, \OCP\IUserSession::class);
-
-		$this->registerService('OCP\\ISession', function($c) {
-			return $this->getServer()->getSession();
-		});
-
-		$this->registerService('OCP\\Security\\IContentSecurityPolicyManager', function($c) {
-			return $this->getServer()->getContentSecurityPolicyManager();
-		});
-
-		$this->registerService('ServerContainer', function ($c) {
-			return $this->getServer();
-		});
-		$this->registerAlias('OCP\\IServerContainer', 'ServerContainer');
-
-		$this->registerService('Symfony\Component\EventDispatcher\EventDispatcherInterface', function ($c) {
-			return $this->getServer()->getEventDispatcher();
-		});
-
-		$this->registerService('OCP\WorkflowEngine\IManager', function ($c) {
-			return $c->query('OCA\WorkflowEngine\Manager');
-		});
-
-		$this->registerService('OCP\\AppFramework\\IAppContainer', function ($c) {
-			return $c;
-		});
-		$this->registerService(IMountManager::class, function () {
-			return $this->getServer()->getMountManager();
-		});
-
-		// commonly used attributes
-		$this->registerService('UserId', function ($c) {
-			return $c->query('OCP\\IUserSession')->getSession()->get('user_id');
-		});
-
-		$this->registerService('WebRoot', function ($c) {
-			return $c->query('ServerContainer')->getWebRoot();
-		});
-
-		$this->registerService('OCP\Encryption\IManager', function ($c) {
-			return $this->getServer()->getEncryptionManager();
-		});
-
-		$this->registerService(IValidator::class, function($c) {
-			return $c->query(Validator::class);
-		});
-
-		$this->registerService(\OC\Security\IdentityProof\Manager::class, function ($c) {
-			return new \OC\Security\IdentityProof\Manager(
-				$this->getServer()->getAppDataDir('identityproof'),
-				$this->getServer()->getCrypto()
-			);
-		});
-
-
-		/**
-		 * App Framework APIs
-		 */
-		$this->registerService('API', function($c){
-			$c->query('OCP\\ILogger')->debug(
-				'Accessing the API class is deprecated! Use the appropriate ' .
-				'services instead!'
-			);
-			return new API($c['AppName']);
-		});
-
-		$this->registerService('Protocol', function($c){
-			/** @var \OC\Server $server */
-			$server = $c->query('ServerContainer');
-			$protocol = $server->getRequest()->getHttpProtocol();
-			return new Http($_SERVER, $protocol);
-		});
-
-		$this->registerService('Dispatcher', function($c) {
-			return new Dispatcher(
-				$c['Protocol'],
-				$c['MiddlewareDispatcher'],
-				$c['ControllerMethodReflector'],
-				$c['Request']
-			);
-		});
-
-		/**
-		 * App Framework default arguments
-		 */
-		$this->registerParameter('corsMethods', 'PUT, POST, GET, DELETE, PATCH');
-		$this->registerParameter('corsAllowedHeaders', 'Authorization, Content-Type, Accept');
-		$this->registerParameter('corsMaxAge', 1728000);
-
-		/**
-		 * Middleware
-		 */
-		$app = $this;
-		$this->registerService('SecurityMiddleware', function($c) use ($app){
-			/** @var \OC\Server $server */
-			$server = $app->getServer();
-
-			return new SecurityMiddleware(
-				$c['Request'],
-				$c['ControllerMethodReflector'],
-				$server->getNavigationManager(),
-				$server->getURLGenerator(),
-				$server->getLogger(),
-				$server->getSession(),
-				$c['AppName'],
-				$app->isLoggedIn(),
-				$app->isAdminUser(),
-				$server->getContentSecurityPolicyManager(),
-				$server->getCsrfTokenManager(),
-				$server->getContentSecurityPolicyNonceManager(),
-				$server->getBruteForceThrottler()
-			);
-
-		});
-
-		$this->registerService('CORSMiddleware', function($c) {
-			return new CORSMiddleware(
-				$c['Request'],
-				$c['ControllerMethodReflector'],
-				$c['OCP\IUserSession'],
-				$c->getServer()->getBruteForceThrottler()
-			);
-		});
-
-		$this->registerService('SessionMiddleware', function($c) use ($app) {
-			return new SessionMiddleware(
-				$c['Request'],
-				$c['ControllerMethodReflector'],
-				$app->getServer()->getSession()
-			);
-		});
-
-		$this->registerService('TwoFactorMiddleware', function (SimpleContainer $c) use ($app) {
-			$twoFactorManager = $c->getServer()->getTwoFactorAuthManager();
-			$userSession = $app->getServer()->getUserSession();
-			$session = $app->getServer()->getSession();
-			$urlGenerator = $app->getServer()->getURLGenerator();
-			$reflector = $c['ControllerMethodReflector'];
-			$request = $app->getServer()->getRequest();
-			return new TwoFactorMiddleware($twoFactorManager, $userSession, $session, $urlGenerator, $reflector, $request);
-		});
-
-		$this->registerService('OCSMiddleware', function (SimpleContainer $c) {
-			return new OCSMiddleware(
-				$c['Request']
-			);
-		});
-
-		$middleWares = &$this->middleWares;
-		$this->registerService('MiddlewareDispatcher', function($c) use (&$middleWares) {
-			$dispatcher = new MiddlewareDispatcher();
-			$dispatcher->registerMiddleware($c['CORSMiddleware']);
-			$dispatcher->registerMiddleware($c['OCSMiddleware']);
-			$dispatcher->registerMiddleware($c['SecurityMiddleware']);
-			$dispatcher->registerMiddleWare($c['TwoFactorMiddleware']);
-
-			foreach($middleWares as $middleWare) {
-				$dispatcher->registerMiddleware($c[$middleWare]);
-			}
-
-			$dispatcher->registerMiddleware($c['SessionMiddleware']);
-			return $dispatcher;
-		});
-
-	}
-
-
-	/**
-	 * @deprecated implements only deprecated methods
-	 * @return IApi
-	 */
-	function getCoreApi()
-	{
-		return $this->query('API');
-	}
-
-	/**
-	 * @return \OCP\IServerContainer
-	 */
-	function getServer()
-	{
-		return OC::$server;
-	}
-
-	/**
-	 * @param string $middleWare
-	 * @return boolean|null
-	 */
-	function registerMiddleWare($middleWare) {
-		array_push($this->middleWares, $middleWare);
-	}
-
-	/**
-	 * used to return the appname of the set application
-	 * @return string the name of your application
-	 */
-	function getAppName() {
-		return $this->query('AppName');
-	}
-
-	/**
-	 * @deprecated use IUserSession->isLoggedIn()
-	 * @return boolean
-	 */
-	function isLoggedIn() {
-		return \OC_User::isLoggedIn();
-	}
-
-	/**
-	 * @deprecated use IGroupManager->isAdmin($userId)
-	 * @return boolean
-	 */
-	function isAdminUser() {
-		$uid = $this->getUserId();
-		return \OC_User::isAdminUser($uid);
-	}
-
-	private function getUserId() {
-		return $this->getServer()->getSession()->get('user_id');
-	}
-
-	/**
-	 * @deprecated use the ILogger instead
-	 * @param string $message
-	 * @param string $level
-	 * @return mixed
-	 */
-	function log($message, $level) {
-		switch($level){
-			case 'debug':
-				$level = \OCP\Util::DEBUG;
-				break;
-			case 'info':
-				$level = \OCP\Util::INFO;
-				break;
-			case 'warn':
-				$level = \OCP\Util::WARN;
-				break;
-			case 'fatal':
-				$level = \OCP\Util::FATAL;
-				break;
-			default:
-				$level = \OCP\Util::ERROR;
-				break;
-		}
-		\OCP\Util::writeLog($this->getAppName(), $message, $level);
-	}
-
-	/**
-	 * Register a capability
-	 *
-	 * @param string $serviceName e.g. 'OCA\Files\Capabilities'
-	 */
-	public function registerCapability($serviceName) {
-		$this->query('OC\CapabilitiesManager')->registerCapability(function() use ($serviceName) {
-			return $this->query($serviceName);
-		});
-	}
-
-	public function query($name) {
-		return parent::query($name);
-	}
+        $this->registerService('OCP\\ISearch', function($c) {
+            return $this->getServer()->getSearch();
+        });
+
+        $this->registerService('OCP\\Security\\ICrypto', function($c) {
+            return $this->getServer()->getCrypto();
+        });
+
+        $this->registerService('OCP\\Security\\IHasher', function($c) {
+            return $this->getServer()->getHasher();
+        });
+
+        $this->registerService('OCP\\Security\\ICredentialsManager', function($c) {
+            return $this->getServer()->getCredentialsManager();
+        });
+
+        $this->registerService('OCP\\Security\\ISecureRandom', function($c) {
+            return $this->getServer()->getSecureRandom();
+        });
+
+        $this->registerService('OCP\\Share\\IManager', function($c) {
+            return $this->getServer()->getShareManager();
+        });
+
+        $this->registerService('OCP\\SystemTag\\ISystemTagManager', function() {
+            return $this->getServer()->getSystemTagManager();
+        });
+
+        $this->registerService('OCP\\SystemTag\\ISystemTagObjectMapper', function() {
+            return $this->getServer()->getSystemTagObjectMapper();
+        });
+
+        $this->registerService('OCP\\IURLGenerator', function($c) {
+            return $this->getServer()->getURLGenerator();
+        });
+
+        $this->registerService('OCP\\IUserManager', function($c) {
+            return $this->getServer()->getUserManager();
+        });
+
+        $this->registerService('OCP\\IUserSession', function($c) {
+            return $this->getServer()->getUserSession();
+        });
+        $this->registerAlias(\OC\User\Session::class, \OCP\IUserSession::class);
+
+        $this->registerService('OCP\\ISession', function($c) {
+            return $this->getServer()->getSession();
+        });
+
+        $this->registerService('OCP\\Security\\IContentSecurityPolicyManager', function($c) {
+            return $this->getServer()->getContentSecurityPolicyManager();
+        });
+
+        $this->registerService('ServerContainer', function ($c) {
+            return $this->getServer();
+        });
+        $this->registerAlias('OCP\\IServerContainer', 'ServerContainer');
+
+        $this->registerService('Symfony\Component\EventDispatcher\EventDispatcherInterface', function ($c) {
+            return $this->getServer()->getEventDispatcher();
+        });
+
+        $this->registerService('OCP\WorkflowEngine\IManager', function ($c) {
+            return $c->query('OCA\WorkflowEngine\Manager');
+        });
+
+        $this->registerService('OCP\\AppFramework\\IAppContainer', function ($c) {
+            return $c;
+        });
+        $this->registerService(IMountManager::class, function () {
+            return $this->getServer()->getMountManager();
+        });
+
+        // commonly used attributes
+        $this->registerService('UserId', function ($c) {
+            return $c->query('OCP\\IUserSession')->getSession()->get('user_id');
+        });
+
+        $this->registerService('WebRoot', function ($c) {
+            return $c->query('ServerContainer')->getWebRoot();
+        });
+
+        $this->registerService('OCP\Encryption\IManager', function ($c) {
+            return $this->getServer()->getEncryptionManager();
+        });
+
+        $this->registerService(IValidator::class, function($c) {
+            return $c->query(Validator::class);
+        });
+
+        $this->registerService(\OC\Security\IdentityProof\Manager::class, function ($c) {
+            return new \OC\Security\IdentityProof\Manager(
+                $this->getServer()->getAppDataDir('identityproof'),
+                $this->getServer()->getCrypto()
+            );
+        });
+
+
+        /**
+         * App Framework APIs
+         */
+        $this->registerService('API', function($c){
+            $c->query('OCP\\ILogger')->debug(
+                'Accessing the API class is deprecated! Use the appropriate ' .
+                'services instead!'
+            );
+            return new API($c['AppName']);
+        });
+
+        $this->registerService('Protocol', function($c){
+            /** @var \OC\Server $server */
+            $server = $c->query('ServerContainer');
+            $protocol = $server->getRequest()->getHttpProtocol();
+            return new Http($_SERVER, $protocol);
+        });
+
+        $this->registerService('Dispatcher', function($c) {
+            return new Dispatcher(
+                $c['Protocol'],
+                $c['MiddlewareDispatcher'],
+                $c['ControllerMethodReflector'],
+                $c['Request']
+            );
+        });
+
+        /**
+         * App Framework default arguments
+         */
+        $this->registerParameter('corsMethods', 'PUT, POST, GET, DELETE, PATCH');
+        $this->registerParameter('corsAllowedHeaders', 'Authorization, Content-Type, Accept');
+        $this->registerParameter('corsMaxAge', 1728000);
+
+        /**
+         * Middleware
+         */
+        $app = $this;
+        $this->registerService('SecurityMiddleware', function($c) use ($app){
+            /** @var \OC\Server $server */
+            $server = $app->getServer();
+
+            return new SecurityMiddleware(
+                $c['Request'],
+                $c['ControllerMethodReflector'],
+                $server->getNavigationManager(),
+                $server->getURLGenerator(),
+                $server->getLogger(),
+                $server->getSession(),
+                $c['AppName'],
+                $app->isLoggedIn(),
+                $app->isAdminUser(),
+                $server->getContentSecurityPolicyManager(),
+                $server->getCsrfTokenManager(),
+                $server->getContentSecurityPolicyNonceManager(),
+                $server->getBruteForceThrottler()
+            );
+
+        });
+
+        $this->registerService('CORSMiddleware', function($c) {
+            return new CORSMiddleware(
+                $c['Request'],
+                $c['ControllerMethodReflector'],
+                $c['OCP\IUserSession'],
+                $c->getServer()->getBruteForceThrottler()
+            );
+        });
+
+        $this->registerService('SessionMiddleware', function($c) use ($app) {
+            return new SessionMiddleware(
+                $c['Request'],
+                $c['ControllerMethodReflector'],
+                $app->getServer()->getSession()
+            );
+        });
+
+        $this->registerService('TwoFactorMiddleware', function (SimpleContainer $c) use ($app) {
+            $twoFactorManager = $c->getServer()->getTwoFactorAuthManager();
+            $userSession = $app->getServer()->getUserSession();
+            $session = $app->getServer()->getSession();
+            $urlGenerator = $app->getServer()->getURLGenerator();
+            $reflector = $c['ControllerMethodReflector'];
+            $request = $app->getServer()->getRequest();
+            return new TwoFactorMiddleware($twoFactorManager, $userSession, $session, $urlGenerator, $reflector, $request);
+        });
+
+        $this->registerService('OCSMiddleware', function (SimpleContainer $c) {
+            return new OCSMiddleware(
+                $c['Request']
+            );
+        });
+
+        $middleWares = &$this->middleWares;
+        $this->registerService('MiddlewareDispatcher', function($c) use (&$middleWares) {
+            $dispatcher = new MiddlewareDispatcher();
+            $dispatcher->registerMiddleware($c['CORSMiddleware']);
+            $dispatcher->registerMiddleware($c['OCSMiddleware']);
+            $dispatcher->registerMiddleware($c['SecurityMiddleware']);
+            $dispatcher->registerMiddleWare($c['TwoFactorMiddleware']);
+
+            foreach($middleWares as $middleWare) {
+                $dispatcher->registerMiddleware($c[$middleWare]);
+            }
+
+            $dispatcher->registerMiddleware($c['SessionMiddleware']);
+            return $dispatcher;
+        });
+
+    }
+
+
+    /**
+     * @deprecated implements only deprecated methods
+     * @return IApi
+     */
+    function getCoreApi()
+    {
+        return $this->query('API');
+    }
+
+    /**
+     * @return \OCP\IServerContainer
+     */
+    function getServer()
+    {
+        return OC::$server;
+    }
+
+    /**
+     * @param string $middleWare
+     * @return boolean|null
+     */
+    function registerMiddleWare($middleWare) {
+        array_push($this->middleWares, $middleWare);
+    }
+
+    /**
+     * used to return the appname of the set application
+     * @return string the name of your application
+     */
+    function getAppName() {
+        return $this->query('AppName');
+    }
+
+    /**
+     * @deprecated use IUserSession->isLoggedIn()
+     * @return boolean
+     */
+    function isLoggedIn() {
+        return \OC_User::isLoggedIn();
+    }
+
+    /**
+     * @deprecated use IGroupManager->isAdmin($userId)
+     * @return boolean
+     */
+    function isAdminUser() {
+        $uid = $this->getUserId();
+        return \OC_User::isAdminUser($uid);
+    }
+
+    private function getUserId() {
+        return $this->getServer()->getSession()->get('user_id');
+    }
+
+    /**
+     * @deprecated use the ILogger instead
+     * @param string $message
+     * @param string $level
+     * @return mixed
+     */
+    function log($message, $level) {
+        switch($level){
+            case 'debug':
+                $level = \OCP\Util::DEBUG;
+                break;
+            case 'info':
+                $level = \OCP\Util::INFO;
+                break;
+            case 'warn':
+                $level = \OCP\Util::WARN;
+                break;
+            case 'fatal':
+                $level = \OCP\Util::FATAL;
+                break;
+            default:
+                $level = \OCP\Util::ERROR;
+                break;
+        }
+        \OCP\Util::writeLog($this->getAppName(), $message, $level);
+    }
+
+    /**
+     * Register a capability
+     *
+     * @param string $serviceName e.g. 'OCA\Files\Capabilities'
+     */
+    public function registerCapability($serviceName) {
+        $this->query('OC\CapabilitiesManager')->registerCapability(function() use ($serviceName) {
+            return $this->query($serviceName);
+        });
+    }
+
+    public function query($name) {
+        return parent::query($name);
+    }
 }

Spacing +20 added lines, -20 removed lines

@@ -65,7 +65,7 @@ 
 	 * Put your class dependencies in here
 	 * @param string $appName the name of the app
 	 */
-	public function __construct($appName, $urlParams = array()){
+	public function __construct($appName, $urlParams = array()) {
 		parent::__construct();
 		$this['AppName'] = $appName;
 		$this['urlParams'] = $urlParams;
@@ -90,7 +90,7 @@ 
 			return $this->getServer()->getAppManager();
 		});
 
-		$this->registerService('OCP\\AppFramework\\Http\\IOutput', function($c){
+		$this->registerService('OCP\\AppFramework\\Http\\IOutput', function($c) {
 			return new Output($this->getServer()->getWebRoot());
 		});
 
@@ -181,7 +181,7 @@ 
 			return $this->getServer()->getHTTPClientService();
 		});
 
-		$this->registerService(IAppData::class, function (SimpleContainer $c) {
+		$this->registerService(IAppData::class, function(SimpleContainer $c) {
 			return $this->getServer()->getAppDataDir($c->query('AppName'));
 		});
 
@@ -232,7 +232,7 @@ 
 			return $this->getServer()->getPreviewManager();
 		});
 
-		$this->registerService('OCP\\IRequest', function () {
+		$this->registerService('OCP\\IRequest', function() {
 			return $this->getServer()->getRequest();
 		});
 		$this->registerAlias('Request', 'OCP\\IRequest');
@@ -310,36 +310,36 @@ 
 			return $this->getServer()->getContentSecurityPolicyManager();
 		});
 
-		$this->registerService('ServerContainer', function ($c) {
+		$this->registerService('ServerContainer', function($c) {
 			return $this->getServer();
 		});
 		$this->registerAlias('OCP\\IServerContainer', 'ServerContainer');
 
-		$this->registerService('Symfony\Component\EventDispatcher\EventDispatcherInterface', function ($c) {
+		$this->registerService('Symfony\Component\EventDispatcher\EventDispatcherInterface', function($c) {
 			return $this->getServer()->getEventDispatcher();
 		});
 
-		$this->registerService('OCP\WorkflowEngine\IManager', function ($c) {
+		$this->registerService('OCP\WorkflowEngine\IManager', function($c) {
 			return $c->query('OCA\WorkflowEngine\Manager');
 		});
 
-		$this->registerService('OCP\\AppFramework\\IAppContainer', function ($c) {
+		$this->registerService('OCP\\AppFramework\\IAppContainer', function($c) {
 			return $c;
 		});
-		$this->registerService(IMountManager::class, function () {
+		$this->registerService(IMountManager::class, function() {
 			return $this->getServer()->getMountManager();
 		});
 
 		// commonly used attributes
-		$this->registerService('UserId', function ($c) {
+		$this->registerService('UserId', function($c) {
 			return $c->query('OCP\\IUserSession')->getSession()->get('user_id');
 		});
 
-		$this->registerService('WebRoot', function ($c) {
+		$this->registerService('WebRoot', function($c) {
 			return $c->query('ServerContainer')->getWebRoot();
 		});
 
-		$this->registerService('OCP\Encryption\IManager', function ($c) {
+		$this->registerService('OCP\Encryption\IManager', function($c) {
 			return $this->getServer()->getEncryptionManager();
 		});
 
@@ -347,7 +347,7 @@ 
 			return $c->query(Validator::class);
 		});
 
-		$this->registerService(\OC\Security\IdentityProof\Manager::class, function ($c) {
+		$this->registerService(\OC\Security\IdentityProof\Manager::class, function($c) {
 			return new \OC\Security\IdentityProof\Manager(
 				$this->getServer()->getAppDataDir('identityproof'),
 				$this->getServer()->getCrypto()
@@ -358,15 +358,15 @@ 
 		/**
 		 * App Framework APIs
 		 */
-		$this->registerService('API', function($c){
+		$this->registerService('API', function($c) {
 			$c->query('OCP\\ILogger')->debug(
-				'Accessing the API class is deprecated! Use the appropriate ' .
+				'Accessing the API class is deprecated! Use the appropriate '.
 				'services instead!'
 			);
 			return new API($c['AppName']);
 		});
 
-		$this->registerService('Protocol', function($c){
+		$this->registerService('Protocol', function($c) {
 			/** @var \OC\Server $server */
 			$server = $c->query('ServerContainer');
 			$protocol = $server->getRequest()->getHttpProtocol();
@@ -432,7 +432,7 @@ 
 			);
 		});
 
-		$this->registerService('TwoFactorMiddleware', function (SimpleContainer $c) use ($app) {
+		$this->registerService('TwoFactorMiddleware', function(SimpleContainer $c) use ($app) {
 			$twoFactorManager = $c->getServer()->getTwoFactorAuthManager();
 			$userSession = $app->getServer()->getUserSession();
 			$session = $app->getServer()->getSession();
@@ -442,7 +442,7 @@ 
 			return new TwoFactorMiddleware($twoFactorManager, $userSession, $session, $urlGenerator, $reflector, $request);
 		});
 
-		$this->registerService('OCSMiddleware', function (SimpleContainer $c) {
+		$this->registerService('OCSMiddleware', function(SimpleContainer $c) {
 			return new OCSMiddleware(
 				$c['Request']
 			);
@@ -456,7 +456,7 @@ 
 			$dispatcher->registerMiddleware($c['SecurityMiddleware']);
 			$dispatcher->registerMiddleWare($c['TwoFactorMiddleware']);
 
-			foreach($middleWares as $middleWare) {
+			foreach ($middleWares as $middleWare) {
 				$dispatcher->registerMiddleware($c[$middleWare]);
 			}
 
@@ -528,7 +528,7 @@ 
 	 * @return mixed
 	 */
 	function log($message, $level) {
-		switch($level){
+		switch ($level) {
 			case 'debug':
 				$level = \OCP\Util::DEBUG;
 				break;

apps/dav/lib/CardDAV/CardDavBackend.php

Doc Comments +11 added lines, -3 removed lines

@@ -104,7 +104,7 @@ 
 	/**
 	 * Return the number of address books for a principal
 	 *
-	 * @param $principalUri
+	 * @param string $principalUri
 	 * @return int
 	 */
 	public function getAddressBooksForUserCount($principalUri) {
@@ -195,6 +195,9 @@ 
 		return array_values($addressBooks);
 	}
 
+	/**
+	 * @param string $principalUri
+	 */
 	public function getUsersOwnAddressBooks($principalUri) {
 		$principalUriOriginal = $principalUri;
 		$principalUri = $this->convertPrincipal($principalUri, true);
@@ -264,7 +267,8 @@ 
 	}
 
 	/**
-	 * @param $addressBookUri
+	 * @param string $addressBookUri
+	 * @param string $principal
 	 * @return array|null
 	 */
 	public function getAddressBooksByUri($principal, $addressBookUri) {
@@ -953,6 +957,7 @@ 
 	 *   * readOnly - boolean
 	 *   * summary - Optional, a description for the share
 	 *
+	 * @param integer $addressBookId
 	 * @return array
 	 */
 	public function getShares($addressBookId) {
@@ -1052,7 +1057,7 @@ 
 
 	/**
 	 * For shared address books the sharee is set in the ACL of the address book
-	 * @param $addressBookId
+	 * @param integer $addressBookId
 	 * @param $acl
 	 * @return array
 	 */
@@ -1060,6 +1065,9 @@ 
 		return $this->sharingBackend->applyShareAcl($addressBookId, $acl);
 	}
 
+	/**
+	 * @param boolean $toV2
+	 */
 	private function convertPrincipal($principalUri, $toV2) {
 		if ($this->principalBackend->getPrincipalPrefix() === 'principals') {
 			list(, $name) = URLUtil::splitPath($principalUri);

Indentation +1022 added lines, -1022 removed lines

@@ -48,1026 +48,1026 @@
 
 class CardDavBackend implements BackendInterface, SyncSupport {
 
-	const PERSONAL_ADDRESSBOOK_URI = 'contacts';
-	const PERSONAL_ADDRESSBOOK_NAME = 'Contacts';
-
-	/** @var Principal */
-	private $principalBackend;
-
-	/** @var string */
-	private $dbCardsTable = 'cards';
-
-	/** @var string */
-	private $dbCardsPropertiesTable = 'cards_properties';
-
-	/** @var IDBConnection */
-	private $db;
-
-	/** @var Backend */
-	private $sharingBackend;
-
-	/** @var array properties to index */
-	public static $indexProperties = array(
-			'BDAY', 'UID', 'N', 'FN', 'TITLE', 'ROLE', 'NOTE', 'NICKNAME',
-			'ORG', 'CATEGORIES', 'EMAIL', 'TEL', 'IMPP', 'ADR', 'URL', 'GEO', 'CLOUD');
-
-	/**
-	 * @var string[] Map of uid => display name
-	 */
-	protected $userDisplayNames;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var EventDispatcherInterface */
-	private $dispatcher;
-
-	/**
-	 * CardDavBackend constructor.
-	 *
-	 * @param IDBConnection $db
-	 * @param Principal $principalBackend
-	 * @param IUserManager $userManager
-	 * @param EventDispatcherInterface $dispatcher
-	 */
-	public function __construct(IDBConnection $db,
-								Principal $principalBackend,
-								IUserManager $userManager,
-								EventDispatcherInterface $dispatcher = null) {
-		$this->db = $db;
-		$this->principalBackend = $principalBackend;
-		$this->userManager = $userManager;
-		$this->dispatcher = $dispatcher;
-		$this->sharingBackend = new Backend($this->db, $principalBackend, 'addressbook');
-	}
-
-	/**
-	 * Return the number of address books for a principal
-	 *
-	 * @param $principalUri
-	 * @return int
-	 */
-	public function getAddressBooksForUserCount($principalUri) {
-		$principalUri = $this->convertPrincipal($principalUri, true);
-		$query = $this->db->getQueryBuilder();
-		$query->select($query->createFunction('COUNT(*)'))
-			->from('addressbooks')
-			->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
-
-		return (int)$query->execute()->fetchColumn();
-	}
-
-	/**
-	 * Returns the list of address books for a specific user.
-	 *
-	 * Every addressbook should have the following properties:
-	 *   id - an arbitrary unique id
-	 *   uri - the 'basename' part of the url
-	 *   principaluri - Same as the passed parameter
-	 *
-	 * Any additional clark-notation property may be passed besides this. Some
-	 * common ones are :
-	 *   {DAV:}displayname
-	 *   {urn:ietf:params:xml:ns:carddav}addressbook-description
-	 *   {http://calendarserver.org/ns/}getctag
-	 *
-	 * @param string $principalUri
-	 * @return array
-	 */
-	function getAddressBooksForUser($principalUri) {
-		$principalUriOriginal = $principalUri;
-		$principalUri = $this->convertPrincipal($principalUri, true);
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			->from('addressbooks')
-			->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
-
-		$addressBooks = [];
-
-		$result = $query->execute();
-		while($row = $result->fetch()) {
-			$addressBooks[$row['id']] = [
-				'id'  => $row['id'],
-				'uri' => $row['uri'],
-				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
-				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-			];
-		}
-		$result->closeCursor();
-
-		// query for shared calendars
-		$principals = $this->principalBackend->getGroupMembership($principalUriOriginal, true);
-		$principals[]= $principalUri;
-
-		$query = $this->db->getQueryBuilder();
-		$result = $query->select(['a.id', 'a.uri', 'a.displayname', 'a.principaluri', 'a.description', 'a.synctoken', 's.access'])
-			->from('dav_shares', 's')
-			->join('s', 'addressbooks', 'a', $query->expr()->eq('s.resourceid', 'a.id'))
-			->where($query->expr()->in('s.principaluri', $query->createParameter('principaluri')))
-			->andWhere($query->expr()->eq('s.type', $query->createParameter('type')))
-			->setParameter('type', 'addressbook')
-			->setParameter('principaluri', $principals, IQueryBuilder::PARAM_STR_ARRAY)
-			->execute();
-
-		while($row = $result->fetch()) {
-			list(, $name) = URLUtil::splitPath($row['principaluri']);
-			$uri = $row['uri'] . '_shared_by_' . $name;
-			$displayName = $row['displayname'] . ' (' . $this->getUserDisplayName($name) . ')';
-			if (!isset($addressBooks[$row['id']])) {
-				$addressBooks[$row['id']] = [
-					'id'  => $row['id'],
-					'uri' => $uri,
-					'principaluri' => $principalUri,
-					'{DAV:}displayname' => $displayName,
-					'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-					'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-					'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-					'{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal' => $row['principaluri'],
-					'{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}read-only' => (int)$row['access'] === Backend::ACCESS_READ,
-				];
-			}
-		}
-		$result->closeCursor();
-
-		return array_values($addressBooks);
-	}
-
-	public function getUsersOwnAddressBooks($principalUri) {
-		$principalUriOriginal = $principalUri;
-		$principalUri = $this->convertPrincipal($principalUri, true);
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			  ->from('addressbooks')
-			  ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
-
-		$addressBooks = [];
-
-		$result = $query->execute();
-		while($row = $result->fetch()) {
-			$addressBooks[$row['id']] = [
-				'id'  => $row['id'],
-				'uri' => $row['uri'],
-				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
-				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-			];
-		}
-		$result->closeCursor();
-
-		return array_values($addressBooks);
-	}
-
-	private function getUserDisplayName($uid) {
-		if (!isset($this->userDisplayNames[$uid])) {
-			$user = $this->userManager->get($uid);
-
-			if ($user instanceof IUser) {
-				$this->userDisplayNames[$uid] = $user->getDisplayName();
-			} else {
-				$this->userDisplayNames[$uid] = $uid;
-			}
-		}
-
-		return $this->userDisplayNames[$uid];
-	}
-
-	/**
-	 * @param int $addressBookId
-	 */
-	public function getAddressBookById($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			->from('addressbooks')
-			->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-		$row = $result->fetch();
-		$result->closeCursor();
-		if ($row === false) {
-			return null;
-		}
-
-		return [
-			'id'  => $row['id'],
-			'uri' => $row['uri'],
-			'principaluri' => $row['principaluri'],
-			'{DAV:}displayname' => $row['displayname'],
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-			'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-			'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-		];
-	}
-
-	/**
-	 * @param $addressBookUri
-	 * @return array|null
-	 */
-	public function getAddressBooksByUri($principal, $addressBookUri) {
-		$query = $this->db->getQueryBuilder();
-		$result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			->from('addressbooks')
-			->where($query->expr()->eq('uri', $query->createNamedParameter($addressBookUri)))
-			->andWhere($query->expr()->eq('principaluri', $query->createNamedParameter($principal)))
-			->setMaxResults(1)
-			->execute();
-
-		$row = $result->fetch();
-		$result->closeCursor();
-		if ($row === false) {
-			return null;
-		}
-
-		return [
-				'id'  => $row['id'],
-				'uri' => $row['uri'],
-				'principaluri' => $row['principaluri'],
-				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-			];
-	}
-
-	/**
-	 * Updates properties for an address book.
-	 *
-	 * The list of mutations is stored in a Sabre\DAV\PropPatch object.
-	 * To do the actual updates, you must tell this object which properties
-	 * you're going to process with the handle() method.
-	 *
-	 * Calling the handle method is like telling the PropPatch object "I
-	 * promise I can handle updating this property".
-	 *
-	 * Read the PropPatch documentation for more info and examples.
-	 *
-	 * @param string $addressBookId
-	 * @param \Sabre\DAV\PropPatch $propPatch
-	 * @return void
-	 */
-	function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
-		$supportedProperties = [
-			'{DAV:}displayname',
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description',
-		];
-
-		$propPatch->handle($supportedProperties, function($mutations) use ($addressBookId) {
-
-			$updates = [];
-			foreach($mutations as $property=>$newValue) {
-
-				switch($property) {
-					case '{DAV:}displayname' :
-						$updates['displayname'] = $newValue;
-						break;
-					case '{' . Plugin::NS_CARDDAV . '}addressbook-description' :
-						$updates['description'] = $newValue;
-						break;
-				}
-			}
-			$query = $this->db->getQueryBuilder();
-			$query->update('addressbooks');
-
-			foreach($updates as $key=>$value) {
-				$query->set($key, $query->createNamedParameter($value));
-			}
-			$query->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-			$this->addChange($addressBookId, "", 2);
-
-			return true;
-
-		});
-	}
-
-	/**
-	 * Creates a new address book
-	 *
-	 * @param string $principalUri
-	 * @param string $url Just the 'basename' of the url.
-	 * @param array $properties
-	 * @return int
-	 * @throws BadRequest
-	 */
-	function createAddressBook($principalUri, $url, array $properties) {
-		$values = [
-			'displayname' => null,
-			'description' => null,
-			'principaluri' => $principalUri,
-			'uri' => $url,
-			'synctoken' => 1
-		];
-
-		foreach($properties as $property=>$newValue) {
-
-			switch($property) {
-				case '{DAV:}displayname' :
-					$values['displayname'] = $newValue;
-					break;
-				case '{' . Plugin::NS_CARDDAV . '}addressbook-description' :
-					$values['description'] = $newValue;
-					break;
-				default :
-					throw new BadRequest('Unknown property: ' . $property);
-			}
-
-		}
-
-		// Fallback to make sure the displayname is set. Some clients may refuse
-		// to work with addressbooks not having a displayname.
-		if(is_null($values['displayname'])) {
-			$values['displayname'] = $url;
-		}
-
-		$query = $this->db->getQueryBuilder();
-		$query->insert('addressbooks')
-			->values([
-				'uri' => $query->createParameter('uri'),
-				'displayname' => $query->createParameter('displayname'),
-				'description' => $query->createParameter('description'),
-				'principaluri' => $query->createParameter('principaluri'),
-				'synctoken' => $query->createParameter('synctoken'),
-			])
-			->setParameters($values)
-			->execute();
-
-		return $query->getLastInsertId();
-	}
-
-	/**
-	 * Deletes an entire addressbook and all its contents
-	 *
-	 * @param mixed $addressBookId
-	 * @return void
-	 */
-	function deleteAddressBook($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$query->delete('cards')
-			->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
-			->setParameter('addressbookid', $addressBookId)
-			->execute();
-
-		$query->delete('addressbookchanges')
-			->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
-			->setParameter('addressbookid', $addressBookId)
-			->execute();
-
-		$query->delete('addressbooks')
-			->where($query->expr()->eq('id', $query->createParameter('id')))
-			->setParameter('id', $addressBookId)
-			->execute();
-
-		$this->sharingBackend->deleteAllShares($addressBookId);
-
-		$query->delete($this->dbCardsPropertiesTable)
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-	}
-
-	/**
-	 * Returns all cards for a specific addressbook id.
-	 *
-	 * This method should return the following properties for each card:
-	 *   * carddata - raw vcard data
-	 *   * uri - Some unique url
-	 *   * lastmodified - A unix timestamp
-	 *
-	 * It's recommended to also return the following properties:
-	 *   * etag - A unique etag. This must change every time the card changes.
-	 *   * size - The size of the card in bytes.
-	 *
-	 * If these last two properties are provided, less time will be spent
-	 * calculating them. If they are specified, you can also ommit carddata.
-	 * This may speed up certain requests, especially with large cards.
-	 *
-	 * @param mixed $addressBookId
-	 * @return array
-	 */
-	function getCards($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata'])
-			->from('cards')
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-
-		$cards = [];
-
-		$result = $query->execute();
-		while($row = $result->fetch()) {
-			$row['etag'] = '"' . $row['etag'] . '"';
-			$row['carddata'] = $this->readBlob($row['carddata']);
-			$cards[] = $row;
-		}
-		$result->closeCursor();
-
-		return $cards;
-	}
-
-	/**
-	 * Returns a specific card.
-	 *
-	 * The same set of properties must be returned as with getCards. The only
-	 * exception is that 'carddata' is absolutely required.
-	 *
-	 * If the card does not exist, you must return false.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @return array
-	 */
-	function getCard($addressBookId, $cardUri) {
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata'])
-			->from('cards')
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
-			->setMaxResults(1);
-
-		$result = $query->execute();
-		$row = $result->fetch();
-		if (!$row) {
-			return false;
-		}
-		$row['etag'] = '"' . $row['etag'] . '"';
-		$row['carddata'] = $this->readBlob($row['carddata']);
-
-		return $row;
-	}
-
-	/**
-	 * Returns a list of cards.
-	 *
-	 * This method should work identical to getCard, but instead return all the
-	 * cards in the list as an array.
-	 *
-	 * If the backend supports this, it may allow for some speed-ups.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string[] $uris
-	 * @return array
-	 */
-	function getMultipleCards($addressBookId, array $uris) {
-		if (empty($uris)) {
-			return [];
-		}
-
-		$chunks = array_chunk($uris, 100);
-		$cards = [];
-
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata'])
-			->from('cards')
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->andWhere($query->expr()->in('uri', $query->createParameter('uri')));
-
-		foreach ($chunks as $uris) {
-			$query->setParameter('uri', $uris, IQueryBuilder::PARAM_STR_ARRAY);
-			$result = $query->execute();
-
-			while ($row = $result->fetch()) {
-				$row['etag'] = '"' . $row['etag'] . '"';
-				$row['carddata'] = $this->readBlob($row['carddata']);
-				$cards[] = $row;
-			}
-			$result->closeCursor();
-		}
-		return $cards;
-	}
-
-	/**
-	 * Creates a new card.
-	 *
-	 * The addressbook id will be passed as the first argument. This is the
-	 * same id as it is returned from the getAddressBooksForUser method.
-	 *
-	 * The cardUri is a base uri, and doesn't include the full path. The
-	 * cardData argument is the vcard body, and is passed as a string.
-	 *
-	 * It is possible to return an ETag from this method. This ETag is for the
-	 * newly created resource, and must be enclosed with double quotes (that
-	 * is, the string itself must contain the double quotes).
-	 *
-	 * You should only return the ETag if you store the carddata as-is. If a
-	 * subsequent GET request on the same card does not have the same body,
-	 * byte-by-byte and you did return an ETag here, clients tend to get
-	 * confused.
-	 *
-	 * If you don't return an ETag, you can just return null.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @param string $cardData
-	 * @return string
-	 */
-	function createCard($addressBookId, $cardUri, $cardData) {
-		$etag = md5($cardData);
-
-		$query = $this->db->getQueryBuilder();
-		$query->insert('cards')
-			->values([
-				'carddata' => $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB),
-				'uri' => $query->createNamedParameter($cardUri),
-				'lastmodified' => $query->createNamedParameter(time()),
-				'addressbookid' => $query->createNamedParameter($addressBookId),
-				'size' => $query->createNamedParameter(strlen($cardData)),
-				'etag' => $query->createNamedParameter($etag),
-			])
-			->execute();
-
-		$this->addChange($addressBookId, $cardUri, 1);
-		$this->updateProperties($addressBookId, $cardUri, $cardData);
-
-		if (!is_null($this->dispatcher)) {
-			$this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::createCard',
-				new GenericEvent(null, [
-					'addressBookId' => $addressBookId,
-					'cardUri' => $cardUri,
-					'cardData' => $cardData]));
-		}
-
-		return '"' . $etag . '"';
-	}
-
-	/**
-	 * Updates a card.
-	 *
-	 * The addressbook id will be passed as the first argument. This is the
-	 * same id as it is returned from the getAddressBooksForUser method.
-	 *
-	 * The cardUri is a base uri, and doesn't include the full path. The
-	 * cardData argument is the vcard body, and is passed as a string.
-	 *
-	 * It is possible to return an ETag from this method. This ETag should
-	 * match that of the updated resource, and must be enclosed with double
-	 * quotes (that is: the string itself must contain the actual quotes).
-	 *
-	 * You should only return the ETag if you store the carddata as-is. If a
-	 * subsequent GET request on the same card does not have the same body,
-	 * byte-by-byte and you did return an ETag here, clients tend to get
-	 * confused.
-	 *
-	 * If you don't return an ETag, you can just return null.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @param string $cardData
-	 * @return string
-	 */
-	function updateCard($addressBookId, $cardUri, $cardData) {
-
-		$etag = md5($cardData);
-		$query = $this->db->getQueryBuilder();
-		$query->update('cards')
-			->set('carddata', $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB))
-			->set('lastmodified', $query->createNamedParameter(time()))
-			->set('size', $query->createNamedParameter(strlen($cardData)))
-			->set('etag', $query->createNamedParameter($etag))
-			->where($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-		$this->addChange($addressBookId, $cardUri, 2);
-		$this->updateProperties($addressBookId, $cardUri, $cardData);
-
-		if (!is_null($this->dispatcher)) {
-			$this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::updateCard',
-				new GenericEvent(null, [
-					'addressBookId' => $addressBookId,
-					'cardUri' => $cardUri,
-					'cardData' => $cardData]));
-		}
-
-		return '"' . $etag . '"';
-	}
-
-	/**
-	 * Deletes a card
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @return bool
-	 */
-	function deleteCard($addressBookId, $cardUri) {
-		try {
-			$cardId = $this->getCardId($addressBookId, $cardUri);
-		} catch (\InvalidArgumentException $e) {
-			$cardId = null;
-		}
-		$query = $this->db->getQueryBuilder();
-		$ret = $query->delete('cards')
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
-			->execute();
-
-		$this->addChange($addressBookId, $cardUri, 3);
-
-		if (!is_null($this->dispatcher)) {
-			$this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::deleteCard',
-				new GenericEvent(null, [
-					'addressBookId' => $addressBookId,
-					'cardUri' => $cardUri]));
-		}
-
-		if ($ret === 1) {
-			if ($cardId !== null) {
-				$this->purgeProperties($addressBookId, $cardId);
-			}
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * The getChanges method returns all the changes that have happened, since
-	 * the specified syncToken in the specified address book.
-	 *
-	 * This function should return an array, such as the following:
-	 *
-	 * [
-	 *   'syncToken' => 'The current synctoken',
-	 *   'added'   => [
-	 *      'new.txt',
-	 *   ],
-	 *   'modified'   => [
-	 *      'modified.txt',
-	 *   ],
-	 *   'deleted' => [
-	 *      'foo.php.bak',
-	 *      'old.txt'
-	 *   ]
-	 * ];
-	 *
-	 * The returned syncToken property should reflect the *current* syncToken
-	 * of the calendar, as reported in the {http://sabredav.org/ns}sync-token
-	 * property. This is needed here too, to ensure the operation is atomic.
-	 *
-	 * If the $syncToken argument is specified as null, this is an initial
-	 * sync, and all members should be reported.
-	 *
-	 * The modified property is an array of nodenames that have changed since
-	 * the last token.
-	 *
-	 * The deleted property is an array with nodenames, that have been deleted
-	 * from collection.
-	 *
-	 * The $syncLevel argument is basically the 'depth' of the report. If it's
-	 * 1, you only have to report changes that happened only directly in
-	 * immediate descendants. If it's 2, it should also include changes from
-	 * the nodes below the child collections. (grandchildren)
-	 *
-	 * The $limit argument allows a client to specify how many results should
-	 * be returned at most. If the limit is not specified, it should be treated
-	 * as infinite.
-	 *
-	 * If the limit (infinite or not) is higher than you're willing to return,
-	 * you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.
-	 *
-	 * If the syncToken is expired (due to data cleanup) or unknown, you must
-	 * return null.
-	 *
-	 * The limit is 'suggestive'. You are free to ignore it.
-	 *
-	 * @param string $addressBookId
-	 * @param string $syncToken
-	 * @param int $syncLevel
-	 * @param int $limit
-	 * @return array
-	 */
-	function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
-		// Current synctoken
-		$stmt = $this->db->prepare('SELECT `synctoken` FROM `*PREFIX*addressbooks` WHERE `id` = ?');
-		$stmt->execute([ $addressBookId ]);
-		$currentToken = $stmt->fetchColumn(0);
-
-		if (is_null($currentToken)) return null;
-
-		$result = [
-			'syncToken' => $currentToken,
-			'added'     => [],
-			'modified'  => [],
-			'deleted'   => [],
-		];
-
-		if ($syncToken) {
-
-			$query = "SELECT `uri`, `operation` FROM `*PREFIX*addressbookchanges` WHERE `synctoken` >= ? AND `synctoken` < ? AND `addressbookid` = ? ORDER BY `synctoken`";
-			if ($limit>0) {
-				$query .= " `LIMIT` " . (int)$limit;
-			}
-
-			// Fetching all changes
-			$stmt = $this->db->prepare($query);
-			$stmt->execute([$syncToken, $currentToken, $addressBookId]);
-
-			$changes = [];
-
-			// This loop ensures that any duplicates are overwritten, only the
-			// last change on a node is relevant.
-			while($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
-
-				$changes[$row['uri']] = $row['operation'];
-
-			}
-
-			foreach($changes as $uri => $operation) {
-
-				switch($operation) {
-					case 1:
-						$result['added'][] = $uri;
-						break;
-					case 2:
-						$result['modified'][] = $uri;
-						break;
-					case 3:
-						$result['deleted'][] = $uri;
-						break;
-				}
-
-			}
-		} else {
-			// No synctoken supplied, this is the initial sync.
-			$query = "SELECT `uri` FROM `*PREFIX*cards` WHERE `addressbookid` = ?";
-			$stmt = $this->db->prepare($query);
-			$stmt->execute([$addressBookId]);
-
-			$result['added'] = $stmt->fetchAll(\PDO::FETCH_COLUMN);
-		}
-		return $result;
-	}
-
-	/**
-	 * Adds a change record to the addressbookchanges table.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $objectUri
-	 * @param int $operation 1 = add, 2 = modify, 3 = delete
-	 * @return void
-	 */
-	protected function addChange($addressBookId, $objectUri, $operation) {
-		$sql = 'INSERT INTO `*PREFIX*addressbookchanges`(`uri`, `synctoken`, `addressbookid`, `operation`) SELECT ?, `synctoken`, ?, ? FROM `*PREFIX*addressbooks` WHERE `id` = ?';
-		$stmt = $this->db->prepare($sql);
-		$stmt->execute([
-			$objectUri,
-			$addressBookId,
-			$operation,
-			$addressBookId
-		]);
-		$stmt = $this->db->prepare('UPDATE `*PREFIX*addressbooks` SET `synctoken` = `synctoken` + 1 WHERE `id` = ?');
-		$stmt->execute([
-			$addressBookId
-		]);
-	}
-
-	private function readBlob($cardData) {
-		if (is_resource($cardData)) {
-			return stream_get_contents($cardData);
-		}
-
-		return $cardData;
-	}
-
-	/**
-	 * @param IShareable $shareable
-	 * @param string[] $add
-	 * @param string[] $remove
-	 */
-	public function updateShares(IShareable $shareable, $add, $remove) {
-		$this->sharingBackend->updateShares($shareable, $add, $remove);
-	}
-
-	/**
-	 * search contact
-	 *
-	 * @param int $addressBookId
-	 * @param string $pattern which should match within the $searchProperties
-	 * @param array $searchProperties defines the properties within the query pattern should match
-	 * @return array an array of contacts which are arrays of key-value-pairs
-	 */
-	public function search($addressBookId, $pattern, $searchProperties) {
-		$query = $this->db->getQueryBuilder();
-		$query2 = $this->db->getQueryBuilder();
-		$query2->selectDistinct('cp.cardid')->from($this->dbCardsPropertiesTable, 'cp');
-		foreach ($searchProperties as $property) {
-			$query2->orWhere(
-				$query2->expr()->andX(
-					$query2->expr()->eq('cp.name', $query->createNamedParameter($property)),
-					$query2->expr()->ilike('cp.value', $query->createNamedParameter('%' . $this->db->escapeLikeParameter($pattern) . '%'))
-				)
-			);
-		}
-		$query2->andWhere($query2->expr()->eq('cp.addressbookid', $query->createNamedParameter($addressBookId)));
-
-		$query->select('c.carddata', 'c.uri')->from($this->dbCardsTable, 'c')
-			->where($query->expr()->in('c.id', $query->createFunction($query2->getSQL())));
-
-		$result = $query->execute();
-		$cards = $result->fetchAll();
-
-		$result->closeCursor();
-
-		return array_map(function($array) {
-			$array['carddata'] = $this->readBlob($array['carddata']);
-			return $array;
-		}, $cards);
-	}
-
-	/**
-	 * @param int $bookId
-	 * @param string $name
-	 * @return array
-	 */
-	public function collectCardProperties($bookId, $name) {
-		$query = $this->db->getQueryBuilder();
-		$result = $query->selectDistinct('value')
-			->from($this->dbCardsPropertiesTable)
-			->where($query->expr()->eq('name', $query->createNamedParameter($name)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($bookId)))
-			->execute();
-
-		$all = $result->fetchAll(PDO::FETCH_COLUMN);
-		$result->closeCursor();
-
-		return $all;
-	}
-
-	/**
-	 * get URI from a given contact
-	 *
-	 * @param int $id
-	 * @return string
-	 */
-	public function getCardUri($id) {
-		$query = $this->db->getQueryBuilder();
-		$query->select('uri')->from($this->dbCardsTable)
-				->where($query->expr()->eq('id', $query->createParameter('id')))
-				->setParameter('id', $id);
-
-		$result = $query->execute();
-		$uri = $result->fetch();
-		$result->closeCursor();
-
-		if (!isset($uri['uri'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $id);
-		}
-
-		return $uri['uri'];
-	}
-
-	/**
-	 * return contact with the given URI
-	 *
-	 * @param int $addressBookId
-	 * @param string $uri
-	 * @returns array
-	 */
-	public function getContact($addressBookId, $uri) {
-		$result = [];
-		$query = $this->db->getQueryBuilder();
-		$query->select('*')->from($this->dbCardsTable)
-				->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
-				->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-		$queryResult = $query->execute();
-		$contact = $queryResult->fetch();
-		$queryResult->closeCursor();
-
-		if (is_array($contact)) {
-			$result = $contact;
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Returns the list of people whom this address book is shared with.
-	 *
-	 * Every element in this array should have the following properties:
-	 *   * href - Often a mailto: address
-	 *   * commonName - Optional, for example a first + last name
-	 *   * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants.
-	 *   * readOnly - boolean
-	 *   * summary - Optional, a description for the share
-	 *
-	 * @return array
-	 */
-	public function getShares($addressBookId) {
-		return $this->sharingBackend->getShares($addressBookId);
-	}
-
-	/**
-	 * update properties table
-	 *
-	 * @param int $addressBookId
-	 * @param string $cardUri
-	 * @param string $vCardSerialized
-	 */
-	protected function updateProperties($addressBookId, $cardUri, $vCardSerialized) {
-		$cardId = $this->getCardId($addressBookId, $cardUri);
-		$vCard = $this->readCard($vCardSerialized);
-
-		$this->purgeProperties($addressBookId, $cardId);
-
-		$query = $this->db->getQueryBuilder();
-		$query->insert($this->dbCardsPropertiesTable)
-			->values(
-				[
-					'addressbookid' => $query->createNamedParameter($addressBookId),
-					'cardid' => $query->createNamedParameter($cardId),
-					'name' => $query->createParameter('name'),
-					'value' => $query->createParameter('value'),
-					'preferred' => $query->createParameter('preferred')
-				]
-			);
-
-		foreach ($vCard->children() as $property) {
-			if(!in_array($property->name, self::$indexProperties)) {
-				continue;
-			}
-			$preferred = 0;
-			foreach($property->parameters as $parameter) {
-				if ($parameter->name == 'TYPE' && strtoupper($parameter->getValue()) == 'PREF') {
-					$preferred = 1;
-					break;
-				}
-			}
-			$query->setParameter('name', $property->name);
-			$query->setParameter('value', substr($property->getValue(), 0, 254));
-			$query->setParameter('preferred', $preferred);
-			$query->execute();
-		}
-	}
-
-	/**
-	 * read vCard data into a vCard object
-	 *
-	 * @param string $cardData
-	 * @return VCard
-	 */
-	protected function readCard($cardData) {
-		return  Reader::read($cardData);
-	}
-
-	/**
-	 * delete all properties from a given card
-	 *
-	 * @param int $addressBookId
-	 * @param int $cardId
-	 */
-	protected function purgeProperties($addressBookId, $cardId) {
-		$query = $this->db->getQueryBuilder();
-		$query->delete($this->dbCardsPropertiesTable)
-			->where($query->expr()->eq('cardid', $query->createNamedParameter($cardId)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-		$query->execute();
-	}
-
-	/**
-	 * get ID from a given contact
-	 *
-	 * @param int $addressBookId
-	 * @param string $uri
-	 * @return int
-	 */
-	protected function getCardId($addressBookId, $uri) {
-		$query = $this->db->getQueryBuilder();
-		$query->select('id')->from($this->dbCardsTable)
-			->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-
-		$result = $query->execute();
-		$cardIds = $result->fetch();
-		$result->closeCursor();
-
-		if (!isset($cardIds['id'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $uri);
-		}
-
-		return (int)$cardIds['id'];
-	}
-
-	/**
-	 * For shared address books the sharee is set in the ACL of the address book
-	 * @param $addressBookId
-	 * @param $acl
-	 * @return array
-	 */
-	public function applyShareAcl($addressBookId, $acl) {
-		return $this->sharingBackend->applyShareAcl($addressBookId, $acl);
-	}
-
-	private function convertPrincipal($principalUri, $toV2) {
-		if ($this->principalBackend->getPrincipalPrefix() === 'principals') {
-			list(, $name) = URLUtil::splitPath($principalUri);
-			if ($toV2 === true) {
-				return "principals/users/$name";
-			}
-			return "principals/$name";
-		}
-		return $principalUri;
-	}
+    const PERSONAL_ADDRESSBOOK_URI = 'contacts';
+    const PERSONAL_ADDRESSBOOK_NAME = 'Contacts';
+
+    /** @var Principal */
+    private $principalBackend;
+
+    /** @var string */
+    private $dbCardsTable = 'cards';
+
+    /** @var string */
+    private $dbCardsPropertiesTable = 'cards_properties';
+
+    /** @var IDBConnection */
+    private $db;
+
+    /** @var Backend */
+    private $sharingBackend;
+
+    /** @var array properties to index */
+    public static $indexProperties = array(
+            'BDAY', 'UID', 'N', 'FN', 'TITLE', 'ROLE', 'NOTE', 'NICKNAME',
+            'ORG', 'CATEGORIES', 'EMAIL', 'TEL', 'IMPP', 'ADR', 'URL', 'GEO', 'CLOUD');
+
+    /**
+     * @var string[] Map of uid => display name
+     */
+    protected $userDisplayNames;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var EventDispatcherInterface */
+    private $dispatcher;
+
+    /**
+     * CardDavBackend constructor.
+     *
+     * @param IDBConnection $db
+     * @param Principal $principalBackend
+     * @param IUserManager $userManager
+     * @param EventDispatcherInterface $dispatcher
+     */
+    public function __construct(IDBConnection $db,
+                                Principal $principalBackend,
+                                IUserManager $userManager,
+                                EventDispatcherInterface $dispatcher = null) {
+        $this->db = $db;
+        $this->principalBackend = $principalBackend;
+        $this->userManager = $userManager;
+        $this->dispatcher = $dispatcher;
+        $this->sharingBackend = new Backend($this->db, $principalBackend, 'addressbook');
+    }
+
+    /**
+     * Return the number of address books for a principal
+     *
+     * @param $principalUri
+     * @return int
+     */
+    public function getAddressBooksForUserCount($principalUri) {
+        $principalUri = $this->convertPrincipal($principalUri, true);
+        $query = $this->db->getQueryBuilder();
+        $query->select($query->createFunction('COUNT(*)'))
+            ->from('addressbooks')
+            ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
+
+        return (int)$query->execute()->fetchColumn();
+    }
+
+    /**
+     * Returns the list of address books for a specific user.
+     *
+     * Every addressbook should have the following properties:
+     *   id - an arbitrary unique id
+     *   uri - the 'basename' part of the url
+     *   principaluri - Same as the passed parameter
+     *
+     * Any additional clark-notation property may be passed besides this. Some
+     * common ones are :
+     *   {DAV:}displayname
+     *   {urn:ietf:params:xml:ns:carddav}addressbook-description
+     *   {http://calendarserver.org/ns/}getctag
+     *
+     * @param string $principalUri
+     * @return array
+     */
+    function getAddressBooksForUser($principalUri) {
+        $principalUriOriginal = $principalUri;
+        $principalUri = $this->convertPrincipal($principalUri, true);
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+            ->from('addressbooks')
+            ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
+
+        $addressBooks = [];
+
+        $result = $query->execute();
+        while($row = $result->fetch()) {
+            $addressBooks[$row['id']] = [
+                'id'  => $row['id'],
+                'uri' => $row['uri'],
+                'principaluri' => $this->convertPrincipal($row['principaluri'], false),
+                '{DAV:}displayname' => $row['displayname'],
+                '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+                '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+                '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+            ];
+        }
+        $result->closeCursor();
+
+        // query for shared calendars
+        $principals = $this->principalBackend->getGroupMembership($principalUriOriginal, true);
+        $principals[]= $principalUri;
+
+        $query = $this->db->getQueryBuilder();
+        $result = $query->select(['a.id', 'a.uri', 'a.displayname', 'a.principaluri', 'a.description', 'a.synctoken', 's.access'])
+            ->from('dav_shares', 's')
+            ->join('s', 'addressbooks', 'a', $query->expr()->eq('s.resourceid', 'a.id'))
+            ->where($query->expr()->in('s.principaluri', $query->createParameter('principaluri')))
+            ->andWhere($query->expr()->eq('s.type', $query->createParameter('type')))
+            ->setParameter('type', 'addressbook')
+            ->setParameter('principaluri', $principals, IQueryBuilder::PARAM_STR_ARRAY)
+            ->execute();
+
+        while($row = $result->fetch()) {
+            list(, $name) = URLUtil::splitPath($row['principaluri']);
+            $uri = $row['uri'] . '_shared_by_' . $name;
+            $displayName = $row['displayname'] . ' (' . $this->getUserDisplayName($name) . ')';
+            if (!isset($addressBooks[$row['id']])) {
+                $addressBooks[$row['id']] = [
+                    'id'  => $row['id'],
+                    'uri' => $uri,
+                    'principaluri' => $principalUri,
+                    '{DAV:}displayname' => $displayName,
+                    '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+                    '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+                    '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+                    '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal' => $row['principaluri'],
+                    '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}read-only' => (int)$row['access'] === Backend::ACCESS_READ,
+                ];
+            }
+        }
+        $result->closeCursor();
+
+        return array_values($addressBooks);
+    }
+
+    public function getUsersOwnAddressBooks($principalUri) {
+        $principalUriOriginal = $principalUri;
+        $principalUri = $this->convertPrincipal($principalUri, true);
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+                ->from('addressbooks')
+                ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
+
+        $addressBooks = [];
+
+        $result = $query->execute();
+        while($row = $result->fetch()) {
+            $addressBooks[$row['id']] = [
+                'id'  => $row['id'],
+                'uri' => $row['uri'],
+                'principaluri' => $this->convertPrincipal($row['principaluri'], false),
+                '{DAV:}displayname' => $row['displayname'],
+                '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+                '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+                '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+            ];
+        }
+        $result->closeCursor();
+
+        return array_values($addressBooks);
+    }
+
+    private function getUserDisplayName($uid) {
+        if (!isset($this->userDisplayNames[$uid])) {
+            $user = $this->userManager->get($uid);
+
+            if ($user instanceof IUser) {
+                $this->userDisplayNames[$uid] = $user->getDisplayName();
+            } else {
+                $this->userDisplayNames[$uid] = $uid;
+            }
+        }
+
+        return $this->userDisplayNames[$uid];
+    }
+
+    /**
+     * @param int $addressBookId
+     */
+    public function getAddressBookById($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+            ->from('addressbooks')
+            ->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+        $row = $result->fetch();
+        $result->closeCursor();
+        if ($row === false) {
+            return null;
+        }
+
+        return [
+            'id'  => $row['id'],
+            'uri' => $row['uri'],
+            'principaluri' => $row['principaluri'],
+            '{DAV:}displayname' => $row['displayname'],
+            '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+            '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+            '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+        ];
+    }
+
+    /**
+     * @param $addressBookUri
+     * @return array|null
+     */
+    public function getAddressBooksByUri($principal, $addressBookUri) {
+        $query = $this->db->getQueryBuilder();
+        $result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+            ->from('addressbooks')
+            ->where($query->expr()->eq('uri', $query->createNamedParameter($addressBookUri)))
+            ->andWhere($query->expr()->eq('principaluri', $query->createNamedParameter($principal)))
+            ->setMaxResults(1)
+            ->execute();
+
+        $row = $result->fetch();
+        $result->closeCursor();
+        if ($row === false) {
+            return null;
+        }
+
+        return [
+                'id'  => $row['id'],
+                'uri' => $row['uri'],
+                'principaluri' => $row['principaluri'],
+                '{DAV:}displayname' => $row['displayname'],
+                '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+                '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+                '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+            ];
+    }
+
+    /**
+     * Updates properties for an address book.
+     *
+     * The list of mutations is stored in a Sabre\DAV\PropPatch object.
+     * To do the actual updates, you must tell this object which properties
+     * you're going to process with the handle() method.
+     *
+     * Calling the handle method is like telling the PropPatch object "I
+     * promise I can handle updating this property".
+     *
+     * Read the PropPatch documentation for more info and examples.
+     *
+     * @param string $addressBookId
+     * @param \Sabre\DAV\PropPatch $propPatch
+     * @return void
+     */
+    function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
+        $supportedProperties = [
+            '{DAV:}displayname',
+            '{' . Plugin::NS_CARDDAV . '}addressbook-description',
+        ];
+
+        $propPatch->handle($supportedProperties, function($mutations) use ($addressBookId) {
+
+            $updates = [];
+            foreach($mutations as $property=>$newValue) {
+
+                switch($property) {
+                    case '{DAV:}displayname' :
+                        $updates['displayname'] = $newValue;
+                        break;
+                    case '{' . Plugin::NS_CARDDAV . '}addressbook-description' :
+                        $updates['description'] = $newValue;
+                        break;
+                }
+            }
+            $query = $this->db->getQueryBuilder();
+            $query->update('addressbooks');
+
+            foreach($updates as $key=>$value) {
+                $query->set($key, $query->createNamedParameter($value));
+            }
+            $query->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+            $this->addChange($addressBookId, "", 2);
+
+            return true;
+
+        });
+    }
+
+    /**
+     * Creates a new address book
+     *
+     * @param string $principalUri
+     * @param string $url Just the 'basename' of the url.
+     * @param array $properties
+     * @return int
+     * @throws BadRequest
+     */
+    function createAddressBook($principalUri, $url, array $properties) {
+        $values = [
+            'displayname' => null,
+            'description' => null,
+            'principaluri' => $principalUri,
+            'uri' => $url,
+            'synctoken' => 1
+        ];
+
+        foreach($properties as $property=>$newValue) {
+
+            switch($property) {
+                case '{DAV:}displayname' :
+                    $values['displayname'] = $newValue;
+                    break;
+                case '{' . Plugin::NS_CARDDAV . '}addressbook-description' :
+                    $values['description'] = $newValue;
+                    break;
+                default :
+                    throw new BadRequest('Unknown property: ' . $property);
+            }
+
+        }
+
+        // Fallback to make sure the displayname is set. Some clients may refuse
+        // to work with addressbooks not having a displayname.
+        if(is_null($values['displayname'])) {
+            $values['displayname'] = $url;
+        }
+
+        $query = $this->db->getQueryBuilder();
+        $query->insert('addressbooks')
+            ->values([
+                'uri' => $query->createParameter('uri'),
+                'displayname' => $query->createParameter('displayname'),
+                'description' => $query->createParameter('description'),
+                'principaluri' => $query->createParameter('principaluri'),
+                'synctoken' => $query->createParameter('synctoken'),
+            ])
+            ->setParameters($values)
+            ->execute();
+
+        return $query->getLastInsertId();
+    }
+
+    /**
+     * Deletes an entire addressbook and all its contents
+     *
+     * @param mixed $addressBookId
+     * @return void
+     */
+    function deleteAddressBook($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $query->delete('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
+            ->setParameter('addressbookid', $addressBookId)
+            ->execute();
+
+        $query->delete('addressbookchanges')
+            ->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
+            ->setParameter('addressbookid', $addressBookId)
+            ->execute();
+
+        $query->delete('addressbooks')
+            ->where($query->expr()->eq('id', $query->createParameter('id')))
+            ->setParameter('id', $addressBookId)
+            ->execute();
+
+        $this->sharingBackend->deleteAllShares($addressBookId);
+
+        $query->delete($this->dbCardsPropertiesTable)
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+    }
+
+    /**
+     * Returns all cards for a specific addressbook id.
+     *
+     * This method should return the following properties for each card:
+     *   * carddata - raw vcard data
+     *   * uri - Some unique url
+     *   * lastmodified - A unix timestamp
+     *
+     * It's recommended to also return the following properties:
+     *   * etag - A unique etag. This must change every time the card changes.
+     *   * size - The size of the card in bytes.
+     *
+     * If these last two properties are provided, less time will be spent
+     * calculating them. If they are specified, you can also ommit carddata.
+     * This may speed up certain requests, especially with large cards.
+     *
+     * @param mixed $addressBookId
+     * @return array
+     */
+    function getCards($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata'])
+            ->from('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+
+        $cards = [];
+
+        $result = $query->execute();
+        while($row = $result->fetch()) {
+            $row['etag'] = '"' . $row['etag'] . '"';
+            $row['carddata'] = $this->readBlob($row['carddata']);
+            $cards[] = $row;
+        }
+        $result->closeCursor();
+
+        return $cards;
+    }
+
+    /**
+     * Returns a specific card.
+     *
+     * The same set of properties must be returned as with getCards. The only
+     * exception is that 'carddata' is absolutely required.
+     *
+     * If the card does not exist, you must return false.
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @return array
+     */
+    function getCard($addressBookId, $cardUri) {
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata'])
+            ->from('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
+            ->setMaxResults(1);
+
+        $result = $query->execute();
+        $row = $result->fetch();
+        if (!$row) {
+            return false;
+        }
+        $row['etag'] = '"' . $row['etag'] . '"';
+        $row['carddata'] = $this->readBlob($row['carddata']);
+
+        return $row;
+    }
+
+    /**
+     * Returns a list of cards.
+     *
+     * This method should work identical to getCard, but instead return all the
+     * cards in the list as an array.
+     *
+     * If the backend supports this, it may allow for some speed-ups.
+     *
+     * @param mixed $addressBookId
+     * @param string[] $uris
+     * @return array
+     */
+    function getMultipleCards($addressBookId, array $uris) {
+        if (empty($uris)) {
+            return [];
+        }
+
+        $chunks = array_chunk($uris, 100);
+        $cards = [];
+
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata'])
+            ->from('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->andWhere($query->expr()->in('uri', $query->createParameter('uri')));
+
+        foreach ($chunks as $uris) {
+            $query->setParameter('uri', $uris, IQueryBuilder::PARAM_STR_ARRAY);
+            $result = $query->execute();
+
+            while ($row = $result->fetch()) {
+                $row['etag'] = '"' . $row['etag'] . '"';
+                $row['carddata'] = $this->readBlob($row['carddata']);
+                $cards[] = $row;
+            }
+            $result->closeCursor();
+        }
+        return $cards;
+    }
+
+    /**
+     * Creates a new card.
+     *
+     * The addressbook id will be passed as the first argument. This is the
+     * same id as it is returned from the getAddressBooksForUser method.
+     *
+     * The cardUri is a base uri, and doesn't include the full path. The
+     * cardData argument is the vcard body, and is passed as a string.
+     *
+     * It is possible to return an ETag from this method. This ETag is for the
+     * newly created resource, and must be enclosed with double quotes (that
+     * is, the string itself must contain the double quotes).
+     *
+     * You should only return the ETag if you store the carddata as-is. If a
+     * subsequent GET request on the same card does not have the same body,
+     * byte-by-byte and you did return an ETag here, clients tend to get
+     * confused.
+     *
+     * If you don't return an ETag, you can just return null.
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @param string $cardData
+     * @return string
+     */
+    function createCard($addressBookId, $cardUri, $cardData) {
+        $etag = md5($cardData);
+
+        $query = $this->db->getQueryBuilder();
+        $query->insert('cards')
+            ->values([
+                'carddata' => $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB),
+                'uri' => $query->createNamedParameter($cardUri),
+                'lastmodified' => $query->createNamedParameter(time()),
+                'addressbookid' => $query->createNamedParameter($addressBookId),
+                'size' => $query->createNamedParameter(strlen($cardData)),
+                'etag' => $query->createNamedParameter($etag),
+            ])
+            ->execute();
+
+        $this->addChange($addressBookId, $cardUri, 1);
+        $this->updateProperties($addressBookId, $cardUri, $cardData);
+
+        if (!is_null($this->dispatcher)) {
+            $this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::createCard',
+                new GenericEvent(null, [
+                    'addressBookId' => $addressBookId,
+                    'cardUri' => $cardUri,
+                    'cardData' => $cardData]));
+        }
+
+        return '"' . $etag . '"';
+    }
+
+    /**
+     * Updates a card.
+     *
+     * The addressbook id will be passed as the first argument. This is the
+     * same id as it is returned from the getAddressBooksForUser method.
+     *
+     * The cardUri is a base uri, and doesn't include the full path. The
+     * cardData argument is the vcard body, and is passed as a string.
+     *
+     * It is possible to return an ETag from this method. This ETag should
+     * match that of the updated resource, and must be enclosed with double
+     * quotes (that is: the string itself must contain the actual quotes).
+     *
+     * You should only return the ETag if you store the carddata as-is. If a
+     * subsequent GET request on the same card does not have the same body,
+     * byte-by-byte and you did return an ETag here, clients tend to get
+     * confused.
+     *
+     * If you don't return an ETag, you can just return null.
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @param string $cardData
+     * @return string
+     */
+    function updateCard($addressBookId, $cardUri, $cardData) {
+
+        $etag = md5($cardData);
+        $query = $this->db->getQueryBuilder();
+        $query->update('cards')
+            ->set('carddata', $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB))
+            ->set('lastmodified', $query->createNamedParameter(time()))
+            ->set('size', $query->createNamedParameter(strlen($cardData)))
+            ->set('etag', $query->createNamedParameter($etag))
+            ->where($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+        $this->addChange($addressBookId, $cardUri, 2);
+        $this->updateProperties($addressBookId, $cardUri, $cardData);
+
+        if (!is_null($this->dispatcher)) {
+            $this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::updateCard',
+                new GenericEvent(null, [
+                    'addressBookId' => $addressBookId,
+                    'cardUri' => $cardUri,
+                    'cardData' => $cardData]));
+        }
+
+        return '"' . $etag . '"';
+    }
+
+    /**
+     * Deletes a card
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @return bool
+     */
+    function deleteCard($addressBookId, $cardUri) {
+        try {
+            $cardId = $this->getCardId($addressBookId, $cardUri);
+        } catch (\InvalidArgumentException $e) {
+            $cardId = null;
+        }
+        $query = $this->db->getQueryBuilder();
+        $ret = $query->delete('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
+            ->execute();
+
+        $this->addChange($addressBookId, $cardUri, 3);
+
+        if (!is_null($this->dispatcher)) {
+            $this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::deleteCard',
+                new GenericEvent(null, [
+                    'addressBookId' => $addressBookId,
+                    'cardUri' => $cardUri]));
+        }
+
+        if ($ret === 1) {
+            if ($cardId !== null) {
+                $this->purgeProperties($addressBookId, $cardId);
+            }
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * The getChanges method returns all the changes that have happened, since
+     * the specified syncToken in the specified address book.
+     *
+     * This function should return an array, such as the following:
+     *
+     * [
+     *   'syncToken' => 'The current synctoken',
+     *   'added'   => [
+     *      'new.txt',
+     *   ],
+     *   'modified'   => [
+     *      'modified.txt',
+     *   ],
+     *   'deleted' => [
+     *      'foo.php.bak',
+     *      'old.txt'
+     *   ]
+     * ];
+     *
+     * The returned syncToken property should reflect the *current* syncToken
+     * of the calendar, as reported in the {http://sabredav.org/ns}sync-token
+     * property. This is needed here too, to ensure the operation is atomic.
+     *
+     * If the $syncToken argument is specified as null, this is an initial
+     * sync, and all members should be reported.
+     *
+     * The modified property is an array of nodenames that have changed since
+     * the last token.
+     *
+     * The deleted property is an array with nodenames, that have been deleted
+     * from collection.
+     *
+     * The $syncLevel argument is basically the 'depth' of the report. If it's
+     * 1, you only have to report changes that happened only directly in
+     * immediate descendants. If it's 2, it should also include changes from
+     * the nodes below the child collections. (grandchildren)
+     *
+     * The $limit argument allows a client to specify how many results should
+     * be returned at most. If the limit is not specified, it should be treated
+     * as infinite.
+     *
+     * If the limit (infinite or not) is higher than you're willing to return,
+     * you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.
+     *
+     * If the syncToken is expired (due to data cleanup) or unknown, you must
+     * return null.
+     *
+     * The limit is 'suggestive'. You are free to ignore it.
+     *
+     * @param string $addressBookId
+     * @param string $syncToken
+     * @param int $syncLevel
+     * @param int $limit
+     * @return array
+     */
+    function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
+        // Current synctoken
+        $stmt = $this->db->prepare('SELECT `synctoken` FROM `*PREFIX*addressbooks` WHERE `id` = ?');
+        $stmt->execute([ $addressBookId ]);
+        $currentToken = $stmt->fetchColumn(0);
+
+        if (is_null($currentToken)) return null;
+
+        $result = [
+            'syncToken' => $currentToken,
+            'added'     => [],
+            'modified'  => [],
+            'deleted'   => [],
+        ];
+
+        if ($syncToken) {
+
+            $query = "SELECT `uri`, `operation` FROM `*PREFIX*addressbookchanges` WHERE `synctoken` >= ? AND `synctoken` < ? AND `addressbookid` = ? ORDER BY `synctoken`";
+            if ($limit>0) {
+                $query .= " `LIMIT` " . (int)$limit;
+            }
+
+            // Fetching all changes
+            $stmt = $this->db->prepare($query);
+            $stmt->execute([$syncToken, $currentToken, $addressBookId]);
+
+            $changes = [];
+
+            // This loop ensures that any duplicates are overwritten, only the
+            // last change on a node is relevant.
+            while($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+
+                $changes[$row['uri']] = $row['operation'];
+
+            }
+
+            foreach($changes as $uri => $operation) {
+
+                switch($operation) {
+                    case 1:
+                        $result['added'][] = $uri;
+                        break;
+                    case 2:
+                        $result['modified'][] = $uri;
+                        break;
+                    case 3:
+                        $result['deleted'][] = $uri;
+                        break;
+                }
+
+            }
+        } else {
+            // No synctoken supplied, this is the initial sync.
+            $query = "SELECT `uri` FROM `*PREFIX*cards` WHERE `addressbookid` = ?";
+            $stmt = $this->db->prepare($query);
+            $stmt->execute([$addressBookId]);
+
+            $result['added'] = $stmt->fetchAll(\PDO::FETCH_COLUMN);
+        }
+        return $result;
+    }
+
+    /**
+     * Adds a change record to the addressbookchanges table.
+     *
+     * @param mixed $addressBookId
+     * @param string $objectUri
+     * @param int $operation 1 = add, 2 = modify, 3 = delete
+     * @return void
+     */
+    protected function addChange($addressBookId, $objectUri, $operation) {
+        $sql = 'INSERT INTO `*PREFIX*addressbookchanges`(`uri`, `synctoken`, `addressbookid`, `operation`) SELECT ?, `synctoken`, ?, ? FROM `*PREFIX*addressbooks` WHERE `id` = ?';
+        $stmt = $this->db->prepare($sql);
+        $stmt->execute([
+            $objectUri,
+            $addressBookId,
+            $operation,
+            $addressBookId
+        ]);
+        $stmt = $this->db->prepare('UPDATE `*PREFIX*addressbooks` SET `synctoken` = `synctoken` + 1 WHERE `id` = ?');
+        $stmt->execute([
+            $addressBookId
+        ]);
+    }
+
+    private function readBlob($cardData) {
+        if (is_resource($cardData)) {
+            return stream_get_contents($cardData);
+        }
+
+        return $cardData;
+    }
+
+    /**
+     * @param IShareable $shareable
+     * @param string[] $add
+     * @param string[] $remove
+     */
+    public function updateShares(IShareable $shareable, $add, $remove) {
+        $this->sharingBackend->updateShares($shareable, $add, $remove);
+    }
+
+    /**
+     * search contact
+     *
+     * @param int $addressBookId
+     * @param string $pattern which should match within the $searchProperties
+     * @param array $searchProperties defines the properties within the query pattern should match
+     * @return array an array of contacts which are arrays of key-value-pairs
+     */
+    public function search($addressBookId, $pattern, $searchProperties) {
+        $query = $this->db->getQueryBuilder();
+        $query2 = $this->db->getQueryBuilder();
+        $query2->selectDistinct('cp.cardid')->from($this->dbCardsPropertiesTable, 'cp');
+        foreach ($searchProperties as $property) {
+            $query2->orWhere(
+                $query2->expr()->andX(
+                    $query2->expr()->eq('cp.name', $query->createNamedParameter($property)),
+                    $query2->expr()->ilike('cp.value', $query->createNamedParameter('%' . $this->db->escapeLikeParameter($pattern) . '%'))
+                )
+            );
+        }
+        $query2->andWhere($query2->expr()->eq('cp.addressbookid', $query->createNamedParameter($addressBookId)));
+
+        $query->select('c.carddata', 'c.uri')->from($this->dbCardsTable, 'c')
+            ->where($query->expr()->in('c.id', $query->createFunction($query2->getSQL())));
+
+        $result = $query->execute();
+        $cards = $result->fetchAll();
+
+        $result->closeCursor();
+
+        return array_map(function($array) {
+            $array['carddata'] = $this->readBlob($array['carddata']);
+            return $array;
+        }, $cards);
+    }
+
+    /**
+     * @param int $bookId
+     * @param string $name
+     * @return array
+     */
+    public function collectCardProperties($bookId, $name) {
+        $query = $this->db->getQueryBuilder();
+        $result = $query->selectDistinct('value')
+            ->from($this->dbCardsPropertiesTable)
+            ->where($query->expr()->eq('name', $query->createNamedParameter($name)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($bookId)))
+            ->execute();
+
+        $all = $result->fetchAll(PDO::FETCH_COLUMN);
+        $result->closeCursor();
+
+        return $all;
+    }
+
+    /**
+     * get URI from a given contact
+     *
+     * @param int $id
+     * @return string
+     */
+    public function getCardUri($id) {
+        $query = $this->db->getQueryBuilder();
+        $query->select('uri')->from($this->dbCardsTable)
+                ->where($query->expr()->eq('id', $query->createParameter('id')))
+                ->setParameter('id', $id);
+
+        $result = $query->execute();
+        $uri = $result->fetch();
+        $result->closeCursor();
+
+        if (!isset($uri['uri'])) {
+            throw new \InvalidArgumentException('Card does not exists: ' . $id);
+        }
+
+        return $uri['uri'];
+    }
+
+    /**
+     * return contact with the given URI
+     *
+     * @param int $addressBookId
+     * @param string $uri
+     * @returns array
+     */
+    public function getContact($addressBookId, $uri) {
+        $result = [];
+        $query = $this->db->getQueryBuilder();
+        $query->select('*')->from($this->dbCardsTable)
+                ->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
+                ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+        $queryResult = $query->execute();
+        $contact = $queryResult->fetch();
+        $queryResult->closeCursor();
+
+        if (is_array($contact)) {
+            $result = $contact;
+        }
+
+        return $result;
+    }
+
+    /**
+     * Returns the list of people whom this address book is shared with.
+     *
+     * Every element in this array should have the following properties:
+     *   * href - Often a mailto: address
+     *   * commonName - Optional, for example a first + last name
+     *   * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants.
+     *   * readOnly - boolean
+     *   * summary - Optional, a description for the share
+     *
+     * @return array
+     */
+    public function getShares($addressBookId) {
+        return $this->sharingBackend->getShares($addressBookId);
+    }
+
+    /**
+     * update properties table
+     *
+     * @param int $addressBookId
+     * @param string $cardUri
+     * @param string $vCardSerialized
+     */
+    protected function updateProperties($addressBookId, $cardUri, $vCardSerialized) {
+        $cardId = $this->getCardId($addressBookId, $cardUri);
+        $vCard = $this->readCard($vCardSerialized);
+
+        $this->purgeProperties($addressBookId, $cardId);
+
+        $query = $this->db->getQueryBuilder();
+        $query->insert($this->dbCardsPropertiesTable)
+            ->values(
+                [
+                    'addressbookid' => $query->createNamedParameter($addressBookId),
+                    'cardid' => $query->createNamedParameter($cardId),
+                    'name' => $query->createParameter('name'),
+                    'value' => $query->createParameter('value'),
+                    'preferred' => $query->createParameter('preferred')
+                ]
+            );
+
+        foreach ($vCard->children() as $property) {
+            if(!in_array($property->name, self::$indexProperties)) {
+                continue;
+            }
+            $preferred = 0;
+            foreach($property->parameters as $parameter) {
+                if ($parameter->name == 'TYPE' && strtoupper($parameter->getValue()) == 'PREF') {
+                    $preferred = 1;
+                    break;
+                }
+            }
+            $query->setParameter('name', $property->name);
+            $query->setParameter('value', substr($property->getValue(), 0, 254));
+            $query->setParameter('preferred', $preferred);
+            $query->execute();
+        }
+    }
+
+    /**
+     * read vCard data into a vCard object
+     *
+     * @param string $cardData
+     * @return VCard
+     */
+    protected function readCard($cardData) {
+        return  Reader::read($cardData);
+    }
+
+    /**
+     * delete all properties from a given card
+     *
+     * @param int $addressBookId
+     * @param int $cardId
+     */
+    protected function purgeProperties($addressBookId, $cardId) {
+        $query = $this->db->getQueryBuilder();
+        $query->delete($this->dbCardsPropertiesTable)
+            ->where($query->expr()->eq('cardid', $query->createNamedParameter($cardId)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+        $query->execute();
+    }
+
+    /**
+     * get ID from a given contact
+     *
+     * @param int $addressBookId
+     * @param string $uri
+     * @return int
+     */
+    protected function getCardId($addressBookId, $uri) {
+        $query = $this->db->getQueryBuilder();
+        $query->select('id')->from($this->dbCardsTable)
+            ->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+
+        $result = $query->execute();
+        $cardIds = $result->fetch();
+        $result->closeCursor();
+
+        if (!isset($cardIds['id'])) {
+            throw new \InvalidArgumentException('Card does not exists: ' . $uri);
+        }
+
+        return (int)$cardIds['id'];
+    }
+
+    /**
+     * For shared address books the sharee is set in the ACL of the address book
+     * @param $addressBookId
+     * @param $acl
+     * @return array
+     */
+    public function applyShareAcl($addressBookId, $acl) {
+        return $this->sharingBackend->applyShareAcl($addressBookId, $acl);
+    }
+
+    private function convertPrincipal($principalUri, $toV2) {
+        if ($this->principalBackend->getPrincipalPrefix() === 'principals') {
+            list(, $name) = URLUtil::splitPath($principalUri);
+            if ($toV2 === true) {
+                return "principals/users/$name";
+            }
+            return "principals/$name";
+        }
+        return $principalUri;
+    }
 }

Spacing +47 added lines, -47 removed lines

@@ -114,7 +114,7 @@ 
 			->from('addressbooks')
 			->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
 
-		return (int)$query->execute()->fetchColumn();
+		return (int) $query->execute()->fetchColumn();
 	}
 
 	/**
@@ -145,22 +145,22 @@ 
 		$addressBooks = [];
 
 		$result = $query->execute();
-		while($row = $result->fetch()) {
+		while ($row = $result->fetch()) {
 			$addressBooks[$row['id']] = [
 				'id'  => $row['id'],
 				'uri' => $row['uri'],
 				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
 				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+				'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+				'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
 			];
 		}
 		$result->closeCursor();
 
 		// query for shared calendars
 		$principals = $this->principalBackend->getGroupMembership($principalUriOriginal, true);
-		$principals[]= $principalUri;
+		$principals[] = $principalUri;
 
 		$query = $this->db->getQueryBuilder();
 		$result = $query->select(['a.id', 'a.uri', 'a.displayname', 'a.principaluri', 'a.description', 'a.synctoken', 's.access'])
@@ -172,21 +172,21 @@ 
 			->setParameter('principaluri', $principals, IQueryBuilder::PARAM_STR_ARRAY)
 			->execute();
 
-		while($row = $result->fetch()) {
+		while ($row = $result->fetch()) {
 			list(, $name) = URLUtil::splitPath($row['principaluri']);
-			$uri = $row['uri'] . '_shared_by_' . $name;
-			$displayName = $row['displayname'] . ' (' . $this->getUserDisplayName($name) . ')';
+			$uri = $row['uri'].'_shared_by_'.$name;
+			$displayName = $row['displayname'].' ('.$this->getUserDisplayName($name).')';
 			if (!isset($addressBooks[$row['id']])) {
 				$addressBooks[$row['id']] = [
 					'id'  => $row['id'],
 					'uri' => $uri,
 					'principaluri' => $principalUri,
 					'{DAV:}displayname' => $displayName,
-					'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+					'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 					'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-					'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-					'{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal' => $row['principaluri'],
-					'{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}read-only' => (int)$row['access'] === Backend::ACCESS_READ,
+					'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
+					'{'.\OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD.'}owner-principal' => $row['principaluri'],
+					'{'.\OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD.'}read-only' => (int) $row['access'] === Backend::ACCESS_READ,
 				];
 			}
 		}
@@ -206,15 +206,15 @@ 
 		$addressBooks = [];
 
 		$result = $query->execute();
-		while($row = $result->fetch()) {
+		while ($row = $result->fetch()) {
 			$addressBooks[$row['id']] = [
 				'id'  => $row['id'],
 				'uri' => $row['uri'],
 				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
 				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+				'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+				'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
 			];
 		}
 		$result->closeCursor();
@@ -257,9 +257,9 @@ 
 			'uri' => $row['uri'],
 			'principaluri' => $row['principaluri'],
 			'{DAV:}displayname' => $row['displayname'],
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+			'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 			'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-			'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+			'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
 		];
 	}
 
@@ -287,9 +287,9 @@ 
 				'uri' => $row['uri'],
 				'principaluri' => $row['principaluri'],
 				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+				'{'.Plugin::NS_CARDDAV.'}addressbook-description' => $row['description'],
 				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+				'{http://sabredav.org/ns}sync-token' => $row['synctoken'] ? $row['synctoken'] : '0',
 			];
 	}
 
@@ -312,19 +312,19 @@ 
 	function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
 		$supportedProperties = [
 			'{DAV:}displayname',
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description',
+			'{'.Plugin::NS_CARDDAV.'}addressbook-description',
 		];
 
 		$propPatch->handle($supportedProperties, function($mutations) use ($addressBookId) {
 
 			$updates = [];
-			foreach($mutations as $property=>$newValue) {
+			foreach ($mutations as $property=>$newValue) {
 
-				switch($property) {
+				switch ($property) {
 					case '{DAV:}displayname' :
 						$updates['displayname'] = $newValue;
 						break;
-					case '{' . Plugin::NS_CARDDAV . '}addressbook-description' :
+					case '{'.Plugin::NS_CARDDAV.'}addressbook-description' :
 						$updates['description'] = $newValue;
 						break;
 				}
@@ -332,7 +332,7 @@ 
 			$query = $this->db->getQueryBuilder();
 			$query->update('addressbooks');
 
-			foreach($updates as $key=>$value) {
+			foreach ($updates as $key=>$value) {
 				$query->set($key, $query->createNamedParameter($value));
 			}
 			$query->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
@@ -363,24 +363,24 @@ 
 			'synctoken' => 1
 		];
 
-		foreach($properties as $property=>$newValue) {
+		foreach ($properties as $property=>$newValue) {
 
-			switch($property) {
+			switch ($property) {
 				case '{DAV:}displayname' :
 					$values['displayname'] = $newValue;
 					break;
-				case '{' . Plugin::NS_CARDDAV . '}addressbook-description' :
+				case '{'.Plugin::NS_CARDDAV.'}addressbook-description' :
 					$values['description'] = $newValue;
 					break;
 				default :
-					throw new BadRequest('Unknown property: ' . $property);
+					throw new BadRequest('Unknown property: '.$property);
 			}
 
 		}
 
 		// Fallback to make sure the displayname is set. Some clients may refuse
 		// to work with addressbooks not having a displayname.
-		if(is_null($values['displayname'])) {
+		if (is_null($values['displayname'])) {
 			$values['displayname'] = $url;
 		}
 
@@ -458,8 +458,8 @@ 
 		$cards = [];
 
 		$result = $query->execute();
-		while($row = $result->fetch()) {
-			$row['etag'] = '"' . $row['etag'] . '"';
+		while ($row = $result->fetch()) {
+			$row['etag'] = '"'.$row['etag'].'"';
 			$row['carddata'] = $this->readBlob($row['carddata']);
 			$cards[] = $row;
 		}
@@ -493,7 +493,7 @@ 
 		if (!$row) {
 			return false;
 		}
-		$row['etag'] = '"' . $row['etag'] . '"';
+		$row['etag'] = '"'.$row['etag'].'"';
 		$row['carddata'] = $this->readBlob($row['carddata']);
 
 		return $row;
@@ -530,7 +530,7 @@ 
 			$result = $query->execute();
 
 			while ($row = $result->fetch()) {
-				$row['etag'] = '"' . $row['etag'] . '"';
+				$row['etag'] = '"'.$row['etag'].'"';
 				$row['carddata'] = $this->readBlob($row['carddata']);
 				$cards[] = $row;
 			}
@@ -590,7 +590,7 @@ 
 					'cardData' => $cardData]));
 		}
 
-		return '"' . $etag . '"';
+		return '"'.$etag.'"';
 	}
 
 	/**
@@ -642,7 +642,7 @@ 
 					'cardData' => $cardData]));
 		}
 
-		return '"' . $etag . '"';
+		return '"'.$etag.'"';
 	}
 
 	/**
@@ -742,7 +742,7 @@ 
 	function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
 		// Current synctoken
 		$stmt = $this->db->prepare('SELECT `synctoken` FROM `*PREFIX*addressbooks` WHERE `id` = ?');
-		$stmt->execute([ $addressBookId ]);
+		$stmt->execute([$addressBookId]);
 		$currentToken = $stmt->fetchColumn(0);
 
 		if (is_null($currentToken)) return null;
@@ -757,8 +757,8 @@ 
 		if ($syncToken) {
 
 			$query = "SELECT `uri`, `operation` FROM `*PREFIX*addressbookchanges` WHERE `synctoken` >= ? AND `synctoken` < ? AND `addressbookid` = ? ORDER BY `synctoken`";
-			if ($limit>0) {
-				$query .= " `LIMIT` " . (int)$limit;
+			if ($limit > 0) {
+				$query .= " `LIMIT` ".(int) $limit;
 			}
 
 			// Fetching all changes
@@ -769,15 +769,15 @@ 
 
 			// This loop ensures that any duplicates are overwritten, only the
 			// last change on a node is relevant.
-			while($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+			while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
 
 				$changes[$row['uri']] = $row['operation'];
 
 			}
 
-			foreach($changes as $uri => $operation) {
+			foreach ($changes as $uri => $operation) {
 
-				switch($operation) {
+				switch ($operation) {
 					case 1:
 						$result['added'][] = $uri;
 						break;
@@ -857,7 +857,7 @@ 
 			$query2->orWhere(
 				$query2->expr()->andX(
 					$query2->expr()->eq('cp.name', $query->createNamedParameter($property)),
-					$query2->expr()->ilike('cp.value', $query->createNamedParameter('%' . $this->db->escapeLikeParameter($pattern) . '%'))
+					$query2->expr()->ilike('cp.value', $query->createNamedParameter('%'.$this->db->escapeLikeParameter($pattern).'%'))
 				)
 			);
 		}
@@ -913,7 +913,7 @@ 
 		$result->closeCursor();
 
 		if (!isset($uri['uri'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $id);
+			throw new \InvalidArgumentException('Card does not exists: '.$id);
 		}
 
 		return $uri['uri'];
@@ -985,11 +985,11 @@ 
 			);
 
 		foreach ($vCard->children() as $property) {
-			if(!in_array($property->name, self::$indexProperties)) {
+			if (!in_array($property->name, self::$indexProperties)) {
 				continue;
 			}
 			$preferred = 0;
-			foreach($property->parameters as $parameter) {
+			foreach ($property->parameters as $parameter) {
 				if ($parameter->name == 'TYPE' && strtoupper($parameter->getValue()) == 'PREF') {
 					$preferred = 1;
 					break;
@@ -1044,10 +1044,10 @@ 
 		$result->closeCursor();
 
 		if (!isset($cardIds['id'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $uri);
+			throw new \InvalidArgumentException('Card does not exists: '.$uri);
 		}
 
-		return (int)$cardIds['id'];
+		return (int) $cardIds['id'];
 	}
 
 	/**

Braces +3 added lines, -1 removed lines

@@ -745,7 +745,9 @@
 		$stmt->execute([ $addressBookId ]);
 		$currentToken = $stmt->fetchColumn(0);
 
-		if (is_null($currentToken)) return null;
+		if (is_null($currentToken)) {
+		    return null;
+		}
 
 		$result = [
 			'syncToken' => $currentToken,

apps/files/lib/Controller/ViewController.php

Unused Use Statements -1 removed lines

@@ -35,7 +35,6 @@
 use OCP\Files\NotFoundException;
 use OCP\IConfig;
 use OCP\IL10N;
-use OCP\INavigationManager;
 use OCP\IRequest;
 use OCP\IURLGenerator;
 use OCP\IUserSession;

Indentation +215 added lines, -215 removed lines

@@ -49,241 +49,241 @@
  * @package OCA\Files\Controller
  */
 class ViewController extends Controller {
-	/** @var string */
-	protected $appName;
-	/** @var IRequest */
-	protected $request;
-	/** @var IURLGenerator */
-	protected $urlGenerator;
-	/** @var IL10N */
-	protected $l10n;
-	/** @var IConfig */
-	protected $config;
-	/** @var EventDispatcherInterface */
-	protected $eventDispatcher;
-	/** @var IUserSession */
-	protected $userSession;
-	/** @var IAppManager */
-	protected $appManager;
-	/** @var IRootFolder */
-	protected $rootFolder;
+    /** @var string */
+    protected $appName;
+    /** @var IRequest */
+    protected $request;
+    /** @var IURLGenerator */
+    protected $urlGenerator;
+    /** @var IL10N */
+    protected $l10n;
+    /** @var IConfig */
+    protected $config;
+    /** @var EventDispatcherInterface */
+    protected $eventDispatcher;
+    /** @var IUserSession */
+    protected $userSession;
+    /** @var IAppManager */
+    protected $appManager;
+    /** @var IRootFolder */
+    protected $rootFolder;
 
-	/**
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param IURLGenerator $urlGenerator
-	 * @param IL10N $l10n
-	 * @param IConfig $config
-	 * @param EventDispatcherInterface $eventDispatcherInterface
-	 * @param IUserSession $userSession
-	 * @param IAppManager $appManager
-	 * @param IRootFolder $rootFolder
-	 */
-	public function __construct($appName,
-								IRequest $request,
-								IURLGenerator $urlGenerator,
-								IL10N $l10n,
-								IConfig $config,
-								EventDispatcherInterface $eventDispatcherInterface,
-								IUserSession $userSession,
-								IAppManager $appManager,
-								IRootFolder $rootFolder
-	) {
-		parent::__construct($appName, $request);
-		$this->appName = $appName;
-		$this->request = $request;
-		$this->urlGenerator = $urlGenerator;
-		$this->l10n = $l10n;
-		$this->config = $config;
-		$this->eventDispatcher = $eventDispatcherInterface;
-		$this->userSession = $userSession;
-		$this->appManager = $appManager;
-		$this->rootFolder = $rootFolder;
-	}
+    /**
+     * @param string $appName
+     * @param IRequest $request
+     * @param IURLGenerator $urlGenerator
+     * @param IL10N $l10n
+     * @param IConfig $config
+     * @param EventDispatcherInterface $eventDispatcherInterface
+     * @param IUserSession $userSession
+     * @param IAppManager $appManager
+     * @param IRootFolder $rootFolder
+     */
+    public function __construct($appName,
+                                IRequest $request,
+                                IURLGenerator $urlGenerator,
+                                IL10N $l10n,
+                                IConfig $config,
+                                EventDispatcherInterface $eventDispatcherInterface,
+                                IUserSession $userSession,
+                                IAppManager $appManager,
+                                IRootFolder $rootFolder
+    ) {
+        parent::__construct($appName, $request);
+        $this->appName = $appName;
+        $this->request = $request;
+        $this->urlGenerator = $urlGenerator;
+        $this->l10n = $l10n;
+        $this->config = $config;
+        $this->eventDispatcher = $eventDispatcherInterface;
+        $this->userSession = $userSession;
+        $this->appManager = $appManager;
+        $this->rootFolder = $rootFolder;
+    }
 
-	/**
-	 * @param string $appName
-	 * @param string $scriptName
-	 * @return string
-	 */
-	protected function renderScript($appName, $scriptName) {
-		$content = '';
-		$appPath = \OC_App::getAppPath($appName);
-		$scriptPath = $appPath . '/' . $scriptName;
-		if (file_exists($scriptPath)) {
-			// TODO: sanitize path / script name ?
-			ob_start();
-			include $scriptPath;
-			$content = ob_get_contents();
-			@ob_end_clean();
-		}
-		return $content;
-	}
+    /**
+     * @param string $appName
+     * @param string $scriptName
+     * @return string
+     */
+    protected function renderScript($appName, $scriptName) {
+        $content = '';
+        $appPath = \OC_App::getAppPath($appName);
+        $scriptPath = $appPath . '/' . $scriptName;
+        if (file_exists($scriptPath)) {
+            // TODO: sanitize path / script name ?
+            ob_start();
+            include $scriptPath;
+            $content = ob_get_contents();
+            @ob_end_clean();
+        }
+        return $content;
+    }
 
-	/**
-	 * FIXME: Replace with non static code
-	 *
-	 * @return array
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	protected function getStorageInfo() {
-		$dirInfo = \OC\Files\Filesystem::getFileInfo('/', false);
-		return \OC_Helper::getStorageInfo('/', $dirInfo);
-	}
+    /**
+     * FIXME: Replace with non static code
+     *
+     * @return array
+     * @throws \OCP\Files\NotFoundException
+     */
+    protected function getStorageInfo() {
+        $dirInfo = \OC\Files\Filesystem::getFileInfo('/', false);
+        return \OC_Helper::getStorageInfo('/', $dirInfo);
+    }
 
-	/**
-	 * @NoCSRFRequired
-	 * @NoAdminRequired
-	 *
-	 * @param string $dir
-	 * @param string $view
-	 * @param string $fileid
-	 * @return TemplateResponse|RedirectResponse
-	 */
-	public function index($dir = '', $view = '', $fileid = null, $fileNotFound = false) {
-		if ($fileid !== null) {
-			try {
-				return $this->showFile($fileid);
-			} catch (NotFoundException $e) {
-				return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.index', ['fileNotFound' => true]));
-			}
-		}
+    /**
+     * @NoCSRFRequired
+     * @NoAdminRequired
+     *
+     * @param string $dir
+     * @param string $view
+     * @param string $fileid
+     * @return TemplateResponse|RedirectResponse
+     */
+    public function index($dir = '', $view = '', $fileid = null, $fileNotFound = false) {
+        if ($fileid !== null) {
+            try {
+                return $this->showFile($fileid);
+            } catch (NotFoundException $e) {
+                return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.index', ['fileNotFound' => true]));
+            }
+        }
 
-		$nav = new \OCP\Template('files', 'appnavigation', '');
+        $nav = new \OCP\Template('files', 'appnavigation', '');
 
-		// Load the files we need
-		\OCP\Util::addStyle('files', 'files');
-		\OCP\Util::addStyle('files', 'upload');
-		\OCP\Util::addStyle('files', 'mobile');
-		\OCP\Util::addScript('files', 'app');
-		\OCP\Util::addScript('files', 'file-upload');
-		\OCP\Util::addScript('files', 'newfilemenu');
-		\OCP\Util::addScript('files', 'jquery.fileupload');
-		\OCP\Util::addScript('files', 'jquery-visibility');
-		\OCP\Util::addScript('files', 'fileinfomodel');
-		\OCP\Util::addScript('files', 'filesummary');
-		\OCP\Util::addScript('files', 'breadcrumb');
-		\OCP\Util::addScript('files', 'filelist');
-		\OCP\Util::addScript('files', 'search');
+        // Load the files we need
+        \OCP\Util::addStyle('files', 'files');
+        \OCP\Util::addStyle('files', 'upload');
+        \OCP\Util::addStyle('files', 'mobile');
+        \OCP\Util::addScript('files', 'app');
+        \OCP\Util::addScript('files', 'file-upload');
+        \OCP\Util::addScript('files', 'newfilemenu');
+        \OCP\Util::addScript('files', 'jquery.fileupload');
+        \OCP\Util::addScript('files', 'jquery-visibility');
+        \OCP\Util::addScript('files', 'fileinfomodel');
+        \OCP\Util::addScript('files', 'filesummary');
+        \OCP\Util::addScript('files', 'breadcrumb');
+        \OCP\Util::addScript('files', 'filelist');
+        \OCP\Util::addScript('files', 'search');
 
-		\OCP\Util::addScript('files', 'favoritesfilelist');
-		\OCP\Util::addScript('files', 'recentfilelist');
-		\OCP\Util::addScript('files', 'tagsplugin');
-		\OCP\Util::addScript('files', 'gotoplugin');
-		\OCP\Util::addScript('files', 'favoritesplugin');
-		\OCP\Util::addScript('files', 'recentplugin');
+        \OCP\Util::addScript('files', 'favoritesfilelist');
+        \OCP\Util::addScript('files', 'recentfilelist');
+        \OCP\Util::addScript('files', 'tagsplugin');
+        \OCP\Util::addScript('files', 'gotoplugin');
+        \OCP\Util::addScript('files', 'favoritesplugin');
+        \OCP\Util::addScript('files', 'recentplugin');
 
-		\OCP\Util::addScript('files', 'detailfileinfoview');
-		\OCP\Util::addScript('files', 'sidebarpreviewmanager');
-		\OCP\Util::addScript('files', 'sidebarpreviewtext');
-		\OCP\Util::addScript('files', 'detailtabview');
-		\OCP\Util::addScript('files', 'mainfileinfodetailview');
-		\OCP\Util::addScript('files', 'detailsview');
-		\OCP\Util::addStyle('files', 'detailsView');
+        \OCP\Util::addScript('files', 'detailfileinfoview');
+        \OCP\Util::addScript('files', 'sidebarpreviewmanager');
+        \OCP\Util::addScript('files', 'sidebarpreviewtext');
+        \OCP\Util::addScript('files', 'detailtabview');
+        \OCP\Util::addScript('files', 'mainfileinfodetailview');
+        \OCP\Util::addScript('files', 'detailsview');
+        \OCP\Util::addStyle('files', 'detailsView');
 
-		\OC_Util::addVendorScript('core', 'handlebars/handlebars');
+        \OC_Util::addVendorScript('core', 'handlebars/handlebars');
 
-		\OCP\Util::addScript('files', 'fileactions');
-		\OCP\Util::addScript('files', 'fileactionsmenu');
-		\OCP\Util::addScript('files', 'files');
-		\OCP\Util::addScript('files', 'keyboardshortcuts');
-		\OCP\Util::addScript('files', 'navigation');
+        \OCP\Util::addScript('files', 'fileactions');
+        \OCP\Util::addScript('files', 'fileactionsmenu');
+        \OCP\Util::addScript('files', 'files');
+        \OCP\Util::addScript('files', 'keyboardshortcuts');
+        \OCP\Util::addScript('files', 'navigation');
 
-		// mostly for the home storage's free space
-		// FIXME: Make non static
-		$storageInfo = $this->getStorageInfo();
+        // mostly for the home storage's free space
+        // FIXME: Make non static
+        $storageInfo = $this->getStorageInfo();
 
-		\OCA\Files\App::getNavigationManager()->add(
-			[
-				'id' => 'favorites',
-				'appname' => 'files',
-				'script' => 'simplelist.php',
-				'order' => 5,
-				'name' => $this->l10n->t('Favorites')
-			]
-		);
+        \OCA\Files\App::getNavigationManager()->add(
+            [
+                'id' => 'favorites',
+                'appname' => 'files',
+                'script' => 'simplelist.php',
+                'order' => 5,
+                'name' => $this->l10n->t('Favorites')
+            ]
+        );
 
-		$navItems = \OCA\Files\App::getNavigationManager()->getAll();
-		usort($navItems, function($item1, $item2) {
-			return $item1['order'] - $item2['order'];
-		});
-		$nav->assign('navigationItems', $navItems);
+        $navItems = \OCA\Files\App::getNavigationManager()->getAll();
+        usort($navItems, function($item1, $item2) {
+            return $item1['order'] - $item2['order'];
+        });
+        $nav->assign('navigationItems', $navItems);
 
-		$contentItems = [];
+        $contentItems = [];
 
-		// render the container content for every navigation item
-		foreach ($navItems as $item) {
-			$content = '';
-			if (isset($item['script'])) {
-				$content = $this->renderScript($item['appname'], $item['script']);
-			}
-			$contentItem = [];
-			$contentItem['id'] = $item['id'];
-			$contentItem['content'] = $content;
-			$contentItems[] = $contentItem;
-		}
+        // render the container content for every navigation item
+        foreach ($navItems as $item) {
+            $content = '';
+            if (isset($item['script'])) {
+                $content = $this->renderScript($item['appname'], $item['script']);
+            }
+            $contentItem = [];
+            $contentItem['id'] = $item['id'];
+            $contentItem['content'] = $content;
+            $contentItems[] = $contentItem;
+        }
 
-		$this->eventDispatcher->dispatch('OCA\Files::loadAdditionalScripts');
+        $this->eventDispatcher->dispatch('OCA\Files::loadAdditionalScripts');
 
-		$params = [];
-		$params['usedSpacePercent'] = (int)$storageInfo['relative'];
-		$params['owner'] = $storageInfo['owner'];
-		$params['ownerDisplayName'] = $storageInfo['ownerDisplayName'];
-		$params['isPublic'] = false;
-		$params['allowShareWithLink'] = $this->config->getAppValue('core', 'shareapi_allow_links', 'yes');
-		$user = $this->userSession->getUser()->getUID();
-		$params['defaultFileSorting'] = $this->config->getUserValue($user, 'files', 'file_sorting', 'name');
-		$params['defaultFileSortingDirection'] = $this->config->getUserValue($user, 'files', 'file_sorting_direction', 'asc');
-		$showHidden = (bool) $this->config->getUserValue($this->userSession->getUser()->getUID(), 'files', 'show_hidden', false);
-		$params['showHiddenFiles'] = $showHidden ? 1 : 0;
-		$params['fileNotFound'] = $fileNotFound ? 1 : 0;
-		$params['appNavigation'] = $nav;
-		$params['appContents'] = $contentItems;
+        $params = [];
+        $params['usedSpacePercent'] = (int)$storageInfo['relative'];
+        $params['owner'] = $storageInfo['owner'];
+        $params['ownerDisplayName'] = $storageInfo['ownerDisplayName'];
+        $params['isPublic'] = false;
+        $params['allowShareWithLink'] = $this->config->getAppValue('core', 'shareapi_allow_links', 'yes');
+        $user = $this->userSession->getUser()->getUID();
+        $params['defaultFileSorting'] = $this->config->getUserValue($user, 'files', 'file_sorting', 'name');
+        $params['defaultFileSortingDirection'] = $this->config->getUserValue($user, 'files', 'file_sorting_direction', 'asc');
+        $showHidden = (bool) $this->config->getUserValue($this->userSession->getUser()->getUID(), 'files', 'show_hidden', false);
+        $params['showHiddenFiles'] = $showHidden ? 1 : 0;
+        $params['fileNotFound'] = $fileNotFound ? 1 : 0;
+        $params['appNavigation'] = $nav;
+        $params['appContents'] = $contentItems;
 
-		$response = new TemplateResponse(
-			$this->appName,
-			'index',
-			$params
-		);
-		$policy = new ContentSecurityPolicy();
-		$policy->addAllowedFrameDomain('\'self\'');
-		$response->setContentSecurityPolicy($policy);
+        $response = new TemplateResponse(
+            $this->appName,
+            'index',
+            $params
+        );
+        $policy = new ContentSecurityPolicy();
+        $policy->addAllowedFrameDomain('\'self\'');
+        $response->setContentSecurityPolicy($policy);
 
-		return $response;
-	}
+        return $response;
+    }
 
-	/**
-	 * Redirects to the file list and highlight the given file id
-	 *
-	 * @param string $fileId file id to show
-	 * @return RedirectResponse redirect response or not found response
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	private function showFile($fileId) {
-		$uid = $this->userSession->getUser()->getUID();
-		$baseFolder = $this->rootFolder->getUserFolder($uid);
-		$files = $baseFolder->getById($fileId);
-		$params = [];
+    /**
+     * Redirects to the file list and highlight the given file id
+     *
+     * @param string $fileId file id to show
+     * @return RedirectResponse redirect response or not found response
+     * @throws \OCP\Files\NotFoundException
+     */
+    private function showFile($fileId) {
+        $uid = $this->userSession->getUser()->getUID();
+        $baseFolder = $this->rootFolder->getUserFolder($uid);
+        $files = $baseFolder->getById($fileId);
+        $params = [];
 
-		if (empty($files) && $this->appManager->isEnabledForUser('files_trashbin')) {
-			$baseFolder = $this->rootFolder->get($uid . '/files_trashbin/files/');
-			$files = $baseFolder->getById($fileId);
-			$params['view'] = 'trashbin';
-		}
+        if (empty($files) && $this->appManager->isEnabledForUser('files_trashbin')) {
+            $baseFolder = $this->rootFolder->get($uid . '/files_trashbin/files/');
+            $files = $baseFolder->getById($fileId);
+            $params['view'] = 'trashbin';
+        }
 
-		if (!empty($files)) {
-			$file = current($files);
-			if ($file instanceof Folder) {
-				// set the full path to enter the folder
-				$params['dir'] = $baseFolder->getRelativePath($file->getPath());
-			} else {
-				// set parent path as dir
-				$params['dir'] = $baseFolder->getRelativePath($file->getParent()->getPath());
-				// and scroll to the entry
-				$params['scrollto'] = $file->getName();
-			}
-			return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.index', $params));
-		}
-		throw new \OCP\Files\NotFoundException();
-	}
+        if (!empty($files)) {
+            $file = current($files);
+            if ($file instanceof Folder) {
+                // set the full path to enter the folder
+                $params['dir'] = $baseFolder->getRelativePath($file->getPath());
+            } else {
+                // set parent path as dir
+                $params['dir'] = $baseFolder->getRelativePath($file->getParent()->getPath());
+                // and scroll to the entry
+                $params['scrollto'] = $file->getName();
+            }
+            return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.index', $params));
+        }
+        throw new \OCP\Files\NotFoundException();
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -109,7 +109,7 @@ 
 	protected function renderScript($appName, $scriptName) {
 		$content = '';
 		$appPath = \OC_App::getAppPath($appName);
-		$scriptPath = $appPath . '/' . $scriptName;
+		$scriptPath = $appPath.'/'.$scriptName;
 		if (file_exists($scriptPath)) {
 			// TODO: sanitize path / script name ?
 			ob_start();
@@ -226,7 +226,7 @@ 
 		$this->eventDispatcher->dispatch('OCA\Files::loadAdditionalScripts');
 
 		$params = [];
-		$params['usedSpacePercent'] = (int)$storageInfo['relative'];
+		$params['usedSpacePercent'] = (int) $storageInfo['relative'];
 		$params['owner'] = $storageInfo['owner'];
 		$params['ownerDisplayName'] = $storageInfo['ownerDisplayName'];
 		$params['isPublic'] = false;
@@ -266,7 +266,7 @@ 
 		$params = [];
 
 		if (empty($files) && $this->appManager->isEnabledForUser('files_trashbin')) {
-			$baseFolder = $this->rootFolder->get($uid . '/files_trashbin/files/');
+			$baseFolder = $this->rootFolder->get($uid.'/files_trashbin/files/');
 			$files = $baseFolder->getById($fileId);
 			$params['view'] = 'trashbin';
 		}