nextcloud/lib/private/legacy/app.php

1323 lines
36 KiB
PHP
Raw Normal View History

<?php
/**
2015-03-26 13:44:34 +03:00
* @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>
2015-10-05 21:54:56 +03:00
* @author RealRancor <Fisch.666@gmx.de>
2015-03-26 13:44:34 +03:00
* @author Robin Appelman <icewind@owncloud.com>
2016-01-12 17:02:16 +03:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
* @author Roeland Jago Douma <rullzer@owncloud.com>
2015-03-26 13:44:34 +03: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>
*
2016-01-12 17:02:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
*
2015-03-26 13:44:34 +03: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 13:44:34 +03: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 13:44:34 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
2015-03-26 13:44:34 +03: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\Platform;
2016-04-28 16:15:34 +03:00
use OC\Installer;
use OC\OCSClient;
use OC\Repair;
/**
* This class manages the apps. It allows them to register and integrate in the
2014-07-09 12:20:17 +04:00
* ownCloud ecosystem. Furthermore, this class is responsible for installing,
* upgrading and removing apps.
*/
class OC_App {
2015-02-03 16:13:44 +03:00
static private $appVersion = [];
static private $adminForms = array();
static private $personalForms = array();
static private $appInfo = array();
2012-04-14 19:53:02 +04:00
static private $appTypes = array();
static private $loadedApps = array();
static private $altLogin = array();
const officialApp = 200;
/**
2014-07-09 12:20:17 +04:00
* clean the appId
2015-02-02 16:47:38 +03:00
*
2014-07-09 12:20:17 +04: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 16:47:38 +03:00
*
2016-02-23 17:57:12 +03:00
* @param string[] | string | null $types
2012-09-23 04:39:11 +04:00
* @return bool
*
2014-07-09 12:20:17 +04: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 13:42:09 +03:00
if (\OC::$server->getSystemConfig()->getValue('maintenance', false)) {
return false;
}
// Load the enabled apps here
2012-03-30 16:00:24 +04: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 15:11:34 +03: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 20:27:57 +04:00
return true;
}
/**
* load a single app
*
2012-09-23 04:39:11 +04:00
* @param string $app
* @param bool $checkUpgrade whether an upgrade check should be done
* @throws \OC\NeedsUpdateException
*/
public static function loadApp($app, $checkUpgrade = true) {
2015-09-05 00:11:45 +03:00
self::$loadedApps[] = $app;
$appPath = self::getAppPath($app);
if($appPath === false) {
return;
}
2016-05-02 15:11:34 +03:00
// in case someone calls loadApp() directly
self::registerAutoloading($app, $appPath);
if (is_file($appPath . '/appinfo/app.php')) {
2014-10-04 00:13:55 +04:00
\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();
}
2014-10-04 00:13:55 +04:00
\OC::$server->getEventLogger()->end('load_app_' . $app);
}
}
2016-05-02 15:11:34 +03:00
/**
* @param string $app
* @param string $path
*/
protected static function registerAutoloading($app, $path) {
// Register on PSR-4 composer autoloader
$appNamespace = \OC\AppFramework\App::buildAppNamespace($app);
\OC::$composerAutoloader->addPsr4($appNamespace . '\\', $path . '/lib/', true);
2016-05-02 15:11:34 +03:00
if (defined('PHPUNIT_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);
}
}
}
/**
2012-05-14 19:58:50 +04:00
* check if an app is of a specific type
*
* @param string $app
2014-04-21 14:54:45 +04:00
* @param string|array $types
2012-09-23 04:39:11 +04:00
* @return bool
*/
2012-11-02 22:53:02 +04: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 13:14:11 +04:00
2012-04-14 19:53:02 +04:00
/**
* get the types of an app
*
2012-04-14 19:53:02 +04:00
* @param string $app
* @return array
*/
2012-09-07 17:22:01 +04:00
private static function getAppTypes($app) {
2012-04-14 19:53:02 +04:00
//load the cache
if (count(self::$appTypes) == 0) {
2015-07-03 15:16:29 +03:00
self::$appTypes = \OC::$server->getAppConfig()->getValues(false, 'types');
2012-04-14 19:53:02 +04:00
}
2012-05-02 13:14:11 +04:00
if (isset(self::$appTypes[$app])) {
2012-09-04 14:32:27 +04:00
return explode(',', self::$appTypes[$app]);
} else {
return array();
}
}
2012-05-02 13:14:11 +04:00
/**
* read app types from info.xml and cache them in the database
*/
2012-09-07 17:22:01 +04: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 = '';
2012-04-14 19:53:02 +04:00
}
2012-05-02 13:14:11 +04:00
2015-07-03 15:16:29 +03:00
\OC::$server->getAppConfig()->setValue($app, 'types', $appTypes);
2012-04-14 19:53:02 +04:00
}
2013-01-14 23:30:39 +04:00
/**
* check if app is shipped
*
2014-07-09 12:20:17 +04: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 12:20:17 +04:00
public static function isShipped($appId) {
return \OC::$server->getAppManager()->isShipped($appId);
}
2012-03-30 16:00:24 +04:00
/**
* get all enabled apps
*/
2014-07-01 18:55:29 +04: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 16:47:38 +03:00
* @return string[]
*/
public static function getEnabledApps($forceRefresh = false, $all = false) {
2015-12-18 13:42:09 +03: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 16:47:38 +03:00
$appManager = \OC::$server->getAppManager();
if ($all) {
$user = null;
} else {
$user = \OC::$server->getUserSession()->getUser();
}
2015-02-02 16:47:38 +03:00
if (is_null($user)) {
$apps = $appManager->getInstalledApps();
} else {
2015-02-05 17:11:07 +03:00
$apps = $appManager->getEnabledAppsForUser($user);
2012-03-30 16:00:24 +04:00
}
2015-02-02 16:47:38 +03:00
$apps = array_filter($apps, function ($app) {
return $app !== 'files';//we add this manually
});
2014-04-21 15:38:08 +04:00
sort($apps);
array_unshift($apps, 'files');
2012-03-30 16:00:24 +04:00
return $apps;
}
/**
* checks whether or not an app is enabled
2015-02-02 16:47:38 +03:00
*
2012-09-23 04:39:11 +04: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 16:47:38 +03:00
return \OC::$server->getAppManager()->isEnabledForUser($app);
}
/**
* enables an app
2015-02-02 16:47:38 +03:00
*
2012-09-23 04:39:11 +04:00
* @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
2016-04-28 16:15:34 +03:00
if (!Installer::isInstalled($app)) {
$app = self::installApp($app);
2011-08-22 16:17:38 +04:00
}
$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);
2015-02-02 16:47:38 +03:00
} else {
$appManager->enableApp($app);
}
}
/**
* @param string $app
* @return int
*/
private static function downloadApp($app) {
$ocsClient = new OCSClient(
\OC::$server->getHTTPClientService(),
\OC::$server->getConfig(),
\OC::$server->getLogger()
);
$appData = $ocsClient->getApplication($app, \OCP\Util::getVersion());
$download = $ocsClient->getApplicationDownload($app, \OCP\Util::getVersion());
if(isset($download['downloadlink']) and $download['downloadlink']!='') {
// Replace spaces in download link without encoding entire URL
$download['downloadlink'] = str_replace(' ', '%20', $download['downloadlink']);
2015-02-02 16:47:38 +03:00
$info = array('source' => 'http', 'href' => $download['downloadlink'], 'appdata' => $appData);
2016-04-28 16:15:34 +03:00
$app = Installer::installApp($info);
}
return $app;
}
/**
* @param string $app
* @return bool
*/
public static function removeApp($app) {
if (self::isShipped($app)) {
return false;
}
2016-04-28 16:15:34 +03:00
return Installer::removeApp($app);
}
/**
2011-11-09 14:32:06 +04:00
* This function set an app as disabled in appconfig.
2015-02-02 16:47:38 +03:00
*
2014-06-10 15:51:20 +04:00
* @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);
}
// 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
2015-02-02 16:47:38 +03:00
*
* @return string[]
*
2011-04-17 21:38:04 +04:00
* This function returns an array containing all settings pages added. The
2011-06-20 21:50:25 +04:00
* entries are sorted by the key 'order' ascending.
*/
2012-09-07 17:22:01 +04:00
public static function getSettingsNavigation() {
2014-08-31 12:05:59 +04:00
$l = \OC::$server->getL10N('lib');
$urlGenerator = \OC::$server->getURLGenerator();
$settings = array();
// by default, settings only contain the help menu
if (OC_Util::getEditionString() === '' &&
2015-12-18 13:42:09 +03:00
\OC::$server->getSystemConfig()->getValue('knowledgebaseenabled', true) == true
) {
$settings = array(
2013-02-11 20:44:02 +04:00
array(
"id" => "help",
"order" => 1000,
"href" => $urlGenerator->linkToRoute('settings_help'),
2013-02-11 20:44:02 +04:00
"name" => $l->t("Help"),
"icon" => $urlGenerator->imagePath("settings", "help.svg")
2013-02-11 20:44:02 +04:00
)
);
}
// if the user is logged-in
if (OC_User::isLoggedIn()) {
// personal menu
2013-02-11 20:44:02 +04:00
$settings[] = array(
"id" => "personal",
"order" => 1,
"href" => $urlGenerator->linkToRoute('settings_personal'),
2013-02-11 20:44:02 +04:00
"name" => $l->t("Personal"),
"icon" => $urlGenerator->imagePath("settings", "personal.svg")
2013-02-11 20:44:02 +04:00
);
2012-07-15 18:31:28 +04:00
//SubAdmins are also allowed to access user management
2015-10-27 16:09:45 +03:00
$userObject = \OC::$server->getUserSession()->getUser();
$isSubAdmin = false;
if($userObject !== null) {
$isSubAdmin = \OC::$server->getGroupManager()->getSubAdmin()->isSubAdmin($userObject);
}
if ($isSubAdmin) {
// admin users menu
2013-02-11 20:44:02 +04:00
$settings[] = array(
"id" => "core_users",
"order" => 2,
"href" => $urlGenerator->linkToRoute('settings_users'),
2013-02-11 20:44:02 +04:00
"name" => $l->t("Users"),
"icon" => $urlGenerator->imagePath("settings", "users.svg")
2013-02-11 20:44:02 +04:00
);
2012-07-15 18:31:28 +04:00
}
2012-07-15 18:31:28 +04:00
// if the user is an admin
if (OC_User::isAdminUser(OC_User::getUser())) {
// admin settings
$settings[] = array(
2013-02-11 20:44:02 +04:00
"id" => "admin",
"order" => 1000,
"href" => $urlGenerator->linkToRoute('settings_admin'),
2013-02-11 20:44:02 +04:00
"name" => $l->t("Admin"),
"icon" => $urlGenerator->imagePath("settings", "admin.svg")
2013-02-11 20:44:02 +04:00
);
}
2012-08-29 22:34:44 +04:00
}
$navigation = self::proceedNavigation($settings);
return $navigation;
2011-04-17 21:38:04 +04:00
}
2013-07-16 07:56:52 +04:00
// This is private as well. It simply works, so don't ask for more details
private static function proceedNavigation($list) {
2014-07-09 12:20:17 +04:00
$activeApp = OC::$server->getNavigationManager()->getActiveEntry();
foreach ($list as &$navEntry) {
if ($navEntry['id'] == $activeApp) {
$navEntry['active'] = true;
} else {
2014-07-09 12:20:17 +04:00
$navEntry['active'] = false;
2011-04-17 21:38:04 +04:00
}
}
2014-07-09 12:20:17 +04:00
unset($navEntry);
2011-04-16 12:26:18 +04:00
usort($list, create_function('$a, $b', 'if( $a["order"] == $b["order"] ) {return 0;}elseif( $a["order"] < $b["order"] ) {return -1;}else{return 1;}'));
2011-04-17 21:38:04 +04:00
return $list;
2011-04-16 12:26:18 +04:00
}
2012-05-02 13:14:11 +04:00
/**
2012-07-24 02:39:59 +04:00
* Get the path where to install apps
*
2015-01-16 21:31:15 +03:00
* @return string|false
2012-07-24 02:39:59 +04:00
*/
public static function getInstallPath() {
2015-12-18 13:42:09 +03: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 15:06:40 +03: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 16:47:38 +03:00
*
2015-04-07 14:49:16 +03:00
* @param string $appId
* @return false|string
*/
protected static function findAppInDirectories($appId) {
$sanitizedAppId = self::cleanAppId($appId);
if($sanitizedAppId !== $appId) {
return false;
}
2012-06-28 23:54:33 +04:00
static $app_dir = array();
if (isset($app_dir[$appId])) {
return $app_dir[$appId];
2012-06-28 23:54:33 +04:00
}
$possibleApps = array();
2015-02-02 16:47:38 +03:00
foreach (OC::$APPSROOTS as $dir) {
if (file_exists($dir['path'] . '/' . $appId)) {
$possibleApps[] = $dir;
}
}
if (empty($possibleApps)) {
return false;
2015-02-02 16:47:38 +03:00
} elseif (count($possibleApps) === 1) {
$dir = array_shift($possibleApps);
$app_dir[$appId] = $dir;
return $dir;
} else {
$versionToLoad = array();
2015-02-02 16:47:38 +03: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-02 02:05:20 +04: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 12:20:17 +04:00
*
2014-07-09 12:20:52 +04:00
* @param string $appId
* @return string|false
*/
2014-07-09 12:20:17 +04:00
public static function getAppPath($appId) {
if ($appId === null || trim($appId) === '') {
return false;
}
2014-07-09 12:20:17 +04:00
if (($dir = self::findAppInDirectories($appId)) != false) {
return $dir['path'] . '/' . $appId;
}
2012-09-23 04:39:11 +04:00
return false;
}
/**
* check if an app's directory is writable
2014-07-09 12:20:17 +04:00
*
* @param string $appId
* @return bool
*/
2014-07-09 12:20:17 +04:00
public static function isAppDirWritable($appId) {
$path = self::getAppPath($appId);
2014-06-06 11:41:33 +04:00
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)
2014-07-09 12:20:17 +04:00
*
* @param string $appId
* @return string|false
*/
2014-07-09 12:20:17 +04:00
public static function getAppWebPath($appId) {
if (($dir = self::findAppInDirectories($appId)) != false) {
return OC::$WEBROOT . $dir['url'] . '/' . $appId;
2012-06-02 02:05:20 +04:00
}
2012-09-23 04:39:11 +04:00
return false;
2012-06-02 02:05:20 +04:00
}
/**
2016-02-10 13:04:12 +03:00
* get the last version of the app from appinfo/info.xml
2014-07-09 12:20:17 +04:00
*
* @param string $appId
* @return string
*/
2014-07-09 12:20:17 +04:00
public static function getAppVersion($appId) {
2015-02-03 16:13:44 +03:00
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
2015-02-02 16:47:38 +03:00
*
* @param string $path
* @return string
*/
public static function getAppVersionByPath($path) {
$infoFile = $path . '/appinfo/info.xml';
2016-02-10 13:04:12 +03:00
$appData = self::getAppInfo($infoFile, true);
return isset($appData['version']) ? $appData['version'] : '';
}
/**
* Read all app metadata from the info.xml file
2014-07-09 12:20:17 +04:00
*
* @param string $appId id of the app or the path of the info.xml file
2012-09-23 04:39:11 +04:00
* @param boolean $path (optional)
2014-07-05 15:32:21 +04:00
* @return array|null
* @note all data is read from info.xml, not just pre-defined fields
*/
2014-07-09 12:20:17 +04:00
public static function getAppInfo($appId, $path = false) {
if ($path) {
2014-07-09 12:20:17 +04:00
$file = $appId;
} else {
2014-07-09 12:20:17 +04:00
if (isset(self::$appInfo[$appId])) {
return self::$appInfo[$appId];
}
$appPath = self::getAppPath($appId);
if($appPath === false) {
return null;
}
$file = $appPath . '/appinfo/info.xml';
}
$parser = new \OC\App\InfoParser(\OC::$server->getURLGenerator());
$data = $parser->parse($file);
2015-02-02 16:47:38 +03:00
if (is_array($data)) {
$data = OC_App::parseAppInfo($data);
}
if(isset($data['ocsid'])) {
$storedId = \OC::$server->getConfig()->getAppValue($appId, 'ocsid');
if($storedId !== '' && $storedId !== $data['ocsid']) {
$data['ocsid'] = $storedId;
}
}
2014-07-09 12:20:17 +04:00
self::$appInfo[$appId] = $data;
2012-10-14 23:04:08 +04:00
return $data;
}
/**
* Returns the navigation
2015-02-02 16:47:38 +03:00
*
2014-04-21 17:44:54 +04: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 17:22:01 +04:00
public static function getNavigation() {
$entries = OC::$server->getNavigationManager()->getAll();
$navigation = self::proceedNavigation($entries);
return $navigation;
}
/**
* get the id of loaded app
*
* @return string
*/
2012-09-07 17:22:01 +04: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 17:22:01 +04:00
public static function getForms($type) {
$forms = array();
switch ($type) {
case 'admin':
$source = self::$adminForms;
2013-02-09 20:27:57 +04:00
break;
case 'personal':
$source = self::$personalForms;
2013-02-09 20:27:57 +04:00
break;
2012-09-23 04:39:11 +04:00
default:
2013-02-09 20:27:57 +04: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 22:53:02 +04:00
public static function registerAdmin($app, $page) {
self::$adminForms[] = $app . '/' . $page . '.php';
}
/**
* register a personal form to be shown
2015-04-07 14:49:16 +03:00
* @param string $app
* @param string $page
*/
2012-11-02 22:53:02 +04: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 14:20:43 +04:00
/**
* get a list of all apps in the apps folder
2015-02-02 16:47:38 +03:00
*
2014-05-11 21:13:51 +04: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 14:20:43 +04:00
*/
2012-09-07 17:22:01 +04:00
public static function getAllApps() {
2012-10-14 23:04:08 +04:00
$apps = array();
2012-10-14 23:04:08 +04:00
foreach (OC::$APPSROOTS as $apps_dir) {
if (!is_readable($apps_dir['path'])) {
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('core', 'unable to read app folder : ' . $apps_dir['path'], \OCP\Util::WARN);
2012-09-19 23:26:57 +04:00
continue;
}
$dh = opendir($apps_dir['path']);
2012-10-14 23:04:08 +04:00
if (is_resource($dh)) {
while (($file = readdir($dh)) !== false) {
2012-10-14 23:04:08 +04:00
if ($file[0] != '.' and is_dir($apps_dir['path'] . '/' . $file) and is_file($apps_dir['path'] . '/' . $file . '/appinfo/info.xml')) {
2012-10-14 23:04:08 +04:00
$apps[] = $file;
}
}
2011-08-10 14:20:43 +04:00
}
}
2012-10-14 23:04:08 +04:00
2011-08-10 14:20:43 +04:00
return $apps;
}
2012-10-14 23:04:08 +04:00
2013-01-22 01:18:11 +04:00
/**
* List all apps, this is used in apps.php
2015-02-02 16:47:38 +03:00
*
* @param bool $onlyLocal
* @param bool $includeUpdateInfo Should we check whether there is an update
* in the app store?
* @param OCSClient $ocsClient
2013-01-22 01:18:11 +04:00
* @return array
*/
public static function listAllApps($onlyLocal = false,
$includeUpdateInfo = true,
OCSClient $ocsClient) {
2013-01-22 01:18:11 +04:00
$installedApps = OC_App::getAllApps();
2013-02-11 20:44:02 +04:00
//TODO which apps do we want to blacklist and how do we integrate
// blacklisting with the multi apps folder feature?
2013-01-22 01:18:11 +04:00
//we don't want to show configuration for these
$blacklist = \OC::$server->getAppManager()->getAlwaysEnabledApps();
2013-01-22 01:18:11 +04:00
$appList = array();
foreach ($installedApps as $app) {
if (array_search($app, $blacklist) === false) {
2013-01-22 01:18:11 +04:00
$info = OC_App::getAppInfo($app);
if (!is_array($info)) {
\OCP\Util::writeLog('core', 'Could not read app info file for app "' . $app . '"', \OCP\Util::ERROR);
continue;
}
2013-01-22 01:18:11 +04:00
if (!isset($info['name'])) {
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('core', 'App id "' . $app . '" has no name in appinfo', \OCP\Util::ERROR);
2013-01-22 01:18:11 +04:00
continue;
}
2015-07-03 15:16:29 +03:00
$enabled = \OC::$server->getAppConfig()->getValue($app, 'enabled', 'no');
$info['groups'] = null;
if ($enabled === 'yes') {
2013-01-22 01:18:11 +04:00
$active = true;
2015-02-02 16:47:38 +03:00
} else if ($enabled === 'no') {
2013-01-22 01:18:11 +04:00
$active = false;
} else {
$active = true;
$info['groups'] = $enabled;
2013-01-22 01:18:11 +04:00
}
$info['active'] = $active;
if (self::isShipped($app)) {
$info['internal'] = true;
$info['level'] = self::officialApp;
$info['removable'] = false;
2013-01-22 01:18:11 +04:00
} else {
$info['internal'] = false;
$info['removable'] = true;
2013-01-22 01:18:11 +04:00
}
2016-04-28 16:15:34 +03:00
$info['update'] = ($includeUpdateInfo) ? Installer::isUpdateAvailable($app) : null;
$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;
}
}
}
2013-01-22 01:18:11 +04:00
$info['version'] = OC_App::getAppVersion($app);
$appList[] = $info;
}
}
if ($onlyLocal) {
$remoteApps = [];
} else {
$remoteApps = OC_App::getAppstoreApps('approved', null, $ocsClient);
}
if ($remoteApps) {
2013-01-31 13:27:02 +04:00
// Remove duplicates
foreach ($appList as $app) {
foreach ($remoteApps AS $key => $remote) {
2014-07-10 19:18:10 +04:00
if ($app['name'] === $remote['name'] ||
(isset($app['ocsid']) &&
2015-02-02 16:47:38 +03:00
$app['ocsid'] === $remote['id'])
) {
unset($remoteApps[$key]);
2013-02-09 20:27:57 +04:00
}
2013-01-22 01:18:11 +04:00
}
}
$combinedApps = array_merge($appList, $remoteApps);
2013-02-09 20:27:57 +04:00
} else {
$combinedApps = $appList;
2013-01-22 01:18:11 +04:00
}
2013-10-14 12:54:38 +04:00
2014-07-09 12:20:17 +04:00
return $combinedApps;
2013-10-14 12:54:38 +04: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;
}
/**
* Get a list of all apps on the appstore
* @param string $filter
* @param string|null $category
* @param OCSClient $ocsClient
* @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,
OCSClient $ocsClient) {
$categories = [$category];
if (is_null($category)) {
$categoryNames = $ocsClient->getCategories(\OCP\Util::getVersion());
if (is_array($categoryNames)) {
// Check that categories of apps were retrieved correctly
if (!$categories = array_keys($categoryNames)) {
return false;
}
} else {
return false;
}
}
2012-10-14 23:04:08 +04:00
$page = 0;
$remoteApps = $ocsClient->getApplications($categories, $page, $filter, \OCP\Util::getVersion());
$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';
}
// Apps from the appstore are always assumed to be compatible with the
// the current release as the initial filtering is done on the appstore
$apps[$i]['dependencies']['owncloud']['@attributes']['min-version'] = implode('.', \OCP\Util::getVersion());
$apps[$i]['dependencies']['owncloud']['@attributes']['max-version'] = implode('.', \OCP\Util::getVersion());
$i++;
}
if (empty($apps)) {
return false;
} else {
return $apps;
}
}
2012-03-16 19:00:12 +04:00
public static function shouldUpgrade($app) {
$versions = self::getAppVersions();
$currentVersion = OC_App::getAppVersion($app);
2014-10-30 19:24:25 +03:00
if ($currentVersion && isset($versions[$app])) {
$installedVersion = $versions[$app];
if (version_compare($currentVersion, $installedVersion, '>')) {
return true;
}
}
return false;
}
/**
2014-07-09 12:20:17 +04: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 16:47:38 +03:00
* @param array $appInfo app info (from xml)
*
* @return boolean true if compatible, otherwise false
*/
2015-02-02 16:47:38 +03:00
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;
}
2012-03-30 15:48:44 +04:00
/**
2012-06-29 00:01:46 +04:00
* get the installed version of all apps
2012-03-30 15:48:44 +04:00
*/
2012-09-07 17:22:01 +04:00
public static function getAppVersions() {
2012-06-26 22:53:28 +04:00
static $versions;
2016-01-03 18:53:30 +03:00
if(!$versions) {
$appConfig = \OC::$server->getAppConfig();
$versions = $appConfig->getValues(false, 'installed_version');
2012-03-30 15:48:44 +04:00
}
2016-01-03 18:53:30 +03:00
return $versions;
2012-03-30 15:48:44 +04:00
}
/**
* @param string $app
* @return bool
2014-06-10 15:58:41 +04:00
* @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) {
2014-08-31 12:05:59 +04:00
$l = \OC::$server->getL10N('core');
$config = \OC::$server->getConfig();
$ocsClient = new OCSClient(
\OC::$server->getHTTPClientService(),
$config,
\OC::$server->getLogger()
);
$appData = $ocsClient->getApplication($app, \OCP\Util::getVersion());
// check if app is a shipped app or not. OCS apps have an integer as id, shipped apps use a string
2015-02-02 16:47:38 +03:00
if (!is_numeric($app)) {
$shippedVersion = self::getAppVersion($app);
if ($appData && version_compare($shippedVersion, $appData['version'], '<')) {
$app = self::downloadApp($app);
} else {
2016-04-28 16:15:34 +03:00
$app = Installer::installShippedApp($app);
}
2015-02-02 16:47:38 +03:00
} 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);
}
}
2015-02-02 16:47:38 +03: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 16:47:38 +03:00
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
2014-12-12 14:34:53 +03:00
$dependencyAnalyzer = new DependencyAnalyzer(new Platform($config), $l);
$missing = $dependencyAnalyzer->analyze($info);
2015-02-02 16:47:38 +03:00
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');
2015-02-02 16:47:38 +03:00
if (isset($appData['id'])) {
$config->setAppValue($app, 'ocsid', $appData['id']);
}
\OC_Hook::emit('OC_App', 'post_enable', array('app' => $app));
2015-02-02 16:47:38 +03:00
} else {
throw new \Exception($l->t("No app name specified"));
}
return $app;
}
/**
* update the database for the app and call the update script
*
2014-07-09 12:20:17 +04:00
* @param string $appId
* @return bool
*/
2014-07-09 12:20:17 +04: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 12:56:56 +03:00
self::setupLiveMigrations($appId, $appData['repair-steps']['live-migration']);
2015-02-03 17:23:51 +03:00
unset(self::$appVersion[$appId]);
2015-07-09 13:37:57 +03:00
// run upgrade code
if (file_exists($appPath . '/appinfo/update.php')) {
self::loadApp($appId, false);
include $appPath . '/appinfo/update.php';
}
self::setupBackgroundJobs($appData['background-jobs']);
2012-09-23 04:39:11 +04:00
//set remote/public handlers
2014-07-07 18:57:50 +04:00
if (array_key_exists('ocsid', $appData)) {
2015-07-09 13:37:57 +03: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 18:57:50 +04:00
}
foreach ($appData['remote'] as $name => $path) {
2015-07-09 13:37:57 +03:00
\OC::$server->getConfig()->setAppValue('core', 'remote_' . $name, $appId . '/' . $path);
}
foreach ($appData['public'] as $name => $path) {
2015-07-09 13:37:57 +03:00
\OC::$server->getConfig()->setAppValue('core', 'public_' . $name, $appId . '/' . $path);
}
2014-07-09 12:20:17 +04:00
self::setAppTypes($appId);
$version = \OC_App::getAppVersion($appId);
2015-07-03 15:16:29 +03:00
\OC::$server->getAppConfig()->setValue($appId, 'installed_version', $version);
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, false);
$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 12:56:56 +03: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 12:20:17 +04:00
* @param string $appId
2015-01-16 21:31:15 +03:00
* @return \OC\Files\View|false
*/
2014-07-09 12:20:17 +04:00
public static function getStorage($appId) {
if (OC_App::isEnabled($appId)) { //sanity check
if (OC_User::isLoggedIn()) {
$view = new \OC\Files\View('/' . OC_User::getUser());
2014-07-09 12:20:17 +04:00
if (!$view->file_exists($appId)) {
$view->mkdir($appId);
}
2014-07-09 12:20:17 +04:00
return new \OC\Files\View('/' . OC_User::getUser() . '/' . $appId);
} else {
2015-07-03 15:06:40 +03: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 15:06:40 +03:00
\OCP\Util::writeLog('core', 'Can\'t get app storage, app ' . $appId . ' not enabled', \OCP\Util::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'
2015-02-02 16:47:38 +03:00
if (isset($data['description'])) {
if (is_string($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!mu", $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:]]+!mu', ' ', $value));
}
// join the single paragraphs with a empty line in between
$data['description'] = implode("\n\n", $result);
} else {
$data['description'] = '';
}
}
return $data;
}
}