123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398 |
- <?php
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- * @copyright Copyright (c) 2016, Lukas Reschke <lukas@statuscode.ch>
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Bart Visscher <bartv@thisnet.nl>
- * @author Bernhard Posselt <dev@bernhard-posselt.com>
- * @author Björn Schießle <bjoern@schiessle.org>
- * @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@karlitschek.de>
- * @author Georg Ehrke <georg@owncloud.com>
- * @author Jakob Sack <mail@jakobsack.de>
- * @author Jan-Christoph Borchardt <hey@jancborchardt.net>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Kamil Domanski <kdomanski@kdemail.net>
- * @author Klaas Freitag <freitag@owncloud.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Markus Goetz <markus@woboq.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author RealRancor <Fisch.666@gmx.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Sam Tuke <mail@samtuke.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>
- *
- * @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\InfoParser;
- use OC\App\Platform;
- use OC\Installer;
- use OC\OCSClient;
- use OC\Repair;
- use OCP\App\ManagerEvent;
- /**
- * 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();
- static private $alreadyRegistered = [];
- 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);
- }
- /**
- * Check if an app is loaded
- *
- * @param string $app
- * @return bool
- */
- public static function isAppLoaded($app) {
- return in_array($app, self::$loadedApps, true);
- }
- /**
- * loads all apps
- *
- * @param string[] | string | null $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::$server->getSystemConfig()->getValue('maintenance', false)) {
- return false;
- }
- // Load the enabled apps here
- $apps = self::getEnabledApps();
- // Add each apps' folder as allowed class path
- foreach($apps as $app) {
- $path = self::getAppPath($app);
- if($path !== false) {
- self::registerAutoloading($app, $path);
- }
- }
- // 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::loadApp($app);
- }
- }
- ob_end_clean();
- return true;
- }
- /**
- * load a single app
- *
- * @param string $app
- */
- public static function loadApp($app) {
- self::$loadedApps[] = $app;
- $appPath = self::getAppPath($app);
- if($appPath === false) {
- return;
- }
- // in case someone calls loadApp() directly
- self::registerAutoloading($app, $appPath);
- if (is_file($appPath . '/appinfo/app.php')) {
- \OC::$server->getEventLogger()->start('load_app_' . $app, 'Load app: ' . $app);
- 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);
- }
- $info = self::getAppInfo($app);
- if (!empty($info['activity']['filters'])) {
- foreach ($info['activity']['filters'] as $filter) {
- \OC::$server->getActivityManager()->registerFilter($filter);
- }
- }
- if (!empty($info['activity']['settings'])) {
- foreach ($info['activity']['settings'] as $setting) {
- \OC::$server->getActivityManager()->registerSetting($setting);
- }
- }
- if (!empty($info['activity']['providers'])) {
- foreach ($info['activity']['providers'] as $provider) {
- \OC::$server->getActivityManager()->registerProvider($provider);
- }
- }
- }
- /**
- * @internal
- * @param string $app
- * @param string $path
- */
- public static function registerAutoloading($app, $path) {
- $key = $app . '-' . $path;
- if(isset(self::$alreadyRegistered[$key])) {
- return;
- }
- self::$alreadyRegistered[$key] = true;
- // Register on PSR-4 composer autoloader
- $appNamespace = \OC\AppFramework\App::buildAppNamespace($app);
- \OC::$composerAutoloader->addPsr4($appNamespace . '\\', $path . '/lib/', true);
- if (defined('PHPUNIT_RUN') || defined('CLI_TEST_RUN')) {
- \OC::$composerAutoloader->addPsr4($appNamespace . '\\Tests\\', $path . '/tests/', true);
- }
- // Register on legacy autoloader
- \OC::$loader->addValidRoot($path);
- }
- /**
- * Load app.php from the given app
- *
- * @param string $app app name
- */
- private static function requireAppFile($app) {
- try {
- // encapsulated here to avoid variable scope conflicts
- require_once $app . '/appinfo/app.php';
- } catch (Error $ex) {
- \OC::$server->getLogger()->logException($ex);
- $blacklist = \OC::$server->getAppManager()->getAlwaysEnabledApps();
- if (!in_array($app, $blacklist)) {
- self::disable($app);
- }
- }
- }
- /**
- * 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::$server->getAppConfig()->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(!is_array($appData)) {
- return;
- }
- if (isset($appData['types'])) {
- $appTypes = implode(',', $appData['types']);
- } else {
- $appTypes = '';
- $appData['types'] = [];
- }
- \OC::$server->getAppConfig()->setValue($app, 'types', $appTypes);
- if (\OC::$server->getAppManager()->hasProtectedAppType($appData['types'])) {
- $enabled = \OC::$server->getAppConfig()->getValue($app, 'enabled', 'yes');
- if ($enabled !== 'yes' && $enabled !== 'no') {
- \OC::$server->getAppConfig()->setValue($app, 'enabled', 'yes');
- }
- }
- }
- /**
- * 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) {
- return \OC::$server->getAppManager()->isShipped($appId);
- }
- /**
- * 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::$server->getSystemConfig()->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) {
- return \OC::$server->getAppManager()->isEnabledForUser($app);
- }
- /**
- * enables an app
- *
- * @param string $appId
- * @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 function enable($appId,
- $groups = null) {
- self::$enabledAppsCache = []; // flush
- $l = \OC::$server->getL10N('core');
- $config = \OC::$server->getConfig();
- // Check if app is already downloaded
- $installer = new Installer(
- \OC::$server->getAppFetcher(),
- \OC::$server->getHTTPClientService(),
- \OC::$server->getTempManager(),
- \OC::$server->getLogger()
- );
- $isDownloaded = $installer->isDownloaded($appId);
- if(!$isDownloaded) {
- $installer->downloadApp($appId);
- }
- if (!Installer::isInstalled($appId)) {
- $appId = self::installApp(
- $appId,
- $config,
- $l
- );
- $appPath = self::getAppPath($appId);
- self::registerAutoloading($appId, $appPath);
- $installer->installApp($appId);
- } else {
- // check for required dependencies
- $info = self::getAppInfo($appId);
- self::checkAppDependencies($config, $l, $info);
- $appPath = self::getAppPath($appId);
- self::registerAutoloading($appId, $appPath);
- $installer->installApp($appId);
- }
- $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($appId, $groupsList);
- } else {
- $appManager->enableApp($appId);
- }
- $info = self::getAppInfo($appId);
- if(isset($info['settings']) && is_array($info['settings'])) {
- $appPath = self::getAppPath($appId);
- self::registerAutoloading($appId, $appPath);
- \OC::$server->getSettingsManager()->setupSettings($info['settings']);
- }
- }
- /**
- * @param string $app
- * @return bool
- */
- public static function removeApp($app) {
- if (self::isShipped($app)) {
- return false;
- }
- $installer = new Installer(
- \OC::$server->getAppFetcher(),
- \OC::$server->getHTTPClientService(),
- \OC::$server->getTempManager(),
- \OC::$server->getLogger()
- );
- return $installer->removeApp($app);
- }
- /**
- * This function set an app as disabled in appconfig.
- *
- * @param string $app app
- * @throws Exception
- */
- public static function disable($app) {
- // flush
- self::$enabledAppsCache = array();
- // run uninstall steps
- $appData = OC_App::getAppInfo($app);
- if (!is_null($appData)) {
- OC_App::executeRepairSteps($app, $appData['repair-steps']['uninstall']);
- }
- // emit disable hook - needed anymore ?
- \OC_Hook::emit('OC_App', 'pre_disable', array('app' => $app));
- // finally disable it
- $appManager = \OC::$server->getAppManager();
- $appManager->disableApp($app);
- }
- /**
- * 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');
- $urlGenerator = \OC::$server->getURLGenerator();
- $settings = array();
- // by default, settings only contain the help menu
- if (\OC::$server->getSystemConfig()->getValue('knowledgebaseenabled', true)) {
- $settings = array(
- array(
- "id" => "help",
- "order" => 4,
- "href" => $urlGenerator->linkToRoute('settings_help'),
- "name" => $l->t("Help"),
- "icon" => $urlGenerator->imagePath("settings", "help.svg")
- )
- );
- }
- // if the user is logged-in
- if (\OC::$server->getUserSession()->isLoggedIn()) {
- // personal menu
- $settings[] = array(
- "id" => "personal",
- "order" => 1,
- "href" => $urlGenerator->linkToRoute('settings_personal'),
- "name" => $l->t("Personal"),
- "icon" => $urlGenerator->imagePath("settings", "personal.svg")
- );
- //SubAdmins are also allowed to access user management
- $userObject = \OC::$server->getUserSession()->getUser();
- $isSubAdmin = false;
- if($userObject !== null) {
- $isSubAdmin = \OC::$server->getGroupManager()->getSubAdmin()->isSubAdmin($userObject);
- }
- if ($isSubAdmin) {
- // admin users menu
- $settings[] = array(
- "id" => "core_users",
- "order" => 3,
- "href" => $urlGenerator->linkToRoute('settings_users'),
- "name" => $l->t("Users"),
- "icon" => $urlGenerator->imagePath("settings", "users.svg")
- );
- }
- // if the user is an admin
- if (OC_User::isAdminUser(OC_User::getUser())) {
- // admin settings
- $settings[] = array(
- "id" => "admin",
- "order" => 2,
- "href" => $urlGenerator->linkToRoute('settings.AdminSettings.index'),
- "name" => $l->t("Admin"),
- "icon" => $urlGenerator->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) {
- $headerIconCount = 8;
- if(OC_User::isAdminUser(OC_User::getUser())) {
- $headerIconCount--;
- }
- usort($list, function($a, $b) {
- if (isset($a['order']) && isset($b['order'])) {
- return ($a['order'] < $b['order']) ? -1 : 1;
- } else if (isset($a['order']) || isset($b['order'])) {
- return isset($a['order']) ? -1 : 1;
- } else {
- return ($a['name'] < $b['name']) ? -1 : 1;
- }
- });
- $activeAppIndex = -1;
- $activeApp = OC::$server->getNavigationManager()->getActiveEntry();
- foreach ($list as $index => &$navEntry) {
- if ($navEntry['id'] == $activeApp) {
- $navEntry['active'] = true;
- $activeAppIndex = $index;
- } else {
- $navEntry['active'] = false;
- }
- }
- unset($navEntry);
- if($activeAppIndex > ($headerIconCount-1)) {
- $active = $list[$activeAppIndex];
- $lastInHeader = $list[$headerIconCount-1];
- $list[$headerIconCount-1] = $active;
- $list[$activeAppIndex] = $lastInHeader;
- }
- foreach ($list as $index => &$navEntry) {
- $navEntry['showInHeader'] = false;
- if($index < $headerIconCount) {
- $navEntry['showInHeader'] = true;
- }
- }
- return $list;
- }
- public static function proceedAppNavigation($entries) {
- $headerIconCount = 8;
- if(OC_User::isAdminUser(OC_User::getUser())) {
- $headerIconCount--;
- }
- $activeAppIndex = -1;
- $list = self::proceedNavigation($entries);
- $activeApp = OC::$server->getNavigationManager()->getActiveEntry();
- foreach ($list as $index => &$navEntry) {
- if ($navEntry['id'] == $activeApp) {
- $navEntry['active'] = true;
- $activeAppIndex = $index;
- } else {
- $navEntry['active'] = false;
- }
- }
- // move active item to last position
- if($activeAppIndex > ($headerIconCount-1)) {
- $active = $list[$activeAppIndex];
- $lastInHeader = $list[$headerIconCount-1];
- $list[$headerIconCount-1] = $active;
- $list[$activeAppIndex] = $lastInHeader;
- }
- $list = array_slice($list, 0, $headerIconCount);
- return $list;
- }
- /**
- * Get the path where to install apps
- *
- * @return string|false
- */
- public static function getInstallPath() {
- if (\OC::$server->getSystemConfig()->getValue('appstoreenabled', true) == false) {
- return false;
- }
- foreach (OC::$APPSROOTS as $dir) {
- if (isset($dir['writable']) && $dir['writable'] === true) {
- return $dir['path'];
- }
- }
- \OCP\Util::writeLog('core', 'No application directories are marked as writable.', \OCP\Util::ERROR);
- return null;
- }
- /**
- * search for an app in all app-directories
- *
- * @param string $appId
- * @return false|string
- */
- public static function findAppInDirectories($appId) {
- $sanitizedAppId = self::cleanAppId($appId);
- if($sanitizedAppId !== $appId) {
- return false;
- }
- 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;
- }
- /**
- * 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 from appinfo/info.xml
- *
- * @param string $appId
- * @param bool $useCache
- * @return string
- */
- public static function getAppVersion($appId, $useCache = true) {
- if($useCache && isset(self::$appVersion[$appId])) {
- return 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) {
- $infoFile = $path . '/appinfo/info.xml';
- $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 bool $path
- * @param string $lang
- * @return array|null
- * @note all data is read from info.xml, not just pre-defined fields
- */
- public static function getAppInfo($appId, $path = false, $lang = null) {
- if ($path) {
- $file = $appId;
- } else {
- if ($lang === null && isset(self::$appInfo[$appId])) {
- return self::$appInfo[$appId];
- }
- $appPath = self::getAppPath($appId);
- if($appPath === false) {
- return null;
- }
- $file = $appPath . '/appinfo/info.xml';
- }
- $parser = new InfoParser(\OC::$server->getMemCacheFactory()->create('core.appinfo'));
- $data = $parser->parse($file);
- if (is_array($data)) {
- $data = OC_App::parseAppInfo($data, $lang);
- }
- if(isset($data['ocsid'])) {
- $storedId = \OC::$server->getConfig()->getAppValue($appId, 'ocsid');
- if($storedId !== '' && $storedId !== $data['ocsid']) {
- $data['ocsid'] = $storedId;
- }
- }
- if ($lang === null) {
- 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;
- }
- /**
- * Returns the navigation inside the header bar
- *
- * @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 getHeaderNavigation() {
- $entries = OC::$server->getNavigationManager()->getAll();
- $navigation = self::proceedAppNavigation($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'])) {
- \OCP\Util::writeLog('core', 'unable to read app folder : ' . $apps_dir['path'], \OCP\Util::WARN);
- continue;
- }
- $dh = opendir($apps_dir['path']);
- if (is_resource($dh)) {
- while (($file = readdir($dh)) !== false) {
- if ($file[0] != '.' and is_dir($apps_dir['path'] . '/' . $file) and is_file($apps_dir['path'] . '/' . $file . '/appinfo/info.xml')) {
- $apps[] = $file;
- }
- }
- }
- }
- return $apps;
- }
- /**
- * List all apps, this is used in apps.php
- *
- * @return array
- */
- public function listAllApps() {
- $installedApps = OC_App::getAllApps();
- //we don't want to show configuration for these
- $blacklist = \OC::$server->getAppManager()->getAlwaysEnabledApps();
- $appList = array();
- $langCode = \OC::$server->getL10N('core')->getLanguageCode();
- $urlGenerator = \OC::$server->getURLGenerator();
- foreach ($installedApps as $app) {
- if (array_search($app, $blacklist) === false) {
- $info = OC_App::getAppInfo($app, false, $langCode);
- if (!is_array($info)) {
- \OCP\Util::writeLog('core', 'Could not read app info file for app "' . $app . '"', \OCP\Util::ERROR);
- continue;
- }
- if (!isset($info['name'])) {
- \OCP\Util::writeLog('core', 'App id "' . $app . '" has no name in appinfo', \OCP\Util::ERROR);
- continue;
- }
- $enabled = \OC::$server->getAppConfig()->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 (self::isShipped($app)) {
- $info['internal'] = true;
- $info['level'] = self::officialApp;
- $info['removable'] = false;
- } else {
- $info['internal'] = false;
- $info['removable'] = true;
- }
- $appPath = self::getAppPath($app);
- if($appPath !== false) {
- $appIcon = $appPath . '/img/' . $app . '.svg';
- if (file_exists($appIcon)) {
- $info['preview'] = \OC::$server->getURLGenerator()->imagePath($app, $app . '.svg');
- $info['previewAsIcon'] = true;
- } else {
- $appIcon = $appPath . '/img/app.svg';
- if (file_exists($appIcon)) {
- $info['preview'] = \OC::$server->getURLGenerator()->imagePath($app, 'app.svg');
- $info['previewAsIcon'] = true;
- }
- }
- }
- // fix documentation
- if (isset($info['documentation']) && is_array($info['documentation'])) {
- foreach ($info['documentation'] as $key => $url) {
- // If it is not an absolute URL we assume it is a key
- // i.e. admin-ldap will get converted to go.php?to=admin-ldap
- if (stripos($url, 'https://') !== 0 && stripos($url, 'http://') !== 0) {
- $url = $urlGenerator->linkToDocs($url);
- }
- $info['documentation'][$key] = $url;
- }
- }
- $info['version'] = OC_App::getAppVersion($app);
- $appList[] = $info;
- }
- }
- return $appList;
- }
- /**
- * Returns the internal app ID or false
- * @param string $ocsID
- * @return string|false
- */
- public 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;
- }
- 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']['nextcloud']['@attributes']['min-version'])) {
- $requireMin = $appInfo['dependencies']['nextcloud']['@attributes']['min-version'];
- } elseif (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']['nextcloud']['@attributes']['max-version'])) {
- $requireMax = $appInfo['dependencies']['nextcloud']['@attributes']['max-version'];
- } elseif (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(!$versions) {
- $appConfig = \OC::$server->getAppConfig();
- $versions = $appConfig->getValues(false, 'installed_version');
- }
- return $versions;
- }
- /**
- * @param string $app
- * @param \OCP\IConfig $config
- * @param \OCP\IL10N $l
- * @return bool
- *
- * @throws Exception if app is not compatible with this version of ownCloud
- * @throws Exception if no app-name was specified
- */
- public function installApp($app,
- \OCP\IConfig $config,
- \OCP\IL10N $l) {
- if ($app !== false) {
- // check if the app is compatible with this version of ownCloud
- $info = self::getAppInfo($app);
- if(!is_array($info)) {
- throw new \Exception(
- $l->t('App "%s" cannot be installed because appinfo file cannot be read.',
- [$info['name']]
- )
- );
- }
- $version = \OCP\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 the server.',
- array($info['name'])
- )
- );
- }
- // check for required dependencies
- self::checkAppDependencies($config, $l, $info);
- $config->setAppValue($app, 'enabled', 'yes');
- if (isset($appData['id'])) {
- $config->setAppValue($app, 'ocsid', $appData['id']);
- }
- if(isset($info['settings']) && is_array($info['settings'])) {
- $appPath = self::getAppPath($app);
- self::registerAutoloading($app, $appPath);
- \OC::$server->getSettingsManager()->setupSettings($info['settings']);
- }
- \OC_Hook::emit('OC_App', 'post_enable', array('app' => $app));
- } else {
- if(empty($appName) ) {
- throw new \Exception($l->t("No app name specified"));
- } else {
- throw new \Exception($l->t("App '%s' could not be installed!", $appName));
- }
- }
- return $app;
- }
- /**
- * update the database for the app and call the update script
- *
- * @param string $appId
- * @return bool
- */
- public static function updateApp($appId) {
- $appPath = self::getAppPath($appId);
- if($appPath === false) {
- return false;
- }
- $appData = self::getAppInfo($appId);
- self::executeRepairSteps($appId, $appData['repair-steps']['pre-migration']);
- if (file_exists($appPath . '/appinfo/database.xml')) {
- OC_DB::updateDbFromStructure($appPath . '/appinfo/database.xml');
- }
- self::executeRepairSteps($appId, $appData['repair-steps']['post-migration']);
- self::setupLiveMigrations($appId, $appData['repair-steps']['live-migration']);
- unset(self::$appVersion[$appId]);
- // run upgrade code
- if (file_exists($appPath . '/appinfo/update.php')) {
- self::loadApp($appId);
- include $appPath . '/appinfo/update.php';
- }
- self::setupBackgroundJobs($appData['background-jobs']);
- if(isset($appData['settings']) && is_array($appData['settings'])) {
- $appPath = self::getAppPath($appId);
- self::registerAutoloading($appId, $appPath);
- \OC::$server->getSettingsManager()->setupSettings($appData['settings']);
- }
- //set remote/public handlers
- if (array_key_exists('ocsid', $appData)) {
- \OC::$server->getConfig()->setAppValue($appId, 'ocsid', $appData['ocsid']);
- } elseif(\OC::$server->getConfig()->getAppValue($appId, 'ocsid', null) !== null) {
- \OC::$server->getConfig()->deleteAppValue($appId, 'ocsid');
- }
- foreach ($appData['remote'] as $name => $path) {
- \OC::$server->getConfig()->setAppValue('core', 'remote_' . $name, $appId . '/' . $path);
- }
- foreach ($appData['public'] as $name => $path) {
- \OC::$server->getConfig()->setAppValue('core', 'public_' . $name, $appId . '/' . $path);
- }
- self::setAppTypes($appId);
- $version = \OC_App::getAppVersion($appId);
- \OC::$server->getAppConfig()->setValue($appId, 'installed_version', $version);
- \OC::$server->getEventDispatcher()->dispatch(ManagerEvent::EVENT_APP_UPDATE, new ManagerEvent(
- ManagerEvent::EVENT_APP_UPDATE, $appId
- ));
- return true;
- }
- /**
- * @param string $appId
- * @param string[] $steps
- * @throws \OC\NeedsUpdateException
- */
- public static function executeRepairSteps($appId, array $steps) {
- if (empty($steps)) {
- return;
- }
- // load the app
- self::loadApp($appId);
- $dispatcher = OC::$server->getEventDispatcher();
- // load the steps
- $r = new Repair([], $dispatcher);
- foreach ($steps as $step) {
- try {
- $r->addStep($step);
- } catch (Exception $ex) {
- $r->emit('\OC\Repair', 'error', [$ex->getMessage()]);
- \OC::$server->getLogger()->logException($ex);
- }
- }
- // run the steps
- $r->run();
- }
- public static function setupBackgroundJobs(array $jobs) {
- $queue = \OC::$server->getJobList();
- foreach ($jobs as $job) {
- $queue->add($job);
- }
- }
- /**
- * @param string $appId
- * @param string[] $steps
- */
- private static function setupLiveMigrations($appId, array $steps) {
- $queue = \OC::$server->getJobList();
- foreach ($steps as $step) {
- $queue->add('OC\Migration\BackgroundRepair', [
- 'app' => $appId,
- 'step' => $step]);
- }
- }
- /**
- * @param string $appId
- * @return \OC\Files\View|false
- */
- public static function getStorage($appId) {
- if (OC_App::isEnabled($appId)) { //sanity check
- if (\OC::$server->getUserSession()->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 {
- \OCP\Util::writeLog('core', 'Can\'t get app storage, app ' . $appId . ', user not logged in', \OCP\Util::ERROR);
- return false;
- }
- } else {
- \OCP\Util::writeLog('core', 'Can\'t get app storage, app ' . $appId . ' not enabled', \OCP\Util::ERROR);
- return false;
- }
- }
- protected static function findBestL10NOption($options, $lang) {
- $fallback = $similarLangFallback = $englishFallback = false;
- $lang = strtolower($lang);
- $similarLang = $lang;
- if (strpos($similarLang, '_')) {
- // For "de_DE" we want to find "de" and the other way around
- $similarLang = substr($lang, 0, strpos($lang, '_'));
- }
- foreach ($options as $option) {
- if (is_array($option)) {
- if ($fallback === false) {
- $fallback = $option['@value'];
- }
- if (!isset($option['@attributes']['lang'])) {
- continue;
- }
- $attributeLang = strtolower($option['@attributes']['lang']);
- if ($attributeLang === $lang) {
- return $option['@value'];
- }
- if ($attributeLang === $similarLang) {
- $similarLangFallback = $option['@value'];
- } else if (strpos($attributeLang, $similarLang . '_') === 0) {
- if ($similarLangFallback === false) {
- $similarLangFallback = $option['@value'];
- }
- }
- } else {
- $englishFallback = $option;
- }
- }
- if ($similarLangFallback !== false) {
- return $similarLangFallback;
- } else if ($englishFallback !== false) {
- return $englishFallback;
- }
- return (string) $fallback;
- }
- /**
- * parses the app data array and enhanced the 'description' value
- *
- * @param array $data the app data
- * @param string $lang
- * @return array improved app data
- */
- public static function parseAppInfo(array $data, $lang = null) {
- if ($lang && isset($data['name']) && is_array($data['name'])) {
- $data['name'] = self::findBestL10NOption($data['name'], $lang);
- }
- if ($lang && isset($data['summary']) && is_array($data['summary'])) {
- $data['summary'] = self::findBestL10NOption($data['summary'], $lang);
- }
- if ($lang && isset($data['description']) && is_array($data['description'])) {
- $data['description'] = trim(self::findBestL10NOption($data['description'], $lang));
- } else if (isset($data['description']) && is_string($data['description'])) {
- $data['description'] = trim($data['description']);
- } else {
- $data['description'] = '';
- }
- return $data;
- }
- /**
- * @param \OCP\IConfig $config
- * @param \OCP\IL10N $l
- * @param array $info
- * @throws \Exception
- */
- protected static function checkAppDependencies($config, $l, $info) {
- $dependencyAnalyzer = new DependencyAnalyzer(new Platform($config), $l);
- $missing = $dependencyAnalyzer->analyze($info);
- 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',
- [$info['name'], $missingMsg]
- )
- );
- }
- }
- }
|