123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245 |
- <?php
- /**
- * @author Arthur Schiwon <blizzz@owncloud.com>
- * @author Bart Visscher <bartv@thisnet.nl>
- * @author Bernhard Posselt <dev@bernhard-posselt.com>
- * @author Björn Schießle <schiessle@owncloud.com>
- * @author Borjan Tchakaloff <borjan@tchakaloff.fr>
- * @author Brice Maron <brice@bmaron.net>
- * @author Christopher Schäpers <kondou@ts.unde.re>
- * @author Felix Moeller <mail@felixmoeller.de>
- * @author Frank Karlitschek <frank@owncloud.org>
- * @author Georg Ehrke <georg@owncloud.com>
- * @author Jakob Sack <mail@jakobsack.de>
- * @author Jan-Christoph Borchardt <hey@jancborchardt.net>
- * @author Joas Schilling <nickvergessen@owncloud.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Kamil Domanski <kdomanski@kdemail.net>
- * @author Lukas Reschke <lukas@owncloud.com>
- * @author Markus Goetz <markus@woboq.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <icewind@owncloud.com>
- * @author Robin McCorkell <rmccorkell@karoshi.org.uk>
- * @author Sam Tuke <mail@samtuke.com>
- * @author Scrutinizer Auto-Fixer <auto-fixer@scrutinizer-ci.com>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Thomas Tanghus <thomas@tanghus.net>
- * @author Tom Needham <tom@owncloud.com>
- * @author Vincent Petry <pvince81@owncloud.com>
- *
- * @copyright Copyright (c) 2015, ownCloud, Inc.
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
- use OC\App\DependencyAnalyzer;
- use OC\App\Platform;
- use OC\OCSClient;
- /**
- * This class manages the apps. It allows them to register and integrate in the
- * ownCloud ecosystem. Furthermore, this class is responsible for installing,
- * upgrading and removing apps.
- */
- class OC_App {
- static private $appVersion = [];
- static private $adminForms = array();
- static private $personalForms = array();
- static private $appInfo = array();
- static private $appTypes = array();
- static private $loadedApps = array();
- static private $altLogin = array();
- private static $shippedApps = null;
- const officialApp = 200;
- /**
- * clean the appId
- *
- * @param string|boolean $app AppId that needs to be cleaned
- * @return string
- */
- public static function cleanAppId($app) {
- return str_replace(array('\0', '/', '\\', '..'), '', $app);
- }
- /**
- * loads all apps
- *
- * @param array $types
- * @return bool
- *
- * This function walks through the ownCloud directory and loads all apps
- * it can find. A directory contains an app if the file /appinfo/info.xml
- * exists.
- *
- * if $types is set, only apps of those types will be loaded
- */
- public static function loadApps($types = null) {
- if (OC_Config::getValue('maintenance', false)) {
- return false;
- }
- // Load the enabled apps here
- $apps = self::getEnabledApps();
- // prevent app.php from printing output
- ob_start();
- foreach ($apps as $app) {
- if ((is_null($types) or self::isType($app, $types)) && !in_array($app, self::$loadedApps)) {
- self::$loadedApps[] = $app;
- self::loadApp($app);
- }
- }
- ob_end_clean();
- return true;
- }
- /**
- * load a single app
- *
- * @param string $app
- * @param bool $checkUpgrade whether an upgrade check should be done
- * @throws \OC\NeedsUpdateException
- */
- public static function loadApp($app, $checkUpgrade = true) {
- if (is_file(self::getAppPath($app) . '/appinfo/app.php')) {
- \OC::$server->getEventLogger()->start('load_app_' . $app, 'Load app: ' . $app);
- if ($checkUpgrade and self::shouldUpgrade($app)) {
- throw new \OC\NeedsUpdateException();
- }
- self::requireAppFile($app);
- if (self::isType($app, array('authentication'))) {
- // since authentication apps affect the "is app enabled for group" check,
- // the enabled apps cache needs to be cleared to make sure that the
- // next time getEnableApps() is called it will also include apps that were
- // enabled for groups
- self::$enabledAppsCache = array();
- }
- \OC::$server->getEventLogger()->end('load_app_' . $app);
- }
- }
- /**
- * Load app.php from the given app
- *
- * @param string $app app name
- */
- private static function requireAppFile($app) {
- // encapsulated here to avoid variable scope conflicts
- require_once $app . '/appinfo/app.php';
- }
- /**
- * check if an app is of a specific type
- *
- * @param string $app
- * @param string|array $types
- * @return bool
- */
- public static function isType($app, $types) {
- if (is_string($types)) {
- $types = array($types);
- }
- $appTypes = self::getAppTypes($app);
- foreach ($types as $type) {
- if (array_search($type, $appTypes) !== false) {
- return true;
- }
- }
- return false;
- }
- /**
- * get the types of an app
- *
- * @param string $app
- * @return array
- */
- private static function getAppTypes($app) {
- //load the cache
- if (count(self::$appTypes) == 0) {
- self::$appTypes = OC_Appconfig::getValues(false, 'types');
- }
- if (isset(self::$appTypes[$app])) {
- return explode(',', self::$appTypes[$app]);
- } else {
- return array();
- }
- }
- /**
- * read app types from info.xml and cache them in the database
- */
- public static function setAppTypes($app) {
- $appData = self::getAppInfo($app);
- if (isset($appData['types'])) {
- $appTypes = implode(',', $appData['types']);
- } else {
- $appTypes = '';
- }
- OC_Appconfig::setValue($app, 'types', $appTypes);
- }
- /**
- * check if app is shipped
- *
- * @param string $appId the id of the app to check
- * @return bool
- *
- * Check if an app that is installed is a shipped app or installed from the appstore.
- */
- public static function isShipped($appId) {
- if (is_null(self::$shippedApps)) {
- $shippedJson = \OC::$SERVERROOT . '/core/shipped.json';
- if (file_exists($shippedJson)) {
- self::$shippedApps = json_decode(file_get_contents($shippedJson), true);
- self::$shippedApps = self::$shippedApps['shippedApps'];
- } else {
- self::$shippedApps = ['files', 'encryption', 'files_external',
- 'files_sharing', 'files_trashbin', 'files_versions', 'provisioning_api',
- 'user_ldap', 'user_webdavauth'];
- }
- }
- return in_array($appId, self::$shippedApps);
- }
- /**
- * get all enabled apps
- */
- protected static $enabledAppsCache = array();
- /**
- * Returns apps enabled for the current user.
- *
- * @param bool $forceRefresh whether to refresh the cache
- * @param bool $all whether to return apps for all users, not only the
- * currently logged in one
- * @return string[]
- */
- public static function getEnabledApps($forceRefresh = false, $all = false) {
- if (!OC_Config::getValue('installed', false)) {
- return array();
- }
- // in incognito mode or when logged out, $user will be false,
- // which is also the case during an upgrade
- $appManager = \OC::$server->getAppManager();
- if ($all) {
- $user = null;
- } else {
- $user = \OC::$server->getUserSession()->getUser();
- }
- if (is_null($user)) {
- $apps = $appManager->getInstalledApps();
- } else {
- $apps = $appManager->getEnabledAppsForUser($user);
- }
- $apps = array_filter($apps, function ($app) {
- return $app !== 'files';//we add this manually
- });
- sort($apps);
- array_unshift($apps, 'files');
- return $apps;
- }
- /**
- * checks whether or not an app is enabled
- *
- * @param string $app app
- * @return bool
- *
- * This function checks whether or not an app is enabled.
- */
- public static function isEnabled($app) {
- if ('files' == $app) {
- return true;
- }
- return \OC::$server->getAppManager()->isEnabledForUser($app);
- }
- /**
- * enables an app
- *
- * @param mixed $app app
- * @param array $groups (optional) when set, only these groups will have access to the app
- * @throws \Exception
- * @return void
- *
- * This function set an app as enabled in appconfig.
- */
- public static function enable($app, $groups = null) {
- self::$enabledAppsCache = array(); // flush
- if (!OC_Installer::isInstalled($app)) {
- $app = self::installApp($app);
- }
- $appManager = \OC::$server->getAppManager();
- if (!is_null($groups)) {
- $groupManager = \OC::$server->getGroupManager();
- $groupsList = [];
- foreach ($groups as $group) {
- $groupItem = $groupManager->get($group);
- if ($groupItem instanceof \OCP\IGroup) {
- $groupsList[] = $groupManager->get($group);
- }
- }
- $appManager->enableAppForGroups($app, $groupsList);
- } else {
- $appManager->enableApp($app);
- }
- }
- /**
- * @param string $app
- * @return int
- */
- public static function downloadApp($app) {
- $ocsClient = new OCSClient(
- \OC::$server->getHTTPClientService(),
- \OC::$server->getConfig(),
- \OC::$server->getLogger()
- );
- $appData = $ocsClient->getApplication($app);
- $download= $ocsClient->getApplicationDownload($app);
- if(isset($download['downloadlink']) and $download['downloadlink']!='') {
- // Replace spaces in download link without encoding entire URL
- $download['downloadlink'] = str_replace(' ', '%20', $download['downloadlink']);
- $info = array('source' => 'http', 'href' => $download['downloadlink'], 'appdata' => $appData);
- $app = OC_Installer::installApp($info);
- }
- return $app;
- }
- /**
- * @param string $app
- * @return bool
- */
- public static function removeApp($app) {
- if (self::isShipped($app)) {
- return false;
- }
- return OC_Installer::removeApp($app);
- }
- /**
- * This function set an app as disabled in appconfig.
- *
- * @param string $app app
- * @throws Exception
- */
- public static function disable($app) {
- // Convert OCS ID to regular application identifier
- if(self::getInternalAppIdByOcs($app) !== false) {
- $app = self::getInternalAppIdByOcs($app);
- }
- if($app === 'files') {
- throw new \Exception("files can't be disabled.");
- }
- self::$enabledAppsCache = array(); // flush
- // check if app is a shipped app or not. if not delete
- \OC_Hook::emit('OC_App', 'pre_disable', array('app' => $app));
- $appManager = \OC::$server->getAppManager();
- $appManager->disableApp($app);
- }
- /**
- * marks a navigation entry as active
- *
- * @param string $id id of the entry
- * @return bool
- *
- * This function sets a navigation entry as active and removes the 'active'
- * property from all other entries. The templates can use this for
- * highlighting the current position of the user.
- *
- * @deprecated Use \OC::$server->getNavigationManager()->setActiveEntry() instead
- */
- public static function setActiveNavigationEntry($id) {
- OC::$server->getNavigationManager()->setActiveEntry($id);
- return true;
- }
- /**
- * Get the navigation entries for the $app
- *
- * @param string $app app
- * @return array an array of the $data added with addNavigationEntry
- *
- * Warning: destroys the existing entries
- */
- public static function getAppNavigationEntries($app) {
- if (is_file(self::getAppPath($app) . '/appinfo/app.php')) {
- OC::$server->getNavigationManager()->clear();
- try {
- require $app . '/appinfo/app.php';
- } catch (\OC\Encryption\Exceptions\ModuleAlreadyExistsException $e) {
- // FIXME we should avoid getting this exception in first place,
- // For now we just catch it, since we don't care about encryption modules
- // when trying to find out, whether the app has a navigation entry.
- }
- return OC::$server->getNavigationManager()->getAll();
- }
- return array();
- }
- /**
- * gets the active Menu entry
- *
- * @return string id or empty string
- *
- * This function returns the id of the active navigation entry (set by
- * setActiveNavigationEntry
- *
- * @deprecated Use \OC::$server->getNavigationManager()->getActiveEntry() instead
- */
- public static function getActiveNavigationEntry() {
- return OC::$server->getNavigationManager()->getActiveEntry();
- }
- /**
- * Returns the Settings Navigation
- *
- * @return string
- *
- * This function returns an array containing all settings pages added. The
- * entries are sorted by the key 'order' ascending.
- */
- public static function getSettingsNavigation() {
- $l = \OC::$server->getL10N('lib');
- $settings = array();
- // by default, settings only contain the help menu
- if (OC_Util::getEditionString() === '' &&
- OC_Config::getValue('knowledgebaseenabled', true) == true
- ) {
- $settings = array(
- array(
- "id" => "help",
- "order" => 1000,
- "href" => OC_Helper::linkToRoute("settings_help"),
- "name" => $l->t("Help"),
- "icon" => OC_Helper::imagePath("settings", "help.svg")
- )
- );
- }
- // if the user is logged-in
- if (OC_User::isLoggedIn()) {
- // personal menu
- $settings[] = array(
- "id" => "personal",
- "order" => 1,
- "href" => OC_Helper::linkToRoute("settings_personal"),
- "name" => $l->t("Personal"),
- "icon" => OC_Helper::imagePath("settings", "personal.svg")
- );
- //SubAdmins are also allowed to access user management
- if (OC_SubAdmin::isSubAdmin(OC_User::getUser())) {
- // admin users menu
- $settings[] = array(
- "id" => "core_users",
- "order" => 2,
- "href" => OC_Helper::linkToRoute("settings_users"),
- "name" => $l->t("Users"),
- "icon" => OC_Helper::imagePath("settings", "users.svg")
- );
- }
- // if the user is an admin
- if (OC_User::isAdminUser(OC_User::getUser())) {
- // admin settings
- $settings[] = array(
- "id" => "admin",
- "order" => 1000,
- "href" => OC_Helper::linkToRoute("settings_admin"),
- "name" => $l->t("Admin"),
- "icon" => OC_Helper::imagePath("settings", "admin.svg")
- );
- }
- }
- $navigation = self::proceedNavigation($settings);
- return $navigation;
- }
- // This is private as well. It simply works, so don't ask for more details
- private static function proceedNavigation($list) {
- $activeApp = OC::$server->getNavigationManager()->getActiveEntry();
- foreach ($list as &$navEntry) {
- if ($navEntry['id'] == $activeApp) {
- $navEntry['active'] = true;
- } else {
- $navEntry['active'] = false;
- }
- }
- unset($navEntry);
- usort($list, create_function('$a, $b', 'if( $a["order"] == $b["order"] ) {return 0;}elseif( $a["order"] < $b["order"] ) {return -1;}else{return 1;}'));
- return $list;
- }
- /**
- * Get the path where to install apps
- *
- * @return string|false
- */
- public static function getInstallPath() {
- if (OC_Config::getValue('appstoreenabled', true) == false) {
- return false;
- }
- foreach (OC::$APPSROOTS as $dir) {
- if (isset($dir['writable']) && $dir['writable'] === true) {
- return $dir['path'];
- }
- }
- OC_Log::write('core', 'No application directories are marked as writable.', OC_Log::ERROR);
- return null;
- }
- /**
- * search for an app in all app-directories
- *
- * @param string $appId
- * @return mixed (bool|string)
- */
- protected static function findAppInDirectories($appId) {
- static $app_dir = array();
- if (isset($app_dir[$appId])) {
- return $app_dir[$appId];
- }
- $possibleApps = array();
- foreach (OC::$APPSROOTS as $dir) {
- if (file_exists($dir['path'] . '/' . $appId)) {
- $possibleApps[] = $dir;
- }
- }
- if (empty($possibleApps)) {
- return false;
- } elseif (count($possibleApps) === 1) {
- $dir = array_shift($possibleApps);
- $app_dir[$appId] = $dir;
- return $dir;
- } else {
- $versionToLoad = array();
- foreach ($possibleApps as $possibleApp) {
- $version = self::getAppVersionByPath($possibleApp['path']);
- if (empty($versionToLoad) || version_compare($version, $versionToLoad['version'], '>')) {
- $versionToLoad = array(
- 'dir' => $possibleApp,
- 'version' => $version,
- );
- }
- }
- $app_dir[$appId] = $versionToLoad['dir'];
- return $versionToLoad['dir'];
- //TODO - write test
- }
- }
- /**
- * Get the directory for the given app.
- * If the app is defined in multiple directories, the first one is taken. (false if not found)
- *
- * @param string $appId
- * @return string|false
- */
- public static function getAppPath($appId) {
- if ($appId === null || trim($appId) === '') {
- return false;
- }
- if (($dir = self::findAppInDirectories($appId)) != false) {
- return $dir['path'] . '/' . $appId;
- }
- return false;
- }
- /**
- * check if an app's directory is writable
- *
- * @param string $appId
- * @return bool
- */
- public static function isAppDirWritable($appId) {
- $path = self::getAppPath($appId);
- return ($path !== false) ? is_writable($path) : false;
- }
- /**
- * Get the path for the given app on the access
- * If the app is defined in multiple directories, the first one is taken. (false if not found)
- *
- * @param string $appId
- * @return string|false
- */
- public static function getAppWebPath($appId) {
- if (($dir = self::findAppInDirectories($appId)) != false) {
- return OC::$WEBROOT . $dir['url'] . '/' . $appId;
- }
- return false;
- }
- /**
- * get the last version of the app, either from appinfo/version or from appinfo/info.xml
- *
- * @param string $appId
- * @return string
- */
- public static function getAppVersion($appId) {
- if (!isset(self::$appVersion[$appId])) {
- $file = self::getAppPath($appId);
- self::$appVersion[$appId] = ($file !== false) ? self::getAppVersionByPath($file) : '0';
- }
- return self::$appVersion[$appId];
- }
- /**
- * get app's version based on it's path
- *
- * @param string $path
- * @return string
- */
- public static function getAppVersionByPath($path) {
- $versionFile = $path . '/appinfo/version';
- $infoFile = $path . '/appinfo/info.xml';
- if (is_file($versionFile)) {
- return trim(file_get_contents($versionFile));
- } else {
- $appData = self::getAppInfo($infoFile, true);
- return isset($appData['version']) ? $appData['version'] : '';
- }
- }
- /**
- * Read all app metadata from the info.xml file
- *
- * @param string $appId id of the app or the path of the info.xml file
- * @param boolean $path (optional)
- * @return array|null
- * @note all data is read from info.xml, not just pre-defined fields
- */
- public static function getAppInfo($appId, $path = false) {
- if ($path) {
- $file = $appId;
- } else {
- if (isset(self::$appInfo[$appId])) {
- return self::$appInfo[$appId];
- }
- $file = self::getAppPath($appId) . '/appinfo/info.xml';
- }
- $parser = new \OC\App\InfoParser(\OC::$server->getHTTPHelper(), \OC::$server->getURLGenerator());
- $data = $parser->parse($file);
- if (is_array($data)) {
- $data = OC_App::parseAppInfo($data);
- }
- self::$appInfo[$appId] = $data;
- return $data;
- }
- /**
- * Returns the navigation
- *
- * @return array
- *
- * This function returns an array containing all entries added. The
- * entries are sorted by the key 'order' ascending. Additional to the keys
- * given for each app the following keys exist:
- * - active: boolean, signals if the user is on this navigation entry
- */
- public static function getNavigation() {
- $entries = OC::$server->getNavigationManager()->getAll();
- $navigation = self::proceedNavigation($entries);
- return $navigation;
- }
- /**
- * get the id of loaded app
- *
- * @return string
- */
- public static function getCurrentApp() {
- $request = \OC::$server->getRequest();
- $script = substr($request->getScriptName(), strlen(OC::$WEBROOT) + 1);
- $topFolder = substr($script, 0, strpos($script, '/'));
- if (empty($topFolder)) {
- $path_info = $request->getPathInfo();
- if ($path_info) {
- $topFolder = substr($path_info, 1, strpos($path_info, '/', 1) - 1);
- }
- }
- if ($topFolder == 'apps') {
- $length = strlen($topFolder);
- return substr($script, $length + 1, strpos($script, '/', $length + 1) - $length - 1);
- } else {
- return $topFolder;
- }
- }
- /**
- * @param string $type
- * @return array
- */
- public static function getForms($type) {
- $forms = array();
- switch ($type) {
- case 'admin':
- $source = self::$adminForms;
- break;
- case 'personal':
- $source = self::$personalForms;
- break;
- default:
- return array();
- }
- foreach ($source as $form) {
- $forms[] = include $form;
- }
- return $forms;
- }
- /**
- * register an admin form to be shown
- *
- * @param string $app
- * @param string $page
- */
- public static function registerAdmin($app, $page) {
- self::$adminForms[] = $app . '/' . $page . '.php';
- }
- /**
- * register a personal form to be shown
- * @param string $app
- * @param string $page
- */
- public static function registerPersonal($app, $page) {
- self::$personalForms[] = $app . '/' . $page . '.php';
- }
- /**
- * @param array $entry
- */
- public static function registerLogIn(array $entry) {
- self::$altLogin[] = $entry;
- }
- /**
- * @return array
- */
- public static function getAlternativeLogIns() {
- return self::$altLogin;
- }
- /**
- * get a list of all apps in the apps folder
- *
- * @return array an array of app names (string IDs)
- * @todo: change the name of this method to getInstalledApps, which is more accurate
- */
- public static function getAllApps() {
- $apps = array();
- foreach (OC::$APPSROOTS as $apps_dir) {
- if (!is_readable($apps_dir['path'])) {
- OC_Log::write('core', 'unable to read app folder : ' . $apps_dir['path'], OC_Log::WARN);
- continue;
- }
- $dh = opendir($apps_dir['path']);
- if (is_resource($dh)) {
- while (($file = readdir($dh)) !== false) {
- if ($file[0] != '.' and is_file($apps_dir['path'] . '/' . $file . '/appinfo/info.xml')) {
- $apps[] = $file;
- }
- }
- }
- }
- return $apps;
- }
- /**
- * List all apps, this is used in apps.php
- *
- * @param bool $onlyLocal
- * @return array
- */
- public static function listAllApps($onlyLocal = false) {
- $installedApps = OC_App::getAllApps();
- //TODO which apps do we want to blacklist and how do we integrate
- // blacklisting with the multi apps folder feature?
- $blacklist = array('files'); //we don't want to show configuration for these
- $appList = array();
- $l = \OC::$server->getL10N('core');
- foreach ($installedApps as $app) {
- if (array_search($app, $blacklist) === false) {
- $info = OC_App::getAppInfo($app);
- if (!isset($info['name'])) {
- OC_Log::write('core', 'App id "' . $app . '" has no name in appinfo', OC_Log::ERROR);
- continue;
- }
- $enabled = OC_Appconfig::getValue($app, 'enabled', 'no');
- $info['groups'] = null;
- if ($enabled === 'yes') {
- $active = true;
- } else if ($enabled === 'no') {
- $active = false;
- } else {
- $active = true;
- $info['groups'] = $enabled;
- }
- $info['active'] = $active;
- if (isset($info['shipped']) and ($info['shipped'] == 'true')) {
- $info['internal'] = true;
- $info['level'] = self::officialApp;
- $info['removable'] = false;
- } else {
- $info['internal'] = false;
- $info['removable'] = true;
- }
- $info['update'] = OC_Installer::isUpdateAvailable($app);
- $appIcon = self::getAppPath($app) . '/img/' . $app . '.svg';
- if (file_exists($appIcon)) {
- $info['preview'] = OC_Helper::imagePath($app, $app . '.svg');
- $info['previewAsIcon'] = true;
- } else {
- $appIcon = self::getAppPath($app) . '/img/app.svg';
- if (file_exists($appIcon)) {
- $info['preview'] = OC_Helper::imagePath($app, 'app.svg');
- $info['previewAsIcon'] = true;
- }
- }
- $info['version'] = OC_App::getAppVersion($app);
- $appList[] = $info;
- }
- }
- if ($onlyLocal) {
- $remoteApps = [];
- } else {
- $remoteApps = OC_App::getAppstoreApps();
- }
- if ($remoteApps) {
- // Remove duplicates
- foreach ($appList as $app) {
- foreach ($remoteApps AS $key => $remote) {
- if ($app['name'] === $remote['name'] ||
- (isset($app['ocsid']) &&
- $app['ocsid'] === $remote['id'])
- ) {
- unset($remoteApps[$key]);
- }
- }
- }
- $combinedApps = array_merge($appList, $remoteApps);
- } else {
- $combinedApps = $appList;
- }
- return $combinedApps;
- }
- /**
- * Returns the internal app ID or false
- * @param string $ocsID
- * @return string|false
- */
- protected static function getInternalAppIdByOcs($ocsID) {
- if(is_numeric($ocsID)) {
- $idArray = \OC::$server->getAppConfig()->getValues(false, 'ocsid');
- if(array_search($ocsID, $idArray)) {
- return array_search($ocsID, $idArray);
- }
- }
- return false;
- }
- /**
- * Get a list of all apps on the appstore
- * @param string $filter
- * @param string $category
- * @return array|bool multi-dimensional array of apps.
- * Keys: id, name, type, typename, personid, license, detailpage, preview, changed, description
- */
- public static function getAppstoreApps($filter = 'approved', $category = null) {
- $categories = [$category];
- $ocsClient = new OCSClient(
- \OC::$server->getHTTPClientService(),
- \OC::$server->getConfig(),
- \OC::$server->getLogger()
- );
- if (is_null($category)) {
- $categoryNames = $ocsClient->getCategories();
- if (is_array($categoryNames)) {
- // Check that categories of apps were retrieved correctly
- if (!$categories = array_keys($categoryNames)) {
- return false;
- }
- } else {
- return false;
- }
- }
- $page = 0;
- $remoteApps = $ocsClient->getApplications($categories, $page, $filter);
- $apps = [];
- $i = 0;
- $l = \OC::$server->getL10N('core');
- foreach ($remoteApps as $app) {
- $potentialCleanId = self::getInternalAppIdByOcs($app['id']);
- // enhance app info (for example the description)
- $apps[$i] = OC_App::parseAppInfo($app);
- $apps[$i]['author'] = $app['personid'];
- $apps[$i]['ocs_id'] = $app['id'];
- $apps[$i]['internal'] = 0;
- $apps[$i]['active'] = ($potentialCleanId !== false) ? self::isEnabled($potentialCleanId) : false;
- $apps[$i]['update'] = false;
- $apps[$i]['groups'] = false;
- $apps[$i]['score'] = $app['score'];
- $apps[$i]['removable'] = false;
- if ($app['label'] == 'recommended') {
- $apps[$i]['internallabel'] = (string)$l->t('Recommended');
- $apps[$i]['internalclass'] = 'recommendedapp';
- }
- $i++;
- }
- if (empty($apps)) {
- return false;
- } else {
- return $apps;
- }
- }
- public static function shouldUpgrade($app) {
- $versions = self::getAppVersions();
- $currentVersion = OC_App::getAppVersion($app);
- if ($currentVersion && isset($versions[$app])) {
- $installedVersion = $versions[$app];
- if (version_compare($currentVersion, $installedVersion, '>')) {
- return true;
- }
- }
- return false;
- }
- /**
- * Adjust the number of version parts of $version1 to match
- * the number of version parts of $version2.
- *
- * @param string $version1 version to adjust
- * @param string $version2 version to take the number of parts from
- * @return string shortened $version1
- */
- private static function adjustVersionParts($version1, $version2) {
- $version1 = explode('.', $version1);
- $version2 = explode('.', $version2);
- // reduce $version1 to match the number of parts in $version2
- while (count($version1) > count($version2)) {
- array_pop($version1);
- }
- // if $version1 does not have enough parts, add some
- while (count($version1) < count($version2)) {
- $version1[] = '0';
- }
- return implode('.', $version1);
- }
- /**
- * Check whether the current ownCloud version matches the given
- * application's version requirements.
- *
- * The comparison is made based on the number of parts that the
- * app info version has. For example for ownCloud 6.0.3 if the
- * app info version is expecting version 6.0, the comparison is
- * made on the first two parts of the ownCloud version.
- * This means that it's possible to specify "requiremin" => 6
- * and "requiremax" => 6 and it will still match ownCloud 6.0.3.
- *
- * @param string $ocVersion ownCloud version to check against
- * @param array $appInfo app info (from xml)
- *
- * @return boolean true if compatible, otherwise false
- */
- public static function isAppCompatible($ocVersion, $appInfo) {
- $requireMin = '';
- $requireMax = '';
- if (isset($appInfo['dependencies']['owncloud']['@attributes']['min-version'])) {
- $requireMin = $appInfo['dependencies']['owncloud']['@attributes']['min-version'];
- } else if (isset($appInfo['requiremin'])) {
- $requireMin = $appInfo['requiremin'];
- } else if (isset($appInfo['require'])) {
- $requireMin = $appInfo['require'];
- }
- if (isset($appInfo['dependencies']['owncloud']['@attributes']['max-version'])) {
- $requireMax = $appInfo['dependencies']['owncloud']['@attributes']['max-version'];
- } else if (isset($appInfo['requiremax'])) {
- $requireMax = $appInfo['requiremax'];
- }
- if (is_array($ocVersion)) {
- $ocVersion = implode('.', $ocVersion);
- }
- if (!empty($requireMin)
- && version_compare(self::adjustVersionParts($ocVersion, $requireMin), $requireMin, '<')
- ) {
- return false;
- }
- if (!empty($requireMax)
- && version_compare(self::adjustVersionParts($ocVersion, $requireMax), $requireMax, '>')
- ) {
- return false;
- }
- return true;
- }
- /**
- * get the installed version of all apps
- */
- public static function getAppVersions() {
- static $versions;
- if (isset($versions)) { // simple cache, needs to be fixed
- return $versions; // when function is used besides in checkUpgrade
- }
- $versions = array();
- try {
- $query = OC_DB::prepare('SELECT `appid`, `configvalue` FROM `*PREFIX*appconfig`'
- . ' WHERE `configkey` = \'installed_version\'');
- $result = $query->execute();
- while ($row = $result->fetchRow()) {
- $versions[$row['appid']] = $row['configvalue'];
- }
- return $versions;
- } catch (\Exception $e) {
- return array();
- }
- }
- /**
- * @param mixed $app
- * @return bool
- * @throws Exception if app is not compatible with this version of ownCloud
- * @throws Exception if no app-name was specified
- */
- public static function installApp($app) {
- $l = \OC::$server->getL10N('core');
- $config = \OC::$server->getConfig();
- $ocsClient = new OCSClient(
- \OC::$server->getHTTPClientService(),
- $config,
- \OC::$server->getLogger()
- );
- $appData = $ocsClient->getApplication($app);
- // check if app is a shipped app or not. OCS apps have an integer as id, shipped apps use a string
- if (!is_numeric($app)) {
- $shippedVersion = self::getAppVersion($app);
- if ($appData && version_compare($shippedVersion, $appData['version'], '<')) {
- $app = self::downloadApp($app);
- } else {
- $app = OC_Installer::installShippedApp($app);
- }
- } else {
- // Maybe the app is already installed - compare the version in this
- // case and use the local already installed one.
- // FIXME: This is a horrible hack. I feel sad. The god of code cleanness may forgive me.
- $internalAppId = self::getInternalAppIdByOcs($app);
- if($internalAppId !== false) {
- if($appData && version_compare(\OC_App::getAppVersion($internalAppId), $appData['version'], '<')) {
- $app = self::downloadApp($app);
- } else {
- self::enable($internalAppId);
- $app = $internalAppId;
- }
- } else {
- $app = self::downloadApp($app);
- }
- }
- if ($app !== false) {
- // check if the app is compatible with this version of ownCloud
- $info = self::getAppInfo($app);
- $version = OC_Util::getVersion();
- if (!self::isAppCompatible($version, $info)) {
- throw new \Exception(
- $l->t('App "%s" cannot be installed because it is not compatible with this version of ownCloud.',
- array($info['name'])
- )
- );
- }
- // check for required dependencies
- $dependencyAnalyzer = new DependencyAnalyzer(new Platform($config), $l);
- $missing = $dependencyAnalyzer->analyze($app);
- if (!empty($missing)) {
- $missingMsg = join(PHP_EOL, $missing);
- throw new \Exception(
- $l->t('App "%s" cannot be installed because the following dependencies are not fulfilled: %s',
- array($info['name'], $missingMsg)
- )
- );
- }
- $config->setAppValue($app, 'enabled', 'yes');
- if (isset($appData['id'])) {
- $config->setAppValue($app, 'ocsid', $appData['id']);
- }
- \OC_Hook::emit('OC_App', 'post_enable', array('app' => $app));
- } else {
- throw new \Exception($l->t("No app name specified"));
- }
- return $app;
- }
- /**
- * update the database for the app and call the update script
- *
- * @param string $appId
- * @return bool
- */
- public static function updateApp($appId) {
- if (file_exists(self::getAppPath($appId) . '/appinfo/database.xml')) {
- OC_DB::updateDbFromStructure(self::getAppPath($appId) . '/appinfo/database.xml');
- }
- unset(self::$appVersion[$appId]);
- if (!self::isEnabled($appId)) {
- return false;
- }
- if (file_exists(self::getAppPath($appId) . '/appinfo/update.php')) {
- self::loadApp($appId, false);
- include self::getAppPath($appId) . '/appinfo/update.php';
- }
- //set remote/public handlers
- $appData = self::getAppInfo($appId);
- if (array_key_exists('ocsid', $appData)) {
- OC_Appconfig::setValue($appId, 'ocsid', $appData['ocsid']);
- }
- foreach ($appData['remote'] as $name => $path) {
- OCP\CONFIG::setAppValue('core', 'remote_' . $name, $appId . '/' . $path);
- }
- foreach ($appData['public'] as $name => $path) {
- OCP\CONFIG::setAppValue('core', 'public_' . $name, $appId . '/' . $path);
- }
- self::setAppTypes($appId);
- $version = \OC_App::getAppVersion($appId);
- \OC_Appconfig::setValue($appId, 'installed_version', $version);
- return true;
- }
- /**
- * @param string $appId
- * @return \OC\Files\View|false
- */
- public static function getStorage($appId) {
- if (OC_App::isEnabled($appId)) { //sanity check
- if (OC_User::isLoggedIn()) {
- $view = new \OC\Files\View('/' . OC_User::getUser());
- if (!$view->file_exists($appId)) {
- $view->mkdir($appId);
- }
- return new \OC\Files\View('/' . OC_User::getUser() . '/' . $appId);
- } else {
- OC_Log::write('core', 'Can\'t get app storage, app ' . $appId . ', user not logged in', OC_Log::ERROR);
- return false;
- }
- } else {
- OC_Log::write('core', 'Can\'t get app storage, app ' . $appId . ' not enabled', OC_Log::ERROR);
- return false;
- }
- }
- /**
- * parses the app data array and enhanced the 'description' value
- *
- * @param array $data the app data
- * @return array improved app data
- */
- public static function parseAppInfo(array $data) {
- // just modify the description if it is available
- // otherwise this will create a $data element with an empty 'description'
- if (isset($data['description'])) {
- // sometimes the description contains line breaks and they are then also
- // shown in this way in the app management which isn't wanted as HTML
- // manages line breaks itself
- // first of all we split on empty lines
- $paragraphs = preg_split("!\n[[:space:]]*\n!m", $data['description']);
- $result = [];
- foreach ($paragraphs as $value) {
- // replace multiple whitespace (tabs, space, newlines) inside a paragraph
- // with a single space - also trims whitespace
- $result[] = trim(preg_replace('![[:space:]]+!m', ' ', $value));
- }
- // join the single paragraphs with a empty line in between
- $data['description'] = implode("\n\n", $result);
- }
- return $data;
- }
- }
|