nextcloud / server

apps/user_ldap/lib/Jobs/UpdateGroups.php

Doc Comments +1 added lines, -1 removed lines

@@ -77,7 +77,7 @@
 	}
 
 	/**
-	 * @return int
+	 * @return string
 	 */
 	static private function getRefreshInterval() {
 		//defaults to every hour

Indentation +163 added lines, -163 removed lines

@@ -41,182 +41,182 @@
 use OCA\User_LDAP\User\Manager;
 
 class UpdateGroups extends \OC\BackgroundJob\TimedJob {
-	static private $groupsFromDB;
-
-	static private $groupBE;
-
-	public function __construct(){
-		$this->interval = self::getRefreshInterval();
-	}
-
-	/**
-	 * @param mixed $argument
-	 */
-	public function run($argument){
-		self::updateGroups();
-	}
-
-	static public function updateGroups() {
-		\OCP\Util::writeLog('user_ldap', 'Run background job "updateGroups"', \OCP\Util::DEBUG);
-
-		$knownGroups = array_keys(self::getKnownGroups());
-		$actualGroups = self::getGroupBE()->getGroups();
-
-		if(empty($actualGroups) && empty($knownGroups)) {
-			\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – groups do not seem to be configured properly, aborting.',
-				\OCP\Util::INFO);
-			return;
-		}
-
-		self::handleKnownGroups(array_intersect($actualGroups, $knownGroups));
-		self::handleCreatedGroups(array_diff($actualGroups, $knownGroups));
-		self::handleRemovedGroups(array_diff($knownGroups, $actualGroups));
-
-		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Finished.', \OCP\Util::DEBUG);
-	}
-
-	/**
-	 * @return int
-	 */
-	static private function getRefreshInterval() {
-		//defaults to every hour
-		return \OCP\Config::getAppValue('user_ldap', 'bgjRefreshInterval', 3600);
-	}
-
-	/**
-	 * @param string[] $groups
-	 */
-	static private function handleKnownGroups($groups) {
-		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Dealing with known Groups.', \OCP\Util::DEBUG);
-		$query = \OCP\DB::prepare('
+    static private $groupsFromDB;
+
+    static private $groupBE;
+
+    public function __construct(){
+        $this->interval = self::getRefreshInterval();
+    }
+
+    /**
+     * @param mixed $argument
+     */
+    public function run($argument){
+        self::updateGroups();
+    }
+
+    static public function updateGroups() {
+        \OCP\Util::writeLog('user_ldap', 'Run background job "updateGroups"', \OCP\Util::DEBUG);
+
+        $knownGroups = array_keys(self::getKnownGroups());
+        $actualGroups = self::getGroupBE()->getGroups();
+
+        if(empty($actualGroups) && empty($knownGroups)) {
+            \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – groups do not seem to be configured properly, aborting.',
+                \OCP\Util::INFO);
+            return;
+        }
+
+        self::handleKnownGroups(array_intersect($actualGroups, $knownGroups));
+        self::handleCreatedGroups(array_diff($actualGroups, $knownGroups));
+        self::handleRemovedGroups(array_diff($knownGroups, $actualGroups));
+
+        \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Finished.', \OCP\Util::DEBUG);
+    }
+
+    /**
+     * @return int
+     */
+    static private function getRefreshInterval() {
+        //defaults to every hour
+        return \OCP\Config::getAppValue('user_ldap', 'bgjRefreshInterval', 3600);
+    }
+
+    /**
+     * @param string[] $groups
+     */
+    static private function handleKnownGroups($groups) {
+        \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Dealing with known Groups.', \OCP\Util::DEBUG);
+        $query = \OCP\DB::prepare('
 			UPDATE `*PREFIX*ldap_group_members`
 			SET `owncloudusers` = ?
 			WHERE `owncloudname` = ?
 		');
-		foreach($groups as $group) {
-			//we assume, that self::$groupsFromDB has been retrieved already
-			$knownUsers = unserialize(self::$groupsFromDB[$group]['owncloudusers']);
-			$actualUsers = self::getGroupBE()->usersInGroup($group);
-			$hasChanged = false;
-			foreach(array_diff($knownUsers, $actualUsers) as $removedUser) {
-				\OCP\Util::emitHook('OC_User', 'post_removeFromGroup', array('uid' => $removedUser, 'gid' => $group));
-				\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – "'.$removedUser.'" removed from "'.$group.'".',
-				\OCP\Util::INFO);
-				$hasChanged = true;
-			}
-			foreach(array_diff($actualUsers, $knownUsers) as $addedUser) {
-				\OCP\Util::emitHook('OC_User', 'post_addToGroup', array('uid' => $addedUser, 'gid' => $group));
-				\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – "'.$addedUser.'" added to "'.$group.'".',
-				\OCP\Util::INFO);
-				$hasChanged = true;
-			}
-			if($hasChanged) {
-				$query->execute(array(serialize($actualUsers), $group));
-			}
-		}
-		\OCP\Util::writeLog('user_ldap',
-			'bgJ "updateGroups" – FINISHED dealing with known Groups.',
-			\OCP\Util::DEBUG);
-	}
-
-	/**
-	 * @param string[] $createdGroups
-	 */
-	static private function handleCreatedGroups($createdGroups) {
-		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with created Groups.', \OCP\Util::DEBUG);
-		$query = \OCP\DB::prepare('
+        foreach($groups as $group) {
+            //we assume, that self::$groupsFromDB has been retrieved already
+            $knownUsers = unserialize(self::$groupsFromDB[$group]['owncloudusers']);
+            $actualUsers = self::getGroupBE()->usersInGroup($group);
+            $hasChanged = false;
+            foreach(array_diff($knownUsers, $actualUsers) as $removedUser) {
+                \OCP\Util::emitHook('OC_User', 'post_removeFromGroup', array('uid' => $removedUser, 'gid' => $group));
+                \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – "'.$removedUser.'" removed from "'.$group.'".',
+                \OCP\Util::INFO);
+                $hasChanged = true;
+            }
+            foreach(array_diff($actualUsers, $knownUsers) as $addedUser) {
+                \OCP\Util::emitHook('OC_User', 'post_addToGroup', array('uid' => $addedUser, 'gid' => $group));
+                \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – "'.$addedUser.'" added to "'.$group.'".',
+                \OCP\Util::INFO);
+                $hasChanged = true;
+            }
+            if($hasChanged) {
+                $query->execute(array(serialize($actualUsers), $group));
+            }
+        }
+        \OCP\Util::writeLog('user_ldap',
+            'bgJ "updateGroups" – FINISHED dealing with known Groups.',
+            \OCP\Util::DEBUG);
+    }
+
+    /**
+     * @param string[] $createdGroups
+     */
+    static private function handleCreatedGroups($createdGroups) {
+        \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with created Groups.', \OCP\Util::DEBUG);
+        $query = \OCP\DB::prepare('
 			INSERT
 			INTO `*PREFIX*ldap_group_members` (`owncloudname`, `owncloudusers`)
 			VALUES (?, ?)
 		');
-		foreach($createdGroups as $createdGroup) {
-			\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – new group "'.$createdGroup.'" found.',
-				\OCP\Util::INFO);
-			$users = serialize(self::getGroupBE()->usersInGroup($createdGroup));
-			$query->execute(array($createdGroup, $users));
-		}
-		\OCP\Util::writeLog('user_ldap',
-			'bgJ "updateGroups" – FINISHED dealing with created Groups.',
-			\OCP\Util::DEBUG);
-	}
-
-	/**
-	 * @param string[] $removedGroups
-	 */
-	static private function handleRemovedGroups($removedGroups) {
-		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with removed groups.', \OCP\Util::DEBUG);
-		$query = \OCP\DB::prepare('
+        foreach($createdGroups as $createdGroup) {
+            \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – new group "'.$createdGroup.'" found.',
+                \OCP\Util::INFO);
+            $users = serialize(self::getGroupBE()->usersInGroup($createdGroup));
+            $query->execute(array($createdGroup, $users));
+        }
+        \OCP\Util::writeLog('user_ldap',
+            'bgJ "updateGroups" – FINISHED dealing with created Groups.',
+            \OCP\Util::DEBUG);
+    }
+
+    /**
+     * @param string[] $removedGroups
+     */
+    static private function handleRemovedGroups($removedGroups) {
+        \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with removed groups.', \OCP\Util::DEBUG);
+        $query = \OCP\DB::prepare('
 			DELETE
 			FROM `*PREFIX*ldap_group_members`
 			WHERE `owncloudname` = ?
 		');
-		foreach($removedGroups as $removedGroup) {
-			\OCP\Util::writeLog('user_ldap',
-				'bgJ "updateGroups" – group "'.$removedGroup.'" was removed.',
-				\OCP\Util::INFO);
-			$query->execute(array($removedGroup));
-		}
-		\OCP\Util::writeLog('user_ldap',
-			'bgJ "updateGroups" – FINISHED dealing with removed groups.',
-			\OCP\Util::DEBUG);
-	}
-
-	/**
-	 * @return \OCA\User_LDAP\Group_LDAP|\OCA\User_LDAP\Group_Proxy
-	 */
-	static private function getGroupBE() {
-		if(!is_null(self::$groupBE)) {
-			return self::$groupBE;
-		}
-		$helper = new Helper(\OC::$server->getConfig());
-		$configPrefixes = $helper->getServerConfigurationPrefixes(true);
-		$ldapWrapper = new LDAP();
-		if(count($configPrefixes) === 1) {
-			//avoid the proxy when there is only one LDAP server configured
-			$dbc = \OC::$server->getDatabaseConnection();
-			$userManager = new Manager(
-				\OC::$server->getConfig(),
-				new FilesystemHelper(),
-				new LogWrapper(),
-				\OC::$server->getAvatarManager(),
-				new \OCP\Image(),
-				$dbc,
-				\OC::$server->getUserManager());
-			$connector = new Connection($ldapWrapper, $configPrefixes[0]);
-			$ldapAccess = new Access($connector, $ldapWrapper, $userManager, $helper);
-			$groupMapper = new GroupMapping($dbc);
-			$userMapper  = new UserMapping($dbc);
-			$ldapAccess->setGroupMapper($groupMapper);
-			$ldapAccess->setUserMapper($userMapper);
-			self::$groupBE = new \OCA\User_LDAP\Group_LDAP($ldapAccess);
-		} else {
-			self::$groupBE = new \OCA\User_LDAP\Group_Proxy($configPrefixes, $ldapWrapper);
-		}
-
-		return self::$groupBE;
-	}
-
-	/**
-	 * @return array
-	 */
-	static private function getKnownGroups() {
-		if(is_array(self::$groupsFromDB)) {
-			return self::$groupsFromDB;
-		}
-		$query = \OCP\DB::prepare('
+        foreach($removedGroups as $removedGroup) {
+            \OCP\Util::writeLog('user_ldap',
+                'bgJ "updateGroups" – group "'.$removedGroup.'" was removed.',
+                \OCP\Util::INFO);
+            $query->execute(array($removedGroup));
+        }
+        \OCP\Util::writeLog('user_ldap',
+            'bgJ "updateGroups" – FINISHED dealing with removed groups.',
+            \OCP\Util::DEBUG);
+    }
+
+    /**
+     * @return \OCA\User_LDAP\Group_LDAP|\OCA\User_LDAP\Group_Proxy
+     */
+    static private function getGroupBE() {
+        if(!is_null(self::$groupBE)) {
+            return self::$groupBE;
+        }
+        $helper = new Helper(\OC::$server->getConfig());
+        $configPrefixes = $helper->getServerConfigurationPrefixes(true);
+        $ldapWrapper = new LDAP();
+        if(count($configPrefixes) === 1) {
+            //avoid the proxy when there is only one LDAP server configured
+            $dbc = \OC::$server->getDatabaseConnection();
+            $userManager = new Manager(
+                \OC::$server->getConfig(),
+                new FilesystemHelper(),
+                new LogWrapper(),
+                \OC::$server->getAvatarManager(),
+                new \OCP\Image(),
+                $dbc,
+                \OC::$server->getUserManager());
+            $connector = new Connection($ldapWrapper, $configPrefixes[0]);
+            $ldapAccess = new Access($connector, $ldapWrapper, $userManager, $helper);
+            $groupMapper = new GroupMapping($dbc);
+            $userMapper  = new UserMapping($dbc);
+            $ldapAccess->setGroupMapper($groupMapper);
+            $ldapAccess->setUserMapper($userMapper);
+            self::$groupBE = new \OCA\User_LDAP\Group_LDAP($ldapAccess);
+        } else {
+            self::$groupBE = new \OCA\User_LDAP\Group_Proxy($configPrefixes, $ldapWrapper);
+        }
+
+        return self::$groupBE;
+    }
+
+    /**
+     * @return array
+     */
+    static private function getKnownGroups() {
+        if(is_array(self::$groupsFromDB)) {
+            return self::$groupsFromDB;
+        }
+        $query = \OCP\DB::prepare('
 			SELECT `owncloudname`, `owncloudusers`
 			FROM `*PREFIX*ldap_group_members`
 		');
-		$result = $query->execute()->fetchAll();
-		self::$groupsFromDB = array();
-		foreach($result as $dataset) {
-			self::$groupsFromDB[$dataset['owncloudname']] = $dataset;
-		}
-
-		return self::$groupsFromDB;
-	}
+        $result = $query->execute()->fetchAll();
+        self::$groupsFromDB = array();
+        foreach($result as $dataset) {
+            self::$groupsFromDB[$dataset['owncloudname']] = $dataset;
+        }
+
+        return self::$groupsFromDB;
+    }
 }

Spacing +13 added lines, -13 removed lines

@@ -45,14 +45,14 @@ 
 
 	static private $groupBE;
 
-	public function __construct(){
+	public function __construct() {
 		$this->interval = self::getRefreshInterval();
 	}
 
 	/**
 	 * @param mixed $argument
 	 */
-	public function run($argument){
+	public function run($argument) {
 		self::updateGroups();
 	}
 
@@ -62,7 +62,7 @@ 
 		$knownGroups = array_keys(self::getKnownGroups());
 		$actualGroups = self::getGroupBE()->getGroups();
 
-		if(empty($actualGroups) && empty($knownGroups)) {
+		if (empty($actualGroups) && empty($knownGroups)) {
 			\OCP\Util::writeLog('user_ldap',
 				'bgJ "updateGroups" – groups do not seem to be configured properly, aborting.',
 				\OCP\Util::INFO);
@@ -94,26 +94,26 @@ 
 			SET `owncloudusers` = ?
 			WHERE `owncloudname` = ?
 		');
-		foreach($groups as $group) {
+		foreach ($groups as $group) {
 			//we assume, that self::$groupsFromDB has been retrieved already
 			$knownUsers = unserialize(self::$groupsFromDB[$group]['owncloudusers']);
 			$actualUsers = self::getGroupBE()->usersInGroup($group);
 			$hasChanged = false;
-			foreach(array_diff($knownUsers, $actualUsers) as $removedUser) {
+			foreach (array_diff($knownUsers, $actualUsers) as $removedUser) {
 				\OCP\Util::emitHook('OC_User', 'post_removeFromGroup', array('uid' => $removedUser, 'gid' => $group));
 				\OCP\Util::writeLog('user_ldap',
 				'bgJ "updateGroups" – "'.$removedUser.'" removed from "'.$group.'".',
 				\OCP\Util::INFO);
 				$hasChanged = true;
 			}
-			foreach(array_diff($actualUsers, $knownUsers) as $addedUser) {
+			foreach (array_diff($actualUsers, $knownUsers) as $addedUser) {
 				\OCP\Util::emitHook('OC_User', 'post_addToGroup', array('uid' => $addedUser, 'gid' => $group));
 				\OCP\Util::writeLog('user_ldap',
 				'bgJ "updateGroups" – "'.$addedUser.'" added to "'.$group.'".',
 				\OCP\Util::INFO);
 				$hasChanged = true;
 			}
-			if($hasChanged) {
+			if ($hasChanged) {
 				$query->execute(array(serialize($actualUsers), $group));
 			}
 		}
@@ -132,7 +132,7 @@ 
 			INTO `*PREFIX*ldap_group_members` (`owncloudname`, `owncloudusers`)
 			VALUES (?, ?)
 		');
-		foreach($createdGroups as $createdGroup) {
+		foreach ($createdGroups as $createdGroup) {
 			\OCP\Util::writeLog('user_ldap',
 				'bgJ "updateGroups" – new group "'.$createdGroup.'" found.',
 				\OCP\Util::INFO);
@@ -154,7 +154,7 @@ 
 			FROM `*PREFIX*ldap_group_members`
 			WHERE `owncloudname` = ?
 		');
-		foreach($removedGroups as $removedGroup) {
+		foreach ($removedGroups as $removedGroup) {
 			\OCP\Util::writeLog('user_ldap',
 				'bgJ "updateGroups" – group "'.$removedGroup.'" was removed.',
 				\OCP\Util::INFO);
@@ -169,13 +169,13 @@ 
 	 * @return \OCA\User_LDAP\Group_LDAP|\OCA\User_LDAP\Group_Proxy
 	 */
 	static private function getGroupBE() {
-		if(!is_null(self::$groupBE)) {
+		if (!is_null(self::$groupBE)) {
 			return self::$groupBE;
 		}
 		$helper = new Helper(\OC::$server->getConfig());
 		$configPrefixes = $helper->getServerConfigurationPrefixes(true);
 		$ldapWrapper = new LDAP();
-		if(count($configPrefixes) === 1) {
+		if (count($configPrefixes) === 1) {
 			//avoid the proxy when there is only one LDAP server configured
 			$dbc = \OC::$server->getDatabaseConnection();
 			$userManager = new Manager(
@@ -204,7 +204,7 @@ 
 	 * @return array
 	 */
 	static private function getKnownGroups() {
-		if(is_array(self::$groupsFromDB)) {
+		if (is_array(self::$groupsFromDB)) {
 			return self::$groupsFromDB;
 		}
 		$query = \OCP\DB::prepare('
@@ -213,7 +213,7 @@ 
 		');
 		$result = $query->execute()->fetchAll();
 		self::$groupsFromDB = array();
-		foreach($result as $dataset) {
+		foreach ($result as $dataset) {
 			self::$groupsFromDB[$dataset['owncloudname']] = $dataset;
 		}
 

core/Command/Maintenance/Repair.php

Unused Use Statements -1 removed lines

@@ -32,7 +32,6 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\EventDispatcher\GenericEvent;
 

Indentation +98 added lines, -98 removed lines

@@ -38,111 +38,111 @@
 use Symfony\Component\EventDispatcher\GenericEvent;
 
 class Repair extends Command {
-	/** @var \OC\Repair $repair */
-	protected $repair;
-	/** @var IConfig */
-	protected $config;
-	/** @var EventDispatcherInterface */
-	private $dispatcher;
-	/** @var ProgressBar */
-	private $progress;
-	/** @var OutputInterface */
-	private $output;
+    /** @var \OC\Repair $repair */
+    protected $repair;
+    /** @var IConfig */
+    protected $config;
+    /** @var EventDispatcherInterface */
+    private $dispatcher;
+    /** @var ProgressBar */
+    private $progress;
+    /** @var OutputInterface */
+    private $output;
 
-	/**
-	 * @param \OC\Repair $repair
-	 * @param IConfig $config
-	 */
-	public function __construct(\OC\Repair $repair, IConfig $config, EventDispatcherInterface $dispatcher) {
-		$this->repair = $repair;
-		$this->config = $config;
-		$this->dispatcher = $dispatcher;
-		parent::__construct();
-	}
+    /**
+     * @param \OC\Repair $repair
+     * @param IConfig $config
+     */
+    public function __construct(\OC\Repair $repair, IConfig $config, EventDispatcherInterface $dispatcher) {
+        $this->repair = $repair;
+        $this->config = $config;
+        $this->dispatcher = $dispatcher;
+        parent::__construct();
+    }
 
-	protected function configure() {
-		$this
-			->setName('maintenance:repair')
-			->setDescription('repair this installation')
-			->addOption(
-				'include-expensive',
-				null,
-				InputOption::VALUE_NONE,
-				'Use this option when you want to include resource and load expensive tasks');
-	}
+    protected function configure() {
+        $this
+            ->setName('maintenance:repair')
+            ->setDescription('repair this installation')
+            ->addOption(
+                'include-expensive',
+                null,
+                InputOption::VALUE_NONE,
+                'Use this option when you want to include resource and load expensive tasks');
+    }
 
-	protected function execute(InputInterface $input, OutputInterface $output) {
-		$includeExpensive = $input->getOption('include-expensive');
-		if ($includeExpensive) {
-			foreach ($this->repair->getExpensiveRepairSteps() as $step) {
-				$this->repair->addStep($step);
-			}
-		}
+    protected function execute(InputInterface $input, OutputInterface $output) {
+        $includeExpensive = $input->getOption('include-expensive');
+        if ($includeExpensive) {
+            foreach ($this->repair->getExpensiveRepairSteps() as $step) {
+                $this->repair->addStep($step);
+            }
+        }
 
-		$apps = \OC::$server->getAppManager()->getInstalledApps();
-		foreach ($apps as $app) {
-			if (!\OC_App::isEnabled($app)) {
-				continue;
-			}
-			$info = \OC_App::getAppInfo($app);
-			if (!is_array($info)) {
-				continue;
-			}
-			$steps = $info['repair-steps']['post-migration'];
-			foreach ($steps as $step) {
-				try {
-					$this->repair->addStep($step);
-				} catch (Exception $ex) {
-					$output->writeln("<error>Failed to load repair step for $app: {$ex->getMessage()}</error>");
-				}
-			}
-		}
+        $apps = \OC::$server->getAppManager()->getInstalledApps();
+        foreach ($apps as $app) {
+            if (!\OC_App::isEnabled($app)) {
+                continue;
+            }
+            $info = \OC_App::getAppInfo($app);
+            if (!is_array($info)) {
+                continue;
+            }
+            $steps = $info['repair-steps']['post-migration'];
+            foreach ($steps as $step) {
+                try {
+                    $this->repair->addStep($step);
+                } catch (Exception $ex) {
+                    $output->writeln("<error>Failed to load repair step for $app: {$ex->getMessage()}</error>");
+                }
+            }
+        }
 
-		$maintenanceMode = $this->config->getSystemValue('maintenance', false);
-		$this->config->setSystemValue('maintenance', true);
+        $maintenanceMode = $this->config->getSystemValue('maintenance', false);
+        $this->config->setSystemValue('maintenance', true);
 
-		$this->progress = new ProgressBar($output);
-		$this->output = $output;
-		$this->dispatcher->addListener('\OC\Repair::startProgress', [$this, 'handleRepairFeedBack']);
-		$this->dispatcher->addListener('\OC\Repair::advance', [$this, 'handleRepairFeedBack']);
-		$this->dispatcher->addListener('\OC\Repair::finishProgress', [$this, 'handleRepairFeedBack']);
-		$this->dispatcher->addListener('\OC\Repair::step', [$this, 'handleRepairFeedBack']);
-		$this->dispatcher->addListener('\OC\Repair::info', [$this, 'handleRepairFeedBack']);
-		$this->dispatcher->addListener('\OC\Repair::warning', [$this, 'handleRepairFeedBack']);
-		$this->dispatcher->addListener('\OC\Repair::error', [$this, 'handleRepairFeedBack']);
+        $this->progress = new ProgressBar($output);
+        $this->output = $output;
+        $this->dispatcher->addListener('\OC\Repair::startProgress', [$this, 'handleRepairFeedBack']);
+        $this->dispatcher->addListener('\OC\Repair::advance', [$this, 'handleRepairFeedBack']);
+        $this->dispatcher->addListener('\OC\Repair::finishProgress', [$this, 'handleRepairFeedBack']);
+        $this->dispatcher->addListener('\OC\Repair::step', [$this, 'handleRepairFeedBack']);
+        $this->dispatcher->addListener('\OC\Repair::info', [$this, 'handleRepairFeedBack']);
+        $this->dispatcher->addListener('\OC\Repair::warning', [$this, 'handleRepairFeedBack']);
+        $this->dispatcher->addListener('\OC\Repair::error', [$this, 'handleRepairFeedBack']);
 
-		$this->repair->run();
+        $this->repair->run();
 
-		$this->config->setSystemValue('maintenance', $maintenanceMode);
-	}
+        $this->config->setSystemValue('maintenance', $maintenanceMode);
+    }
 
-	public function handleRepairFeedBack($event) {
-		if (!$event instanceof GenericEvent) {
-			return;
-		}
-		switch ($event->getSubject()) {
-			case '\OC\Repair::startProgress':
-				$this->progress->start($event->getArgument(0));
-				break;
-			case '\OC\Repair::advance':
-				$this->progress->advance($event->getArgument(0));
-				break;
-			case '\OC\Repair::finishProgress':
-				$this->progress->finish();
-				$this->output->writeln('');
-				break;
-			case '\OC\Repair::step':
-				$this->output->writeln(' - ' . $event->getArgument(0));
-				break;
-			case '\OC\Repair::info':
-				$this->output->writeln('     - ' . $event->getArgument(0));
-				break;
-			case '\OC\Repair::warning':
-				$this->output->writeln('     - WARNING: ' . $event->getArgument(0));
-				break;
-			case '\OC\Repair::error':
-				$this->output->writeln('     - ERROR: ' . $event->getArgument(0));
-				break;
-		}
-	}
+    public function handleRepairFeedBack($event) {
+        if (!$event instanceof GenericEvent) {
+            return;
+        }
+        switch ($event->getSubject()) {
+            case '\OC\Repair::startProgress':
+                $this->progress->start($event->getArgument(0));
+                break;
+            case '\OC\Repair::advance':
+                $this->progress->advance($event->getArgument(0));
+                break;
+            case '\OC\Repair::finishProgress':
+                $this->progress->finish();
+                $this->output->writeln('');
+                break;
+            case '\OC\Repair::step':
+                $this->output->writeln(' - ' . $event->getArgument(0));
+                break;
+            case '\OC\Repair::info':
+                $this->output->writeln('     - ' . $event->getArgument(0));
+                break;
+            case '\OC\Repair::warning':
+                $this->output->writeln('     - WARNING: ' . $event->getArgument(0));
+                break;
+            case '\OC\Repair::error':
+                $this->output->writeln('     - ERROR: ' . $event->getArgument(0));
+                break;
+        }
+    }
 }

Spacing +4 added lines, -4 removed lines

@@ -132,16 +132,16 @@
 				$this->output->writeln('');
 				break;
 			case '\OC\Repair::step':
-				$this->output->writeln(' - ' . $event->getArgument(0));
+				$this->output->writeln(' - '.$event->getArgument(0));
 				break;
 			case '\OC\Repair::info':
-				$this->output->writeln('     - ' . $event->getArgument(0));
+				$this->output->writeln('     - '.$event->getArgument(0));
 				break;
 			case '\OC\Repair::warning':
-				$this->output->writeln('     - WARNING: ' . $event->getArgument(0));
+				$this->output->writeln('     - WARNING: '.$event->getArgument(0));
 				break;
 			case '\OC\Repair::error':
-				$this->output->writeln('     - ERROR: ' . $event->getArgument(0));
+				$this->output->writeln('     - ERROR: '.$event->getArgument(0));
 				break;
 		}
 	}

lib/private/App/AppManager.php

Doc Comments +5 added lines, -2 removed lines

@@ -117,7 +117,7 @@ 
 	/**
 	 * List all installed apps
 	 *
-	 * @return string[]
+	 * @return integer[]
 	 */
 	public function getInstalledApps() {
 		return array_keys($this->getInstalledAppsValues());
@@ -274,7 +274,7 @@ 
 	/**
 	 * Returns a list of apps that need upgrade
 	 *
-	 * @param array $version ownCloud version as array of version components
+	 * @param array $ocVersion ownCloud version as array of version components
 	 * @return array list of app info from apps that need an upgrade
 	 *
 	 * @internal
@@ -344,6 +344,9 @@ 
 		return in_array($appId, $this->shippedApps);
 	}
 
+	/**
+	 * @param string $appId
+	 */
 	private function isAlwaysEnabled($appId) {
 		$alwaysEnabled = $this->getAlwaysEnabledApps();
 		return in_array($appId, $alwaysEnabled);

Indentation +358 added lines, -358 removed lines

@@ -43,362 +43,362 @@
 
 class AppManager implements IAppManager {
 
-	/**
-	 * Apps with these types can not be enabled for certain groups only
-	 * @var string[]
-	 */
-	protected $protectedAppTypes = [
-		'filesystem',
-		'prelogin',
-		'authentication',
-		'logging',
-		'prevent_group_restriction',
-	];
-
-	/** @var \OCP\IUserSession */
-	private $userSession;
-
-	/** @var \OCP\IAppConfig */
-	private $appConfig;
-
-	/** @var \OCP\IGroupManager */
-	private $groupManager;
-
-	/** @var \OCP\ICacheFactory */
-	private $memCacheFactory;
-
-	/** @var string[] $appId => $enabled */
-	private $installedAppsCache;
-
-	/** @var string[] */
-	private $shippedApps;
-
-	/** @var string[] */
-	private $alwaysEnabled;
-
-	/** @var EventDispatcherInterface */
-	private $dispatcher;
-
-	/**
-	 * @param \OCP\IUserSession $userSession
-	 * @param \OCP\IAppConfig $appConfig
-	 * @param \OCP\IGroupManager $groupManager
-	 * @param \OCP\ICacheFactory $memCacheFactory
-	 */
-	public function __construct(IUserSession $userSession,
-								IAppConfig $appConfig,
-								IGroupManager $groupManager,
-								ICacheFactory $memCacheFactory,
-								EventDispatcherInterface $dispatcher) {
-		$this->userSession = $userSession;
-		$this->appConfig = $appConfig;
-		$this->groupManager = $groupManager;
-		$this->memCacheFactory = $memCacheFactory;
-		$this->dispatcher = $dispatcher;
-	}
-
-	/**
-	 * @return string[] $appId => $enabled
-	 */
-	private function getInstalledAppsValues() {
-		if (!$this->installedAppsCache) {
-			$values = $this->appConfig->getValues(false, 'enabled');
-
-			$alwaysEnabledApps = $this->getAlwaysEnabledApps();
-			foreach($alwaysEnabledApps as $appId) {
-				$values[$appId] = 'yes';
-			}
-
-			$this->installedAppsCache = array_filter($values, function ($value) {
-				return $value !== 'no';
-			});
-			ksort($this->installedAppsCache);
-		}
-		return $this->installedAppsCache;
-	}
-
-	/**
-	 * List all installed apps
-	 *
-	 * @return string[]
-	 */
-	public function getInstalledApps() {
-		return array_keys($this->getInstalledAppsValues());
-	}
-
-	/**
-	 * List all apps enabled for a user
-	 *
-	 * @param \OCP\IUser $user
-	 * @return string[]
-	 */
-	public function getEnabledAppsForUser(IUser $user) {
-		$apps = $this->getInstalledAppsValues();
-		$appsForUser = array_filter($apps, function ($enabled) use ($user) {
-			return $this->checkAppForUser($enabled, $user);
-		});
-		return array_keys($appsForUser);
-	}
-
-	/**
-	 * Check if an app is enabled for user
-	 *
-	 * @param string $appId
-	 * @param \OCP\IUser $user (optional) if not defined, the currently logged in user will be used
-	 * @return bool
-	 */
-	public function isEnabledForUser($appId, $user = null) {
-		if ($this->isAlwaysEnabled($appId)) {
-			return true;
-		}
-		if (is_null($user)) {
-			$user = $this->userSession->getUser();
-		}
-		$installedApps = $this->getInstalledAppsValues();
-		if (isset($installedApps[$appId])) {
-			return $this->checkAppForUser($installedApps[$appId], $user);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * @param string $enabled
-	 * @param IUser $user
-	 * @return bool
-	 */
-	private function checkAppForUser($enabled, $user) {
-		if ($enabled === 'yes') {
-			return true;
-		} elseif (is_null($user)) {
-			return false;
-		} else {
-			if(empty($enabled)){
-				return false;
-			}
-
-			$groupIds = json_decode($enabled);
-
-			if (!is_array($groupIds)) {
-				$jsonError = json_last_error();
-				\OC::$server->getLogger()->warning('AppManger::checkAppForUser - can\'t decode group IDs: ' . print_r($enabled, true) . ' - json error code: ' . $jsonError, ['app' => 'lib']);
-				return false;
-			}
-
-			$userGroups = $this->groupManager->getUserGroupIds($user);
-			foreach ($userGroups as $groupId) {
-				if (array_search($groupId, $groupIds) !== false) {
-					return true;
-				}
-			}
-			return false;
-		}
-	}
-
-	/**
-	 * Check if an app is installed in the instance
-	 *
-	 * @param string $appId
-	 * @return bool
-	 */
-	public function isInstalled($appId) {
-		$installedApps = $this->getInstalledAppsValues();
-		return isset($installedApps[$appId]);
-	}
-
-	/**
-	 * Enable an app for every user
-	 *
-	 * @param string $appId
-	 */
-	public function enableApp($appId) {
-		$this->installedAppsCache[$appId] = 'yes';
-		$this->appConfig->setValue($appId, 'enabled', 'yes');
-		$this->dispatcher->dispatch(ManagerEvent::EVENT_APP_ENABLE, new ManagerEvent(
-			ManagerEvent::EVENT_APP_ENABLE, $appId
-		));
-		$this->clearAppsCache();
-	}
-
-	/**
-	 * Whether a list of types contains a protected app type
-	 *
-	 * @param string[] $types
-	 * @return bool
-	 */
-	public function hasProtectedAppType($types) {
-		if (empty($types)) {
-			return false;
-		}
-
-		$protectedTypes = array_intersect($this->protectedAppTypes, $types);
-		return !empty($protectedTypes);
-	}
-
-	/**
-	 * Enable an app only for specific groups
-	 *
-	 * @param string $appId
-	 * @param \OCP\IGroup[] $groups
-	 * @throws \Exception if app can't be enabled for groups
-	 */
-	public function enableAppForGroups($appId, $groups) {
-		$info = $this->getAppInfo($appId);
-		if (!empty($info['types'])) {
-			$protectedTypes = array_intersect($this->protectedAppTypes, $info['types']);
-			if (!empty($protectedTypes)) {
-				throw new \Exception("$appId can't be enabled for groups.");
-			}
-		}
-
-		$groupIds = array_map(function ($group) {
-			/** @var \OCP\IGroup $group */
-			return $group->getGID();
-		}, $groups);
-		$this->installedAppsCache[$appId] = json_encode($groupIds);
-		$this->appConfig->setValue($appId, 'enabled', json_encode($groupIds));
-		$this->dispatcher->dispatch(ManagerEvent::EVENT_APP_ENABLE_FOR_GROUPS, new ManagerEvent(
-			ManagerEvent::EVENT_APP_ENABLE_FOR_GROUPS, $appId, $groups
-		));
-		$this->clearAppsCache();
-	}
-
-	/**
-	 * Disable an app for every user
-	 *
-	 * @param string $appId
-	 * @throws \Exception if app can't be disabled
-	 */
-	public function disableApp($appId) {
-		if ($this->isAlwaysEnabled($appId)) {
-			throw new \Exception("$appId can't be disabled.");
-		}
-		unset($this->installedAppsCache[$appId]);
-		$this->appConfig->setValue($appId, 'enabled', 'no');
-		$this->dispatcher->dispatch(ManagerEvent::EVENT_APP_DISABLE, new ManagerEvent(
-			ManagerEvent::EVENT_APP_DISABLE, $appId
-		));
-		$this->clearAppsCache();
-	}
-
-	/**
-	 * Get the directory for the given app.
-	 *
-	 * @param string $appId
-	 * @return string
-	 * @throws AppPathNotFoundException if app folder can't be found
-	 */
-	public function getAppPath($appId) {
-		$appPath = \OC_App::getAppPath($appId);
-		if($appPath === false) {
-			throw new AppPathNotFoundException('Could not find path for ' . $appId);
-		}
-		return $appPath;
-	}
-
-	/**
-	 * Clear the cached list of apps when enabling/disabling an app
-	 */
-	public function clearAppsCache() {
-		$settingsMemCache = $this->memCacheFactory->create('settings');
-		$settingsMemCache->clear('listApps');
-	}
-
-	/**
-	 * Returns a list of apps that need upgrade
-	 *
-	 * @param array $version ownCloud version as array of version components
-	 * @return array list of app info from apps that need an upgrade
-	 *
-	 * @internal
-	 */
-	public function getAppsNeedingUpgrade($ocVersion) {
-		$appsToUpgrade = [];
-		$apps = $this->getInstalledApps();
-		foreach ($apps as $appId) {
-			$appInfo = $this->getAppInfo($appId);
-			$appDbVersion = $this->appConfig->getValue($appId, 'installed_version');
-			if ($appDbVersion
-				&& isset($appInfo['version'])
-				&& version_compare($appInfo['version'], $appDbVersion, '>')
-				&& \OC_App::isAppCompatible($ocVersion, $appInfo)
-			) {
-				$appsToUpgrade[] = $appInfo;
-			}
-		}
-
-		return $appsToUpgrade;
-	}
-
-	/**
-	 * Returns the app information from "appinfo/info.xml".
-	 *
-	 * @param string $appId app id
-	 *
-	 * @return array app info
-	 *
-	 * @internal
-	 */
-	public function getAppInfo($appId) {
-		$appInfo = \OC_App::getAppInfo($appId);
-		if (!isset($appInfo['version'])) {
-			// read version from separate file
-			$appInfo['version'] = \OC_App::getAppVersion($appId);
-		}
-		return $appInfo;
-	}
-
-	/**
-	 * Returns a list of apps incompatible with the given version
-	 *
-	 * @param array $version ownCloud version as array of version components
-	 *
-	 * @return array list of app info from incompatible apps
-	 *
-	 * @internal
-	 */
-	public function getIncompatibleApps($version) {
-		$apps = $this->getInstalledApps();
-		$incompatibleApps = array();
-		foreach ($apps as $appId) {
-			$info = $this->getAppInfo($appId);
-			if (!\OC_App::isAppCompatible($version, $info)) {
-				$incompatibleApps[] = $info;
-			}
-		}
-		return $incompatibleApps;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function isShipped($appId) {
-		$this->loadShippedJson();
-		return in_array($appId, $this->shippedApps);
-	}
-
-	private function isAlwaysEnabled($appId) {
-		$alwaysEnabled = $this->getAlwaysEnabledApps();
-		return in_array($appId, $alwaysEnabled);
-	}
-
-	private function loadShippedJson() {
-		if (is_null($this->shippedApps)) {
-			$shippedJson = \OC::$SERVERROOT . '/core/shipped.json';
-			if (!file_exists($shippedJson)) {
-				throw new \Exception("File not found: $shippedJson");
-			}
-			$content = json_decode(file_get_contents($shippedJson), true);
-			$this->shippedApps = $content['shippedApps'];
-			$this->alwaysEnabled = $content['alwaysEnabled'];
-		}
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getAlwaysEnabledApps() {
-		$this->loadShippedJson();
-		return $this->alwaysEnabled;
-	}
+    /**
+     * Apps with these types can not be enabled for certain groups only
+     * @var string[]
+     */
+    protected $protectedAppTypes = [
+        'filesystem',
+        'prelogin',
+        'authentication',
+        'logging',
+        'prevent_group_restriction',
+    ];
+
+    /** @var \OCP\IUserSession */
+    private $userSession;
+
+    /** @var \OCP\IAppConfig */
+    private $appConfig;
+
+    /** @var \OCP\IGroupManager */
+    private $groupManager;
+
+    /** @var \OCP\ICacheFactory */
+    private $memCacheFactory;
+
+    /** @var string[] $appId => $enabled */
+    private $installedAppsCache;
+
+    /** @var string[] */
+    private $shippedApps;
+
+    /** @var string[] */
+    private $alwaysEnabled;
+
+    /** @var EventDispatcherInterface */
+    private $dispatcher;
+
+    /**
+     * @param \OCP\IUserSession $userSession
+     * @param \OCP\IAppConfig $appConfig
+     * @param \OCP\IGroupManager $groupManager
+     * @param \OCP\ICacheFactory $memCacheFactory
+     */
+    public function __construct(IUserSession $userSession,
+                                IAppConfig $appConfig,
+                                IGroupManager $groupManager,
+                                ICacheFactory $memCacheFactory,
+                                EventDispatcherInterface $dispatcher) {
+        $this->userSession = $userSession;
+        $this->appConfig = $appConfig;
+        $this->groupManager = $groupManager;
+        $this->memCacheFactory = $memCacheFactory;
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * @return string[] $appId => $enabled
+     */
+    private function getInstalledAppsValues() {
+        if (!$this->installedAppsCache) {
+            $values = $this->appConfig->getValues(false, 'enabled');
+
+            $alwaysEnabledApps = $this->getAlwaysEnabledApps();
+            foreach($alwaysEnabledApps as $appId) {
+                $values[$appId] = 'yes';
+            }
+
+            $this->installedAppsCache = array_filter($values, function ($value) {
+                return $value !== 'no';
+            });
+            ksort($this->installedAppsCache);
+        }
+        return $this->installedAppsCache;
+    }
+
+    /**
+     * List all installed apps
+     *
+     * @return string[]
+     */
+    public function getInstalledApps() {
+        return array_keys($this->getInstalledAppsValues());
+    }
+
+    /**
+     * List all apps enabled for a user
+     *
+     * @param \OCP\IUser $user
+     * @return string[]
+     */
+    public function getEnabledAppsForUser(IUser $user) {
+        $apps = $this->getInstalledAppsValues();
+        $appsForUser = array_filter($apps, function ($enabled) use ($user) {
+            return $this->checkAppForUser($enabled, $user);
+        });
+        return array_keys($appsForUser);
+    }
+
+    /**
+     * Check if an app is enabled for user
+     *
+     * @param string $appId
+     * @param \OCP\IUser $user (optional) if not defined, the currently logged in user will be used
+     * @return bool
+     */
+    public function isEnabledForUser($appId, $user = null) {
+        if ($this->isAlwaysEnabled($appId)) {
+            return true;
+        }
+        if (is_null($user)) {
+            $user = $this->userSession->getUser();
+        }
+        $installedApps = $this->getInstalledAppsValues();
+        if (isset($installedApps[$appId])) {
+            return $this->checkAppForUser($installedApps[$appId], $user);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * @param string $enabled
+     * @param IUser $user
+     * @return bool
+     */
+    private function checkAppForUser($enabled, $user) {
+        if ($enabled === 'yes') {
+            return true;
+        } elseif (is_null($user)) {
+            return false;
+        } else {
+            if(empty($enabled)){
+                return false;
+            }
+
+            $groupIds = json_decode($enabled);
+
+            if (!is_array($groupIds)) {
+                $jsonError = json_last_error();
+                \OC::$server->getLogger()->warning('AppManger::checkAppForUser - can\'t decode group IDs: ' . print_r($enabled, true) . ' - json error code: ' . $jsonError, ['app' => 'lib']);
+                return false;
+            }
+
+            $userGroups = $this->groupManager->getUserGroupIds($user);
+            foreach ($userGroups as $groupId) {
+                if (array_search($groupId, $groupIds) !== false) {
+                    return true;
+                }
+            }
+            return false;
+        }
+    }
+
+    /**
+     * Check if an app is installed in the instance
+     *
+     * @param string $appId
+     * @return bool
+     */
+    public function isInstalled($appId) {
+        $installedApps = $this->getInstalledAppsValues();
+        return isset($installedApps[$appId]);
+    }
+
+    /**
+     * Enable an app for every user
+     *
+     * @param string $appId
+     */
+    public function enableApp($appId) {
+        $this->installedAppsCache[$appId] = 'yes';
+        $this->appConfig->setValue($appId, 'enabled', 'yes');
+        $this->dispatcher->dispatch(ManagerEvent::EVENT_APP_ENABLE, new ManagerEvent(
+            ManagerEvent::EVENT_APP_ENABLE, $appId
+        ));
+        $this->clearAppsCache();
+    }
+
+    /**
+     * Whether a list of types contains a protected app type
+     *
+     * @param string[] $types
+     * @return bool
+     */
+    public function hasProtectedAppType($types) {
+        if (empty($types)) {
+            return false;
+        }
+
+        $protectedTypes = array_intersect($this->protectedAppTypes, $types);
+        return !empty($protectedTypes);
+    }
+
+    /**
+     * Enable an app only for specific groups
+     *
+     * @param string $appId
+     * @param \OCP\IGroup[] $groups
+     * @throws \Exception if app can't be enabled for groups
+     */
+    public function enableAppForGroups($appId, $groups) {
+        $info = $this->getAppInfo($appId);
+        if (!empty($info['types'])) {
+            $protectedTypes = array_intersect($this->protectedAppTypes, $info['types']);
+            if (!empty($protectedTypes)) {
+                throw new \Exception("$appId can't be enabled for groups.");
+            }
+        }
+
+        $groupIds = array_map(function ($group) {
+            /** @var \OCP\IGroup $group */
+            return $group->getGID();
+        }, $groups);
+        $this->installedAppsCache[$appId] = json_encode($groupIds);
+        $this->appConfig->setValue($appId, 'enabled', json_encode($groupIds));
+        $this->dispatcher->dispatch(ManagerEvent::EVENT_APP_ENABLE_FOR_GROUPS, new ManagerEvent(
+            ManagerEvent::EVENT_APP_ENABLE_FOR_GROUPS, $appId, $groups
+        ));
+        $this->clearAppsCache();
+    }
+
+    /**
+     * Disable an app for every user
+     *
+     * @param string $appId
+     * @throws \Exception if app can't be disabled
+     */
+    public function disableApp($appId) {
+        if ($this->isAlwaysEnabled($appId)) {
+            throw new \Exception("$appId can't be disabled.");
+        }
+        unset($this->installedAppsCache[$appId]);
+        $this->appConfig->setValue($appId, 'enabled', 'no');
+        $this->dispatcher->dispatch(ManagerEvent::EVENT_APP_DISABLE, new ManagerEvent(
+            ManagerEvent::EVENT_APP_DISABLE, $appId
+        ));
+        $this->clearAppsCache();
+    }
+
+    /**
+     * Get the directory for the given app.
+     *
+     * @param string $appId
+     * @return string
+     * @throws AppPathNotFoundException if app folder can't be found
+     */
+    public function getAppPath($appId) {
+        $appPath = \OC_App::getAppPath($appId);
+        if($appPath === false) {
+            throw new AppPathNotFoundException('Could not find path for ' . $appId);
+        }
+        return $appPath;
+    }
+
+    /**
+     * Clear the cached list of apps when enabling/disabling an app
+     */
+    public function clearAppsCache() {
+        $settingsMemCache = $this->memCacheFactory->create('settings');
+        $settingsMemCache->clear('listApps');
+    }
+
+    /**
+     * Returns a list of apps that need upgrade
+     *
+     * @param array $version ownCloud version as array of version components
+     * @return array list of app info from apps that need an upgrade
+     *
+     * @internal
+     */
+    public function getAppsNeedingUpgrade($ocVersion) {
+        $appsToUpgrade = [];
+        $apps = $this->getInstalledApps();
+        foreach ($apps as $appId) {
+            $appInfo = $this->getAppInfo($appId);
+            $appDbVersion = $this->appConfig->getValue($appId, 'installed_version');
+            if ($appDbVersion
+                && isset($appInfo['version'])
+                && version_compare($appInfo['version'], $appDbVersion, '>')
+                && \OC_App::isAppCompatible($ocVersion, $appInfo)
+            ) {
+                $appsToUpgrade[] = $appInfo;
+            }
+        }
+
+        return $appsToUpgrade;
+    }
+
+    /**
+     * Returns the app information from "appinfo/info.xml".
+     *
+     * @param string $appId app id
+     *
+     * @return array app info
+     *
+     * @internal
+     */
+    public function getAppInfo($appId) {
+        $appInfo = \OC_App::getAppInfo($appId);
+        if (!isset($appInfo['version'])) {
+            // read version from separate file
+            $appInfo['version'] = \OC_App::getAppVersion($appId);
+        }
+        return $appInfo;
+    }
+
+    /**
+     * Returns a list of apps incompatible with the given version
+     *
+     * @param array $version ownCloud version as array of version components
+     *
+     * @return array list of app info from incompatible apps
+     *
+     * @internal
+     */
+    public function getIncompatibleApps($version) {
+        $apps = $this->getInstalledApps();
+        $incompatibleApps = array();
+        foreach ($apps as $appId) {
+            $info = $this->getAppInfo($appId);
+            if (!\OC_App::isAppCompatible($version, $info)) {
+                $incompatibleApps[] = $info;
+            }
+        }
+        return $incompatibleApps;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function isShipped($appId) {
+        $this->loadShippedJson();
+        return in_array($appId, $this->shippedApps);
+    }
+
+    private function isAlwaysEnabled($appId) {
+        $alwaysEnabled = $this->getAlwaysEnabledApps();
+        return in_array($appId, $alwaysEnabled);
+    }
+
+    private function loadShippedJson() {
+        if (is_null($this->shippedApps)) {
+            $shippedJson = \OC::$SERVERROOT . '/core/shipped.json';
+            if (!file_exists($shippedJson)) {
+                throw new \Exception("File not found: $shippedJson");
+            }
+            $content = json_decode(file_get_contents($shippedJson), true);
+            $this->shippedApps = $content['shippedApps'];
+            $this->alwaysEnabled = $content['alwaysEnabled'];
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getAlwaysEnabledApps() {
+        $this->loadShippedJson();
+        return $this->alwaysEnabled;
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -105,11 +105,11 @@ 
 			$values = $this->appConfig->getValues(false, 'enabled');
 
 			$alwaysEnabledApps = $this->getAlwaysEnabledApps();
-			foreach($alwaysEnabledApps as $appId) {
+			foreach ($alwaysEnabledApps as $appId) {
 				$values[$appId] = 'yes';
 			}
 
-			$this->installedAppsCache = array_filter($values, function ($value) {
+			$this->installedAppsCache = array_filter($values, function($value) {
 				return $value !== 'no';
 			});
 			ksort($this->installedAppsCache);
@@ -134,7 +134,7 @@ 
 	 */
 	public function getEnabledAppsForUser(IUser $user) {
 		$apps = $this->getInstalledAppsValues();
-		$appsForUser = array_filter($apps, function ($enabled) use ($user) {
+		$appsForUser = array_filter($apps, function($enabled) use ($user) {
 			return $this->checkAppForUser($enabled, $user);
 		});
 		return array_keys($appsForUser);
@@ -173,7 +173,7 @@ 
 		} elseif (is_null($user)) {
 			return false;
 		} else {
-			if(empty($enabled)){
+			if (empty($enabled)) {
 				return false;
 			}
 
@@ -181,7 +181,7 @@ 
 
 			if (!is_array($groupIds)) {
 				$jsonError = json_last_error();
-				\OC::$server->getLogger()->warning('AppManger::checkAppForUser - can\'t decode group IDs: ' . print_r($enabled, true) . ' - json error code: ' . $jsonError, ['app' => 'lib']);
+				\OC::$server->getLogger()->warning('AppManger::checkAppForUser - can\'t decode group IDs: '.print_r($enabled, true).' - json error code: '.$jsonError, ['app' => 'lib']);
 				return false;
 			}
 
@@ -251,7 +251,7 @@ 
 			}
 		}
 
-		$groupIds = array_map(function ($group) {
+		$groupIds = array_map(function($group) {
 			/** @var \OCP\IGroup $group */
 			return $group->getGID();
 		}, $groups);
@@ -290,8 +290,8 @@ 
 	 */
 	public function getAppPath($appId) {
 		$appPath = \OC_App::getAppPath($appId);
-		if($appPath === false) {
-			throw new AppPathNotFoundException('Could not find path for ' . $appId);
+		if ($appPath === false) {
+			throw new AppPathNotFoundException('Could not find path for '.$appId);
 		}
 		return $appPath;
 	}
@@ -384,7 +384,7 @@ 
 
 	private function loadShippedJson() {
 		if (is_null($this->shippedApps)) {
-			$shippedJson = \OC::$SERVERROOT . '/core/shipped.json';
+			$shippedJson = \OC::$SERVERROOT.'/core/shipped.json';
 			if (!file_exists($shippedJson)) {
 				throw new \Exception("File not found: $shippedJson");
 			}

lib/private/App/CodeChecker/NodeVisitor.php

Doc Comments +3 added lines

@@ -296,6 +296,9 @@
 		}
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private function buildReason($name, $errorCode) {
 		if (isset($this->errorMessages[$errorCode])) {
 			$desc = $this->list->getDescription($errorCode, $name);

Indentation +276 added lines, -276 removed lines

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

Spacing +13 added lines, -13 removed lines

@@ -102,7 +102,7 @@ 
 
 	public function enterNode(Node $node) {
 		if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => '==',
 				'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
 				'line' => $node->getLine(),
@@ -110,7 +110,7 @@ 
 			];
 		}
 		if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => '!=',
 				'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
 				'line' => $node->getLine(),
@@ -214,28 +214,28 @@ 
 		$alias = strtolower($alias);
 
 		foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) {
-			if (strpos($blackListedClassName, $name . '\\') === 0) {
+			if (strpos($blackListedClassName, $name.'\\') === 0) {
 				$aliasedClassName = str_replace($name, $alias, $blackListedClassName);
 				$this->blackListedClassNames[$aliasedClassName] = $blackListedClassName;
 			}
 		}
 
 		foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) {
-			if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) {
+			if (strpos($blackListedConstant, $name.'\\') === 0 || strpos($blackListedConstant, $name.'::') === 0) {
 				$aliasedConstantName = str_replace($name, $alias, $blackListedConstant);
 				$this->blackListedConstants[$aliasedConstantName] = $blackListedConstant;
 			}
 		}
 
 		foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) {
-			if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) {
+			if (strpos($blackListedFunction, $name.'\\') === 0 || strpos($blackListedFunction, $name.'::') === 0) {
 				$aliasedFunctionName = str_replace($name, $alias, $blackListedFunction);
 				$this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction;
 			}
 		}
 
 		foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) {
-			if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) {
+			if (strpos($blackListedMethod, $name.'\\') === 0 || strpos($blackListedMethod, $name.'::') === 0) {
 				$aliasedMethodName = str_replace($name, $alias, $blackListedMethod);
 				$this->blackListedMethods[$aliasedMethodName] = $blackListedMethod;
 			}
@@ -246,7 +246,7 @@ 
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedClassNames[$lowerName])) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => $name,
 				'errorCode' => $errorCode,
 				'line' => $node->getLine(),
@@ -256,11 +256,11 @@ 
 	}
 
 	private function checkBlackListConstant($class, $constantName, Node $node) {
-		$name = $class . '::' . $constantName;
+		$name = $class.'::'.$constantName;
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedConstants[$lowerName])) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => $name,
 				'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED,
 				'line' => $node->getLine(),
@@ -270,11 +270,11 @@ 
 	}
 
 	private function checkBlackListFunction($class, $functionName, Node $node) {
-		$name = $class . '::' . $functionName;
+		$name = $class.'::'.$functionName;
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedFunctions[$lowerName])) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => $name,
 				'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED,
 				'line' => $node->getLine(),
@@ -284,11 +284,11 @@ 
 	}
 
 	private function checkBlackListMethod($class, $functionName, Node $node) {
-		$name = $class . '::' . $functionName;
+		$name = $class.'::'.$functionName;
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedMethods[$lowerName])) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => $name,
 				'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED,
 				'line' => $node->getLine(),

lib/private/App/Platform.php

Unused Use Statements -1 removed lines

@@ -23,7 +23,6 @@
 
 namespace OC\App;
 
-use OC_Util;
 use OCP\IConfig;
 
 /**

Indentation +54 added lines, -54 removed lines

@@ -36,66 +36,66 @@
  */
 class Platform {
 
-	/**
-	 * @param IConfig $config
-	 */
-	function __construct(IConfig $config) {
-		$this->config = $config;
-	}
+    /**
+     * @param IConfig $config
+     */
+    function __construct(IConfig $config) {
+        $this->config = $config;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getPhpVersion() {
-		return phpversion();
-	}
+    /**
+     * @return string
+     */
+    public function getPhpVersion() {
+        return phpversion();
+    }
 
-	/**
-	 * @return int
-	 */
-	public function getIntSize() {
-		return PHP_INT_SIZE;
-	}
+    /**
+     * @return int
+     */
+    public function getIntSize() {
+        return PHP_INT_SIZE;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getOcVersion() {
-		$v = \OCP\Util::getVersion();
-		return join('.', $v);
-	}
+    /**
+     * @return string
+     */
+    public function getOcVersion() {
+        $v = \OCP\Util::getVersion();
+        return join('.', $v);
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getDatabase() {
-		$dbType = $this->config->getSystemValue('dbtype', 'sqlite');
-		if ($dbType === 'sqlite3') {
-			$dbType = 'sqlite';
-		}
+    /**
+     * @return string
+     */
+    public function getDatabase() {
+        $dbType = $this->config->getSystemValue('dbtype', 'sqlite');
+        if ($dbType === 'sqlite3') {
+            $dbType = 'sqlite';
+        }
 
-		return $dbType;
-	}
+        return $dbType;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getOS() {
-		return php_uname('s');
-	}
+    /**
+     * @return string
+     */
+    public function getOS() {
+        return php_uname('s');
+    }
 
-	/**
-	 * @param $command
-	 * @return bool
-	 */
-	public function isCommandKnown($command) {
-		$path = \OC_Helper::findBinaryPath($command);
-		return ($path !== null);
-	}
+    /**
+     * @param $command
+     * @return bool
+     */
+    public function isCommandKnown($command) {
+        $path = \OC_Helper::findBinaryPath($command);
+        return ($path !== null);
+    }
 
-	public function getLibraryVersion($name) {
-		$repo = new PlatformRepository();
-		$lib = $repo->findLibrary($name);
-		return $lib;
-	}
+    public function getLibraryVersion($name) {
+        $repo = new PlatformRepository();
+        $lib = $repo->findLibrary($name);
+        return $lib;
+    }
 }

lib/private/AppFramework/Http.php

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
 
 	/**
 	 * Gets the correct header
-	 * @param Http::CONSTANT $status the constant from the Http class
+	 * @param integer $status the constant from the Http class
 	 * @param \DateTime $lastModified formatted last modified date
 	 * @param string $ETag the etag
 	 * @return string

Indentation +115 added lines, -115 removed lines

@@ -33,121 +33,121 @@
 
 class Http extends BaseHttp {
 
-	private $server;
-	private $protocolVersion;
-	protected $headers;
-
-	/**
-	 * @param array $server $_SERVER
-	 * @param string $protocolVersion the http version to use defaults to HTTP/1.1
-	 */
-	public function __construct($server, $protocolVersion='HTTP/1.1') {
-		$this->server = $server;
-		$this->protocolVersion = $protocolVersion;
-
-		$this->headers = array(
-			self::STATUS_CONTINUE => 'Continue',
-			self::STATUS_SWITCHING_PROTOCOLS => 'Switching Protocols',
-			self::STATUS_PROCESSING => 'Processing',
-			self::STATUS_OK => 'OK',
-			self::STATUS_CREATED => 'Created',
-			self::STATUS_ACCEPTED => 'Accepted',
-			self::STATUS_NON_AUTHORATIVE_INFORMATION => 'Non-Authorative Information',
-			self::STATUS_NO_CONTENT => 'No Content',
-			self::STATUS_RESET_CONTENT => 'Reset Content',
-			self::STATUS_PARTIAL_CONTENT => 'Partial Content',
-			self::STATUS_MULTI_STATUS => 'Multi-Status', // RFC 4918
-			self::STATUS_ALREADY_REPORTED => 'Already Reported', // RFC 5842
-			self::STATUS_IM_USED => 'IM Used', // RFC 3229
-			self::STATUS_MULTIPLE_CHOICES => 'Multiple Choices',
-			self::STATUS_MOVED_PERMANENTLY => 'Moved Permanently',
-			self::STATUS_FOUND => 'Found',
-			self::STATUS_SEE_OTHER => 'See Other',
-			self::STATUS_NOT_MODIFIED => 'Not Modified',
-			self::STATUS_USE_PROXY => 'Use Proxy',
-			self::STATUS_RESERVED => 'Reserved',
-			self::STATUS_TEMPORARY_REDIRECT => 'Temporary Redirect',
-			self::STATUS_BAD_REQUEST => 'Bad request',
-			self::STATUS_UNAUTHORIZED => 'Unauthorized',
-			self::STATUS_PAYMENT_REQUIRED => 'Payment Required',
-			self::STATUS_FORBIDDEN => 'Forbidden',
-			self::STATUS_NOT_FOUND => 'Not Found',
-			self::STATUS_METHOD_NOT_ALLOWED => 'Method Not Allowed',
-			self::STATUS_NOT_ACCEPTABLE => 'Not Acceptable',
-			self::STATUS_PROXY_AUTHENTICATION_REQUIRED => 'Proxy Authentication Required',
-			self::STATUS_REQUEST_TIMEOUT => 'Request Timeout',
-			self::STATUS_CONFLICT => 'Conflict',
-			self::STATUS_GONE => 'Gone',
-			self::STATUS_LENGTH_REQUIRED => 'Length Required',
-			self::STATUS_PRECONDITION_FAILED => 'Precondition failed',
-			self::STATUS_REQUEST_ENTITY_TOO_LARGE => 'Request Entity Too Large',
-			self::STATUS_REQUEST_URI_TOO_LONG => 'Request-URI Too Long',
-			self::STATUS_UNSUPPORTED_MEDIA_TYPE => 'Unsupported Media Type',
-			self::STATUS_REQUEST_RANGE_NOT_SATISFIABLE => 'Requested Range Not Satisfiable',
-			self::STATUS_EXPECTATION_FAILED => 'Expectation Failed',
-			self::STATUS_IM_A_TEAPOT => 'I\'m a teapot', // RFC 2324
-			self::STATUS_UNPROCESSABLE_ENTITY => 'Unprocessable Entity', // RFC 4918
-			self::STATUS_LOCKED => 'Locked', // RFC 4918
-			self::STATUS_FAILED_DEPENDENCY => 'Failed Dependency', // RFC 4918
-			self::STATUS_UPGRADE_REQUIRED => 'Upgrade required',
-			self::STATUS_PRECONDITION_REQUIRED => 'Precondition required', // draft-nottingham-http-new-status
-			self::STATUS_TOO_MANY_REQUESTS => 'Too Many Requests', // draft-nottingham-http-new-status
-			self::STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE => 'Request Header Fields Too Large', // draft-nottingham-http-new-status
-			self::STATUS_INTERNAL_SERVER_ERROR => 'Internal Server Error',
-			self::STATUS_NOT_IMPLEMENTED => 'Not Implemented',
-			self::STATUS_BAD_GATEWAY => 'Bad Gateway',
-			self::STATUS_SERVICE_UNAVAILABLE => 'Service Unavailable',
-			self::STATUS_GATEWAY_TIMEOUT => 'Gateway Timeout',
-			self::STATUS_HTTP_VERSION_NOT_SUPPORTED => 'HTTP Version not supported',
-			self::STATUS_VARIANT_ALSO_NEGOTIATES => 'Variant Also Negotiates',
-			self::STATUS_INSUFFICIENT_STORAGE => 'Insufficient Storage', // RFC 4918
-			self::STATUS_LOOP_DETECTED => 'Loop Detected', // RFC 5842
-			self::STATUS_BANDWIDTH_LIMIT_EXCEEDED => 'Bandwidth Limit Exceeded', // non-standard
-			self::STATUS_NOT_EXTENDED => 'Not extended',
-			self::STATUS_NETWORK_AUTHENTICATION_REQUIRED => 'Network Authentication Required', // draft-nottingham-http-new-status
-		);
-	}
-
-
-	/**
-	 * Gets the correct header
-	 * @param Http::CONSTANT $status the constant from the Http class
-	 * @param \DateTime $lastModified formatted last modified date
-	 * @param string $ETag the etag
-	 * @return string
-	 */
-	public function getStatusHeader($status, \DateTime $lastModified=null, 
-	                                $ETag=null) {
-
-		if(!is_null($lastModified)) {
-			$lastModified = $lastModified->format(\DateTime::RFC2822);
-		}
-
-		// if etag or lastmodified have not changed, return a not modified
-		if ((isset($this->server['HTTP_IF_NONE_MATCH'])
-			&& trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string)$ETag)
-
-			||
-
-			(isset($this->server['HTTP_IF_MODIFIED_SINCE'])
-			&& trim($this->server['HTTP_IF_MODIFIED_SINCE']) === 
-				$lastModified)) {
-
-			$status = self::STATUS_NOT_MODIFIED;
-		}
-
-		// we have one change currently for the http 1.0 header that differs
-		// from 1.1: STATUS_TEMPORARY_REDIRECT should be STATUS_FOUND
-		// if this differs any more, we want to create childclasses for this
-		if($status === self::STATUS_TEMPORARY_REDIRECT 
-			&& $this->protocolVersion === 'HTTP/1.0') {
-
-			$status = self::STATUS_FOUND;
-		}
-
-		return $this->protocolVersion . ' ' . $status . ' ' . 
-			$this->headers[$status];
-	}
+    private $server;
+    private $protocolVersion;
+    protected $headers;
+
+    /**
+     * @param array $server $_SERVER
+     * @param string $protocolVersion the http version to use defaults to HTTP/1.1
+     */
+    public function __construct($server, $protocolVersion='HTTP/1.1') {
+        $this->server = $server;
+        $this->protocolVersion = $protocolVersion;
+
+        $this->headers = array(
+            self::STATUS_CONTINUE => 'Continue',
+            self::STATUS_SWITCHING_PROTOCOLS => 'Switching Protocols',
+            self::STATUS_PROCESSING => 'Processing',
+            self::STATUS_OK => 'OK',
+            self::STATUS_CREATED => 'Created',
+            self::STATUS_ACCEPTED => 'Accepted',
+            self::STATUS_NON_AUTHORATIVE_INFORMATION => 'Non-Authorative Information',
+            self::STATUS_NO_CONTENT => 'No Content',
+            self::STATUS_RESET_CONTENT => 'Reset Content',
+            self::STATUS_PARTIAL_CONTENT => 'Partial Content',
+            self::STATUS_MULTI_STATUS => 'Multi-Status', // RFC 4918
+            self::STATUS_ALREADY_REPORTED => 'Already Reported', // RFC 5842
+            self::STATUS_IM_USED => 'IM Used', // RFC 3229
+            self::STATUS_MULTIPLE_CHOICES => 'Multiple Choices',
+            self::STATUS_MOVED_PERMANENTLY => 'Moved Permanently',
+            self::STATUS_FOUND => 'Found',
+            self::STATUS_SEE_OTHER => 'See Other',
+            self::STATUS_NOT_MODIFIED => 'Not Modified',
+            self::STATUS_USE_PROXY => 'Use Proxy',
+            self::STATUS_RESERVED => 'Reserved',
+            self::STATUS_TEMPORARY_REDIRECT => 'Temporary Redirect',
+            self::STATUS_BAD_REQUEST => 'Bad request',
+            self::STATUS_UNAUTHORIZED => 'Unauthorized',
+            self::STATUS_PAYMENT_REQUIRED => 'Payment Required',
+            self::STATUS_FORBIDDEN => 'Forbidden',
+            self::STATUS_NOT_FOUND => 'Not Found',
+            self::STATUS_METHOD_NOT_ALLOWED => 'Method Not Allowed',
+            self::STATUS_NOT_ACCEPTABLE => 'Not Acceptable',
+            self::STATUS_PROXY_AUTHENTICATION_REQUIRED => 'Proxy Authentication Required',
+            self::STATUS_REQUEST_TIMEOUT => 'Request Timeout',
+            self::STATUS_CONFLICT => 'Conflict',
+            self::STATUS_GONE => 'Gone',
+            self::STATUS_LENGTH_REQUIRED => 'Length Required',
+            self::STATUS_PRECONDITION_FAILED => 'Precondition failed',
+            self::STATUS_REQUEST_ENTITY_TOO_LARGE => 'Request Entity Too Large',
+            self::STATUS_REQUEST_URI_TOO_LONG => 'Request-URI Too Long',
+            self::STATUS_UNSUPPORTED_MEDIA_TYPE => 'Unsupported Media Type',
+            self::STATUS_REQUEST_RANGE_NOT_SATISFIABLE => 'Requested Range Not Satisfiable',
+            self::STATUS_EXPECTATION_FAILED => 'Expectation Failed',
+            self::STATUS_IM_A_TEAPOT => 'I\'m a teapot', // RFC 2324
+            self::STATUS_UNPROCESSABLE_ENTITY => 'Unprocessable Entity', // RFC 4918
+            self::STATUS_LOCKED => 'Locked', // RFC 4918
+            self::STATUS_FAILED_DEPENDENCY => 'Failed Dependency', // RFC 4918
+            self::STATUS_UPGRADE_REQUIRED => 'Upgrade required',
+            self::STATUS_PRECONDITION_REQUIRED => 'Precondition required', // draft-nottingham-http-new-status
+            self::STATUS_TOO_MANY_REQUESTS => 'Too Many Requests', // draft-nottingham-http-new-status
+            self::STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE => 'Request Header Fields Too Large', // draft-nottingham-http-new-status
+            self::STATUS_INTERNAL_SERVER_ERROR => 'Internal Server Error',
+            self::STATUS_NOT_IMPLEMENTED => 'Not Implemented',
+            self::STATUS_BAD_GATEWAY => 'Bad Gateway',
+            self::STATUS_SERVICE_UNAVAILABLE => 'Service Unavailable',
+            self::STATUS_GATEWAY_TIMEOUT => 'Gateway Timeout',
+            self::STATUS_HTTP_VERSION_NOT_SUPPORTED => 'HTTP Version not supported',
+            self::STATUS_VARIANT_ALSO_NEGOTIATES => 'Variant Also Negotiates',
+            self::STATUS_INSUFFICIENT_STORAGE => 'Insufficient Storage', // RFC 4918
+            self::STATUS_LOOP_DETECTED => 'Loop Detected', // RFC 5842
+            self::STATUS_BANDWIDTH_LIMIT_EXCEEDED => 'Bandwidth Limit Exceeded', // non-standard
+            self::STATUS_NOT_EXTENDED => 'Not extended',
+            self::STATUS_NETWORK_AUTHENTICATION_REQUIRED => 'Network Authentication Required', // draft-nottingham-http-new-status
+        );
+    }
+
+
+    /**
+     * Gets the correct header
+     * @param Http::CONSTANT $status the constant from the Http class
+     * @param \DateTime $lastModified formatted last modified date
+     * @param string $ETag the etag
+     * @return string
+     */
+    public function getStatusHeader($status, \DateTime $lastModified=null, 
+                                    $ETag=null) {
+
+        if(!is_null($lastModified)) {
+            $lastModified = $lastModified->format(\DateTime::RFC2822);
+        }
+
+        // if etag or lastmodified have not changed, return a not modified
+        if ((isset($this->server['HTTP_IF_NONE_MATCH'])
+            && trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string)$ETag)
+
+            ||
+
+            (isset($this->server['HTTP_IF_MODIFIED_SINCE'])
+            && trim($this->server['HTTP_IF_MODIFIED_SINCE']) === 
+                $lastModified)) {
+
+            $status = self::STATUS_NOT_MODIFIED;
+        }
+
+        // we have one change currently for the http 1.0 header that differs
+        // from 1.1: STATUS_TEMPORARY_REDIRECT should be STATUS_FOUND
+        // if this differs any more, we want to create childclasses for this
+        if($status === self::STATUS_TEMPORARY_REDIRECT 
+            && $this->protocolVersion === 'HTTP/1.0') {
+
+            $status = self::STATUS_FOUND;
+        }
+
+        return $this->protocolVersion . ' ' . $status . ' ' . 
+            $this->headers[$status];
+    }
 
 
 }

Spacing +7 added lines, -7 removed lines

@@ -41,7 +41,7 @@ 
 	 * @param array $server $_SERVER
 	 * @param string $protocolVersion the http version to use defaults to HTTP/1.1
 	 */
-	public function __construct($server, $protocolVersion='HTTP/1.1') {
+	public function __construct($server, $protocolVersion = 'HTTP/1.1') {
 		$this->server = $server;
 		$this->protocolVersion = $protocolVersion;
 
@@ -116,16 +116,16 @@ 
 	 * @param string $ETag the etag
 	 * @return string
 	 */
-	public function getStatusHeader($status, \DateTime $lastModified=null, 
-	                                $ETag=null) {
+	public function getStatusHeader($status, \DateTime $lastModified = null, 
+	                                $ETag = null) {
 
-		if(!is_null($lastModified)) {
+		if (!is_null($lastModified)) {
 			$lastModified = $lastModified->format(\DateTime::RFC2822);
 		}
 
 		// if etag or lastmodified have not changed, return a not modified
 		if ((isset($this->server['HTTP_IF_NONE_MATCH'])
-			&& trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string)$ETag)
+			&& trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string) $ETag)
 
 			||
 
@@ -139,13 +139,13 @@ 
 		// we have one change currently for the http 1.0 header that differs
 		// from 1.1: STATUS_TEMPORARY_REDIRECT should be STATUS_FOUND
 		// if this differs any more, we want to create childclasses for this
-		if($status === self::STATUS_TEMPORARY_REDIRECT 
+		if ($status === self::STATUS_TEMPORARY_REDIRECT 
 			&& $this->protocolVersion === 'HTTP/1.0') {
 
 			$status = self::STATUS_FOUND;
 		}
 
-		return $this->protocolVersion . ' ' . $status . ' ' . 
+		return $this->protocolVersion.' '.$status.' '. 
 			$this->headers[$status];
 	}
 

lib/private/AppFramework/Utility/ControllerMethodReflector.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 
 
 	/**
-	 * @param object $object an object or classname
+	 * @param \OCP\AppFramework\Controller $object an object or classname
 	 * @param string $method the method which we want to inspect
 	 */
 	public function reflect($object, $method){

Indentation +96 added lines, -96 removed lines

@@ -35,102 +35,102 @@
  */
 class ControllerMethodReflector implements IControllerMethodReflector{
 
-	private $annotations;
-	private $types;
-	private $parameters;
-
-	public function __construct() {
-		$this->types = array();
-		$this->parameters = array();
-		$this->annotations = array();
-	}
-
-
-	/**
-	 * @param object $object an object or classname
-	 * @param string $method the method which we want to inspect
-	 */
-	public function reflect($object, $method){
-		$reflection = new \ReflectionMethod($object, $method);
-		$docs = $reflection->getDocComment();
-
-		// extract everything prefixed by @ and first letter uppercase
-		preg_match_all('/^\h+\*\h+@(?P<annotation>[A-Z]\w+)(\h+(?P<parameter>\w+))?$/m', $docs, $matches);
-		foreach($matches['annotation'] as $key => $annontation) {
-			$this->annotations[$annontation] = $matches['parameter'][$key];
-		}
-
-		// extract type parameter information
-		preg_match_all('/@param\h+(?P<type>\w+)\h+\$(?P<var>\w+)/', $docs, $matches);
-		$this->types = array_combine($matches['var'], $matches['type']);
-
-		foreach ($reflection->getParameters() as $param) {
-			// extract type information from PHP 7 scalar types and prefer them
-			// over phpdoc annotations
-			if (method_exists($param, 'getType')) {
-				$type = $param->getType();
-				if ($type !== null) {
-					$this->types[$param->getName()] = (string) $type;
-				}
-			}
-
-			if($param->isOptional()) {
-				$default = $param->getDefaultValue();
-			} else {
-				$default = null;
-			}
-			$this->parameters[$param->name] = $default;
-		}
-	}
-
-
-	/**
-	 * Inspects the PHPDoc parameters for types
-	 * @param string $parameter the parameter whose type comments should be
-	 * parsed
-	 * @return string|null type in the type parameters (@param int $something)
-	 * would return int or null if not existing
-	 */
-	public function getType($parameter) {
-		if(array_key_exists($parameter, $this->types)) {
-			return $this->types[$parameter];
-		} else {
-			return null;
-		}
-	}
-
-
-	/**
-	 * @return array the arguments of the method with key => default value
-	 */
-	public function getParameters() {
-		return $this->parameters;
-	}
-
-
-	/**
-	 * Check if a method contains an annotation
-	 * @param string $name the name of the annotation
-	 * @return bool true if the annotation is found
-	 */
-	public function hasAnnotation($name){
-		return array_key_exists($name, $this->annotations);
-	}
-
-
-	/**
-	 * Get optional annotation parameter
-	 * @param string $name the name of the annotation
-	 * @return string
-	 */
-	public function getAnnotationParameter($name){
-		$parameter = '';
-		if($this->hasAnnotation($name)) {
-			$parameter = $this->annotations[$name];
-		}
-
-		return $parameter;
-	}
+    private $annotations;
+    private $types;
+    private $parameters;
+
+    public function __construct() {
+        $this->types = array();
+        $this->parameters = array();
+        $this->annotations = array();
+    }
+
+
+    /**
+     * @param object $object an object or classname
+     * @param string $method the method which we want to inspect
+     */
+    public function reflect($object, $method){
+        $reflection = new \ReflectionMethod($object, $method);
+        $docs = $reflection->getDocComment();
+
+        // extract everything prefixed by @ and first letter uppercase
+        preg_match_all('/^\h+\*\h+@(?P<annotation>[A-Z]\w+)(\h+(?P<parameter>\w+))?$/m', $docs, $matches);
+        foreach($matches['annotation'] as $key => $annontation) {
+            $this->annotations[$annontation] = $matches['parameter'][$key];
+        }
+
+        // extract type parameter information
+        preg_match_all('/@param\h+(?P<type>\w+)\h+\$(?P<var>\w+)/', $docs, $matches);
+        $this->types = array_combine($matches['var'], $matches['type']);
+
+        foreach ($reflection->getParameters() as $param) {
+            // extract type information from PHP 7 scalar types and prefer them
+            // over phpdoc annotations
+            if (method_exists($param, 'getType')) {
+                $type = $param->getType();
+                if ($type !== null) {
+                    $this->types[$param->getName()] = (string) $type;
+                }
+            }
+
+            if($param->isOptional()) {
+                $default = $param->getDefaultValue();
+            } else {
+                $default = null;
+            }
+            $this->parameters[$param->name] = $default;
+        }
+    }
+
+
+    /**
+     * Inspects the PHPDoc parameters for types
+     * @param string $parameter the parameter whose type comments should be
+     * parsed
+     * @return string|null type in the type parameters (@param int $something)
+     * would return int or null if not existing
+     */
+    public function getType($parameter) {
+        if(array_key_exists($parameter, $this->types)) {
+            return $this->types[$parameter];
+        } else {
+            return null;
+        }
+    }
+
+
+    /**
+     * @return array the arguments of the method with key => default value
+     */
+    public function getParameters() {
+        return $this->parameters;
+    }
+
+
+    /**
+     * Check if a method contains an annotation
+     * @param string $name the name of the annotation
+     * @return bool true if the annotation is found
+     */
+    public function hasAnnotation($name){
+        return array_key_exists($name, $this->annotations);
+    }
+
+
+    /**
+     * Get optional annotation parameter
+     * @param string $name the name of the annotation
+     * @return string
+     */
+    public function getAnnotationParameter($name){
+        $parameter = '';
+        if($this->hasAnnotation($name)) {
+            $parameter = $this->annotations[$name];
+        }
+
+        return $parameter;
+    }
 
 
 }

Spacing +8 added lines, -8 removed lines

@@ -33,7 +33,7 @@ 
 /**
  * Reads and parses annotations from doc comments
  */
-class ControllerMethodReflector implements IControllerMethodReflector{
+class ControllerMethodReflector implements IControllerMethodReflector {
 
 	private $annotations;
 	private $types;
@@ -50,13 +50,13 @@ 
 	 * @param object $object an object or classname
 	 * @param string $method the method which we want to inspect
 	 */
-	public function reflect($object, $method){
+	public function reflect($object, $method) {
 		$reflection = new \ReflectionMethod($object, $method);
 		$docs = $reflection->getDocComment();
 
 		// extract everything prefixed by @ and first letter uppercase
 		preg_match_all('/^\h+\*\h+@(?P<annotation>[A-Z]\w+)(\h+(?P<parameter>\w+))?$/m', $docs, $matches);
-		foreach($matches['annotation'] as $key => $annontation) {
+		foreach ($matches['annotation'] as $key => $annontation) {
 			$this->annotations[$annontation] = $matches['parameter'][$key];
 		}
 
@@ -74,7 +74,7 @@ 
 				}
 			}
 
-			if($param->isOptional()) {
+			if ($param->isOptional()) {
 				$default = $param->getDefaultValue();
 			} else {
 				$default = null;
@@ -92,7 +92,7 @@ 
 	 * would return int or null if not existing
 	 */
 	public function getType($parameter) {
-		if(array_key_exists($parameter, $this->types)) {
+		if (array_key_exists($parameter, $this->types)) {
 			return $this->types[$parameter];
 		} else {
 			return null;
@@ -113,7 +113,7 @@ 
 	 * @param string $name the name of the annotation
 	 * @return bool true if the annotation is found
 	 */
-	public function hasAnnotation($name){
+	public function hasAnnotation($name) {
 		return array_key_exists($name, $this->annotations);
 	}
 
@@ -123,9 +123,9 @@ 
 	 * @param string $name the name of the annotation
 	 * @return string
 	 */
-	public function getAnnotationParameter($name){
+	public function getAnnotationParameter($name) {
 		$parameter = '';
-		if($this->hasAnnotation($name)) {
+		if ($this->hasAnnotation($name)) {
 			$parameter = $this->annotations[$name];
 		}
 

lib/private/Comments/Manager.php

Doc Comments +1 added lines, -1 removed lines

@@ -205,7 +205,7 @@
 	/**
 	 * removes an entry from the comments run time cache
 	 *
-	 * @param mixed $id the comment's id
+	 * @param string $id the comment's id
 	 */
 	protected function uncache($id) {
 		$id = strval($id);

Indentation +804 added lines, -804 removed lines

@@ -37,808 +37,808 @@
 
 class Manager implements ICommentsManager {
 
-	/** @var  IDBConnection */
-	protected $dbConn;
-
-	/** @var  ILogger */
-	protected $logger;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IComment[]  */
-	protected $commentsCache = [];
-
-	/** @var  \Closure[] */
-	protected $eventHandlerClosures = [];
-
-	/** @var  ICommentsEventHandler[] */
-	protected $eventHandlers = [];
-
-	/** @var \Closure[] */
-	protected $displayNameResolvers = [];
-
-	/**
-	 * Manager constructor.
-	 *
-	 * @param IDBConnection $dbConn
-	 * @param ILogger $logger
-	 * @param IConfig $config
-	 */
-	public function __construct(
-		IDBConnection $dbConn,
-		ILogger $logger,
-		IConfig $config
-	) {
-		$this->dbConn = $dbConn;
-		$this->logger = $logger;
-		$this->config = $config;
-	}
-
-	/**
-	 * converts data base data into PHP native, proper types as defined by
-	 * IComment interface.
-	 *
-	 * @param array $data
-	 * @return array
-	 */
-	protected function normalizeDatabaseData(array $data) {
-		$data['id'] = strval($data['id']);
-		$data['parent_id'] = strval($data['parent_id']);
-		$data['topmost_parent_id'] = strval($data['topmost_parent_id']);
-		$data['creation_timestamp'] = new \DateTime($data['creation_timestamp']);
-		if (!is_null($data['latest_child_timestamp'])) {
-			$data['latest_child_timestamp'] = new \DateTime($data['latest_child_timestamp']);
-		}
-		$data['children_count'] = intval($data['children_count']);
-		return $data;
-	}
-
-	/**
-	 * prepares a comment for an insert or update operation after making sure
-	 * all necessary fields have a value assigned.
-	 *
-	 * @param IComment $comment
-	 * @return IComment returns the same updated IComment instance as provided
-	 *                  by parameter for convenience
-	 * @throws \UnexpectedValueException
-	 */
-	protected function prepareCommentForDatabaseWrite(IComment $comment) {
-		if(    !$comment->getActorType()
-			|| !$comment->getActorId()
-			|| !$comment->getObjectType()
-			|| !$comment->getObjectId()
-			|| !$comment->getVerb()
-		) {
-			throw new \UnexpectedValueException('Actor, Object and Verb information must be provided for saving');
-		}
-
-		if($comment->getId() === '') {
-			$comment->setChildrenCount(0);
-			$comment->setLatestChildDateTime(new \DateTime('0000-00-00 00:00:00', new \DateTimeZone('UTC')));
-			$comment->setLatestChildDateTime(null);
-		}
-
-		if(is_null($comment->getCreationDateTime())) {
-			$comment->setCreationDateTime(new \DateTime());
-		}
-
-		if($comment->getParentId() !== '0') {
-			$comment->setTopmostParentId($this->determineTopmostParentId($comment->getParentId()));
-		} else {
-			$comment->setTopmostParentId('0');
-		}
-
-		$this->cache($comment);
-
-		return $comment;
-	}
-
-	/**
-	 * returns the topmost parent id of a given comment identified by ID
-	 *
-	 * @param string $id
-	 * @return string
-	 * @throws NotFoundException
-	 */
-	protected function determineTopmostParentId($id) {
-		$comment = $this->get($id);
-		if($comment->getParentId() === '0') {
-			return $comment->getId();
-		} else {
-			return $this->determineTopmostParentId($comment->getId());
-		}
-	}
-
-	/**
-	 * updates child information of a comment
-	 *
-	 * @param string	$id
-	 * @param \DateTime	$cDateTime	the date time of the most recent child
-	 * @throws NotFoundException
-	 */
-	protected function updateChildrenInformation($id, \DateTime $cDateTime) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select($qb->createFunction('COUNT(`id`)'))
-				->from('comments')
-				->where($qb->expr()->eq('parent_id', $qb->createParameter('id')))
-				->setParameter('id', $id);
-
-		$resultStatement = $query->execute();
-		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
-		$resultStatement->closeCursor();
-		$children = intval($data[0]);
-
-		$comment = $this->get($id);
-		$comment->setChildrenCount($children);
-		$comment->setLatestChildDateTime($cDateTime);
-		$this->save($comment);
-	}
-
-	/**
-	 * Tests whether actor or object type and id parameters are acceptable.
-	 * Throws exception if not.
-	 *
-	 * @param string $role
-	 * @param string $type
-	 * @param string $id
-	 * @throws \InvalidArgumentException
-	 */
-	protected function checkRoleParameters($role, $type, $id) {
-		if(
-			   !is_string($type) || empty($type)
-			|| !is_string($id) || empty($id)
-		) {
-			throw new \InvalidArgumentException($role . ' parameters must be string and not empty');
-		}
-	}
-
-	/**
-	 * run-time caches a comment
-	 *
-	 * @param IComment $comment
-	 */
-	protected function cache(IComment $comment) {
-		$id = $comment->getId();
-		if(empty($id)) {
-			return;
-		}
-		$this->commentsCache[strval($id)] = $comment;
-	}
-
-	/**
-	 * removes an entry from the comments run time cache
-	 *
-	 * @param mixed $id the comment's id
-	 */
-	protected function uncache($id) {
-		$id = strval($id);
-		if (isset($this->commentsCache[$id])) {
-			unset($this->commentsCache[$id]);
-		}
-	}
-
-	/**
-	 * returns a comment instance
-	 *
-	 * @param string $id the ID of the comment
-	 * @return IComment
-	 * @throws NotFoundException
-	 * @throws \InvalidArgumentException
-	 * @since 9.0.0
-	 */
-	public function get($id) {
-		if(intval($id) === 0) {
-			throw new \InvalidArgumentException('IDs must be translatable to a number in this implementation.');
-		}
-
-		if(isset($this->commentsCache[$id])) {
-			return $this->commentsCache[$id];
-		}
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$resultStatement = $qb->select('*')
-			->from('comments')
-			->where($qb->expr()->eq('id', $qb->createParameter('id')))
-			->setParameter('id', $id, IQueryBuilder::PARAM_INT)
-			->execute();
-
-		$data = $resultStatement->fetch();
-		$resultStatement->closeCursor();
-		if(!$data) {
-			throw new NotFoundException();
-		}
-
-		$comment = new Comment($this->normalizeDatabaseData($data));
-		$this->cache($comment);
-		return $comment;
-	}
-
-	/**
-	 * returns the comment specified by the id and all it's child comments.
-	 * At this point of time, we do only support one level depth.
-	 *
-	 * @param string $id
-	 * @param int $limit max number of entries to return, 0 returns all
-	 * @param int $offset the start entry
-	 * @return array
-	 * @since 9.0.0
-	 *
-	 * The return array looks like this
-	 * [
-	 *   'comment' => IComment, // root comment
-	 *   'replies' =>
-	 *   [
-	 *     0 =>
-	 *     [
-	 *       'comment' => IComment,
-	 *       'replies' => []
-	 *     ]
-	 *     1 =>
-	 *     [
-	 *       'comment' => IComment,
-	 *       'replies'=> []
-	 *     ],
-	 *     …
-	 *   ]
-	 * ]
-	 */
-	public function getTree($id, $limit = 0, $offset = 0) {
-		$tree = [];
-		$tree['comment'] = $this->get($id);
-		$tree['replies'] = [];
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select('*')
-				->from('comments')
-				->where($qb->expr()->eq('topmost_parent_id', $qb->createParameter('id')))
-				->orderBy('creation_timestamp', 'DESC')
-				->setParameter('id', $id);
-
-		if($limit > 0) {
-			$query->setMaxResults($limit);
-		}
-		if($offset > 0) {
-			$query->setFirstResult($offset);
-		}
-
-		$resultStatement = $query->execute();
-		while($data = $resultStatement->fetch()) {
-			$comment = new Comment($this->normalizeDatabaseData($data));
-			$this->cache($comment);
-			$tree['replies'][] = [
-				'comment' => $comment,
-				'replies' => []
-			];
-		}
-		$resultStatement->closeCursor();
-
-		return $tree;
-	}
-
-	/**
-	 * returns comments for a specific object (e.g. a file).
-	 *
-	 * The sort order is always newest to oldest.
-	 *
-	 * @param string $objectType the object type, e.g. 'files'
-	 * @param string $objectId the id of the object
-	 * @param int $limit optional, number of maximum comments to be returned. if
-	 * not specified, all comments are returned.
-	 * @param int $offset optional, starting point
-	 * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
-	 * that may be returned
-	 * @return IComment[]
-	 * @since 9.0.0
-	 */
-	public function getForObject(
-			$objectType,
-			$objectId,
-			$limit = 0,
-			$offset = 0,
-			\DateTime $notOlderThan = null
-	) {
-		$comments = [];
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select('*')
-				->from('comments')
-				->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
-				->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
-				->orderBy('creation_timestamp', 'DESC')
-				->setParameter('type', $objectType)
-				->setParameter('id', $objectId);
-
-		if($limit > 0) {
-			$query->setMaxResults($limit);
-		}
-		if($offset > 0) {
-			$query->setFirstResult($offset);
-		}
-		if(!is_null($notOlderThan)) {
-			$query
-				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
-				->setParameter('notOlderThan', $notOlderThan, 'datetime');
-		}
-
-		$resultStatement = $query->execute();
-		while($data = $resultStatement->fetch()) {
-			$comment = new Comment($this->normalizeDatabaseData($data));
-			$this->cache($comment);
-			$comments[] = $comment;
-		}
-		$resultStatement->closeCursor();
-
-		return $comments;
-	}
-
-	/**
-	 * @param $objectType string the object type, e.g. 'files'
-	 * @param $objectId string the id of the object
-	 * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
-	 * that may be returned
-	 * @return Int
-	 * @since 9.0.0
-	 */
-	public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select($qb->createFunction('COUNT(`id`)'))
-				->from('comments')
-				->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
-				->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
-				->setParameter('type', $objectType)
-				->setParameter('id', $objectId);
-
-		if(!is_null($notOlderThan)) {
-			$query
-				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
-				->setParameter('notOlderThan', $notOlderThan, 'datetime');
-		}
-
-		$resultStatement = $query->execute();
-		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
-		$resultStatement->closeCursor();
-		return intval($data[0]);
-	}
-
-	/**
-	 * creates a new comment and returns it. At this point of time, it is not
-	 * saved in the used data storage. Use save() after setting other fields
-	 * of the comment (e.g. message or verb).
-	 *
-	 * @param string $actorType the actor type (e.g. 'users')
-	 * @param string $actorId a user id
-	 * @param string $objectType the object type the comment is attached to
-	 * @param string $objectId the object id the comment is attached to
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function create($actorType, $actorId, $objectType, $objectId) {
-		$comment = new Comment();
-		$comment
-			->setActor($actorType, $actorId)
-			->setObject($objectType, $objectId);
-		return $comment;
-	}
-
-	/**
-	 * permanently deletes the comment specified by the ID
-	 *
-	 * When the comment has child comments, their parent ID will be changed to
-	 * the parent ID of the item that is to be deleted.
-	 *
-	 * @param string $id
-	 * @return bool
-	 * @throws \InvalidArgumentException
-	 * @since 9.0.0
-	 */
-	public function delete($id) {
-		if(!is_string($id)) {
-			throw new \InvalidArgumentException('Parameter must be string');
-		}
-
-		try {
-			$comment = $this->get($id);
-		} catch (\Exception $e) {
-			// Ignore exceptions, we just don't fire a hook then
-			$comment = null;
-		}
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->delete('comments')
-			->where($qb->expr()->eq('id', $qb->createParameter('id')))
-			->setParameter('id', $id);
-
-		try {
-			$affectedRows = $query->execute();
-			$this->uncache($id);
-		} catch (DriverException $e) {
-			$this->logger->logException($e, ['app' => 'core_comments']);
-			return false;
-		}
-
-		if ($affectedRows > 0 && $comment instanceof IComment) {
-			$this->sendEvent(CommentsEvent::EVENT_DELETE, $comment);
-		}
-
-		return ($affectedRows > 0);
-	}
-
-	/**
-	 * saves the comment permanently
-	 *
-	 * if the supplied comment has an empty ID, a new entry comment will be
-	 * saved and the instance updated with the new ID.
-	 *
-	 * Otherwise, an existing comment will be updated.
-	 *
-	 * Throws NotFoundException when a comment that is to be updated does not
-	 * exist anymore at this point of time.
-	 *
-	 * @param IComment $comment
-	 * @return bool
-	 * @throws NotFoundException
-	 * @since 9.0.0
-	 */
-	public function save(IComment $comment) {
-		if($this->prepareCommentForDatabaseWrite($comment)->getId() === '') {
-			$result = $this->insert($comment);
-		} else {
-			$result = $this->update($comment);
-		}
-
-		if($result && !!$comment->getParentId()) {
-			$this->updateChildrenInformation(
-					$comment->getParentId(),
-					$comment->getCreationDateTime()
-			);
-			$this->cache($comment);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * inserts the provided comment in the database
-	 *
-	 * @param IComment $comment
-	 * @return bool
-	 */
-	protected function insert(IComment &$comment) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->insert('comments')
-			->values([
-				'parent_id'					=> $qb->createNamedParameter($comment->getParentId()),
-				'topmost_parent_id' 		=> $qb->createNamedParameter($comment->getTopmostParentId()),
-				'children_count' 			=> $qb->createNamedParameter($comment->getChildrenCount()),
-				'actor_type' 				=> $qb->createNamedParameter($comment->getActorType()),
-				'actor_id' 					=> $qb->createNamedParameter($comment->getActorId()),
-				'message' 					=> $qb->createNamedParameter($comment->getMessage()),
-				'verb' 						=> $qb->createNamedParameter($comment->getVerb()),
-				'creation_timestamp' 		=> $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'),
-				'latest_child_timestamp'	=> $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'),
-				'object_type' 				=> $qb->createNamedParameter($comment->getObjectType()),
-				'object_id' 				=> $qb->createNamedParameter($comment->getObjectId()),
-			])
-			->execute();
-
-		if ($affectedRows > 0) {
-			$comment->setId(strval($qb->getLastInsertId()));
-			$this->sendEvent(CommentsEvent::EVENT_ADD, $comment);
-		}
-
-		return $affectedRows > 0;
-	}
-
-	/**
-	 * updates a Comment data row
-	 *
-	 * @param IComment $comment
-	 * @return bool
-	 * @throws NotFoundException
-	 */
-	protected function update(IComment $comment) {
-		// for properly working preUpdate Events we need the old comments as is
-		// in the DB and overcome caching. Also avoid that outdated information stays.
-		$this->uncache($comment->getId());
-		$this->sendEvent(CommentsEvent::EVENT_PRE_UPDATE, $this->get($comment->getId()));
-		$this->uncache($comment->getId());
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->update('comments')
-				->set('parent_id',				$qb->createNamedParameter($comment->getParentId()))
-				->set('topmost_parent_id', 		$qb->createNamedParameter($comment->getTopmostParentId()))
-				->set('children_count',			$qb->createNamedParameter($comment->getChildrenCount()))
-				->set('actor_type', 			$qb->createNamedParameter($comment->getActorType()))
-				->set('actor_id', 				$qb->createNamedParameter($comment->getActorId()))
-				->set('message',				$qb->createNamedParameter($comment->getMessage()))
-				->set('verb',					$qb->createNamedParameter($comment->getVerb()))
-				->set('creation_timestamp',		$qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'))
-				->set('latest_child_timestamp',	$qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'))
-				->set('object_type',			$qb->createNamedParameter($comment->getObjectType()))
-				->set('object_id',				$qb->createNamedParameter($comment->getObjectId()))
-			->where($qb->expr()->eq('id', $qb->createParameter('id')))
-			->setParameter('id', $comment->getId())
-			->execute();
-
-		if($affectedRows === 0) {
-			throw new NotFoundException('Comment to update does ceased to exist');
-		}
-
-		$this->sendEvent(CommentsEvent::EVENT_UPDATE, $comment);
-
-		return $affectedRows > 0;
-	}
-
-	/**
-	 * removes references to specific actor (e.g. on user delete) of a comment.
-	 * The comment itself must not get lost/deleted.
-	 *
-	 * @param string $actorType the actor type (e.g. 'users')
-	 * @param string $actorId a user id
-	 * @return boolean
-	 * @since 9.0.0
-	 */
-	public function deleteReferencesOfActor($actorType, $actorId) {
-		$this->checkRoleParameters('Actor', $actorType, $actorId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->update('comments')
-			->set('actor_type',	$qb->createNamedParameter(ICommentsManager::DELETED_USER))
-			->set('actor_id',	$qb->createNamedParameter(ICommentsManager::DELETED_USER))
-			->where($qb->expr()->eq('actor_type', $qb->createParameter('type')))
-			->andWhere($qb->expr()->eq('actor_id', $qb->createParameter('id')))
-			->setParameter('type', $actorType)
-			->setParameter('id', $actorId)
-			->execute();
-
-		$this->commentsCache = [];
-
-		return is_int($affectedRows);
-	}
-
-	/**
-	 * deletes all comments made of a specific object (e.g. on file delete)
-	 *
-	 * @param string $objectType the object type (e.g. 'files')
-	 * @param string $objectId e.g. the file id
-	 * @return boolean
-	 * @since 9.0.0
-	 */
-	public function deleteCommentsAtObject($objectType, $objectId) {
-		$this->checkRoleParameters('Object', $objectType, $objectId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->delete('comments')
-			->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
-			->setParameter('type', $objectType)
-			->setParameter('id', $objectId)
-			->execute();
-
-		$this->commentsCache = [];
-
-		return is_int($affectedRows);
-	}
-
-	/**
-	 * deletes the read markers for the specified user
-	 *
-	 * @param \OCP\IUser $user
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function deleteReadMarksFromUser(IUser $user) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->delete('comments_read_markers')
-			->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
-			->setParameter('user_id', $user->getUID());
-
-		try {
-			$affectedRows = $query->execute();
-		} catch (DriverException $e) {
-			$this->logger->logException($e, ['app' => 'core_comments']);
-			return false;
-		}
-		return ($affectedRows > 0);
-	}
-
-	/**
-	 * sets the read marker for a given file to the specified date for the
-	 * provided user
-	 *
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @param \DateTime $dateTime
-	 * @param IUser $user
-	 * @since 9.0.0
-	 */
-	public function setReadMark($objectType, $objectId, \DateTime $dateTime, IUser $user) {
-		$this->checkRoleParameters('Object', $objectType, $objectId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$values = [
-			'user_id'         => $qb->createNamedParameter($user->getUID()),
-			'marker_datetime' => $qb->createNamedParameter($dateTime, 'datetime'),
-			'object_type'     => $qb->createNamedParameter($objectType),
-			'object_id'       => $qb->createNamedParameter($objectId),
-		];
-
-		// Strategy: try to update, if this does not return affected rows, do an insert.
-		$affectedRows = $qb
-			->update('comments_read_markers')
-			->set('user_id',         $values['user_id'])
-			->set('marker_datetime', $values['marker_datetime'])
-			->set('object_type',     $values['object_type'])
-			->set('object_id',       $values['object_id'])
-			->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
-			->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
-			->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR)
-			->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR)
-			->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR)
-			->execute();
-
-		if ($affectedRows > 0) {
-			return;
-		}
-
-		$qb->insert('comments_read_markers')
-			->values($values)
-			->execute();
-	}
-
-	/**
-	 * returns the read marker for a given file to the specified date for the
-	 * provided user. It returns null, when the marker is not present, i.e.
-	 * no comments were marked as read.
-	 *
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @param IUser $user
-	 * @return \DateTime|null
-	 * @since 9.0.0
-	 */
-	public function getReadMark($objectType, $objectId, IUser $user) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$resultStatement = $qb->select('marker_datetime')
-			->from('comments_read_markers')
-			->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
-			->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
-			->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR)
-			->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR)
-			->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR)
-			->execute();
-
-		$data = $resultStatement->fetch();
-		$resultStatement->closeCursor();
-		if(!$data || is_null($data['marker_datetime'])) {
-			return null;
-		}
-
-		return new \DateTime($data['marker_datetime']);
-	}
-
-	/**
-	 * deletes the read markers on the specified object
-	 *
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function deleteReadMarksOnObject($objectType, $objectId) {
-		$this->checkRoleParameters('Object', $objectType, $objectId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->delete('comments_read_markers')
-			->where($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
-			->setParameter('object_type', $objectType)
-			->setParameter('object_id', $objectId);
-
-		try {
-			$affectedRows = $query->execute();
-		} catch (DriverException $e) {
-			$this->logger->logException($e, ['app' => 'core_comments']);
-			return false;
-		}
-		return ($affectedRows > 0);
-	}
-
-	/**
-	 * registers an Entity to the manager, so event notifications can be send
-	 * to consumers of the comments infrastructure
-	 *
-	 * @param \Closure $closure
-	 */
-	public function registerEventHandler(\Closure $closure) {
-		$this->eventHandlerClosures[] = $closure;
-		$this->eventHandlers = [];
-	}
-
-	/**
-	 * registers a method that resolves an ID to a display name for a given type
-	 *
-	 * @param string $type
-	 * @param \Closure $closure
-	 * @throws \OutOfBoundsException
-	 * @since 11.0.0
-	 *
-	 * Only one resolver shall be registered per type. Otherwise a
-	 * \OutOfBoundsException has to thrown.
-	 */
-	public function registerDisplayNameResolver($type, \Closure $closure) {
-		if(!is_string($type)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		if(isset($this->displayNameResolvers[$type])) {
-			throw new \OutOfBoundsException('Displayname resolver for this type already registered');
-		}
-		$this->displayNameResolvers[$type] = $closure;
-	}
-
-	/**
-	 * resolves a given ID of a given Type to a display name.
-	 *
-	 * @param string $type
-	 * @param string $id
-	 * @return string
-	 * @throws \OutOfBoundsException
-	 * @since 11.0.0
-	 *
-	 * If a provided type was not registered, an \OutOfBoundsException shall
-	 * be thrown. It is upon the resolver discretion what to return of the
-	 * provided ID is unknown. It must be ensured that a string is returned.
-	 */
-	public function resolveDisplayName($type, $id) {
-		if(!is_string($type)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		if(!isset($this->displayNameResolvers[$type])) {
-			throw new \OutOfBoundsException('No Displayname resolver for this type registered');
-		}
-		return (string)$this->displayNameResolvers[$type]($id);
-	}
-
-	/**
-	 * returns valid, registered entities
-	 *
-	 * @return \OCP\Comments\ICommentsEventHandler[]
-	 */
-	private function getEventHandlers() {
-		if(!empty($this->eventHandlers)) {
-			return $this->eventHandlers;
-		}
-
-		$this->eventHandlers = [];
-		foreach ($this->eventHandlerClosures as $name => $closure) {
-			$entity = $closure();
-			if (!($entity instanceof ICommentsEventHandler)) {
-				throw new \InvalidArgumentException('The given entity does not implement the ICommentsEntity interface');
-			}
-			$this->eventHandlers[$name] = $entity;
-		}
-
-		return $this->eventHandlers;
-	}
-
-	/**
-	 * sends notifications to the registered entities
-	 *
-	 * @param $eventType
-	 * @param IComment $comment
-	 */
-	private function sendEvent($eventType, IComment $comment) {
-		$entities = $this->getEventHandlers();
-		$event = new CommentsEvent($eventType, $comment);
-		foreach ($entities as $entity) {
-			$entity->handle($event);
-		}
-	}
+    /** @var  IDBConnection */
+    protected $dbConn;
+
+    /** @var  ILogger */
+    protected $logger;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var IComment[]  */
+    protected $commentsCache = [];
+
+    /** @var  \Closure[] */
+    protected $eventHandlerClosures = [];
+
+    /** @var  ICommentsEventHandler[] */
+    protected $eventHandlers = [];
+
+    /** @var \Closure[] */
+    protected $displayNameResolvers = [];
+
+    /**
+     * Manager constructor.
+     *
+     * @param IDBConnection $dbConn
+     * @param ILogger $logger
+     * @param IConfig $config
+     */
+    public function __construct(
+        IDBConnection $dbConn,
+        ILogger $logger,
+        IConfig $config
+    ) {
+        $this->dbConn = $dbConn;
+        $this->logger = $logger;
+        $this->config = $config;
+    }
+
+    /**
+     * converts data base data into PHP native, proper types as defined by
+     * IComment interface.
+     *
+     * @param array $data
+     * @return array
+     */
+    protected function normalizeDatabaseData(array $data) {
+        $data['id'] = strval($data['id']);
+        $data['parent_id'] = strval($data['parent_id']);
+        $data['topmost_parent_id'] = strval($data['topmost_parent_id']);
+        $data['creation_timestamp'] = new \DateTime($data['creation_timestamp']);
+        if (!is_null($data['latest_child_timestamp'])) {
+            $data['latest_child_timestamp'] = new \DateTime($data['latest_child_timestamp']);
+        }
+        $data['children_count'] = intval($data['children_count']);
+        return $data;
+    }
+
+    /**
+     * prepares a comment for an insert or update operation after making sure
+     * all necessary fields have a value assigned.
+     *
+     * @param IComment $comment
+     * @return IComment returns the same updated IComment instance as provided
+     *                  by parameter for convenience
+     * @throws \UnexpectedValueException
+     */
+    protected function prepareCommentForDatabaseWrite(IComment $comment) {
+        if(    !$comment->getActorType()
+            || !$comment->getActorId()
+            || !$comment->getObjectType()
+            || !$comment->getObjectId()
+            || !$comment->getVerb()
+        ) {
+            throw new \UnexpectedValueException('Actor, Object and Verb information must be provided for saving');
+        }
+
+        if($comment->getId() === '') {
+            $comment->setChildrenCount(0);
+            $comment->setLatestChildDateTime(new \DateTime('0000-00-00 00:00:00', new \DateTimeZone('UTC')));
+            $comment->setLatestChildDateTime(null);
+        }
+
+        if(is_null($comment->getCreationDateTime())) {
+            $comment->setCreationDateTime(new \DateTime());
+        }
+
+        if($comment->getParentId() !== '0') {
+            $comment->setTopmostParentId($this->determineTopmostParentId($comment->getParentId()));
+        } else {
+            $comment->setTopmostParentId('0');
+        }
+
+        $this->cache($comment);
+
+        return $comment;
+    }
+
+    /**
+     * returns the topmost parent id of a given comment identified by ID
+     *
+     * @param string $id
+     * @return string
+     * @throws NotFoundException
+     */
+    protected function determineTopmostParentId($id) {
+        $comment = $this->get($id);
+        if($comment->getParentId() === '0') {
+            return $comment->getId();
+        } else {
+            return $this->determineTopmostParentId($comment->getId());
+        }
+    }
+
+    /**
+     * updates child information of a comment
+     *
+     * @param string	$id
+     * @param \DateTime	$cDateTime	the date time of the most recent child
+     * @throws NotFoundException
+     */
+    protected function updateChildrenInformation($id, \DateTime $cDateTime) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select($qb->createFunction('COUNT(`id`)'))
+                ->from('comments')
+                ->where($qb->expr()->eq('parent_id', $qb->createParameter('id')))
+                ->setParameter('id', $id);
+
+        $resultStatement = $query->execute();
+        $data = $resultStatement->fetch(\PDO::FETCH_NUM);
+        $resultStatement->closeCursor();
+        $children = intval($data[0]);
+
+        $comment = $this->get($id);
+        $comment->setChildrenCount($children);
+        $comment->setLatestChildDateTime($cDateTime);
+        $this->save($comment);
+    }
+
+    /**
+     * Tests whether actor or object type and id parameters are acceptable.
+     * Throws exception if not.
+     *
+     * @param string $role
+     * @param string $type
+     * @param string $id
+     * @throws \InvalidArgumentException
+     */
+    protected function checkRoleParameters($role, $type, $id) {
+        if(
+                !is_string($type) || empty($type)
+            || !is_string($id) || empty($id)
+        ) {
+            throw new \InvalidArgumentException($role . ' parameters must be string and not empty');
+        }
+    }
+
+    /**
+     * run-time caches a comment
+     *
+     * @param IComment $comment
+     */
+    protected function cache(IComment $comment) {
+        $id = $comment->getId();
+        if(empty($id)) {
+            return;
+        }
+        $this->commentsCache[strval($id)] = $comment;
+    }
+
+    /**
+     * removes an entry from the comments run time cache
+     *
+     * @param mixed $id the comment's id
+     */
+    protected function uncache($id) {
+        $id = strval($id);
+        if (isset($this->commentsCache[$id])) {
+            unset($this->commentsCache[$id]);
+        }
+    }
+
+    /**
+     * returns a comment instance
+     *
+     * @param string $id the ID of the comment
+     * @return IComment
+     * @throws NotFoundException
+     * @throws \InvalidArgumentException
+     * @since 9.0.0
+     */
+    public function get($id) {
+        if(intval($id) === 0) {
+            throw new \InvalidArgumentException('IDs must be translatable to a number in this implementation.');
+        }
+
+        if(isset($this->commentsCache[$id])) {
+            return $this->commentsCache[$id];
+        }
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $resultStatement = $qb->select('*')
+            ->from('comments')
+            ->where($qb->expr()->eq('id', $qb->createParameter('id')))
+            ->setParameter('id', $id, IQueryBuilder::PARAM_INT)
+            ->execute();
+
+        $data = $resultStatement->fetch();
+        $resultStatement->closeCursor();
+        if(!$data) {
+            throw new NotFoundException();
+        }
+
+        $comment = new Comment($this->normalizeDatabaseData($data));
+        $this->cache($comment);
+        return $comment;
+    }
+
+    /**
+     * returns the comment specified by the id and all it's child comments.
+     * At this point of time, we do only support one level depth.
+     *
+     * @param string $id
+     * @param int $limit max number of entries to return, 0 returns all
+     * @param int $offset the start entry
+     * @return array
+     * @since 9.0.0
+     *
+     * The return array looks like this
+     * [
+     *   'comment' => IComment, // root comment
+     *   'replies' =>
+     *   [
+     *     0 =>
+     *     [
+     *       'comment' => IComment,
+     *       'replies' => []
+     *     ]
+     *     1 =>
+     *     [
+     *       'comment' => IComment,
+     *       'replies'=> []
+     *     ],
+     *     …
+     *   ]
+     * ]
+     */
+    public function getTree($id, $limit = 0, $offset = 0) {
+        $tree = [];
+        $tree['comment'] = $this->get($id);
+        $tree['replies'] = [];
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select('*')
+                ->from('comments')
+                ->where($qb->expr()->eq('topmost_parent_id', $qb->createParameter('id')))
+                ->orderBy('creation_timestamp', 'DESC')
+                ->setParameter('id', $id);
+
+        if($limit > 0) {
+            $query->setMaxResults($limit);
+        }
+        if($offset > 0) {
+            $query->setFirstResult($offset);
+        }
+
+        $resultStatement = $query->execute();
+        while($data = $resultStatement->fetch()) {
+            $comment = new Comment($this->normalizeDatabaseData($data));
+            $this->cache($comment);
+            $tree['replies'][] = [
+                'comment' => $comment,
+                'replies' => []
+            ];
+        }
+        $resultStatement->closeCursor();
+
+        return $tree;
+    }
+
+    /**
+     * returns comments for a specific object (e.g. a file).
+     *
+     * The sort order is always newest to oldest.
+     *
+     * @param string $objectType the object type, e.g. 'files'
+     * @param string $objectId the id of the object
+     * @param int $limit optional, number of maximum comments to be returned. if
+     * not specified, all comments are returned.
+     * @param int $offset optional, starting point
+     * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
+     * that may be returned
+     * @return IComment[]
+     * @since 9.0.0
+     */
+    public function getForObject(
+            $objectType,
+            $objectId,
+            $limit = 0,
+            $offset = 0,
+            \DateTime $notOlderThan = null
+    ) {
+        $comments = [];
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select('*')
+                ->from('comments')
+                ->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
+                ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
+                ->orderBy('creation_timestamp', 'DESC')
+                ->setParameter('type', $objectType)
+                ->setParameter('id', $objectId);
+
+        if($limit > 0) {
+            $query->setMaxResults($limit);
+        }
+        if($offset > 0) {
+            $query->setFirstResult($offset);
+        }
+        if(!is_null($notOlderThan)) {
+            $query
+                ->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
+                ->setParameter('notOlderThan', $notOlderThan, 'datetime');
+        }
+
+        $resultStatement = $query->execute();
+        while($data = $resultStatement->fetch()) {
+            $comment = new Comment($this->normalizeDatabaseData($data));
+            $this->cache($comment);
+            $comments[] = $comment;
+        }
+        $resultStatement->closeCursor();
+
+        return $comments;
+    }
+
+    /**
+     * @param $objectType string the object type, e.g. 'files'
+     * @param $objectId string the id of the object
+     * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
+     * that may be returned
+     * @return Int
+     * @since 9.0.0
+     */
+    public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select($qb->createFunction('COUNT(`id`)'))
+                ->from('comments')
+                ->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
+                ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
+                ->setParameter('type', $objectType)
+                ->setParameter('id', $objectId);
+
+        if(!is_null($notOlderThan)) {
+            $query
+                ->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
+                ->setParameter('notOlderThan', $notOlderThan, 'datetime');
+        }
+
+        $resultStatement = $query->execute();
+        $data = $resultStatement->fetch(\PDO::FETCH_NUM);
+        $resultStatement->closeCursor();
+        return intval($data[0]);
+    }
+
+    /**
+     * creates a new comment and returns it. At this point of time, it is not
+     * saved in the used data storage. Use save() after setting other fields
+     * of the comment (e.g. message or verb).
+     *
+     * @param string $actorType the actor type (e.g. 'users')
+     * @param string $actorId a user id
+     * @param string $objectType the object type the comment is attached to
+     * @param string $objectId the object id the comment is attached to
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function create($actorType, $actorId, $objectType, $objectId) {
+        $comment = new Comment();
+        $comment
+            ->setActor($actorType, $actorId)
+            ->setObject($objectType, $objectId);
+        return $comment;
+    }
+
+    /**
+     * permanently deletes the comment specified by the ID
+     *
+     * When the comment has child comments, their parent ID will be changed to
+     * the parent ID of the item that is to be deleted.
+     *
+     * @param string $id
+     * @return bool
+     * @throws \InvalidArgumentException
+     * @since 9.0.0
+     */
+    public function delete($id) {
+        if(!is_string($id)) {
+            throw new \InvalidArgumentException('Parameter must be string');
+        }
+
+        try {
+            $comment = $this->get($id);
+        } catch (\Exception $e) {
+            // Ignore exceptions, we just don't fire a hook then
+            $comment = null;
+        }
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->delete('comments')
+            ->where($qb->expr()->eq('id', $qb->createParameter('id')))
+            ->setParameter('id', $id);
+
+        try {
+            $affectedRows = $query->execute();
+            $this->uncache($id);
+        } catch (DriverException $e) {
+            $this->logger->logException($e, ['app' => 'core_comments']);
+            return false;
+        }
+
+        if ($affectedRows > 0 && $comment instanceof IComment) {
+            $this->sendEvent(CommentsEvent::EVENT_DELETE, $comment);
+        }
+
+        return ($affectedRows > 0);
+    }
+
+    /**
+     * saves the comment permanently
+     *
+     * if the supplied comment has an empty ID, a new entry comment will be
+     * saved and the instance updated with the new ID.
+     *
+     * Otherwise, an existing comment will be updated.
+     *
+     * Throws NotFoundException when a comment that is to be updated does not
+     * exist anymore at this point of time.
+     *
+     * @param IComment $comment
+     * @return bool
+     * @throws NotFoundException
+     * @since 9.0.0
+     */
+    public function save(IComment $comment) {
+        if($this->prepareCommentForDatabaseWrite($comment)->getId() === '') {
+            $result = $this->insert($comment);
+        } else {
+            $result = $this->update($comment);
+        }
+
+        if($result && !!$comment->getParentId()) {
+            $this->updateChildrenInformation(
+                    $comment->getParentId(),
+                    $comment->getCreationDateTime()
+            );
+            $this->cache($comment);
+        }
+
+        return $result;
+    }
+
+    /**
+     * inserts the provided comment in the database
+     *
+     * @param IComment $comment
+     * @return bool
+     */
+    protected function insert(IComment &$comment) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->insert('comments')
+            ->values([
+                'parent_id'					=> $qb->createNamedParameter($comment->getParentId()),
+                'topmost_parent_id' 		=> $qb->createNamedParameter($comment->getTopmostParentId()),
+                'children_count' 			=> $qb->createNamedParameter($comment->getChildrenCount()),
+                'actor_type' 				=> $qb->createNamedParameter($comment->getActorType()),
+                'actor_id' 					=> $qb->createNamedParameter($comment->getActorId()),
+                'message' 					=> $qb->createNamedParameter($comment->getMessage()),
+                'verb' 						=> $qb->createNamedParameter($comment->getVerb()),
+                'creation_timestamp' 		=> $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'),
+                'latest_child_timestamp'	=> $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'),
+                'object_type' 				=> $qb->createNamedParameter($comment->getObjectType()),
+                'object_id' 				=> $qb->createNamedParameter($comment->getObjectId()),
+            ])
+            ->execute();
+
+        if ($affectedRows > 0) {
+            $comment->setId(strval($qb->getLastInsertId()));
+            $this->sendEvent(CommentsEvent::EVENT_ADD, $comment);
+        }
+
+        return $affectedRows > 0;
+    }
+
+    /**
+     * updates a Comment data row
+     *
+     * @param IComment $comment
+     * @return bool
+     * @throws NotFoundException
+     */
+    protected function update(IComment $comment) {
+        // for properly working preUpdate Events we need the old comments as is
+        // in the DB and overcome caching. Also avoid that outdated information stays.
+        $this->uncache($comment->getId());
+        $this->sendEvent(CommentsEvent::EVENT_PRE_UPDATE, $this->get($comment->getId()));
+        $this->uncache($comment->getId());
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->update('comments')
+                ->set('parent_id',				$qb->createNamedParameter($comment->getParentId()))
+                ->set('topmost_parent_id', 		$qb->createNamedParameter($comment->getTopmostParentId()))
+                ->set('children_count',			$qb->createNamedParameter($comment->getChildrenCount()))
+                ->set('actor_type', 			$qb->createNamedParameter($comment->getActorType()))
+                ->set('actor_id', 				$qb->createNamedParameter($comment->getActorId()))
+                ->set('message',				$qb->createNamedParameter($comment->getMessage()))
+                ->set('verb',					$qb->createNamedParameter($comment->getVerb()))
+                ->set('creation_timestamp',		$qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'))
+                ->set('latest_child_timestamp',	$qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'))
+                ->set('object_type',			$qb->createNamedParameter($comment->getObjectType()))
+                ->set('object_id',				$qb->createNamedParameter($comment->getObjectId()))
+            ->where($qb->expr()->eq('id', $qb->createParameter('id')))
+            ->setParameter('id', $comment->getId())
+            ->execute();
+
+        if($affectedRows === 0) {
+            throw new NotFoundException('Comment to update does ceased to exist');
+        }
+
+        $this->sendEvent(CommentsEvent::EVENT_UPDATE, $comment);
+
+        return $affectedRows > 0;
+    }
+
+    /**
+     * removes references to specific actor (e.g. on user delete) of a comment.
+     * The comment itself must not get lost/deleted.
+     *
+     * @param string $actorType the actor type (e.g. 'users')
+     * @param string $actorId a user id
+     * @return boolean
+     * @since 9.0.0
+     */
+    public function deleteReferencesOfActor($actorType, $actorId) {
+        $this->checkRoleParameters('Actor', $actorType, $actorId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->update('comments')
+            ->set('actor_type',	$qb->createNamedParameter(ICommentsManager::DELETED_USER))
+            ->set('actor_id',	$qb->createNamedParameter(ICommentsManager::DELETED_USER))
+            ->where($qb->expr()->eq('actor_type', $qb->createParameter('type')))
+            ->andWhere($qb->expr()->eq('actor_id', $qb->createParameter('id')))
+            ->setParameter('type', $actorType)
+            ->setParameter('id', $actorId)
+            ->execute();
+
+        $this->commentsCache = [];
+
+        return is_int($affectedRows);
+    }
+
+    /**
+     * deletes all comments made of a specific object (e.g. on file delete)
+     *
+     * @param string $objectType the object type (e.g. 'files')
+     * @param string $objectId e.g. the file id
+     * @return boolean
+     * @since 9.0.0
+     */
+    public function deleteCommentsAtObject($objectType, $objectId) {
+        $this->checkRoleParameters('Object', $objectType, $objectId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->delete('comments')
+            ->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
+            ->setParameter('type', $objectType)
+            ->setParameter('id', $objectId)
+            ->execute();
+
+        $this->commentsCache = [];
+
+        return is_int($affectedRows);
+    }
+
+    /**
+     * deletes the read markers for the specified user
+     *
+     * @param \OCP\IUser $user
+     * @return bool
+     * @since 9.0.0
+     */
+    public function deleteReadMarksFromUser(IUser $user) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->delete('comments_read_markers')
+            ->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
+            ->setParameter('user_id', $user->getUID());
+
+        try {
+            $affectedRows = $query->execute();
+        } catch (DriverException $e) {
+            $this->logger->logException($e, ['app' => 'core_comments']);
+            return false;
+        }
+        return ($affectedRows > 0);
+    }
+
+    /**
+     * sets the read marker for a given file to the specified date for the
+     * provided user
+     *
+     * @param string $objectType
+     * @param string $objectId
+     * @param \DateTime $dateTime
+     * @param IUser $user
+     * @since 9.0.0
+     */
+    public function setReadMark($objectType, $objectId, \DateTime $dateTime, IUser $user) {
+        $this->checkRoleParameters('Object', $objectType, $objectId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $values = [
+            'user_id'         => $qb->createNamedParameter($user->getUID()),
+            'marker_datetime' => $qb->createNamedParameter($dateTime, 'datetime'),
+            'object_type'     => $qb->createNamedParameter($objectType),
+            'object_id'       => $qb->createNamedParameter($objectId),
+        ];
+
+        // Strategy: try to update, if this does not return affected rows, do an insert.
+        $affectedRows = $qb
+            ->update('comments_read_markers')
+            ->set('user_id',         $values['user_id'])
+            ->set('marker_datetime', $values['marker_datetime'])
+            ->set('object_type',     $values['object_type'])
+            ->set('object_id',       $values['object_id'])
+            ->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
+            ->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
+            ->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR)
+            ->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR)
+            ->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR)
+            ->execute();
+
+        if ($affectedRows > 0) {
+            return;
+        }
+
+        $qb->insert('comments_read_markers')
+            ->values($values)
+            ->execute();
+    }
+
+    /**
+     * returns the read marker for a given file to the specified date for the
+     * provided user. It returns null, when the marker is not present, i.e.
+     * no comments were marked as read.
+     *
+     * @param string $objectType
+     * @param string $objectId
+     * @param IUser $user
+     * @return \DateTime|null
+     * @since 9.0.0
+     */
+    public function getReadMark($objectType, $objectId, IUser $user) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $resultStatement = $qb->select('marker_datetime')
+            ->from('comments_read_markers')
+            ->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
+            ->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
+            ->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR)
+            ->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR)
+            ->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR)
+            ->execute();
+
+        $data = $resultStatement->fetch();
+        $resultStatement->closeCursor();
+        if(!$data || is_null($data['marker_datetime'])) {
+            return null;
+        }
+
+        return new \DateTime($data['marker_datetime']);
+    }
+
+    /**
+     * deletes the read markers on the specified object
+     *
+     * @param string $objectType
+     * @param string $objectId
+     * @return bool
+     * @since 9.0.0
+     */
+    public function deleteReadMarksOnObject($objectType, $objectId) {
+        $this->checkRoleParameters('Object', $objectType, $objectId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->delete('comments_read_markers')
+            ->where($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
+            ->setParameter('object_type', $objectType)
+            ->setParameter('object_id', $objectId);
+
+        try {
+            $affectedRows = $query->execute();
+        } catch (DriverException $e) {
+            $this->logger->logException($e, ['app' => 'core_comments']);
+            return false;
+        }
+        return ($affectedRows > 0);
+    }
+
+    /**
+     * registers an Entity to the manager, so event notifications can be send
+     * to consumers of the comments infrastructure
+     *
+     * @param \Closure $closure
+     */
+    public function registerEventHandler(\Closure $closure) {
+        $this->eventHandlerClosures[] = $closure;
+        $this->eventHandlers = [];
+    }
+
+    /**
+     * registers a method that resolves an ID to a display name for a given type
+     *
+     * @param string $type
+     * @param \Closure $closure
+     * @throws \OutOfBoundsException
+     * @since 11.0.0
+     *
+     * Only one resolver shall be registered per type. Otherwise a
+     * \OutOfBoundsException has to thrown.
+     */
+    public function registerDisplayNameResolver($type, \Closure $closure) {
+        if(!is_string($type)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        if(isset($this->displayNameResolvers[$type])) {
+            throw new \OutOfBoundsException('Displayname resolver for this type already registered');
+        }
+        $this->displayNameResolvers[$type] = $closure;
+    }
+
+    /**
+     * resolves a given ID of a given Type to a display name.
+     *
+     * @param string $type
+     * @param string $id
+     * @return string
+     * @throws \OutOfBoundsException
+     * @since 11.0.0
+     *
+     * If a provided type was not registered, an \OutOfBoundsException shall
+     * be thrown. It is upon the resolver discretion what to return of the
+     * provided ID is unknown. It must be ensured that a string is returned.
+     */
+    public function resolveDisplayName($type, $id) {
+        if(!is_string($type)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        if(!isset($this->displayNameResolvers[$type])) {
+            throw new \OutOfBoundsException('No Displayname resolver for this type registered');
+        }
+        return (string)$this->displayNameResolvers[$type]($id);
+    }
+
+    /**
+     * returns valid, registered entities
+     *
+     * @return \OCP\Comments\ICommentsEventHandler[]
+     */
+    private function getEventHandlers() {
+        if(!empty($this->eventHandlers)) {
+            return $this->eventHandlers;
+        }
+
+        $this->eventHandlers = [];
+        foreach ($this->eventHandlerClosures as $name => $closure) {
+            $entity = $closure();
+            if (!($entity instanceof ICommentsEventHandler)) {
+                throw new \InvalidArgumentException('The given entity does not implement the ICommentsEntity interface');
+            }
+            $this->eventHandlers[$name] = $entity;
+        }
+
+        return $this->eventHandlers;
+    }
+
+    /**
+     * sends notifications to the registered entities
+     *
+     * @param $eventType
+     * @param IComment $comment
+     */
+    private function sendEvent($eventType, IComment $comment) {
+        $entities = $this->getEventHandlers();
+        $event = new CommentsEvent($eventType, $comment);
+        foreach ($entities as $entity) {
+            $entity->handle($event);
+        }
+    }
 }

Spacing +47 added lines, -47 removed lines

@@ -104,7 +104,7 @@ 
 	 * @throws \UnexpectedValueException
 	 */
 	protected function prepareCommentForDatabaseWrite(IComment $comment) {
-		if(    !$comment->getActorType()
+		if (!$comment->getActorType()
 			|| !$comment->getActorId()
 			|| !$comment->getObjectType()
 			|| !$comment->getObjectId()
@@ -113,17 +113,17 @@ 
 			throw new \UnexpectedValueException('Actor, Object and Verb information must be provided for saving');
 		}
 
-		if($comment->getId() === '') {
+		if ($comment->getId() === '') {
 			$comment->setChildrenCount(0);
 			$comment->setLatestChildDateTime(new \DateTime('0000-00-00 00:00:00', new \DateTimeZone('UTC')));
 			$comment->setLatestChildDateTime(null);
 		}
 
-		if(is_null($comment->getCreationDateTime())) {
+		if (is_null($comment->getCreationDateTime())) {
 			$comment->setCreationDateTime(new \DateTime());
 		}
 
-		if($comment->getParentId() !== '0') {
+		if ($comment->getParentId() !== '0') {
 			$comment->setTopmostParentId($this->determineTopmostParentId($comment->getParentId()));
 		} else {
 			$comment->setTopmostParentId('0');
@@ -143,7 +143,7 @@ 
 	 */
 	protected function determineTopmostParentId($id) {
 		$comment = $this->get($id);
-		if($comment->getParentId() === '0') {
+		if ($comment->getParentId() === '0') {
 			return $comment->getId();
 		} else {
 			return $this->determineTopmostParentId($comment->getId());
@@ -185,11 +185,11 @@ 
 	 * @throws \InvalidArgumentException
 	 */
 	protected function checkRoleParameters($role, $type, $id) {
-		if(
+		if (
 			   !is_string($type) || empty($type)
 			|| !is_string($id) || empty($id)
 		) {
-			throw new \InvalidArgumentException($role . ' parameters must be string and not empty');
+			throw new \InvalidArgumentException($role.' parameters must be string and not empty');
 		}
 	}
 
@@ -200,7 +200,7 @@ 
 	 */
 	protected function cache(IComment $comment) {
 		$id = $comment->getId();
-		if(empty($id)) {
+		if (empty($id)) {
 			return;
 		}
 		$this->commentsCache[strval($id)] = $comment;
@@ -228,11 +228,11 @@ 
 	 * @since 9.0.0
 	 */
 	public function get($id) {
-		if(intval($id) === 0) {
+		if (intval($id) === 0) {
 			throw new \InvalidArgumentException('IDs must be translatable to a number in this implementation.');
 		}
 
-		if(isset($this->commentsCache[$id])) {
+		if (isset($this->commentsCache[$id])) {
 			return $this->commentsCache[$id];
 		}
 
@@ -245,7 +245,7 @@ 
 
 		$data = $resultStatement->fetch();
 		$resultStatement->closeCursor();
-		if(!$data) {
+		if (!$data) {
 			throw new NotFoundException();
 		}
 
@@ -295,15 +295,15 @@ 
 				->orderBy('creation_timestamp', 'DESC')
 				->setParameter('id', $id);
 
-		if($limit > 0) {
+		if ($limit > 0) {
 			$query->setMaxResults($limit);
 		}
-		if($offset > 0) {
+		if ($offset > 0) {
 			$query->setFirstResult($offset);
 		}
 
 		$resultStatement = $query->execute();
-		while($data = $resultStatement->fetch()) {
+		while ($data = $resultStatement->fetch()) {
 			$comment = new Comment($this->normalizeDatabaseData($data));
 			$this->cache($comment);
 			$tree['replies'][] = [
@@ -349,20 +349,20 @@ 
 				->setParameter('type', $objectType)
 				->setParameter('id', $objectId);
 
-		if($limit > 0) {
+		if ($limit > 0) {
 			$query->setMaxResults($limit);
 		}
-		if($offset > 0) {
+		if ($offset > 0) {
 			$query->setFirstResult($offset);
 		}
-		if(!is_null($notOlderThan)) {
+		if (!is_null($notOlderThan)) {
 			$query
 				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
 				->setParameter('notOlderThan', $notOlderThan, 'datetime');
 		}
 
 		$resultStatement = $query->execute();
-		while($data = $resultStatement->fetch()) {
+		while ($data = $resultStatement->fetch()) {
 			$comment = new Comment($this->normalizeDatabaseData($data));
 			$this->cache($comment);
 			$comments[] = $comment;
@@ -389,7 +389,7 @@ 
 				->setParameter('type', $objectType)
 				->setParameter('id', $objectId);
 
-		if(!is_null($notOlderThan)) {
+		if (!is_null($notOlderThan)) {
 			$query
 				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
 				->setParameter('notOlderThan', $notOlderThan, 'datetime');
@@ -433,7 +433,7 @@ 
 	 * @since 9.0.0
 	 */
 	public function delete($id) {
-		if(!is_string($id)) {
+		if (!is_string($id)) {
 			throw new \InvalidArgumentException('Parameter must be string');
 		}
 
@@ -481,13 +481,13 @@ 
 	 * @since 9.0.0
 	 */
 	public function save(IComment $comment) {
-		if($this->prepareCommentForDatabaseWrite($comment)->getId() === '') {
+		if ($this->prepareCommentForDatabaseWrite($comment)->getId() === '') {
 			$result = $this->insert($comment);
 		} else {
 			$result = $this->update($comment);
 		}
 
-		if($result && !!$comment->getParentId()) {
+		if ($result && !!$comment->getParentId()) {
 			$this->updateChildrenInformation(
 					$comment->getParentId(),
 					$comment->getCreationDateTime()
@@ -504,7 +504,7 @@ 
 	 * @param IComment $comment
 	 * @return bool
 	 */
-	protected function insert(IComment &$comment) {
+	protected function insert(IComment & $comment) {
 		$qb = $this->dbConn->getQueryBuilder();
 		$affectedRows = $qb
 			->insert('comments')
@@ -548,22 +548,22 @@ 
 		$qb = $this->dbConn->getQueryBuilder();
 		$affectedRows = $qb
 			->update('comments')
-				->set('parent_id',				$qb->createNamedParameter($comment->getParentId()))
-				->set('topmost_parent_id', 		$qb->createNamedParameter($comment->getTopmostParentId()))
-				->set('children_count',			$qb->createNamedParameter($comment->getChildrenCount()))
-				->set('actor_type', 			$qb->createNamedParameter($comment->getActorType()))
-				->set('actor_id', 				$qb->createNamedParameter($comment->getActorId()))
-				->set('message',				$qb->createNamedParameter($comment->getMessage()))
-				->set('verb',					$qb->createNamedParameter($comment->getVerb()))
-				->set('creation_timestamp',		$qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'))
-				->set('latest_child_timestamp',	$qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'))
-				->set('object_type',			$qb->createNamedParameter($comment->getObjectType()))
-				->set('object_id',				$qb->createNamedParameter($comment->getObjectId()))
+				->set('parent_id', $qb->createNamedParameter($comment->getParentId()))
+				->set('topmost_parent_id', $qb->createNamedParameter($comment->getTopmostParentId()))
+				->set('children_count', $qb->createNamedParameter($comment->getChildrenCount()))
+				->set('actor_type', $qb->createNamedParameter($comment->getActorType()))
+				->set('actor_id', $qb->createNamedParameter($comment->getActorId()))
+				->set('message', $qb->createNamedParameter($comment->getMessage()))
+				->set('verb', $qb->createNamedParameter($comment->getVerb()))
+				->set('creation_timestamp', $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'))
+				->set('latest_child_timestamp', $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'))
+				->set('object_type', $qb->createNamedParameter($comment->getObjectType()))
+				->set('object_id', $qb->createNamedParameter($comment->getObjectId()))
 			->where($qb->expr()->eq('id', $qb->createParameter('id')))
 			->setParameter('id', $comment->getId())
 			->execute();
 
-		if($affectedRows === 0) {
+		if ($affectedRows === 0) {
 			throw new NotFoundException('Comment to update does ceased to exist');
 		}
 
@@ -587,8 +587,8 @@ 
 		$qb = $this->dbConn->getQueryBuilder();
 		$affectedRows = $qb
 			->update('comments')
-			->set('actor_type',	$qb->createNamedParameter(ICommentsManager::DELETED_USER))
-			->set('actor_id',	$qb->createNamedParameter(ICommentsManager::DELETED_USER))
+			->set('actor_type', $qb->createNamedParameter(ICommentsManager::DELETED_USER))
+			->set('actor_id', $qb->createNamedParameter(ICommentsManager::DELETED_USER))
 			->where($qb->expr()->eq('actor_type', $qb->createParameter('type')))
 			->andWhere($qb->expr()->eq('actor_id', $qb->createParameter('id')))
 			->setParameter('type', $actorType)
@@ -671,10 +671,10 @@ 
 		// Strategy: try to update, if this does not return affected rows, do an insert.
 		$affectedRows = $qb
 			->update('comments_read_markers')
-			->set('user_id',         $values['user_id'])
+			->set('user_id', $values['user_id'])
 			->set('marker_datetime', $values['marker_datetime'])
-			->set('object_type',     $values['object_type'])
-			->set('object_id',       $values['object_id'])
+			->set('object_type', $values['object_type'])
+			->set('object_id', $values['object_id'])
 			->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
 			->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
 			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
@@ -717,7 +717,7 @@ 
 
 		$data = $resultStatement->fetch();
 		$resultStatement->closeCursor();
-		if(!$data || is_null($data['marker_datetime'])) {
+		if (!$data || is_null($data['marker_datetime'])) {
 			return null;
 		}
 
@@ -774,10 +774,10 @@ 
 	 * \OutOfBoundsException has to thrown.
 	 */
 	public function registerDisplayNameResolver($type, \Closure $closure) {
-		if(!is_string($type)) {
+		if (!is_string($type)) {
 			throw new \InvalidArgumentException('String expected.');
 		}
-		if(isset($this->displayNameResolvers[$type])) {
+		if (isset($this->displayNameResolvers[$type])) {
 			throw new \OutOfBoundsException('Displayname resolver for this type already registered');
 		}
 		$this->displayNameResolvers[$type] = $closure;
@@ -797,13 +797,13 @@ 
 	 * provided ID is unknown. It must be ensured that a string is returned.
 	 */
 	public function resolveDisplayName($type, $id) {
-		if(!is_string($type)) {
+		if (!is_string($type)) {
 			throw new \InvalidArgumentException('String expected.');
 		}
-		if(!isset($this->displayNameResolvers[$type])) {
+		if (!isset($this->displayNameResolvers[$type])) {
 			throw new \OutOfBoundsException('No Displayname resolver for this type registered');
 		}
-		return (string)$this->displayNameResolvers[$type]($id);
+		return (string) $this->displayNameResolvers[$type]($id);
 	}
 
 	/**
@@ -812,7 +812,7 @@ 
 	 * @return \OCP\Comments\ICommentsEventHandler[]
 	 */
 	private function getEventHandlers() {
-		if(!empty($this->eventHandlers)) {
+		if (!empty($this->eventHandlers)) {
 			return $this->eventHandlers;
 		}
 

lib/private/DB/Connection.php

Doc Comments +2 added lines, -2 removed lines

@@ -173,7 +173,7 @@ 
 	 * If an SQLLogger is configured, the execution is logged.
 	 *
 	 * @param string                                      $query  The SQL query to execute.
-	 * @param array                                       $params The parameters to bind to the query, if any.
+	 * @param string[]                                       $params The parameters to bind to the query, if any.
 	 * @param array                                       $types  The types the previous parameters are in.
 	 * @param \Doctrine\DBAL\Cache\QueryCacheProfile|null $qcp    The query cache profile, optional.
 	 *
@@ -218,7 +218,7 @@ 
 	 * columns or sequences.
 	 *
 	 * @param string $seqName Name of the sequence object from which the ID should be returned.
-	 * @return string A string representation of the last inserted ID.
+	 * @return integer A string representation of the last inserted ID.
 	 */
 	public function lastInsertId($seqName = null) {
 		if ($seqName) {

Indentation +377 added lines, -377 removed lines

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

Spacing +14 added lines, -14 removed lines

@@ -57,7 +57,7 @@ 
 			return parent::connect();
 		} catch (DBALException $e) {
 			// throw a new exception to prevent leaking info from the stacktrace
-			throw new DBALException('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
+			throw new DBALException('Failed to connect to the database: '.$e->getMessage(), $e->getCode());
 		}
 	}
 
@@ -109,7 +109,7 @@ 
 		// 0 is the method where we use `getCallerBacktrace`
 		// 1 is the target method which uses the method we want to log
 		if (isset($traces[1])) {
-			return $traces[1]['file'] . ':' . $traces[1]['line'];
+			return $traces[1]['file'].':'.$traces[1]['line'];
 		}
 
 		return '';
@@ -155,7 +155,7 @@ 
 	 * @param int $offset
 	 * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
 	 */
-	public function prepare( $statement, $limit=null, $offset=null ) {
+	public function prepare($statement, $limit = null, $offset = null) {
 		if ($limit === -1) {
 			$limit = null;
 		}
@@ -166,7 +166,7 @@ 
 		$statement = $this->replaceTablePrefix($statement);
 		$statement = $this->adapter->fixupStatement($statement);
 
-		if(\OC::$server->getSystemConfig()->getValue( 'log_query', false)) {
+		if (\OC::$server->getSystemConfig()->getValue('log_query', false)) {
 			\OCP\Util::writeLog('core', 'DB prepare : '.$statement, \OCP\Util::DEBUG);
 		}
 		return parent::prepare($statement);
@@ -323,7 +323,7 @@ 
 			throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
 		}
 
-		$tableName = $this->tablePrefix . $tableName;
+		$tableName = $this->tablePrefix.$tableName;
 		$this->lockedTable = $tableName;
 		$this->adapter->lockTable($tableName);
 	}
@@ -344,11 +344,11 @@ 
 	 * @return string
 	 */
 	public function getError() {
-		$msg = $this->errorCode() . ': ';
+		$msg = $this->errorCode().': ';
 		$errorInfo = $this->errorInfo();
 		if (is_array($errorInfo)) {
-			$msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
-			$msg .= 'Driver Code = '.$errorInfo[1] . ', ';
+			$msg .= 'SQLSTATE = '.$errorInfo[0].', ';
+			$msg .= 'Driver Code = '.$errorInfo[1].', ';
 			$msg .= 'Driver Message = '.$errorInfo[2];
 		}
 		return $msg;
@@ -360,9 +360,9 @@ 
 	 * @param string $table table name without the prefix
 	 */
 	public function dropTable($table) {
-		$table = $this->tablePrefix . trim($table);
+		$table = $this->tablePrefix.trim($table);
 		$schema = $this->getSchemaManager();
-		if($schema->tablesExist(array($table))) {
+		if ($schema->tablesExist(array($table))) {
 			$schema->dropTable($table);
 		}
 	}
@@ -373,8 +373,8 @@ 
 	 * @param string $table table name without the prefix
 	 * @return bool
 	 */
-	public function tableExists($table){
-		$table = $this->tablePrefix . trim($table);
+	public function tableExists($table) {
+		$table = $this->tablePrefix.trim($table);
 		$schema = $this->getSchemaManager();
 		return $schema->tablesExist(array($table));
 	}
@@ -385,7 +385,7 @@ 
 	 * @return string
 	 */
 	protected function replaceTablePrefix($statement) {
-		return str_replace( '*PREFIX*', $this->tablePrefix, $statement );
+		return str_replace('*PREFIX*', $this->tablePrefix, $statement);
 	}
 
 	/**
@@ -415,6 +415,6 @@ 
 	 * @since 11.0.0
 	 */
 	public function supports4ByteText() {
-		return ! ($this->getDatabasePlatform() instanceof MySqlPlatform && $this->getParams()['charset'] !== 'utf8mb4');
+		return !($this->getDatabasePlatform() instanceof MySqlPlatform && $this->getParams()['charset'] !== 'utf8mb4');
 	}
 }