nextcloud / server

lib/private/Group/Manager.php

Doc Comments +1 added lines, -1 removed lines

@@ -154,7 +154,7 @@
 
 	/**
 	 * @param string $gid
-	 * @return \OCP\IGroup
+	 * @return null|Group
 	 */
 	protected function getGroupObject($gid) {
 		$backends = array();

Spacing +12 added lines, -12 removed lines

@@ -85,20 +85,20 @@ 
 		$this->userManager = $userManager;
 		$cachedGroups = & $this->cachedGroups;
 		$cachedUserGroups = & $this->cachedUserGroups;
-		$this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
+		$this->listen('\OC\Group', 'postDelete', function($group) use (&$cachedGroups, &$cachedUserGroups) {
 			/**
 			 * @var \OC\Group\Group $group
 			 */
 			unset($cachedGroups[$group->getGID()]);
 			$cachedUserGroups = array();
 		});
-		$this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
+		$this->listen('\OC\Group', 'postAddUser', function($group) use (&$cachedUserGroups) {
 			/**
 			 * @var \OC\Group\Group $group
 			 */
 			$cachedUserGroups = array();
 		});
-		$this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
+		$this->listen('\OC\Group', 'postRemoveUser', function($group) use (&$cachedUserGroups) {
 			/**
 			 * @var \OC\Group\Group $group
 			 */
@@ -304,32 +304,32 @@ 
 	 */
 	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
 		$group = $this->get($gid);
-		if(is_null($group)) {
+		if (is_null($group)) {
 			return array();
 		}
 
 		$search = trim($search);
 		$groupUsers = array();
 
-		if(!empty($search)) {
+		if (!empty($search)) {
 			// only user backends have the capability to do a complex search for users
 			$searchOffset = 0;
 			$searchLimit = $limit * 100;
-			if($limit === -1) {
+			if ($limit === -1) {
 				$searchLimit = 500;
 			}
 
 			do {
 				$filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
-				foreach($filteredUsers as $filteredUser) {
-					if($group->inGroup($filteredUser)) {
-						$groupUsers[]= $filteredUser;
+				foreach ($filteredUsers as $filteredUser) {
+					if ($group->inGroup($filteredUser)) {
+						$groupUsers[] = $filteredUser;
 					}
 				}
 				$searchOffset += $searchLimit;
-			} while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
+			} while (count($groupUsers) < $searchLimit + $offset && count($filteredUsers) >= $searchLimit);
 
-			if($limit === -1) {
+			if ($limit === -1) {
 				$groupUsers = array_slice($groupUsers, $offset);
 			} else {
 				$groupUsers = array_slice($groupUsers, $offset, $limit);
@@ -339,7 +339,7 @@ 
 		}
 
 		$matchingUsers = array();
-		foreach($groupUsers as $groupUser) {
+		foreach ($groupUsers as $groupUser) {
 			$matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
 		}
 		return $matchingUsers;

Indentation +265 added lines, -265 removed lines

@@ -55,298 +55,298 @@
  * @package OC\Group
  */
 class Manager extends PublicEmitter implements IGroupManager {
-	/**
-	 * @var GroupInterface[] $backends
-	 */
-	private $backends = array();
+    /**
+     * @var GroupInterface[] $backends
+     */
+    private $backends = array();
 
-	/**
-	 * @var \OC\User\Manager $userManager
-	 */
-	private $userManager;
+    /**
+     * @var \OC\User\Manager $userManager
+     */
+    private $userManager;
 
-	/**
-	 * @var \OC\Group\Group[]
-	 */
-	private $cachedGroups = array();
+    /**
+     * @var \OC\Group\Group[]
+     */
+    private $cachedGroups = array();
 
-	/**
-	 * @var \OC\Group\Group[]
-	 */
-	private $cachedUserGroups = array();
+    /**
+     * @var \OC\Group\Group[]
+     */
+    private $cachedUserGroups = array();
 
-	/** @var \OC\SubAdmin */
-	private $subAdmin = null;
+    /** @var \OC\SubAdmin */
+    private $subAdmin = null;
 
-	/**
-	 * @param \OC\User\Manager $userManager
-	 */
-	public function __construct(\OC\User\Manager $userManager) {
-		$this->userManager = $userManager;
-		$cachedGroups = & $this->cachedGroups;
-		$cachedUserGroups = & $this->cachedUserGroups;
-		$this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
-			/**
-			 * @var \OC\Group\Group $group
-			 */
-			unset($cachedGroups[$group->getGID()]);
-			$cachedUserGroups = array();
-		});
-		$this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
-			/**
-			 * @var \OC\Group\Group $group
-			 */
-			$cachedUserGroups = array();
-		});
-		$this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
-			/**
-			 * @var \OC\Group\Group $group
-			 */
-			$cachedUserGroups = array();
-		});
-	}
+    /**
+     * @param \OC\User\Manager $userManager
+     */
+    public function __construct(\OC\User\Manager $userManager) {
+        $this->userManager = $userManager;
+        $cachedGroups = & $this->cachedGroups;
+        $cachedUserGroups = & $this->cachedUserGroups;
+        $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
+            /**
+             * @var \OC\Group\Group $group
+             */
+            unset($cachedGroups[$group->getGID()]);
+            $cachedUserGroups = array();
+        });
+        $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
+            /**
+             * @var \OC\Group\Group $group
+             */
+            $cachedUserGroups = array();
+        });
+        $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
+            /**
+             * @var \OC\Group\Group $group
+             */
+            $cachedUserGroups = array();
+        });
+    }
 
-	/**
-	 * Checks whether a given backend is used
-	 *
-	 * @param string $backendClass Full classname including complete namespace
-	 * @return bool
-	 */
-	public function isBackendUsed($backendClass) {
-		$backendClass = strtolower(ltrim($backendClass, '\\'));
+    /**
+     * Checks whether a given backend is used
+     *
+     * @param string $backendClass Full classname including complete namespace
+     * @return bool
+     */
+    public function isBackendUsed($backendClass) {
+        $backendClass = strtolower(ltrim($backendClass, '\\'));
 
-		foreach ($this->backends as $backend) {
-			if (strtolower(get_class($backend)) === $backendClass) {
-				return true;
-			}
-		}
+        foreach ($this->backends as $backend) {
+            if (strtolower(get_class($backend)) === $backendClass) {
+                return true;
+            }
+        }
 
-		return false;
-	}
+        return false;
+    }
 
-	/**
-	 * @param \OCP\GroupInterface $backend
-	 */
-	public function addBackend($backend) {
-		$this->backends[] = $backend;
-		$this->clearCaches();
-	}
+    /**
+     * @param \OCP\GroupInterface $backend
+     */
+    public function addBackend($backend) {
+        $this->backends[] = $backend;
+        $this->clearCaches();
+    }
 
-	public function clearBackends() {
-		$this->backends = array();
-		$this->clearCaches();
-	}
+    public function clearBackends() {
+        $this->backends = array();
+        $this->clearCaches();
+    }
 	
-	protected function clearCaches() {
-		$this->cachedGroups = array();
-		$this->cachedUserGroups = array();
-	}
+    protected function clearCaches() {
+        $this->cachedGroups = array();
+        $this->cachedUserGroups = array();
+    }
 
-	/**
-	 * @param string $gid
-	 * @return \OC\Group\Group
-	 */
-	public function get($gid) {
-		if (isset($this->cachedGroups[$gid])) {
-			return $this->cachedGroups[$gid];
-		}
-		return $this->getGroupObject($gid);
-	}
+    /**
+     * @param string $gid
+     * @return \OC\Group\Group
+     */
+    public function get($gid) {
+        if (isset($this->cachedGroups[$gid])) {
+            return $this->cachedGroups[$gid];
+        }
+        return $this->getGroupObject($gid);
+    }
 
-	/**
-	 * @param string $gid
-	 * @return \OCP\IGroup
-	 */
-	protected function getGroupObject($gid) {
-		$backends = array();
-		foreach ($this->backends as $backend) {
-			if ($backend->groupExists($gid)) {
-				$backends[] = $backend;
-			}
-		}
-		if (count($backends) === 0) {
-			return null;
-		}
-		$this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this);
-		return $this->cachedGroups[$gid];
-	}
+    /**
+     * @param string $gid
+     * @return \OCP\IGroup
+     */
+    protected function getGroupObject($gid) {
+        $backends = array();
+        foreach ($this->backends as $backend) {
+            if ($backend->groupExists($gid)) {
+                $backends[] = $backend;
+            }
+        }
+        if (count($backends) === 0) {
+            return null;
+        }
+        $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this);
+        return $this->cachedGroups[$gid];
+    }
 
-	/**
-	 * @param string $gid
-	 * @return bool
-	 */
-	public function groupExists($gid) {
-		return !is_null($this->get($gid));
-	}
+    /**
+     * @param string $gid
+     * @return bool
+     */
+    public function groupExists($gid) {
+        return !is_null($this->get($gid));
+    }
 
-	/**
-	 * @param string $gid
-	 * @return \OC\Group\Group
-	 */
-	public function createGroup($gid) {
-		if ($gid === '' || is_null($gid)) {
-			return false;
-		} else if ($group = $this->get($gid)) {
-			return $group;
-		} else {
-			$this->emit('\OC\Group', 'preCreate', array($gid));
-			foreach ($this->backends as $backend) {
-				if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) {
-					$backend->createGroup($gid);
-					$group = $this->getGroupObject($gid);
-					$this->emit('\OC\Group', 'postCreate', array($group));
-					return $group;
-				}
-			}
-			return null;
-		}
-	}
+    /**
+     * @param string $gid
+     * @return \OC\Group\Group
+     */
+    public function createGroup($gid) {
+        if ($gid === '' || is_null($gid)) {
+            return false;
+        } else if ($group = $this->get($gid)) {
+            return $group;
+        } else {
+            $this->emit('\OC\Group', 'preCreate', array($gid));
+            foreach ($this->backends as $backend) {
+                if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) {
+                    $backend->createGroup($gid);
+                    $group = $this->getGroupObject($gid);
+                    $this->emit('\OC\Group', 'postCreate', array($group));
+                    return $group;
+                }
+            }
+            return null;
+        }
+    }
 
-	/**
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OC\Group\Group[]
-	 */
-	public function search($search, $limit = null, $offset = null) {
-		$groups = array();
-		foreach ($this->backends as $backend) {
-			$groupIds = $backend->getGroups($search, $limit, $offset);
-			foreach ($groupIds as $groupId) {
-				$groups[$groupId] = $this->get($groupId);
-			}
-			if (!is_null($limit) and $limit <= 0) {
-				return array_values($groups);
-			}
-		}
-		return array_values($groups);
-	}
+    /**
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return \OC\Group\Group[]
+     */
+    public function search($search, $limit = null, $offset = null) {
+        $groups = array();
+        foreach ($this->backends as $backend) {
+            $groupIds = $backend->getGroups($search, $limit, $offset);
+            foreach ($groupIds as $groupId) {
+                $groups[$groupId] = $this->get($groupId);
+            }
+            if (!is_null($limit) and $limit <= 0) {
+                return array_values($groups);
+            }
+        }
+        return array_values($groups);
+    }
 
-	/**
-	 * @param \OC\User\User|null $user
-	 * @return \OC\Group\Group[]
-	 */
-	public function getUserGroups($user) {
-		if (is_null($user)) {
-			return [];
-		}
-		return $this->getUserIdGroups($user->getUID());
-	}
+    /**
+     * @param \OC\User\User|null $user
+     * @return \OC\Group\Group[]
+     */
+    public function getUserGroups($user) {
+        if (is_null($user)) {
+            return [];
+        }
+        return $this->getUserIdGroups($user->getUID());
+    }
 
-	/**
-	 * @param string $uid the user id
-	 * @return \OC\Group\Group[]
-	 */
-	public function getUserIdGroups($uid) {
-		if (isset($this->cachedUserGroups[$uid])) {
-			return $this->cachedUserGroups[$uid];
-		}
-		$groups = array();
-		foreach ($this->backends as $backend) {
-			$groupIds = $backend->getUserGroups($uid);
-			if (is_array($groupIds)) {
-				foreach ($groupIds as $groupId) {
-					$groups[$groupId] = $this->get($groupId);
-				}
-			}
-		}
-		$this->cachedUserGroups[$uid] = $groups;
-		return $this->cachedUserGroups[$uid];
-	}
+    /**
+     * @param string $uid the user id
+     * @return \OC\Group\Group[]
+     */
+    public function getUserIdGroups($uid) {
+        if (isset($this->cachedUserGroups[$uid])) {
+            return $this->cachedUserGroups[$uid];
+        }
+        $groups = array();
+        foreach ($this->backends as $backend) {
+            $groupIds = $backend->getUserGroups($uid);
+            if (is_array($groupIds)) {
+                foreach ($groupIds as $groupId) {
+                    $groups[$groupId] = $this->get($groupId);
+                }
+            }
+        }
+        $this->cachedUserGroups[$uid] = $groups;
+        return $this->cachedUserGroups[$uid];
+    }
 
-	/**
-	 * Checks if a userId is in the admin group
-	 * @param string $userId
-	 * @return bool if admin
-	 */
-	public function isAdmin($userId) {
-		return $this->isInGroup($userId, 'admin');
-	}
+    /**
+     * Checks if a userId is in the admin group
+     * @param string $userId
+     * @return bool if admin
+     */
+    public function isAdmin($userId) {
+        return $this->isInGroup($userId, 'admin');
+    }
 
-	/**
-	 * Checks if a userId is in a group
-	 * @param string $userId
-	 * @param string $group
-	 * @return bool if in group
-	 */
-	public function isInGroup($userId, $group) {
-		return array_key_exists($group, $this->getUserIdGroups($userId));
-	}
+    /**
+     * Checks if a userId is in a group
+     * @param string $userId
+     * @param string $group
+     * @return bool if in group
+     */
+    public function isInGroup($userId, $group) {
+        return array_key_exists($group, $this->getUserIdGroups($userId));
+    }
 
-	/**
-	 * get a list of group ids for a user
-	 * @param \OC\User\User $user
-	 * @return array with group ids
-	 */
-	public function getUserGroupIds($user) {
-		return array_map(function($value) {
-			return (string) $value;
-		}, array_keys($this->getUserGroups($user)));
-	}
+    /**
+     * get a list of group ids for a user
+     * @param \OC\User\User $user
+     * @return array with group ids
+     */
+    public function getUserGroupIds($user) {
+        return array_map(function($value) {
+            return (string) $value;
+        }, array_keys($this->getUserGroups($user)));
+    }
 
-	/**
-	 * get a list of all display names in a group
-	 * @param string $gid
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of display names (value) and user ids (key)
-	 */
-	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
-		$group = $this->get($gid);
-		if(is_null($group)) {
-			return array();
-		}
+    /**
+     * get a list of all display names in a group
+     * @param string $gid
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of display names (value) and user ids (key)
+     */
+    public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
+        $group = $this->get($gid);
+        if(is_null($group)) {
+            return array();
+        }
 
-		$search = trim($search);
-		$groupUsers = array();
+        $search = trim($search);
+        $groupUsers = array();
 
-		if(!empty($search)) {
-			// only user backends have the capability to do a complex search for users
-			$searchOffset = 0;
-			$searchLimit = $limit * 100;
-			if($limit === -1) {
-				$searchLimit = 500;
-			}
+        if(!empty($search)) {
+            // only user backends have the capability to do a complex search for users
+            $searchOffset = 0;
+            $searchLimit = $limit * 100;
+            if($limit === -1) {
+                $searchLimit = 500;
+            }
 
-			do {
-				$filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
-				foreach($filteredUsers as $filteredUser) {
-					if($group->inGroup($filteredUser)) {
-						$groupUsers[]= $filteredUser;
-					}
-				}
-				$searchOffset += $searchLimit;
-			} while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
+            do {
+                $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
+                foreach($filteredUsers as $filteredUser) {
+                    if($group->inGroup($filteredUser)) {
+                        $groupUsers[]= $filteredUser;
+                    }
+                }
+                $searchOffset += $searchLimit;
+            } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
 
-			if($limit === -1) {
-				$groupUsers = array_slice($groupUsers, $offset);
-			} else {
-				$groupUsers = array_slice($groupUsers, $offset, $limit);
-			}
-		} else {
-			$groupUsers = $group->searchUsers('', $limit, $offset);
-		}
+            if($limit === -1) {
+                $groupUsers = array_slice($groupUsers, $offset);
+            } else {
+                $groupUsers = array_slice($groupUsers, $offset, $limit);
+            }
+        } else {
+            $groupUsers = $group->searchUsers('', $limit, $offset);
+        }
 
-		$matchingUsers = array();
-		foreach($groupUsers as $groupUser) {
-			$matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
-		}
-		return $matchingUsers;
-	}
+        $matchingUsers = array();
+        foreach($groupUsers as $groupUser) {
+            $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
+        }
+        return $matchingUsers;
+    }
 
-	/**
-	 * @return \OC\SubAdmin
-	 */
-	public function getSubAdmin() {
-		if (!$this->subAdmin) {
-			$this->subAdmin = new \OC\SubAdmin(
-				$this->userManager,
-				$this,
-				\OC::$server->getDatabaseConnection()
-			);
-		}
+    /**
+     * @return \OC\SubAdmin
+     */
+    public function getSubAdmin() {
+        if (!$this->subAdmin) {
+            $this->subAdmin = new \OC\SubAdmin(
+                $this->userManager,
+                $this,
+                \OC::$server->getDatabaseConnection()
+            );
+        }
 
-		return $this->subAdmin;
-	}
+        return $this->subAdmin;
+    }
 }

lib/private/Installer.php

Doc Comments +1 added lines, -1 removed lines

