server/lib/private/legacy/app.php

1248 lines
34 KiB
PHP
Raw Normal View History

<?php
/**
2016-07-21 15:07:57 +00:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
* @copyright Copyright (c) 2016, Lukas Reschke <lukas@statuscode.ch>
2016-07-21 15:07:57 +00:00
*
2016-05-26 17:56:05 +00:00
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
2015-03-26 10:44:34 +00:00
* @author Bart Visscher <bartv@thisnet.nl>
* @author Bernhard Posselt <dev@bernhard-posselt.com>
2016-05-26 17:56:05 +00:00
* @author Björn Schießle <bjoern@schiessle.org>
2015-03-26 10:44:34 +00:00
* @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>
2016-05-26 17:56:05 +00:00
* @author Frank Karlitschek <frank@karlitschek.de>
2015-03-26 10:44:34 +00:00
* @author Georg Ehrke <georg@owncloud.com>
* @author Jakob Sack <mail@jakobsack.de>
* @author Jan-Christoph Borchardt <hey@jancborchardt.net>
2016-07-21 15:07:57 +00:00
* @author Joas Schilling <coding@schilljs.com>
2015-03-26 10:44:34 +00:00
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Kamil Domanski <kdomanski@kdemail.net>
2016-07-21 15:07:57 +00:00
* @author Klaas Freitag <freitag@owncloud.com>
2016-05-26 17:56:05 +00:00
* @author Lukas Reschke <lukas@statuscode.ch>
2015-03-26 10:44:34 +00:00
* @author Markus Goetz <markus@woboq.com>
* @author Morris Jobke <hey@morrisjobke.de>
2015-10-05 18:54:56 +00:00
* @author RealRancor <Fisch.666@gmx.de>
2016-07-21 16:13:36 +00:00
* @author Robin Appelman <robin@icewind.nl>
2016-01-12 14:02:16 +00:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
2016-07-21 15:07:57 +00:00
* @author Roeland Jago Douma <roeland@famdouma.nl>
2015-03-26 10:44:34 +00:00
* @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>
*
2015-03-26 10:44:34 +00:00
* @license AGPL-3.0
*
2015-03-26 10:44:34 +00:00
* 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.
*
2015-03-26 10:44:34 +00:00
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 10:44:34 +00:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
2015-03-26 10:44:34 +00:00
* 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;
2016-04-28 13:15:34 +00:00
use OC\Installer;
use OC\Repair;
use OCP\App\ManagerEvent;
/**
* This class manages the apps. It allows them to register and integrate in the
2014-07-09 08:20:17 +00:00
* ownCloud ecosystem. Furthermore, this class is responsible for installing,
* upgrading and removing apps.
*/
class OC_App {
2015-02-03 13:13:44 +00:00
static private $appVersion = [];
static private $adminForms = array();
static private $personalForms = array();
static private $appInfo = array();
2012-04-14 15:53:02 +00:00
static private $appTypes = array();
static private $loadedApps = array();
static private $altLogin = array();
static private $alreadyRegistered = [];
const officialApp = 200;
/**
2014-07-09 08:20:17 +00:00
* clean the appId
2015-02-02 13:47:38 +00:00
*
2014-07-09 08:20:17 +00:00
* @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
2015-02-02 13:47:38 +00:00
*
2016-02-23 14:57:12 +00:00
* @param string[] | string | null $types
2012-09-23 00:39:11 +00:00
* @return bool
*
2014-07-09 08:20:17 +00:00
* 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) {
2015-12-18 10:42:09 +00:00
if (\OC::$server->getSystemConfig()->getValue('maintenance', false)) {
return false;
}
// Load the enabled apps here
2012-03-30 12:00:24 +00:00
$apps = self::getEnabledApps();
// Add each apps' folder as allowed class path
foreach($apps as $app) {
$path = self::getAppPath($app);
if($path !== false) {
2016-05-02 12:11:34 +00:00
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();
2013-02-09 16:27:57 +00:00
return true;
}
/**
* load a single app
*
2012-09-23 00:39:11 +00:00
* @param string $app
*/
public static function loadApp($app) {
2015-09-04 21:11:45 +00:00
self::$loadedApps[] = $app;
$appPath = self::getAppPath($app);
if($appPath === false) {
return;
}
2016-05-02 12:11:34 +00:00
// in case someone calls loadApp() directly
self::registerAutoloading($app, $appPath);
if (is_file($appPath . '/appinfo/app.php')) {
2014-10-03 20:13:55 +00:00
\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();
}
2014-10-03 20:13:55 +00:00
\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);
}
}
}
2016-05-02 12:11:34 +00:00
/**
* @internal
2016-05-02 12:11:34 +00:00
* @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;
2016-05-02 12:11:34 +00:00
// Register on PSR-4 composer autoloader
$appNamespace = \OC\AppFramework\App::buildAppNamespace($app);
\OC::$server->registerNamespace($app, $appNamespace);
\OC::$composerAutoloader->addPsr4($appNamespace . '\\', $path . '/lib/', true);
if (defined('PHPUNIT_RUN') || defined('CLI_TEST_RUN')) {
2016-05-02 12:11:34 +00:00
\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);
}
}
}
/**
2012-05-14 15:58:50 +00:00
* check if an app is of a specific type
*
* @param string $app
2014-04-21 10:54:45 +00:00
* @param string|array $types
2012-09-23 00:39:11 +00:00
* @return bool
*/
2012-11-02 18:53:02 +00:00
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;
}
2012-05-02 09:14:11 +00:00
2012-04-14 15:53:02 +00:00
/**
* get the types of an app
*
2012-04-14 15:53:02 +00:00
* @param string $app
* @return array
*/
2012-09-07 13:22:01 +00:00
private static function getAppTypes($app) {
2012-04-14 15:53:02 +00:00
//load the cache
if (count(self::$appTypes) == 0) {
2015-07-03 12:16:29 +00:00
self::$appTypes = \OC::$server->getAppConfig()->getValues(false, 'types');
2012-04-14 15:53:02 +00:00
}
2012-05-02 09:14:11 +00:00
if (isset(self::$appTypes[$app])) {
2012-09-04 10:32:27 +00:00
return explode(',', self::$appTypes[$app]);
} else {
return array();
}
}
2012-05-02 09:14:11 +00:00
/**
* read app types from info.xml and cache them in the database
*/
2012-09-07 13:22:01 +00:00
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'] = [];
2012-04-14 15:53:02 +00:00
}
2012-05-02 09:14:11 +00:00
2015-07-03 12:16:29 +00:00
\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');
}
}
2012-04-14 15:53:02 +00:00
}
2013-01-14 19:30:39 +00:00
/**
* check if app is shipped
*
2014-07-09 08:20:17 +00:00
* @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.
*/
2014-07-09 08:20:17 +00:00
public static function isShipped($appId) {
return \OC::$server->getAppManager()->isShipped($appId);
}
2012-03-30 12:00:24 +00:00
/**
* get all enabled apps
*/
2014-07-01 14:55:29 +00:00
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
2015-02-02 13:47:38 +00:00
* @return string[]
*/
public static function getEnabledApps($forceRefresh = false, $all = false) {
2015-12-18 10:42:09 +00:00
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
2015-02-02 13:47:38 +00:00
$appManager = \OC::$server->getAppManager();
if ($all) {
$user = null;
} else {
$user = \OC::$server->getUserSession()->getUser();
}
2015-02-02 13:47:38 +00:00
if (is_null($user)) {
$apps = $appManager->getInstalledApps();
} else {
2015-02-05 14:11:07 +00:00
$apps = $appManager->getEnabledAppsForUser($user);
2012-03-30 12:00:24 +00:00
}
2015-02-02 13:47:38 +00:00
$apps = array_filter($apps, function ($app) {
return $app !== 'files';//we add this manually
});
2014-04-21 11:38:08 +00:00
sort($apps);
array_unshift($apps, 'files');
2012-03-30 12:00:24 +00:00
return $apps;
}
/**
* checks whether or not an app is enabled
2015-02-02 13:47:38 +00:00
*
2012-09-23 00:39:11 +00:00
* @param string $app app
* @return bool
*
* This function checks whether or not an app is enabled.
*/
public static function isEnabled($app) {
2015-02-02 13:47:38 +00:00
return \OC::$server->getAppManager()->isEnabledForUser($app);
}
/**
* enables an app
2015-02-02 13:47:38 +00:00
*
* @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
// Check if app is already downloaded
$installer = new Installer(
\OC::$server->getAppFetcher(),
\OC::$server->getHTTPClientService(),
\OC::$server->getTempManager(),
\OC::$server->getLogger(),
\OC::$server->getConfig()
);
$isDownloaded = $installer->isDownloaded($appId);
if(!$isDownloaded) {
$installer->downloadApp($appId);
}
$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);
2015-02-02 13:47:38 +00:00
} else {
$appManager->enableApp($appId);
}
}
/**
* @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(),
\OC::$server->getConfig()
);
return $installer->removeApp($app);
}
/**
2011-11-09 10:32:06 +00:00
* This function set an app as disabled in appconfig.
2015-02-02 13:47:38 +00:00
*
2014-06-10 11:51:20 +00:00
* @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);
}
2013-07-16 03:56:52 +00:00
// This is private as well. It simply works, so don't ask for more details
private static function proceedNavigation($list) {
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;
}
});
2011-04-17 17:38:04 +00:00
$activeApp = OC::$server->getNavigationManager()->getActiveEntry();
foreach ($list as $index => &$navEntry) {
if ($navEntry['id'] == $activeApp) {
$navEntry['active'] = true;
} else {
$navEntry['active'] = false;
}
}
unset($navEntry);
2011-04-17 17:38:04 +00:00
return $list;
2011-04-16 08:26:18 +00:00
}
2012-05-02 09:14:11 +00:00
/**
2012-07-23 22:39:59 +00:00
* Get the path where to install apps
*
2015-01-16 18:31:15 +00:00
* @return string|false
2012-07-23 22:39:59 +00:00
*/
public static function getInstallPath() {
2015-12-18 10:42:09 +00:00
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'];
}
}
2015-07-03 12:06:40 +00:00
\OCP\Util::writeLog('core', 'No application directories are marked as writable.', \OCP\Util::ERROR);
return null;
}
/**
* search for an app in all app-directories
2015-02-02 13:47:38 +00:00
*
2015-04-07 11:49:16 +00:00
* @param string $appId
* @return false|string
*/
public static function findAppInDirectories($appId) {
$sanitizedAppId = self::cleanAppId($appId);
if($sanitizedAppId !== $appId) {
return false;
}
2012-06-28 19:54:33 +00:00
static $app_dir = array();
if (isset($app_dir[$appId])) {
return $app_dir[$appId];
2012-06-28 19:54:33 +00:00
}
$possibleApps = array();
2015-02-02 13:47:38 +00:00
foreach (OC::$APPSROOTS as $dir) {
if (file_exists($dir['path'] . '/' . $appId)) {
$possibleApps[] = $dir;
}
}
if (empty($possibleApps)) {
return false;
2015-02-02 13:47:38 +00:00
} elseif (count($possibleApps) === 1) {
$dir = array_shift($possibleApps);
$app_dir[$appId] = $dir;
return $dir;
} else {
$versionToLoad = array();
2015-02-02 13:47:38 +00:00
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
}
}
2012-06-01 22:05:20 +00:00
/**
* Get the directory for the given app.
* If the app is defined in multiple directories, the first one is taken. (false if not found)
2014-07-09 08:20:17 +00:00
*
2014-07-09 08:20:52 +00:00
* @param string $appId
* @return string|false
*/
2014-07-09 08:20:17 +00:00
public static function getAppPath($appId) {
if ($appId === null || trim($appId) === '') {
return false;
}
2014-07-09 08:20:17 +00:00
if (($dir = self::findAppInDirectories($appId)) != false) {
return $dir['path'] . '/' . $appId;
}
2012-09-23 00:39:11 +00:00
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)
2014-07-09 08:20:17 +00:00
*
* @param string $appId
* @return string|false
*/
2014-07-09 08:20:17 +00:00
public static function getAppWebPath($appId) {
if (($dir = self::findAppInDirectories($appId)) != false) {
return OC::$WEBROOT . $dir['url'] . '/' . $appId;
2012-06-01 22:05:20 +00:00
}
2012-09-23 00:39:11 +00:00
return false;
2012-06-01 22:05:20 +00:00
}
/**
2016-02-10 10:04:12 +00:00
* get the last version of the app from appinfo/info.xml
2014-07-09 08:20:17 +00:00
*
* @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];
2015-02-03 13:13:44 +00:00
}
$file = self::getAppPath($appId);
self::$appVersion[$appId] = ($file !== false) ? self::getAppVersionByPath($file) : '0';
2015-02-03 13:13:44 +00:00
return self::$appVersion[$appId];
}
/**
* get app's version based on it's path
2015-02-02 13:47:38 +00:00
*
* @param string $path
* @return string
*/
public static function getAppVersionByPath($path) {
$infoFile = $path . '/appinfo/info.xml';
2016-02-10 10:04:12 +00:00
$appData = self::getAppInfo($infoFile, true);
return isset($appData['version']) ? $appData['version'] : '';
}
/**
* Read all app metadata from the info.xml file
2014-07-09 08:20:17 +00:00
*
* @param string $appId id of the app or the path of the info.xml file
* @param bool $path
* @param string $lang
2014-07-05 11:32:21 +00:00
* @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) {
2014-07-09 08:20:17 +00:00
$file = $appId;
} else {
if ($lang === null && isset(self::$appInfo[$appId])) {
2014-07-09 08:20:17 +00:00
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);
2015-02-02 13:47:38 +00:00
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;
}
2012-10-14 19:04:08 +00:00
return $data;
}
/**
* Returns the navigation
2015-02-02 13:47:38 +00:00
*
2014-04-21 13:44:54 +00:00
* @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
*/
2012-09-07 13:22:01 +00:00
public static function getNavigation() {
$entries = OC::$server->getNavigationManager()->getAll();
return self::proceedNavigation($entries);
}
/**
* 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() {
$entries = OC::$server->getNavigationManager()->getAll('settings');
return self::proceedNavigation($entries);
}
/**
* get the id of loaded app
*
* @return string
*/
2012-09-07 13:22:01 +00:00
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
*/
2012-09-07 13:22:01 +00:00
public static function getForms($type) {
$forms = array();
switch ($type) {
case 'admin':
$source = self::$adminForms;
2013-02-09 16:27:57 +00:00
break;
case 'personal':
$source = self::$personalForms;
2013-02-09 16:27:57 +00:00
break;
2012-09-23 00:39:11 +00:00
default:
2013-02-09 16:27:57 +00:00
return array();
}
foreach ($source as $form) {
$forms[] = include $form;
}
return $forms;
}
/**
* register an admin form to be shown
*
* @param string $app
* @param string $page
*/
2012-11-02 18:53:02 +00:00
public static function registerAdmin($app, $page) {
self::$adminForms[] = $app . '/' . $page . '.php';
}
/**
* register a personal form to be shown
2015-04-07 11:49:16 +00:00
* @param string $app
* @param string $page
*/
2012-11-02 18:53:02 +00:00
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;
}
2011-08-10 10:20:43 +00:00
/**
* get a list of all apps in the apps folder
2015-02-02 13:47:38 +00:00
*
2014-05-11 17:13:51 +00:00
* @return array an array of app names (string IDs)
* @todo: change the name of this method to getInstalledApps, which is more accurate
2011-08-10 10:20:43 +00:00
*/
2012-09-07 13:22:01 +00:00
public static function getAllApps() {
2012-10-14 19:04:08 +00:00
$apps = array();
2012-10-14 19:04:08 +00:00
foreach (OC::$APPSROOTS as $apps_dir) {
if (!is_readable($apps_dir['path'])) {
2015-07-03 12:06:40 +00:00
\OCP\Util::writeLog('core', 'unable to read app folder : ' . $apps_dir['path'], \OCP\Util::WARN);
2012-09-19 19:26:57 +00:00
continue;
}
$dh = opendir($apps_dir['path']);
2012-10-14 19:04:08 +00:00
if (is_resource($dh)) {
while (($file = readdir($dh)) !== false) {
2012-10-14 19:04:08 +00:00
if ($file[0] != '.' and is_dir($apps_dir['path'] . '/' . $file) and is_file($apps_dir['path'] . '/' . $file . '/appinfo/info.xml')) {
2012-10-14 19:04:08 +00:00
$apps[] = $file;
}
}
2011-08-10 10:20:43 +00:00
}
}
2012-10-14 19:04:08 +00:00
2011-08-10 10:20:43 +00:00
return $apps;
}
2012-10-14 19:04:08 +00:00
2013-01-21 21:18:11 +00:00
/**
* List all apps, this is used in apps.php
2015-02-02 13:47:38 +00:00
*
2013-01-21 21:18:11 +00:00
* @return array
*/
public function listAllApps() {
2013-01-21 21:18:11 +00:00
$installedApps = OC_App::getAllApps();
//we don't want to show configuration for these
$blacklist = \OC::$server->getAppManager()->getAlwaysEnabledApps();
2013-01-21 21:18:11 +00:00
$appList = array();
$langCode = \OC::$server->getL10N('core')->getLanguageCode();
$urlGenerator = \OC::$server->getURLGenerator();
2013-01-21 21:18:11 +00:00
foreach ($installedApps as $app) {
if (array_search($app, $blacklist) === false) {
2013-01-21 21:18:11 +00:00
$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;
}
2013-01-21 21:18:11 +00:00
if (!isset($info['name'])) {
2015-07-03 12:06:40 +00:00
\OCP\Util::writeLog('core', 'App id "' . $app . '" has no name in appinfo', \OCP\Util::ERROR);
2013-01-21 21:18:11 +00:00
continue;
}
2015-07-03 12:16:29 +00:00
$enabled = \OC::$server->getAppConfig()->getValue($app, 'enabled', 'no');
$info['groups'] = null;
if ($enabled === 'yes') {
2013-01-21 21:18:11 +00:00
$active = true;
2015-02-02 13:47:38 +00:00
} else if ($enabled === 'no') {
2013-01-21 21:18:11 +00:00
$active = false;
} else {
$active = true;
$info['groups'] = $enabled;
2013-01-21 21:18:11 +00:00
}
$info['active'] = $active;
if (self::isShipped($app)) {
$info['internal'] = true;
$info['level'] = self::officialApp;
$info['removable'] = false;
2013-01-21 21:18:11 +00:00
} else {
$info['internal'] = false;
$info['removable'] = true;
2013-01-21 21:18:11 +00:00
}
$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;
}
}
2013-01-21 21:18:11 +00:00
$info['version'] = OC_App::getAppVersion($app);
$appList[] = $info;
}
}
2013-10-14 08:54:38 +00:00
return $appList;
2013-10-14 08:54:38 +00:00
}
/**
* 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);
2014-10-30 16:24:25 +00:00
if ($currentVersion && isset($versions[$app])) {
$installedVersion = $versions[$app];
if (!version_compare($currentVersion, $installedVersion, '=')) {
return true;
}
}
return false;
}
/**
2014-07-09 08:20:17 +00:00
* 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
2015-02-02 13:47:38 +00:00
* @param array $appInfo app info (from xml)
*
* @return boolean true if compatible, otherwise false
*/
2015-02-02 13:47:38 +00:00
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;
}
2012-03-30 11:48:44 +00:00
/**
2012-06-28 20:01:46 +00:00
* get the installed version of all apps
2012-03-30 11:48:44 +00:00
*/
2012-09-07 13:22:01 +00:00
public static function getAppVersions() {
2012-06-26 18:53:28 +00:00
static $versions;
2016-01-03 15:53:30 +00:00
if(!$versions) {
$appConfig = \OC::$server->getAppConfig();
$versions = $appConfig->getValues(false, 'installed_version');
2012-03-30 11:48:44 +00:00
}
2016-01-03 15:53:30 +00:00
return $versions;
2012-03-30 11:48:44 +00:00
}
/**
* @param string $app
* @param \OCP\IConfig $config
* @param \OCP\IL10N $l
* @return bool
*
2014-06-10 11:58:41 +00:00
* @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) {
2015-02-02 13:47:38 +00:00
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();
2015-02-02 13:47:38 +00:00
if (!self::isAppCompatible($version, $info)) {
throw new \Exception(
2016-06-20 08:48:56 +00:00
$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');
2015-02-02 13:47:38 +00:00
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));
2015-02-02 13:47:38 +00:00
} 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
*
2014-07-09 08:20:17 +00:00
* @param string $appId
* @return bool
*/
2014-07-09 08:20:17 +00:00
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']);
2016-04-26 09:56:56 +00:00
self::setupLiveMigrations($appId, $appData['repair-steps']['live-migration']);
2015-02-03 14:23:51 +00:00
unset(self::$appVersion[$appId]);
2015-07-09 10:37:57 +00:00
// run upgrade code
if (file_exists($appPath . '/appinfo/update.php')) {
self::loadApp($appId);
include $appPath . '/appinfo/update.php';
}
self::registerAutoloading($appId, $appPath);
self::setupBackgroundJobs($appData['background-jobs']);
if(isset($appData['settings']) && is_array($appData['settings'])) {
\OC::$server->getSettingsManager()->setupSettings($appData['settings']);
}
2012-09-23 00:39:11 +00:00
//set remote/public handlers
2014-07-07 14:57:50 +00:00
if (array_key_exists('ocsid', $appData)) {
2015-07-09 10:37:57 +00:00
\OC::$server->getConfig()->setAppValue($appId, 'ocsid', $appData['ocsid']);
} elseif(\OC::$server->getConfig()->getAppValue($appId, 'ocsid', null) !== null) {
\OC::$server->getConfig()->deleteAppValue($appId, 'ocsid');
2014-07-07 14:57:50 +00:00
}
foreach ($appData['remote'] as $name => $path) {
2015-07-09 10:37:57 +00:00
\OC::$server->getConfig()->setAppValue('core', 'remote_' . $name, $appId . '/' . $path);
}
foreach ($appData['public'] as $name => $path) {
2015-07-09 10:37:57 +00:00
\OC::$server->getConfig()->setAppValue('core', 'public_' . $name, $appId . '/' . $path);
}
2014-07-09 08:20:17 +00:00
self::setAppTypes($appId);
$version = \OC_App::getAppVersion($appId);
2015-07-03 12:16:29 +00:00
\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);
}
}
2016-04-26 09:56:56 +00:00
/**
* @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]);
}
}
/**
2014-07-09 08:20:17 +00:00
* @param string $appId
2015-01-16 18:31:15 +00:00
* @return \OC\Files\View|false
*/
2014-07-09 08:20:17 +00:00
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());
2014-07-09 08:20:17 +00:00
if (!$view->file_exists($appId)) {
$view->mkdir($appId);
}
2014-07-09 08:20:17 +00:00
return new \OC\Files\View('/' . OC_User::getUser() . '/' . $appId);
} else {
2015-07-03 12:06:40 +00:00
\OCP\Util::writeLog('core', 'Can\'t get app storage, app ' . $appId . ', user not logged in', \OCP\Util::ERROR);
return false;
}
} else {
2015-07-03 12:06:40 +00:00
\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
*/
public 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]
)
);
}
}
}