nextcloud / server

lib/private/Files/Storage/Flysystem.php

Doc Comments +3 added lines

@@ -54,6 +54,9 @@
 		$this->flysystem->addPlugin(new GetWithMetadata());
 	}
 
+	/**
+	 * @param string $path
+	 */
 	protected function buildPath($path) {
 		$fullPath = \OC\Files\Filesystem::normalizePath($this->root . '/' . $path);
 		return ltrim($fullPath, '/');

Indentation +201 added lines, -201 removed lines

@@ -35,223 +35,223 @@
  * To use: subclass and call $this->buildFlysystem with the flysystem adapter of choice
  */
 abstract class Flysystem extends Common {
-	/**
-	 * @var Filesystem
-	 */
-	protected $flysystem;
+    /**
+     * @var Filesystem
+     */
+    protected $flysystem;
 
-	/**
-	 * @var string
-	 */
-	protected $root = '';
+    /**
+     * @var string
+     */
+    protected $root = '';
 
-	/**
-	 * Initialize the storage backend with a flyssytem adapter
-	 *
-	 * @param \League\Flysystem\AdapterInterface $adapter
-	 */
-	protected function buildFlySystem(AdapterInterface $adapter) {
-		$this->flysystem = new Filesystem($adapter);
-		$this->flysystem->addPlugin(new GetWithMetadata());
-	}
+    /**
+     * Initialize the storage backend with a flyssytem adapter
+     *
+     * @param \League\Flysystem\AdapterInterface $adapter
+     */
+    protected function buildFlySystem(AdapterInterface $adapter) {
+        $this->flysystem = new Filesystem($adapter);
+        $this->flysystem->addPlugin(new GetWithMetadata());
+    }
 
-	protected function buildPath($path) {
-		$fullPath = \OC\Files\Filesystem::normalizePath($this->root . '/' . $path);
-		return ltrim($fullPath, '/');
-	}
+    protected function buildPath($path) {
+        $fullPath = \OC\Files\Filesystem::normalizePath($this->root . '/' . $path);
+        return ltrim($fullPath, '/');
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function file_get_contents($path) {
-		return $this->flysystem->read($this->buildPath($path));
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function file_get_contents($path) {
+        return $this->flysystem->read($this->buildPath($path));
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function file_put_contents($path, $data) {
-		return $this->flysystem->put($this->buildPath($path), $data);
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function file_put_contents($path, $data) {
+        return $this->flysystem->put($this->buildPath($path), $data);
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function file_exists($path) {
-		return $this->flysystem->has($this->buildPath($path));
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function file_exists($path) {
+        return $this->flysystem->has($this->buildPath($path));
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function unlink($path) {
-		if ($this->is_dir($path)) {
-			return $this->rmdir($path);
-		}
-		try {
-			return $this->flysystem->delete($this->buildPath($path));
-		} catch (FileNotFoundException $e) {
-			return false;
-		}
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function unlink($path) {
+        if ($this->is_dir($path)) {
+            return $this->rmdir($path);
+        }
+        try {
+            return $this->flysystem->delete($this->buildPath($path));
+        } catch (FileNotFoundException $e) {
+            return false;
+        }
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function rename($source, $target) {
-		if ($this->file_exists($target)) {
-			$this->unlink($target);
-		}
-		return $this->flysystem->rename($this->buildPath($source), $this->buildPath($target));
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function rename($source, $target) {
+        if ($this->file_exists($target)) {
+            $this->unlink($target);
+        }
+        return $this->flysystem->rename($this->buildPath($source), $this->buildPath($target));
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function copy($source, $target) {
-		if ($this->file_exists($target)) {
-			$this->unlink($target);
-		}
-		return $this->flysystem->copy($this->buildPath($source), $this->buildPath($target));
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function copy($source, $target) {
+        if ($this->file_exists($target)) {
+            $this->unlink($target);
+        }
+        return $this->flysystem->copy($this->buildPath($source), $this->buildPath($target));
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function filesize($path) {
-		if ($this->is_dir($path)) {
-			return 0;
-		} else {
-			return $this->flysystem->getSize($this->buildPath($path));
-		}
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function filesize($path) {
+        if ($this->is_dir($path)) {
+            return 0;
+        } else {
+            return $this->flysystem->getSize($this->buildPath($path));
+        }
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function mkdir($path) {
-		if ($this->file_exists($path)) {
-			return false;
-		}
-		return $this->flysystem->createDir($this->buildPath($path));
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function mkdir($path) {
+        if ($this->file_exists($path)) {
+            return false;
+        }
+        return $this->flysystem->createDir($this->buildPath($path));
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function filemtime($path) {
-		return $this->flysystem->getTimestamp($this->buildPath($path));
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function filemtime($path) {
+        return $this->flysystem->getTimestamp($this->buildPath($path));
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function rmdir($path) {
-		try {
-			return @$this->flysystem->deleteDir($this->buildPath($path));
-		} catch (FileNotFoundException $e) {
-			return false;
-		}
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function rmdir($path) {
+        try {
+            return @$this->flysystem->deleteDir($this->buildPath($path));
+        } catch (FileNotFoundException $e) {
+            return false;
+        }
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function opendir($path) {
-		try {
-			$content = $this->flysystem->listContents($this->buildPath($path));
-		} catch (FileNotFoundException $e) {
-			return false;
-		}
-		$names = array_map(function ($object) {
-			return $object['basename'];
-		}, $content);
-		return IteratorDirectory::wrap($names);
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function opendir($path) {
+        try {
+            $content = $this->flysystem->listContents($this->buildPath($path));
+        } catch (FileNotFoundException $e) {
+            return false;
+        }
+        $names = array_map(function ($object) {
+            return $object['basename'];
+        }, $content);
+        return IteratorDirectory::wrap($names);
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function fopen($path, $mode) {
-		$fullPath = $this->buildPath($path);
-		$useExisting = true;
-		switch ($mode) {
-			case 'r':
-			case 'rb':
-				try {
-					return $this->flysystem->readStream($fullPath);
-				} catch (FileNotFoundException $e) {
-					return false;
-				}
-			case 'w':
-			case 'w+':
-			case 'wb':
-			case 'wb+':
-				$useExisting = false;
-			case 'a':
-			case 'ab':
-			case 'r+':
-			case 'a+':
-			case 'x':
-			case 'x+':
-			case 'c':
-			case 'c+':
-				//emulate these
-				if ($useExisting and $this->file_exists($path)) {
-					if (!$this->isUpdatable($path)) {
-						return false;
-					}
-					$tmpFile = $this->getCachedFile($path);
-				} else {
-					if (!$this->isCreatable(dirname($path))) {
-						return false;
-					}
-					$tmpFile = \OCP\Files::tmpFile();
-				}
-				$source = fopen($tmpFile, $mode);
-				return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath) {
-					$this->flysystem->putStream($fullPath, fopen($tmpFile, 'r'));
-					unlink($tmpFile);
-				});
-		}
-		return false;
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function fopen($path, $mode) {
+        $fullPath = $this->buildPath($path);
+        $useExisting = true;
+        switch ($mode) {
+            case 'r':
+            case 'rb':
+                try {
+                    return $this->flysystem->readStream($fullPath);
+                } catch (FileNotFoundException $e) {
+                    return false;
+                }
+            case 'w':
+            case 'w+':
+            case 'wb':
+            case 'wb+':
+                $useExisting = false;
+            case 'a':
+            case 'ab':
+            case 'r+':
+            case 'a+':
+            case 'x':
+            case 'x+':
+            case 'c':
+            case 'c+':
+                //emulate these
+                if ($useExisting and $this->file_exists($path)) {
+                    if (!$this->isUpdatable($path)) {
+                        return false;
+                    }
+                    $tmpFile = $this->getCachedFile($path);
+                } else {
+                    if (!$this->isCreatable(dirname($path))) {
+                        return false;
+                    }
+                    $tmpFile = \OCP\Files::tmpFile();
+                }
+                $source = fopen($tmpFile, $mode);
+                return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath) {
+                    $this->flysystem->putStream($fullPath, fopen($tmpFile, 'r'));
+                    unlink($tmpFile);
+                });
+        }
+        return false;
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function touch($path, $mtime = null) {
-		if ($this->file_exists($path)) {
-			return false;
-		} else {
-			$this->file_put_contents($path, '');
-			return true;
-		}
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function touch($path, $mtime = null) {
+        if ($this->file_exists($path)) {
+            return false;
+        } else {
+            $this->file_put_contents($path, '');
+            return true;
+        }
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function stat($path) {
-		$info = $this->flysystem->getWithMetadata($this->buildPath($path), ['timestamp', 'size']);
-		return [
-			'mtime' => $info['timestamp'],
-			'size' => $info['size']
-		];
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function stat($path) {
+        $info = $this->flysystem->getWithMetadata($this->buildPath($path), ['timestamp', 'size']);
+        return [
+            'mtime' => $info['timestamp'],
+            'size' => $info['size']
+        ];
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function filetype($path) {
-		if ($path === '' or $path === '/' or $path === '.') {
-			return 'dir';
-		}
-		try {
-			$info = $this->flysystem->getMetadata($this->buildPath($path));
-		} catch (FileNotFoundException $e) {
-			return false;
-		}
-		return $info['type'];
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function filetype($path) {
+        if ($path === '' or $path === '/' or $path === '.') {
+            return 'dir';
+        }
+        try {
+            $info = $this->flysystem->getMetadata($this->buildPath($path));
+        } catch (FileNotFoundException $e) {
+            return false;
+        }
+        return $info['type'];
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -56,7 +56,7 @@ 
 	}
 
 	protected function buildPath($path) {
-		$fullPath = \OC\Files\Filesystem::normalizePath($this->root . '/' . $path);
+		$fullPath = \OC\Files\Filesystem::normalizePath($this->root.'/'.$path);
 		return ltrim($fullPath, '/');
 	}
 
@@ -163,7 +163,7 @@ 
 		} catch (FileNotFoundException $e) {
 			return false;
 		}
-		$names = array_map(function ($object) {
+		$names = array_map(function($object) {
 			return $object['basename'];
 		}, $content);
 		return IteratorDirectory::wrap($names);
@@ -209,7 +209,7 @@ 
 					$tmpFile = \OCP\Files::tmpFile();
 				}
 				$source = fopen($tmpFile, $mode);
-				return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath) {
+				return CallbackWrapper::wrap($source, null, null, function() use ($tmpFile, $fullPath) {
 					$this->flysystem->putStream($fullPath, fopen($tmpFile, 'r'));
 					unlink($tmpFile);
 				});

lib/private/Files/Storage/Wrapper/Quota.php

Doc Comments +1 added lines, -1 removed lines

@@ -159,7 +159,7 @@
 	 * Checks whether the given path is a part file
 	 *
 	 * @param string $path Path that may identify a .part file
-	 * @return string File path without .part extension
+	 * @return boolean File path without .part extension
 	 * @note this is needed for reusing keys
 	 */
 	private function isPartFile($path) {

Indentation +168 added lines, -168 removed lines

@@ -31,172 +31,172 @@
 
 class Quota extends Wrapper {
 
-	/**
-	 * @var int $quota
-	 */
-	protected $quota;
-
-	/**
-	 * @var string $sizeRoot
-	 */
-	protected $sizeRoot;
-
-	/**
-	 * @param array $parameters
-	 */
-	public function __construct($parameters) {
-		$this->storage = $parameters['storage'];
-		$this->quota = $parameters['quota'];
-		$this->sizeRoot = isset($parameters['root']) ? $parameters['root'] : '';
-	}
-
-	/**
-	 * @return int quota value
-	 */
-	public function getQuota() {
-		return $this->quota;
-	}
-
-	/**
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage $storage
-	 */
-	protected function getSize($path, $storage = null) {
-		if (is_null($storage)) {
-			$cache = $this->getCache();
-		} else {
-			$cache = $storage->getCache();
-		}
-		$data = $cache->get($path);
-		if ($data instanceof ICacheEntry and isset($data['size'])) {
-			return $data['size'];
-		} else {
-			return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
-		}
-	}
-
-	/**
-	 * Get free space as limited by the quota
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function free_space($path) {
-		if ($this->quota < 0) {
-			return $this->storage->free_space($path);
-		} else {
-			$used = $this->getSize($this->sizeRoot);
-			if ($used < 0) {
-				return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
-			} else {
-				$free = $this->storage->free_space($path);
-				$quotaFree = max($this->quota - $used, 0);
-				// if free space is known
-				if ($free >= 0) {
-					$free = min($free, $quotaFree);
-				} else {
-					$free = $quotaFree;
-				}
-				return $free;
-			}
-		}
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.file_put_contents.php
-	 *
-	 * @param string $path
-	 * @param string $data
-	 * @return bool
-	 */
-	public function file_put_contents($path, $data) {
-		$free = $this->free_space('');
-		if ($free < 0 or strlen($data) < $free) {
-			return $this->storage->file_put_contents($path, $data);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.copy.php
-	 *
-	 * @param string $source
-	 * @param string $target
-	 * @return bool
-	 */
-	public function copy($source, $target) {
-		$free = $this->free_space('');
-		if ($free < 0 or $this->getSize($source) < $free) {
-			return $this->storage->copy($source, $target);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource
-	 */
-	public function fopen($path, $mode) {
-		$source = $this->storage->fopen($path, $mode);
-
-		// don't apply quota for part files
-		if (!$this->isPartFile($path)) {
-			$free = $this->free_space('');
-			if ($source && $free >= 0 && $mode !== 'r' && $mode !== 'rb') {
-				// only apply quota for files, not metadata, trash or others
-				if (strpos(ltrim($path, '/'), 'files/') === 0) {
-					return \OC\Files\Stream\Quota::wrap($source, $free);
-				}
-			}
-		}
-		return $source;
-	}
-
-	/**
-	 * Checks whether the given path is a part file
-	 *
-	 * @param string $path Path that may identify a .part file
-	 * @return string File path without .part extension
-	 * @note this is needed for reusing keys
-	 */
-	private function isPartFile($path) {
-		$extension = pathinfo($path, PATHINFO_EXTENSION);
-
-		return ($extension === 'part');
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		$free = $this->free_space('');
-		if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) {
-			return $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		$free = $this->free_space('');
-		if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) {
-			return $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		} else {
-			return false;
-		}
-	}
+    /**
+     * @var int $quota
+     */
+    protected $quota;
+
+    /**
+     * @var string $sizeRoot
+     */
+    protected $sizeRoot;
+
+    /**
+     * @param array $parameters
+     */
+    public function __construct($parameters) {
+        $this->storage = $parameters['storage'];
+        $this->quota = $parameters['quota'];
+        $this->sizeRoot = isset($parameters['root']) ? $parameters['root'] : '';
+    }
+
+    /**
+     * @return int quota value
+     */
+    public function getQuota() {
+        return $this->quota;
+    }
+
+    /**
+     * @param string $path
+     * @param \OC\Files\Storage\Storage $storage
+     */
+    protected function getSize($path, $storage = null) {
+        if (is_null($storage)) {
+            $cache = $this->getCache();
+        } else {
+            $cache = $storage->getCache();
+        }
+        $data = $cache->get($path);
+        if ($data instanceof ICacheEntry and isset($data['size'])) {
+            return $data['size'];
+        } else {
+            return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
+        }
+    }
+
+    /**
+     * Get free space as limited by the quota
+     *
+     * @param string $path
+     * @return int
+     */
+    public function free_space($path) {
+        if ($this->quota < 0) {
+            return $this->storage->free_space($path);
+        } else {
+            $used = $this->getSize($this->sizeRoot);
+            if ($used < 0) {
+                return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
+            } else {
+                $free = $this->storage->free_space($path);
+                $quotaFree = max($this->quota - $used, 0);
+                // if free space is known
+                if ($free >= 0) {
+                    $free = min($free, $quotaFree);
+                } else {
+                    $free = $quotaFree;
+                }
+                return $free;
+            }
+        }
+    }
+
+    /**
+     * see http://php.net/manual/en/function.file_put_contents.php
+     *
+     * @param string $path
+     * @param string $data
+     * @return bool
+     */
+    public function file_put_contents($path, $data) {
+        $free = $this->free_space('');
+        if ($free < 0 or strlen($data) < $free) {
+            return $this->storage->file_put_contents($path, $data);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * see http://php.net/manual/en/function.copy.php
+     *
+     * @param string $source
+     * @param string $target
+     * @return bool
+     */
+    public function copy($source, $target) {
+        $free = $this->free_space('');
+        if ($free < 0 or $this->getSize($source) < $free) {
+            return $this->storage->copy($source, $target);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * see http://php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource
+     */
+    public function fopen($path, $mode) {
+        $source = $this->storage->fopen($path, $mode);
+
+        // don't apply quota for part files
+        if (!$this->isPartFile($path)) {
+            $free = $this->free_space('');
+            if ($source && $free >= 0 && $mode !== 'r' && $mode !== 'rb') {
+                // only apply quota for files, not metadata, trash or others
+                if (strpos(ltrim($path, '/'), 'files/') === 0) {
+                    return \OC\Files\Stream\Quota::wrap($source, $free);
+                }
+            }
+        }
+        return $source;
+    }
+
+    /**
+     * Checks whether the given path is a part file
+     *
+     * @param string $path Path that may identify a .part file
+     * @return string File path without .part extension
+     * @note this is needed for reusing keys
+     */
+    private function isPartFile($path) {
+        $extension = pathinfo($path, PATHINFO_EXTENSION);
+
+        return ($extension === 'part');
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        $free = $this->free_space('');
+        if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) {
+            return $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        $free = $this->free_space('');
+        if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) {
+            return $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        } else {
+            return false;
+        }
+    }
 }

lib/private/L10N/L10N.php

Doc Comments +1 added lines, -1 removed lines

@@ -176,7 +176,7 @@
 	 * Returns an associative array with all translations
 	 *
 	 * Called by \OC_L10N_String
-	 * @return array
+	 * @return string[]
 	 */
 	public function getTranslations() {
 		return $this->translations;

Indentation +192 added lines, -192 removed lines

@@ -29,196 +29,196 @@
 
 class L10N implements IL10N {
 
-	/** @var IFactory */
-	protected $factory;
-
-	/** @var string App of this object */
-	protected $app;
-
-	/** @var string Language of this object */
-	protected $lang;
-
-	/** @var string Plural forms (string) */
-	private $pluralFormString = 'nplurals=2; plural=(n != 1);';
-
-	/** @var string Plural forms (function) */
-	private $pluralFormFunction = null;
-
-	/** @var string[] */
-	private $translations = [];
-
-	/**
-	 * @param IFactory $factory
-	 * @param string $app
-	 * @param string $lang
-	 * @param array $files
-	 */
-	public function __construct(IFactory $factory, $app, $lang, array $files) {
-		$this->factory = $factory;
-		$this->app = $app;
-		$this->lang = $lang;
-
-		$this->translations = [];
-		foreach ($files as $languageFile) {
-			$this->load($languageFile);
-		}
-	}
-
-	/**
-	 * The code (en, de, ...) of the language that is used for this instance
-	 *
-	 * @return string language
-	 */
-	public function getLanguageCode() {
-		return $this->lang;
-	}
-
-	/**
-	 * Translating
-	 * @param string $text The text we need a translation for
-	 * @param array $parameters default:array() Parameters for sprintf
-	 * @return string Translation or the same text
-	 *
-	 * Returns the translation. If no translation is found, $text will be
-	 * returned.
-	 */
-	public function t($text, $parameters = array()) {
-		return (string) new L10NString($this, $text, $parameters);
-	}
-
-	/**
-	 * Translating
-	 * @param string $text_singular the string to translate for exactly one object
-	 * @param string $text_plural the string to translate for n objects
-	 * @param integer $count Number of objects
-	 * @param array $parameters default:array() Parameters for sprintf
-	 * @return string Translation or the same text
-	 *
-	 * Returns the translation. If no translation is found, $text will be
-	 * returned. %n will be replaced with the number of objects.
-	 *
-	 * The correct plural is determined by the plural_forms-function
-	 * provided by the po file.
-	 *
-	 */
-	public function n($text_singular, $text_plural, $count, $parameters = array()) {
-		$identifier = "_${text_singular}_::_${text_plural}_";
-		if (isset($this->translations[$identifier])) {
-			return (string) new L10NString($this, $identifier, $parameters, $count);
-		} else {
-			if ($count === 1) {
-				return (string) new L10NString($this, $text_singular, $parameters, $count);
-			} else {
-				return (string) new L10NString($this, $text_plural, $parameters, $count);
-			}
-		}
-	}
-
-	/**
-	 * Localization
-	 * @param string $type Type of localization
-	 * @param \DateTime|int|string $data parameters for this localization
-	 * @param array $options
-	 * @return string|int|false
-	 *
-	 * Returns the localized data.
-	 *
-	 * Implemented types:
-	 *  - date
-	 *    - Creates a date
-	 *    - params: timestamp (int/string)
-	 *  - datetime
-	 *    - Creates date and time
-	 *    - params: timestamp (int/string)
-	 *  - time
-	 *    - Creates a time
-	 *    - params: timestamp (int/string)
-	 *  - firstday: Returns the first day of the week (0 sunday - 6 saturday)
-	 *  - jsdate: Returns the short JS date format
-	 */
-	public function l($type, $data = null, $options = array()) {
-		// Use the language of the instance
-		$locale = $this->getLanguageCode();
-		if ($locale === 'sr@latin') {
-			$locale = 'sr_latn';
-		}
-
-		if ($type === 'firstday') {
-			return (int) Calendar::getFirstWeekday($locale);
-		}
-		if ($type === 'jsdate') {
-			return (string) Calendar::getDateFormat('short', $locale);
-		}
-
-		$value = new \DateTime();
-		if ($data instanceof \DateTime) {
-			$value = $data;
-		} else if (is_string($data) && !is_numeric($data)) {
-			$data = strtotime($data);
-			$value->setTimestamp($data);
-		} else if ($data !== null) {
-			$value->setTimestamp($data);
-		}
-
-		$options = array_merge(array('width' => 'long'), $options);
-		$width = $options['width'];
-		switch ($type) {
-			case 'date':
-				return (string) Calendar::formatDate($value, $width, $locale);
-			case 'datetime':
-				return (string) Calendar::formatDatetime($value, $width, $locale);
-			case 'time':
-				return (string) Calendar::formatTime($value, $width, $locale);
-			case 'weekdayName':
-				return (string) Calendar::getWeekdayName($value, $width, $locale);
-			default:
-				return false;
-		}
-	}
-
-	/**
-	 * Returns an associative array with all translations
-	 *
-	 * Called by \OC_L10N_String
-	 * @return array
-	 */
-	public function getTranslations() {
-		return $this->translations;
-	}
-
-	/**
-	 * Returnsed function accepts the argument $n
-	 *
-	 * Called by \OC_L10N_String
-	 * @return string the plural form function
-	 */
-	public function getPluralFormFunction() {
-		if (is_null($this->pluralFormFunction)) {
-			$lang = $this->getLanguageCode();
-			$this->pluralFormFunction = function($n) use ($lang) {
-				return PluralizationRules::get($n, $lang);
-			};
-		}
-
-		return $this->pluralFormFunction;
-	}
-
-	/**
-	 * @param $translationFile
-	 * @return bool
-	 */
-	protected function load($translationFile) {
-		$json = json_decode(file_get_contents($translationFile), true);
-		if (!is_array($json)) {
-			$jsonError = json_last_error();
-			\OC::$server->getLogger()->warning("Failed to load $translationFile - json error code: $jsonError", ['app' => 'l10n']);
-			return false;
-		}
-
-		if (!empty($json['pluralForm'])) {
-			$this->pluralFormString = $json['pluralForm'];
-		}
-		$this->translations = array_merge($this->translations, $json['translations']);
-		return true;
-	}
+    /** @var IFactory */
+    protected $factory;
+
+    /** @var string App of this object */
+    protected $app;
+
+    /** @var string Language of this object */
+    protected $lang;
+
+    /** @var string Plural forms (string) */
+    private $pluralFormString = 'nplurals=2; plural=(n != 1);';
+
+    /** @var string Plural forms (function) */
+    private $pluralFormFunction = null;
+
+    /** @var string[] */
+    private $translations = [];
+
+    /**
+     * @param IFactory $factory
+     * @param string $app
+     * @param string $lang
+     * @param array $files
+     */
+    public function __construct(IFactory $factory, $app, $lang, array $files) {
+        $this->factory = $factory;
+        $this->app = $app;
+        $this->lang = $lang;
+
+        $this->translations = [];
+        foreach ($files as $languageFile) {
+            $this->load($languageFile);
+        }
+    }
+
+    /**
+     * The code (en, de, ...) of the language that is used for this instance
+     *
+     * @return string language
+     */
+    public function getLanguageCode() {
+        return $this->lang;
+    }
+
+    /**
+     * Translating
+     * @param string $text The text we need a translation for
+     * @param array $parameters default:array() Parameters for sprintf
+     * @return string Translation or the same text
+     *
+     * Returns the translation. If no translation is found, $text will be
+     * returned.
+     */
+    public function t($text, $parameters = array()) {
+        return (string) new L10NString($this, $text, $parameters);
+    }
+
+    /**
+     * Translating
+     * @param string $text_singular the string to translate for exactly one object
+     * @param string $text_plural the string to translate for n objects
+     * @param integer $count Number of objects
+     * @param array $parameters default:array() Parameters for sprintf
+     * @return string Translation or the same text
+     *
+     * Returns the translation. If no translation is found, $text will be
+     * returned. %n will be replaced with the number of objects.
+     *
+     * The correct plural is determined by the plural_forms-function
+     * provided by the po file.
+     *
+     */
+    public function n($text_singular, $text_plural, $count, $parameters = array()) {
+        $identifier = "_${text_singular}_::_${text_plural}_";
+        if (isset($this->translations[$identifier])) {
+            return (string) new L10NString($this, $identifier, $parameters, $count);
+        } else {
+            if ($count === 1) {
+                return (string) new L10NString($this, $text_singular, $parameters, $count);
+            } else {
+                return (string) new L10NString($this, $text_plural, $parameters, $count);
+            }
+        }
+    }
+
+    /**
+     * Localization
+     * @param string $type Type of localization
+     * @param \DateTime|int|string $data parameters for this localization
+     * @param array $options
+     * @return string|int|false
+     *
+     * Returns the localized data.
+     *
+     * Implemented types:
+     *  - date
+     *    - Creates a date
+     *    - params: timestamp (int/string)
+     *  - datetime
+     *    - Creates date and time
+     *    - params: timestamp (int/string)
+     *  - time
+     *    - Creates a time
+     *    - params: timestamp (int/string)
+     *  - firstday: Returns the first day of the week (0 sunday - 6 saturday)
+     *  - jsdate: Returns the short JS date format
+     */
+    public function l($type, $data = null, $options = array()) {
+        // Use the language of the instance
+        $locale = $this->getLanguageCode();
+        if ($locale === 'sr@latin') {
+            $locale = 'sr_latn';
+        }
+
+        if ($type === 'firstday') {
+            return (int) Calendar::getFirstWeekday($locale);
+        }
+        if ($type === 'jsdate') {
+            return (string) Calendar::getDateFormat('short', $locale);
+        }
+
+        $value = new \DateTime();
+        if ($data instanceof \DateTime) {
+            $value = $data;
+        } else if (is_string($data) && !is_numeric($data)) {
+            $data = strtotime($data);
+            $value->setTimestamp($data);
+        } else if ($data !== null) {
+            $value->setTimestamp($data);
+        }
+
+        $options = array_merge(array('width' => 'long'), $options);
+        $width = $options['width'];
+        switch ($type) {
+            case 'date':
+                return (string) Calendar::formatDate($value, $width, $locale);
+            case 'datetime':
+                return (string) Calendar::formatDatetime($value, $width, $locale);
+            case 'time':
+                return (string) Calendar::formatTime($value, $width, $locale);
+            case 'weekdayName':
+                return (string) Calendar::getWeekdayName($value, $width, $locale);
+            default:
+                return false;
+        }
+    }
+
+    /**
+     * Returns an associative array with all translations
+     *
+     * Called by \OC_L10N_String
+     * @return array
+     */
+    public function getTranslations() {
+        return $this->translations;
+    }
+
+    /**
+     * Returnsed function accepts the argument $n
+     *
+     * Called by \OC_L10N_String
+     * @return string the plural form function
+     */
+    public function getPluralFormFunction() {
+        if (is_null($this->pluralFormFunction)) {
+            $lang = $this->getLanguageCode();
+            $this->pluralFormFunction = function($n) use ($lang) {
+                return PluralizationRules::get($n, $lang);
+            };
+        }
+
+        return $this->pluralFormFunction;
+    }
+
+    /**
+     * @param $translationFile
+     * @return bool
+     */
+    protected function load($translationFile) {
+        $json = json_decode(file_get_contents($translationFile), true);
+        if (!is_array($json)) {
+            $jsonError = json_last_error();
+            \OC::$server->getLogger()->warning("Failed to load $translationFile - json error code: $jsonError", ['app' => 'l10n']);
+            return false;
+        }
+
+        if (!empty($json['pluralForm'])) {
+            $this->pluralFormString = $json['pluralForm'];
+        }
+        $this->translations = array_merge($this->translations, $json['translations']);
+        return true;
+    }
 }

lib/private/legacy/api.php

Doc Comments +1 added lines, -1 removed lines

@@ -331,7 +331,7 @@
 
 	/**
 	 * http basic auth
-	 * @return string|false (username, or false on failure)
+	 * @return string (username, or false on failure)
 	 */
 	private static function loginUser() {
 		if(self::$isLoggedIn === true) {

Indentation +459 added lines, -459 removed lines

@@ -37,463 +37,463 @@
 
 class OC_API {
 
-	/**
-	 * API authentication levels
-	 */
-
-	/** @deprecated Use \OCP\API::GUEST_AUTH instead */
-	const GUEST_AUTH = 0;
-
-	/** @deprecated Use \OCP\API::USER_AUTH instead */
-	const USER_AUTH = 1;
-
-	/** @deprecated Use \OCP\API::SUBADMIN_AUTH instead */
-	const SUBADMIN_AUTH = 2;
-
-	/** @deprecated Use \OCP\API::ADMIN_AUTH instead */
-	const ADMIN_AUTH = 3;
-
-	/**
-	 * API Response Codes
-	 */
-
-	/** @deprecated Use \OCP\API::RESPOND_UNAUTHORISED instead */
-	const RESPOND_UNAUTHORISED = 997;
-
-	/** @deprecated Use \OCP\API::RESPOND_SERVER_ERROR instead */
-	const RESPOND_SERVER_ERROR = 996;
-
-	/** @deprecated Use \OCP\API::RESPOND_NOT_FOUND instead */
-	const RESPOND_NOT_FOUND = 998;
-
-	/** @deprecated Use \OCP\API::RESPOND_UNKNOWN_ERROR instead */
-	const RESPOND_UNKNOWN_ERROR = 999;
-
-	/**
-	 * api actions
-	 */
-	protected static $actions = array();
-	private static $logoutRequired = false;
-	private static $isLoggedIn = false;
-
-	/**
-	 * registers an api call
-	 * @param string $method the http method
-	 * @param string $url the url to match
-	 * @param callable $action the function to run
-	 * @param string $app the id of the app registering the call
-	 * @param int $authLevel the level of authentication required for the call
-	 * @param array $defaults
-	 * @param array $requirements
-	 */
-	public static function register($method, $url, $action, $app,
-				$authLevel = API::USER_AUTH,
-				$defaults = array(),
-				$requirements = array()) {
-		$name = strtolower($method).$url;
-		$name = str_replace(array('/', '{', '}'), '_', $name);
-		if(!isset(self::$actions[$name])) {
-			$oldCollection = OC::$server->getRouter()->getCurrentCollection();
-			OC::$server->getRouter()->useCollection('ocs');
-			OC::$server->getRouter()->create($name, $url)
-				->method($method)
-				->defaults($defaults)
-				->requirements($requirements)
-				->action('OC_API', 'call');
-			self::$actions[$name] = array();
-			OC::$server->getRouter()->useCollection($oldCollection);
-		}
-		self::$actions[$name][] = array('app' => $app, 'action' => $action, 'authlevel' => $authLevel);
-	}
-
-	/**
-	 * handles an api call
-	 * @param array $parameters
-	 */
-	public static function call($parameters) {
-		$request = \OC::$server->getRequest();
-		$method = $request->getMethod();
-
-		// Prepare the request variables
-		if($method === 'PUT') {
-			$parameters['_put'] = $request->getParams();
-		} else if($method === 'DELETE') {
-			$parameters['_delete'] = $request->getParams();
-		}
-		$name = $parameters['_route'];
-		// Foreach registered action
-		$responses = array();
-		$appManager = \OC::$server->getAppManager();
-		foreach(self::$actions[$name] as $action) {
-			// Check authentication and availability
-			if(!self::isAuthorised($action)) {
-				$responses[] = array(
-					'app' => $action['app'],
-					'response' => new \OC\OCS\Result(null, API::RESPOND_UNAUTHORISED, 'Unauthorised'),
-					'shipped' => $appManager->isShipped($action['app']),
-					);
-				continue;
-			}
-			if(!is_callable($action['action'])) {
-				$responses[] = array(
-					'app' => $action['app'],
-					'response' => new \OC\OCS\Result(null, API::RESPOND_NOT_FOUND, 'Api method not found'),
-					'shipped' => $appManager->isShipped($action['app']),
-					);
-				continue;
-			}
-			// Run the action
-			$responses[] = array(
-				'app' => $action['app'],
-				'response' => call_user_func($action['action'], $parameters),
-				'shipped' => $appManager->isShipped($action['app']),
-				);
-		}
-		$response = self::mergeResponses($responses);
-		$format = self::requestedFormat();
-		if (self::$logoutRequired) {
-			\OC::$server->getUserSession()->logout();
-		}
-
-		self::respond($response, $format);
-	}
-
-	/**
-	 * merge the returned result objects into one response
-	 * @param array $responses
-	 * @return \OC\OCS\Result
-	 */
-	public static function mergeResponses($responses) {
-		// Sort into shipped and third-party
-		$shipped = array(
-			'succeeded' => array(),
-			'failed' => array(),
-			);
-		$thirdparty = array(
-			'succeeded' => array(),
-			'failed' => array(),
-			);
-
-		foreach($responses as $response) {
-			if($response['shipped'] || ($response['app'] === 'core')) {
-				if($response['response']->succeeded()) {
-					$shipped['succeeded'][$response['app']] = $response;
-				} else {
-					$shipped['failed'][$response['app']] = $response;
-				}
-			} else {
-				if($response['response']->succeeded()) {
-					$thirdparty['succeeded'][$response['app']] = $response;
-				} else {
-					$thirdparty['failed'][$response['app']] = $response;
-				}
-			}
-		}
-
-		// Remove any error responses if there is one shipped response that succeeded
-		if(!empty($shipped['failed'])) {
-			// Which shipped response do we use if they all failed?
-			// They may have failed for different reasons (different status codes)
-			// Which response code should we return?
-			// Maybe any that are not \OCP\API::RESPOND_SERVER_ERROR
-			// Merge failed responses if more than one
-			$data = array();
-			foreach($shipped['failed'] as $failure) {
-				$data = array_merge_recursive($data, $failure['response']->getData());
-			}
-			$picked = reset($shipped['failed']);
-			$code = $picked['response']->getStatusCode();
-			$meta = $picked['response']->getMeta();
-			$headers = $picked['response']->getHeaders();
-			$response = new \OC\OCS\Result($data, $code, $meta['message'], $headers);
-			return $response;
-		} elseif(!empty($shipped['succeeded'])) {
-			$responses = array_merge($shipped['succeeded'], $thirdparty['succeeded']);
-		} elseif(!empty($thirdparty['failed'])) {
-			// Merge failed responses if more than one
-			$data = array();
-			foreach($thirdparty['failed'] as $failure) {
-				$data = array_merge_recursive($data, $failure['response']->getData());
-			}
-			$picked = reset($thirdparty['failed']);
-			$code = $picked['response']->getStatusCode();
-			$meta = $picked['response']->getMeta();
-			$headers = $picked['response']->getHeaders();
-			$response = new \OC\OCS\Result($data, $code, $meta['message'], $headers);
-			return $response;
-		} else {
-			$responses = $thirdparty['succeeded'];
-		}
-		// Merge the successful responses
-		$data = [];
-		$codes = [];
-		$header = [];
-
-		foreach($responses as $response) {
-			if($response['shipped']) {
-				$data = array_merge_recursive($response['response']->getData(), $data);
-			} else {
-				$data = array_merge_recursive($data, $response['response']->getData());
-			}
-			$header = array_merge_recursive($header, $response['response']->getHeaders());
-			$codes[] = ['code' => $response['response']->getStatusCode(),
-				'meta' => $response['response']->getMeta()];
-		}
-
-		// Use any non 100 status codes
-		$statusCode = 100;
-		$statusMessage = null;
-		foreach($codes as $code) {
-			if($code['code'] != 100) {
-				$statusCode = $code['code'];
-				$statusMessage = $code['meta']['message'];
-				break;
-			}
-		}
-
-		return new \OC\OCS\Result($data, $statusCode, $statusMessage, $header);
-	}
-
-	/**
-	 * authenticate the api call
-	 * @param array $action the action details as supplied to OC_API::register()
-	 * @return bool
-	 */
-	private static function isAuthorised($action) {
-		$level = $action['authlevel'];
-		switch($level) {
-			case API::GUEST_AUTH:
-				// Anyone can access
-				return true;
-			case API::USER_AUTH:
-				// User required
-				return self::loginUser();
-			case API::SUBADMIN_AUTH:
-				// Check for subadmin
-				$user = self::loginUser();
-				if(!$user) {
-					return false;
-				} else {
-					$userObject = \OC::$server->getUserSession()->getUser();
-					if($userObject === null) {
-						return false;
-					}
-					$isSubAdmin = \OC::$server->getGroupManager()->getSubAdmin()->isSubAdmin($userObject);
-					$admin = OC_User::isAdminUser($user);
-					if($isSubAdmin || $admin) {
-						return true;
-					} else {
-						return false;
-					}
-				}
-			case API::ADMIN_AUTH:
-				// Check for admin
-				$user = self::loginUser();
-				if(!$user) {
-					return false;
-				} else {
-					return OC_User::isAdminUser($user);
-				}
-			default:
-				// oops looks like invalid level supplied
-				return false;
-		}
-	}
-
-	/**
-	 * http basic auth
-	 * @return string|false (username, or false on failure)
-	 */
-	private static function loginUser() {
-		if(self::$isLoggedIn === true) {
-			return \OC_User::getUser();
-		}
-
-		// reuse existing login
-		$loggedIn = \OC::$server->getUserSession()->isLoggedIn();
-		if ($loggedIn === true) {
-			if (\OC::$server->getTwoFactorAuthManager()->needsSecondFactor(\OC::$server->getUserSession()->getUser())) {
-				// Do not allow access to OCS until the 2FA challenge was solved successfully
-				return false;
-			}
-			$ocsApiRequest = isset($_SERVER['HTTP_OCS_APIREQUEST']) ? $_SERVER['HTTP_OCS_APIREQUEST'] === 'true' : false;
-			if ($ocsApiRequest) {
-
-				// initialize the user's filesystem
-				\OC_Util::setupFS(\OC_User::getUser());
-				self::$isLoggedIn = true;
-
-				return OC_User::getUser();
-			}
-			return false;
-		}
-
-		// basic auth - because OC_User::login will create a new session we shall only try to login
-		// if user and pass are set
-		$userSession = \OC::$server->getUserSession();
-		$request = \OC::$server->getRequest();
-		try {
-			if ($userSession->tryTokenLogin($request)
-				|| $userSession->tryBasicAuthLogin($request, \OC::$server->getBruteForceThrottler())) {
-				self::$logoutRequired = true;
-			} else {
-				return false;
-			}
-			// initialize the user's filesystem
-			\OC_Util::setupFS(\OC_User::getUser());
-			self::$isLoggedIn = true;
-
-			return \OC_User::getUser();
-		} catch (\OC\User\LoginException $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * respond to a call
-	 * @param \OC\OCS\Result $result
-	 * @param string $format the format xml|json
-	 */
-	public static function respond($result, $format='xml') {
-		$request = \OC::$server->getRequest();
-
-		// Send 401 headers if unauthorised
-		if($result->getStatusCode() === API::RESPOND_UNAUTHORISED) {
-			// If request comes from JS return dummy auth request
-			if($request->getHeader('X-Requested-With') === 'XMLHttpRequest') {
-				header('WWW-Authenticate: DummyBasic realm="Authorisation Required"');
-			} else {
-				header('WWW-Authenticate: Basic realm="Authorisation Required"');
-			}
-			header('HTTP/1.0 401 Unauthorized');
-		}
-
-		foreach($result->getHeaders() as $name => $value) {
-			header($name . ': ' . $value);
-		}
-
-		$meta = $result->getMeta();
-		$data = $result->getData();
-		if (self::isV2($request)) {
-			$statusCode = self::mapStatusCodes($result->getStatusCode());
-			if (!is_null($statusCode)) {
-				$meta['statuscode'] = $statusCode;
-				OC_Response::setStatus($statusCode);
-			}
-		}
-
-		self::setContentType($format);
-		$body = self::renderResult($format, $meta, $data);
-		echo $body;
-	}
-
-	/**
-	 * @param XMLWriter $writer
-	 */
-	private static function toXML($array, $writer) {
-		foreach($array as $k => $v) {
-			if ($k[0] === '@') {
-				$writer->writeAttribute(substr($k, 1), $v);
-				continue;
-			} else if (is_numeric($k)) {
-				$k = 'element';
-			}
-			if(is_array($v)) {
-				$writer->startElement($k);
-				self::toXML($v, $writer);
-				$writer->endElement();
-			} else {
-				$writer->writeElement($k, $v);
-			}
-		}
-	}
-
-	/**
-	 * @return string
-	 */
-	public static function requestedFormat() {
-		$formats = array('json', 'xml');
-
-		$format = !empty($_GET['format']) && in_array($_GET['format'], $formats) ? $_GET['format'] : 'xml';
-		return $format;
-	}
-
-	/**
-	 * Based on the requested format the response content type is set
-	 * @param string $format
-	 */
-	public static function setContentType($format = null) {
-		$format = is_null($format) ? self::requestedFormat() : $format;
-		if ($format === 'xml') {
-			header('Content-type: text/xml; charset=UTF-8');
-			return;
-		}
-
-		if ($format === 'json') {
-			header('Content-Type: application/json; charset=utf-8');
-			return;
-		}
-
-		header('Content-Type: application/octet-stream; charset=utf-8');
-	}
-
-	/**
-	 * @param \OCP\IRequest $request
-	 * @return bool
-	 */
-	protected static function isV2(\OCP\IRequest $request) {
-		$script = $request->getScriptName();
-
-		return substr($script, -11) === '/ocs/v2.php';
-	}
-
-	/**
-	 * @param integer $sc
-	 * @return int
-	 */
-	public static function mapStatusCodes($sc) {
-		switch ($sc) {
-			case API::RESPOND_NOT_FOUND:
-				return Http::STATUS_NOT_FOUND;
-			case API::RESPOND_SERVER_ERROR:
-				return Http::STATUS_INTERNAL_SERVER_ERROR;
-			case API::RESPOND_UNKNOWN_ERROR:
-				return Http::STATUS_INTERNAL_SERVER_ERROR;
-			case API::RESPOND_UNAUTHORISED:
-				// already handled for v1
-				return null;
-			case 100:
-				return Http::STATUS_OK;
-		}
-		// any 2xx, 4xx and 5xx will be used as is
-		if ($sc >= 200 && $sc < 600) {
-			return $sc;
-		}
-
-		return Http::STATUS_BAD_REQUEST;
-	}
-
-	/**
-	 * @param string $format
-	 * @return string
-	 */
-	public static function renderResult($format, $meta, $data) {
-		$response = array(
-			'ocs' => array(
-				'meta' => $meta,
-				'data' => $data,
-			),
-		);
-		if ($format == 'json') {
-			return OC_JSON::encode($response);
-		}
-
-		$writer = new XMLWriter();
-		$writer->openMemory();
-		$writer->setIndent(true);
-		$writer->startDocument();
-		self::toXML($response, $writer);
-		$writer->endDocument();
-		return $writer->outputMemory(true);
-	}
+    /**
+     * API authentication levels
+     */
+
+    /** @deprecated Use \OCP\API::GUEST_AUTH instead */
+    const GUEST_AUTH = 0;
+
+    /** @deprecated Use \OCP\API::USER_AUTH instead */
+    const USER_AUTH = 1;
+
+    /** @deprecated Use \OCP\API::SUBADMIN_AUTH instead */
+    const SUBADMIN_AUTH = 2;
+
+    /** @deprecated Use \OCP\API::ADMIN_AUTH instead */
+    const ADMIN_AUTH = 3;
+
+    /**
+     * API Response Codes
+     */
+
+    /** @deprecated Use \OCP\API::RESPOND_UNAUTHORISED instead */
+    const RESPOND_UNAUTHORISED = 997;
+
+    /** @deprecated Use \OCP\API::RESPOND_SERVER_ERROR instead */
+    const RESPOND_SERVER_ERROR = 996;
+
+    /** @deprecated Use \OCP\API::RESPOND_NOT_FOUND instead */
+    const RESPOND_NOT_FOUND = 998;
+
+    /** @deprecated Use \OCP\API::RESPOND_UNKNOWN_ERROR instead */
+    const RESPOND_UNKNOWN_ERROR = 999;
+
+    /**
+     * api actions
+     */
+    protected static $actions = array();
+    private static $logoutRequired = false;
+    private static $isLoggedIn = false;
+
+    /**
+     * registers an api call
+     * @param string $method the http method
+     * @param string $url the url to match
+     * @param callable $action the function to run
+     * @param string $app the id of the app registering the call
+     * @param int $authLevel the level of authentication required for the call
+     * @param array $defaults
+     * @param array $requirements
+     */
+    public static function register($method, $url, $action, $app,
+                $authLevel = API::USER_AUTH,
+                $defaults = array(),
+                $requirements = array()) {
+        $name = strtolower($method).$url;
+        $name = str_replace(array('/', '{', '}'), '_', $name);
+        if(!isset(self::$actions[$name])) {
+            $oldCollection = OC::$server->getRouter()->getCurrentCollection();
+            OC::$server->getRouter()->useCollection('ocs');
+            OC::$server->getRouter()->create($name, $url)
+                ->method($method)
+                ->defaults($defaults)
+                ->requirements($requirements)
+                ->action('OC_API', 'call');
+            self::$actions[$name] = array();
+            OC::$server->getRouter()->useCollection($oldCollection);
+        }
+        self::$actions[$name][] = array('app' => $app, 'action' => $action, 'authlevel' => $authLevel);
+    }
+
+    /**
+     * handles an api call
+     * @param array $parameters
+     */
+    public static function call($parameters) {
+        $request = \OC::$server->getRequest();
+        $method = $request->getMethod();
+
+        // Prepare the request variables
+        if($method === 'PUT') {
+            $parameters['_put'] = $request->getParams();
+        } else if($method === 'DELETE') {
+            $parameters['_delete'] = $request->getParams();
+        }
+        $name = $parameters['_route'];
+        // Foreach registered action
+        $responses = array();
+        $appManager = \OC::$server->getAppManager();
+        foreach(self::$actions[$name] as $action) {
+            // Check authentication and availability
+            if(!self::isAuthorised($action)) {
+                $responses[] = array(
+                    'app' => $action['app'],
+                    'response' => new \OC\OCS\Result(null, API::RESPOND_UNAUTHORISED, 'Unauthorised'),
+                    'shipped' => $appManager->isShipped($action['app']),
+                    );
+                continue;
+            }
+            if(!is_callable($action['action'])) {
+                $responses[] = array(
+                    'app' => $action['app'],
+                    'response' => new \OC\OCS\Result(null, API::RESPOND_NOT_FOUND, 'Api method not found'),
+                    'shipped' => $appManager->isShipped($action['app']),
+                    );
+                continue;
+            }
+            // Run the action
+            $responses[] = array(
+                'app' => $action['app'],
+                'response' => call_user_func($action['action'], $parameters),
+                'shipped' => $appManager->isShipped($action['app']),
+                );
+        }
+        $response = self::mergeResponses($responses);
+        $format = self::requestedFormat();
+        if (self::$logoutRequired) {
+            \OC::$server->getUserSession()->logout();
+        }
+
+        self::respond($response, $format);
+    }
+
+    /**
+     * merge the returned result objects into one response
+     * @param array $responses
+     * @return \OC\OCS\Result
+     */
+    public static function mergeResponses($responses) {
+        // Sort into shipped and third-party
+        $shipped = array(
+            'succeeded' => array(),
+            'failed' => array(),
+            );
+        $thirdparty = array(
+            'succeeded' => array(),
+            'failed' => array(),
+            );
+
+        foreach($responses as $response) {
+            if($response['shipped'] || ($response['app'] === 'core')) {
+                if($response['response']->succeeded()) {
+                    $shipped['succeeded'][$response['app']] = $response;
+                } else {
+                    $shipped['failed'][$response['app']] = $response;
+                }
+            } else {
+                if($response['response']->succeeded()) {
+                    $thirdparty['succeeded'][$response['app']] = $response;
+                } else {
+                    $thirdparty['failed'][$response['app']] = $response;
+                }
+            }
+        }
+
+        // Remove any error responses if there is one shipped response that succeeded
+        if(!empty($shipped['failed'])) {
+            // Which shipped response do we use if they all failed?
+            // They may have failed for different reasons (different status codes)
+            // Which response code should we return?
+            // Maybe any that are not \OCP\API::RESPOND_SERVER_ERROR
+            // Merge failed responses if more than one
+            $data = array();
+            foreach($shipped['failed'] as $failure) {
+                $data = array_merge_recursive($data, $failure['response']->getData());
+            }
+            $picked = reset($shipped['failed']);
+            $code = $picked['response']->getStatusCode();
+            $meta = $picked['response']->getMeta();
+            $headers = $picked['response']->getHeaders();
+            $response = new \OC\OCS\Result($data, $code, $meta['message'], $headers);
+            return $response;
+        } elseif(!empty($shipped['succeeded'])) {
+            $responses = array_merge($shipped['succeeded'], $thirdparty['succeeded']);
+        } elseif(!empty($thirdparty['failed'])) {
+            // Merge failed responses if more than one
+            $data = array();
+            foreach($thirdparty['failed'] as $failure) {
+                $data = array_merge_recursive($data, $failure['response']->getData());
+            }
+            $picked = reset($thirdparty['failed']);
+            $code = $picked['response']->getStatusCode();
+            $meta = $picked['response']->getMeta();
+            $headers = $picked['response']->getHeaders();
+            $response = new \OC\OCS\Result($data, $code, $meta['message'], $headers);
+            return $response;
+        } else {
+            $responses = $thirdparty['succeeded'];
+        }
+        // Merge the successful responses
+        $data = [];
+        $codes = [];
+        $header = [];
+
+        foreach($responses as $response) {
+            if($response['shipped']) {
+                $data = array_merge_recursive($response['response']->getData(), $data);
+            } else {
+                $data = array_merge_recursive($data, $response['response']->getData());
+            }
+            $header = array_merge_recursive($header, $response['response']->getHeaders());
+            $codes[] = ['code' => $response['response']->getStatusCode(),
+                'meta' => $response['response']->getMeta()];
+        }
+
+        // Use any non 100 status codes
+        $statusCode = 100;
+        $statusMessage = null;
+        foreach($codes as $code) {
+            if($code['code'] != 100) {
+                $statusCode = $code['code'];
+                $statusMessage = $code['meta']['message'];
+                break;
+            }
+        }
+
+        return new \OC\OCS\Result($data, $statusCode, $statusMessage, $header);
+    }
+
+    /**
+     * authenticate the api call
+     * @param array $action the action details as supplied to OC_API::register()
+     * @return bool
+     */
+    private static function isAuthorised($action) {
+        $level = $action['authlevel'];
+        switch($level) {
+            case API::GUEST_AUTH:
+                // Anyone can access
+                return true;
+            case API::USER_AUTH:
+                // User required
+                return self::loginUser();
+            case API::SUBADMIN_AUTH:
+                // Check for subadmin
+                $user = self::loginUser();
+                if(!$user) {
+                    return false;
+                } else {
+                    $userObject = \OC::$server->getUserSession()->getUser();
+                    if($userObject === null) {
+                        return false;
+                    }
+                    $isSubAdmin = \OC::$server->getGroupManager()->getSubAdmin()->isSubAdmin($userObject);
+                    $admin = OC_User::isAdminUser($user);
+                    if($isSubAdmin || $admin) {
+                        return true;
+                    } else {
+                        return false;
+                    }
+                }
+            case API::ADMIN_AUTH:
+                // Check for admin
+                $user = self::loginUser();
+                if(!$user) {
+                    return false;
+                } else {
+                    return OC_User::isAdminUser($user);
+                }
+            default:
+                // oops looks like invalid level supplied
+                return false;
+        }
+    }
+
+    /**
+     * http basic auth
+     * @return string|false (username, or false on failure)
+     */
+    private static function loginUser() {
+        if(self::$isLoggedIn === true) {
+            return \OC_User::getUser();
+        }
+
+        // reuse existing login
+        $loggedIn = \OC::$server->getUserSession()->isLoggedIn();
+        if ($loggedIn === true) {
+            if (\OC::$server->getTwoFactorAuthManager()->needsSecondFactor(\OC::$server->getUserSession()->getUser())) {
+                // Do not allow access to OCS until the 2FA challenge was solved successfully
+                return false;
+            }
+            $ocsApiRequest = isset($_SERVER['HTTP_OCS_APIREQUEST']) ? $_SERVER['HTTP_OCS_APIREQUEST'] === 'true' : false;
+            if ($ocsApiRequest) {
+
+                // initialize the user's filesystem
+                \OC_Util::setupFS(\OC_User::getUser());
+                self::$isLoggedIn = true;
+
+                return OC_User::getUser();
+            }
+            return false;
+        }
+
+        // basic auth - because OC_User::login will create a new session we shall only try to login
+        // if user and pass are set
+        $userSession = \OC::$server->getUserSession();
+        $request = \OC::$server->getRequest();
+        try {
+            if ($userSession->tryTokenLogin($request)
+                || $userSession->tryBasicAuthLogin($request, \OC::$server->getBruteForceThrottler())) {
+                self::$logoutRequired = true;
+            } else {
+                return false;
+            }
+            // initialize the user's filesystem
+            \OC_Util::setupFS(\OC_User::getUser());
+            self::$isLoggedIn = true;
+
+            return \OC_User::getUser();
+        } catch (\OC\User\LoginException $e) {
+            return false;
+        }
+    }
+
+    /**
+     * respond to a call
+     * @param \OC\OCS\Result $result
+     * @param string $format the format xml|json
+     */
+    public static function respond($result, $format='xml') {
+        $request = \OC::$server->getRequest();
+
+        // Send 401 headers if unauthorised
+        if($result->getStatusCode() === API::RESPOND_UNAUTHORISED) {
+            // If request comes from JS return dummy auth request
+            if($request->getHeader('X-Requested-With') === 'XMLHttpRequest') {
+                header('WWW-Authenticate: DummyBasic realm="Authorisation Required"');
+            } else {
+                header('WWW-Authenticate: Basic realm="Authorisation Required"');
+            }
+            header('HTTP/1.0 401 Unauthorized');
+        }
+
+        foreach($result->getHeaders() as $name => $value) {
+            header($name . ': ' . $value);
+        }
+
+        $meta = $result->getMeta();
+        $data = $result->getData();
+        if (self::isV2($request)) {
+            $statusCode = self::mapStatusCodes($result->getStatusCode());
+            if (!is_null($statusCode)) {
+                $meta['statuscode'] = $statusCode;
+                OC_Response::setStatus($statusCode);
+            }
+        }
+
+        self::setContentType($format);
+        $body = self::renderResult($format, $meta, $data);
+        echo $body;
+    }
+
+    /**
+     * @param XMLWriter $writer
+     */
+    private static function toXML($array, $writer) {
+        foreach($array as $k => $v) {
+            if ($k[0] === '@') {
+                $writer->writeAttribute(substr($k, 1), $v);
+                continue;
+            } else if (is_numeric($k)) {
+                $k = 'element';
+            }
+            if(is_array($v)) {
+                $writer->startElement($k);
+                self::toXML($v, $writer);
+                $writer->endElement();
+            } else {
+                $writer->writeElement($k, $v);
+            }
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public static function requestedFormat() {
+        $formats = array('json', 'xml');
+
+        $format = !empty($_GET['format']) && in_array($_GET['format'], $formats) ? $_GET['format'] : 'xml';
+        return $format;
+    }
+
+    /**
+     * Based on the requested format the response content type is set
+     * @param string $format
+     */
+    public static function setContentType($format = null) {
+        $format = is_null($format) ? self::requestedFormat() : $format;
+        if ($format === 'xml') {
+            header('Content-type: text/xml; charset=UTF-8');
+            return;
+        }
+
+        if ($format === 'json') {
+            header('Content-Type: application/json; charset=utf-8');
+            return;
+        }
+
+        header('Content-Type: application/octet-stream; charset=utf-8');
+    }
+
+    /**
+     * @param \OCP\IRequest $request
+     * @return bool
+     */
+    protected static function isV2(\OCP\IRequest $request) {
+        $script = $request->getScriptName();
+
+        return substr($script, -11) === '/ocs/v2.php';
+    }
+
+    /**
+     * @param integer $sc
+     * @return int
+     */
+    public static function mapStatusCodes($sc) {
+        switch ($sc) {
+            case API::RESPOND_NOT_FOUND:
+                return Http::STATUS_NOT_FOUND;
+            case API::RESPOND_SERVER_ERROR:
+                return Http::STATUS_INTERNAL_SERVER_ERROR;
+            case API::RESPOND_UNKNOWN_ERROR:
+                return Http::STATUS_INTERNAL_SERVER_ERROR;
+            case API::RESPOND_UNAUTHORISED:
+                // already handled for v1
+                return null;
+            case 100:
+                return Http::STATUS_OK;
+        }
+        // any 2xx, 4xx and 5xx will be used as is
+        if ($sc >= 200 && $sc < 600) {
+            return $sc;
+        }
+
+        return Http::STATUS_BAD_REQUEST;
+    }
+
+    /**
+     * @param string $format
+     * @return string
+     */
+    public static function renderResult($format, $meta, $data) {
+        $response = array(
+            'ocs' => array(
+                'meta' => $meta,
+                'data' => $data,
+            ),
+        );
+        if ($format == 'json') {
+            return OC_JSON::encode($response);
+        }
+
+        $writer = new XMLWriter();
+        $writer->openMemory();
+        $writer->setIndent(true);
+        $writer->startDocument();
+        self::toXML($response, $writer);
+        $writer->endDocument();
+        return $writer->outputMemory(true);
+    }
 }

Spacing +32 added lines, -32 removed lines

@@ -92,7 +92,7 @@ 
 				$requirements = array()) {
 		$name = strtolower($method).$url;
 		$name = str_replace(array('/', '{', '}'), '_', $name);
-		if(!isset(self::$actions[$name])) {
+		if (!isset(self::$actions[$name])) {
 			$oldCollection = OC::$server->getRouter()->getCurrentCollection();
 			OC::$server->getRouter()->useCollection('ocs');
 			OC::$server->getRouter()->create($name, $url)
@@ -115,18 +115,18 @@ 
 		$method = $request->getMethod();
 
 		// Prepare the request variables
-		if($method === 'PUT') {
+		if ($method === 'PUT') {
 			$parameters['_put'] = $request->getParams();
-		} else if($method === 'DELETE') {
+		} else if ($method === 'DELETE') {
 			$parameters['_delete'] = $request->getParams();
 		}
 		$name = $parameters['_route'];
 		// Foreach registered action
 		$responses = array();
 		$appManager = \OC::$server->getAppManager();
-		foreach(self::$actions[$name] as $action) {
+		foreach (self::$actions[$name] as $action) {
 			// Check authentication and availability
-			if(!self::isAuthorised($action)) {
+			if (!self::isAuthorised($action)) {
 				$responses[] = array(
 					'app' => $action['app'],
 					'response' => new \OC\OCS\Result(null, API::RESPOND_UNAUTHORISED, 'Unauthorised'),
@@ -134,7 +134,7 @@ 
 					);
 				continue;
 			}
-			if(!is_callable($action['action'])) {
+			if (!is_callable($action['action'])) {
 				$responses[] = array(
 					'app' => $action['app'],
 					'response' => new \OC\OCS\Result(null, API::RESPOND_NOT_FOUND, 'Api method not found'),
@@ -174,15 +174,15 @@ 
 			'failed' => array(),
 			);
 
-		foreach($responses as $response) {
-			if($response['shipped'] || ($response['app'] === 'core')) {
-				if($response['response']->succeeded()) {
+		foreach ($responses as $response) {
+			if ($response['shipped'] || ($response['app'] === 'core')) {
+				if ($response['response']->succeeded()) {
 					$shipped['succeeded'][$response['app']] = $response;
 				} else {
 					$shipped['failed'][$response['app']] = $response;
 				}
 			} else {
-				if($response['response']->succeeded()) {
+				if ($response['response']->succeeded()) {
 					$thirdparty['succeeded'][$response['app']] = $response;
 				} else {
 					$thirdparty['failed'][$response['app']] = $response;
@@ -191,14 +191,14 @@ 
 		}
 
 		// Remove any error responses if there is one shipped response that succeeded
-		if(!empty($shipped['failed'])) {
+		if (!empty($shipped['failed'])) {
 			// Which shipped response do we use if they all failed?
 			// They may have failed for different reasons (different status codes)
 			// Which response code should we return?
 			// Maybe any that are not \OCP\API::RESPOND_SERVER_ERROR
 			// Merge failed responses if more than one
 			$data = array();
-			foreach($shipped['failed'] as $failure) {
+			foreach ($shipped['failed'] as $failure) {
 				$data = array_merge_recursive($data, $failure['response']->getData());
 			}
 			$picked = reset($shipped['failed']);
@@ -207,12 +207,12 @@ 
 			$headers = $picked['response']->getHeaders();
 			$response = new \OC\OCS\Result($data, $code, $meta['message'], $headers);
 			return $response;
-		} elseif(!empty($shipped['succeeded'])) {
+		} elseif (!empty($shipped['succeeded'])) {
 			$responses = array_merge($shipped['succeeded'], $thirdparty['succeeded']);
-		} elseif(!empty($thirdparty['failed'])) {
+		} elseif (!empty($thirdparty['failed'])) {
 			// Merge failed responses if more than one
 			$data = array();
-			foreach($thirdparty['failed'] as $failure) {
+			foreach ($thirdparty['failed'] as $failure) {
 				$data = array_merge_recursive($data, $failure['response']->getData());
 			}
 			$picked = reset($thirdparty['failed']);
@@ -229,8 +229,8 @@ 
 		$codes = [];
 		$header = [];
 
-		foreach($responses as $response) {
-			if($response['shipped']) {
+		foreach ($responses as $response) {
+			if ($response['shipped']) {
 				$data = array_merge_recursive($response['response']->getData(), $data);
 			} else {
 				$data = array_merge_recursive($data, $response['response']->getData());
@@ -243,8 +243,8 @@ 
 		// Use any non 100 status codes
 		$statusCode = 100;
 		$statusMessage = null;
-		foreach($codes as $code) {
-			if($code['code'] != 100) {
+		foreach ($codes as $code) {
+			if ($code['code'] != 100) {
 				$statusCode = $code['code'];
 				$statusMessage = $code['meta']['message'];
 				break;
@@ -261,7 +261,7 @@ 
 	 */
 	private static function isAuthorised($action) {
 		$level = $action['authlevel'];
-		switch($level) {
+		switch ($level) {
 			case API::GUEST_AUTH:
 				// Anyone can access
 				return true;
@@ -271,16 +271,16 @@ 
 			case API::SUBADMIN_AUTH:
 				// Check for subadmin
 				$user = self::loginUser();
-				if(!$user) {
+				if (!$user) {
 					return false;
 				} else {
 					$userObject = \OC::$server->getUserSession()->getUser();
-					if($userObject === null) {
+					if ($userObject === null) {
 						return false;
 					}
 					$isSubAdmin = \OC::$server->getGroupManager()->getSubAdmin()->isSubAdmin($userObject);
 					$admin = OC_User::isAdminUser($user);
-					if($isSubAdmin || $admin) {
+					if ($isSubAdmin || $admin) {
 						return true;
 					} else {
 						return false;
@@ -289,7 +289,7 @@ 
 			case API::ADMIN_AUTH:
 				// Check for admin
 				$user = self::loginUser();
-				if(!$user) {
+				if (!$user) {
 					return false;
 				} else {
 					return OC_User::isAdminUser($user);
@@ -305,7 +305,7 @@ 
 	 * @return string|false (username, or false on failure)
 	 */
 	private static function loginUser() {
-		if(self::$isLoggedIn === true) {
+		if (self::$isLoggedIn === true) {
 			return \OC_User::getUser();
 		}
 
@@ -354,13 +354,13 @@ 
 	 * @param \OC\OCS\Result $result
 	 * @param string $format the format xml|json
 	 */
-	public static function respond($result, $format='xml') {
+	public static function respond($result, $format = 'xml') {
 		$request = \OC::$server->getRequest();
 
 		// Send 401 headers if unauthorised
-		if($result->getStatusCode() === API::RESPOND_UNAUTHORISED) {
+		if ($result->getStatusCode() === API::RESPOND_UNAUTHORISED) {
 			// If request comes from JS return dummy auth request
-			if($request->getHeader('X-Requested-With') === 'XMLHttpRequest') {
+			if ($request->getHeader('X-Requested-With') === 'XMLHttpRequest') {
 				header('WWW-Authenticate: DummyBasic realm="Authorisation Required"');
 			} else {
 				header('WWW-Authenticate: Basic realm="Authorisation Required"');
@@ -368,8 +368,8 @@ 
 			header('HTTP/1.0 401 Unauthorized');
 		}
 
-		foreach($result->getHeaders() as $name => $value) {
-			header($name . ': ' . $value);
+		foreach ($result->getHeaders() as $name => $value) {
+			header($name.': '.$value);
 		}
 
 		$meta = $result->getMeta();
@@ -391,14 +391,14 @@ 
 	 * @param XMLWriter $writer
 	 */
 	private static function toXML($array, $writer) {
-		foreach($array as $k => $v) {
+		foreach ($array as $k => $v) {
 			if ($k[0] === '@') {
 				$writer->writeAttribute(substr($k, 1), $v);
 				continue;
 			} else if (is_numeric($k)) {
 				$k = 'element';
 			}
-			if(is_array($v)) {
+			if (is_array($v)) {
 				$writer->startElement($k);
 				self::toXML($v, $writer);
 				$writer->endElement();

lib/private/legacy/eventsource.php

Doc Comments +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
 	 * send a message to the client
 	 *
 	 * @param string $type
-	 * @param mixed $data
+	 * @param string $data
 	 *
 	 * @throws \BadMethodCallException
 	 * if only one parameter is given, a typeless message will be send with that parameter as data

Spacing +7 added lines, -7 removed lines

@@ -60,7 +60,7 @@ 
 		header('X-Accel-Buffering: no');
 		$this->fallback = isset($_GET['fallback']) and $_GET['fallback'] == 'true';
 		if ($this->fallback) {
-			$this->fallBackId = (int)$_GET['fallback_id'];
+			$this->fallBackId = (int) $_GET['fallback_id'];
 			/**
 			 * FIXME: The default content-security-policy of ownCloud forbids inline
 			 * JavaScript for security reasons. IE starting on Windows 10 will
@@ -73,11 +73,11 @@ 
 			 */
 			header("Content-Security-Policy: default-src 'none'; script-src 'unsafe-inline'");
 			header("Content-Type: text/html");
-			echo str_repeat('<span></span>' . PHP_EOL, 10); //dummy data to keep IE happy
+			echo str_repeat('<span></span>'.PHP_EOL, 10); //dummy data to keep IE happy
 		} else {
 			header("Content-Type: text/event-stream");
 		}
-		if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
+		if (!\OC::$server->getRequest()->passesStrictCookieCheck()) {
 			header('Location: '.\OC::$WEBROOT);
 			exit();
 		}
@@ -100,7 +100,7 @@ 
 	 */
 	public function send($type, $data = null) {
 		if ($data and !preg_match('/^[A-Za-z0-9_]+$/', $type)) {
-			throw new BadMethodCallException('Type needs to be alphanumeric ('. $type .')');
+			throw new BadMethodCallException('Type needs to be alphanumeric ('.$type.')');
 		}
 		$this->init();
 		if (is_null($data)) {
@@ -109,13 +109,13 @@ 
 		}
 		if ($this->fallback) {
 			$response = '<script type="text/javascript">window.parent.OC.EventSource.fallBackCallBack('
-				. $this->fallBackId . ',"' . $type . '",' . OCP\JSON::encode($data) . ')</script>' . PHP_EOL;
+				. $this->fallBackId.',"'.$type.'",'.OCP\JSON::encode($data).')</script>'.PHP_EOL;
 			echo $response;
 		} else {
 			if ($type) {
-				echo 'event: ' . $type . PHP_EOL;
+				echo 'event: '.$type.PHP_EOL;
 			}
-			echo 'data: ' . OCP\JSON::encode($data) . PHP_EOL;
+			echo 'data: '.OCP\JSON::encode($data).PHP_EOL;
 		}
 		echo PHP_EOL;
 		flush();

Indentation +89 added lines, -89 removed lines

@@ -33,99 +33,99 @@
  * use server side events with caution, to many open requests can hang the server
  */
 class OC_EventSource implements \OCP\IEventSource {
-	/**
-	 * @var bool
-	 */
-	private $fallback;
+    /**
+     * @var bool
+     */
+    private $fallback;
 
-	/**
-	 * @var int
-	 */
-	private $fallBackId = 0;
+    /**
+     * @var int
+     */
+    private $fallBackId = 0;
 
-	/**
-	 * @var bool
-	 */
-	private $started = false;
+    /**
+     * @var bool
+     */
+    private $started = false;
 
-	protected function init() {
-		if ($this->started) {
-			return;
-		}
-		$this->started = true;
+    protected function init() {
+        if ($this->started) {
+            return;
+        }
+        $this->started = true;
 
-		// prevent php output buffering, caching and nginx buffering
-		OC_Util::obEnd();
-		header('Cache-Control: no-cache');
-		header('X-Accel-Buffering: no');
-		$this->fallback = isset($_GET['fallback']) and $_GET['fallback'] == 'true';
-		if ($this->fallback) {
-			$this->fallBackId = (int)$_GET['fallback_id'];
-			/**
-			 * FIXME: The default content-security-policy of ownCloud forbids inline
-			 * JavaScript for security reasons. IE starting on Windows 10 will
-			 * however also obey the CSP which will break the event source fallback.
-			 *
-			 * As a workaround thus we set a custom policy which allows the execution
-			 * of inline JavaScript.
-			 *
-			 * @link https://github.com/owncloud/core/issues/14286
-			 */
-			header("Content-Security-Policy: default-src 'none'; script-src 'unsafe-inline'");
-			header("Content-Type: text/html");
-			echo str_repeat('<span></span>' . PHP_EOL, 10); //dummy data to keep IE happy
-		} else {
-			header("Content-Type: text/event-stream");
-		}
-		if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
-			header('Location: '.\OC::$WEBROOT);
-			exit();
-		}
-		if (!\OC::$server->getRequest()->passesCSRFCheck()) {
-			$this->send('error', 'Possible CSRF attack. Connection will be closed.');
-			$this->close();
-			exit();
-		}
-		flush();
-	}
+        // prevent php output buffering, caching and nginx buffering
+        OC_Util::obEnd();
+        header('Cache-Control: no-cache');
+        header('X-Accel-Buffering: no');
+        $this->fallback = isset($_GET['fallback']) and $_GET['fallback'] == 'true';
+        if ($this->fallback) {
+            $this->fallBackId = (int)$_GET['fallback_id'];
+            /**
+             * FIXME: The default content-security-policy of ownCloud forbids inline
+             * JavaScript for security reasons. IE starting on Windows 10 will
+             * however also obey the CSP which will break the event source fallback.
+             *
+             * As a workaround thus we set a custom policy which allows the execution
+             * of inline JavaScript.
+             *
+             * @link https://github.com/owncloud/core/issues/14286
+             */
+            header("Content-Security-Policy: default-src 'none'; script-src 'unsafe-inline'");
+            header("Content-Type: text/html");
+            echo str_repeat('<span></span>' . PHP_EOL, 10); //dummy data to keep IE happy
+        } else {
+            header("Content-Type: text/event-stream");
+        }
+        if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
+            header('Location: '.\OC::$WEBROOT);
+            exit();
+        }
+        if (!\OC::$server->getRequest()->passesCSRFCheck()) {
+            $this->send('error', 'Possible CSRF attack. Connection will be closed.');
+            $this->close();
+            exit();
+        }
+        flush();
+    }
 
-	/**
-	 * send a message to the client
-	 *
-	 * @param string $type
-	 * @param mixed $data
-	 *
-	 * @throws \BadMethodCallException
-	 * if only one parameter is given, a typeless message will be send with that parameter as data
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public function send($type, $data = null) {
-		if ($data and !preg_match('/^[A-Za-z0-9_]+$/', $type)) {
-			throw new BadMethodCallException('Type needs to be alphanumeric ('. $type .')');
-		}
-		$this->init();
-		if (is_null($data)) {
-			$data = $type;
-			$type = null;
-		}
-		if ($this->fallback) {
-			$response = '<script type="text/javascript">window.parent.OC.EventSource.fallBackCallBack('
-				. $this->fallBackId . ',"' . $type . '",' . OCP\JSON::encode($data) . ')</script>' . PHP_EOL;
-			echo $response;
-		} else {
-			if ($type) {
-				echo 'event: ' . $type . PHP_EOL;
-			}
-			echo 'data: ' . OCP\JSON::encode($data) . PHP_EOL;
-		}
-		echo PHP_EOL;
-		flush();
-	}
+    /**
+     * send a message to the client
+     *
+     * @param string $type
+     * @param mixed $data
+     *
+     * @throws \BadMethodCallException
+     * if only one parameter is given, a typeless message will be send with that parameter as data
+     * @suppress PhanDeprecatedFunction
+     */
+    public function send($type, $data = null) {
+        if ($data and !preg_match('/^[A-Za-z0-9_]+$/', $type)) {
+            throw new BadMethodCallException('Type needs to be alphanumeric ('. $type .')');
+        }
+        $this->init();
+        if (is_null($data)) {
+            $data = $type;
+            $type = null;
+        }
+        if ($this->fallback) {
+            $response = '<script type="text/javascript">window.parent.OC.EventSource.fallBackCallBack('
+                . $this->fallBackId . ',"' . $type . '",' . OCP\JSON::encode($data) . ')</script>' . PHP_EOL;
+            echo $response;
+        } else {
+            if ($type) {
+                echo 'event: ' . $type . PHP_EOL;
+            }
+            echo 'data: ' . OCP\JSON::encode($data) . PHP_EOL;
+        }
+        echo PHP_EOL;
+        flush();
+    }
 
-	/**
-	 * close the connection of the event source
-	 */
-	public function close() {
-		$this->send('__internal__', 'close'); //server side closing can be an issue, let the client do it
-	}
+    /**
+     * close the connection of the event source
+     */
+    public function close() {
+        $this->send('__internal__', 'close'); //server side closing can be an issue, let the client do it
+    }
 }

lib/private/Memcache/Memcached.php

Doc Comments +1 added lines, -1 removed lines

@@ -155,7 +155,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
 	 * @throws \Exception

Indentation +189 added lines, -189 removed lines

@@ -33,193 +33,193 @@
 use OCP\IMemcache;
 
 class Memcached extends Cache implements IMemcache {
-	use CASTrait;
-
-	/**
-	 * @var \Memcached $cache
-	 */
-	private static $cache = null;
-
-	use CADTrait;
-
-	public function __construct($prefix = '') {
-		parent::__construct($prefix);
-		if (is_null(self::$cache)) {
-			self::$cache = new \Memcached();
-
-			$defaultOptions = [
-				\Memcached::OPT_CONNECT_TIMEOUT => 50,
-				\Memcached::OPT_RETRY_TIMEOUT =>   50,
-				\Memcached::OPT_SEND_TIMEOUT =>    50,
-				\Memcached::OPT_RECV_TIMEOUT =>    50,
-				\Memcached::OPT_POLL_TIMEOUT =>    50,
-
-				// Enable compression
-				\Memcached::OPT_COMPRESSION =>          true,
-
-				// Turn on consistent hashing
-				\Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
-
-				// Enable Binary Protocol
-				//\Memcached::OPT_BINARY_PROTOCOL =>      true,
-			];
-			// by default enable igbinary serializer if available
-			if (\Memcached::HAVE_IGBINARY) {
-				$defaultOptions[\Memcached::OPT_SERIALIZER] =
-					\Memcached::SERIALIZER_IGBINARY;
-			}
-			$options = \OC::$server->getConfig()->getSystemValue('memcached_options', []);
-			if (is_array($options)) {
-				$options = $options + $defaultOptions;
-				self::$cache->setOptions($options);
-			} else {
-				throw new HintException("Expected 'memcached_options' config to be an array, got $options");
-			}
-
-			$servers = \OC::$server->getSystemConfig()->getValue('memcached_servers');
-			if (!$servers) {
-				$server = \OC::$server->getSystemConfig()->getValue('memcached_server');
-				if ($server) {
-					$servers = [$server];
-				} else {
-					$servers = [['localhost', 11211]];
-				}
-			}
-			self::$cache->addServers($servers);
-		}
-	}
-
-	/**
-	 * entries in XCache gets namespaced to prevent collisions between owncloud instances and users
-	 */
-	protected function getNameSpace() {
-		return $this->prefix;
-	}
-
-	public function get($key) {
-		$result = self::$cache->get($this->getNameSpace() . $key);
-		if ($result === false and self::$cache->getResultCode() == \Memcached::RES_NOTFOUND) {
-			return null;
-		} else {
-			return $result;
-		}
-	}
-
-	public function set($key, $value, $ttl = 0) {
-		if ($ttl > 0) {
-			$result =  self::$cache->set($this->getNameSpace() . $key, $value, $ttl);
-		} else {
-			$result = self::$cache->set($this->getNameSpace() . $key, $value);
-		}
-		if ($result !== true) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	public function hasKey($key) {
-		self::$cache->get($this->getNameSpace() . $key);
-		return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
-	}
-
-	public function remove($key) {
-		$result= self::$cache->delete($this->getNameSpace() . $key);
-		if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	public function clear($prefix = '') {
-		$prefix = $this->getNameSpace() . $prefix;
-		$allKeys = self::$cache->getAllKeys();
-		if ($allKeys === false) {
-			// newer Memcached doesn't like getAllKeys(), flush everything
-			self::$cache->flush();
-			return true;
-		}
-		$keys = array();
-		$prefixLength = strlen($prefix);
-		foreach ($allKeys as $key) {
-			if (substr($key, 0, $prefixLength) === $prefix) {
-				$keys[] = $key;
-			}
-		}
-		if (method_exists(self::$cache, 'deleteMulti')) {
-			self::$cache->deleteMulti($keys);
-		} else {
-			foreach ($keys as $key) {
-				self::$cache->delete($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
-	 * @throws \Exception
-	 */
-	public function add($key, $value, $ttl = 0) {
-		$result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
-		if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	/**
-	 * Increase a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function inc($key, $step = 1) {
-		$this->add($key, 0);
-		$result = self::$cache->increment($this->getPrefix() . $key, $step);
-
-		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
-			return false;
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Decrease a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function dec($key, $step = 1) {
-		$result = self::$cache->decrement($this->getPrefix() . $key, $step);
-
-		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
-			return false;
-		}
-
-		return $result;
-	}
-
-	static public function isAvailable() {
-		return extension_loaded('memcached');
-	}
-
-	/**
-	 * @throws \Exception
-	 */
-	private function verifyReturnCode() {
-		$code = self::$cache->getResultCode();
-		if ($code === \Memcached::RES_SUCCESS) {
-			return;
-		}
-		$message = self::$cache->getResultMessage();
-		throw new \Exception("Error $code interacting with memcached : $message");
-	}
+    use CASTrait;
+
+    /**
+     * @var \Memcached $cache
+     */
+    private static $cache = null;
+
+    use CADTrait;
+
+    public function __construct($prefix = '') {
+        parent::__construct($prefix);
+        if (is_null(self::$cache)) {
+            self::$cache = new \Memcached();
+
+            $defaultOptions = [
+                \Memcached::OPT_CONNECT_TIMEOUT => 50,
+                \Memcached::OPT_RETRY_TIMEOUT =>   50,
+                \Memcached::OPT_SEND_TIMEOUT =>    50,
+                \Memcached::OPT_RECV_TIMEOUT =>    50,
+                \Memcached::OPT_POLL_TIMEOUT =>    50,
+
+                // Enable compression
+                \Memcached::OPT_COMPRESSION =>          true,
+
+                // Turn on consistent hashing
+                \Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
+
+                // Enable Binary Protocol
+                //\Memcached::OPT_BINARY_PROTOCOL =>      true,
+            ];
+            // by default enable igbinary serializer if available
+            if (\Memcached::HAVE_IGBINARY) {
+                $defaultOptions[\Memcached::OPT_SERIALIZER] =
+                    \Memcached::SERIALIZER_IGBINARY;
+            }
+            $options = \OC::$server->getConfig()->getSystemValue('memcached_options', []);
+            if (is_array($options)) {
+                $options = $options + $defaultOptions;
+                self::$cache->setOptions($options);
+            } else {
+                throw new HintException("Expected 'memcached_options' config to be an array, got $options");
+            }
+
+            $servers = \OC::$server->getSystemConfig()->getValue('memcached_servers');
+            if (!$servers) {
+                $server = \OC::$server->getSystemConfig()->getValue('memcached_server');
+                if ($server) {
+                    $servers = [$server];
+                } else {
+                    $servers = [['localhost', 11211]];
+                }
+            }
+            self::$cache->addServers($servers);
+        }
+    }
+
+    /**
+     * entries in XCache gets namespaced to prevent collisions between owncloud instances and users
+     */
+    protected function getNameSpace() {
+        return $this->prefix;
+    }
+
+    public function get($key) {
+        $result = self::$cache->get($this->getNameSpace() . $key);
+        if ($result === false and self::$cache->getResultCode() == \Memcached::RES_NOTFOUND) {
+            return null;
+        } else {
+            return $result;
+        }
+    }
+
+    public function set($key, $value, $ttl = 0) {
+        if ($ttl > 0) {
+            $result =  self::$cache->set($this->getNameSpace() . $key, $value, $ttl);
+        } else {
+            $result = self::$cache->set($this->getNameSpace() . $key, $value);
+        }
+        if ($result !== true) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    public function hasKey($key) {
+        self::$cache->get($this->getNameSpace() . $key);
+        return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
+    }
+
+    public function remove($key) {
+        $result= self::$cache->delete($this->getNameSpace() . $key);
+        if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    public function clear($prefix = '') {
+        $prefix = $this->getNameSpace() . $prefix;
+        $allKeys = self::$cache->getAllKeys();
+        if ($allKeys === false) {
+            // newer Memcached doesn't like getAllKeys(), flush everything
+            self::$cache->flush();
+            return true;
+        }
+        $keys = array();
+        $prefixLength = strlen($prefix);
+        foreach ($allKeys as $key) {
+            if (substr($key, 0, $prefixLength) === $prefix) {
+                $keys[] = $key;
+            }
+        }
+        if (method_exists(self::$cache, 'deleteMulti')) {
+            self::$cache->deleteMulti($keys);
+        } else {
+            foreach ($keys as $key) {
+                self::$cache->delete($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
+     * @throws \Exception
+     */
+    public function add($key, $value, $ttl = 0) {
+        $result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
+        if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    /**
+     * Increase a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function inc($key, $step = 1) {
+        $this->add($key, 0);
+        $result = self::$cache->increment($this->getPrefix() . $key, $step);
+
+        if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
+            return false;
+        }
+
+        return $result;
+    }
+
+    /**
+     * Decrease a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function dec($key, $step = 1) {
+        $result = self::$cache->decrement($this->getPrefix() . $key, $step);
+
+        if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
+            return false;
+        }
+
+        return $result;
+    }
+
+    static public function isAvailable() {
+        return extension_loaded('memcached');
+    }
+
+    /**
+     * @throws \Exception
+     */
+    private function verifyReturnCode() {
+        $code = self::$cache->getResultCode();
+        if ($code === \Memcached::RES_SUCCESS) {
+            return;
+        }
+        $message = self::$cache->getResultMessage();
+        throw new \Exception("Error $code interacting with memcached : $message");
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -97,7 +97,7 @@ 
 	}
 
 	public function get($key) {
-		$result = self::$cache->get($this->getNameSpace() . $key);
+		$result = self::$cache->get($this->getNameSpace().$key);
 		if ($result === false and self::$cache->getResultCode() == \Memcached::RES_NOTFOUND) {
 			return null;
 		} else {
@@ -107,9 +107,9 @@ 
 
 	public function set($key, $value, $ttl = 0) {
 		if ($ttl > 0) {
-			$result =  self::$cache->set($this->getNameSpace() . $key, $value, $ttl);
+			$result = self::$cache->set($this->getNameSpace().$key, $value, $ttl);
 		} else {
-			$result = self::$cache->set($this->getNameSpace() . $key, $value);
+			$result = self::$cache->set($this->getNameSpace().$key, $value);
 		}
 		if ($result !== true) {
 			$this->verifyReturnCode();
@@ -118,12 +118,12 @@ 
 	}
 
 	public function hasKey($key) {
-		self::$cache->get($this->getNameSpace() . $key);
+		self::$cache->get($this->getNameSpace().$key);
 		return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
 	}
 
 	public function remove($key) {
-		$result= self::$cache->delete($this->getNameSpace() . $key);
+		$result = self::$cache->delete($this->getNameSpace().$key);
 		if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) {
 			$this->verifyReturnCode();
 		}
@@ -131,7 +131,7 @@ 
 	}
 
 	public function clear($prefix = '') {
-		$prefix = $this->getNameSpace() . $prefix;
+		$prefix = $this->getNameSpace().$prefix;
 		$allKeys = self::$cache->getAllKeys();
 		if ($allKeys === false) {
 			// newer Memcached doesn't like getAllKeys(), flush everything
@@ -165,7 +165,7 @@ 
 	 * @throws \Exception
 	 */
 	public function add($key, $value, $ttl = 0) {
-		$result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
+		$result = self::$cache->add($this->getPrefix().$key, $value, $ttl);
 		if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) {
 			$this->verifyReturnCode();
 		}
@@ -181,7 +181,7 @@ 
 	 */
 	public function inc($key, $step = 1) {
 		$this->add($key, 0);
-		$result = self::$cache->increment($this->getPrefix() . $key, $step);
+		$result = self::$cache->increment($this->getPrefix().$key, $step);
 
 		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
 			return false;
@@ -198,7 +198,7 @@ 
 	 * @return int | bool
 	 */
 	public function dec($key, $step = 1) {
-		$result = self::$cache->decrement($this->getPrefix() . $key, $step);
+		$result = self::$cache->decrement($this->getPrefix().$key, $step);
 
 		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
 			return false;

lib/private/Repair.php

Doc Comments +1 added lines, -2 removed lines

@@ -139,7 +139,7 @@ 
 	 * Returns expensive repair steps to be run on the
 	 * command line with a special option.
 	 *
-	 * @return IRepairStep[]
+	 * @return OldGroupMembershipShares[]
 	 */
 	public static function getExpensiveRepairSteps() {
 		return [
@@ -216,7 +216,6 @@ 
 	}
 
 	/**
-	 * @param int $max
 	 */
 	public function finishProgress() {
 		// for now just emit as we did in the past

Spacing +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\EventDispatcher\GenericEvent;
 
-class Repair implements IOutput{
+class Repair implements IOutput {
 	/* @var IRepairStep[] */
 	private $repairSteps;
 	/** @var EventDispatcher */

Unused Use Statements -2 removed lines

@@ -30,8 +30,6 @@
 
 namespace OC;
 
-use OC\App\AppStore\Bundles\BundleFetcher;
-use OC\Files\AppData\Factory;
 use OC\Repair\CleanTags;
 use OC\Repair\ClearFrontendCaches;
 use OC\Repair\Collation;

Indentation +163 added lines, -163 removed lines

@@ -55,167 +55,167 @@
 use Symfony\Component\EventDispatcher\GenericEvent;
 
 class Repair implements IOutput{
-	/* @var IRepairStep[] */
-	private $repairSteps;
-	/** @var EventDispatcher */
-	private $dispatcher;
-	/** @var string */
-	private $currentStep;
-
-	/**
-	 * Creates a new repair step runner
-	 *
-	 * @param IRepairStep[] $repairSteps array of RepairStep instances
-	 * @param EventDispatcher $dispatcher
-	 */
-	public function __construct($repairSteps = [], EventDispatcher $dispatcher = null) {
-		$this->repairSteps = $repairSteps;
-		$this->dispatcher = $dispatcher;
-	}
-
-	/**
-	 * Run a series of repair steps for common problems
-	 */
-	public function run() {
-		if (count($this->repairSteps) === 0) {
-			$this->emit('\OC\Repair', 'info', array('No repair steps available'));
-			return;
-		}
-		// run each repair step
-		foreach ($this->repairSteps as $step) {
-			$this->currentStep = $step->getName();
-			$this->emit('\OC\Repair', 'step', [$this->currentStep]);
-			$step->run($this);
-		}
-	}
-
-	/**
-	 * Add repair step
-	 *
-	 * @param IRepairStep|string $repairStep repair step
-	 * @throws \Exception
-	 */
-	public function addStep($repairStep) {
-		if (is_string($repairStep)) {
-			try {
-				$s = \OC::$server->query($repairStep);
-			} catch (QueryException $e) {
-				if (class_exists($repairStep)) {
-					$s = new $repairStep();
-				} else {
-					throw new \Exception("Repair step '$repairStep' is unknown");
-				}
-			}
-
-			if ($s instanceof IRepairStep) {
-				$this->repairSteps[] = $s;
-			} else {
-				throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
-			}
-		} else {
-			$this->repairSteps[] = $repairStep;
-		}
-	}
-
-	/**
-	 * Returns the default repair steps to be run on the
-	 * command line or after an upgrade.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getRepairSteps() {
-		return [
-			new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), \OC::$server->getDatabaseConnection(), false),
-			new RepairMimeTypes(\OC::$server->getConfig()),
-			new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
-			new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
-			new RemoveRootShares(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager(), \OC::$server->getLazyRootFolder()),
-			new MoveUpdaterStepFile(\OC::$server->getConfig()),
-			new FixMountStorages(\OC::$server->getDatabaseConnection()),
-			new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
-			new AddLogRotateJob(\OC::$server->getJobList()),
-			new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OC::$server->query(SCSSCacher::class), \OC::$server->query(JSCombiner::class))
-		];
-	}
-
-	/**
-	 * Returns expensive repair steps to be run on the
-	 * command line with a special option.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getExpensiveRepairSteps() {
-		return [
-			new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager())
-		];
-	}
-
-	/**
-	 * Returns the repair steps to be run before an
-	 * upgrade.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getBeforeUpgradeRepairSteps() {
-		$connection = \OC::$server->getDatabaseConnection();
-		$config = \OC::$server->getConfig();
-		$steps = [
-			new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), $connection, true),
-			new SqliteAutoincrement($connection),
-			new SaveAccountsTableData($connection, $config),
-			new DropAccountTermsTable($connection),
-		];
-
-		return $steps;
-	}
-
-	/**
-	 * @param string $scope
-	 * @param string $method
-	 * @param array $arguments
-	 */
-	public function emit($scope, $method, array $arguments = []) {
-		if (!is_null($this->dispatcher)) {
-			$this->dispatcher->dispatch("$scope::$method",
-				new GenericEvent("$scope::$method", $arguments));
-		}
-	}
-
-	public function info($string) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'info', array($string));
-	}
-
-	/**
-	 * @param string $message
-	 */
-	public function warning($message) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'warning', [$message]);
-	}
-
-	/**
-	 * @param int $max
-	 */
-	public function startProgress($max = 0) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'startProgress', [$max, $this->currentStep]);
-	}
-
-	/**
-	 * @param int $step
-	 * @param string $description
-	 */
-	public function advance($step = 1, $description = '') {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'advance', [$step, $description]);
-	}
-
-	/**
-	 * @param int $max
-	 */
-	public function finishProgress() {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'finishProgress', []);
-	}
+    /* @var IRepairStep[] */
+    private $repairSteps;
+    /** @var EventDispatcher */
+    private $dispatcher;
+    /** @var string */
+    private $currentStep;
+
+    /**
+     * Creates a new repair step runner
+     *
+     * @param IRepairStep[] $repairSteps array of RepairStep instances
+     * @param EventDispatcher $dispatcher
+     */
+    public function __construct($repairSteps = [], EventDispatcher $dispatcher = null) {
+        $this->repairSteps = $repairSteps;
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * Run a series of repair steps for common problems
+     */
+    public function run() {
+        if (count($this->repairSteps) === 0) {
+            $this->emit('\OC\Repair', 'info', array('No repair steps available'));
+            return;
+        }
+        // run each repair step
+        foreach ($this->repairSteps as $step) {
+            $this->currentStep = $step->getName();
+            $this->emit('\OC\Repair', 'step', [$this->currentStep]);
+            $step->run($this);
+        }
+    }
+
+    /**
+     * Add repair step
+     *
+     * @param IRepairStep|string $repairStep repair step
+     * @throws \Exception
+     */
+    public function addStep($repairStep) {
+        if (is_string($repairStep)) {
+            try {
+                $s = \OC::$server->query($repairStep);
+            } catch (QueryException $e) {
+                if (class_exists($repairStep)) {
+                    $s = new $repairStep();
+                } else {
+                    throw new \Exception("Repair step '$repairStep' is unknown");
+                }
+            }
+
+            if ($s instanceof IRepairStep) {
+                $this->repairSteps[] = $s;
+            } else {
+                throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
+            }
+        } else {
+            $this->repairSteps[] = $repairStep;
+        }
+    }
+
+    /**
+     * Returns the default repair steps to be run on the
+     * command line or after an upgrade.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getRepairSteps() {
+        return [
+            new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), \OC::$server->getDatabaseConnection(), false),
+            new RepairMimeTypes(\OC::$server->getConfig()),
+            new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
+            new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
+            new RemoveRootShares(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager(), \OC::$server->getLazyRootFolder()),
+            new MoveUpdaterStepFile(\OC::$server->getConfig()),
+            new FixMountStorages(\OC::$server->getDatabaseConnection()),
+            new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
+            new AddLogRotateJob(\OC::$server->getJobList()),
+            new ClearFrontendCaches(\OC::$server->getMemCacheFactory(), \OC::$server->query(SCSSCacher::class), \OC::$server->query(JSCombiner::class))
+        ];
+    }
+
+    /**
+     * Returns expensive repair steps to be run on the
+     * command line with a special option.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getExpensiveRepairSteps() {
+        return [
+            new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager())
+        ];
+    }
+
+    /**
+     * Returns the repair steps to be run before an
+     * upgrade.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getBeforeUpgradeRepairSteps() {
+        $connection = \OC::$server->getDatabaseConnection();
+        $config = \OC::$server->getConfig();
+        $steps = [
+            new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), $connection, true),
+            new SqliteAutoincrement($connection),
+            new SaveAccountsTableData($connection, $config),
+            new DropAccountTermsTable($connection),
+        ];
+
+        return $steps;
+    }
+
+    /**
+     * @param string $scope
+     * @param string $method
+     * @param array $arguments
+     */
+    public function emit($scope, $method, array $arguments = []) {
+        if (!is_null($this->dispatcher)) {
+            $this->dispatcher->dispatch("$scope::$method",
+                new GenericEvent("$scope::$method", $arguments));
+        }
+    }
+
+    public function info($string) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'info', array($string));
+    }
+
+    /**
+     * @param string $message
+     */
+    public function warning($message) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'warning', [$message]);
+    }
+
+    /**
+     * @param int $max
+     */
+    public function startProgress($max = 0) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'startProgress', [$max, $this->currentStep]);
+    }
+
+    /**
+     * @param int $step
+     * @param string $description
+     */
+    public function advance($step = 1, $description = '') {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'advance', [$step, $description]);
+    }
+
+    /**
+     * @param int $max
+     */
+    public function finishProgress() {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'finishProgress', []);
+    }
 }

lib/private/Session/CryptoSessionData.php

Doc Comments +1 added lines, -1 removed lines

@@ -176,7 +176,7 @@
 
 	/**
 	 * @param mixed $offset
-	 * @return mixed
+	 * @return string|null
 	 */
 	public function offsetGet($offset) {
 		return $this->get($offset);

Spacing +3 added lines, -3 removed lines

@@ -66,7 +66,7 @@ 
 	public function __destruct() {
 		try {
 			$this->close();
-		} catch (SessionNotAvailableException $e){
+		} catch (SessionNotAvailableException $e) {
 			// This exception can occur if session is already closed
 			// So it is safe to ignore it and let the garbage collector to proceed
 		}
@@ -102,7 +102,7 @@ 
 	 * @return string|null Either the value or null
 	 */
 	public function get($key) {
-		if(isset($this->sessionValues[$key])) {
+		if (isset($this->sessionValues[$key])) {
 			return $this->sessionValues[$key];
 		}
 
@@ -168,7 +168,7 @@ 
 	 * Close the session and release the lock, also writes all changed data in batch
 	 */
 	public function close() {
-		if($this->isModified) {
+		if ($this->isModified) {
 			$encryptedValue = $this->crypto->encrypt(json_encode($this->sessionValues), $this->passphrase);
 			$this->session->set(self::encryptedSessionName, $encryptedValue);
 			$this->isModified = false;

Indentation +172 added lines, -172 removed lines

@@ -36,176 +36,176 @@
  * @package OC\Session
  */
 class CryptoSessionData implements \ArrayAccess, ISession {
-	/** @var ISession */
-	protected $session;
-	/** @var \OCP\Security\ICrypto */
-	protected $crypto;
-	/** @var string */
-	protected $passphrase;
-	/** @var array */
-	protected $sessionValues;
-	/** @var bool */
-	protected $isModified = false;
-	CONST encryptedSessionName = 'encrypted_session_data';
-
-	/**
-	 * @param ISession $session
-	 * @param ICrypto $crypto
-	 * @param string $passphrase
-	 */
-	public function __construct(ISession $session,
-								ICrypto $crypto,
-								$passphrase) {
-		$this->crypto = $crypto;
-		$this->session = $session;
-		$this->passphrase = $passphrase;
-		$this->initializeSession();
-	}
-
-	/**
-	 * Close session if class gets destructed
-	 */
-	public function __destruct() {
-		try {
-			$this->close();
-		} catch (SessionNotAvailableException $e){
-			// This exception can occur if session is already closed
-			// So it is safe to ignore it and let the garbage collector to proceed
-		}
-	}
-
-	protected function initializeSession() {
-		$encryptedSessionData = $this->session->get(self::encryptedSessionName) ?: '';
-		try {
-			$this->sessionValues = json_decode(
-				$this->crypto->decrypt($encryptedSessionData, $this->passphrase),
-				true
-			);
-		} catch (\Exception $e) {
-			$this->sessionValues = [];
-		}
-	}
-
-	/**
-	 * Set a value in the session
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 */
-	public function set($key, $value) {
-		$this->sessionValues[$key] = $value;
-		$this->isModified = true;
-	}
-
-	/**
-	 * Get a value from the session
-	 *
-	 * @param string $key
-	 * @return string|null Either the value or null
-	 */
-	public function get($key) {
-		if(isset($this->sessionValues[$key])) {
-			return $this->sessionValues[$key];
-		}
-
-		return null;
-	}
-
-	/**
-	 * Check if a named key exists in the session
-	 *
-	 * @param string $key
-	 * @return bool
-	 */
-	public function exists($key) {
-		return isset($this->sessionValues[$key]);
-	}
-
-	/**
-	 * Remove a $key/$value pair from the session
-	 *
-	 * @param string $key
-	 */
-	public function remove($key) {
-		$this->isModified = true;
-		unset($this->sessionValues[$key]);
-		$this->session->remove(self::encryptedSessionName);
-	}
-
-	/**
-	 * Reset and recreate the session
-	 */
-	public function clear() {
-		$requesttoken = $this->get('requesttoken');
-		$this->sessionValues = [];
-		if ($requesttoken !== null) {
-			$this->set('requesttoken', $requesttoken);
-		}
-		$this->isModified = true;
-		$this->session->clear();
-	}
-
-	/**
-	 * Wrapper around session_regenerate_id
-	 *
-	 * @param bool $deleteOldSession Whether to delete the old associated session file or not.
-	 * @return void
-	 */
-	public function regenerateId($deleteOldSession = true) {
-		$this->session->regenerateId($deleteOldSession);
-	}
-
-	/**
-	 * Wrapper around session_id
-	 *
-	 * @return string
-	 * @throws SessionNotAvailableException
-	 * @since 9.1.0
-	 */
-	public function getId() {
-		return $this->session->getId();
-	}
-
-	/**
-	 * Close the session and release the lock, also writes all changed data in batch
-	 */
-	public function close() {
-		if($this->isModified) {
-			$encryptedValue = $this->crypto->encrypt(json_encode($this->sessionValues), $this->passphrase);
-			$this->session->set(self::encryptedSessionName, $encryptedValue);
-			$this->isModified = false;
-		}
-		$this->session->close();
-	}
-
-	/**
-	 * @param mixed $offset
-	 * @return bool
-	 */
-	public function offsetExists($offset) {
-		return $this->exists($offset);
-	}
-
-	/**
-	 * @param mixed $offset
-	 * @return mixed
-	 */
-	public function offsetGet($offset) {
-		return $this->get($offset);
-	}
-
-	/**
-	 * @param mixed $offset
-	 * @param mixed $value
-	 */
-	public function offsetSet($offset, $value) {
-		$this->set($offset, $value);
-	}
-
-	/**
-	 * @param mixed $offset
-	 */
-	public function offsetUnset($offset) {
-		$this->remove($offset);
-	}
+    /** @var ISession */
+    protected $session;
+    /** @var \OCP\Security\ICrypto */
+    protected $crypto;
+    /** @var string */
+    protected $passphrase;
+    /** @var array */
+    protected $sessionValues;
+    /** @var bool */
+    protected $isModified = false;
+    CONST encryptedSessionName = 'encrypted_session_data';
+
+    /**
+     * @param ISession $session
+     * @param ICrypto $crypto
+     * @param string $passphrase
+     */
+    public function __construct(ISession $session,
+                                ICrypto $crypto,
+                                $passphrase) {
+        $this->crypto = $crypto;
+        $this->session = $session;
+        $this->passphrase = $passphrase;
+        $this->initializeSession();
+    }
+
+    /**
+     * Close session if class gets destructed
+     */
+    public function __destruct() {
+        try {
+            $this->close();
+        } catch (SessionNotAvailableException $e){
+            // This exception can occur if session is already closed
+            // So it is safe to ignore it and let the garbage collector to proceed
+        }
+    }
+
+    protected function initializeSession() {
+        $encryptedSessionData = $this->session->get(self::encryptedSessionName) ?: '';
+        try {
+            $this->sessionValues = json_decode(
+                $this->crypto->decrypt($encryptedSessionData, $this->passphrase),
+                true
+            );
+        } catch (\Exception $e) {
+            $this->sessionValues = [];
+        }
+    }
+
+    /**
+     * Set a value in the session
+     *
+     * @param string $key
+     * @param mixed $value
+     */
+    public function set($key, $value) {
+        $this->sessionValues[$key] = $value;
+        $this->isModified = true;
+    }
+
+    /**
+     * Get a value from the session
+     *
+     * @param string $key
+     * @return string|null Either the value or null
+     */
+    public function get($key) {
+        if(isset($this->sessionValues[$key])) {
+            return $this->sessionValues[$key];
+        }
+
+        return null;
+    }
+
+    /**
+     * Check if a named key exists in the session
+     *
+     * @param string $key
+     * @return bool
+     */
+    public function exists($key) {
+        return isset($this->sessionValues[$key]);
+    }
+
+    /**
+     * Remove a $key/$value pair from the session
+     *
+     * @param string $key
+     */
+    public function remove($key) {
+        $this->isModified = true;
+        unset($this->sessionValues[$key]);
+        $this->session->remove(self::encryptedSessionName);
+    }
+
+    /**
+     * Reset and recreate the session
+     */
+    public function clear() {
+        $requesttoken = $this->get('requesttoken');
+        $this->sessionValues = [];
+        if ($requesttoken !== null) {
+            $this->set('requesttoken', $requesttoken);
+        }
+        $this->isModified = true;
+        $this->session->clear();
+    }
+
+    /**
+     * Wrapper around session_regenerate_id
+     *
+     * @param bool $deleteOldSession Whether to delete the old associated session file or not.
+     * @return void
+     */
+    public function regenerateId($deleteOldSession = true) {
+        $this->session->regenerateId($deleteOldSession);
+    }
+
+    /**
+     * Wrapper around session_id
+     *
+     * @return string
+     * @throws SessionNotAvailableException
+     * @since 9.1.0
+     */
+    public function getId() {
+        return $this->session->getId();
+    }
+
+    /**
+     * Close the session and release the lock, also writes all changed data in batch
+     */
+    public function close() {
+        if($this->isModified) {
+            $encryptedValue = $this->crypto->encrypt(json_encode($this->sessionValues), $this->passphrase);
+            $this->session->set(self::encryptedSessionName, $encryptedValue);
+            $this->isModified = false;
+        }
+        $this->session->close();
+    }
+
+    /**
+     * @param mixed $offset
+     * @return bool
+     */
+    public function offsetExists($offset) {
+        return $this->exists($offset);
+    }
+
+    /**
+     * @param mixed $offset
+     * @return mixed
+     */
+    public function offsetGet($offset) {
+        return $this->get($offset);
+    }
+
+    /**
+     * @param mixed $offset
+     * @param mixed $value
+     */
+    public function offsetSet($offset, $value) {
+        $this->set($offset, $value);
+    }
+
+    /**
+     * @param mixed $offset
+     */
+    public function offsetUnset($offset) {
+        $this->remove($offset);
+    }
 }

lib/private/Tags.php

Doc Comments +10 added lines, -2 removed lines

@@ -742,11 +742,19 @@ 
 	}
 
 	// case-insensitive array_search
+
+	/**
+	 * @param string $needle
+	 */
 	protected function array_searchi($needle, $haystack, $mem='getName') {
 		if(!is_array($haystack)) {
 			return false;
 		}
 		return array_search(strtolower($needle), array_map(
+
+			/**
+			 * @param string $tag
+			 */
 			function($tag) use($mem) {
 				return strtolower(call_user_func(array($tag, $mem)));
 			}, $haystack)
@@ -771,7 +779,7 @@ 
 	* Get a tag by its name.
 	*
 	* @param string $name The tag name.
-	* @return integer|bool The tag object's offset within the $this->tags
+	* @return \OCP\AppFramework\Db\Entity The tag object's offset within the $this->tags
 	*                      array or false if it doesn't exist.
 	*/
 	private function getTagByName($name) {
@@ -782,7 +790,7 @@ 
 	* Get a tag by its ID.
 	*
 	* @param string $id The tag ID to look for.
-	* @return integer|bool The tag object's offset within the $this->tags
+	* @return \OCP\AppFramework\Db\Entity The tag object's offset within the $this->tags
 	*                      array or false if it doesn't exist.
 	*/
 	private function getTagById($id) {

Indentation +802 added lines, -802 removed lines

@@ -50,806 +50,806 @@
 
 class Tags implements \OCP\ITags {
 
-	/**
-	 * Tags
-	 *
-	 * @var array
-	 */
-	private $tags = array();
-
-	/**
-	 * Used for storing objectid/categoryname pairs while rescanning.
-	 *
-	 * @var array
-	 */
-	private static $relations = array();
-
-	/**
-	 * Type
-	 *
-	 * @var string
-	 */
-	private $type;
-
-	/**
-	 * User
-	 *
-	 * @var string
-	 */
-	private $user;
-
-	/**
-	 * Are we including tags for shared items?
-	 *
-	 * @var bool
-	 */
-	private $includeShared = false;
-
-	/**
-	 * The current user, plus any owners of the items shared with the current
-	 * user, if $this->includeShared === true.
-	 *
-	 * @var array
-	 */
-	private $owners = array();
-
-	/**
-	 * The Mapper we're using to communicate our Tag objects to the database.
-	 *
-	 * @var TagMapper
-	 */
-	private $mapper;
-
-	/**
-	 * The sharing backend for objects of $this->type. Required if
-	 * $this->includeShared === true to determine ownership of items.
-	 *
-	 * @var \OCP\Share_Backend
-	 */
-	private $backend;
-
-	const TAG_TABLE = '*PREFIX*vcategory';
-	const RELATION_TABLE = '*PREFIX*vcategory_to_object';
-
-	const TAG_FAVORITE = '_$!<Favorite>!$_';
-
-	/**
-	* Constructor.
-	*
-	* @param TagMapper $mapper Instance of the TagMapper abstraction layer.
-	* @param string $user The user whose data the object will operate on.
-	* @param string $type The type of items for which tags will be loaded.
-	* @param array $defaultTags Tags that should be created at construction.
-	* @param boolean $includeShared Whether to include tags for items shared with this user by others.
-	*/
-	public function __construct(TagMapper $mapper, $user, $type, $defaultTags = array(), $includeShared = false) {
-		$this->mapper = $mapper;
-		$this->user = $user;
-		$this->type = $type;
-		$this->includeShared = $includeShared;
-		$this->owners = array($this->user);
-		if ($this->includeShared) {
-			$this->owners = array_merge($this->owners, \OC\Share\Share::getSharedItemsOwners($this->user, $this->type, true));
-			$this->backend = \OC\Share\Share::getBackend($this->type);
-		}
-		$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-
-		if(count($defaultTags) > 0 && count($this->tags) === 0) {
-			$this->addMultiple($defaultTags, true);
-		}
-	}
-
-	/**
-	* Check if any tags are saved for this type and user.
-	*
-	* @return boolean
-	*/
-	public function isEmpty() {
-		return count($this->tags) === 0;
-	}
-
-	/**
-	* Returns an array mapping a given tag's properties to its values:
-	* ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
-	*
-	* @param string $id The ID of the tag that is going to be mapped
-	* @return array|false
-	*/
-	public function getTag($id) {
-		$key = $this->getTagById($id);
-		if ($key !== false) {
-			return $this->tagMap($this->tags[$key]);
-		}
-		return false;
-	}
-
-	/**
-	* Get the tags for a specific user.
-	*
-	* This returns an array with maps containing each tag's properties:
-	* [
-	* 	['id' => 0, 'name' = 'First tag', 'owner' = 'User', 'type' => 'tagtype'],
-	* 	['id' => 1, 'name' = 'Shared tag', 'owner' = 'Other user', 'type' => 'tagtype'],
-	* ]
-	*
-	* @return array
-	*/
-	public function getTags() {
-		if(!count($this->tags)) {
-			return array();
-		}
-
-		usort($this->tags, function($a, $b) {
-			return strnatcasecmp($a->getName(), $b->getName());
-		});
-		$tagMap = array();
-
-		foreach($this->tags as $tag) {
-			if($tag->getName() !== self::TAG_FAVORITE) {
-				$tagMap[] = $this->tagMap($tag);
-			}
-		}
-		return $tagMap;
-
-	}
-
-	/**
-	* Return only the tags owned by the given user, omitting any tags shared
-	* by other users.
-	*
-	* @param string $user The user whose tags are to be checked.
-	* @return array An array of Tag objects.
-	*/
-	public function getTagsForUser($user) {
-		return array_filter($this->tags,
-			function($tag) use($user) {
-				return $tag->getOwner() === $user;
-			}
-		);
-	}
-
-	/**
-	 * Get the list of tags for the given ids.
-	 *
-	 * @param array $objIds array of object ids
-	 * @return array|boolean of tags id as key to array of tag names
-	 * or false if an error occurred
-	 */
-	public function getTagsForObjects(array $objIds) {
-		$entries = array();
-
-		try {
-			$conn = \OC::$server->getDatabaseConnection();
-			$chunks = array_chunk($objIds, 900, false);
-			foreach ($chunks as $chunk) {
-				$result = $conn->executeQuery(
-					'SELECT `category`, `categoryid`, `objid` ' .
-					'FROM `' . self::RELATION_TABLE . '` r, `' . self::TAG_TABLE . '` ' .
-					'WHERE `categoryid` = `id` AND `uid` = ? AND r.`type` = ? AND `objid` IN (?)',
-					array($this->user, $this->type, $chunk),
-					array(null, null, IQueryBuilder::PARAM_INT_ARRAY)
-				);
-				while ($row = $result->fetch()) {
-					$objId = (int)$row['objid'];
-					if (!isset($entries[$objId])) {
-						$entries[$objId] = array();
-					}
-					$entries[$objId][] = $row['category'];
-				}
-				if (\OCP\DB::isError($result)) {
-					\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-					return false;
-				}
-			}
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => \OCP\Util::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-
-		return $entries;
-	}
-
-	/**
-	* Get the a list if items tagged with $tag.
-	*
-	* Throws an exception if the tag could not be found.
-	*
-	* @param string $tag Tag id or name.
-	* @return array|false An array of object ids or false on error.
-	* @throws \Exception
-	*/
-	public function getIdsForTag($tag) {
-		$result = null;
-		$tagId = false;
-		if(is_numeric($tag)) {
-			$tagId = $tag;
-		} elseif(is_string($tag)) {
-			$tag = trim($tag);
-			if($tag === '') {
-				\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
-				return false;
-			}
-			$tagId = $this->getTagId($tag);
-		}
-
-		if($tagId === false) {
-			$l10n = \OC::$server->getL10N('core');
-			throw new \Exception(
-				$l10n->t('Could not find category "%s"', [$tag])
-			);
-		}
-
-		$ids = array();
-		$sql = 'SELECT `objid` FROM `' . self::RELATION_TABLE
-			. '` WHERE `categoryid` = ?';
-
-		try {
-			$stmt = \OCP\DB::prepare($sql);
-			$result = $stmt->execute(array($tagId));
-			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-				return false;
-			}
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => \OCP\Util::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-
-		if(!is_null($result)) {
-			while( $row = $result->fetchRow()) {
-				$id = (int)$row['objid'];
-
-				if ($this->includeShared) {
-					// We have to check if we are really allowed to access the
-					// items that are tagged with $tag. To that end, we ask the
-					// corresponding sharing backend if the item identified by $id
-					// is owned by any of $this->owners.
-					foreach ($this->owners as $owner) {
-						if ($this->backend->isValidSource($id, $owner)) {
-							$ids[] = $id;
-							break;
-						}
-					}
-				} else {
-					$ids[] = $id;
-				}
-			}
-		}
-
-		return $ids;
-	}
-
-	/**
-	* Checks whether a tag is saved for the given user,
-	* disregarding the ones shared with him or her.
-	*
-	* @param string $name The tag name to check for.
-	* @param string $user The user whose tags are to be checked.
-	* @return bool
-	*/
-	public function userHasTag($name, $user) {
-		$key = $this->array_searchi($name, $this->getTagsForUser($user));
-		return ($key !== false) ? $this->tags[$key]->getId() : false;
-	}
-
-	/**
-	* Checks whether a tag is saved for or shared with the current user.
-	*
-	* @param string $name The tag name to check for.
-	* @return bool
-	*/
-	public function hasTag($name) {
-		return $this->getTagId($name) !== false;
-	}
-
-	/**
-	* Add a new tag.
-	*
-	* @param string $name A string with a name of the tag
-	* @return false|int the id of the added tag or false on error.
-	*/
-	public function add($name) {
-		$name = trim($name);
-
-		if($name === '') {
-			\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
-			return false;
-		}
-		if($this->userHasTag($name, $this->user)) {
-			\OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', \OCP\Util::DEBUG);
-			return false;
-		}
-		try {
-			$tag = new Tag($this->user, $this->type, $name);
-			$tag = $this->mapper->insert($tag);
-			$this->tags[] = $tag;
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => \OCP\Util::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-		\OCP\Util::writeLog('core', __METHOD__.', id: ' . $tag->getId(), \OCP\Util::DEBUG);
-		return $tag->getId();
-	}
-
-	/**
-	* Rename tag.
-	*
-	* @param string|integer $from The name or ID of the existing tag
-	* @param string $to The new name of the tag.
-	* @return bool
-	*/
-	public function rename($from, $to) {
-		$from = trim($from);
-		$to = trim($to);
-
-		if($to === '' || $from === '') {
-			\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
-			return false;
-		}
-
-		if (is_numeric($from)) {
-			$key = $this->getTagById($from);
-		} else {
-			$key = $this->getTagByName($from);
-		}
-		if($key === false) {
-			\OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', \OCP\Util::DEBUG);
-			return false;
-		}
-		$tag = $this->tags[$key];
-
-		if($this->userHasTag($to, $tag->getOwner())) {
-			\OCP\Util::writeLog('core', __METHOD__.', A tag named ' . $to. ' already exists for user ' . $tag->getOwner() . '.', \OCP\Util::DEBUG);
-			return false;
-		}
-
-		try {
-			$tag->setName($to);
-			$this->tags[$key] = $this->mapper->update($tag);
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => \OCP\Util::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	* Add a list of new tags.
-	*
-	* @param string[] $names A string with a name or an array of strings containing
-	* the name(s) of the tag(s) to add.
-	* @param bool $sync When true, save the tags
-	* @param int|null $id int Optional object id to add to this|these tag(s)
-	* @return bool Returns false on error.
-	*/
-	public function addMultiple($names, $sync=false, $id = null) {
-		if(!is_array($names)) {
-			$names = array($names);
-		}
-		$names = array_map('trim', $names);
-		array_filter($names);
-
-		$newones = array();
-		foreach($names as $name) {
-			if(!$this->hasTag($name) && $name !== '') {
-				$newones[] = new Tag($this->user, $this->type, $name);
-			}
-			if(!is_null($id) ) {
-				// Insert $objectid, $categoryid  pairs if not exist.
-				self::$relations[] = array('objid' => $id, 'tag' => $name);
-			}
-		}
-		$this->tags = array_merge($this->tags, $newones);
-		if($sync === true) {
-			$this->save();
-		}
-
-		return true;
-	}
-
-	/**
-	 * Save the list of tags and their object relations
-	 */
-	protected function save() {
-		if(is_array($this->tags)) {
-			foreach($this->tags as $tag) {
-				try {
-					if (!$this->mapper->tagExists($tag)) {
-						$this->mapper->insert($tag);
-					}
-				} catch(\Exception $e) {
-					\OC::$server->getLogger()->logException($e, [
-						'message' => __METHOD__,
-						'level' => \OCP\Util::ERROR,
-						'app' => 'core',
-					]);
-				}
-			}
-
-			// reload tags to get the proper ids.
-			$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-			\OCP\Util::writeLog('core', __METHOD__.', tags: ' . print_r($this->tags, true),
-				\OCP\Util::DEBUG);
-			// Loop through temporarily cached objectid/tagname pairs
-			// and save relations.
-			$tags = $this->tags;
-			// For some reason this is needed or array_search(i) will return 0..?
-			ksort($tags);
-			foreach(self::$relations as $relation) {
-				$tagId = $this->getTagId($relation['tag']);
-				\OCP\Util::writeLog('core', __METHOD__ . 'catid, ' . $relation['tag'] . ' ' . $tagId, \OCP\Util::DEBUG);
-				if($tagId) {
-					try {
-						\OCP\DB::insertIfNotExist(self::RELATION_TABLE,
-							array(
-								'objid' => $relation['objid'],
-								'categoryid' => $tagId,
-								'type' => $this->type,
-								));
-					} catch(\Exception $e) {
-						\OC::$server->getLogger()->logException($e, [
-							'message' => __METHOD__,
-							'level' => \OCP\Util::ERROR,
-							'app' => 'core',
-						]);
-					}
-				}
-			}
-			self::$relations = array(); // reset
-		} else {
-			\OCP\Util::writeLog('core', __METHOD__.', $this->tags is not an array! '
-				. print_r($this->tags, true), \OCP\Util::ERROR);
-		}
-	}
-
-	/**
-	* Delete tags and tag/object relations for a user.
-	*
-	* For hooking up on post_deleteUser
-	*
-	* @param array $arguments
-	*/
-	public static function post_deleteUser($arguments) {
-		// Find all objectid/tagId pairs.
-		$result = null;
-		try {
-			$stmt = \OCP\DB::prepare('SELECT `id` FROM `' . self::TAG_TABLE . '` '
-				. 'WHERE `uid` = ?');
-			$result = $stmt->execute(array($arguments['uid']));
-			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-			}
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => \OCP\Util::ERROR,
-				'app' => 'core',
-			]);
-		}
-
-		if(!is_null($result)) {
-			try {
-				$stmt = \OCP\DB::prepare('DELETE FROM `' . self::RELATION_TABLE . '` '
-					. 'WHERE `categoryid` = ?');
-				while( $row = $result->fetchRow()) {
-					try {
-						$stmt->execute(array($row['id']));
-					} catch(\Exception $e) {
-						\OC::$server->getLogger()->logException($e, [
-							'message' => __METHOD__,
-							'level' => \OCP\Util::ERROR,
-							'app' => 'core',
-						]);
-					}
-				}
-			} catch(\Exception $e) {
-				\OC::$server->getLogger()->logException($e, [
-					'message' => __METHOD__,
-					'level' => \OCP\Util::ERROR,
-					'app' => 'core',
-				]);
-			}
-		}
-		try {
-			$stmt = \OCP\DB::prepare('DELETE FROM `' . self::TAG_TABLE . '` '
-				. 'WHERE `uid` = ?');
-			$result = $stmt->execute(array($arguments['uid']));
-			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. ', DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-			}
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => \OCP\Util::ERROR,
-				'app' => 'core',
-			]);
-		}
-	}
-
-	/**
-	* Delete tag/object relations from the db
-	*
-	* @param array $ids The ids of the objects
-	* @return boolean Returns false on error.
-	*/
-	public function purgeObjects(array $ids) {
-		if(count($ids) === 0) {
-			// job done ;)
-			return true;
-		}
-		$updates = $ids;
-		try {
-			$query = 'DELETE FROM `' . self::RELATION_TABLE . '` ';
-			$query .= 'WHERE `objid` IN (' . str_repeat('?,', count($ids)-1) . '?) ';
-			$query .= 'AND `type`= ?';
-			$updates[] = $this->type;
-			$stmt = \OCP\DB::prepare($query);
-			$result = $stmt->execute($updates);
-			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
-				return false;
-			}
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => \OCP\Util::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	* Get favorites for an object type
-	*
-	* @return array|false An array of object ids.
-	*/
-	public function getFavorites() {
-		try {
-			return $this->getIdsForTag(self::TAG_FAVORITE);
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => \OCP\Util::ERROR,
-				'app' => 'core',
-			]);
-			return array();
-		}
-	}
-
-	/**
-	* Add an object to favorites
-	*
-	* @param int $objid The id of the object
-	* @return boolean
-	*/
-	public function addToFavorites($objid) {
-		if(!$this->userHasTag(self::TAG_FAVORITE, $this->user)) {
-			$this->add(self::TAG_FAVORITE);
-		}
-		return $this->tagAs($objid, self::TAG_FAVORITE);
-	}
-
-	/**
-	* Remove an object from favorites
-	*
-	* @param int $objid The id of the object
-	* @return boolean
-	*/
-	public function removeFromFavorites($objid) {
-		return $this->unTag($objid, self::TAG_FAVORITE);
-	}
-
-	/**
-	* Creates a tag/object relation.
-	*
-	* @param int $objid The id of the object
-	* @param string $tag The id or name of the tag
-	* @return boolean Returns false on error.
-	*/
-	public function tagAs($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
-			$tag = trim($tag);
-			if($tag === '') {
-				\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
-				return false;
-			}
-			if(!$this->hasTag($tag)) {
-				$this->add($tag);
-			}
-			$tagId =  $this->getTagId($tag);
-		} else {
-			$tagId = $tag;
-		}
-		try {
-			\OCP\DB::insertIfNotExist(self::RELATION_TABLE,
-				array(
-					'objid' => $objid,
-					'categoryid' => $tagId,
-					'type' => $this->type,
-				));
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => \OCP\Util::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	* Delete single tag/object relation from the db
-	*
-	* @param int $objid The id of the object
-	* @param string $tag The id or name of the tag
-	* @return boolean
-	*/
-	public function unTag($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
-			$tag = trim($tag);
-			if($tag === '') {
-				\OCP\Util::writeLog('core', __METHOD__.', Tag name is empty', \OCP\Util::DEBUG);
-				return false;
-			}
-			$tagId =  $this->getTagId($tag);
-		} else {
-			$tagId = $tag;
-		}
-
-		try {
-			$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
-					. 'WHERE `objid` = ? AND `categoryid` = ? AND `type` = ?';
-			$stmt = \OCP\DB::prepare($sql);
-			$stmt->execute(array($objid, $tagId, $this->type));
-		} catch(\Exception $e) {
-			\OC::$server->getLogger()->logException($e, [
-				'message' => __METHOD__,
-				'level' => \OCP\Util::ERROR,
-				'app' => 'core',
-			]);
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	* Delete tags from the database.
-	*
-	* @param string[]|integer[] $names An array of tags (names or IDs) to delete
-	* @return bool Returns false on error
-	*/
-	public function delete($names) {
-		if(!is_array($names)) {
-			$names = array($names);
-		}
-
-		$names = array_map('trim', $names);
-		array_filter($names);
-
-		\OCP\Util::writeLog('core', __METHOD__ . ', before: '
-			. print_r($this->tags, true), \OCP\Util::DEBUG);
-		foreach($names as $name) {
-			$id = null;
-
-			if (is_numeric($name)) {
-				$key = $this->getTagById($name);
-			} else {
-				$key = $this->getTagByName($name);
-			}
-			if ($key !== false) {
-				$tag = $this->tags[$key];
-				$id = $tag->getId();
-				unset($this->tags[$key]);
-				$this->mapper->delete($tag);
-			} else {
-				\OCP\Util::writeLog('core', __METHOD__ . 'Cannot delete tag ' . $name
-					. ': not found.', \OCP\Util::ERROR);
-			}
-			if(!is_null($id) && $id !== false) {
-				try {
-					$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
-							. 'WHERE `categoryid` = ?';
-					$stmt = \OCP\DB::prepare($sql);
-					$result = $stmt->execute(array($id));
-					if (\OCP\DB::isError($result)) {
-						\OCP\Util::writeLog('core',
-							__METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(),
-							\OCP\Util::ERROR);
-						return false;
-					}
-				} catch(\Exception $e) {
-					\OC::$server->getLogger()->logException($e, [
-						'message' => __METHOD__,
-						'level' => \OCP\Util::ERROR,
-						'app' => 'core',
-					]);
-					return false;
-				}
-			}
-		}
-		return true;
-	}
-
-	// case-insensitive array_search
-	protected function array_searchi($needle, $haystack, $mem='getName') {
-		if(!is_array($haystack)) {
-			return false;
-		}
-		return array_search(strtolower($needle), array_map(
-			function($tag) use($mem) {
-				return strtolower(call_user_func(array($tag, $mem)));
-			}, $haystack)
-		);
-	}
-
-	/**
-	* Get a tag's ID.
-	*
-	* @param string $name The tag name to look for.
-	* @return string|bool The tag's id or false if no matching tag is found.
-	*/
-	private function getTagId($name) {
-		$key = $this->array_searchi($name, $this->tags);
-		if ($key !== false) {
-			return $this->tags[$key]->getId();
-		}
-		return false;
-	}
-
-	/**
-	* Get a tag by its name.
-	*
-	* @param string $name The tag name.
-	* @return integer|bool The tag object's offset within the $this->tags
-	*                      array or false if it doesn't exist.
-	*/
-	private function getTagByName($name) {
-		return $this->array_searchi($name, $this->tags, 'getName');
-	}
-
-	/**
-	* Get a tag by its ID.
-	*
-	* @param string $id The tag ID to look for.
-	* @return integer|bool The tag object's offset within the $this->tags
-	*                      array or false if it doesn't exist.
-	*/
-	private function getTagById($id) {
-		return $this->array_searchi($id, $this->tags, 'getId');
-	}
-
-	/**
-	* Returns an array mapping a given tag's properties to its values:
-	* ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
-	*
-	* @param Tag $tag The tag that is going to be mapped
-	* @return array
-	*/
-	private function tagMap(Tag $tag) {
-		return array(
-			'id'    => $tag->getId(),
-			'name'  => $tag->getName(),
-			'owner' => $tag->getOwner(),
-			'type'  => $tag->getType()
-		);
-	}
+    /**
+     * Tags
+     *
+     * @var array
+     */
+    private $tags = array();
+
+    /**
+     * Used for storing objectid/categoryname pairs while rescanning.
+     *
+     * @var array
+     */
+    private static $relations = array();
+
+    /**
+     * Type
+     *
+     * @var string
+     */
+    private $type;
+
+    /**
+     * User
+     *
+     * @var string
+     */
+    private $user;
+
+    /**
+     * Are we including tags for shared items?
+     *
+     * @var bool
+     */
+    private $includeShared = false;
+
+    /**
+     * The current user, plus any owners of the items shared with the current
+     * user, if $this->includeShared === true.
+     *
+     * @var array
+     */
+    private $owners = array();
+
+    /**
+     * The Mapper we're using to communicate our Tag objects to the database.
+     *
+     * @var TagMapper
+     */
+    private $mapper;
+
+    /**
+     * The sharing backend for objects of $this->type. Required if
+     * $this->includeShared === true to determine ownership of items.
+     *
+     * @var \OCP\Share_Backend
+     */
+    private $backend;
+
+    const TAG_TABLE = '*PREFIX*vcategory';
+    const RELATION_TABLE = '*PREFIX*vcategory_to_object';
+
+    const TAG_FAVORITE = '_$!<Favorite>!$_';
+
+    /**
+     * Constructor.
+     *
+     * @param TagMapper $mapper Instance of the TagMapper abstraction layer.
+     * @param string $user The user whose data the object will operate on.
+     * @param string $type The type of items for which tags will be loaded.
+     * @param array $defaultTags Tags that should be created at construction.
+     * @param boolean $includeShared Whether to include tags for items shared with this user by others.
+     */
+    public function __construct(TagMapper $mapper, $user, $type, $defaultTags = array(), $includeShared = false) {
+        $this->mapper = $mapper;
+        $this->user = $user;
+        $this->type = $type;
+        $this->includeShared = $includeShared;
+        $this->owners = array($this->user);
+        if ($this->includeShared) {
+            $this->owners = array_merge($this->owners, \OC\Share\Share::getSharedItemsOwners($this->user, $this->type, true));
+            $this->backend = \OC\Share\Share::getBackend($this->type);
+        }
+        $this->tags = $this->mapper->loadTags($this->owners, $this->type);
+
+        if(count($defaultTags) > 0 && count($this->tags) === 0) {
+            $this->addMultiple($defaultTags, true);
+        }
+    }
+
+    /**
+     * Check if any tags are saved for this type and user.
+     *
+     * @return boolean
+     */
+    public function isEmpty() {
+        return count($this->tags) === 0;
+    }
+
+    /**
+     * Returns an array mapping a given tag's properties to its values:
+     * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
+     *
+     * @param string $id The ID of the tag that is going to be mapped
+     * @return array|false
+     */
+    public function getTag($id) {
+        $key = $this->getTagById($id);
+        if ($key !== false) {
+            return $this->tagMap($this->tags[$key]);
+        }
+        return false;
+    }
+
+    /**
+     * Get the tags for a specific user.
+     *
+     * This returns an array with maps containing each tag's properties:
+     * [
+     * 	['id' => 0, 'name' = 'First tag', 'owner' = 'User', 'type' => 'tagtype'],
+     * 	['id' => 1, 'name' = 'Shared tag', 'owner' = 'Other user', 'type' => 'tagtype'],
+     * ]
+     *
+     * @return array
+     */
+    public function getTags() {
+        if(!count($this->tags)) {
+            return array();
+        }
+
+        usort($this->tags, function($a, $b) {
+            return strnatcasecmp($a->getName(), $b->getName());
+        });
+        $tagMap = array();
+
+        foreach($this->tags as $tag) {
+            if($tag->getName() !== self::TAG_FAVORITE) {
+                $tagMap[] = $this->tagMap($tag);
+            }
+        }
+        return $tagMap;
+
+    }
+
+    /**
+     * Return only the tags owned by the given user, omitting any tags shared
+     * by other users.
+     *
+     * @param string $user The user whose tags are to be checked.
+     * @return array An array of Tag objects.
+     */
+    public function getTagsForUser($user) {
+        return array_filter($this->tags,
+            function($tag) use($user) {
+                return $tag->getOwner() === $user;
+            }
+        );
+    }
+
+    /**
+     * Get the list of tags for the given ids.
+     *
+     * @param array $objIds array of object ids
+     * @return array|boolean of tags id as key to array of tag names
+     * or false if an error occurred
+     */
+    public function getTagsForObjects(array $objIds) {
+        $entries = array();
+
+        try {
+            $conn = \OC::$server->getDatabaseConnection();
+            $chunks = array_chunk($objIds, 900, false);
+            foreach ($chunks as $chunk) {
+                $result = $conn->executeQuery(
+                    'SELECT `category`, `categoryid`, `objid` ' .
+                    'FROM `' . self::RELATION_TABLE . '` r, `' . self::TAG_TABLE . '` ' .
+                    'WHERE `categoryid` = `id` AND `uid` = ? AND r.`type` = ? AND `objid` IN (?)',
+                    array($this->user, $this->type, $chunk),
+                    array(null, null, IQueryBuilder::PARAM_INT_ARRAY)
+                );
+                while ($row = $result->fetch()) {
+                    $objId = (int)$row['objid'];
+                    if (!isset($entries[$objId])) {
+                        $entries[$objId] = array();
+                    }
+                    $entries[$objId][] = $row['category'];
+                }
+                if (\OCP\DB::isError($result)) {
+                    \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+                    return false;
+                }
+            }
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => \OCP\Util::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+
+        return $entries;
+    }
+
+    /**
+     * Get the a list if items tagged with $tag.
+     *
+     * Throws an exception if the tag could not be found.
+     *
+     * @param string $tag Tag id or name.
+     * @return array|false An array of object ids or false on error.
+     * @throws \Exception
+     */
+    public function getIdsForTag($tag) {
+        $result = null;
+        $tagId = false;
+        if(is_numeric($tag)) {
+            $tagId = $tag;
+        } elseif(is_string($tag)) {
+            $tag = trim($tag);
+            if($tag === '') {
+                \OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
+                return false;
+            }
+            $tagId = $this->getTagId($tag);
+        }
+
+        if($tagId === false) {
+            $l10n = \OC::$server->getL10N('core');
+            throw new \Exception(
+                $l10n->t('Could not find category "%s"', [$tag])
+            );
+        }
+
+        $ids = array();
+        $sql = 'SELECT `objid` FROM `' . self::RELATION_TABLE
+            . '` WHERE `categoryid` = ?';
+
+        try {
+            $stmt = \OCP\DB::prepare($sql);
+            $result = $stmt->execute(array($tagId));
+            if (\OCP\DB::isError($result)) {
+                \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+                return false;
+            }
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => \OCP\Util::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+
+        if(!is_null($result)) {
+            while( $row = $result->fetchRow()) {
+                $id = (int)$row['objid'];
+
+                if ($this->includeShared) {
+                    // We have to check if we are really allowed to access the
+                    // items that are tagged with $tag. To that end, we ask the
+                    // corresponding sharing backend if the item identified by $id
+                    // is owned by any of $this->owners.
+                    foreach ($this->owners as $owner) {
+                        if ($this->backend->isValidSource($id, $owner)) {
+                            $ids[] = $id;
+                            break;
+                        }
+                    }
+                } else {
+                    $ids[] = $id;
+                }
+            }
+        }
+
+        return $ids;
+    }
+
+    /**
+     * Checks whether a tag is saved for the given user,
+     * disregarding the ones shared with him or her.
+     *
+     * @param string $name The tag name to check for.
+     * @param string $user The user whose tags are to be checked.
+     * @return bool
+     */
+    public function userHasTag($name, $user) {
+        $key = $this->array_searchi($name, $this->getTagsForUser($user));
+        return ($key !== false) ? $this->tags[$key]->getId() : false;
+    }
+
+    /**
+     * Checks whether a tag is saved for or shared with the current user.
+     *
+     * @param string $name The tag name to check for.
+     * @return bool
+     */
+    public function hasTag($name) {
+        return $this->getTagId($name) !== false;
+    }
+
+    /**
+     * Add a new tag.
+     *
+     * @param string $name A string with a name of the tag
+     * @return false|int the id of the added tag or false on error.
+     */
+    public function add($name) {
+        $name = trim($name);
+
+        if($name === '') {
+            \OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
+            return false;
+        }
+        if($this->userHasTag($name, $this->user)) {
+            \OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', \OCP\Util::DEBUG);
+            return false;
+        }
+        try {
+            $tag = new Tag($this->user, $this->type, $name);
+            $tag = $this->mapper->insert($tag);
+            $this->tags[] = $tag;
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => \OCP\Util::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+        \OCP\Util::writeLog('core', __METHOD__.', id: ' . $tag->getId(), \OCP\Util::DEBUG);
+        return $tag->getId();
+    }
+
+    /**
+     * Rename tag.
+     *
+     * @param string|integer $from The name or ID of the existing tag
+     * @param string $to The new name of the tag.
+     * @return bool
+     */
+    public function rename($from, $to) {
+        $from = trim($from);
+        $to = trim($to);
+
+        if($to === '' || $from === '') {
+            \OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
+            return false;
+        }
+
+        if (is_numeric($from)) {
+            $key = $this->getTagById($from);
+        } else {
+            $key = $this->getTagByName($from);
+        }
+        if($key === false) {
+            \OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', \OCP\Util::DEBUG);
+            return false;
+        }
+        $tag = $this->tags[$key];
+
+        if($this->userHasTag($to, $tag->getOwner())) {
+            \OCP\Util::writeLog('core', __METHOD__.', A tag named ' . $to. ' already exists for user ' . $tag->getOwner() . '.', \OCP\Util::DEBUG);
+            return false;
+        }
+
+        try {
+            $tag->setName($to);
+            $this->tags[$key] = $this->mapper->update($tag);
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => \OCP\Util::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Add a list of new tags.
+     *
+     * @param string[] $names A string with a name or an array of strings containing
+     * the name(s) of the tag(s) to add.
+     * @param bool $sync When true, save the tags
+     * @param int|null $id int Optional object id to add to this|these tag(s)
+     * @return bool Returns false on error.
+     */
+    public function addMultiple($names, $sync=false, $id = null) {
+        if(!is_array($names)) {
+            $names = array($names);
+        }
+        $names = array_map('trim', $names);
+        array_filter($names);
+
+        $newones = array();
+        foreach($names as $name) {
+            if(!$this->hasTag($name) && $name !== '') {
+                $newones[] = new Tag($this->user, $this->type, $name);
+            }
+            if(!is_null($id) ) {
+                // Insert $objectid, $categoryid  pairs if not exist.
+                self::$relations[] = array('objid' => $id, 'tag' => $name);
+            }
+        }
+        $this->tags = array_merge($this->tags, $newones);
+        if($sync === true) {
+            $this->save();
+        }
+
+        return true;
+    }
+
+    /**
+     * Save the list of tags and their object relations
+     */
+    protected function save() {
+        if(is_array($this->tags)) {
+            foreach($this->tags as $tag) {
+                try {
+                    if (!$this->mapper->tagExists($tag)) {
+                        $this->mapper->insert($tag);
+                    }
+                } catch(\Exception $e) {
+                    \OC::$server->getLogger()->logException($e, [
+                        'message' => __METHOD__,
+                        'level' => \OCP\Util::ERROR,
+                        'app' => 'core',
+                    ]);
+                }
+            }
+
+            // reload tags to get the proper ids.
+            $this->tags = $this->mapper->loadTags($this->owners, $this->type);
+            \OCP\Util::writeLog('core', __METHOD__.', tags: ' . print_r($this->tags, true),
+                \OCP\Util::DEBUG);
+            // Loop through temporarily cached objectid/tagname pairs
+            // and save relations.
+            $tags = $this->tags;
+            // For some reason this is needed or array_search(i) will return 0..?
+            ksort($tags);
+            foreach(self::$relations as $relation) {
+                $tagId = $this->getTagId($relation['tag']);
+                \OCP\Util::writeLog('core', __METHOD__ . 'catid, ' . $relation['tag'] . ' ' . $tagId, \OCP\Util::DEBUG);
+                if($tagId) {
+                    try {
+                        \OCP\DB::insertIfNotExist(self::RELATION_TABLE,
+                            array(
+                                'objid' => $relation['objid'],
+                                'categoryid' => $tagId,
+                                'type' => $this->type,
+                                ));
+                    } catch(\Exception $e) {
+                        \OC::$server->getLogger()->logException($e, [
+                            'message' => __METHOD__,
+                            'level' => \OCP\Util::ERROR,
+                            'app' => 'core',
+                        ]);
+                    }
+                }
+            }
+            self::$relations = array(); // reset
+        } else {
+            \OCP\Util::writeLog('core', __METHOD__.', $this->tags is not an array! '
+                . print_r($this->tags, true), \OCP\Util::ERROR);
+        }
+    }
+
+    /**
+     * Delete tags and tag/object relations for a user.
+     *
+     * For hooking up on post_deleteUser
+     *
+     * @param array $arguments
+     */
+    public static function post_deleteUser($arguments) {
+        // Find all objectid/tagId pairs.
+        $result = null;
+        try {
+            $stmt = \OCP\DB::prepare('SELECT `id` FROM `' . self::TAG_TABLE . '` '
+                . 'WHERE `uid` = ?');
+            $result = $stmt->execute(array($arguments['uid']));
+            if (\OCP\DB::isError($result)) {
+                \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+            }
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => \OCP\Util::ERROR,
+                'app' => 'core',
+            ]);
+        }
+
+        if(!is_null($result)) {
+            try {
+                $stmt = \OCP\DB::prepare('DELETE FROM `' . self::RELATION_TABLE . '` '
+                    . 'WHERE `categoryid` = ?');
+                while( $row = $result->fetchRow()) {
+                    try {
+                        $stmt->execute(array($row['id']));
+                    } catch(\Exception $e) {
+                        \OC::$server->getLogger()->logException($e, [
+                            'message' => __METHOD__,
+                            'level' => \OCP\Util::ERROR,
+                            'app' => 'core',
+                        ]);
+                    }
+                }
+            } catch(\Exception $e) {
+                \OC::$server->getLogger()->logException($e, [
+                    'message' => __METHOD__,
+                    'level' => \OCP\Util::ERROR,
+                    'app' => 'core',
+                ]);
+            }
+        }
+        try {
+            $stmt = \OCP\DB::prepare('DELETE FROM `' . self::TAG_TABLE . '` '
+                . 'WHERE `uid` = ?');
+            $result = $stmt->execute(array($arguments['uid']));
+            if (\OCP\DB::isError($result)) {
+                \OCP\Util::writeLog('core', __METHOD__. ', DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+            }
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => \OCP\Util::ERROR,
+                'app' => 'core',
+            ]);
+        }
+    }
+
+    /**
+     * Delete tag/object relations from the db
+     *
+     * @param array $ids The ids of the objects
+     * @return boolean Returns false on error.
+     */
+    public function purgeObjects(array $ids) {
+        if(count($ids) === 0) {
+            // job done ;)
+            return true;
+        }
+        $updates = $ids;
+        try {
+            $query = 'DELETE FROM `' . self::RELATION_TABLE . '` ';
+            $query .= 'WHERE `objid` IN (' . str_repeat('?,', count($ids)-1) . '?) ';
+            $query .= 'AND `type`= ?';
+            $updates[] = $this->type;
+            $stmt = \OCP\DB::prepare($query);
+            $result = $stmt->execute($updates);
+            if (\OCP\DB::isError($result)) {
+                \OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+                return false;
+            }
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => \OCP\Util::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Get favorites for an object type
+     *
+     * @return array|false An array of object ids.
+     */
+    public function getFavorites() {
+        try {
+            return $this->getIdsForTag(self::TAG_FAVORITE);
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => \OCP\Util::ERROR,
+                'app' => 'core',
+            ]);
+            return array();
+        }
+    }
+
+    /**
+     * Add an object to favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     */
+    public function addToFavorites($objid) {
+        if(!$this->userHasTag(self::TAG_FAVORITE, $this->user)) {
+            $this->add(self::TAG_FAVORITE);
+        }
+        return $this->tagAs($objid, self::TAG_FAVORITE);
+    }
+
+    /**
+     * Remove an object from favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     */
+    public function removeFromFavorites($objid) {
+        return $this->unTag($objid, self::TAG_FAVORITE);
+    }
+
+    /**
+     * Creates a tag/object relation.
+     *
+     * @param int $objid The id of the object
+     * @param string $tag The id or name of the tag
+     * @return boolean Returns false on error.
+     */
+    public function tagAs($objid, $tag) {
+        if(is_string($tag) && !is_numeric($tag)) {
+            $tag = trim($tag);
+            if($tag === '') {
+                \OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
+                return false;
+            }
+            if(!$this->hasTag($tag)) {
+                $this->add($tag);
+            }
+            $tagId =  $this->getTagId($tag);
+        } else {
+            $tagId = $tag;
+        }
+        try {
+            \OCP\DB::insertIfNotExist(self::RELATION_TABLE,
+                array(
+                    'objid' => $objid,
+                    'categoryid' => $tagId,
+                    'type' => $this->type,
+                ));
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => \OCP\Util::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Delete single tag/object relation from the db
+     *
+     * @param int $objid The id of the object
+     * @param string $tag The id or name of the tag
+     * @return boolean
+     */
+    public function unTag($objid, $tag) {
+        if(is_string($tag) && !is_numeric($tag)) {
+            $tag = trim($tag);
+            if($tag === '') {
+                \OCP\Util::writeLog('core', __METHOD__.', Tag name is empty', \OCP\Util::DEBUG);
+                return false;
+            }
+            $tagId =  $this->getTagId($tag);
+        } else {
+            $tagId = $tag;
+        }
+
+        try {
+            $sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+                    . 'WHERE `objid` = ? AND `categoryid` = ? AND `type` = ?';
+            $stmt = \OCP\DB::prepare($sql);
+            $stmt->execute(array($objid, $tagId, $this->type));
+        } catch(\Exception $e) {
+            \OC::$server->getLogger()->logException($e, [
+                'message' => __METHOD__,
+                'level' => \OCP\Util::ERROR,
+                'app' => 'core',
+            ]);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Delete tags from the database.
+     *
+     * @param string[]|integer[] $names An array of tags (names or IDs) to delete
+     * @return bool Returns false on error
+     */
+    public function delete($names) {
+        if(!is_array($names)) {
+            $names = array($names);
+        }
+
+        $names = array_map('trim', $names);
+        array_filter($names);
+
+        \OCP\Util::writeLog('core', __METHOD__ . ', before: '
+            . print_r($this->tags, true), \OCP\Util::DEBUG);
+        foreach($names as $name) {
+            $id = null;
+
+            if (is_numeric($name)) {
+                $key = $this->getTagById($name);
+            } else {
+                $key = $this->getTagByName($name);
+            }
+            if ($key !== false) {
+                $tag = $this->tags[$key];
+                $id = $tag->getId();
+                unset($this->tags[$key]);
+                $this->mapper->delete($tag);
+            } else {
+                \OCP\Util::writeLog('core', __METHOD__ . 'Cannot delete tag ' . $name
+                    . ': not found.', \OCP\Util::ERROR);
+            }
+            if(!is_null($id) && $id !== false) {
+                try {
+                    $sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+                            . 'WHERE `categoryid` = ?';
+                    $stmt = \OCP\DB::prepare($sql);
+                    $result = $stmt->execute(array($id));
+                    if (\OCP\DB::isError($result)) {
+                        \OCP\Util::writeLog('core',
+                            __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(),
+                            \OCP\Util::ERROR);
+                        return false;
+                    }
+                } catch(\Exception $e) {
+                    \OC::$server->getLogger()->logException($e, [
+                        'message' => __METHOD__,
+                        'level' => \OCP\Util::ERROR,
+                        'app' => 'core',
+                    ]);
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+
+    // case-insensitive array_search
+    protected function array_searchi($needle, $haystack, $mem='getName') {
+        if(!is_array($haystack)) {
+            return false;
+        }
+        return array_search(strtolower($needle), array_map(
+            function($tag) use($mem) {
+                return strtolower(call_user_func(array($tag, $mem)));
+            }, $haystack)
+        );
+    }
+
+    /**
+     * Get a tag's ID.
+     *
+     * @param string $name The tag name to look for.
+     * @return string|bool The tag's id or false if no matching tag is found.
+     */
+    private function getTagId($name) {
+        $key = $this->array_searchi($name, $this->tags);
+        if ($key !== false) {
+            return $this->tags[$key]->getId();
+        }
+        return false;
+    }
+
+    /**
+     * Get a tag by its name.
+     *
+     * @param string $name The tag name.
+     * @return integer|bool The tag object's offset within the $this->tags
+     *                      array or false if it doesn't exist.
+     */
+    private function getTagByName($name) {
+        return $this->array_searchi($name, $this->tags, 'getName');
+    }
+
+    /**
+     * Get a tag by its ID.
+     *
+     * @param string $id The tag ID to look for.
+     * @return integer|bool The tag object's offset within the $this->tags
+     *                      array or false if it doesn't exist.
+     */
+    private function getTagById($id) {
+        return $this->array_searchi($id, $this->tags, 'getId');
+    }
+
+    /**
+     * Returns an array mapping a given tag's properties to its values:
+     * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
+     *
+     * @param Tag $tag The tag that is going to be mapped
+     * @return array
+     */
+    private function tagMap(Tag $tag) {
+        return array(
+            'id'    => $tag->getId(),
+            'name'  => $tag->getName(),
+            'owner' => $tag->getOwner(),
+            'type'  => $tag->getType()
+        );
+    }
 }

Spacing +82 added lines, -82 removed lines

@@ -134,7 +134,7 @@ 
 		}
 		$this->tags = $this->mapper->loadTags($this->owners, $this->type);
 
-		if(count($defaultTags) > 0 && count($this->tags) === 0) {
+		if (count($defaultTags) > 0 && count($this->tags) === 0) {
 			$this->addMultiple($defaultTags, true);
 		}
 	}
@@ -175,7 +175,7 @@ 
 	* @return array
 	*/
 	public function getTags() {
-		if(!count($this->tags)) {
+		if (!count($this->tags)) {
 			return array();
 		}
 
@@ -184,8 +184,8 @@ 
 		});
 		$tagMap = array();
 
-		foreach($this->tags as $tag) {
-			if($tag->getName() !== self::TAG_FAVORITE) {
+		foreach ($this->tags as $tag) {
+			if ($tag->getName() !== self::TAG_FAVORITE) {
 				$tagMap[] = $this->tagMap($tag);
 			}
 		}
@@ -223,25 +223,25 @@ 
 			$chunks = array_chunk($objIds, 900, false);
 			foreach ($chunks as $chunk) {
 				$result = $conn->executeQuery(
-					'SELECT `category`, `categoryid`, `objid` ' .
-					'FROM `' . self::RELATION_TABLE . '` r, `' . self::TAG_TABLE . '` ' .
+					'SELECT `category`, `categoryid`, `objid` '.
+					'FROM `'.self::RELATION_TABLE.'` r, `'.self::TAG_TABLE.'` '.
 					'WHERE `categoryid` = `id` AND `uid` = ? AND r.`type` = ? AND `objid` IN (?)',
 					array($this->user, $this->type, $chunk),
 					array(null, null, IQueryBuilder::PARAM_INT_ARRAY)
 				);
 				while ($row = $result->fetch()) {
-					$objId = (int)$row['objid'];
+					$objId = (int) $row['objid'];
 					if (!isset($entries[$objId])) {
 						$entries[$objId] = array();
 					}
 					$entries[$objId][] = $row['category'];
 				}
 				if (\OCP\DB::isError($result)) {
-					\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+					\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 					return false;
 				}
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => \OCP\Util::ERROR,
@@ -265,18 +265,18 @@ 
 	public function getIdsForTag($tag) {
 		$result = null;
 		$tagId = false;
-		if(is_numeric($tag)) {
+		if (is_numeric($tag)) {
 			$tagId = $tag;
-		} elseif(is_string($tag)) {
+		} elseif (is_string($tag)) {
 			$tag = trim($tag);
-			if($tag === '') {
+			if ($tag === '') {
 				\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
 				return false;
 			}
 			$tagId = $this->getTagId($tag);
 		}
 
-		if($tagId === false) {
+		if ($tagId === false) {
 			$l10n = \OC::$server->getL10N('core');
 			throw new \Exception(
 				$l10n->t('Could not find category "%s"', [$tag])
@@ -284,17 +284,17 @@ 
 		}
 
 		$ids = array();
-		$sql = 'SELECT `objid` FROM `' . self::RELATION_TABLE
+		$sql = 'SELECT `objid` FROM `'.self::RELATION_TABLE
 			. '` WHERE `categoryid` = ?';
 
 		try {
 			$stmt = \OCP\DB::prepare($sql);
 			$result = $stmt->execute(array($tagId));
 			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 				return false;
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => \OCP\Util::ERROR,
@@ -303,9 +303,9 @@ 
 			return false;
 		}
 
-		if(!is_null($result)) {
-			while( $row = $result->fetchRow()) {
-				$id = (int)$row['objid'];
+		if (!is_null($result)) {
+			while ($row = $result->fetchRow()) {
+				$id = (int) $row['objid'];
 
 				if ($this->includeShared) {
 					// We have to check if we are really allowed to access the
@@ -359,19 +359,19 @@ 
 	public function add($name) {
 		$name = trim($name);
 
-		if($name === '') {
+		if ($name === '') {
 			\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
 			return false;
 		}
-		if($this->userHasTag($name, $this->user)) {
-			\OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', \OCP\Util::DEBUG);
+		if ($this->userHasTag($name, $this->user)) {
+			\OCP\Util::writeLog('core', __METHOD__.', name: '.$name.' exists already', \OCP\Util::DEBUG);
 			return false;
 		}
 		try {
 			$tag = new Tag($this->user, $this->type, $name);
 			$tag = $this->mapper->insert($tag);
 			$this->tags[] = $tag;
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => \OCP\Util::ERROR,
@@ -379,7 +379,7 @@ 
 			]);
 			return false;
 		}
-		\OCP\Util::writeLog('core', __METHOD__.', id: ' . $tag->getId(), \OCP\Util::DEBUG);
+		\OCP\Util::writeLog('core', __METHOD__.', id: '.$tag->getId(), \OCP\Util::DEBUG);
 		return $tag->getId();
 	}
 
@@ -394,7 +394,7 @@ 
 		$from = trim($from);
 		$to = trim($to);
 
-		if($to === '' || $from === '') {
+		if ($to === '' || $from === '') {
 			\OCP\Util::writeLog('core', __METHOD__.', Cannot use empty tag names', \OCP\Util::DEBUG);
 			return false;
 		}
@@ -404,21 +404,21 @@ 
 		} else {
 			$key = $this->getTagByName($from);
 		}
-		if($key === false) {
-			\OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', \OCP\Util::DEBUG);
+		if ($key === false) {
+			\OCP\Util::writeLog('core', __METHOD__.', tag: '.$from.' does not exist', \OCP\Util::DEBUG);
 			return false;
 		}
 		$tag = $this->tags[$key];
 
-		if($this->userHasTag($to, $tag->getOwner())) {
-			\OCP\Util::writeLog('core', __METHOD__.', A tag named ' . $to. ' already exists for user ' . $tag->getOwner() . '.', \OCP\Util::DEBUG);
+		if ($this->userHasTag($to, $tag->getOwner())) {
+			\OCP\Util::writeLog('core', __METHOD__.', A tag named '.$to.' already exists for user '.$tag->getOwner().'.', \OCP\Util::DEBUG);
 			return false;
 		}
 
 		try {
 			$tag->setName($to);
 			$this->tags[$key] = $this->mapper->update($tag);
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => \OCP\Util::ERROR,
@@ -438,25 +438,25 @@ 
 	* @param int|null $id int Optional object id to add to this|these tag(s)
 	* @return bool Returns false on error.
 	*/
-	public function addMultiple($names, $sync=false, $id = null) {
-		if(!is_array($names)) {
+	public function addMultiple($names, $sync = false, $id = null) {
+		if (!is_array($names)) {
 			$names = array($names);
 		}
 		$names = array_map('trim', $names);
 		array_filter($names);
 
 		$newones = array();
-		foreach($names as $name) {
-			if(!$this->hasTag($name) && $name !== '') {
+		foreach ($names as $name) {
+			if (!$this->hasTag($name) && $name !== '') {
 				$newones[] = new Tag($this->user, $this->type, $name);
 			}
-			if(!is_null($id) ) {
+			if (!is_null($id)) {
 				// Insert $objectid, $categoryid  pairs if not exist.
 				self::$relations[] = array('objid' => $id, 'tag' => $name);
 			}
 		}
 		$this->tags = array_merge($this->tags, $newones);
-		if($sync === true) {
+		if ($sync === true) {
 			$this->save();
 		}
 
@@ -467,13 +467,13 @@ 
 	 * Save the list of tags and their object relations
 	 */
 	protected function save() {
-		if(is_array($this->tags)) {
-			foreach($this->tags as $tag) {
+		if (is_array($this->tags)) {
+			foreach ($this->tags as $tag) {
 				try {
 					if (!$this->mapper->tagExists($tag)) {
 						$this->mapper->insert($tag);
 					}
-				} catch(\Exception $e) {
+				} catch (\Exception $e) {
 					\OC::$server->getLogger()->logException($e, [
 						'message' => __METHOD__,
 						'level' => \OCP\Util::ERROR,
@@ -484,17 +484,17 @@ 
 
 			// reload tags to get the proper ids.
 			$this->tags = $this->mapper->loadTags($this->owners, $this->type);
-			\OCP\Util::writeLog('core', __METHOD__.', tags: ' . print_r($this->tags, true),
+			\OCP\Util::writeLog('core', __METHOD__.', tags: '.print_r($this->tags, true),
 				\OCP\Util::DEBUG);
 			// Loop through temporarily cached objectid/tagname pairs
 			// and save relations.
 			$tags = $this->tags;
 			// For some reason this is needed or array_search(i) will return 0..?
 			ksort($tags);
-			foreach(self::$relations as $relation) {
+			foreach (self::$relations as $relation) {
 				$tagId = $this->getTagId($relation['tag']);
-				\OCP\Util::writeLog('core', __METHOD__ . 'catid, ' . $relation['tag'] . ' ' . $tagId, \OCP\Util::DEBUG);
-				if($tagId) {
+				\OCP\Util::writeLog('core', __METHOD__.'catid, '.$relation['tag'].' '.$tagId, \OCP\Util::DEBUG);
+				if ($tagId) {
 					try {
 						\OCP\DB::insertIfNotExist(self::RELATION_TABLE,
 							array(
@@ -502,7 +502,7 @@ 
 								'categoryid' => $tagId,
 								'type' => $this->type,
 								));
-					} catch(\Exception $e) {
+					} catch (\Exception $e) {
 						\OC::$server->getLogger()->logException($e, [
 							'message' => __METHOD__,
 							'level' => \OCP\Util::ERROR,
@@ -529,13 +529,13 @@ 
 		// Find all objectid/tagId pairs.
 		$result = null;
 		try {
-			$stmt = \OCP\DB::prepare('SELECT `id` FROM `' . self::TAG_TABLE . '` '
+			$stmt = \OCP\DB::prepare('SELECT `id` FROM `'.self::TAG_TABLE.'` '
 				. 'WHERE `uid` = ?');
 			$result = $stmt->execute(array($arguments['uid']));
 			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => \OCP\Util::ERROR,
@@ -543,14 +543,14 @@ 
 			]);
 		}
 
-		if(!is_null($result)) {
+		if (!is_null($result)) {
 			try {
-				$stmt = \OCP\DB::prepare('DELETE FROM `' . self::RELATION_TABLE . '` '
+				$stmt = \OCP\DB::prepare('DELETE FROM `'.self::RELATION_TABLE.'` '
 					. 'WHERE `categoryid` = ?');
-				while( $row = $result->fetchRow()) {
+				while ($row = $result->fetchRow()) {
 					try {
 						$stmt->execute(array($row['id']));
-					} catch(\Exception $e) {
+					} catch (\Exception $e) {
 						\OC::$server->getLogger()->logException($e, [
 							'message' => __METHOD__,
 							'level' => \OCP\Util::ERROR,
@@ -558,7 +558,7 @@ 
 						]);
 					}
 				}
-			} catch(\Exception $e) {
+			} catch (\Exception $e) {
 				\OC::$server->getLogger()->logException($e, [
 					'message' => __METHOD__,
 					'level' => \OCP\Util::ERROR,
@@ -567,13 +567,13 @@ 
 			}
 		}
 		try {
-			$stmt = \OCP\DB::prepare('DELETE FROM `' . self::TAG_TABLE . '` '
+			$stmt = \OCP\DB::prepare('DELETE FROM `'.self::TAG_TABLE.'` '
 				. 'WHERE `uid` = ?');
 			$result = $stmt->execute(array($arguments['uid']));
 			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. ', DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.', DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => \OCP\Util::ERROR,
@@ -589,23 +589,23 @@ 
 	* @return boolean Returns false on error.
 	*/
 	public function purgeObjects(array $ids) {
-		if(count($ids) === 0) {
+		if (count($ids) === 0) {
 			// job done ;)
 			return true;
 		}
 		$updates = $ids;
 		try {
-			$query = 'DELETE FROM `' . self::RELATION_TABLE . '` ';
-			$query .= 'WHERE `objid` IN (' . str_repeat('?,', count($ids)-1) . '?) ';
+			$query = 'DELETE FROM `'.self::RELATION_TABLE.'` ';
+			$query .= 'WHERE `objid` IN ('.str_repeat('?,', count($ids) - 1).'?) ';
 			$query .= 'AND `type`= ?';
 			$updates[] = $this->type;
 			$stmt = \OCP\DB::prepare($query);
 			$result = $stmt->execute($updates);
 			if (\OCP\DB::isError($result)) {
-				\OCP\Util::writeLog('core', __METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
+				\OCP\Util::writeLog('core', __METHOD__.'DB error: '.\OCP\DB::getErrorMessage(), \OCP\Util::ERROR);
 				return false;
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => \OCP\Util::ERROR,
@@ -624,7 +624,7 @@ 
 	public function getFavorites() {
 		try {
 			return $this->getIdsForTag(self::TAG_FAVORITE);
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => \OCP\Util::ERROR,
@@ -641,7 +641,7 @@ 
 	* @return boolean
 	*/
 	public function addToFavorites($objid) {
-		if(!$this->userHasTag(self::TAG_FAVORITE, $this->user)) {
+		if (!$this->userHasTag(self::TAG_FAVORITE, $this->user)) {
 			$this->add(self::TAG_FAVORITE);
 		}
 		return $this->tagAs($objid, self::TAG_FAVORITE);
@@ -665,16 +665,16 @@ 
 	* @return boolean Returns false on error.
 	*/
 	public function tagAs($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
+		if (is_string($tag) && !is_numeric($tag)) {
 			$tag = trim($tag);
-			if($tag === '') {
+			if ($tag === '') {
 				\OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG);
 				return false;
 			}
-			if(!$this->hasTag($tag)) {
+			if (!$this->hasTag($tag)) {
 				$this->add($tag);
 			}
-			$tagId =  $this->getTagId($tag);
+			$tagId = $this->getTagId($tag);
 		} else {
 			$tagId = $tag;
 		}
@@ -685,7 +685,7 @@ 
 					'categoryid' => $tagId,
 					'type' => $this->type,
 				));
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => \OCP\Util::ERROR,
@@ -704,23 +704,23 @@ 
 	* @return boolean
 	*/
 	public function unTag($objid, $tag) {
-		if(is_string($tag) && !is_numeric($tag)) {
+		if (is_string($tag) && !is_numeric($tag)) {
 			$tag = trim($tag);
-			if($tag === '') {
+			if ($tag === '') {
 				\OCP\Util::writeLog('core', __METHOD__.', Tag name is empty', \OCP\Util::DEBUG);
 				return false;
 			}
-			$tagId =  $this->getTagId($tag);
+			$tagId = $this->getTagId($tag);
 		} else {
 			$tagId = $tag;
 		}
 
 		try {
-			$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+			$sql = 'DELETE FROM `'.self::RELATION_TABLE.'` '
 					. 'WHERE `objid` = ? AND `categoryid` = ? AND `type` = ?';
 			$stmt = \OCP\DB::prepare($sql);
 			$stmt->execute(array($objid, $tagId, $this->type));
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			\OC::$server->getLogger()->logException($e, [
 				'message' => __METHOD__,
 				'level' => \OCP\Util::ERROR,
@@ -738,16 +738,16 @@ 
 	* @return bool Returns false on error
 	*/
 	public function delete($names) {
-		if(!is_array($names)) {
+		if (!is_array($names)) {
 			$names = array($names);
 		}
 
 		$names = array_map('trim', $names);
 		array_filter($names);
 
-		\OCP\Util::writeLog('core', __METHOD__ . ', before: '
+		\OCP\Util::writeLog('core', __METHOD__.', before: '
 			. print_r($this->tags, true), \OCP\Util::DEBUG);
-		foreach($names as $name) {
+		foreach ($names as $name) {
 			$id = null;
 
 			if (is_numeric($name)) {
@@ -761,22 +761,22 @@ 
 				unset($this->tags[$key]);
 				$this->mapper->delete($tag);
 			} else {
-				\OCP\Util::writeLog('core', __METHOD__ . 'Cannot delete tag ' . $name
+				\OCP\Util::writeLog('core', __METHOD__.'Cannot delete tag '.$name
 					. ': not found.', \OCP\Util::ERROR);
 			}
-			if(!is_null($id) && $id !== false) {
+			if (!is_null($id) && $id !== false) {
 				try {
-					$sql = 'DELETE FROM `' . self::RELATION_TABLE . '` '
+					$sql = 'DELETE FROM `'.self::RELATION_TABLE.'` '
 							. 'WHERE `categoryid` = ?';
 					$stmt = \OCP\DB::prepare($sql);
 					$result = $stmt->execute(array($id));
 					if (\OCP\DB::isError($result)) {
 						\OCP\Util::writeLog('core',
-							__METHOD__. 'DB error: ' . \OCP\DB::getErrorMessage(),
+							__METHOD__.'DB error: '.\OCP\DB::getErrorMessage(),
 							\OCP\Util::ERROR);
 						return false;
 					}
-				} catch(\Exception $e) {
+				} catch (\Exception $e) {
 					\OC::$server->getLogger()->logException($e, [
 						'message' => __METHOD__,
 						'level' => \OCP\Util::ERROR,
@@ -790,8 +790,8 @@ 
 	}
 
 	// case-insensitive array_search
-	protected function array_searchi($needle, $haystack, $mem='getName') {
-		if(!is_array($haystack)) {
+	protected function array_searchi($needle, $haystack, $mem = 'getName') {
+		if (!is_array($haystack)) {
 			return false;
 		}
 		return array_search(strtolower($needle), array_map(