nextcloud / server

apps/user_ldap/command/setconfig.php

Doc Comments -2 removed lines

@@ -74,8 +74,6 @@
 	/**
 	 * save the configuration value as provided
 	 * @param string $configID
-	 * @param string $configKey
-	 * @param string $configValue
 	 */
 	protected function setValue($configID, $key, $value) {
 		$configHolder = new Configuration($configID);

Indentation +46 added lines, -46 removed lines

@@ -34,53 +34,53 @@
 
 class SetConfig extends Command {
 
-	protected function configure() {
-		$this
-			->setName('ldap:set-config')
-			->setDescription('modifies an LDAP configuration')
-			->addArgument(
-					'configID',
-					InputArgument::REQUIRED,
-					'the configuration ID'
-				     )
-			->addArgument(
-					'configKey',
-					InputArgument::REQUIRED,
-					'the configuration key'
-				     )
-			->addArgument(
-					'configValue',
-					InputArgument::REQUIRED,
-					'the new configuration value'
-				     )
-		;
-	}
+    protected function configure() {
+        $this
+            ->setName('ldap:set-config')
+            ->setDescription('modifies an LDAP configuration')
+            ->addArgument(
+                    'configID',
+                    InputArgument::REQUIRED,
+                    'the configuration ID'
+                        )
+            ->addArgument(
+                    'configKey',
+                    InputArgument::REQUIRED,
+                    'the configuration key'
+                        )
+            ->addArgument(
+                    'configValue',
+                    InputArgument::REQUIRED,
+                    'the new configuration value'
+                        )
+        ;
+    }
 
-	protected function execute(InputInterface $input, OutputInterface $output) {
-		$helper = new Helper();
-		$availableConfigs = $helper->getServerConfigurationPrefixes();
-		$configID = $input->getArgument('configID');
-		if(!in_array($configID, $availableConfigs)) {
-			$output->writeln("Invalid configID");
-			return;
-		}
+    protected function execute(InputInterface $input, OutputInterface $output) {
+        $helper = new Helper();
+        $availableConfigs = $helper->getServerConfigurationPrefixes();
+        $configID = $input->getArgument('configID');
+        if(!in_array($configID, $availableConfigs)) {
+            $output->writeln("Invalid configID");
+            return;
+        }
 
-		$this->setValue(
-			$configID,
-			$input->getArgument('configKey'),
-			$input->getArgument('configValue')
-		);
-	}
+        $this->setValue(
+            $configID,
+            $input->getArgument('configKey'),
+            $input->getArgument('configValue')
+        );
+    }
 
-	/**
-	 * save the configuration value as provided
-	 * @param string $configID
-	 * @param string $configKey
-	 * @param string $configValue
-	 */
-	protected function setValue($configID, $key, $value) {
-		$configHolder = new Configuration($configID);
-		$configHolder->$key = $value;
-		$configHolder->saveConfiguration();
-	}
+    /**
+     * save the configuration value as provided
+     * @param string $configID
+     * @param string $configKey
+     * @param string $configValue
+     */
+    protected function setValue($configID, $key, $value) {
+        $configHolder = new Configuration($configID);
+        $configHolder->$key = $value;
+        $configHolder->saveConfiguration();
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
 		$helper = new Helper();
 		$availableConfigs = $helper->getServerConfigurationPrefixes();
 		$configID = $input->getArgument('configID');
-		if(!in_array($configID, $availableConfigs)) {
+		if (!in_array($configID, $availableConfigs)) {
 			$output->writeln("Invalid configID");
 			return;
 		}

apps/user_ldap/lib/jobs.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 +164 added lines, -164 removed lines

@@ -33,183 +33,183 @@
 use OCA\User_LDAP\Mapping\UserMapping;
 
 class Jobs extends \OC\BackgroundJob\TimedJob {
-	static private $groupsFromDB;
-
-	static private $groupBE;
-	static private $connector;
-
-	public function __construct(){
-		$this->interval = self::getRefreshInterval();
-	}
-
-	/**
-	 * @param mixed $argument
-	 */
-	public function run($argument){
-		Jobs::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;
+    static private $connector;
+
+    public function __construct(){
+        $this->interval = self::getRefreshInterval();
+    }
+
+    /**
+     * @param mixed $argument
+     */
+    public function run($argument){
+        Jobs::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();
-		$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 user\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);
-			$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();
+        $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 user\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);
+            $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

@@ -38,14 +38,14 @@ 
 	static private $groupBE;
 	static private $connector;
 
-	public function __construct(){
+	public function __construct() {
 		$this->interval = self::getRefreshInterval();
 	}
 
 	/**
 	 * @param mixed $argument
 	 */
-	public function run($argument){
+	public function run($argument) {
 		Jobs::updateGroups();
 	}
 
@@ -55,7 +55,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);
@@ -87,26 +87,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));
 			}
 		}
@@ -125,7 +125,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);
@@ -147,7 +147,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);
@@ -162,13 +162,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();
 		$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 user\Manager(
@@ -197,7 +197,7 @@ 
 	 * @return array
 	 */
 	static private function getKnownGroups() {
-		if(is_array(self::$groupsFromDB)) {
+		if (is_array(self::$groupsFromDB)) {
 			return self::$groupsFromDB;
 		}
 		$query = \OCP\DB::prepare('
@@ -206,7 +206,7 @@ 
 		');
 		$result = $query->execute()->fetchAll();
 		self::$groupsFromDB = array();
-		foreach($result as $dataset) {
+		foreach ($result as $dataset) {
 			self::$groupsFromDB[$dataset['owncloudname']] = $dataset;
 		}
 

core/command/security/listcertificates.php

Unused Use Statements -1 removed lines

@@ -28,7 +28,6 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
 class ListCertificates extends Base {

Indentation +56 added lines, -56 removed lines

@@ -34,64 +34,64 @@
 
 class ListCertificates extends Base {
 
-	/** @var ICertificateManager */
-	protected $certificateManager;
-	/** @var IL10N */
-	protected $l;
+    /** @var ICertificateManager */
+    protected $certificateManager;
+    /** @var IL10N */
+    protected $l;
 
-	public function __construct(ICertificateManager $certificateManager, IL10N $l) {
-		$this->certificateManager = $certificateManager;
-		$this->l = $l;
-		parent::__construct();
-	}
+    public function __construct(ICertificateManager $certificateManager, IL10N $l) {
+        $this->certificateManager = $certificateManager;
+        $this->l = $l;
+        parent::__construct();
+    }
 
-	protected function configure() {
-		$this
-			->setName('security:certificates')
-			->setDescription('list trusted certificates');
-		parent::configure();
-	}
+    protected function configure() {
+        $this
+            ->setName('security:certificates')
+            ->setDescription('list trusted certificates');
+        parent::configure();
+    }
 
-	protected function execute(InputInterface $input, OutputInterface $output) {
-		$outputType = $input->getOption('output');
-		if ($outputType === self::OUTPUT_FORMAT_JSON || $outputType === self::OUTPUT_FORMAT_JSON_PRETTY) {
-			$certificates = array_map(function (ICertificate $certificate) {
-				return [
-					'name' => $certificate->getName(),
-					'common_name' => $certificate->getCommonName(),
-					'organization' => $certificate->getOrganization(),
-					'expire' => $certificate->getExpireDate()->format(\DateTime::ATOM),
-					'issuer' => $certificate->getIssuerName(),
-					'issuer_organization' => $certificate->getIssuerOrganization(),
-					'issue_date' => $certificate->getIssueDate()->format(\DateTime::ATOM)
-				];
-			}, $this->certificateManager->listCertificates());
-			if ($outputType === self::OUTPUT_FORMAT_JSON) {
-				$output->writeln(json_encode(array_values($certificates)));
-			} else {
-				$output->writeln(json_encode(array_values($certificates), JSON_PRETTY_PRINT));
-			}
-		} else {
-			$table = new Table($output);
-			$table->setHeaders([
-				'File Name',
-				'Common Name',
-				'Organization',
-				'Valid Until',
-				'Issued By'
-			]);
+    protected function execute(InputInterface $input, OutputInterface $output) {
+        $outputType = $input->getOption('output');
+        if ($outputType === self::OUTPUT_FORMAT_JSON || $outputType === self::OUTPUT_FORMAT_JSON_PRETTY) {
+            $certificates = array_map(function (ICertificate $certificate) {
+                return [
+                    'name' => $certificate->getName(),
+                    'common_name' => $certificate->getCommonName(),
+                    'organization' => $certificate->getOrganization(),
+                    'expire' => $certificate->getExpireDate()->format(\DateTime::ATOM),
+                    'issuer' => $certificate->getIssuerName(),
+                    'issuer_organization' => $certificate->getIssuerOrganization(),
+                    'issue_date' => $certificate->getIssueDate()->format(\DateTime::ATOM)
+                ];
+            }, $this->certificateManager->listCertificates());
+            if ($outputType === self::OUTPUT_FORMAT_JSON) {
+                $output->writeln(json_encode(array_values($certificates)));
+            } else {
+                $output->writeln(json_encode(array_values($certificates), JSON_PRETTY_PRINT));
+            }
+        } else {
+            $table = new Table($output);
+            $table->setHeaders([
+                'File Name',
+                'Common Name',
+                'Organization',
+                'Valid Until',
+                'Issued By'
+            ]);
 
-			$rows = array_map(function (ICertificate $certificate) {
-				return [
-					$certificate->getName(),
-					$certificate->getCommonName(),
-					$certificate->getOrganization(),
-					$this->l->l('date', $certificate->getExpireDate()),
-					$certificate->getIssuerName()
-				];
-			}, $this->certificateManager->listCertificates());
-			$table->setRows($rows);
-			$table->render();
-		}
-	}
+            $rows = array_map(function (ICertificate $certificate) {
+                return [
+                    $certificate->getName(),
+                    $certificate->getCommonName(),
+                    $certificate->getOrganization(),
+                    $this->l->l('date', $certificate->getExpireDate()),
+                    $certificate->getIssuerName()
+                ];
+            }, $this->certificateManager->listCertificates());
+            $table->setRows($rows);
+            $table->render();
+        }
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
 	protected function execute(InputInterface $input, OutputInterface $output) {
 		$outputType = $input->getOption('output');
 		if ($outputType === self::OUTPUT_FORMAT_JSON || $outputType === self::OUTPUT_FORMAT_JSON_PRETTY) {
-			$certificates = array_map(function (ICertificate $certificate) {
+			$certificates = array_map(function(ICertificate $certificate) {
 				return [
 					'name' => $certificate->getName(),
 					'common_name' => $certificate->getCommonName(),
@@ -81,7 +81,7 @@ 
 				'Issued By'
 			]);
 
-			$rows = array_map(function (ICertificate $certificate) {
+			$rows = array_map(function(ICertificate $certificate) {
 				return [
 					$certificate->getName(),
 					$certificate->getCommonName(),

core/controller/lostcontroller.php

Doc Comments +1 added lines, -1 removed lines

@@ -132,7 +132,7 @@
 	}
 
 	/**
-	 * @param $message
+	 * @param string $message
 	 * @param array $additional
 	 * @return array
 	 */

Indentation +181 added lines, -181 removed lines

@@ -50,209 +50,209 @@
  */
 class LostController extends Controller {
 
-	/** @var IURLGenerator */
-	protected $urlGenerator;
-	/** @var IUserManager */
-	protected $userManager;
-	// FIXME: Inject a non-static factory of OC_Defaults for better unit-testing
-	/** @var OC_Defaults */
-	protected $defaults;
-	/** @var IL10N */
-	protected $l10n;
-	/** @var string */
-	protected $from;
-	/** @var bool */
-	protected $isDataEncrypted;
-	/** @var IConfig */
-	protected $config;
-	/** @var ISecureRandom */
-	protected $secureRandom;
-	/** @var IMailer */
-	protected $mailer;
-	/** @var ITimeFactory */
-	protected $timeFactory;
+    /** @var IURLGenerator */
+    protected $urlGenerator;
+    /** @var IUserManager */
+    protected $userManager;
+    // FIXME: Inject a non-static factory of OC_Defaults for better unit-testing
+    /** @var OC_Defaults */
+    protected $defaults;
+    /** @var IL10N */
+    protected $l10n;
+    /** @var string */
+    protected $from;
+    /** @var bool */
+    protected $isDataEncrypted;
+    /** @var IConfig */
+    protected $config;
+    /** @var ISecureRandom */
+    protected $secureRandom;
+    /** @var IMailer */
+    protected $mailer;
+    /** @var ITimeFactory */
+    protected $timeFactory;
 
-	/**
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param IURLGenerator $urlGenerator
-	 * @param IUserManager $userManager
-	 * @param OC_Defaults $defaults
-	 * @param IL10N $l10n
-	 * @param IConfig $config
-	 * @param ISecureRandom $secureRandom
-	 * @param string $from
-	 * @param string $isDataEncrypted
-	 * @param IMailer $mailer
-	 * @param ITimeFactory $timeFactory
-	 */
-	public function __construct($appName,
-								IRequest $request,
-								IURLGenerator $urlGenerator,
-								IUserManager $userManager,
-								OC_Defaults $defaults,
-								IL10N $l10n,
-								IConfig $config,
-								ISecureRandom $secureRandom,
-								$from,
-								$isDataEncrypted,
-								IMailer $mailer,
-								ITimeFactory $timeFactory) {
-		parent::__construct($appName, $request);
-		$this->urlGenerator = $urlGenerator;
-		$this->userManager = $userManager;
-		$this->defaults = $defaults;
-		$this->l10n = $l10n;
-		$this->secureRandom = $secureRandom;
-		$this->from = $from;
-		$this->isDataEncrypted = $isDataEncrypted;
-		$this->config = $config;
-		$this->mailer = $mailer;
-		$this->timeFactory = $timeFactory;
-	}
+    /**
+     * @param string $appName
+     * @param IRequest $request
+     * @param IURLGenerator $urlGenerator
+     * @param IUserManager $userManager
+     * @param OC_Defaults $defaults
+     * @param IL10N $l10n
+     * @param IConfig $config
+     * @param ISecureRandom $secureRandom
+     * @param string $from
+     * @param string $isDataEncrypted
+     * @param IMailer $mailer
+     * @param ITimeFactory $timeFactory
+     */
+    public function __construct($appName,
+                                IRequest $request,
+                                IURLGenerator $urlGenerator,
+                                IUserManager $userManager,
+                                OC_Defaults $defaults,
+                                IL10N $l10n,
+                                IConfig $config,
+                                ISecureRandom $secureRandom,
+                                $from,
+                                $isDataEncrypted,
+                                IMailer $mailer,
+                                ITimeFactory $timeFactory) {
+        parent::__construct($appName, $request);
+        $this->urlGenerator = $urlGenerator;
+        $this->userManager = $userManager;
+        $this->defaults = $defaults;
+        $this->l10n = $l10n;
+        $this->secureRandom = $secureRandom;
+        $this->from = $from;
+        $this->isDataEncrypted = $isDataEncrypted;
+        $this->config = $config;
+        $this->mailer = $mailer;
+        $this->timeFactory = $timeFactory;
+    }
 
-	/**
-	 * Someone wants to reset their password:
-	 *
-	 * @PublicPage
-	 * @NoCSRFRequired
-	 *
-	 * @param string $token
-	 * @param string $userId
-	 * @return TemplateResponse
-	 */
-	public function resetform($token, $userId) {
-		return new TemplateResponse(
-			'core',
-			'lostpassword/resetpassword',
-			array(
-				'link' => $this->urlGenerator->linkToRouteAbsolute('core.lost.setPassword', array('userId' => $userId, 'token' => $token)),
-			),
-			'guest'
-		);
-	}
+    /**
+     * Someone wants to reset their password:
+     *
+     * @PublicPage
+     * @NoCSRFRequired
+     *
+     * @param string $token
+     * @param string $userId
+     * @return TemplateResponse
+     */
+    public function resetform($token, $userId) {
+        return new TemplateResponse(
+            'core',
+            'lostpassword/resetpassword',
+            array(
+                'link' => $this->urlGenerator->linkToRouteAbsolute('core.lost.setPassword', array('userId' => $userId, 'token' => $token)),
+            ),
+            'guest'
+        );
+    }
 
-	/**
-	 * @param $message
-	 * @param array $additional
-	 * @return array
-	 */
-	private function error($message, array $additional=array()) {
-		return array_merge(array('status' => 'error', 'msg' => $message), $additional);
-	}
+    /**
+     * @param $message
+     * @param array $additional
+     * @return array
+     */
+    private function error($message, array $additional=array()) {
+        return array_merge(array('status' => 'error', 'msg' => $message), $additional);
+    }
 
-	/**
-	 * @return array
-	 */
-	private function success() {
-		return array('status'=>'success');
-	}
+    /**
+     * @return array
+     */
+    private function success() {
+        return array('status'=>'success');
+    }
 
-	/**
-	 * @PublicPage
-	 *
-	 * @param string $user
-	 * @return array
-	 */
-	public function email($user){
-		// FIXME: use HTTP error codes
-		try {
-			$this->sendEmail($user);
-		} catch (\Exception $e){
-			return $this->error($e->getMessage());
-		}
+    /**
+     * @PublicPage
+     *
+     * @param string $user
+     * @return array
+     */
+    public function email($user){
+        // FIXME: use HTTP error codes
+        try {
+            $this->sendEmail($user);
+        } catch (\Exception $e){
+            return $this->error($e->getMessage());
+        }
 
-		return $this->success();
-	}
+        return $this->success();
+    }
 
-	/**
-	 * @PublicPage
-	 * @param string $token
-	 * @param string $userId
-	 * @param string $password
-	 * @param boolean $proceed
-	 * @return array
-	 */
-	public function setPassword($token, $userId, $password, $proceed) {
-		if ($this->isDataEncrypted && !$proceed) {
-			return $this->error('', array('encryption' => true));
-		}
+    /**
+     * @PublicPage
+     * @param string $token
+     * @param string $userId
+     * @param string $password
+     * @param boolean $proceed
+     * @return array
+     */
+    public function setPassword($token, $userId, $password, $proceed) {
+        if ($this->isDataEncrypted && !$proceed) {
+            return $this->error('', array('encryption' => true));
+        }
 
-		try {
-			$user = $this->userManager->get($userId);
+        try {
+            $user = $this->userManager->get($userId);
 
-			$splittedToken = explode(':', $this->config->getUserValue($userId, 'owncloud', 'lostpassword', null));
-			if(count($splittedToken) !== 2) {
-				throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid'));
-			}
+            $splittedToken = explode(':', $this->config->getUserValue($userId, 'owncloud', 'lostpassword', null));
+            if(count($splittedToken) !== 2) {
+                throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid'));
+            }
 
-			if ($splittedToken[0] < ($this->timeFactory->getTime() - 60*60*12) ||
-				$user->getLastLogin() > $splittedToken[0]) {
-				throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is expired'));
-			}
+            if ($splittedToken[0] < ($this->timeFactory->getTime() - 60*60*12) ||
+                $user->getLastLogin() > $splittedToken[0]) {
+                throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is expired'));
+            }
 
-			if (!StringUtils::equals($splittedToken[1], $token)) {
-				throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid'));
-			}
+            if (!StringUtils::equals($splittedToken[1], $token)) {
+                throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid'));
+            }
 
-			if (!$user->setPassword($password)) {
-				throw new \Exception();
-			}
+            if (!$user->setPassword($password)) {
+                throw new \Exception();
+            }
 
-			\OC_Hook::emit('\OC\Core\LostPassword\Controller\LostController', 'post_passwordReset', array('uid' => $userId, 'password' => $password));
+            \OC_Hook::emit('\OC\Core\LostPassword\Controller\LostController', 'post_passwordReset', array('uid' => $userId, 'password' => $password));
 
-			$this->config->deleteUserValue($userId, 'owncloud', 'lostpassword');
-			@\OC_User::unsetMagicInCookie();
+            $this->config->deleteUserValue($userId, 'owncloud', 'lostpassword');
+            @\OC_User::unsetMagicInCookie();
 
-		} catch (\Exception $e){
-			return $this->error($e->getMessage());
-		}
+        } catch (\Exception $e){
+            return $this->error($e->getMessage());
+        }
 
-		return $this->success();
-	}
+        return $this->success();
+    }
 
-	/**
-	 * @param string $user
-	 * @throws \Exception
-	 */
-	protected function sendEmail($user) {
-		if (!$this->userManager->userExists($user)) {
-			throw new \Exception($this->l10n->t('Couldn\'t send reset email. Please make sure your username is correct.'));
-		}
+    /**
+     * @param string $user
+     * @throws \Exception
+     */
+    protected function sendEmail($user) {
+        if (!$this->userManager->userExists($user)) {
+            throw new \Exception($this->l10n->t('Couldn\'t send reset email. Please make sure your username is correct.'));
+        }
 
-		$userObject = $this->userManager->get($user);
-		$email = $userObject->getEMailAddress();
+        $userObject = $this->userManager->get($user);
+        $email = $userObject->getEMailAddress();
 
-		if (empty($email)) {
-			throw new \Exception(
-				$this->l10n->t('Could not send reset email because there is no email address for this username. Please contact your administrator.')
-			);
-		}
+        if (empty($email)) {
+            throw new \Exception(
+                $this->l10n->t('Could not send reset email because there is no email address for this username. Please contact your administrator.')
+            );
+        }
 
-		$token = $this->secureRandom->generate(21,
-			ISecureRandom::CHAR_DIGITS.
-			ISecureRandom::CHAR_LOWER.
-			ISecureRandom::CHAR_UPPER);
-		$this->config->setUserValue($user, 'owncloud', 'lostpassword', $this->timeFactory->getTime() .':'. $token);
+        $token = $this->secureRandom->generate(21,
+            ISecureRandom::CHAR_DIGITS.
+            ISecureRandom::CHAR_LOWER.
+            ISecureRandom::CHAR_UPPER);
+        $this->config->setUserValue($user, 'owncloud', 'lostpassword', $this->timeFactory->getTime() .':'. $token);
 
-		$link = $this->urlGenerator->linkToRouteAbsolute('core.lost.resetform', array('userId' => $user, 'token' => $token));
+        $link = $this->urlGenerator->linkToRouteAbsolute('core.lost.resetform', array('userId' => $user, 'token' => $token));
 
-		$tmpl = new \OC_Template('core', 'lostpassword/email');
-		$tmpl->assign('link', $link);
-		$msg = $tmpl->fetchPage();
+        $tmpl = new \OC_Template('core', 'lostpassword/email');
+        $tmpl->assign('link', $link);
+        $msg = $tmpl->fetchPage();
 
-		try {
-			$message = $this->mailer->createMessage();
-			$message->setTo([$email => $user]);
-			$message->setSubject($this->l10n->t('%s password reset', [$this->defaults->getName()]));
-			$message->setPlainBody($msg);
-			$message->setFrom([$this->from => $this->defaults->getName()]);
-			$this->mailer->send($message);
-		} catch (\Exception $e) {
-			throw new \Exception($this->l10n->t(
-				'Couldn\'t send reset email. Please contact your administrator.'
-			));
-		}
-	}
+        try {
+            $message = $this->mailer->createMessage();
+            $message->setTo([$email => $user]);
+            $message->setSubject($this->l10n->t('%s password reset', [$this->defaults->getName()]));
+            $message->setPlainBody($msg);
+            $message->setFrom([$this->from => $this->defaults->getName()]);
+            $this->mailer->send($message);
+        } catch (\Exception $e) {
+            throw new \Exception($this->l10n->t(
+                'Couldn\'t send reset email. Please contact your administrator.'
+            ));
+        }
+    }
 
 }

Spacing +7 added lines, -7 removed lines

@@ -137,7 +137,7 @@ 
 	 * @param array $additional
 	 * @return array
 	 */
-	private function error($message, array $additional=array()) {
+	private function error($message, array $additional = array()) {
 		return array_merge(array('status' => 'error', 'msg' => $message), $additional);
 	}
 
@@ -154,11 +154,11 @@ 
 	 * @param string $user
 	 * @return array
 	 */
-	public function email($user){
+	public function email($user) {
 		// FIXME: use HTTP error codes
 		try {
 			$this->sendEmail($user);
-		} catch (\Exception $e){
+		} catch (\Exception $e) {
 			return $this->error($e->getMessage());
 		}
 
@@ -182,11 +182,11 @@ 
 			$user = $this->userManager->get($userId);
 
 			$splittedToken = explode(':', $this->config->getUserValue($userId, 'owncloud', 'lostpassword', null));
-			if(count($splittedToken) !== 2) {
+			if (count($splittedToken) !== 2) {
 				throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid'));
 			}
 
-			if ($splittedToken[0] < ($this->timeFactory->getTime() - 60*60*12) ||
+			if ($splittedToken[0] < ($this->timeFactory->getTime() - 60 * 60 * 12) ||
 				$user->getLastLogin() > $splittedToken[0]) {
 				throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is expired'));
 			}
@@ -204,7 +204,7 @@ 
 			$this->config->deleteUserValue($userId, 'owncloud', 'lostpassword');
 			@\OC_User::unsetMagicInCookie();
 
-		} catch (\Exception $e){
+		} catch (\Exception $e) {
 			return $this->error($e->getMessage());
 		}
 
@@ -233,7 +233,7 @@ 
 			ISecureRandom::CHAR_DIGITS.
 			ISecureRandom::CHAR_LOWER.
 			ISecureRandom::CHAR_UPPER);
-		$this->config->setUserValue($user, 'owncloud', 'lostpassword', $this->timeFactory->getTime() .':'. $token);
+		$this->config->setUserValue($user, 'owncloud', 'lostpassword', $this->timeFactory->getTime().':'.$token);
 
 		$link = $this->urlGenerator->linkToRouteAbsolute('core.lost.resetform', array('userId' => $user, 'token' => $token));
 

lib/private/allconfig.php

Doc Comments +1 added lines, -1 removed lines

@@ -112,7 +112,7 @@
 	 * Looks up a system wide defined value
 	 *
 	 * @param string $key the key of the value, under which it was saved
-	 * @param mixed $default the default value to be returned if the value isn't set
+	 * @param string $default the default value to be returned if the value isn't set
 	 * @return mixed the value or $default
 	 */
 	public function getSystemValue($key, $default = '') {

Indentation +388 added lines, -388 removed lines

@@ -37,392 +37,392 @@
  * Class to combine all the configuration options ownCloud offers
  */
 class AllConfig implements \OCP\IConfig {
-	/** @var SystemConfig */
-	private $systemConfig;
-
-	/** @var IDBConnection */
-	private $connection;
-
-	/**
-	 * 3 dimensional array with the following structure:
-	 * [ $userId =>
-	 *     [ $appId =>
-	 *         [ $key => $value ]
-	 *     ]
-	 * ]
-	 *
-	 * database table: preferences
-	 *
-	 * methods that use this:
-	 *   - setUserValue
-	 *   - getUserValue
-	 *   - getUserKeys
-	 *   - deleteUserValue
-	 *   - deleteAllUserValues
-	 *   - deleteAppFromAllUsers
-	 *
-	 * @var CappedMemoryCache $userCache
-	 */
-	private $userCache;
-
-	/**
-	 * @param SystemConfig $systemConfig
-	 */
-	function __construct(SystemConfig $systemConfig) {
-		$this->userCache = new CappedMemoryCache();
-		$this->systemConfig = $systemConfig;
-	}
-
-	/**
-	 * TODO - FIXME This fixes an issue with base.php that cause cyclic
-	 * dependencies, especially with autoconfig setup
-	 *
-	 * Replace this by properly injected database connection. Currently the
-	 * base.php triggers the getDatabaseConnection too early which causes in
-	 * autoconfig setup case a too early distributed database connection and
-	 * the autoconfig then needs to reinit all already initialized dependencies
-	 * that use the database connection.
-	 *
-	 * otherwise a SQLite database is created in the wrong directory
-	 * because the database connection was created with an uninitialized config
-	 */
-	private function fixDIInit() {
-		if($this->connection === null) {
-			$this->connection = \OC::$server->getDatabaseConnection();
-		}
-	}
-
-	/**
-	 * Sets and deletes system wide values
-	 *
-	 * @param array $configs Associative array with `key => value` pairs
-	 *                       If value is null, the config key will be deleted
-	 */
-	public function setSystemValues(array $configs) {
-		$this->systemConfig->setValues($configs);
-	}
-
-	/**
-	 * Sets a new system wide value
-	 *
-	 * @param string $key the key of the value, under which will be saved
-	 * @param mixed $value the value that should be stored
-	 */
-	public function setSystemValue($key, $value) {
-		$this->systemConfig->setValue($key, $value);
-	}
-
-	/**
-	 * Looks up a system wide defined value
-	 *
-	 * @param string $key the key of the value, under which it was saved
-	 * @param mixed $default the default value to be returned if the value isn't set
-	 * @return mixed the value or $default
-	 */
-	public function getSystemValue($key, $default = '') {
-		return $this->systemConfig->getValue($key, $default);
-	}
-
-	/**
-	 * Looks up a system wide defined value and filters out sensitive data
-	 *
-	 * @param string $key the key of the value, under which it was saved
-	 * @param mixed $default the default value to be returned if the value isn't set
-	 * @return mixed the value or $default
-	 */
-	public function getFilteredSystemValue($key, $default = '') {
-		return $this->systemConfig->getFilteredValue($key, $default);
-	}
-
-	/**
-	 * Delete a system wide defined value
-	 *
-	 * @param string $key the key of the value, under which it was saved
-	 */
-	public function deleteSystemValue($key) {
-		$this->systemConfig->deleteValue($key);
-	}
-
-	/**
-	 * Get all keys stored for an app
-	 *
-	 * @param string $appName the appName that we stored the value under
-	 * @return string[] the keys stored for the app
-	 */
-	public function getAppKeys($appName) {
-		return \OC::$server->getAppConfig()->getKeys($appName);
-	}
-
-	/**
-	 * Writes a new app wide value
-	 *
-	 * @param string $appName the appName that we want to store the value under
-	 * @param string $key the key of the value, under which will be saved
-	 * @param string $value the value that should be stored
-	 */
-	public function setAppValue($appName, $key, $value) {
-		\OC::$server->getAppConfig()->setValue($appName, $key, $value);
-	}
-
-	/**
-	 * Looks up an app wide defined value
-	 *
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key of the value, under which it was saved
-	 * @param string $default the default value to be returned if the value isn't set
-	 * @return string the saved value
-	 */
-	public function getAppValue($appName, $key, $default = '') {
-		return \OC::$server->getAppConfig()->getValue($appName, $key, $default);
-	}
-
-	/**
-	 * Delete an app wide defined value
-	 *
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key of the value, under which it was saved
-	 */
-	public function deleteAppValue($appName, $key) {
-		\OC::$server->getAppConfig()->deleteKey($appName, $key);
-	}
-
-	/**
-	 * Removes all keys in appconfig belonging to the app
-	 *
-	 * @param string $appName the appName the configs are stored under
-	 */
-	public function deleteAppValues($appName) {
-		\OC::$server->getAppConfig()->deleteApp($appName);
-	}
-
-
-	/**
-	 * Set a user defined value
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we want to store the value under
-	 * @param string $key the key under which the value is being stored
-	 * @param string $value the value that you want to store
-	 * @param string $preCondition only update if the config value was previously the value passed as $preCondition
-	 * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met
-	 */
-	public function setUserValue($userId, $appName, $key, $value, $preCondition = null) {
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		$preconditionArray = [];
-		if (isset($preCondition)) {
-			$preconditionArray = [
-				'configvalue' => $preCondition,
-			];
-		}
-
-		$this->connection->setValues('preferences', [
-			'userid' => $userId,
-			'appid' => $appName,
-			'configkey' => $key,
-		], [
-			'configvalue' => $value,
-		], $preconditionArray);
-
-		// only add to the cache if we already loaded data for the user
-		if (isset($this->userCache[$userId])) {
-			if (!isset($this->userCache[$userId][$appName])) {
-				$this->userCache[$userId][$appName] = array();
-			}
-			$this->userCache[$userId][$appName][$key] = $value;
-		}
-	}
-
-	/**
-	 * Getting a user defined value
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key under which the value is being stored
-	 * @param mixed $default the default value to be returned if the value isn't set
-	 * @return string
-	 */
-	public function getUserValue($userId, $appName, $key, $default = '') {
-		$data = $this->getUserValues($userId);
-		if (isset($data[$appName]) and isset($data[$appName][$key])) {
-			return $data[$appName][$key];
-		} else {
-			return $default;
-		}
-	}
-
-	/**
-	 * Get the keys of all stored by an app for the user
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we stored the value under
-	 * @return string[]
-	 */
-	public function getUserKeys($userId, $appName) {
-		$data = $this->getUserValues($userId);
-		if (isset($data[$appName])) {
-			return array_keys($data[$appName]);
-		} else {
-			return array();
-		}
-	}
-
-	/**
-	 * Delete a user value
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key under which the value is being stored
-	 */
-	public function deleteUserValue($userId, $appName, $key) {
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
-				'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?';
-		$this->connection->executeUpdate($sql, array($userId, $appName, $key));
-
-		if (isset($this->userCache[$userId]) and isset($this->userCache[$userId][$appName])) {
-			unset($this->userCache[$userId][$appName][$key]);
-		}
-	}
-
-	/**
-	 * Delete all user values
-	 *
-	 * @param string $userId the userId of the user that we want to remove all values from
-	 */
-	public function deleteAllUserValues($userId) {
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
-			'WHERE `userid` = ?';
-		$this->connection->executeUpdate($sql, array($userId));
-
-		unset($this->userCache[$userId]);
-	}
-
-	/**
-	 * Delete all user related values of one app
-	 *
-	 * @param string $appName the appName of the app that we want to remove all values from
-	 */
-	public function deleteAppFromAllUsers($appName) {
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
-				'WHERE `appid` = ?';
-		$this->connection->executeUpdate($sql, array($appName));
-
-		foreach ($this->userCache as &$userCache) {
-			unset($userCache[$appName]);
-		}
-	}
-
-	/**
-	 * Returns all user configs sorted by app of one user
-	 *
-	 * @param string $userId the user ID to get the app configs from
-	 * @return array[] - 2 dimensional array with the following structure:
-	 *     [ $appId =>
-	 *         [ $key => $value ]
-	 *     ]
-	 */
-	private function getUserValues($userId) {
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		if (isset($this->userCache[$userId])) {
-			return $this->userCache[$userId];
-		}
-		$data = array();
-		$query = 'SELECT `appid`, `configkey`, `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ?';
-		$result = $this->connection->executeQuery($query, array($userId));
-		while ($row = $result->fetch()) {
-			$appId = $row['appid'];
-			if (!isset($data[$appId])) {
-				$data[$appId] = array();
-			}
-			$data[$appId][$row['configkey']] = $row['configvalue'];
-		}
-		$this->userCache[$userId] = $data;
-		return $data;
-	}
-
-	/**
-	 * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs.
-	 *
-	 * @param string $appName app to get the value for
-	 * @param string $key the key to get the value for
-	 * @param array $userIds the user IDs to fetch the values for
-	 * @return array Mapped values: userId => value
-	 */
-	public function getUserValueForUsers($appName, $key, $userIds) {
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		if (empty($userIds) || !is_array($userIds)) {
-			return array();
-		}
-
-		$chunkedUsers = array_chunk($userIds, 50, true);
-		$placeholders50 = implode(',', array_fill(0, 50, '?'));
-
-		$userValues = array();
-		foreach ($chunkedUsers as $chunk) {
-			$queryParams = $chunk;
-			// create [$app, $key, $chunkedUsers]
-			array_unshift($queryParams, $key);
-			array_unshift($queryParams, $appName);
-
-			$placeholders = (sizeof($chunk) == 50) ? $placeholders50 :  implode(',', array_fill(0, sizeof($chunk), '?'));
-
-			$query    = 'SELECT `userid`, `configvalue` ' .
-						'FROM `*PREFIX*preferences` ' .
-						'WHERE `appid` = ? AND `configkey` = ? ' .
-						'AND `userid` IN (' . $placeholders . ')';
-			$result = $this->connection->executeQuery($query, $queryParams);
-
-			while ($row = $result->fetch()) {
-				$userValues[$row['userid']] = $row['configvalue'];
-			}
-		}
-
-		return $userValues;
-	}
-
-	/**
-	 * Determines the users that have the given value set for a specific app-key-pair
-	 *
-	 * @param string $appName the app to get the user for
-	 * @param string $key the key to get the user for
-	 * @param string $value the value to get the user for
-	 * @return array of user IDs
-	 */
-	public function getUsersForUserValue($appName, $key, $value) {
-		// TODO - FIXME
-		$this->fixDIInit();
-
-		$sql  = 'SELECT `userid` FROM `*PREFIX*preferences` ' .
-				'WHERE `appid` = ? AND `configkey` = ? ';
-
-		if($this->getSystemValue('dbtype', 'sqlite') === 'oci') {
-			//oracle hack: need to explicitly cast CLOB to CHAR for comparison
-			$sql .= 'AND to_char(`configvalue`) = ?';
-		} else {
-			$sql .= 'AND `configvalue` = ?';
-		}
-
-		$result = $this->connection->executeQuery($sql, array($appName, $key, $value));
-
-		$userIDs = array();
-		while ($row = $result->fetch()) {
-			$userIDs[] = $row['userid'];
-		}
-
-		return $userIDs;
-	}
+    /** @var SystemConfig */
+    private $systemConfig;
+
+    /** @var IDBConnection */
+    private $connection;
+
+    /**
+     * 3 dimensional array with the following structure:
+     * [ $userId =>
+     *     [ $appId =>
+     *         [ $key => $value ]
+     *     ]
+     * ]
+     *
+     * database table: preferences
+     *
+     * methods that use this:
+     *   - setUserValue
+     *   - getUserValue
+     *   - getUserKeys
+     *   - deleteUserValue
+     *   - deleteAllUserValues
+     *   - deleteAppFromAllUsers
+     *
+     * @var CappedMemoryCache $userCache
+     */
+    private $userCache;
+
+    /**
+     * @param SystemConfig $systemConfig
+     */
+    function __construct(SystemConfig $systemConfig) {
+        $this->userCache = new CappedMemoryCache();
+        $this->systemConfig = $systemConfig;
+    }
+
+    /**
+     * TODO - FIXME This fixes an issue with base.php that cause cyclic
+     * dependencies, especially with autoconfig setup
+     *
+     * Replace this by properly injected database connection. Currently the
+     * base.php triggers the getDatabaseConnection too early which causes in
+     * autoconfig setup case a too early distributed database connection and
+     * the autoconfig then needs to reinit all already initialized dependencies
+     * that use the database connection.
+     *
+     * otherwise a SQLite database is created in the wrong directory
+     * because the database connection was created with an uninitialized config
+     */
+    private function fixDIInit() {
+        if($this->connection === null) {
+            $this->connection = \OC::$server->getDatabaseConnection();
+        }
+    }
+
+    /**
+     * Sets and deletes system wide values
+     *
+     * @param array $configs Associative array with `key => value` pairs
+     *                       If value is null, the config key will be deleted
+     */
+    public function setSystemValues(array $configs) {
+        $this->systemConfig->setValues($configs);
+    }
+
+    /**
+     * Sets a new system wide value
+     *
+     * @param string $key the key of the value, under which will be saved
+     * @param mixed $value the value that should be stored
+     */
+    public function setSystemValue($key, $value) {
+        $this->systemConfig->setValue($key, $value);
+    }
+
+    /**
+     * Looks up a system wide defined value
+     *
+     * @param string $key the key of the value, under which it was saved
+     * @param mixed $default the default value to be returned if the value isn't set
+     * @return mixed the value or $default
+     */
+    public function getSystemValue($key, $default = '') {
+        return $this->systemConfig->getValue($key, $default);
+    }
+
+    /**
+     * Looks up a system wide defined value and filters out sensitive data
+     *
+     * @param string $key the key of the value, under which it was saved
+     * @param mixed $default the default value to be returned if the value isn't set
+     * @return mixed the value or $default
+     */
+    public function getFilteredSystemValue($key, $default = '') {
+        return $this->systemConfig->getFilteredValue($key, $default);
+    }
+
+    /**
+     * Delete a system wide defined value
+     *
+     * @param string $key the key of the value, under which it was saved
+     */
+    public function deleteSystemValue($key) {
+        $this->systemConfig->deleteValue($key);
+    }
+
+    /**
+     * Get all keys stored for an app
+     *
+     * @param string $appName the appName that we stored the value under
+     * @return string[] the keys stored for the app
+     */
+    public function getAppKeys($appName) {
+        return \OC::$server->getAppConfig()->getKeys($appName);
+    }
+
+    /**
+     * Writes a new app wide value
+     *
+     * @param string $appName the appName that we want to store the value under
+     * @param string $key the key of the value, under which will be saved
+     * @param string $value the value that should be stored
+     */
+    public function setAppValue($appName, $key, $value) {
+        \OC::$server->getAppConfig()->setValue($appName, $key, $value);
+    }
+
+    /**
+     * Looks up an app wide defined value
+     *
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key of the value, under which it was saved
+     * @param string $default the default value to be returned if the value isn't set
+     * @return string the saved value
+     */
+    public function getAppValue($appName, $key, $default = '') {
+        return \OC::$server->getAppConfig()->getValue($appName, $key, $default);
+    }
+
+    /**
+     * Delete an app wide defined value
+     *
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key of the value, under which it was saved
+     */
+    public function deleteAppValue($appName, $key) {
+        \OC::$server->getAppConfig()->deleteKey($appName, $key);
+    }
+
+    /**
+     * Removes all keys in appconfig belonging to the app
+     *
+     * @param string $appName the appName the configs are stored under
+     */
+    public function deleteAppValues($appName) {
+        \OC::$server->getAppConfig()->deleteApp($appName);
+    }
+
+
+    /**
+     * Set a user defined value
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we want to store the value under
+     * @param string $key the key under which the value is being stored
+     * @param string $value the value that you want to store
+     * @param string $preCondition only update if the config value was previously the value passed as $preCondition
+     * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met
+     */
+    public function setUserValue($userId, $appName, $key, $value, $preCondition = null) {
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        $preconditionArray = [];
+        if (isset($preCondition)) {
+            $preconditionArray = [
+                'configvalue' => $preCondition,
+            ];
+        }
+
+        $this->connection->setValues('preferences', [
+            'userid' => $userId,
+            'appid' => $appName,
+            'configkey' => $key,
+        ], [
+            'configvalue' => $value,
+        ], $preconditionArray);
+
+        // only add to the cache if we already loaded data for the user
+        if (isset($this->userCache[$userId])) {
+            if (!isset($this->userCache[$userId][$appName])) {
+                $this->userCache[$userId][$appName] = array();
+            }
+            $this->userCache[$userId][$appName][$key] = $value;
+        }
+    }
+
+    /**
+     * Getting a user defined value
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key under which the value is being stored
+     * @param mixed $default the default value to be returned if the value isn't set
+     * @return string
+     */
+    public function getUserValue($userId, $appName, $key, $default = '') {
+        $data = $this->getUserValues($userId);
+        if (isset($data[$appName]) and isset($data[$appName][$key])) {
+            return $data[$appName][$key];
+        } else {
+            return $default;
+        }
+    }
+
+    /**
+     * Get the keys of all stored by an app for the user
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we stored the value under
+     * @return string[]
+     */
+    public function getUserKeys($userId, $appName) {
+        $data = $this->getUserValues($userId);
+        if (isset($data[$appName])) {
+            return array_keys($data[$appName]);
+        } else {
+            return array();
+        }
+    }
+
+    /**
+     * Delete a user value
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key under which the value is being stored
+     */
+    public function deleteUserValue($userId, $appName, $key) {
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        $sql  = 'DELETE FROM `*PREFIX*preferences` '.
+                'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?';
+        $this->connection->executeUpdate($sql, array($userId, $appName, $key));
+
+        if (isset($this->userCache[$userId]) and isset($this->userCache[$userId][$appName])) {
+            unset($this->userCache[$userId][$appName][$key]);
+        }
+    }
+
+    /**
+     * Delete all user values
+     *
+     * @param string $userId the userId of the user that we want to remove all values from
+     */
+    public function deleteAllUserValues($userId) {
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        $sql  = 'DELETE FROM `*PREFIX*preferences` '.
+            'WHERE `userid` = ?';
+        $this->connection->executeUpdate($sql, array($userId));
+
+        unset($this->userCache[$userId]);
+    }
+
+    /**
+     * Delete all user related values of one app
+     *
+     * @param string $appName the appName of the app that we want to remove all values from
+     */
+    public function deleteAppFromAllUsers($appName) {
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        $sql  = 'DELETE FROM `*PREFIX*preferences` '.
+                'WHERE `appid` = ?';
+        $this->connection->executeUpdate($sql, array($appName));
+
+        foreach ($this->userCache as &$userCache) {
+            unset($userCache[$appName]);
+        }
+    }
+
+    /**
+     * Returns all user configs sorted by app of one user
+     *
+     * @param string $userId the user ID to get the app configs from
+     * @return array[] - 2 dimensional array with the following structure:
+     *     [ $appId =>
+     *         [ $key => $value ]
+     *     ]
+     */
+    private function getUserValues($userId) {
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        if (isset($this->userCache[$userId])) {
+            return $this->userCache[$userId];
+        }
+        $data = array();
+        $query = 'SELECT `appid`, `configkey`, `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ?';
+        $result = $this->connection->executeQuery($query, array($userId));
+        while ($row = $result->fetch()) {
+            $appId = $row['appid'];
+            if (!isset($data[$appId])) {
+                $data[$appId] = array();
+            }
+            $data[$appId][$row['configkey']] = $row['configvalue'];
+        }
+        $this->userCache[$userId] = $data;
+        return $data;
+    }
+
+    /**
+     * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs.
+     *
+     * @param string $appName app to get the value for
+     * @param string $key the key to get the value for
+     * @param array $userIds the user IDs to fetch the values for
+     * @return array Mapped values: userId => value
+     */
+    public function getUserValueForUsers($appName, $key, $userIds) {
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        if (empty($userIds) || !is_array($userIds)) {
+            return array();
+        }
+
+        $chunkedUsers = array_chunk($userIds, 50, true);
+        $placeholders50 = implode(',', array_fill(0, 50, '?'));
+
+        $userValues = array();
+        foreach ($chunkedUsers as $chunk) {
+            $queryParams = $chunk;
+            // create [$app, $key, $chunkedUsers]
+            array_unshift($queryParams, $key);
+            array_unshift($queryParams, $appName);
+
+            $placeholders = (sizeof($chunk) == 50) ? $placeholders50 :  implode(',', array_fill(0, sizeof($chunk), '?'));
+
+            $query    = 'SELECT `userid`, `configvalue` ' .
+                        'FROM `*PREFIX*preferences` ' .
+                        'WHERE `appid` = ? AND `configkey` = ? ' .
+                        'AND `userid` IN (' . $placeholders . ')';
+            $result = $this->connection->executeQuery($query, $queryParams);
+
+            while ($row = $result->fetch()) {
+                $userValues[$row['userid']] = $row['configvalue'];
+            }
+        }
+
+        return $userValues;
+    }
+
+    /**
+     * Determines the users that have the given value set for a specific app-key-pair
+     *
+     * @param string $appName the app to get the user for
+     * @param string $key the key to get the user for
+     * @param string $value the value to get the user for
+     * @return array of user IDs
+     */
+    public function getUsersForUserValue($appName, $key, $value) {
+        // TODO - FIXME
+        $this->fixDIInit();
+
+        $sql  = 'SELECT `userid` FROM `*PREFIX*preferences` ' .
+                'WHERE `appid` = ? AND `configkey` = ? ';
+
+        if($this->getSystemValue('dbtype', 'sqlite') === 'oci') {
+            //oracle hack: need to explicitly cast CLOB to CHAR for comparison
+            $sql .= 'AND to_char(`configvalue`) = ?';
+        } else {
+            $sql .= 'AND `configvalue` = ?';
+        }
+
+        $result = $this->connection->executeQuery($sql, array($appName, $key, $value));
+
+        $userIDs = array();
+        while ($row = $result->fetch()) {
+            $userIDs[] = $row['userid'];
+        }
+
+        return $userIDs;
+    }
 }

Spacing +11 added lines, -11 removed lines

@@ -87,7 +87,7 @@ 
 	 * because the database connection was created with an uninitialized config
 	 */
 	private function fixDIInit() {
-		if($this->connection === null) {
+		if ($this->connection === null) {
 			$this->connection = \OC::$server->getDatabaseConnection();
 		}
 	}
@@ -284,7 +284,7 @@ 
 		// TODO - FIXME
 		$this->fixDIInit();
 
-		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
+		$sql = 'DELETE FROM `*PREFIX*preferences` '.
 				'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?';
 		$this->connection->executeUpdate($sql, array($userId, $appName, $key));
 
@@ -302,7 +302,7 @@ 
 		// TODO - FIXME
 		$this->fixDIInit();
 
-		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
+		$sql = 'DELETE FROM `*PREFIX*preferences` '.
 			'WHERE `userid` = ?';
 		$this->connection->executeUpdate($sql, array($userId));
 
@@ -318,7 +318,7 @@ 
 		// TODO - FIXME
 		$this->fixDIInit();
 
-		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
+		$sql = 'DELETE FROM `*PREFIX*preferences` '.
 				'WHERE `appid` = ?';
 		$this->connection->executeUpdate($sql, array($appName));
 
@@ -383,12 +383,12 @@ 
 			array_unshift($queryParams, $key);
 			array_unshift($queryParams, $appName);
 
-			$placeholders = (sizeof($chunk) == 50) ? $placeholders50 :  implode(',', array_fill(0, sizeof($chunk), '?'));
+			$placeholders = (sizeof($chunk) == 50) ? $placeholders50 : implode(',', array_fill(0, sizeof($chunk), '?'));
 
-			$query    = 'SELECT `userid`, `configvalue` ' .
-						'FROM `*PREFIX*preferences` ' .
-						'WHERE `appid` = ? AND `configkey` = ? ' .
-						'AND `userid` IN (' . $placeholders . ')';
+			$query = 'SELECT `userid`, `configvalue` '.
+						'FROM `*PREFIX*preferences` '.
+						'WHERE `appid` = ? AND `configkey` = ? '.
+						'AND `userid` IN ('.$placeholders.')';
 			$result = $this->connection->executeQuery($query, $queryParams);
 
 			while ($row = $result->fetch()) {
@@ -411,10 +411,10 @@ 
 		// TODO - FIXME
 		$this->fixDIInit();
 
-		$sql  = 'SELECT `userid` FROM `*PREFIX*preferences` ' .
+		$sql = 'SELECT `userid` FROM `*PREFIX*preferences` '.
 				'WHERE `appid` = ? AND `configkey` = ? ';
 
-		if($this->getSystemValue('dbtype', 'sqlite') === 'oci') {
+		if ($this->getSystemValue('dbtype', 'sqlite') === 'oci') {
 			//oracle hack: need to explicitly cast CLOB to CHAR for comparison
 			$sql .= 'AND to_char(`configvalue`) = ?';
 		} else {

lib/private/api.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +465 added lines, -465 removed lines

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

Spacing +33 added lines, -33 removed lines

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

lib/private/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 +331 added lines, -331 removed lines

@@ -41,335 +41,335 @@
 
 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();
-	}
-
-	/**
-	 * 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();
-	}
-
-	/**
-	 * 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".
-	 *
-	 * If no version was present in "appinfo/info.xml", reads it
-	 * from the external "appinfo/version" file instead.
-	 *
-	 * @param string $appId app id
-	 *
-	 * @return array app iinfo
-	 *
-	 * @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();
+    }
+
+    /**
+     * 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();
+    }
+
+    /**
+     * 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".
+     *
+     * If no version was present in "appinfo/info.xml", reads it
+     * from the external "appinfo/version" file instead.
+     *
+     * @param string $appId app id
+     *
+     * @return array app iinfo
+     *
+     * @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 +7 added lines, -7 removed lines

@@ -104,11 +104,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);
@@ -133,7 +133,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);
@@ -172,7 +172,7 @@ 
 		} elseif (is_null($user)) {
 			return false;
 		} else {
-			if(empty($enabled)){
+			if (empty($enabled)) {
 				return false;
 			}
 
@@ -180,7 +180,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;
 			}
 
@@ -235,7 +235,7 @@ 
 			}
 		}
 
-		$groupIds = array_map(function ($group) {
+		$groupIds = array_map(function($group) {
 			/** @var \OCP\IGroup $group */
 			return $group->getGID();
 		}, $groups);
@@ -353,7 +353,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 +48 added lines, -48 removed lines

@@ -35,59 +35,59 @@
  */
 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 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;
+    }
 }