@@ -482,7 +482,7 @@
 
 	/**
 	 * Removes an app
-	 * @param string $name name of the application to remove
+	 * @param string $appId
 	 * @return boolean
 	 *
 	 *

Indentation +586 added lines, -586 removed lines

@@ -53,590 +53,590 @@
  */
 class Installer {
 
-	/**
-	 *
-	 * This function installs an app. All information needed are passed in the
-	 * associative array $data.
-	 * The following keys are required:
-	 *   - source: string, can be "path" or "http"
-	 *
-	 * One of the following keys is required:
-	 *   - path: path to the file containing the app
-	 *   - href: link to the downloadable file containing the app
-	 *
-	 * The following keys are optional:
-	 *   - pretend: boolean, if set true the system won't do anything
-	 *   - noinstall: boolean, if true appinfo/install.php won't be loaded
-	 *   - inactive: boolean, if set true the appconfig/app.sample.php won't be
-	 *     renamed
-	 *
-	 * This function works as follows
-	 *   -# fetching the file
-	 *   -# unzipping it
-	 *   -# check the code
-	 *   -# installing the database at appinfo/database.xml
-	 *   -# including appinfo/install.php
-	 *   -# setting the installed version
-	 *
-	 * It is the task of oc_app_install to create the tables and do whatever is
-	 * needed to get the app working.
-	 *
-	 * Installs an app
-	 * @param array $data with all information
-	 * @throws \Exception
-	 * @return integer
-	 */
-	public static function installApp( $data = array()) {
-		$l = \OC::$server->getL10N('lib');
-
-		list($extractDir, $path) = self::downloadApp($data);
-
-		$info = self::checkAppsIntegrity($data, $extractDir, $path);
-		$appId = OC_App::cleanAppId($info['id']);
-		$basedir = OC_App::getInstallPath().'/'.$appId;
-		//check if the destination directory already exists
-		if(is_dir($basedir)) {
-			OC_Helper::rmdirr($extractDir);
-			if($data['source']=='http') {
-				unlink($path);
-			}
-			throw new \Exception($l->t("App directory already exists"));
-		}
-
-		if(!empty($data['pretent'])) {
-			return false;
-		}
-
-		//copy the app to the correct place
-		if(@!mkdir($basedir)) {
-			OC_Helper::rmdirr($extractDir);
-			if($data['source']=='http') {
-				unlink($path);
-			}
-			throw new \Exception($l->t("Can't create app folder. Please fix permissions. %s", array($basedir)));
-		}
-
-		$extractDir .= '/' . $info['id'];
-		if(!file_exists($extractDir)) {
-			OC_Helper::rmdirr($basedir);
-			throw new \Exception($l->t("Archive does not contain a directory named %s", $info['id']));
-		}
-		OC_Helper::copyr($extractDir, $basedir);
-
-		//remove temporary files
-		OC_Helper::rmdirr($extractDir);
-
-		//install the database
-		if(is_file($basedir.'/appinfo/database.xml')) {
-			if (\OC::$server->getAppConfig()->getValue($info['id'], 'installed_version') === null) {
-				OC_DB::createDbFromStructure($basedir.'/appinfo/database.xml');
-			} else {
-				OC_DB::updateDbFromStructure($basedir.'/appinfo/database.xml');
-			}
-		}
-
-		\OC_App::setupBackgroundJobs($info['background-jobs']);
-
-		//run appinfo/install.php
-		if((!isset($data['noinstall']) or $data['noinstall']==false)) {
-			self::includeAppScript($basedir . '/appinfo/install.php');
-		}
-
-		$appData = OC_App::getAppInfo($appId);
-		OC_App::executeRepairSteps($appId, $appData['repair-steps']['install']);
-
-		//set the installed version
-		\OC::$server->getConfig()->setAppValue($info['id'], 'installed_version', OC_App::getAppVersion($info['id']));
-		\OC::$server->getConfig()->setAppValue($info['id'], 'enabled', 'no');
-
-		//set remote/public handlers
-		foreach($info['remote'] as $name=>$path) {
-			\OC::$server->getConfig()->setAppValue('core', 'remote_'.$name, $info['id'].'/'.$path);
-		}
-		foreach($info['public'] as $name=>$path) {
-			\OC::$server->getConfig()->setAppValue('core', 'public_'.$name, $info['id'].'/'.$path);
-		}
-
-		OC_App::setAppTypes($info['id']);
-
-		return $info['id'];
-	}
-
-	/**
-	 * @brief checks whether or not an app is installed
-	 * @param string $app app
-	 * @returns bool
-	 *
-	 * Checks whether or not an app is installed, i.e. registered in apps table.
-	 */
-	public static function 	isInstalled( $app ) {
-		return (\OC::$server->getConfig()->getAppValue($app, "installed_version", null) !== null);
-	}
-
-	/**
-	 * @brief Update an application
-	 * @param array $info
-	 * @param bool $isShipped
-	 * @throws \Exception
-	 * @return bool
-	 *
-	 * This function could work like described below, but currently it disables and then
-	 * enables the app again. This does result in an updated app.
-	 *
-	 *
-	 * This function installs an app. All information needed are passed in the
-	 * associative array $info.
-	 * The following keys are required:
-	 *   - source: string, can be "path" or "http"
-	 *
-	 * One of the following keys is required:
-	 *   - path: path to the file containing the app
-	 *   - href: link to the downloadable file containing the app
-	 *
-	 * The following keys are optional:
-	 *   - pretend: boolean, if set true the system won't do anything
-	 *   - noupgrade: boolean, if true appinfo/upgrade.php won't be loaded
-	 *
-	 * This function works as follows
-	 *   -# fetching the file
-	 *   -# removing the old files
-	 *   -# unzipping new file
-	 *   -# including appinfo/upgrade.php
-	 *   -# setting the installed version
-	 *
-	 * upgrade.php can determine the current installed version of the app using
-	 * "\OC::$server->getAppConfig()->getValue($appid, 'installed_version')"
-	 */
-	public static function updateApp($info=array(), $isShipped=false) {
-		list($extractDir, $path) = self::downloadApp($info);
-		$info = self::checkAppsIntegrity($info, $extractDir, $path, $isShipped);
-
-		$currentDir = OC_App::getAppPath($info['id']);
-		$basedir  = OC_App::getInstallPath();
-		$basedir .= '/';
-		$basedir .= $info['id'];
-
-		if($currentDir !== false && is_writable($currentDir)) {
-			$basedir = $currentDir;
-		}
-		if(is_dir($basedir)) {
-			OC_Helper::rmdirr($basedir);
-		}
-
-		$appInExtractDir = $extractDir;
-		if (substr($extractDir, -1) !== '/') {
-			$appInExtractDir .= '/';
-		}
-
-		$appInExtractDir .= $info['id'];
-		OC_Helper::copyr($appInExtractDir, $basedir);
-		OC_Helper::rmdirr($extractDir);
-
-		return OC_App::updateApp($info['id']);
-	}
-
-	/**
-	 * update an app by it's id
-	 *
-	 * @param integer $ocsId
-	 * @return bool
-	 * @throws \Exception
-	 */
-	public static function updateAppByOCSId($ocsId) {
-		$ocsClient = new OCSClient(
-			\OC::$server->getHTTPClientService(),
-			\OC::$server->getConfig(),
-			\OC::$server->getLogger()
-		);
-		$appData = $ocsClient->getApplication($ocsId, \OCP\Util::getVersion());
-		$download = $ocsClient->getApplicationDownload($ocsId, \OCP\Util::getVersion());
-
-		if (isset($download['downloadlink']) && trim($download['downloadlink']) !== '') {
-			$download['downloadlink'] = str_replace(' ', '%20', $download['downloadlink']);
-			$info = array(
-				'source' => 'http',
-				'href' => $download['downloadlink'],
-				'appdata' => $appData
-			);
-		} else {
-			throw new \Exception('Could not fetch app info!');
-		}
-
-		return self::updateApp($info);
-	}
-
-	/**
-	 * @param array $data
-	 * @return array
-	 * @throws \Exception
-	 */
-	public static function downloadApp($data = array()) {
-		$l = \OC::$server->getL10N('lib');
-
-		if(!isset($data['source'])) {
-			throw new \Exception($l->t("No source specified when installing app"));
-		}
-
-		//download the file if necessary
-		if($data['source']=='http') {
-			$pathInfo = pathinfo($data['href']);
-			$extension = isset($pathInfo['extension']) ? '.' . $pathInfo['extension'] : '';
-			$path = \OC::$server->getTempManager()->getTemporaryFile($extension);
-			if(!isset($data['href'])) {
-				throw new \Exception($l->t("No href specified when installing app from http"));
-			}
-			$client = \OC::$server->getHTTPClientService()->newClient();
-			$client->get($data['href'], ['save_to' => $path]);
-		} else {
-			if(!isset($data['path'])) {
-				throw new \Exception($l->t("No path specified when installing app from local file"));
-			}
-			$path=$data['path'];
-		}
-
-		//detect the archive type
-		$mime = \OC::$server->getMimeTypeDetector()->detect($path);
-		if ($mime !=='application/zip' && $mime !== 'application/x-gzip' && $mime !== 'application/x-bzip2') {
-			throw new \Exception($l->t("Archives of type %s are not supported", array($mime)));
-		}
-
-		//extract the archive in a temporary folder
-		$extractDir = \OC::$server->getTempManager()->getTemporaryFolder();
-		OC_Helper::rmdirr($extractDir);
-		mkdir($extractDir);
-		if($archive=\OC\Archive\Archive::open($path)) {
-			$archive->extract($extractDir);
-		} else {
-			OC_Helper::rmdirr($extractDir);
-			if($data['source']=='http') {
-				unlink($path);
-			}
-			throw new \Exception($l->t("Failed to open archive when installing app"));
-		}
-
-		return array(
-			$extractDir,
-			$path
-		);
-	}
-
-	/**
-	 * check an app's integrity
-	 * @param array $data
-	 * @param string $extractDir
-	 * @param string $path
-	 * @param bool $isShipped
-	 * @return array
-	 * @throws \Exception
-	 */
-	public static function checkAppsIntegrity($data, $extractDir, $path, $isShipped = false) {
-		$l = \OC::$server->getL10N('lib');
-		//load the info.xml file of the app
-		if(!is_file($extractDir.'/appinfo/info.xml')) {
-			//try to find it in a subdir
-			$dh=opendir($extractDir);
-			if(is_resource($dh)) {
-				while (($folder = readdir($dh)) !== false) {
-					if($folder[0]!='.' and is_dir($extractDir.'/'.$folder)) {
-						if(is_file($extractDir.'/'.$folder.'/appinfo/info.xml')) {
-							$extractDir.='/'.$folder;
-						}
-					}
-				}
-			}
-		}
-		if(!is_file($extractDir.'/appinfo/info.xml')) {
-			OC_Helper::rmdirr($extractDir);
-			if($data['source'] === 'http') {
-				unlink($path);
-			}
-			throw new \Exception($l->t("App does not provide an info.xml file"));
-		}
-
-		$info = OC_App::getAppInfo($extractDir.'/appinfo/info.xml', true);
-		if(!is_array($info)) {
-			throw new \Exception($l->t('App cannot be installed because appinfo file cannot be read.'));
-		}
-
-		// We can't trust the parsed info.xml file as it may have been tampered
-		// with by an attacker and thus we need to use the local data to check
-		// whether the application needs to be signed.
-		$appId = OC_App::cleanAppId($data['appdata']['id']);
-		$appBelongingToId = OC_App::getInternalAppIdByOcs($appId);
-		if(is_string($appBelongingToId)) {
-			$previouslySigned = \OC::$server->getConfig()->getAppValue($appBelongingToId, 'signed', 'false');
-		} else {
-			$appBelongingToId = $info['id'];
-			$previouslySigned = 'false';
-		}
-		if($data['appdata']['level'] === OC_App::officialApp || $previouslySigned === 'true') {
-			\OC::$server->getConfig()->setAppValue($appBelongingToId, 'signed', 'true');
-			$integrityResult = \OC::$server->getIntegrityCodeChecker()->verifyAppSignature(
-					$appBelongingToId,
-					$extractDir
-			);
-			if($integrityResult !== []) {
-				$e = new \Exception(
-						$l->t(
-								'Signature could not get checked. Please contact the app developer and check your admin screen.'
-						)
-				);
-				throw $e;
-			}
-		}
-
-		// check the code for not allowed calls
-		if(!$isShipped && !Installer::checkCode($extractDir)) {
-			OC_Helper::rmdirr($extractDir);
-			throw new \Exception($l->t("App can't be installed because of not allowed code in the App"));
-		}
-
-		// check if the app is compatible with this version of ownCloud
-		if(!OC_App::isAppCompatible(\OCP\Util::getVersion(), $info)) {
-			OC_Helper::rmdirr($extractDir);
-			throw new \Exception($l->t("App can't be installed because it is not compatible with this version of the server"));
-		}
-
-		// check if shipped tag is set which is only allowed for apps that are shipped with ownCloud
-		if(!$isShipped && isset($info['shipped']) && ($info['shipped']=='true')) {
-			OC_Helper::rmdirr($extractDir);
-			throw new \Exception($l->t("App can't be installed because it contains the <shipped>true</shipped> tag which is not allowed for non shipped apps"));
-		}
-
-		// check if the ocs version is the same as the version in info.xml/version
-		$version = trim($info['version']);
-
-		if(isset($data['appdata']['version']) && $version<>trim($data['appdata']['version'])) {
-			OC_Helper::rmdirr($extractDir);
-			throw new \Exception($l->t("App can't be installed because the version in info.xml is not the same as the version reported from the app store"));
-		}
-
-		return $info;
-	}
-
-	/**
-	 * Check if an update for the app is available
-	 * @param string $app
-	 * @return string|false false or the version number of the update
-	 *
-	 * The function will check if an update for a version is available
-	 */
-	public static function isUpdateAvailable( $app ) {
-		static $isInstanceReadyForUpdates = null;
-
-		if ($isInstanceReadyForUpdates === null) {
-			$installPath = OC_App::getInstallPath();
-			if ($installPath === false || $installPath === null) {
-				$isInstanceReadyForUpdates = false;
-			} else {
-				$isInstanceReadyForUpdates = true;
-			}
-		}
-
-		if ($isInstanceReadyForUpdates === false) {
-			return false;
-		}
-
-		$ocsid=\OC::$server->getAppConfig()->getValue( $app, 'ocsid', '');
-
-		if($ocsid<>'') {
-			$ocsClient = new OCSClient(
-				\OC::$server->getHTTPClientService(),
-				\OC::$server->getConfig(),
-				\OC::$server->getLogger()
-			);
-			$ocsdata = $ocsClient->getApplication($ocsid, \OCP\Util::getVersion());
-			$ocsversion= (string) $ocsdata['version'];
-			$currentversion=OC_App::getAppVersion($app);
-			if (version_compare($ocsversion, $currentversion, '>')) {
-				return($ocsversion);
-			}else{
-				return false;
-			}
-
-		}else{
-			return false;
-		}
-
-	}
-
-	/**
-	 * Check if app is already downloaded
-	 * @param string $name name of the application to remove
-	 * @return boolean
-	 *
-	 * The function will check if the app is already downloaded in the apps repository
-	 */
-	public static function isDownloaded( $name ) {
-		foreach(\OC::$APPSROOTS as $dir) {
-			$dirToTest  = $dir['path'];
-			$dirToTest .= '/';
-			$dirToTest .= $name;
-			$dirToTest .= '/';
-
-			if (is_dir($dirToTest)) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Removes an app
-	 * @param string $name name of the application to remove
-	 * @return boolean
-	 *
-	 *
-	 * This function works as follows
-	 *   -# call uninstall repair steps
-	 *   -# removing the files
-	 *
-	 * The function will not delete preferences, tables and the configuration,
-	 * this has to be done by the function oc_app_uninstall().
-	 */
-	public static function removeApp($appId) {
-
-		if(Installer::isDownloaded( $appId )) {
-			$appDir=OC_App::getInstallPath() . '/' . $appId;
-			OC_Helper::rmdirr($appDir);
-
-			return true;
-		}else{
-			\OCP\Util::writeLog('core', 'can\'t remove app '.$appId.'. It is not installed.', \OCP\Util::ERROR);
-
-			return false;
-		}
-
-	}
-
-	/**
-	 * Installs shipped apps
-	 *
-	 * This function installs all apps found in the 'apps' directory that should be enabled by default;
-	 * @param bool $softErrors When updating we ignore errors and simply log them, better to have a
-	 *                         working ownCloud at the end instead of an aborted update.
-	 * @return array Array of error messages (appid => Exception)
-	 */
-	public static function installShippedApps($softErrors = false) {
-		$errors = [];
-		foreach(\OC::$APPSROOTS as $app_dir) {
-			if($dir = opendir( $app_dir['path'] )) {
-				while( false !== ( $filename = readdir( $dir ))) {
-					if( substr( $filename, 0, 1 ) != '.' and is_dir($app_dir['path']."/$filename") ) {
-						if( file_exists( $app_dir['path']."/$filename/appinfo/info.xml" )) {
-							if(!Installer::isInstalled($filename)) {
-								$info=OC_App::getAppInfo($filename);
-								$enabled = isset($info['default_enable']);
-								if (($enabled || in_array($filename, \OC::$server->getAppManager()->getAlwaysEnabledApps()))
-									  && \OC::$server->getConfig()->getAppValue($filename, 'enabled') !== 'no') {
-									if ($softErrors) {
-										try {
-											Installer::installShippedApp($filename);
-										} catch (HintException $e) {
-											if ($e->getPrevious() instanceof TableExistsException) {
-												$errors[$filename] = $e;
-												continue;
-											}
-											throw $e;
-										}
-									} else {
-										Installer::installShippedApp($filename);
-									}
-									\OC::$server->getConfig()->setAppValue($filename, 'enabled', 'yes');
-								}
-							}
-						}
-					}
-				}
-				closedir( $dir );
-			}
-		}
-
-		return $errors;
-	}
-
-	/**
-	 * install an app already placed in the app folder
-	 * @param string $app id of the app to install
-	 * @return integer
-	 */
-	public static function installShippedApp($app) {
-		//install the database
-		$appPath = OC_App::getAppPath($app);
-		if(is_file("$appPath/appinfo/database.xml")) {
-			try {
-				OC_DB::createDbFromStructure("$appPath/appinfo/database.xml");
-			} catch (TableExistsException $e) {
-				throw new HintException(
-					'Failed to enable app ' . $app,
-					'Please ask for help via one of our <a href="https://nextcloud.com/support/" target="_blank" rel="noreferrer">support channels</a>.',
-					0, $e
-				);
-			}
-		}
-
-		//run appinfo/install.php
-		\OC_App::registerAutoloading($app, $appPath);
-		self::includeAppScript("$appPath/appinfo/install.php");
-
-		$info = OC_App::getAppInfo($app);
-		if (is_null($info)) {
-			return false;
-		}
-		\OC_App::setupBackgroundJobs($info['background-jobs']);
-
-		OC_App::executeRepairSteps($app, $info['repair-steps']['install']);
-
-		$config = \OC::$server->getConfig();
-
-		$config->setAppValue($app, 'installed_version', OC_App::getAppVersion($app));
-		if (array_key_exists('ocsid', $info)) {
-			$config->setAppValue($app, 'ocsid', $info['ocsid']);
-		}
-
-		//set remote/public handlers
-		foreach($info['remote'] as $name=>$path) {
-			$config->setAppValue('core', 'remote_'.$name, $app.'/'.$path);
-		}
-		foreach($info['public'] as $name=>$path) {
-			$config->setAppValue('core', 'public_'.$name, $app.'/'.$path);
-		}
-
-		OC_App::setAppTypes($info['id']);
-
-		if(isset($info['settings']) && is_array($info['settings'])) {
-			// requires that autoloading was registered for the app,
-			// as happens before running the install.php some lines above
-			\OC::$server->getSettingsManager()->setupSettings($info['settings']);
-		}
-
-		return $info['id'];
-	}
-
-	/**
-	 * check the code of an app with some static code checks
-	 * @param string $folder the folder of the app to check
-	 * @return boolean true for app is o.k. and false for app is not o.k.
-	 */
-	public static function checkCode($folder) {
-		// is the code checker enabled?
-		if(!\OC::$server->getConfig()->getSystemValue('appcodechecker', false)) {
-			return true;
-		}
-
-		$codeChecker = new CodeChecker(new PrivateCheck(new EmptyCheck()));
-		$errors = $codeChecker->analyseFolder(basename($folder), $folder);
-
-		return empty($errors);
-	}
-
-	/**
-	 * @param $basedir
-	 */
-	private static function includeAppScript($script) {
-		if ( file_exists($script) ){
-			include $script;
-		}
-	}
+    /**
+     *
+     * This function installs an app. All information needed are passed in the
+     * associative array $data.
+     * The following keys are required:
+     *   - source: string, can be "path" or "http"
+     *
+     * One of the following keys is required:
+     *   - path: path to the file containing the app
+     *   - href: link to the downloadable file containing the app
+     *
+     * The following keys are optional:
+     *   - pretend: boolean, if set true the system won't do anything
+     *   - noinstall: boolean, if true appinfo/install.php won't be loaded
+     *   - inactive: boolean, if set true the appconfig/app.sample.php won't be
+     *     renamed
+     *
+     * This function works as follows
+     *   -# fetching the file
+     *   -# unzipping it
+     *   -# check the code
+     *   -# installing the database at appinfo/database.xml
+     *   -# including appinfo/install.php
+     *   -# setting the installed version
+     *
+     * It is the task of oc_app_install to create the tables and do whatever is
+     * needed to get the app working.
+     *
+     * Installs an app
+     * @param array $data with all information
+     * @throws \Exception
+     * @return integer
+     */
+    public static function installApp( $data = array()) {
+        $l = \OC::$server->getL10N('lib');
+
+        list($extractDir, $path) = self::downloadApp($data);
+
+        $info = self::checkAppsIntegrity($data, $extractDir, $path);
+        $appId = OC_App::cleanAppId($info['id']);
+        $basedir = OC_App::getInstallPath().'/'.$appId;
+        //check if the destination directory already exists
+        if(is_dir($basedir)) {
+            OC_Helper::rmdirr($extractDir);
+            if($data['source']=='http') {
+                unlink($path);
+            }
+            throw new \Exception($l->t("App directory already exists"));
+        }
+
+        if(!empty($data['pretent'])) {
+            return false;
+        }
+
+        //copy the app to the correct place
+        if(@!mkdir($basedir)) {
+            OC_Helper::rmdirr($extractDir);
+            if($data['source']=='http') {
+                unlink($path);
+            }
+            throw new \Exception($l->t("Can't create app folder. Please fix permissions. %s", array($basedir)));
+        }
+
+        $extractDir .= '/' . $info['id'];
+        if(!file_exists($extractDir)) {
+            OC_Helper::rmdirr($basedir);
+            throw new \Exception($l->t("Archive does not contain a directory named %s", $info['id']));
+        }
+        OC_Helper::copyr($extractDir, $basedir);
+
+        //remove temporary files
+        OC_Helper::rmdirr($extractDir);
+
+        //install the database
+        if(is_file($basedir.'/appinfo/database.xml')) {
+            if (\OC::$server->getAppConfig()->getValue($info['id'], 'installed_version') === null) {
+                OC_DB::createDbFromStructure($basedir.'/appinfo/database.xml');
+            } else {
+                OC_DB::updateDbFromStructure($basedir.'/appinfo/database.xml');
+            }
+        }
+
+        \OC_App::setupBackgroundJobs($info['background-jobs']);
+
+        //run appinfo/install.php
+        if((!isset($data['noinstall']) or $data['noinstall']==false)) {
+            self::includeAppScript($basedir . '/appinfo/install.php');
+        }
+
+        $appData = OC_App::getAppInfo($appId);
+        OC_App::executeRepairSteps($appId, $appData['repair-steps']['install']);
+
+        //set the installed version
+        \OC::$server->getConfig()->setAppValue($info['id'], 'installed_version', OC_App::getAppVersion($info['id']));
+        \OC::$server->getConfig()->setAppValue($info['id'], 'enabled', 'no');
+
+        //set remote/public handlers
+        foreach($info['remote'] as $name=>$path) {
+            \OC::$server->getConfig()->setAppValue('core', 'remote_'.$name, $info['id'].'/'.$path);
+        }
+        foreach($info['public'] as $name=>$path) {
+            \OC::$server->getConfig()->setAppValue('core', 'public_'.$name, $info['id'].'/'.$path);
+        }
+
+        OC_App::setAppTypes($info['id']);
+
+        return $info['id'];
+    }
+
+    /**
+     * @brief checks whether or not an app is installed
+     * @param string $app app
+     * @returns bool
+     *
+     * Checks whether or not an app is installed, i.e. registered in apps table.
+     */
+    public static function 	isInstalled( $app ) {
+        return (\OC::$server->getConfig()->getAppValue($app, "installed_version", null) !== null);
+    }
+
+    /**
+     * @brief Update an application
+     * @param array $info
+     * @param bool $isShipped
+     * @throws \Exception
+     * @return bool
+     *
+     * This function could work like described below, but currently it disables and then
+     * enables the app again. This does result in an updated app.
+     *
+     *
+     * This function installs an app. All information needed are passed in the
+     * associative array $info.
+     * The following keys are required:
+     *   - source: string, can be "path" or "http"
+     *
+     * One of the following keys is required:
+     *   - path: path to the file containing the app
+     *   - href: link to the downloadable file containing the app
+     *
+     * The following keys are optional:
+     *   - pretend: boolean, if set true the system won't do anything
+     *   - noupgrade: boolean, if true appinfo/upgrade.php won't be loaded
+     *
+     * This function works as follows
+     *   -# fetching the file
+     *   -# removing the old files
+     *   -# unzipping new file
+     *   -# including appinfo/upgrade.php
+     *   -# setting the installed version
+     *
+     * upgrade.php can determine the current installed version of the app using
+     * "\OC::$server->getAppConfig()->getValue($appid, 'installed_version')"
+     */
+    public static function updateApp($info=array(), $isShipped=false) {
+        list($extractDir, $path) = self::downloadApp($info);
+        $info = self::checkAppsIntegrity($info, $extractDir, $path, $isShipped);
+
+        $currentDir = OC_App::getAppPath($info['id']);
+        $basedir  = OC_App::getInstallPath();
+        $basedir .= '/';
+        $basedir .= $info['id'];
+
+        if($currentDir !== false && is_writable($currentDir)) {
+            $basedir = $currentDir;
+        }
+        if(is_dir($basedir)) {
+            OC_Helper::rmdirr($basedir);
+        }
+
+        $appInExtractDir = $extractDir;
+        if (substr($extractDir, -1) !== '/') {
+            $appInExtractDir .= '/';
+        }
+
+        $appInExtractDir .= $info['id'];
+        OC_Helper::copyr($appInExtractDir, $basedir);
+        OC_Helper::rmdirr($extractDir);
+
+        return OC_App::updateApp($info['id']);
+    }
+
+    /**
+     * update an app by it's id
+     *
+     * @param integer $ocsId
+     * @return bool
+     * @throws \Exception
+     */
+    public static function updateAppByOCSId($ocsId) {
+        $ocsClient = new OCSClient(
+            \OC::$server->getHTTPClientService(),
+            \OC::$server->getConfig(),
+            \OC::$server->getLogger()
+        );
+        $appData = $ocsClient->getApplication($ocsId, \OCP\Util::getVersion());
+        $download = $ocsClient->getApplicationDownload($ocsId, \OCP\Util::getVersion());
+
+        if (isset($download['downloadlink']) && trim($download['downloadlink']) !== '') {
+            $download['downloadlink'] = str_replace(' ', '%20', $download['downloadlink']);
+            $info = array(
+                'source' => 'http',
+                'href' => $download['downloadlink'],
+                'appdata' => $appData
+            );
+        } else {
+            throw new \Exception('Could not fetch app info!');
+        }
+
+        return self::updateApp($info);
+    }
+
+    /**
+     * @param array $data
+     * @return array
+     * @throws \Exception
+     */
+    public static function downloadApp($data = array()) {
+        $l = \OC::$server->getL10N('lib');
+
+        if(!isset($data['source'])) {
+            throw new \Exception($l->t("No source specified when installing app"));
+        }
+
+        //download the file if necessary
+        if($data['source']=='http') {
+            $pathInfo = pathinfo($data['href']);
+            $extension = isset($pathInfo['extension']) ? '.' . $pathInfo['extension'] : '';
+            $path = \OC::$server->getTempManager()->getTemporaryFile($extension);
+            if(!isset($data['href'])) {
+                throw new \Exception($l->t("No href specified when installing app from http"));
+            }
+            $client = \OC::$server->getHTTPClientService()->newClient();
+            $client->get($data['href'], ['save_to' => $path]);
+        } else {
+            if(!isset($data['path'])) {
+                throw new \Exception($l->t("No path specified when installing app from local file"));
+            }
+            $path=$data['path'];
+        }
+
+        //detect the archive type
+        $mime = \OC::$server->getMimeTypeDetector()->detect($path);
+        if ($mime !=='application/zip' && $mime !== 'application/x-gzip' && $mime !== 'application/x-bzip2') {
+            throw new \Exception($l->t("Archives of type %s are not supported", array($mime)));
+        }
+
+        //extract the archive in a temporary folder
+        $extractDir = \OC::$server->getTempManager()->getTemporaryFolder();
+        OC_Helper::rmdirr($extractDir);
+        mkdir($extractDir);
+        if($archive=\OC\Archive\Archive::open($path)) {
+            $archive->extract($extractDir);
+        } else {
+            OC_Helper::rmdirr($extractDir);
+            if($data['source']=='http') {
+                unlink($path);
+            }
+            throw new \Exception($l->t("Failed to open archive when installing app"));
+        }
+
+        return array(
+            $extractDir,
+            $path
+        );
+    }
+
+    /**
+     * check an app's integrity
+     * @param array $data
+     * @param string $extractDir
+     * @param string $path
+     * @param bool $isShipped
+     * @return array
+     * @throws \Exception
+     */
+    public static function checkAppsIntegrity($data, $extractDir, $path, $isShipped = false) {
+        $l = \OC::$server->getL10N('lib');
+        //load the info.xml file of the app
+        if(!is_file($extractDir.'/appinfo/info.xml')) {
+            //try to find it in a subdir
+            $dh=opendir($extractDir);
+            if(is_resource($dh)) {
+                while (($folder = readdir($dh)) !== false) {
+                    if($folder[0]!='.' and is_dir($extractDir.'/'.$folder)) {
+                        if(is_file($extractDir.'/'.$folder.'/appinfo/info.xml')) {
+                            $extractDir.='/'.$folder;
+                        }
+                    }
+                }
+            }
+        }
+        if(!is_file($extractDir.'/appinfo/info.xml')) {
+            OC_Helper::rmdirr($extractDir);
+            if($data['source'] === 'http') {
+                unlink($path);
+            }
+            throw new \Exception($l->t("App does not provide an info.xml file"));
+        }
+
+        $info = OC_App::getAppInfo($extractDir.'/appinfo/info.xml', true);
+        if(!is_array($info)) {
+            throw new \Exception($l->t('App cannot be installed because appinfo file cannot be read.'));
+        }
+
+        // We can't trust the parsed info.xml file as it may have been tampered
+        // with by an attacker and thus we need to use the local data to check
+        // whether the application needs to be signed.
+        $appId = OC_App::cleanAppId($data['appdata']['id']);
+        $appBelongingToId = OC_App::getInternalAppIdByOcs($appId);
+        if(is_string($appBelongingToId)) {
+            $previouslySigned = \OC::$server->getConfig()->getAppValue($appBelongingToId, 'signed', 'false');
+        } else {
+            $appBelongingToId = $info['id'];
+            $previouslySigned = 'false';
+        }
+        if($data['appdata']['level'] === OC_App::officialApp || $previouslySigned === 'true') {
+            \OC::$server->getConfig()->setAppValue($appBelongingToId, 'signed', 'true');
+            $integrityResult = \OC::$server->getIntegrityCodeChecker()->verifyAppSignature(
+                    $appBelongingToId,
+                    $extractDir
+            );
+            if($integrityResult !== []) {
+                $e = new \Exception(
+                        $l->t(
+                                'Signature could not get checked. Please contact the app developer and check your admin screen.'
+                        )
+                );
+                throw $e;
+            }
+        }
+
+        // check the code for not allowed calls
+        if(!$isShipped && !Installer::checkCode($extractDir)) {
+            OC_Helper::rmdirr($extractDir);
+            throw new \Exception($l->t("App can't be installed because of not allowed code in the App"));
+        }
+
+        // check if the app is compatible with this version of ownCloud
+        if(!OC_App::isAppCompatible(\OCP\Util::getVersion(), $info)) {
+            OC_Helper::rmdirr($extractDir);
+            throw new \Exception($l->t("App can't be installed because it is not compatible with this version of the server"));
+        }
+
+        // check if shipped tag is set which is only allowed for apps that are shipped with ownCloud
+        if(!$isShipped && isset($info['shipped']) && ($info['shipped']=='true')) {
+            OC_Helper::rmdirr($extractDir);
+            throw new \Exception($l->t("App can't be installed because it contains the <shipped>true</shipped> tag which is not allowed for non shipped apps"));
+        }
+
+        // check if the ocs version is the same as the version in info.xml/version
+        $version = trim($info['version']);
+
+        if(isset($data['appdata']['version']) && $version<>trim($data['appdata']['version'])) {
+            OC_Helper::rmdirr($extractDir);
+            throw new \Exception($l->t("App can't be installed because the version in info.xml is not the same as the version reported from the app store"));
+        }
+
+        return $info;
+    }
+
+    /**
+     * Check if an update for the app is available
+     * @param string $app
+     * @return string|false false or the version number of the update
+     *
+     * The function will check if an update for a version is available
+     */
+    public static function isUpdateAvailable( $app ) {
+        static $isInstanceReadyForUpdates = null;
+
+        if ($isInstanceReadyForUpdates === null) {
+            $installPath = OC_App::getInstallPath();
+            if ($installPath === false || $installPath === null) {
+                $isInstanceReadyForUpdates = false;
+            } else {
+                $isInstanceReadyForUpdates = true;
+            }
+        }
+
+        if ($isInstanceReadyForUpdates === false) {
+            return false;
+        }
+
+        $ocsid=\OC::$server->getAppConfig()->getValue( $app, 'ocsid', '');
+
+        if($ocsid<>'') {
+            $ocsClient = new OCSClient(
+                \OC::$server->getHTTPClientService(),
+                \OC::$server->getConfig(),
+                \OC::$server->getLogger()
+            );
+            $ocsdata = $ocsClient->getApplication($ocsid, \OCP\Util::getVersion());
+            $ocsversion= (string) $ocsdata['version'];
+            $currentversion=OC_App::getAppVersion($app);
+            if (version_compare($ocsversion, $currentversion, '>')) {
+                return($ocsversion);
+            }else{
+                return false;
+            }
+
+        }else{
+            return false;
+        }
+
+    }
+
+    /**
+     * Check if app is already downloaded
+     * @param string $name name of the application to remove
+     * @return boolean
+     *
+     * The function will check if the app is already downloaded in the apps repository
+     */
+    public static function isDownloaded( $name ) {
+        foreach(\OC::$APPSROOTS as $dir) {
+            $dirToTest  = $dir['path'];
+            $dirToTest .= '/';
+            $dirToTest .= $name;
+            $dirToTest .= '/';
+
+            if (is_dir($dirToTest)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Removes an app
+     * @param string $name name of the application to remove
+     * @return boolean
+     *
+     *
+     * This function works as follows
+     *   -# call uninstall repair steps
+     *   -# removing the files
+     *
+     * The function will not delete preferences, tables and the configuration,
+     * this has to be done by the function oc_app_uninstall().
+     */
+    public static function removeApp($appId) {
+
+        if(Installer::isDownloaded( $appId )) {
+            $appDir=OC_App::getInstallPath() . '/' . $appId;
+            OC_Helper::rmdirr($appDir);
+
+            return true;
+        }else{
+            \OCP\Util::writeLog('core', 'can\'t remove app '.$appId.'. It is not installed.', \OCP\Util::ERROR);
+
+            return false;
+        }
+
+    }
+
+    /**
+     * Installs shipped apps
+     *
+     * This function installs all apps found in the 'apps' directory that should be enabled by default;
+     * @param bool $softErrors When updating we ignore errors and simply log them, better to have a
+     *                         working ownCloud at the end instead of an aborted update.
+     * @return array Array of error messages (appid => Exception)
+     */
+    public static function installShippedApps($softErrors = false) {
+        $errors = [];
+        foreach(\OC::$APPSROOTS as $app_dir) {
+            if($dir = opendir( $app_dir['path'] )) {
+                while( false !== ( $filename = readdir( $dir ))) {
+                    if( substr( $filename, 0, 1 ) != '.' and is_dir($app_dir['path']."/$filename") ) {
+                        if( file_exists( $app_dir['path']."/$filename/appinfo/info.xml" )) {
+                            if(!Installer::isInstalled($filename)) {
+                                $info=OC_App::getAppInfo($filename);
+                                $enabled = isset($info['default_enable']);
+                                if (($enabled || in_array($filename, \OC::$server->getAppManager()->getAlwaysEnabledApps()))
+                                      && \OC::$server->getConfig()->getAppValue($filename, 'enabled') !== 'no') {
+                                    if ($softErrors) {
+                                        try {
+                                            Installer::installShippedApp($filename);
+                                        } catch (HintException $e) {
+                                            if ($e->getPrevious() instanceof TableExistsException) {
+                                                $errors[$filename] = $e;
+                                                continue;
+                                            }
+                                            throw $e;
+                                        }
+                                    } else {
+                                        Installer::installShippedApp($filename);
+                                    }
+                                    \OC::$server->getConfig()->setAppValue($filename, 'enabled', 'yes');
+                                }
+                            }
+                        }
+                    }
+                }
+                closedir( $dir );
+            }
+        }
+
+        return $errors;
+    }
+
+    /**
+     * install an app already placed in the app folder
+     * @param string $app id of the app to install
+     * @return integer
+     */
+    public static function installShippedApp($app) {
+        //install the database
+        $appPath = OC_App::getAppPath($app);
+        if(is_file("$appPath/appinfo/database.xml")) {
+            try {
+                OC_DB::createDbFromStructure("$appPath/appinfo/database.xml");
+            } catch (TableExistsException $e) {
+                throw new HintException(
+                    'Failed to enable app ' . $app,
+                    'Please ask for help via one of our <a href="https://nextcloud.com/support/" target="_blank" rel="noreferrer">support channels</a>.',
+                    0, $e
+                );
+            }
+        }
+
+        //run appinfo/install.php
+        \OC_App::registerAutoloading($app, $appPath);
+        self::includeAppScript("$appPath/appinfo/install.php");
+
+        $info = OC_App::getAppInfo($app);
+        if (is_null($info)) {
+            return false;
+        }
+        \OC_App::setupBackgroundJobs($info['background-jobs']);
+
+        OC_App::executeRepairSteps($app, $info['repair-steps']['install']);
+
+        $config = \OC::$server->getConfig();
+
+        $config->setAppValue($app, 'installed_version', OC_App::getAppVersion($app));
+        if (array_key_exists('ocsid', $info)) {
+            $config->setAppValue($app, 'ocsid', $info['ocsid']);
+        }
+
+        //set remote/public handlers
+        foreach($info['remote'] as $name=>$path) {
+            $config->setAppValue('core', 'remote_'.$name, $app.'/'.$path);
+        }
+        foreach($info['public'] as $name=>$path) {
+            $config->setAppValue('core', 'public_'.$name, $app.'/'.$path);
+        }
+
+        OC_App::setAppTypes($info['id']);
+
+        if(isset($info['settings']) && is_array($info['settings'])) {
+            // requires that autoloading was registered for the app,
+            // as happens before running the install.php some lines above
+            \OC::$server->getSettingsManager()->setupSettings($info['settings']);
+        }
+
+        return $info['id'];
+    }
+
+    /**
+     * check the code of an app with some static code checks
+     * @param string $folder the folder of the app to check
+     * @return boolean true for app is o.k. and false for app is not o.k.
+     */
+    public static function checkCode($folder) {
+        // is the code checker enabled?
+        if(!\OC::$server->getConfig()->getSystemValue('appcodechecker', false)) {
+            return true;
+        }
+
+        $codeChecker = new CodeChecker(new PrivateCheck(new EmptyCheck()));
+        $errors = $codeChecker->analyseFolder(basename($folder), $folder);
+
+        return empty($errors);
+    }
+
+    /**
+     * @param $basedir
+     */
+    private static function includeAppScript($script) {
+        if ( file_exists($script) ){
+            include $script;
+        }
+    }
 }

Spacing +69 added lines, -69 removed lines

@@ -86,7 +86,7 @@ 
 	 * @throws \Exception
 	 * @return integer
 	 */
-	public static function installApp( $data = array()) {
+	public static function installApp($data = array()) {
 		$l = \OC::$server->getL10N('lib');
 
 		list($extractDir, $path) = self::downloadApp($data);
@@ -95,29 +95,29 @@ 
 		$appId = OC_App::cleanAppId($info['id']);
 		$basedir = OC_App::getInstallPath().'/'.$appId;
 		//check if the destination directory already exists
-		if(is_dir($basedir)) {
+		if (is_dir($basedir)) {
 			OC_Helper::rmdirr($extractDir);
-			if($data['source']=='http') {
+			if ($data['source'] == 'http') {
 				unlink($path);
 			}
 			throw new \Exception($l->t("App directory already exists"));
 		}
 
-		if(!empty($data['pretent'])) {
+		if (!empty($data['pretent'])) {
 			return false;
 		}
 
 		//copy the app to the correct place
-		if(@!mkdir($basedir)) {
+		if (@!mkdir($basedir)) {
 			OC_Helper::rmdirr($extractDir);
-			if($data['source']=='http') {
+			if ($data['source'] == 'http') {
 				unlink($path);
 			}
 			throw new \Exception($l->t("Can't create app folder. Please fix permissions. %s", array($basedir)));
 		}
 
-		$extractDir .= '/' . $info['id'];
-		if(!file_exists($extractDir)) {
+		$extractDir .= '/'.$info['id'];
+		if (!file_exists($extractDir)) {
 			OC_Helper::rmdirr($basedir);
 			throw new \Exception($l->t("Archive does not contain a directory named %s", $info['id']));
 		}
@@ -127,7 +127,7 @@ 
 		OC_Helper::rmdirr($extractDir);
 
 		//install the database
-		if(is_file($basedir.'/appinfo/database.xml')) {
+		if (is_file($basedir.'/appinfo/database.xml')) {
 			if (\OC::$server->getAppConfig()->getValue($info['id'], 'installed_version') === null) {
 				OC_DB::createDbFromStructure($basedir.'/appinfo/database.xml');
 			} else {
@@ -138,8 +138,8 @@ 
 		\OC_App::setupBackgroundJobs($info['background-jobs']);
 
 		//run appinfo/install.php
-		if((!isset($data['noinstall']) or $data['noinstall']==false)) {
-			self::includeAppScript($basedir . '/appinfo/install.php');
+		if ((!isset($data['noinstall']) or $data['noinstall'] == false)) {
+			self::includeAppScript($basedir.'/appinfo/install.php');
 		}
 
 		$appData = OC_App::getAppInfo($appId);
@@ -150,10 +150,10 @@ 
 		\OC::$server->getConfig()->setAppValue($info['id'], 'enabled', 'no');
 
 		//set remote/public handlers
-		foreach($info['remote'] as $name=>$path) {
+		foreach ($info['remote'] as $name=>$path) {
 			\OC::$server->getConfig()->setAppValue('core', 'remote_'.$name, $info['id'].'/'.$path);
 		}
-		foreach($info['public'] as $name=>$path) {
+		foreach ($info['public'] as $name=>$path) {
 			\OC::$server->getConfig()->setAppValue('core', 'public_'.$name, $info['id'].'/'.$path);
 		}
 
@@ -169,7 +169,7 @@ 
 	 *
 	 * Checks whether or not an app is installed, i.e. registered in apps table.
 	 */
-	public static function 	isInstalled( $app ) {
+	public static function 	isInstalled($app) {
 		return (\OC::$server->getConfig()->getAppValue($app, "installed_version", null) !== null);
 	}
 
@@ -207,7 +207,7 @@ 
 	 * upgrade.php can determine the current installed version of the app using
 	 * "\OC::$server->getAppConfig()->getValue($appid, 'installed_version')"
 	 */
-	public static function updateApp($info=array(), $isShipped=false) {
+	public static function updateApp($info = array(), $isShipped = false) {
 		list($extractDir, $path) = self::downloadApp($info);
 		$info = self::checkAppsIntegrity($info, $extractDir, $path, $isShipped);
 
@@ -216,10 +216,10 @@ 
 		$basedir .= '/';
 		$basedir .= $info['id'];
 
-		if($currentDir !== false && is_writable($currentDir)) {
+		if ($currentDir !== false && is_writable($currentDir)) {
 			$basedir = $currentDir;
 		}
-		if(is_dir($basedir)) {
+		if (is_dir($basedir)) {
 			OC_Helper::rmdirr($basedir);
 		}
 
@@ -273,30 +273,30 @@ 
 	public static function downloadApp($data = array()) {
 		$l = \OC::$server->getL10N('lib');
 
-		if(!isset($data['source'])) {
+		if (!isset($data['source'])) {
 			throw new \Exception($l->t("No source specified when installing app"));
 		}
 
 		//download the file if necessary
-		if($data['source']=='http') {
+		if ($data['source'] == 'http') {
 			$pathInfo = pathinfo($data['href']);
-			$extension = isset($pathInfo['extension']) ? '.' . $pathInfo['extension'] : '';
+			$extension = isset($pathInfo['extension']) ? '.'.$pathInfo['extension'] : '';
 			$path = \OC::$server->getTempManager()->getTemporaryFile($extension);
-			if(!isset($data['href'])) {
+			if (!isset($data['href'])) {
 				throw new \Exception($l->t("No href specified when installing app from http"));
 			}
 			$client = \OC::$server->getHTTPClientService()->newClient();
 			$client->get($data['href'], ['save_to' => $path]);
 		} else {
-			if(!isset($data['path'])) {
+			if (!isset($data['path'])) {
 				throw new \Exception($l->t("No path specified when installing app from local file"));
 			}
-			$path=$data['path'];
+			$path = $data['path'];
 		}
 
 		//detect the archive type
 		$mime = \OC::$server->getMimeTypeDetector()->detect($path);
-		if ($mime !=='application/zip' && $mime !== 'application/x-gzip' && $mime !== 'application/x-bzip2') {
+		if ($mime !== 'application/zip' && $mime !== 'application/x-gzip' && $mime !== 'application/x-bzip2') {
 			throw new \Exception($l->t("Archives of type %s are not supported", array($mime)));
 		}
 
@@ -304,11 +304,11 @@ 
 		$extractDir = \OC::$server->getTempManager()->getTemporaryFolder();
 		OC_Helper::rmdirr($extractDir);
 		mkdir($extractDir);
-		if($archive=\OC\Archive\Archive::open($path)) {
+		if ($archive = \OC\Archive\Archive::open($path)) {
 			$archive->extract($extractDir);
 		} else {
 			OC_Helper::rmdirr($extractDir);
-			if($data['source']=='http') {
+			if ($data['source'] == 'http') {
 				unlink($path);
 			}
 			throw new \Exception($l->t("Failed to open archive when installing app"));
@@ -332,29 +332,29 @@ 
 	public static function checkAppsIntegrity($data, $extractDir, $path, $isShipped = false) {
 		$l = \OC::$server->getL10N('lib');
 		//load the info.xml file of the app
-		if(!is_file($extractDir.'/appinfo/info.xml')) {
+		if (!is_file($extractDir.'/appinfo/info.xml')) {
 			//try to find it in a subdir
-			$dh=opendir($extractDir);
-			if(is_resource($dh)) {
+			$dh = opendir($extractDir);
+			if (is_resource($dh)) {
 				while (($folder = readdir($dh)) !== false) {
-					if($folder[0]!='.' and is_dir($extractDir.'/'.$folder)) {
-						if(is_file($extractDir.'/'.$folder.'/appinfo/info.xml')) {
-							$extractDir.='/'.$folder;
+					if ($folder[0] != '.' and is_dir($extractDir.'/'.$folder)) {
+						if (is_file($extractDir.'/'.$folder.'/appinfo/info.xml')) {
+							$extractDir .= '/'.$folder;
 						}
 					}
 				}
 			}
 		}
-		if(!is_file($extractDir.'/appinfo/info.xml')) {
+		if (!is_file($extractDir.'/appinfo/info.xml')) {
 			OC_Helper::rmdirr($extractDir);
-			if($data['source'] === 'http') {
+			if ($data['source'] === 'http') {
 				unlink($path);
 			}
 			throw new \Exception($l->t("App does not provide an info.xml file"));
 		}
 
 		$info = OC_App::getAppInfo($extractDir.'/appinfo/info.xml', true);
-		if(!is_array($info)) {
+		if (!is_array($info)) {
 			throw new \Exception($l->t('App cannot be installed because appinfo file cannot be read.'));
 		}
 
@@ -363,19 +363,19 @@ 
 		// whether the application needs to be signed.
 		$appId = OC_App::cleanAppId($data['appdata']['id']);
 		$appBelongingToId = OC_App::getInternalAppIdByOcs($appId);
-		if(is_string($appBelongingToId)) {
+		if (is_string($appBelongingToId)) {
 			$previouslySigned = \OC::$server->getConfig()->getAppValue($appBelongingToId, 'signed', 'false');
 		} else {
 			$appBelongingToId = $info['id'];
 			$previouslySigned = 'false';
 		}
-		if($data['appdata']['level'] === OC_App::officialApp || $previouslySigned === 'true') {
+		if ($data['appdata']['level'] === OC_App::officialApp || $previouslySigned === 'true') {
 			\OC::$server->getConfig()->setAppValue($appBelongingToId, 'signed', 'true');
 			$integrityResult = \OC::$server->getIntegrityCodeChecker()->verifyAppSignature(
 					$appBelongingToId,
 					$extractDir
 			);
-			if($integrityResult !== []) {
+			if ($integrityResult !== []) {
 				$e = new \Exception(
 						$l->t(
 								'Signature could not get checked. Please contact the app developer and check your admin screen.'
@@ -386,19 +386,19 @@ 
 		}
 
 		// check the code for not allowed calls
-		if(!$isShipped && !Installer::checkCode($extractDir)) {
+		if (!$isShipped && !Installer::checkCode($extractDir)) {
 			OC_Helper::rmdirr($extractDir);
 			throw new \Exception($l->t("App can't be installed because of not allowed code in the App"));
 		}
 
 		// check if the app is compatible with this version of ownCloud
-		if(!OC_App::isAppCompatible(\OCP\Util::getVersion(), $info)) {
+		if (!OC_App::isAppCompatible(\OCP\Util::getVersion(), $info)) {
 			OC_Helper::rmdirr($extractDir);
 			throw new \Exception($l->t("App can't be installed because it is not compatible with this version of the server"));
 		}
 
 		// check if shipped tag is set which is only allowed for apps that are shipped with ownCloud
-		if(!$isShipped && isset($info['shipped']) && ($info['shipped']=='true')) {
+		if (!$isShipped && isset($info['shipped']) && ($info['shipped'] == 'true')) {
 			OC_Helper::rmdirr($extractDir);
 			throw new \Exception($l->t("App can't be installed because it contains the <shipped>true</shipped> tag which is not allowed for non shipped apps"));
 		}
@@ -406,7 +406,7 @@ 
 		// check if the ocs version is the same as the version in info.xml/version
 		$version = trim($info['version']);
 
-		if(isset($data['appdata']['version']) && $version<>trim($data['appdata']['version'])) {
+		if (isset($data['appdata']['version']) && $version <> trim($data['appdata']['version'])) {
 			OC_Helper::rmdirr($extractDir);
 			throw new \Exception($l->t("App can't be installed because the version in info.xml is not the same as the version reported from the app store"));
 		}
@@ -421,7 +421,7 @@ 
 	 *
 	 * The function will check if an update for a version is available
 	 */
-	public static function isUpdateAvailable( $app ) {
+	public static function isUpdateAvailable($app) {
 		static $isInstanceReadyForUpdates = null;
 
 		if ($isInstanceReadyForUpdates === null) {
@@ -437,24 +437,24 @@ 
 			return false;
 		}
 
-		$ocsid=\OC::$server->getAppConfig()->getValue( $app, 'ocsid', '');
+		$ocsid = \OC::$server->getAppConfig()->getValue($app, 'ocsid', '');
 
-		if($ocsid<>'') {
+		if ($ocsid <> '') {
 			$ocsClient = new OCSClient(
 				\OC::$server->getHTTPClientService(),
 				\OC::$server->getConfig(),
 				\OC::$server->getLogger()
 			);
 			$ocsdata = $ocsClient->getApplication($ocsid, \OCP\Util::getVersion());
-			$ocsversion= (string) $ocsdata['version'];
-			$currentversion=OC_App::getAppVersion($app);
+			$ocsversion = (string) $ocsdata['version'];
+			$currentversion = OC_App::getAppVersion($app);
 			if (version_compare($ocsversion, $currentversion, '>')) {
 				return($ocsversion);
-			}else{
+			} else {
 				return false;
 			}
 
-		}else{
+		} else {
 			return false;
 		}
 
@@ -467,8 +467,8 @@ 
 	 *
 	 * The function will check if the app is already downloaded in the apps repository
 	 */
-	public static function isDownloaded( $name ) {
-		foreach(\OC::$APPSROOTS as $dir) {
+	public static function isDownloaded($name) {
+		foreach (\OC::$APPSROOTS as $dir) {
 			$dirToTest  = $dir['path'];
 			$dirToTest .= '/';
 			$dirToTest .= $name;
@@ -497,12 +497,12 @@ 
 	 */
 	public static function removeApp($appId) {
 
-		if(Installer::isDownloaded( $appId )) {
-			$appDir=OC_App::getInstallPath() . '/' . $appId;
+		if (Installer::isDownloaded($appId)) {
+			$appDir = OC_App::getInstallPath().'/'.$appId;
 			OC_Helper::rmdirr($appDir);
 
 			return true;
-		}else{
+		} else {
 			\OCP\Util::writeLog('core', 'can\'t remove app '.$appId.'. It is not installed.', \OCP\Util::ERROR);
 
 			return false;
@@ -520,13 +520,13 @@ 
 	 */
 	public static function installShippedApps($softErrors = false) {
 		$errors = [];
-		foreach(\OC::$APPSROOTS as $app_dir) {
-			if($dir = opendir( $app_dir['path'] )) {
-				while( false !== ( $filename = readdir( $dir ))) {
-					if( substr( $filename, 0, 1 ) != '.' and is_dir($app_dir['path']."/$filename") ) {
-						if( file_exists( $app_dir['path']."/$filename/appinfo/info.xml" )) {
-							if(!Installer::isInstalled($filename)) {
-								$info=OC_App::getAppInfo($filename);
+		foreach (\OC::$APPSROOTS as $app_dir) {
+			if ($dir = opendir($app_dir['path'])) {
+				while (false !== ($filename = readdir($dir))) {
+					if (substr($filename, 0, 1) != '.' and is_dir($app_dir['path']."/$filename")) {
+						if (file_exists($app_dir['path']."/$filename/appinfo/info.xml")) {
+							if (!Installer::isInstalled($filename)) {
+								$info = OC_App::getAppInfo($filename);
 								$enabled = isset($info['default_enable']);
 								if (($enabled || in_array($filename, \OC::$server->getAppManager()->getAlwaysEnabledApps()))
 									  && \OC::$server->getConfig()->getAppValue($filename, 'enabled') !== 'no') {
@@ -549,7 +549,7 @@ 
 						}
 					}
 				}
-				closedir( $dir );
+				closedir($dir);
 			}
 		}
 
@@ -564,12 +564,12 @@ 
 	public static function installShippedApp($app) {
 		//install the database
 		$appPath = OC_App::getAppPath($app);
-		if(is_file("$appPath/appinfo/database.xml")) {
+		if (is_file("$appPath/appinfo/database.xml")) {
 			try {
 				OC_DB::createDbFromStructure("$appPath/appinfo/database.xml");
 			} catch (TableExistsException $e) {
 				throw new HintException(
-					'Failed to enable app ' . $app,
+					'Failed to enable app '.$app,
 					'Please ask for help via one of our <a href="https://nextcloud.com/support/" target="_blank" rel="noreferrer">support channels</a>.',
 					0, $e
 				);
@@ -596,16 +596,16 @@ 
 		}
 
 		//set remote/public handlers
-		foreach($info['remote'] as $name=>$path) {
+		foreach ($info['remote'] as $name=>$path) {
 			$config->setAppValue('core', 'remote_'.$name, $app.'/'.$path);
 		}
-		foreach($info['public'] as $name=>$path) {
+		foreach ($info['public'] as $name=>$path) {
 			$config->setAppValue('core', 'public_'.$name, $app.'/'.$path);
 		}
 
 		OC_App::setAppTypes($info['id']);
 
-		if(isset($info['settings']) && is_array($info['settings'])) {
+		if (isset($info['settings']) && is_array($info['settings'])) {
 			// requires that autoloading was registered for the app,
 			// as happens before running the install.php some lines above
 			\OC::$server->getSettingsManager()->setupSettings($info['settings']);
@@ -621,7 +621,7 @@ 
 	 */
 	public static function checkCode($folder) {
 		// is the code checker enabled?
-		if(!\OC::$server->getConfig()->getSystemValue('appcodechecker', false)) {
+		if (!\OC::$server->getConfig()->getSystemValue('appcodechecker', false)) {
 			return true;
 		}
 
@@ -635,7 +635,7 @@ 
 	 * @param $basedir
 	 */
 	private static function includeAppScript($script) {
-		if ( file_exists($script) ){
+		if (file_exists($script)) {
 			include $script;
 		}
 	}

Braces +3 added lines, -3 removed lines

@@ -450,11 +450,11 @@ 
 			$currentversion=OC_App::getAppVersion($app);
 			if (version_compare($ocsversion, $currentversion, '>')) {
 				return($ocsversion);
-			}else{
+			} else{
 				return false;
 			}
 
-		}else{
+		} else{
 			return false;
 		}
 
@@ -502,7 +502,7 @@ 
 			OC_Helper::rmdirr($appDir);
 
 			return true;
-		}else{
+		} else{
 			\OCP\Util::writeLog('core', 'can\'t remove app '.$appId.'. It is not installed.', \OCP\Util::ERROR);
 
 			return false;

lib/private/L10N/Factory.php

Doc Comments +5 added lines

@@ -278,6 +278,11 @@
 	 */
 	// FIXME This method is only public, until OC_L10N does not need it anymore,
 	// FIXME This is also the reason, why it is not in the public interface
+
+	/**
+	 * @param string|boolean $app
+	 * @param string|null $lang
+	 */
 	public function getL10nFilesForApp($app, $lang) {
 		$languageFiles = [];
 

Indentation +351 added lines, -351 removed lines

@@ -37,355 +37,355 @@
  */
 class Factory implements IFactory {
 
-	/** @var string */
-	protected $requestLanguage = '';
-
-	/**
-	 * cached instances
-	 * @var array Structure: Lang => App => \OCP\IL10N
-	 */
-	protected $instances = [];
-
-	/**
-	 * @var array Structure: App => string[]
-	 */
-	protected $availableLanguages = [];
-
-	/**
-	 * @var array Structure: string => callable
-	 */
-	protected $pluralFunctions = [];
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IRequest */
-	protected $request;
-
-	/** @var IUserSession */
-	protected $userSession;
-
-	/** @var string */
-	protected $serverRoot;
-
-	/**
-	 * @param IConfig $config
-	 * @param IRequest $request
-	 * @param IUserSession $userSession
-	 * @param string $serverRoot
-	 */
-	public function __construct(IConfig $config,
-								IRequest $request,
-								IUserSession $userSession,
-								$serverRoot) {
-		$this->config = $config;
-		$this->request = $request;
-		$this->userSession = $userSession;
-		$this->serverRoot = $serverRoot;
-	}
-
-	/**
-	 * Get a language instance
-	 *
-	 * @param string $app
-	 * @param string|null $lang
-	 * @return \OCP\IL10N
-	 */
-	public function get($app, $lang = null) {
-		$app = \OC_App::cleanAppId($app);
-		if ($lang !== null) {
-			$lang = str_replace(array('\0', '/', '\\', '..'), '', (string) $lang);
-		}
-		if ($lang === null || !$this->languageExists($app, $lang)) {
-			$lang = $this->findLanguage($app);
-		}
-
-		if (!isset($this->instances[$lang][$app])) {
-			$this->instances[$lang][$app] = new L10N(
-				$this, $app, $lang,
-				$this->getL10nFilesForApp($app, $lang)
-			);
-		}
-
-		return $this->instances[$lang][$app];
-	}
-
-	/**
-	 * Find the best language
-	 *
-	 * @param string|null $app App id or null for core
-	 * @return string language If nothing works it returns 'en'
-	 */
-	public function findLanguage($app = null) {
-		if ($this->requestLanguage !== '' && $this->languageExists($app, $this->requestLanguage)) {
-			return $this->requestLanguage;
-		}
-
-		/**
-		 * At this point ownCloud might not yet be installed and thus the lookup
-		 * in the preferences table might fail. For this reason we need to check
-		 * whether the instance has already been installed
-		 *
-		 * @link https://github.com/owncloud/core/issues/21955
-		 */
-		if($this->config->getSystemValue('installed', false)) {
-			$userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() :  null;
-			if(!is_null($userId)) {
-				$userLang = $this->config->getUserValue($userId, 'core', 'lang', null);
-			} else {
-				$userLang = null;
-			}
-		} else {
-			$userId = null;
-			$userLang = null;
-		}
-
-		if ($userLang) {
-			$this->requestLanguage = $userLang;
-			if ($this->languageExists($app, $userLang)) {
-				return $userLang;
-			}
-		}
-
-		$defaultLanguage = $this->config->getSystemValue('default_language', false);
-
-		if ($defaultLanguage !== false && $this->languageExists($app, $defaultLanguage)) {
-			return $defaultLanguage;
-		}
-
-		$lang = $this->setLanguageFromRequest($app);
-		if ($userId !== null && $app === null && !$userLang) {
-			$this->config->setUserValue($userId, 'core', 'lang', $lang);
-		}
-
-		return $lang;
-	}
-
-	/**
-	 * Find all available languages for an app
-	 *
-	 * @param string|null $app App id or null for core
-	 * @return array an array of available languages
-	 */
-	public function findAvailableLanguages($app = null) {
-		$key = $app;
-		if ($key === null) {
-			$key = 'null';
-		}
-
-		// also works with null as key
-		if (!empty($this->availableLanguages[$key])) {
-			return $this->availableLanguages[$key];
-		}
-
-		$available = ['en']; //english is always available
-		$dir = $this->findL10nDir($app);
-		if (is_dir($dir)) {
-			$files = scandir($dir);
-			if ($files !== false) {
-				foreach ($files as $file) {
-					if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
-						$available[] = substr($file, 0, -5);
-					}
-				}
-			}
-		}
-
-		// merge with translations from theme
-		$theme = $this->config->getSystemValue('theme');
-		if (!empty($theme)) {
-			$themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot));
-
-			if (is_dir($themeDir)) {
-				$files = scandir($themeDir);
-				if ($files !== false) {
-					foreach ($files as $file) {
-						if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
-							$available[] = substr($file, 0, -5);
-						}
-					}
-				}
-			}
-		}
-
-		$this->availableLanguages[$key] = $available;
-		return $available;
-	}
-
-	/**
-	 * @param string|null $app App id or null for core
-	 * @param string $lang
-	 * @return bool
-	 */
-	public function languageExists($app, $lang) {
-		if ($lang === 'en') {//english is always available
-			return true;
-		}
-
-		$languages = $this->findAvailableLanguages($app);
-		return array_search($lang, $languages) !== false;
-	}
-
-	/**
-	 * @param string|null $app App id or null for core
-	 * @return string
-	 */
-	public function setLanguageFromRequest($app = null) {
-		$header = $this->request->getHeader('ACCEPT_LANGUAGE');
-		if ($header) {
-			$available = $this->findAvailableLanguages($app);
-
-			// E.g. make sure that 'de' is before 'de_DE'.
-			sort($available);
-
-			$preferences = preg_split('/,\s*/', strtolower($header));
-			foreach ($preferences as $preference) {
-				list($preferred_language) = explode(';', $preference);
-				$preferred_language = str_replace('-', '_', $preferred_language);
-
-				foreach ($available as $available_language) {
-					if ($preferred_language === strtolower($available_language)) {
-						if ($app === null && !$this->requestLanguage) {
-							$this->requestLanguage = $available_language;
-						}
-						return $available_language;
-					}
-				}
-
-				// Fallback from de_De to de
-				foreach ($available as $available_language) {
-					if (substr($preferred_language, 0, 2) === $available_language) {
-						if ($app === null && !$this->requestLanguage) {
-							$this->requestLanguage = $available_language;
-						}
-						return $available_language;
-					}
-				}
-			}
-		}
-
-		if ($app === null && !$this->requestLanguage) {
-			$this->requestLanguage = 'en';
-		}
-		return 'en'; // Last try: English
-	}
-
-	/**
-	 * Get a list of language files that should be loaded
-	 *
-	 * @param string $app
-	 * @param string $lang
-	 * @return string[]
-	 */
-	// FIXME This method is only public, until OC_L10N does not need it anymore,
-	// FIXME This is also the reason, why it is not in the public interface
-	public function getL10nFilesForApp($app, $lang) {
-		$languageFiles = [];
-
-		$i18nDir = $this->findL10nDir($app);
-		$transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json';
-
-		if ((\OC_Helper::isSubDirectory($transFile, $this->serverRoot . '/core/l10n/')
-				|| \OC_Helper::isSubDirectory($transFile, $this->serverRoot . '/lib/l10n/')
-				|| \OC_Helper::isSubDirectory($transFile, $this->serverRoot . '/settings/l10n/')
-				|| \OC_Helper::isSubDirectory($transFile, \OC_App::getAppPath($app) . '/l10n/')
-			)
-			&& file_exists($transFile)) {
-			// load the translations file
-			$languageFiles[] = $transFile;
-		}
-
-		// merge with translations from theme
-		$theme = $this->config->getSystemValue('theme');
-		if (!empty($theme)) {
-			$transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot));
-			if (file_exists($transFile)) {
-				$languageFiles[] = $transFile;
-			}
-		}
-
-		return $languageFiles;
-	}
-
-	/**
-	 * find the l10n directory
-	 *
-	 * @param string $app App id or empty string for core
-	 * @return string directory
-	 */
-	protected function findL10nDir($app = null) {
-		if (in_array($app, ['core', 'lib', 'settings'])) {
-			if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) {
-				return $this->serverRoot . '/' . $app . '/l10n/';
-			}
-		} else if ($app && \OC_App::getAppPath($app) !== false) {
-			// Check if the app is in the app folder
-			return \OC_App::getAppPath($app) . '/l10n/';
-		}
-		return $this->serverRoot . '/core/l10n/';
-	}
-
-
-	/**
-	 * Creates a function from the plural string
-	 *
-	 * Parts of the code is copied from Habari:
-	 * https://github.com/habari/system/blob/master/classes/locale.php
-	 * @param string $string
-	 * @return string
-	 */
-	public function createPluralFunction($string) {
-		if (isset($this->pluralFunctions[$string])) {
-			return $this->pluralFunctions[$string];
-		}
-
-		if (preg_match( '/^\s*nplurals\s*=\s*(\d+)\s*;\s*plural=(.*)$/u', $string, $matches)) {
-			// sanitize
-			$nplurals = preg_replace( '/[^0-9]/', '', $matches[1] );
-			$plural = preg_replace( '#[^n0-9:\(\)\?\|\&=!<>+*/\%-]#', '', $matches[2] );
-
-			$body = str_replace(
-				array( 'plural', 'n', '$n$plurals', ),
-				array( '$plural', '$n', '$nplurals', ),
-				'nplurals='. $nplurals . '; plural=' . $plural
-			);
-
-			// add parents
-			// important since PHP's ternary evaluates from left to right
-			$body .= ';';
-			$res = '';
-			$p = 0;
-			for($i = 0; $i < strlen($body); $i++) {
-				$ch = $body[$i];
-				switch ( $ch ) {
-					case '?':
-						$res .= ' ? (';
-						$p++;
-						break;
-					case ':':
-						$res .= ') : (';
-						break;
-					case ';':
-						$res .= str_repeat( ')', $p ) . ';';
-						$p = 0;
-						break;
-					default:
-						$res .= $ch;
-				}
-			}
-
-			$body = $res . 'return ($plural>=$nplurals?$nplurals-1:$plural);';
-			$function = create_function('$n', $body);
-			$this->pluralFunctions[$string] = $function;
-			return $function;
-		} else {
-			// default: one plural form for all cases but n==1 (english)
-			$function = create_function(
-				'$n',
-				'$nplurals=2;$plural=($n==1?0:1);return ($plural>=$nplurals?$nplurals-1:$plural);'
-			);
-			$this->pluralFunctions[$string] = $function;
-			return $function;
-		}
-	}
+    /** @var string */
+    protected $requestLanguage = '';
+
+    /**
+     * cached instances
+     * @var array Structure: Lang => App => \OCP\IL10N
+     */
+    protected $instances = [];
+
+    /**
+     * @var array Structure: App => string[]
+     */
+    protected $availableLanguages = [];
+
+    /**
+     * @var array Structure: string => callable
+     */
+    protected $pluralFunctions = [];
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var IRequest */
+    protected $request;
+
+    /** @var IUserSession */
+    protected $userSession;
+
+    /** @var string */
+    protected $serverRoot;
+
+    /**
+     * @param IConfig $config
+     * @param IRequest $request
+     * @param IUserSession $userSession
+     * @param string $serverRoot
+     */
+    public function __construct(IConfig $config,
+                                IRequest $request,
+                                IUserSession $userSession,
+                                $serverRoot) {
+        $this->config = $config;
+        $this->request = $request;
+        $this->userSession = $userSession;
+        $this->serverRoot = $serverRoot;
+    }
+
+    /**
+     * Get a language instance
+     *
+     * @param string $app
+     * @param string|null $lang
+     * @return \OCP\IL10N
+     */
+    public function get($app, $lang = null) {
+        $app = \OC_App::cleanAppId($app);
+        if ($lang !== null) {
+            $lang = str_replace(array('\0', '/', '\\', '..'), '', (string) $lang);
+        }
+        if ($lang === null || !$this->languageExists($app, $lang)) {
+            $lang = $this->findLanguage($app);
+        }
+
+        if (!isset($this->instances[$lang][$app])) {
+            $this->instances[$lang][$app] = new L10N(
+                $this, $app, $lang,
+                $this->getL10nFilesForApp($app, $lang)
+            );
+        }
+
+        return $this->instances[$lang][$app];
+    }
+
+    /**
+     * Find the best language
+     *
+     * @param string|null $app App id or null for core
+     * @return string language If nothing works it returns 'en'
+     */
+    public function findLanguage($app = null) {
+        if ($this->requestLanguage !== '' && $this->languageExists($app, $this->requestLanguage)) {
+            return $this->requestLanguage;
+        }
+
+        /**
+         * At this point ownCloud might not yet be installed and thus the lookup
+         * in the preferences table might fail. For this reason we need to check
+         * whether the instance has already been installed
+         *
+         * @link https://github.com/owncloud/core/issues/21955
+         */
+        if($this->config->getSystemValue('installed', false)) {
+            $userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() :  null;
+            if(!is_null($userId)) {
+                $userLang = $this->config->getUserValue($userId, 'core', 'lang', null);
+            } else {
+                $userLang = null;
+            }
+        } else {
+            $userId = null;
+            $userLang = null;
+        }
+
+        if ($userLang) {
+            $this->requestLanguage = $userLang;
+            if ($this->languageExists($app, $userLang)) {
+                return $userLang;
+            }
+        }
+
+        $defaultLanguage = $this->config->getSystemValue('default_language', false);
+
+        if ($defaultLanguage !== false && $this->languageExists($app, $defaultLanguage)) {
+            return $defaultLanguage;
+        }
+
+        $lang = $this->setLanguageFromRequest($app);
+        if ($userId !== null && $app === null && !$userLang) {
+            $this->config->setUserValue($userId, 'core', 'lang', $lang);
+        }
+
+        return $lang;
+    }
+
+    /**
+     * Find all available languages for an app
+     *
+     * @param string|null $app App id or null for core
+     * @return array an array of available languages
+     */
+    public function findAvailableLanguages($app = null) {
+        $key = $app;
+        if ($key === null) {
+            $key = 'null';
+        }
+
+        // also works with null as key
+        if (!empty($this->availableLanguages[$key])) {
+            return $this->availableLanguages[$key];
+        }
+
+        $available = ['en']; //english is always available
+        $dir = $this->findL10nDir($app);
+        if (is_dir($dir)) {
+            $files = scandir($dir);
+            if ($files !== false) {
+                foreach ($files as $file) {
+                    if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
+                        $available[] = substr($file, 0, -5);
+                    }
+                }
+            }
+        }
+
+        // merge with translations from theme
+        $theme = $this->config->getSystemValue('theme');
+        if (!empty($theme)) {
+            $themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot));
+
+            if (is_dir($themeDir)) {
+                $files = scandir($themeDir);
+                if ($files !== false) {
+                    foreach ($files as $file) {
+                        if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
+                            $available[] = substr($file, 0, -5);
+                        }
+                    }
+                }
+            }
+        }
+
+        $this->availableLanguages[$key] = $available;
+        return $available;
+    }
+
+    /**
+     * @param string|null $app App id or null for core
+     * @param string $lang
+     * @return bool
+     */
+    public function languageExists($app, $lang) {
+        if ($lang === 'en') {//english is always available
+            return true;
+        }
+
+        $languages = $this->findAvailableLanguages($app);
+        return array_search($lang, $languages) !== false;
+    }
+
+    /**
+     * @param string|null $app App id or null for core
+     * @return string
+     */
+    public function setLanguageFromRequest($app = null) {
+        $header = $this->request->getHeader('ACCEPT_LANGUAGE');
+        if ($header) {
+            $available = $this->findAvailableLanguages($app);
+
+            // E.g. make sure that 'de' is before 'de_DE'.
+            sort($available);
+
+            $preferences = preg_split('/,\s*/', strtolower($header));
+            foreach ($preferences as $preference) {
+                list($preferred_language) = explode(';', $preference);
+                $preferred_language = str_replace('-', '_', $preferred_language);
+
+                foreach ($available as $available_language) {
+                    if ($preferred_language === strtolower($available_language)) {
+                        if ($app === null && !$this->requestLanguage) {
+                            $this->requestLanguage = $available_language;
+                        }
+                        return $available_language;
+                    }
+                }
+
+                // Fallback from de_De to de
+                foreach ($available as $available_language) {
+                    if (substr($preferred_language, 0, 2) === $available_language) {
+                        if ($app === null && !$this->requestLanguage) {
+                            $this->requestLanguage = $available_language;
+                        }
+                        return $available_language;
+                    }
+                }
+            }
+        }
+
+        if ($app === null && !$this->requestLanguage) {
+            $this->requestLanguage = 'en';
+        }
+        return 'en'; // Last try: English
+    }
+
+    /**
+     * Get a list of language files that should be loaded
+     *
+     * @param string $app
+     * @param string $lang
+     * @return string[]
+     */
+    // FIXME This method is only public, until OC_L10N does not need it anymore,
+    // FIXME This is also the reason, why it is not in the public interface
+    public function getL10nFilesForApp($app, $lang) {
+        $languageFiles = [];
+
+        $i18nDir = $this->findL10nDir($app);
+        $transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json';
+
+        if ((\OC_Helper::isSubDirectory($transFile, $this->serverRoot . '/core/l10n/')
+                || \OC_Helper::isSubDirectory($transFile, $this->serverRoot . '/lib/l10n/')
+                || \OC_Helper::isSubDirectory($transFile, $this->serverRoot . '/settings/l10n/')
+                || \OC_Helper::isSubDirectory($transFile, \OC_App::getAppPath($app) . '/l10n/')
+            )
+            && file_exists($transFile)) {
+            // load the translations file
+            $languageFiles[] = $transFile;
+        }
+
+        // merge with translations from theme
+        $theme = $this->config->getSystemValue('theme');
+        if (!empty($theme)) {
+            $transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot));
+            if (file_exists($transFile)) {
+                $languageFiles[] = $transFile;
+            }
+        }
+
+        return $languageFiles;
+    }
+
+    /**
+     * find the l10n directory
+     *
+     * @param string $app App id or empty string for core
+     * @return string directory
+     */
+    protected function findL10nDir($app = null) {
+        if (in_array($app, ['core', 'lib', 'settings'])) {
+            if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) {
+                return $this->serverRoot . '/' . $app . '/l10n/';
+            }
+        } else if ($app && \OC_App::getAppPath($app) !== false) {
+            // Check if the app is in the app folder
+            return \OC_App::getAppPath($app) . '/l10n/';
+        }
+        return $this->serverRoot . '/core/l10n/';
+    }
+
+
+    /**
+     * Creates a function from the plural string
+     *
+     * Parts of the code is copied from Habari:
+     * https://github.com/habari/system/blob/master/classes/locale.php
+     * @param string $string
+     * @return string
+     */
+    public function createPluralFunction($string) {
+        if (isset($this->pluralFunctions[$string])) {
+            return $this->pluralFunctions[$string];
+        }
+
+        if (preg_match( '/^\s*nplurals\s*=\s*(\d+)\s*;\s*plural=(.*)$/u', $string, $matches)) {
+            // sanitize
+            $nplurals = preg_replace( '/[^0-9]/', '', $matches[1] );
+            $plural = preg_replace( '#[^n0-9:\(\)\?\|\&=!<>+*/\%-]#', '', $matches[2] );
+
+            $body = str_replace(
+                array( 'plural', 'n', '$n$plurals', ),
+                array( '$plural', '$n', '$nplurals', ),
+                'nplurals='. $nplurals . '; plural=' . $plural
+            );
+
+            // add parents
+            // important since PHP's ternary evaluates from left to right
+            $body .= ';';
+            $res = '';
+            $p = 0;
+            for($i = 0; $i < strlen($body); $i++) {
+                $ch = $body[$i];
+                switch ( $ch ) {
+                    case '?':
+                        $res .= ' ? (';
+                        $p++;
+                        break;
+                    case ':':
+                        $res .= ') : (';
+                        break;
+                    case ';':
+                        $res .= str_repeat( ')', $p ) . ';';
+                        $p = 0;
+                        break;
+                    default:
+                        $res .= $ch;
+                }
+            }
+
+            $body = $res . 'return ($plural>=$nplurals?$nplurals-1:$plural);';
+            $function = create_function('$n', $body);
+            $this->pluralFunctions[$string] = $function;
+            return $function;
+        } else {
+            // default: one plural form for all cases but n==1 (english)
+            $function = create_function(
+                '$n',
+                '$nplurals=2;$plural=($n==1?0:1);return ($plural>=$nplurals?$nplurals-1:$plural);'
+            );
+            $this->pluralFunctions[$string] = $function;
+            return $function;
+        }
+    }
 }

Spacing +24 added lines, -24 removed lines

@@ -128,9 +128,9 @@ 
 		 *
 		 * @link https://github.com/owncloud/core/issues/21955
 		 */
-		if($this->config->getSystemValue('installed', false)) {
-			$userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() :  null;
-			if(!is_null($userId)) {
+		if ($this->config->getSystemValue('installed', false)) {
+			$userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() : null;
+			if (!is_null($userId)) {
 				$userLang = $this->config->getUserValue($userId, 'core', 'lang', null);
 			} else {
 				$userLang = null;
@@ -194,7 +194,7 @@ 
 		// merge with translations from theme
 		$theme = $this->config->getSystemValue('theme');
 		if (!empty($theme)) {
-			$themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot));
+			$themeDir = $this->serverRoot.'/themes/'.$theme.substr($dir, strlen($this->serverRoot));
 
 			if (is_dir($themeDir)) {
 				$files = scandir($themeDir);
@@ -283,12 +283,12 @@ 
 		$languageFiles = [];
 
 		$i18nDir = $this->findL10nDir($app);
-		$transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json';
+		$transFile = strip_tags($i18nDir).strip_tags($lang).'.json';
 
-		if ((\OC_Helper::isSubDirectory($transFile, $this->serverRoot . '/core/l10n/')
-				|| \OC_Helper::isSubDirectory($transFile, $this->serverRoot . '/lib/l10n/')
-				|| \OC_Helper::isSubDirectory($transFile, $this->serverRoot . '/settings/l10n/')
-				|| \OC_Helper::isSubDirectory($transFile, \OC_App::getAppPath($app) . '/l10n/')
+		if ((\OC_Helper::isSubDirectory($transFile, $this->serverRoot.'/core/l10n/')
+				|| \OC_Helper::isSubDirectory($transFile, $this->serverRoot.'/lib/l10n/')
+				|| \OC_Helper::isSubDirectory($transFile, $this->serverRoot.'/settings/l10n/')
+				|| \OC_Helper::isSubDirectory($transFile, \OC_App::getAppPath($app).'/l10n/')
 			)
 			&& file_exists($transFile)) {
 			// load the translations file
@@ -298,7 +298,7 @@ 
 		// merge with translations from theme
 		$theme = $this->config->getSystemValue('theme');
 		if (!empty($theme)) {
-			$transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot));
+			$transFile = $this->serverRoot.'/themes/'.$theme.substr($transFile, strlen($this->serverRoot));
 			if (file_exists($transFile)) {
 				$languageFiles[] = $transFile;
 			}
@@ -315,14 +315,14 @@ 
 	 */
 	protected function findL10nDir($app = null) {
 		if (in_array($app, ['core', 'lib', 'settings'])) {
-			if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) {
-				return $this->serverRoot . '/' . $app . '/l10n/';
+			if (file_exists($this->serverRoot.'/'.$app.'/l10n/')) {
+				return $this->serverRoot.'/'.$app.'/l10n/';
 			}
 		} else if ($app && \OC_App::getAppPath($app) !== false) {
 			// Check if the app is in the app folder
-			return \OC_App::getAppPath($app) . '/l10n/';
+			return \OC_App::getAppPath($app).'/l10n/';
 		}
-		return $this->serverRoot . '/core/l10n/';
+		return $this->serverRoot.'/core/l10n/';
 	}
 
 
@@ -339,15 +339,15 @@ 
 			return $this->pluralFunctions[$string];
 		}
 
-		if (preg_match( '/^\s*nplurals\s*=\s*(\d+)\s*;\s*plural=(.*)$/u', $string, $matches)) {
+		if (preg_match('/^\s*nplurals\s*=\s*(\d+)\s*;\s*plural=(.*)$/u', $string, $matches)) {
 			// sanitize
-			$nplurals = preg_replace( '/[^0-9]/', '', $matches[1] );
-			$plural = preg_replace( '#[^n0-9:\(\)\?\|\&=!<>+*/\%-]#', '', $matches[2] );
+			$nplurals = preg_replace('/[^0-9]/', '', $matches[1]);
+			$plural = preg_replace('#[^n0-9:\(\)\?\|\&=!<>+*/\%-]#', '', $matches[2]);
 
 			$body = str_replace(
-				array( 'plural', 'n', '$n$plurals', ),
-				array( '$plural', '$n', '$nplurals', ),
-				'nplurals='. $nplurals . '; plural=' . $plural
+				array('plural', 'n', '$n$plurals',),
+				array('$plural', '$n', '$nplurals',),
+				'nplurals='.$nplurals.'; plural='.$plural
 			);
 
 			// add parents
@@ -355,9 +355,9 @@ 
 			$body .= ';';
 			$res = '';
 			$p = 0;
-			for($i = 0; $i < strlen($body); $i++) {
+			for ($i = 0; $i < strlen($body); $i++) {
 				$ch = $body[$i];
-				switch ( $ch ) {
+				switch ($ch) {
 					case '?':
 						$res .= ' ? (';
 						$p++;
@@ -366,7 +366,7 @@ 
 						$res .= ') : (';
 						break;
 					case ';':
-						$res .= str_repeat( ')', $p ) . ';';
+						$res .= str_repeat(')', $p).';';
 						$p = 0;
 						break;
 					default:
@@ -374,7 +374,7 @@ 
 				}
 			}
 
-			$body = $res . 'return ($plural>=$nplurals?$nplurals-1:$plural);';
+			$body = $res.'return ($plural>=$nplurals?$nplurals-1:$plural);';
 			$function = create_function('$n', $body);
 			$this->pluralFunctions[$string] = $function;
 			return $function;

lib/private/L10N/L10N.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +186 added lines, -186 removed lines

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

lib/private/legacy/api.php

Doc Comments +1 added lines, -1 removed lines

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

Spacing +32 added lines, -32 removed lines

@@ -92,7 +92,7 @@ 
 				$requirements = array()) {
 		$name = strtolower($method).$url;
 		$name = str_replace(array('/', '{', '}'), '_', $name);
-		if(!isset(self::$actions[$name])) {
+		if (!isset(self::$actions[$name])) {
 			$oldCollection = OC::$server->getRouter()->getCurrentCollection();
 			OC::$server->getRouter()->useCollection('ocs');
 			OC::$server->getRouter()->create($name, $url)
@@ -115,17 +115,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'),
@@ -133,7 +133,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'),
@@ -173,15 +173,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;
@@ -190,14 +190,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']);
@@ -206,12 +206,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']);
@@ -228,8 +228,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());
@@ -242,8 +242,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;
@@ -260,7 +260,7 @@ 
 	 */
 	private static function isAuthorised($action) {
 		$level = $action['authlevel'];
-		switch($level) {
+		switch ($level) {
 			case API::GUEST_AUTH:
 				// Anyone can access
 				return true;
@@ -270,16 +270,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;
@@ -288,7 +288,7 @@ 
 			case API::ADMIN_AUTH:
 				// Check for admin
 				$user = self::loginUser();
-				if(!$user) {
+				if (!$user) {
 					return false;
 				} else {
 					return OC_User::isAdminUser($user);
@@ -304,7 +304,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();
 		}
 
@@ -358,13 +358,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"');
@@ -372,8 +372,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();
@@ -395,14 +395,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();

Indentation +462 added lines, -462 removed lines

@@ -68,467 +68,467 @@
 
 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::$server->getUserSession()->logout();
-		}
-
-		self::respond($response, $format);
-	}
-
-	/**
-	 * merge the returned result objects into one response
-	 * @param array $responses
-	 * @return OC_OCS_Result
-	 */
-	public static function mergeResponses($responses) {
-		// Sort into shipped and third-party
-		$shipped = array(
-			'succeeded' => array(),
-			'failed' => array(),
-			);
-		$thirdparty = array(
-			'succeeded' => array(),
-			'failed' => array(),
-			);
-
-		foreach($responses as $response) {
-			if($response['shipped'] || ($response['app'] === 'core')) {
-				if($response['response']->succeeded()) {
-					$shipped['succeeded'][$response['app']] = $response;
-				} else {
-					$shipped['failed'][$response['app']] = $response;
-				}
-			} else {
-				if($response['response']->succeeded()) {
-					$thirdparty['succeeded'][$response['app']] = $response;
-				} else {
-					$thirdparty['failed'][$response['app']] = $response;
-				}
-			}
-		}
-
-		// Remove any error responses if there is one shipped response that succeeded
-		if(!empty($shipped['failed'])) {
-			// Which shipped response do we use if they all failed?
-			// They may have failed for different reasons (different status codes)
-			// Which response code should we return?
-			// Maybe any that are not \OCP\API::RESPOND_SERVER_ERROR
-			// Merge failed responses if more than one
-			$data = array();
-			foreach($shipped['failed'] as $failure) {
-				$data = array_merge_recursive($data, $failure['response']->getData());
-			}
-			$picked = reset($shipped['failed']);
-			$code = $picked['response']->getStatusCode();
-			$meta = $picked['response']->getMeta();
-			$headers = $picked['response']->getHeaders();
-			$response = new OC_OCS_Result($data, $code, $meta['message'], $headers);
-			return $response;
-		} elseif(!empty($shipped['succeeded'])) {
-			$responses = array_merge($shipped['succeeded'], $thirdparty['succeeded']);
-		} elseif(!empty($thirdparty['failed'])) {
-			// Merge failed responses if more than one
-			$data = array();
-			foreach($thirdparty['failed'] as $failure) {
-				$data = array_merge_recursive($data, $failure['response']->getData());
-			}
-			$picked = reset($thirdparty['failed']);
-			$code = $picked['response']->getStatusCode();
-			$meta = $picked['response']->getMeta();
-			$headers = $picked['response']->getHeaders();
-			$response = new OC_OCS_Result($data, $code, $meta['message'], $headers);
-			return $response;
-		} else {
-			$responses = $thirdparty['succeeded'];
-		}
-		// Merge the successful responses
-		$data = [];
-		$codes = [];
-		$header = [];
-
-		foreach($responses as $response) {
-			if($response['shipped']) {
-				$data = array_merge_recursive($response['response']->getData(), $data);
-			} else {
-				$data = array_merge_recursive($data, $response['response']->getData());
-			}
-			$header = array_merge_recursive($header, $response['response']->getHeaders());
-			$codes[] = ['code' => $response['response']->getStatusCode(),
-				'meta' => $response['response']->getMeta()];
-		}
-
-		// Use any non 100 status codes
-		$statusCode = 100;
-		$statusMessage = null;
-		foreach($codes as $code) {
-			if($code['code'] != 100) {
-				$statusCode = $code['code'];
-				$statusMessage = $code['meta']['message'];
-				break;
-			}
-		}
-
-		return new OC_OCS_Result($data, $statusCode, $statusMessage, $header);
-	}
-
-	/**
-	 * authenticate the api call
-	 * @param array $action the action details as supplied to OC_API::register()
-	 * @return bool
-	 */
-	private static function isAuthorised($action) {
-		$level = $action['authlevel'];
-		switch($level) {
-			case API::GUEST_AUTH:
-				// Anyone can access
-				return true;
-			case API::USER_AUTH:
-				// User required
-				return self::loginUser();
-			case API::SUBADMIN_AUTH:
-				// Check for subadmin
-				$user = self::loginUser();
-				if(!$user) {
-					return false;
-				} else {
-					$userObject = \OC::$server->getUserSession()->getUser();
-					if($userObject === null) {
-						return false;
-					}
-					$isSubAdmin = \OC::$server->getGroupManager()->getSubAdmin()->isSubAdmin($userObject);
-					$admin = OC_User::isAdminUser($user);
-					if($isSubAdmin || $admin) {
-						return true;
-					} else {
-						return false;
-					}
-				}
-			case API::ADMIN_AUTH:
-				// Check for admin
-				$user = self::loginUser();
-				if(!$user) {
-					return false;
-				} else {
-					return OC_User::isAdminUser($user);
-				}
-			default:
-				// oops looks like invalid level supplied
-				return false;
-		}
-	}
-
-	/**
-	 * http basic auth
-	 * @return string|false (username, or false on failure)
-	 */
-	private static function loginUser() {
-		if(self::$isLoggedIn === true) {
-			return \OC_User::getUser();
-		}
-
-		// reuse existing login
-		$loggedIn = \OC::$server->getUserSession()->isLoggedIn();
-		if ($loggedIn === true) {
-			if (\OC::$server->getTwoFactorAuthManager()->needsSecondFactor()) {
-				// Do not allow access to OCS until the 2FA challenge was solved successfully
-				return false;
-			}
-			$ocsApiRequest = isset($_SERVER['HTTP_OCS_APIREQUEST']) ? $_SERVER['HTTP_OCS_APIREQUEST'] === 'true' : false;
-			if ($ocsApiRequest) {
-
-				// initialize the user's filesystem
-				\OC_Util::setupFS(\OC_User::getUser());
-				self::$isLoggedIn = true;
-
-				return OC_User::getUser();
-			}
-			return false;
-		}
-
-		// basic auth - because OC_User::login will create a new session we shall only try to login
-		// if user and pass are set
-		$userSession = \OC::$server->getUserSession();
-		$request = \OC::$server->getRequest();
-		try {
-			$loginSuccess = $userSession->tryTokenLogin($request);
-			if (!$loginSuccess) {
-				$loginSuccess = $userSession->tryBasicAuthLogin($request, \OC::$server->getBruteForceThrottler());
-			}
-		} catch (\OC\User\LoginException $e) {
-			return false;
-		}
+    /**
+     * 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::$server->getUserSession()->logout();
+        }
+
+        self::respond($response, $format);
+    }
+
+    /**
+     * merge the returned result objects into one response
+     * @param array $responses
+     * @return OC_OCS_Result
+     */
+    public static function mergeResponses($responses) {
+        // Sort into shipped and third-party
+        $shipped = array(
+            'succeeded' => array(),
+            'failed' => array(),
+            );
+        $thirdparty = array(
+            'succeeded' => array(),
+            'failed' => array(),
+            );
+
+        foreach($responses as $response) {
+            if($response['shipped'] || ($response['app'] === 'core')) {
+                if($response['response']->succeeded()) {
+                    $shipped['succeeded'][$response['app']] = $response;
+                } else {
+                    $shipped['failed'][$response['app']] = $response;
+                }
+            } else {
+                if($response['response']->succeeded()) {
+                    $thirdparty['succeeded'][$response['app']] = $response;
+                } else {
+                    $thirdparty['failed'][$response['app']] = $response;
+                }
+            }
+        }
+
+        // Remove any error responses if there is one shipped response that succeeded
+        if(!empty($shipped['failed'])) {
+            // Which shipped response do we use if they all failed?
+            // They may have failed for different reasons (different status codes)
+            // Which response code should we return?
+            // Maybe any that are not \OCP\API::RESPOND_SERVER_ERROR
+            // Merge failed responses if more than one
+            $data = array();
+            foreach($shipped['failed'] as $failure) {
+                $data = array_merge_recursive($data, $failure['response']->getData());
+            }
+            $picked = reset($shipped['failed']);
+            $code = $picked['response']->getStatusCode();
+            $meta = $picked['response']->getMeta();
+            $headers = $picked['response']->getHeaders();
+            $response = new OC_OCS_Result($data, $code, $meta['message'], $headers);
+            return $response;
+        } elseif(!empty($shipped['succeeded'])) {
+            $responses = array_merge($shipped['succeeded'], $thirdparty['succeeded']);
+        } elseif(!empty($thirdparty['failed'])) {
+            // Merge failed responses if more than one
+            $data = array();
+            foreach($thirdparty['failed'] as $failure) {
+                $data = array_merge_recursive($data, $failure['response']->getData());
+            }
+            $picked = reset($thirdparty['failed']);
+            $code = $picked['response']->getStatusCode();
+            $meta = $picked['response']->getMeta();
+            $headers = $picked['response']->getHeaders();
+            $response = new OC_OCS_Result($data, $code, $meta['message'], $headers);
+            return $response;
+        } else {
+            $responses = $thirdparty['succeeded'];
+        }
+        // Merge the successful responses
+        $data = [];
+        $codes = [];
+        $header = [];
+
+        foreach($responses as $response) {
+            if($response['shipped']) {
+                $data = array_merge_recursive($response['response']->getData(), $data);
+            } else {
+                $data = array_merge_recursive($data, $response['response']->getData());
+            }
+            $header = array_merge_recursive($header, $response['response']->getHeaders());
+            $codes[] = ['code' => $response['response']->getStatusCode(),
+                'meta' => $response['response']->getMeta()];
+        }
+
+        // Use any non 100 status codes
+        $statusCode = 100;
+        $statusMessage = null;
+        foreach($codes as $code) {
+            if($code['code'] != 100) {
+                $statusCode = $code['code'];
+                $statusMessage = $code['meta']['message'];
+                break;
+            }
+        }
+
+        return new OC_OCS_Result($data, $statusCode, $statusMessage, $header);
+    }
+
+    /**
+     * authenticate the api call
+     * @param array $action the action details as supplied to OC_API::register()
+     * @return bool
+     */
+    private static function isAuthorised($action) {
+        $level = $action['authlevel'];
+        switch($level) {
+            case API::GUEST_AUTH:
+                // Anyone can access
+                return true;
+            case API::USER_AUTH:
+                // User required
+                return self::loginUser();
+            case API::SUBADMIN_AUTH:
+                // Check for subadmin
+                $user = self::loginUser();
+                if(!$user) {
+                    return false;
+                } else {
+                    $userObject = \OC::$server->getUserSession()->getUser();
+                    if($userObject === null) {
+                        return false;
+                    }
+                    $isSubAdmin = \OC::$server->getGroupManager()->getSubAdmin()->isSubAdmin($userObject);
+                    $admin = OC_User::isAdminUser($user);
+                    if($isSubAdmin || $admin) {
+                        return true;
+                    } else {
+                        return false;
+                    }
+                }
+            case API::ADMIN_AUTH:
+                // Check for admin
+                $user = self::loginUser();
+                if(!$user) {
+                    return false;
+                } else {
+                    return OC_User::isAdminUser($user);
+                }
+            default:
+                // oops looks like invalid level supplied
+                return false;
+        }
+    }
+
+    /**
+     * http basic auth
+     * @return string|false (username, or false on failure)
+     */
+    private static function loginUser() {
+        if(self::$isLoggedIn === true) {
+            return \OC_User::getUser();
+        }
+
+        // reuse existing login
+        $loggedIn = \OC::$server->getUserSession()->isLoggedIn();
+        if ($loggedIn === true) {
+            if (\OC::$server->getTwoFactorAuthManager()->needsSecondFactor()) {
+                // Do not allow access to OCS until the 2FA challenge was solved successfully
+                return false;
+            }
+            $ocsApiRequest = isset($_SERVER['HTTP_OCS_APIREQUEST']) ? $_SERVER['HTTP_OCS_APIREQUEST'] === 'true' : false;
+            if ($ocsApiRequest) {
+
+                // initialize the user's filesystem
+                \OC_Util::setupFS(\OC_User::getUser());
+                self::$isLoggedIn = true;
+
+                return OC_User::getUser();
+            }
+            return false;
+        }
+
+        // basic auth - because OC_User::login will create a new session we shall only try to login
+        // if user and pass are set
+        $userSession = \OC::$server->getUserSession();
+        $request = \OC::$server->getRequest();
+        try {
+            $loginSuccess = $userSession->tryTokenLogin($request);
+            if (!$loginSuccess) {
+                $loginSuccess = $userSession->tryBasicAuthLogin($request, \OC::$server->getBruteForceThrottler());
+            }
+        } catch (\OC\User\LoginException $e) {
+            return false;
+        }
 	
-		if ($loginSuccess === true) {
-			self::$logoutRequired = true;
-
-			// initialize the user's filesystem
-			\OC_Util::setupFS(\OC_User::getUser());
-			self::$isLoggedIn = true;
-
-			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);
-	}
+        if ($loginSuccess === true) {
+            self::$logoutRequired = true;
+
+            // initialize the user's filesystem
+            \OC_Util::setupFS(\OC_User::getUser());
+            self::$isLoggedIn = true;
+
+            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);
+    }
 }

lib/private/legacy/eventsource.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +88 added lines, -88 removed lines

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

Spacing +7 added lines, -7 removed lines

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

lib/private/legacy/helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -560,7 +560,7 @@
 	 *
 	 * @param string $path
 	 * @param \OCP\Files\FileInfo $rootInfo (optional)
-	 * @return array
+	 * @return string
 	 * @throws \OCP\Files\NotFoundException
 	 */
 	public static function getStorageInfo($path, $rootInfo = null) {

Braces +3 added lines, -2 removed lines

@@ -271,8 +271,9 @@
 		}
 		foreach ($dirs as $dir) {
 			foreach ($exts as $ext) {
-				if ($check_fn("$dir/$name" . $ext))
-					return true;
+				if ($check_fn("$dir/$name" . $ext)) {
+									return true;
+				}
 			}
 		}
 		return false;

Indentation +624 added lines, -624 removed lines

@@ -48,628 +48,628 @@
  * Collection of useful functions
  */
 class OC_Helper {
-	private static $templateManager;
-
-	/**
-	 * Creates an absolute url for public use
-	 * @param string $service id
-	 * @param bool $add_slash
-	 * @return string the url
-	 *
-	 * Returns a absolute url to the given service.
-	 */
-	public static function linkToPublic($service, $add_slash = false) {
-		if ($service === 'files') {
-			$url = OC::$server->getURLGenerator()->getAbsoluteURL('/s');
-		} else {
-			$url = OC::$server->getURLGenerator()->getAbsoluteURL(OC::$server->getURLGenerator()->linkTo('', 'public.php').'?service='.$service);
-		}
-		return $url . (($add_slash && $service[strlen($service) - 1] != '/') ? '/' : '');
-	}
-
-	/**
-	 * Make a human file size
-	 * @param int $bytes file size in bytes
-	 * @return string a human readable file size
-	 *
-	 * Makes 2048 to 2 kB.
-	 */
-	public static function humanFileSize($bytes) {
-		if ($bytes < 0) {
-			return "?";
-		}
-		if ($bytes < 1024) {
-			return "$bytes B";
-		}
-		$bytes = round($bytes / 1024, 0);
-		if ($bytes < 1024) {
-			return "$bytes KB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes MB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes GB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes TB";
-		}
-
-		$bytes = round($bytes / 1024, 1);
-		return "$bytes PB";
-	}
-
-	/**
-	 * Make a php file size
-	 * @param int $bytes file size in bytes
-	 * @return string a php parseable file size
-	 *
-	 * Makes 2048 to 2k and 2^41 to 2048G
-	 */
-	public static function phpFileSize($bytes) {
-		if ($bytes < 0) {
-			return "?";
-		}
-		if ($bytes < 1024) {
-			return $bytes . "B";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return $bytes . "K";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return $bytes . "M";
-		}
-		$bytes = round($bytes / 1024, 1);
-		return $bytes . "G";
-	}
-
-	/**
-	 * Make a computer file size
-	 * @param string $str file size in human readable format
-	 * @return float a file size in bytes
-	 *
-	 * Makes 2kB to 2048.
-	 *
-	 * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
-	 */
-	public static function computerFileSize($str) {
-		$str = strtolower($str);
-		if (is_numeric($str)) {
-			return floatval($str);
-		}
-
-		$bytes_array = array(
-			'b' => 1,
-			'k' => 1024,
-			'kb' => 1024,
-			'mb' => 1024 * 1024,
-			'm' => 1024 * 1024,
-			'gb' => 1024 * 1024 * 1024,
-			'g' => 1024 * 1024 * 1024,
-			'tb' => 1024 * 1024 * 1024 * 1024,
-			't' => 1024 * 1024 * 1024 * 1024,
-			'pb' => 1024 * 1024 * 1024 * 1024 * 1024,
-			'p' => 1024 * 1024 * 1024 * 1024 * 1024,
-		);
-
-		$bytes = floatval($str);
-
-		if (preg_match('#([kmgtp]?b?)$#si', $str, $matches) && !empty($bytes_array[$matches[1]])) {
-			$bytes *= $bytes_array[$matches[1]];
-		} else {
-			return false;
-		}
-
-		$bytes = round($bytes);
-
-		return $bytes;
-	}
-
-	/**
-	 * Recursive copying of folders
-	 * @param string $src source folder
-	 * @param string $dest target folder
-	 *
-	 */
-	static function copyr($src, $dest) {
-		if (is_dir($src)) {
-			if (!is_dir($dest)) {
-				mkdir($dest);
-			}
-			$files = scandir($src);
-			foreach ($files as $file) {
-				if ($file != "." && $file != "..") {
-					self::copyr("$src/$file", "$dest/$file");
-				}
-			}
-		} elseif (file_exists($src) && !\OC\Files\Filesystem::isFileBlacklisted($src)) {
-			copy($src, $dest);
-		}
-	}
-
-	/**
-	 * Recursive deletion of folders
-	 * @param string $dir path to the folder
-	 * @param bool $deleteSelf if set to false only the content of the folder will be deleted
-	 * @return bool
-	 */
-	static function rmdirr($dir, $deleteSelf = true) {
-		if (is_dir($dir)) {
-			$files = new RecursiveIteratorIterator(
-				new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS),
-				RecursiveIteratorIterator::CHILD_FIRST
-			);
-
-			foreach ($files as $fileInfo) {
-				/** @var SplFileInfo $fileInfo */
-				if ($fileInfo->isLink()) {
-					unlink($fileInfo->getPathname());
-				} else if ($fileInfo->isDir()) {
-					rmdir($fileInfo->getRealPath());
-				} else {
-					unlink($fileInfo->getRealPath());
-				}
-			}
-			if ($deleteSelf) {
-				rmdir($dir);
-			}
-		} elseif (file_exists($dir)) {
-			if ($deleteSelf) {
-				unlink($dir);
-			}
-		}
-		if (!$deleteSelf) {
-			return true;
-		}
-
-		return !file_exists($dir);
-	}
-
-	/**
-	 * @return \OC\Files\Type\TemplateManager
-	 */
-	static public function getFileTemplateManager() {
-		if (!self::$templateManager) {
-			self::$templateManager = new \OC\Files\Type\TemplateManager();
-		}
-		return self::$templateManager;
-	}
-
-	/**
-	 * detect if a given program is found in the search PATH
-	 *
-	 * @param string $name
-	 * @param bool $path
-	 * @internal param string $program name
-	 * @internal param string $optional search path, defaults to $PATH
-	 * @return bool    true if executable program found in path
-	 */
-	public static function canExecute($name, $path = false) {
-		// path defaults to PATH from environment if not set
-		if ($path === false) {
-			$path = getenv("PATH");
-		}
-		// check method depends on operating system
-		if (!strncmp(PHP_OS, "WIN", 3)) {
-			// on Windows an appropriate COM or EXE file needs to exist
-			$exts = array(".exe", ".com");
-			$check_fn = "file_exists";
-		} else {
-			// anywhere else we look for an executable file of that name
-			$exts = array("");
-			$check_fn = "is_executable";
-		}
-		// Default check will be done with $path directories :
-		$dirs = explode(PATH_SEPARATOR, $path);
-		// WARNING : We have to check if open_basedir is enabled :
-		$obd = OC::$server->getIniWrapper()->getString('open_basedir');
-		if ($obd != "none") {
-			$obd_values = explode(PATH_SEPARATOR, $obd);
-			if (count($obd_values) > 0 and $obd_values[0]) {
-				// open_basedir is in effect !
-				// We need to check if the program is in one of these dirs :
-				$dirs = $obd_values;
-			}
-		}
-		foreach ($dirs as $dir) {
-			foreach ($exts as $ext) {
-				if ($check_fn("$dir/$name" . $ext))
-					return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * copy the contents of one stream to another
-	 *
-	 * @param resource $source
-	 * @param resource $target
-	 * @return array the number of bytes copied and result
-	 */
-	public static function streamCopy($source, $target) {
-		if (!$source or !$target) {
-			return array(0, false);
-		}
-		$bufSize = 8192;
-		$result = true;
-		$count = 0;
-		while (!feof($source)) {
-			$buf = fread($source, $bufSize);
-			$bytesWritten = fwrite($target, $buf);
-			if ($bytesWritten !== false) {
-				$count += $bytesWritten;
-			}
-			// note: strlen is expensive so only use it when necessary,
-			// on the last block
-			if ($bytesWritten === false
-				|| ($bytesWritten < $bufSize && $bytesWritten < strlen($buf))
-			) {
-				// write error, could be disk full ?
-				$result = false;
-				break;
-			}
-		}
-		return array($count, $result);
-	}
-
-	/**
-	 * Adds a suffix to the name in case the file exists
-	 *
-	 * @param string $path
-	 * @param string $filename
-	 * @return string
-	 */
-	public static function buildNotExistingFileName($path, $filename) {
-		$view = \OC\Files\Filesystem::getView();
-		return self::buildNotExistingFileNameForView($path, $filename, $view);
-	}
-
-	/**
-	 * Adds a suffix to the name in case the file exists
-	 *
-	 * @param string $path
-	 * @param string $filename
-	 * @return string
-	 */
-	public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
-		if ($path === '/') {
-			$path = '';
-		}
-		if ($pos = strrpos($filename, '.')) {
-			$name = substr($filename, 0, $pos);
-			$ext = substr($filename, $pos);
-		} else {
-			$name = $filename;
-			$ext = '';
-		}
-
-		$newpath = $path . '/' . $filename;
-		if ($view->file_exists($newpath)) {
-			if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
-				//Replace the last "(number)" with "(number+1)"
-				$last_match = count($matches[0]) - 1;
-				$counter = $matches[1][$last_match][0] + 1;
-				$offset = $matches[0][$last_match][1];
-				$match_length = strlen($matches[0][$last_match][0]);
-			} else {
-				$counter = 2;
-				$match_length = 0;
-				$offset = false;
-			}
-			do {
-				if ($offset) {
-					//Replace the last "(number)" with "(number+1)"
-					$newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
-				} else {
-					$newname = $name . ' (' . $counter . ')';
-				}
-				$newpath = $path . '/' . $newname . $ext;
-				$counter++;
-			} while ($view->file_exists($newpath));
-		}
-
-		return $newpath;
-	}
-
-	/**
-	 * Checks if $sub is a subdirectory of $parent
-	 *
-	 * @param string $sub
-	 * @param string $parent
-	 * @return bool
-	 */
-	public static function isSubDirectory($sub, $parent) {
-		$realpathSub = realpath($sub);
-		$realpathParent = realpath($parent);
-
-		// realpath() may return false in case the directory does not exist
-		// since we can not be sure how different PHP versions may behave here
-		// we do an additional check whether realpath returned false
-		if($realpathSub === false ||  $realpathParent === false) {
-			return false;
-		}
-
-		// Check whether $sub is a subdirectory of $parent
-		if (strpos($realpathSub, $realpathParent) === 0) {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
-	 *
-	 * @param array $input The array to work on
-	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @return array
-	 *
-	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
-	 * based on http://www.php.net/manual/en/function.array-change-key-case.php#107715
-	 *
-	 */
-	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
-		$case = ($case != MB_CASE_UPPER) ? MB_CASE_LOWER : MB_CASE_UPPER;
-		$ret = array();
-		foreach ($input as $k => $v) {
-			$ret[mb_convert_case($k, $case, $encoding)] = $v;
-		}
-		return $ret;
-	}
-
-	/**
-	 * performs a search in a nested array
-	 * @param array $haystack the array to be searched
-	 * @param string $needle the search string
-	 * @param string $index optional, only search this key name
-	 * @return mixed the key of the matching field, otherwise false
-	 *
-	 * performs a search in a nested array
-	 *
-	 * taken from http://www.php.net/manual/en/function.array-search.php#97645
-	 */
-	public static function recursiveArraySearch($haystack, $needle, $index = null) {
-		$aIt = new RecursiveArrayIterator($haystack);
-		$it = new RecursiveIteratorIterator($aIt);
-
-		while ($it->valid()) {
-			if (((isset($index) AND ($it->key() == $index)) OR (!isset($index))) AND ($it->current() == $needle)) {
-				return $aIt->key();
-			}
-
-			$it->next();
-		}
-
-		return false;
-	}
-
-	/**
-	 * calculates the maximum upload size respecting system settings, free space and user quota
-	 *
-	 * @param string $dir the current folder where the user currently operates
-	 * @param int $freeSpace the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
-	 * @return int number of bytes representing
-	 */
-	public static function maxUploadFilesize($dir, $freeSpace = null) {
-		if (is_null($freeSpace) || $freeSpace < 0){
-			$freeSpace = self::freeSpace($dir);
-		}
-		return min($freeSpace, self::uploadLimit());
-	}
-
-	/**
-	 * Calculate free space left within user quota
-	 *
-	 * @param string $dir the current folder where the user currently operates
-	 * @return int number of bytes representing
-	 */
-	public static function freeSpace($dir) {
-		$freeSpace = \OC\Files\Filesystem::free_space($dir);
-		if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-			$freeSpace = max($freeSpace, 0);
-			return $freeSpace;
-		} else {
-			return (INF > 0)? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
-		}
-	}
-
-	/**
-	 * Calculate PHP upload limit
-	 *
-	 * @return int PHP upload file size limit
-	 */
-	public static function uploadLimit() {
-		$ini = \OC::$server->getIniWrapper();
-		$upload_max_filesize = OCP\Util::computerFileSize($ini->get('upload_max_filesize'));
-		$post_max_size = OCP\Util::computerFileSize($ini->get('post_max_size'));
-		if ((int)$upload_max_filesize === 0 and (int)$post_max_size === 0) {
-			return INF;
-		} elseif ((int)$upload_max_filesize === 0 or (int)$post_max_size === 0) {
-			return max($upload_max_filesize, $post_max_size); //only the non 0 value counts
-		} else {
-			return min($upload_max_filesize, $post_max_size);
-		}
-	}
-
-	/**
-	 * Checks if a function is available
-	 *
-	 * @param string $function_name
-	 * @return bool
-	 */
-	public static function is_function_enabled($function_name) {
-		if (!function_exists($function_name)) {
-			return false;
-		}
-		$ini = \OC::$server->getIniWrapper();
-		$disabled = explode(',', $ini->get('disable_functions'));
-		$disabled = array_map('trim', $disabled);
-		if (in_array($function_name, $disabled)) {
-			return false;
-		}
-		$disabled = explode(',', $ini->get('suhosin.executor.func.blacklist'));
-		$disabled = array_map('trim', $disabled);
-		if (in_array($function_name, $disabled)) {
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * Try to find a program
-	 * Note: currently windows is not supported
-	 *
-	 * @param string $program
-	 * @return null|string
-	 */
-	public static function findBinaryPath($program) {
-		$memcache = \OC::$server->getMemCacheFactory()->create('findBinaryPath');
-		if ($memcache->hasKey($program)) {
-			return $memcache->get($program);
-		}
-		$result = null;
-		if (self::is_function_enabled('exec')) {
-			$exeSniffer = new ExecutableFinder();
-			// Returns null if nothing is found
-			$result = $exeSniffer->find($program);
-			if (empty($result)) {
-				$paths = getenv('PATH');
-				if (empty($paths)) {
-					$paths = '/usr/local/bin /usr/bin /opt/bin /bin';
-				} else {
-					$paths = str_replace(':',' ',getenv('PATH'));
-				}
-				$command = 'find ' . $paths . ' -name ' . escapeshellarg($program) . ' 2> /dev/null';
-				exec($command, $output, $returnCode);
-				if (count($output) > 0) {
-					$result = escapeshellcmd($output[0]);
-				}
-			}
-		}
-		// store the value for 5 minutes
-		$memcache->set($program, $result, 300);
-		return $result;
-	}
-
-	/**
-	 * Calculate the disc space for the given path
-	 *
-	 * @param string $path
-	 * @param \OCP\Files\FileInfo $rootInfo (optional)
-	 * @return array
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	public static function getStorageInfo($path, $rootInfo = null) {
-		// return storage info without adding mount points
-		$includeExtStorage = \OC::$server->getSystemConfig()->getValue('quota_include_external_storage', false);
-
-		if (!$rootInfo) {
-			$rootInfo = \OC\Files\Filesystem::getFileInfo($path, false);
-		}
-		if (!$rootInfo instanceof \OCP\Files\FileInfo) {
-			throw new \OCP\Files\NotFoundException();
-		}
-		$used = $rootInfo->getSize();
-		if ($used < 0) {
-			$used = 0;
-		}
-		$quota = \OCP\Files\FileInfo::SPACE_UNLIMITED;
-		$storage = $rootInfo->getStorage();
-		$sourceStorage = $storage;
-		if ($storage->instanceOfStorage('\OC\Files\Storage\Shared')) {
-			$includeExtStorage = false;
-			$sourceStorage = $storage->getSourceStorage();
-		}
-		if ($includeExtStorage) {
-			$quota = OC_Util::getUserQuota(\OCP\User::getUser());
-			if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-				// always get free space / total space from root + mount points
-				return self::getGlobalStorageInfo();
-			}
-		}
-
-		// TODO: need a better way to get total space from storage
-		if ($sourceStorage->instanceOfStorage('\OC\Files\Storage\Wrapper\Quota')) {
-			/** @var \OC\Files\Storage\Wrapper\Quota $storage */
-			$quota = $sourceStorage->getQuota();
-		}
-		$free = $sourceStorage->free_space('');
-		if ($free >= 0) {
-			$total = $free + $used;
-		} else {
-			$total = $free; //either unknown or unlimited
-		}
-		if ($total > 0) {
-			if ($quota > 0 && $total > $quota) {
-				$total = $quota;
-			}
-			// prevent division by zero or error codes (negative values)
-			$relative = round(($used / $total) * 10000) / 100;
-		} else {
-			$relative = 0;
-		}
-
-		$ownerId = $storage->getOwner($path);
-		$ownerDisplayName = '';
-		$owner = \OC::$server->getUserManager()->get($ownerId);
-		if($owner) {
-			$ownerDisplayName = $owner->getDisplayName();
-		}
-
-		return [
-			'free' => $free,
-			'used' => $used,
-			'quota' => $quota,
-			'total' => $total,
-			'relative' => $relative,
-			'owner' => $ownerId,
-			'ownerDisplayName' => $ownerDisplayName,
-		];
-	}
-
-	/**
-	 * Get storage info including all mount points and quota
-	 *
-	 * @return array
-	 */
-	private static function getGlobalStorageInfo() {
-		$quota = OC_Util::getUserQuota(\OCP\User::getUser());
-
-		$rootInfo = \OC\Files\Filesystem::getFileInfo('', 'ext');
-		$used = $rootInfo['size'];
-		if ($used < 0) {
-			$used = 0;
-		}
-
-		$total = $quota;
-		$free = $quota - $used;
-
-		if ($total > 0) {
-			if ($quota > 0 && $total > $quota) {
-				$total = $quota;
-			}
-			// prevent division by zero or error codes (negative values)
-			$relative = round(($used / $total) * 10000) / 100;
-		} else {
-			$relative = 0;
-		}
-
-		return array('free' => $free, 'used' => $used, 'total' => $total, 'relative' => $relative);
-
-	}
-
-	/**
-	 * Returns whether the config file is set manually to read-only
-	 * @return bool
-	 */
-	public static function isReadOnlyConfigEnabled() {
-		return \OC::$server->getConfig()->getSystemValue('config_is_read_only', false);
-	}
+    private static $templateManager;
+
+    /**
+     * Creates an absolute url for public use
+     * @param string $service id
+     * @param bool $add_slash
+     * @return string the url
+     *
+     * Returns a absolute url to the given service.
+     */
+    public static function linkToPublic($service, $add_slash = false) {
+        if ($service === 'files') {
+            $url = OC::$server->getURLGenerator()->getAbsoluteURL('/s');
+        } else {
+            $url = OC::$server->getURLGenerator()->getAbsoluteURL(OC::$server->getURLGenerator()->linkTo('', 'public.php').'?service='.$service);
+        }
+        return $url . (($add_slash && $service[strlen($service) - 1] != '/') ? '/' : '');
+    }
+
+    /**
+     * Make a human file size
+     * @param int $bytes file size in bytes
+     * @return string a human readable file size
+     *
+     * Makes 2048 to 2 kB.
+     */
+    public static function humanFileSize($bytes) {
+        if ($bytes < 0) {
+            return "?";
+        }
+        if ($bytes < 1024) {
+            return "$bytes B";
+        }
+        $bytes = round($bytes / 1024, 0);
+        if ($bytes < 1024) {
+            return "$bytes KB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes MB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes GB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes TB";
+        }
+
+        $bytes = round($bytes / 1024, 1);
+        return "$bytes PB";
+    }
+
+    /**
+     * Make a php file size
+     * @param int $bytes file size in bytes
+     * @return string a php parseable file size
+     *
+     * Makes 2048 to 2k and 2^41 to 2048G
+     */
+    public static function phpFileSize($bytes) {
+        if ($bytes < 0) {
+            return "?";
+        }
+        if ($bytes < 1024) {
+            return $bytes . "B";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return $bytes . "K";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return $bytes . "M";
+        }
+        $bytes = round($bytes / 1024, 1);
+        return $bytes . "G";
+    }
+
+    /**
+     * Make a computer file size
+     * @param string $str file size in human readable format
+     * @return float a file size in bytes
+     *
+     * Makes 2kB to 2048.
+     *
+     * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
+     */
+    public static function computerFileSize($str) {
+        $str = strtolower($str);
+        if (is_numeric($str)) {
+            return floatval($str);
+        }
+
+        $bytes_array = array(
+            'b' => 1,
+            'k' => 1024,
+            'kb' => 1024,
+            'mb' => 1024 * 1024,
+            'm' => 1024 * 1024,
+            'gb' => 1024 * 1024 * 1024,
+            'g' => 1024 * 1024 * 1024,
+            'tb' => 1024 * 1024 * 1024 * 1024,
+            't' => 1024 * 1024 * 1024 * 1024,
+            'pb' => 1024 * 1024 * 1024 * 1024 * 1024,
+            'p' => 1024 * 1024 * 1024 * 1024 * 1024,
+        );
+
+        $bytes = floatval($str);
+
+        if (preg_match('#([kmgtp]?b?)$#si', $str, $matches) && !empty($bytes_array[$matches[1]])) {
+            $bytes *= $bytes_array[$matches[1]];
+        } else {
+            return false;
+        }
+
+        $bytes = round($bytes);
+
+        return $bytes;
+    }
+
+    /**
+     * Recursive copying of folders
+     * @param string $src source folder
+     * @param string $dest target folder
+     *
+     */
+    static function copyr($src, $dest) {
+        if (is_dir($src)) {
+            if (!is_dir($dest)) {
+                mkdir($dest);
+            }
+            $files = scandir($src);
+            foreach ($files as $file) {
+                if ($file != "." && $file != "..") {
+                    self::copyr("$src/$file", "$dest/$file");
+                }
+            }
+        } elseif (file_exists($src) && !\OC\Files\Filesystem::isFileBlacklisted($src)) {
+            copy($src, $dest);
+        }
+    }
+
+    /**
+     * Recursive deletion of folders
+     * @param string $dir path to the folder
+     * @param bool $deleteSelf if set to false only the content of the folder will be deleted
+     * @return bool
+     */
+    static function rmdirr($dir, $deleteSelf = true) {
+        if (is_dir($dir)) {
+            $files = new RecursiveIteratorIterator(
+                new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS),
+                RecursiveIteratorIterator::CHILD_FIRST
+            );
+
+            foreach ($files as $fileInfo) {
+                /** @var SplFileInfo $fileInfo */
+                if ($fileInfo->isLink()) {
+                    unlink($fileInfo->getPathname());
+                } else if ($fileInfo->isDir()) {
+                    rmdir($fileInfo->getRealPath());
+                } else {
+                    unlink($fileInfo->getRealPath());
+                }
+            }
+            if ($deleteSelf) {
+                rmdir($dir);
+            }
+        } elseif (file_exists($dir)) {
+            if ($deleteSelf) {
+                unlink($dir);
+            }
+        }
+        if (!$deleteSelf) {
+            return true;
+        }
+
+        return !file_exists($dir);
+    }
+
+    /**
+     * @return \OC\Files\Type\TemplateManager
+     */
+    static public function getFileTemplateManager() {
+        if (!self::$templateManager) {
+            self::$templateManager = new \OC\Files\Type\TemplateManager();
+        }
+        return self::$templateManager;
+    }
+
+    /**
+     * detect if a given program is found in the search PATH
+     *
+     * @param string $name
+     * @param bool $path
+     * @internal param string $program name
+     * @internal param string $optional search path, defaults to $PATH
+     * @return bool    true if executable program found in path
+     */
+    public static function canExecute($name, $path = false) {
+        // path defaults to PATH from environment if not set
+        if ($path === false) {
+            $path = getenv("PATH");
+        }
+        // check method depends on operating system
+        if (!strncmp(PHP_OS, "WIN", 3)) {
+            // on Windows an appropriate COM or EXE file needs to exist
+            $exts = array(".exe", ".com");
+            $check_fn = "file_exists";
+        } else {
+            // anywhere else we look for an executable file of that name
+            $exts = array("");
+            $check_fn = "is_executable";
+        }
+        // Default check will be done with $path directories :
+        $dirs = explode(PATH_SEPARATOR, $path);
+        // WARNING : We have to check if open_basedir is enabled :
+        $obd = OC::$server->getIniWrapper()->getString('open_basedir');
+        if ($obd != "none") {
+            $obd_values = explode(PATH_SEPARATOR, $obd);
+            if (count($obd_values) > 0 and $obd_values[0]) {
+                // open_basedir is in effect !
+                // We need to check if the program is in one of these dirs :
+                $dirs = $obd_values;
+            }
+        }
+        foreach ($dirs as $dir) {
+            foreach ($exts as $ext) {
+                if ($check_fn("$dir/$name" . $ext))
+                    return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * copy the contents of one stream to another
+     *
+     * @param resource $source
+     * @param resource $target
+     * @return array the number of bytes copied and result
+     */
+    public static function streamCopy($source, $target) {
+        if (!$source or !$target) {
+            return array(0, false);
+        }
+        $bufSize = 8192;
+        $result = true;
+        $count = 0;
+        while (!feof($source)) {
+            $buf = fread($source, $bufSize);
+            $bytesWritten = fwrite($target, $buf);
+            if ($bytesWritten !== false) {
+                $count += $bytesWritten;
+            }
+            // note: strlen is expensive so only use it when necessary,
+            // on the last block
+            if ($bytesWritten === false
+                || ($bytesWritten < $bufSize && $bytesWritten < strlen($buf))
+            ) {
+                // write error, could be disk full ?
+                $result = false;
+                break;
+            }
+        }
+        return array($count, $result);
+    }
+
+    /**
+     * Adds a suffix to the name in case the file exists
+     *
+     * @param string $path
+     * @param string $filename
+     * @return string
+     */
+    public static function buildNotExistingFileName($path, $filename) {
+        $view = \OC\Files\Filesystem::getView();
+        return self::buildNotExistingFileNameForView($path, $filename, $view);
+    }
+
+    /**
+     * Adds a suffix to the name in case the file exists
+     *
+     * @param string $path
+     * @param string $filename
+     * @return string
+     */
+    public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
+        if ($path === '/') {
+            $path = '';
+        }
+        if ($pos = strrpos($filename, '.')) {
+            $name = substr($filename, 0, $pos);
+            $ext = substr($filename, $pos);
+        } else {
+            $name = $filename;
+            $ext = '';
+        }
+
+        $newpath = $path . '/' . $filename;
+        if ($view->file_exists($newpath)) {
+            if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
+                //Replace the last "(number)" with "(number+1)"
+                $last_match = count($matches[0]) - 1;
+                $counter = $matches[1][$last_match][0] + 1;
+                $offset = $matches[0][$last_match][1];
+                $match_length = strlen($matches[0][$last_match][0]);
+            } else {
+                $counter = 2;
+                $match_length = 0;
+                $offset = false;
+            }
+            do {
+                if ($offset) {
+                    //Replace the last "(number)" with "(number+1)"
+                    $newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
+                } else {
+                    $newname = $name . ' (' . $counter . ')';
+                }
+                $newpath = $path . '/' . $newname . $ext;
+                $counter++;
+            } while ($view->file_exists($newpath));
+        }
+
+        return $newpath;
+    }
+
+    /**
+     * Checks if $sub is a subdirectory of $parent
+     *
+     * @param string $sub
+     * @param string $parent
+     * @return bool
+     */
+    public static function isSubDirectory($sub, $parent) {
+        $realpathSub = realpath($sub);
+        $realpathParent = realpath($parent);
+
+        // realpath() may return false in case the directory does not exist
+        // since we can not be sure how different PHP versions may behave here
+        // we do an additional check whether realpath returned false
+        if($realpathSub === false ||  $realpathParent === false) {
+            return false;
+        }
+
+        // Check whether $sub is a subdirectory of $parent
+        if (strpos($realpathSub, $realpathParent) === 0) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+     *
+     * @param array $input The array to work on
+     * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+     * @return array
+     *
+     * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+     * based on http://www.php.net/manual/en/function.array-change-key-case.php#107715
+     *
+     */
+    public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
+        $case = ($case != MB_CASE_UPPER) ? MB_CASE_LOWER : MB_CASE_UPPER;
+        $ret = array();
+        foreach ($input as $k => $v) {
+            $ret[mb_convert_case($k, $case, $encoding)] = $v;
+        }
+        return $ret;
+    }
+
+    /**
+     * performs a search in a nested array
+     * @param array $haystack the array to be searched
+     * @param string $needle the search string
+     * @param string $index optional, only search this key name
+     * @return mixed the key of the matching field, otherwise false
+     *
+     * performs a search in a nested array
+     *
+     * taken from http://www.php.net/manual/en/function.array-search.php#97645
+     */
+    public static function recursiveArraySearch($haystack, $needle, $index = null) {
+        $aIt = new RecursiveArrayIterator($haystack);
+        $it = new RecursiveIteratorIterator($aIt);
+
+        while ($it->valid()) {
+            if (((isset($index) AND ($it->key() == $index)) OR (!isset($index))) AND ($it->current() == $needle)) {
+                return $aIt->key();
+            }
+
+            $it->next();
+        }
+
+        return false;
+    }
+
+    /**
+     * calculates the maximum upload size respecting system settings, free space and user quota
+     *
+     * @param string $dir the current folder where the user currently operates
+     * @param int $freeSpace the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
+     * @return int number of bytes representing
+     */
+    public static function maxUploadFilesize($dir, $freeSpace = null) {
+        if (is_null($freeSpace) || $freeSpace < 0){
+            $freeSpace = self::freeSpace($dir);
+        }
+        return min($freeSpace, self::uploadLimit());
+    }
+
+    /**
+     * Calculate free space left within user quota
+     *
+     * @param string $dir the current folder where the user currently operates
+     * @return int number of bytes representing
+     */
+    public static function freeSpace($dir) {
+        $freeSpace = \OC\Files\Filesystem::free_space($dir);
+        if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+            $freeSpace = max($freeSpace, 0);
+            return $freeSpace;
+        } else {
+            return (INF > 0)? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
+        }
+    }
+
+    /**
+     * Calculate PHP upload limit
+     *
+     * @return int PHP upload file size limit
+     */
+    public static function uploadLimit() {
+        $ini = \OC::$server->getIniWrapper();
+        $upload_max_filesize = OCP\Util::computerFileSize($ini->get('upload_max_filesize'));
+        $post_max_size = OCP\Util::computerFileSize($ini->get('post_max_size'));
+        if ((int)$upload_max_filesize === 0 and (int)$post_max_size === 0) {
+            return INF;
+        } elseif ((int)$upload_max_filesize === 0 or (int)$post_max_size === 0) {
+            return max($upload_max_filesize, $post_max_size); //only the non 0 value counts
+        } else {
+            return min($upload_max_filesize, $post_max_size);
+        }
+    }
+
+    /**
+     * Checks if a function is available
+     *
+     * @param string $function_name
+     * @return bool
+     */
+    public static function is_function_enabled($function_name) {
+        if (!function_exists($function_name)) {
+            return false;
+        }
+        $ini = \OC::$server->getIniWrapper();
+        $disabled = explode(',', $ini->get('disable_functions'));
+        $disabled = array_map('trim', $disabled);
+        if (in_array($function_name, $disabled)) {
+            return false;
+        }
+        $disabled = explode(',', $ini->get('suhosin.executor.func.blacklist'));
+        $disabled = array_map('trim', $disabled);
+        if (in_array($function_name, $disabled)) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Try to find a program
+     * Note: currently windows is not supported
+     *
+     * @param string $program
+     * @return null|string
+     */
+    public static function findBinaryPath($program) {
+        $memcache = \OC::$server->getMemCacheFactory()->create('findBinaryPath');
+        if ($memcache->hasKey($program)) {
+            return $memcache->get($program);
+        }
+        $result = null;
+        if (self::is_function_enabled('exec')) {
+            $exeSniffer = new ExecutableFinder();
+            // Returns null if nothing is found
+            $result = $exeSniffer->find($program);
+            if (empty($result)) {
+                $paths = getenv('PATH');
+                if (empty($paths)) {
+                    $paths = '/usr/local/bin /usr/bin /opt/bin /bin';
+                } else {
+                    $paths = str_replace(':',' ',getenv('PATH'));
+                }
+                $command = 'find ' . $paths . ' -name ' . escapeshellarg($program) . ' 2> /dev/null';
+                exec($command, $output, $returnCode);
+                if (count($output) > 0) {
+                    $result = escapeshellcmd($output[0]);
+                }
+            }
+        }
+        // store the value for 5 minutes
+        $memcache->set($program, $result, 300);
+        return $result;
+    }
+
+    /**
+     * Calculate the disc space for the given path
+     *
+     * @param string $path
+     * @param \OCP\Files\FileInfo $rootInfo (optional)
+     * @return array
+     * @throws \OCP\Files\NotFoundException
+     */
+    public static function getStorageInfo($path, $rootInfo = null) {
+        // return storage info without adding mount points
+        $includeExtStorage = \OC::$server->getSystemConfig()->getValue('quota_include_external_storage', false);
+
+        if (!$rootInfo) {
+            $rootInfo = \OC\Files\Filesystem::getFileInfo($path, false);
+        }
+        if (!$rootInfo instanceof \OCP\Files\FileInfo) {
+            throw new \OCP\Files\NotFoundException();
+        }
+        $used = $rootInfo->getSize();
+        if ($used < 0) {
+            $used = 0;
+        }
+        $quota = \OCP\Files\FileInfo::SPACE_UNLIMITED;
+        $storage = $rootInfo->getStorage();
+        $sourceStorage = $storage;
+        if ($storage->instanceOfStorage('\OC\Files\Storage\Shared')) {
+            $includeExtStorage = false;
+            $sourceStorage = $storage->getSourceStorage();
+        }
+        if ($includeExtStorage) {
+            $quota = OC_Util::getUserQuota(\OCP\User::getUser());
+            if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+                // always get free space / total space from root + mount points
+                return self::getGlobalStorageInfo();
+            }
+        }
+
+        // TODO: need a better way to get total space from storage
+        if ($sourceStorage->instanceOfStorage('\OC\Files\Storage\Wrapper\Quota')) {
+            /** @var \OC\Files\Storage\Wrapper\Quota $storage */
+            $quota = $sourceStorage->getQuota();
+        }
+        $free = $sourceStorage->free_space('');
+        if ($free >= 0) {
+            $total = $free + $used;
+        } else {
+            $total = $free; //either unknown or unlimited
+        }
+        if ($total > 0) {
+            if ($quota > 0 && $total > $quota) {
+                $total = $quota;
+            }
+            // prevent division by zero or error codes (negative values)
+            $relative = round(($used / $total) * 10000) / 100;
+        } else {
+            $relative = 0;
+        }
+
+        $ownerId = $storage->getOwner($path);
+        $ownerDisplayName = '';
+        $owner = \OC::$server->getUserManager()->get($ownerId);
+        if($owner) {
+            $ownerDisplayName = $owner->getDisplayName();
+        }
+
+        return [
+            'free' => $free,
+            'used' => $used,
+            'quota' => $quota,
+            'total' => $total,
+            'relative' => $relative,
+            'owner' => $ownerId,
+            'ownerDisplayName' => $ownerDisplayName,
+        ];
+    }
+
+    /**
+     * Get storage info including all mount points and quota
+     *
+     * @return array
+     */
+    private static function getGlobalStorageInfo() {
+        $quota = OC_Util::getUserQuota(\OCP\User::getUser());
+
+        $rootInfo = \OC\Files\Filesystem::getFileInfo('', 'ext');
+        $used = $rootInfo['size'];
+        if ($used < 0) {
+            $used = 0;
+        }
+
+        $total = $quota;
+        $free = $quota - $used;
+
+        if ($total > 0) {
+            if ($quota > 0 && $total > $quota) {
+                $total = $quota;
+            }
+            // prevent division by zero or error codes (negative values)
+            $relative = round(($used / $total) * 10000) / 100;
+        } else {
+            $relative = 0;
+        }
+
+        return array('free' => $free, 'used' => $used, 'total' => $total, 'relative' => $relative);
+
+    }
+
+    /**
+     * Returns whether the config file is set manually to read-only
+     * @return bool
+     */
+    public static function isReadOnlyConfigEnabled() {
+        return \OC::$server->getConfig()->getSystemValue('config_is_read_only', false);
+    }
 }

Spacing +18 added lines, -18 removed lines

@@ -64,7 +64,7 @@ 
 		} else {
 			$url = OC::$server->getURLGenerator()->getAbsoluteURL(OC::$server->getURLGenerator()->linkTo('', 'public.php').'?service='.$service);
 		}
-		return $url . (($add_slash && $service[strlen($service) - 1] != '/') ? '/' : '');
+		return $url.(($add_slash && $service[strlen($service) - 1] != '/') ? '/' : '');
 	}
 
 	/**
@@ -114,18 +114,18 @@ 
 			return "?";
 		}
 		if ($bytes < 1024) {
-			return $bytes . "B";
+			return $bytes."B";
 		}
 		$bytes = round($bytes / 1024, 1);
 		if ($bytes < 1024) {
-			return $bytes . "K";
+			return $bytes."K";
 		}
 		$bytes = round($bytes / 1024, 1);
 		if ($bytes < 1024) {
-			return $bytes . "M";
+			return $bytes."M";
 		}
 		$bytes = round($bytes / 1024, 1);
-		return $bytes . "G";
+		return $bytes."G";
 	}
 
 	/**
@@ -278,7 +278,7 @@ 
 		}
 		foreach ($dirs as $dir) {
 			foreach ($exts as $ext) {
-				if ($check_fn("$dir/$name" . $ext))
+				if ($check_fn("$dir/$name".$ext))
 					return true;
 			}
 		}
@@ -349,7 +349,7 @@ 
 			$ext = '';
 		}
 
-		$newpath = $path . '/' . $filename;
+		$newpath = $path.'/'.$filename;
 		if ($view->file_exists($newpath)) {
 			if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
 				//Replace the last "(number)" with "(number+1)"
@@ -365,11 +365,11 @@ 
 			do {
 				if ($offset) {
 					//Replace the last "(number)" with "(number+1)"
-					$newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
+					$newname = substr_replace($name, '('.$counter.')', $offset, $match_length);
 				} else {
-					$newname = $name . ' (' . $counter . ')';
+					$newname = $name.' ('.$counter.')';
 				}
-				$newpath = $path . '/' . $newname . $ext;
+				$newpath = $path.'/'.$newname.$ext;
 				$counter++;
 			} while ($view->file_exists($newpath));
 		}
@@ -391,7 +391,7 @@ 
 		// realpath() may return false in case the directory does not exist
 		// since we can not be sure how different PHP versions may behave here
 		// we do an additional check whether realpath returned false
-		if($realpathSub === false ||  $realpathParent === false) {
+		if ($realpathSub === false || $realpathParent === false) {
 			return false;
 		}
 
@@ -458,7 +458,7 @@ 
 	 * @return int number of bytes representing
 	 */
 	public static function maxUploadFilesize($dir, $freeSpace = null) {
-		if (is_null($freeSpace) || $freeSpace < 0){
+		if (is_null($freeSpace) || $freeSpace < 0) {
 			$freeSpace = self::freeSpace($dir);
 		}
 		return min($freeSpace, self::uploadLimit());
@@ -476,7 +476,7 @@ 
 			$freeSpace = max($freeSpace, 0);
 			return $freeSpace;
 		} else {
-			return (INF > 0)? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
+			return (INF > 0) ? INF : PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
 		}
 	}
 
@@ -489,9 +489,9 @@ 
 		$ini = \OC::$server->getIniWrapper();
 		$upload_max_filesize = OCP\Util::computerFileSize($ini->get('upload_max_filesize'));
 		$post_max_size = OCP\Util::computerFileSize($ini->get('post_max_size'));
-		if ((int)$upload_max_filesize === 0 and (int)$post_max_size === 0) {
+		if ((int) $upload_max_filesize === 0 and (int) $post_max_size === 0) {
 			return INF;
-		} elseif ((int)$upload_max_filesize === 0 or (int)$post_max_size === 0) {
+		} elseif ((int) $upload_max_filesize === 0 or (int) $post_max_size === 0) {
 			return max($upload_max_filesize, $post_max_size); //only the non 0 value counts
 		} else {
 			return min($upload_max_filesize, $post_max_size);
@@ -544,9 +544,9 @@ 
 				if (empty($paths)) {
 					$paths = '/usr/local/bin /usr/bin /opt/bin /bin';
 				} else {
-					$paths = str_replace(':',' ',getenv('PATH'));
+					$paths = str_replace(':', ' ', getenv('PATH'));
 				}
-				$command = 'find ' . $paths . ' -name ' . escapeshellarg($program) . ' 2> /dev/null';
+				$command = 'find '.$paths.' -name '.escapeshellarg($program).' 2> /dev/null';
 				exec($command, $output, $returnCode);
 				if (count($output) > 0) {
 					$result = escapeshellcmd($output[0]);
@@ -619,7 +619,7 @@ 
 		$ownerId = $storage->getOwner($path);
 		$ownerDisplayName = '';
 		$owner = \OC::$server->getUserManager()->get($ownerId);
-		if($owner) {
+		if ($owner) {
 			$ownerDisplayName = $owner->getDisplayName();
 		}
 

lib/private/legacy/l10n.php

Doc Comments +1 added lines, -1 removed lines

@@ -323,7 +323,7 @@
 	/**
 	 * find all available languages for an app
 	 * @param string $app App that needs to be translated
-	 * @return array an array of available languages
+	 * @return string[] an array of available languages
 	 * @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->findAvailableLanguages() instead
 	 */
 	public static function findAvailableLanguages($app=null) {

Indentation +305 added lines, -305 removed lines

@@ -35,309 +35,309 @@
  * @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->get() instead
  */
 class OC_L10N implements \OCP\IL10N {
-	/**
-	 * cache
-	 */
-	protected static $cache = array();
-	protected static $availableLanguages = array();
-
-	/**
-	 * The best language
-	 */
-	protected static $language = '';
-
-	/**
-	 * App of this object
-	 */
-	protected $app;
-
-	/**
-	 * Language of this object
-	 */
-	protected $lang;
-
-	/**
-	 * Translations
-	 */
-	private $translations = array();
-
-	/**
-	 * Plural forms (string)
-	 */
-	private $pluralFormString = 'nplurals=2; plural=(n != 1);';
-
-	/**
-	 * Plural forms (function)
-	 */
-	private $pluralFormFunction = null;
-
-	/**
-	 * The constructor
-	 * @param string $app app requesting l10n
-	 * @param string $lang default: null Language
-	 *
-	 * If language is not set, the constructor tries to find the right
-	 * language.
-	 * @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->get() instead
-	 */
-	public function __construct($app, $lang = null) {
-		$app = \OC_App::cleanAppId($app);
-		$this->app = $app;
-
-		if ($lang !== null) {
-			$lang = str_replace(array('\0', '/', '\\', '..'), '', $lang);
-		}
-
-		// Find the right language
-		if ($app !== 'test' && !\OC::$server->getL10NFactory()->languageExists($app, $lang)) {
-			$lang = \OC::$server->getL10NFactory()->findLanguage($app);
-		}
-
-		$this->lang = $lang;
-	}
-
-	/**
-	 * @param $transFile
-	 * @return bool
-	 */
-	public function load($transFile) {
-		$this->app = true;
-
-		$json = json_decode(file_get_contents($transFile), true);
-		if (!is_array($json)) {
-			$jsonError = json_last_error();
-			\OC::$server->getLogger()->warning("Failed to load $transFile - json error code: $jsonError", ['app' => 'l10n']);
-			return false;
-		}
-
-		$this->pluralFormString = $json['pluralForm'];
-		$translations = $json['translations'];
-
-		$this->translations = array_merge($this->translations, $translations);
-
-		return true;
-	}
-
-	protected function init() {
-		if ($this->app === true) {
-			return;
-		}
-		$app = $this->app;
-		$lang = $this->lang;
-		$this->app = true;
-
-		/** @var \OC\L10N\Factory $factory */
-		$factory = \OC::$server->getL10NFactory();
-		$languageFiles = $factory->getL10nFilesForApp($app, $lang);
-
-		$this->translations = [];
-		foreach ($languageFiles as $languageFile) {
-			$this->load($languageFile);
-		}
-	}
-
-	/**
-	 * Translating
-	 * @param string $text The text we need a translation for
-	 * @param array $parameters default:array() Parameters for sprintf
-	 * @return \OC_L10N_String Translation or the same text
-	 *
-	 * Returns the translation. If no translation is found, $text will be
-	 * returned.
-	 */
-	public function t($text, $parameters = array()) {
-		return new OC_L10N_String($this, $text, $parameters);
-	}
-
-	/**
-	 * Translating
-	 * @param string $text_singular the string to translate for exactly one object
-	 * @param string $text_plural the string to translate for n objects
-	 * @param integer $count Number of objects
-	 * @param array $parameters default:array() Parameters for sprintf
-	 * @return \OC_L10N_String Translation or the same text
-	 *
-	 * Returns the translation. If no translation is found, $text will be
-	 * returned. %n will be replaced with the number of objects.
-	 *
-	 * The correct plural is determined by the plural_forms-function
-	 * provided by the po file.
-	 *
-	 */
-	public function n($text_singular, $text_plural, $count, $parameters = array()) {
-		$this->init();
-		$identifier = "_${text_singular}_::_${text_plural}_";
-		if( array_key_exists($identifier, $this->translations)) {
-			return new OC_L10N_String( $this, $identifier, $parameters, $count );
-		}else{
-			if($count === 1) {
-				return new OC_L10N_String($this, $text_singular, $parameters, $count);
-			}else{
-				return new OC_L10N_String($this, $text_plural, $parameters, $count);
-			}
-		}
-	}
-
-	/**
-	 * getTranslations
-	 * @return array Fetch all translations
-	 *
-	 * Returns an associative array with all translations
-	 */
-	public function getTranslations() {
-		$this->init();
-		return $this->translations;
-	}
-
-	/**
-	 * getPluralFormFunction
-	 * @return string the plural form function
-	 *
-	 * returned function accepts the argument $n
-	 */
-	public function getPluralFormFunction() {
-		$this->init();
-		if (is_null($this->pluralFormFunction)) {
-			$this->pluralFormFunction = \OC::$server->getL10NFactory()->createPluralFunction($this->pluralFormString);
-		}
-		return $this->pluralFormFunction;
-	}
-
-	/**
-	 * Localization
-	 * @param string $type Type of localization
-	 * @param array|int|string $data parameters for this localization
-	 * @param array $options
-	 * @return string|false
-	 *
-	 * Returns the localized data.
-	 *
-	 * Implemented types:
-	 *  - date
-	 *    - Creates a date
-	 *    - params: timestamp (int/string)
-	 *  - datetime
-	 *    - Creates date and time
-	 *    - params: timestamp (int/string)
-	 *  - time
-	 *    - Creates a time
-	 *    - params: timestamp (int/string)
-	 *  - firstday: Returns the first day of the week (0 sunday - 6 saturday)
-	 *  - jsdate: Returns the short JS date format
-	 */
-	public function l($type, $data, $options = array()) {
-		if ($type === 'firstday') {
-			return $this->getFirstWeekDay();
-		}
-		if ($type === 'jsdate') {
-			return $this->getDateFormat();
-		}
-
-		$this->init();
-		$value = new DateTime();
-		if($data instanceof DateTime) {
-			$value = $data;
-		} elseif(is_string($data) && !is_numeric($data)) {
-			$data = strtotime($data);
-			$value->setTimestamp($data);
-		} else {
-			$value->setTimestamp($data);
-		}
-
-		// Use the language of the instance
-		$locale = $this->transformToCLDRLocale($this->getLanguageCode());
-
-		$options = array_merge(array('width' => 'long'), $options);
-		$width = $options['width'];
-		switch($type) {
-			case 'date':
-				return Punic\Calendar::formatDate($value, $width, $locale);
-			case 'datetime':
-				return Punic\Calendar::formatDatetime($value, $width, $locale);
-			case 'time':
-				return Punic\Calendar::formatTime($value, $width, $locale);
-			default:
-				return false;
-		}
-	}
-
-	/**
-	 * The code (en, de, ...) of the language that is used for this OC_L10N object
-	 *
-	 * @return string language
-	 */
-	public function getLanguageCode() {
-		return $this->lang;
-	}
-
-	/**
-	 * @return string
-	 * @throws \Punic\Exception\ValueNotInList
-	 * @deprecated 9.0.0 Use $this->l('jsdate', null) instead
-	 */
-	public function getDateFormat() {
-		$locale = $this->transformToCLDRLocale($this->getLanguageCode());
-		return Punic\Calendar::getDateFormat('short', $locale);
-	}
-
-	/**
-	 * @return int
-	 * @deprecated 9.0.0 Use $this->l('firstday', null) instead
-	 */
-	public function getFirstWeekDay() {
-		$locale = $this->transformToCLDRLocale($this->getLanguageCode());
-		return Punic\Calendar::getFirstWeekday($locale);
-	}
-
-	/**
-	 * @param string $locale
-	 * @return string
-	 */
-	private function transformToCLDRLocale($locale) {
-		if ($locale === 'sr@latin') {
-			return 'sr_latn';
-		}
-
-		return $locale;
-	}
-
-	/**
-	 * find the best language
-	 * @param string $app
-	 * @return string language
-	 *
-	 * If nothing works it returns 'en'
-	 * @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->findLanguage() instead
-	 */
-	public static function findLanguage($app = null) {
-		return \OC::$server->getL10NFactory()->findLanguage($app);
-	}
-
-	/**
-	 * @return string
-	 * @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->setLanguageFromRequest() instead
-	 */
-	public static function setLanguageFromRequest() {
-		return \OC::$server->getL10NFactory()->setLanguageFromRequest();
-	}
-
-	/**
-	 * find all available languages for an app
-	 * @param string $app App that needs to be translated
-	 * @return array an array of available languages
-	 * @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->findAvailableLanguages() instead
-	 */
-	public static function findAvailableLanguages($app=null) {
-		return \OC::$server->getL10NFactory()->findAvailableLanguages($app);
-	}
-
-	/**
-	 * @param string $app
-	 * @param string $lang
-	 * @return bool
-	 * @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->languageExists() instead
-	 */
-	public static function languageExists($app, $lang) {
-		return \OC::$server->getL10NFactory()->languageExists($app, $lang);
-	}
+    /**
+     * cache
+     */
+    protected static $cache = array();
+    protected static $availableLanguages = array();
+
+    /**
+     * The best language
+     */
+    protected static $language = '';
+
+    /**
+     * App of this object
+     */
+    protected $app;
+
+    /**
+     * Language of this object
+     */
+    protected $lang;
+
+    /**
+     * Translations
+     */
+    private $translations = array();
+
+    /**
+     * Plural forms (string)
+     */
+    private $pluralFormString = 'nplurals=2; plural=(n != 1);';
+
+    /**
+     * Plural forms (function)
+     */
+    private $pluralFormFunction = null;
+
+    /**
+     * The constructor
+     * @param string $app app requesting l10n
+     * @param string $lang default: null Language
+     *
+     * If language is not set, the constructor tries to find the right
+     * language.
+     * @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->get() instead
+     */
+    public function __construct($app, $lang = null) {
+        $app = \OC_App::cleanAppId($app);
+        $this->app = $app;
+
+        if ($lang !== null) {
+            $lang = str_replace(array('\0', '/', '\\', '..'), '', $lang);
+        }
+
+        // Find the right language
+        if ($app !== 'test' && !\OC::$server->getL10NFactory()->languageExists($app, $lang)) {
+            $lang = \OC::$server->getL10NFactory()->findLanguage($app);
+        }
+
+        $this->lang = $lang;
+    }
+
+    /**
+     * @param $transFile
+     * @return bool
+     */
+    public function load($transFile) {
+        $this->app = true;
+
+        $json = json_decode(file_get_contents($transFile), true);
+        if (!is_array($json)) {
+            $jsonError = json_last_error();
+            \OC::$server->getLogger()->warning("Failed to load $transFile - json error code: $jsonError", ['app' => 'l10n']);
+            return false;
+        }
+
+        $this->pluralFormString = $json['pluralForm'];
+        $translations = $json['translations'];
+
+        $this->translations = array_merge($this->translations, $translations);
+
+        return true;
+    }
+
+    protected function init() {
+        if ($this->app === true) {
+            return;
+        }
+        $app = $this->app;
+        $lang = $this->lang;
+        $this->app = true;
+
+        /** @var \OC\L10N\Factory $factory */
+        $factory = \OC::$server->getL10NFactory();
+        $languageFiles = $factory->getL10nFilesForApp($app, $lang);
+
+        $this->translations = [];
+        foreach ($languageFiles as $languageFile) {
+            $this->load($languageFile);
+        }
+    }
+
+    /**
+     * Translating
+     * @param string $text The text we need a translation for
+     * @param array $parameters default:array() Parameters for sprintf
+     * @return \OC_L10N_String Translation or the same text
+     *
+     * Returns the translation. If no translation is found, $text will be
+     * returned.
+     */
+    public function t($text, $parameters = array()) {
+        return new OC_L10N_String($this, $text, $parameters);
+    }
+
+    /**
+     * Translating
+     * @param string $text_singular the string to translate for exactly one object
+     * @param string $text_plural the string to translate for n objects
+     * @param integer $count Number of objects
+     * @param array $parameters default:array() Parameters for sprintf
+     * @return \OC_L10N_String Translation or the same text
+     *
+     * Returns the translation. If no translation is found, $text will be
+     * returned. %n will be replaced with the number of objects.
+     *
+     * The correct plural is determined by the plural_forms-function
+     * provided by the po file.
+     *
+     */
+    public function n($text_singular, $text_plural, $count, $parameters = array()) {
+        $this->init();
+        $identifier = "_${text_singular}_::_${text_plural}_";
+        if( array_key_exists($identifier, $this->translations)) {
+            return new OC_L10N_String( $this, $identifier, $parameters, $count );
+        }else{
+            if($count === 1) {
+                return new OC_L10N_String($this, $text_singular, $parameters, $count);
+            }else{
+                return new OC_L10N_String($this, $text_plural, $parameters, $count);
+            }
+        }
+    }
+
+    /**
+     * getTranslations
+     * @return array Fetch all translations
+     *
+     * Returns an associative array with all translations
+     */
+    public function getTranslations() {
+        $this->init();
+        return $this->translations;
+    }
+
+    /**
+     * getPluralFormFunction
+     * @return string the plural form function
+     *
+     * returned function accepts the argument $n
+     */
+    public function getPluralFormFunction() {
+        $this->init();
+        if (is_null($this->pluralFormFunction)) {
+            $this->pluralFormFunction = \OC::$server->getL10NFactory()->createPluralFunction($this->pluralFormString);
+        }
+        return $this->pluralFormFunction;
+    }
+
+    /**
+     * Localization
+     * @param string $type Type of localization
+     * @param array|int|string $data parameters for this localization
+     * @param array $options
+     * @return string|false
+     *
+     * Returns the localized data.
+     *
+     * Implemented types:
+     *  - date
+     *    - Creates a date
+     *    - params: timestamp (int/string)
+     *  - datetime
+     *    - Creates date and time
+     *    - params: timestamp (int/string)
+     *  - time
+     *    - Creates a time
+     *    - params: timestamp (int/string)
+     *  - firstday: Returns the first day of the week (0 sunday - 6 saturday)
+     *  - jsdate: Returns the short JS date format
+     */
+    public function l($type, $data, $options = array()) {
+        if ($type === 'firstday') {
+            return $this->getFirstWeekDay();
+        }
+        if ($type === 'jsdate') {
+            return $this->getDateFormat();
+        }
+
+        $this->init();
+        $value = new DateTime();
+        if($data instanceof DateTime) {
+            $value = $data;
+        } elseif(is_string($data) && !is_numeric($data)) {
+            $data = strtotime($data);
+            $value->setTimestamp($data);
+        } else {
+            $value->setTimestamp($data);
+        }
+
+        // Use the language of the instance
+        $locale = $this->transformToCLDRLocale($this->getLanguageCode());
+
+        $options = array_merge(array('width' => 'long'), $options);
+        $width = $options['width'];
+        switch($type) {
+            case 'date':
+                return Punic\Calendar::formatDate($value, $width, $locale);
+            case 'datetime':
+                return Punic\Calendar::formatDatetime($value, $width, $locale);
+            case 'time':
+                return Punic\Calendar::formatTime($value, $width, $locale);
+            default:
+                return false;
+        }
+    }
+
+    /**
+     * The code (en, de, ...) of the language that is used for this OC_L10N object
+     *
+     * @return string language
+     */
+    public function getLanguageCode() {
+        return $this->lang;
+    }
+
+    /**
+     * @return string
+     * @throws \Punic\Exception\ValueNotInList
+     * @deprecated 9.0.0 Use $this->l('jsdate', null) instead
+     */
+    public function getDateFormat() {
+        $locale = $this->transformToCLDRLocale($this->getLanguageCode());
+        return Punic\Calendar::getDateFormat('short', $locale);
+    }
+
+    /**
+     * @return int
+     * @deprecated 9.0.0 Use $this->l('firstday', null) instead
+     */
+    public function getFirstWeekDay() {
+        $locale = $this->transformToCLDRLocale($this->getLanguageCode());
+        return Punic\Calendar::getFirstWeekday($locale);
+    }
+
+    /**
+     * @param string $locale
+     * @return string
+     */
+    private function transformToCLDRLocale($locale) {
+        if ($locale === 'sr@latin') {
+            return 'sr_latn';
+        }
+
+        return $locale;
+    }
+
+    /**
+     * find the best language
+     * @param string $app
+     * @return string language
+     *
+     * If nothing works it returns 'en'
+     * @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->findLanguage() instead
+     */
+    public static function findLanguage($app = null) {
+        return \OC::$server->getL10NFactory()->findLanguage($app);
+    }
+
+    /**
+     * @return string
+     * @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->setLanguageFromRequest() instead
+     */
+    public static function setLanguageFromRequest() {
+        return \OC::$server->getL10NFactory()->setLanguageFromRequest();
+    }
+
+    /**
+     * find all available languages for an app
+     * @param string $app App that needs to be translated
+     * @return array an array of available languages
+     * @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->findAvailableLanguages() instead
+     */
+    public static function findAvailableLanguages($app=null) {
+        return \OC::$server->getL10NFactory()->findAvailableLanguages($app);
+    }
+
+    /**
+     * @param string $app
+     * @param string $lang
+     * @return bool
+     * @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->languageExists() instead
+     */
+    public static function languageExists($app, $lang) {
+        return \OC::$server->getL10NFactory()->languageExists($app, $lang);
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -167,12 +167,12 @@ 
 	public function n($text_singular, $text_plural, $count, $parameters = array()) {
 		$this->init();
 		$identifier = "_${text_singular}_::_${text_plural}_";
-		if( array_key_exists($identifier, $this->translations)) {
-			return new OC_L10N_String( $this, $identifier, $parameters, $count );
-		}else{
-			if($count === 1) {
+		if (array_key_exists($identifier, $this->translations)) {
+			return new OC_L10N_String($this, $identifier, $parameters, $count);
+		} else {
+			if ($count === 1) {
 				return new OC_L10N_String($this, $text_singular, $parameters, $count);
-			}else{
+			} else {
 				return new OC_L10N_String($this, $text_plural, $parameters, $count);
 			}
 		}
@@ -235,9 +235,9 @@ 
 
 		$this->init();
 		$value = new DateTime();
-		if($data instanceof DateTime) {
+		if ($data instanceof DateTime) {
 			$value = $data;
-		} elseif(is_string($data) && !is_numeric($data)) {
+		} elseif (is_string($data) && !is_numeric($data)) {
 			$data = strtotime($data);
 			$value->setTimestamp($data);
 		} else {
@@ -249,7 +249,7 @@ 
 
 		$options = array_merge(array('width' => 'long'), $options);
 		$width = $options['width'];
-		switch($type) {
+		switch ($type) {
 			case 'date':
 				return Punic\Calendar::formatDate($value, $width, $locale);
 			case 'datetime':
@@ -327,7 +327,7 @@ 
 	 * @return array an array of available languages
 	 * @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->findAvailableLanguages() instead
 	 */
-	public static function findAvailableLanguages($app=null) {
+	public static function findAvailableLanguages($app = null) {
 		return \OC::$server->getL10NFactory()->findAvailableLanguages($app);
 	}
 

Braces +2 added lines, -2 removed lines

@@ -169,10 +169,10 @@
 		$identifier = "_${text_singular}_::_${text_plural}_";
 		if( array_key_exists($identifier, $this->translations)) {
 			return new OC_L10N_String( $this, $identifier, $parameters, $count );
-		}else{
+		} else{
 			if($count === 1) {
 				return new OC_L10N_String($this, $text_singular, $parameters, $count);
-			}else{
+			} else{
 				return new OC_L10N_String($this, $text_plural, $parameters, $count);
 			}
 		}

lib/private/legacy/template/functions.php

Doc Comments +2 added lines, -1 removed lines

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

Indentation +81 added lines, -81 removed lines

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

Spacing +27 added lines, -27 removed lines

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