nextcloud/lib/private/app.php

1240 lines
34 KiB
PHP
Raw Normal View History

<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @copyright 2012 Frank Karlitschek <frank@owncloud.org>
*
* @author Jakob Sack
* @copyright 2012 Jakob Sack <mail@jakobsack.de>
*
* @author Georg Ehrke
* @copyright 2014 Georg Ehrke <georg@ownCloud.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library 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 along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* 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 {
static private $settingsForms = array();
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 $checkedApps = array();
static private $altLogin = array();
/**
2014-07-09 12:20:17 +04:00
* clean the appId
* @param string|boolean $app AppId that needs to be cleaned
* @return string
*/
public static function cleanAppId($app) {
return str_replace(array('\0', '/', '\\', '..'), '', $app);
}
/**
* loads all apps
* @param array $types
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/app.php
* exists.
*
* if $types is set, only apps of those types will be loaded
*/
public static function loadApps($types = null) {
if (OC_Config::getValue('maintenance', false)) {
return false;
}
// Load the enabled apps here
2012-03-30 16:00:24 +04:00
$apps = self::getEnabledApps();
// prevent app.php from printing output
ob_start();
foreach ($apps as $app) {
if ((is_null($types) or self::isType($app, $types)) && !in_array($app, self::$loadedApps)) {
self::$loadedApps[] = $app;
self::loadApp($app);
}
}
ob_end_clean();
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) {
if (is_file(self::getAppPath($app) . '/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);
}
}
/**
* Load app.php from the given app
*
* @param string $app app name
*/
private static function requireAppFile($app) {
// encapsulated here to avoid variable scope conflicts
require_once $app . '/appinfo/app.php';
}
/**
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) {
self::$appTypes = OC_Appconfig::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 (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
2012-09-04 14:32:27 +04:00
OC_Appconfig::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) {
$info = self::getAppInfo($appId);
if (isset($info['shipped']) && $info['shipped'] == 'true') {
return true;
} else {
return false;
}
}
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
*/
public static function getEnabledApps($forceRefresh = false, $all = false) {
if (!OC_Config::getValue('installed', false)) {
return array();
}
// in incognito mode or when logged out, $user will be false,
// which is also the case during an upgrade
$user = null;
if (!$all) {
$user = \OC_User::getUser();
}
if (is_string($user) && !$forceRefresh && !empty(self::$enabledAppsCache)) {
return self::$enabledAppsCache;
}
$apps = array();
$appConfig = \OC::$server->getAppConfig();
$appStatus = $appConfig->getValues(false, 'enabled');
foreach ($appStatus as $app => $enabled) {
2014-04-21 15:38:08 +04:00
if ($app === 'files') {
continue;
}
if ($enabled === 'yes') {
$apps[] = $app;
} else if ($enabled !== 'no') {
$groups = json_decode($enabled);
if (is_array($groups)) {
if (is_string($user)) {
foreach ($groups as $group) {
if (\OC_Group::inGroup($user, $group)) {
$apps[] = $app;
break;
}
}
} else {
// global, consider app as enabled
$apps[] = $app;
}
}
2012-05-03 22:47:18 +04:00
}
2012-03-30 16:00:24 +04:00
}
2014-04-21 15:38:08 +04:00
sort($apps);
array_unshift($apps, 'files');
2014-06-23 17:14:35 +04:00
// Only cache the app list, when the user is logged in.
// Otherwise we cache the list with disabled apps, although
// the apps are enabled for the user after he logged in.
2014-06-23 15:55:21 +04:00
if ($user) {
self::$enabledAppsCache = $apps;
}
2012-03-30 16:00:24 +04:00
return $apps;
}
/**
* checks whether or not an app is enabled
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) {
if ('files' == $app) {
return true;
}
$enabledApps = self::getEnabledApps();
return in_array($app, $enabledApps);
}
/**
* enables an app
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
if (!OC_Installer::isInstalled($app)) {
$app = self::installApp($app);
2011-08-22 16:17:38 +04:00
}
if (!is_null($groups)) {
OC_Appconfig::setValue($app, 'enabled', json_encode($groups));
}else{
OC_Appconfig::setValue($app, 'enabled', 'yes');
}
}
/**
* @param string $app
* @return int
*/
public static function downloadApp($app) {
2014-07-09 12:20:17 +04:00
$appData=OC_OCSClient::getApplication($app);
$download=OC_OCSClient::getApplicationDownload($app, 1);
if(isset($download['downloadlink']) and $download['downloadlink']!='') {
// Replace spaces in download link without encoding entire URL
$download['downloadlink'] = str_replace(' ', '%20', $download['downloadlink']);
2014-07-09 12:20:17 +04:00
$info = array('source'=>'http', 'href'=>$download['downloadlink'], 'appdata'=>$appData);
$app=OC_Installer::installApp($info);
}
return $app;
}
/**
* @param string $app
* @return bool
*/
public static function removeApp($app) {
if (self::isShipped($app)) {
return false;
}
return OC_Installer::removeApp($app);
}
/**
2011-11-09 14:32:06 +04:00
* This function set an app as disabled in appconfig.
2014-06-10 15:51:20 +04:00
* @param string $app app
*/
public static function disable($app) {
self::$enabledAppsCache = array(); // flush
2013-01-31 13:27:02 +04:00
// check if app is a shipped app or not. if not delete
\OC_Hook::emit('OC_App', 'pre_disable', array('app' => $app));
OC_Appconfig::setValue($app, 'enabled', 'no' );
}
/**
* adds an entry to the navigation
* @param array $data array containing the data
2012-09-23 04:39:11 +04:00
* @return bool
*
* This function adds a new entry to the navigation visible to users. $data
* is an associative array.
* The following keys are required:
2011-06-20 21:50:25 +04:00
* - id: unique id for this entry ('addressbook_index')
* - href: link to the page
2011-06-20 21:50:25 +04:00
* - name: Human readable name ('Addressbook')
*
* The following keys are optional:
* - icon: path to the icon of the app
* - order: integer, that influences the position of your application in
* the navigation. Lower values come first.
*/
public static function addNavigationEntry($data) {
OC::$server->getNavigationManager()->add($data);
return true;
}
/**
* marks a navigation entry as active
2012-09-23 04:39:11 +04:00
* @param string $id id of the entry
* @return bool
*
2011-06-20 21:50:25 +04:00
* This function sets a navigation entry as active and removes the 'active'
* property from all other entries. The templates can use this for
* highlighting the current position of the user.
*/
public static function setActiveNavigationEntry($id) {
OC::$server->getNavigationManager()->setActiveEntry($id);
return true;
}
/**
* Get the navigation entries for the $app
* @param string $app app
2014-05-11 21:13:51 +04:00
* @return array an array of the $data added with addNavigationEntry
*
* Warning: destroys the existing entries
*/
public static function getAppNavigationEntries($app) {
if (is_file(self::getAppPath($app) . '/appinfo/app.php')) {
OC::$server->getNavigationManager()->clear();
require $app . '/appinfo/app.php';
return OC::$server->getNavigationManager()->getAll();
}
return array();
}
2011-04-16 19:49:57 +04:00
/**
* gets the active Menu entry
2012-09-23 04:39:11 +04:00
* @return string id or empty string
2011-04-16 19:49:57 +04:00
*
* This function returns the id of the active navigation entry (set by
* setActiveNavigationEntry
*/
2012-09-07 17:22:01 +04:00
public static function getActiveNavigationEntry() {
return OC::$server->getNavigationManager()->getActiveEntry();
2011-04-16 19:49:57 +04:00
}
/**
* Returns the Settings Navigation
* @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');
$settings = array();
// by default, settings only contain the help menu
if (OC_Util::getEditionString() === '' &&
OC_Config::getValue('knowledgebaseenabled', true) == true
) {
$settings = array(
2013-02-11 20:44:02 +04:00
array(
"id" => "help",
"order" => 1000,
"href" => OC_Helper::linkToRoute("settings_help"),
2013-02-11 20:44:02 +04:00
"name" => $l->t("Help"),
"icon" => OC_Helper::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" => OC_Helper::linkToRoute("settings_personal"),
2013-02-11 20:44:02 +04:00
"name" => $l->t("Personal"),
"icon" => OC_Helper::imagePath("settings", "personal.svg")
2013-02-11 20:44:02 +04:00
);
2012-09-23 04:39:11 +04:00
// if there are some settings forms
if (!empty(self::$settingsForms)) {
// settings menu
$settings[] = array(
2013-02-11 20:44:02 +04:00
"id" => "settings",
"order" => 1000,
"href" => OC_Helper::linkToRoute("settings_settings"),
2013-02-11 20:44:02 +04:00
"name" => $l->t("Settings"),
"icon" => OC_Helper::imagePath("settings", "settings.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
if (OC_SubAdmin::isSubAdmin(OC_User::getUser())) {
// admin users menu
2013-02-11 20:44:02 +04:00
$settings[] = array(
"id" => "core_users",
"order" => 2,
"href" => OC_Helper::linkToRoute("settings_users"),
2013-02-11 20:44:02 +04:00
"name" => $l->t("Users"),
"icon" => OC_Helper::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" => OC_Helper::linkToRoute("settings_admin"),
2013-02-11 20:44:02 +04:00
"name" => $l->t("Admin"),
"icon" => OC_Helper::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
*
* @return string
2012-07-24 02:39:59 +04:00
*/
public static function getInstallPath() {
if (OC_Config::getValue('appstoreenabled', true) == false) {
return false;
}
foreach (OC::$APPSROOTS as $dir) {
if (isset($dir['writable']) && $dir['writable'] === true) {
return $dir['path'];
}
}
2012-09-04 14:32:27 +04:00
OC_Log::write('core', 'No application directories are marked as writable.', OC_Log::ERROR);
return null;
}
/**
* search for an app in all app-directories
* @param $appId
* @return mixed (bool|string)
*/
protected static function findAppInDirectories($appId) {
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();
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
}
}
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
}
/**
* get the last version of the app, either from appinfo/version or 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) {
$file = self::getAppPath($appId);
2014-06-06 11:41:33 +04:00
return ($file !== false) ? self::getAppVersionByPath($file) : '0';
}
/**
* get app's version based on it's path
* @param string $path
* @return string
*/
public static function getAppVersionByPath($path) {
$versionFile = $path . '/appinfo/version';
$infoFile = $path . '/appinfo/info.xml';
if(is_file($versionFile)) {
return trim(file_get_contents($versionFile));
}else{
$appData = self::getAppInfo($infoFile, true);
return isset($appData['version']) ? $appData['version'] : '';
}
}
/**
* Read all app metadata from the info.xml file
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];
}
2014-07-09 12:20:17 +04:00
$file = self::getAppPath($appId) . '/appinfo/info.xml';
}
$data = array();
if (!file_exists($file)) {
return null;
}
$content = @file_get_contents($file);
if (!$content) {
2012-09-23 04:39:11 +04:00
return null;
2012-03-30 15:48:44 +04:00
}
$xml = new SimpleXMLElement($content);
$data['info'] = array();
$data['remote'] = array();
$data['public'] = array();
foreach ($xml->children() as $child) {
2012-09-23 04:39:11 +04:00
/**
* @var $child SimpleXMLElement
*/
if ($child->getName() == 'remote') {
foreach ($child->children() as $remote) {
2012-09-23 04:39:11 +04:00
/**
* @var $remote SimpleXMLElement
*/
$data['remote'][$remote->getName()] = (string)$remote;
}
} elseif ($child->getName() == 'public') {
foreach ($child->children() as $public) {
2012-09-23 04:39:11 +04:00
/**
* @var $public SimpleXMLElement
*/
$data['public'][$public->getName()] = (string)$public;
}
} elseif ($child->getName() == 'types') {
$data['types'] = array();
foreach ($child->children() as $type) {
2012-09-23 04:39:11 +04:00
/**
* @var $type SimpleXMLElement
*/
$data['types'][] = $type->getName();
}
} elseif ($child->getName() == 'description') {
$xml = (string)$child->asXML();
$data[$child->getName()] = substr($xml, 13, -14); //script <description> tags
} elseif ($child->getName() == 'documentation') {
2014-07-09 12:20:17 +04:00
foreach ($child as $subChild) {
$url = (string) $subChild;
// 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(!\OC::$server->getHTTPHelper()->isHTTPURL($url)) {
$url = OC_Helper::linkToDocs($url);
}
$data["documentation"][$subChild->getName()] = $url;
2014-01-17 17:05:39 +04:00
}
} else {
$data[$child->getName()] = (string)$child;
}
}
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
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() {
$script = substr(OC_Request::scriptName(), strlen(OC::$WEBROOT) + 1);
$topFolder = substr($script, 0, strpos($script, '/'));
if (empty($topFolder)) {
$path_info = OC_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;
}
}
/**
* get the forms for either settings, admin or personal
*/
2012-09-07 17:22:01 +04:00
public static function getForms($type) {
$forms = array();
switch ($type) {
case 'settings':
$source = self::$settingsForms;
2013-02-09 20:27:57 +04:00
break;
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 a settings form to be shown
*/
2012-11-02 22:53:02 +04:00
public static function registerSettings($app, $page) {
self::$settingsForms[] = $app . '/' . $page . '.php';
}
/**
* 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
*/
2012-11-02 22:53:02 +04:00
public static function registerPersonal($app, $page) {
self::$personalForms[] = $app . '/' . $page . '.php';
}
public static function registerLogIn($entry) {
self::$altLogin[] = $entry;
}
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
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'])) {
OC_Log::write('core', 'unable to read app folder : ' . $apps_dir['path'], OC_Log::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_file($apps_dir['path'] . '/' . $file . '/appinfo/app.php')) {
2012-10-14 23:04:08 +04:00
$apps[] = $file;
2012-10-14 23:04:08 +04:00
}
2012-10-14 23:04:08 +04:00
}
2011-08-10 14:20:43 +04:00
}
2012-10-14 23:04:08 +04:00
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
/**
* Lists all apps, this is used in apps.php
2013-01-22 01:18:11 +04:00
* @return array
*/
public static function listAllApps($onlyLocal = false) {
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
2014-07-09 12:20:17 +04:00
$blacklist = array('files'); //we don't want to show configuration for these
2013-01-22 01:18:11 +04:00
$appList = array();
$l = \OC::$server->getL10N('core');
2013-01-22 01:18:11 +04:00
foreach ($installedApps as $app) {
if (array_search($app, $blacklist) === false) {
2013-01-22 01:18:11 +04:00
$info = OC_App::getAppInfo($app);
2013-01-22 01:18:11 +04:00
if (!isset($info['name'])) {
OC_Log::write('core', 'App id "' . $app . '" has no name in appinfo', OC_Log::ERROR);
2013-01-22 01:18:11 +04:00
continue;
}
$enabled = OC_Appconfig::getValue($app, 'enabled', 'no');
$info['groups'] = null;
if ($enabled === 'yes') {
2013-01-22 01:18:11 +04:00
$active = true;
} 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(isset($info['shipped']) and ($info['shipped'] == 'true')) {
$info['internal'] = true;
$info['internallabel'] = $l->t('Recommended');
$info['internalclass'] = 'recommendedapp';
$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
}
$info['update'] = OC_Installer::isUpdateAvailable($app);
$appIcon = self::getAppPath($app) . '/img/' . $app.'.svg';
if (file_exists($appIcon)) {
$info['preview'] = OC_Helper::imagePath($app, $app.'.svg');
$info['previewAsIcon'] = true;
} else {
$appIcon = self::getAppPath($app) . '/img/app.svg';
if (file_exists($appIcon)) {
$info['preview'] = OC_Helper::imagePath($app, 'app.svg');
$info['previewAsIcon'] = true;
}
}
2013-01-22 01:18:11 +04:00
$info['version'] = OC_App::getAppVersion($app);
$appList[] = $info;
}
}
if ($onlyLocal) {
$remoteApps = array();
} else {
$remoteApps = OC_App::getAppstoreApps();
}
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']) &&
$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
}
2014-07-09 12:20:17 +04:00
// bring the apps into the right order with a custom sort function
usort($combinedApps, function ($a, $b) {
2013-10-14 12:54:38 +04:00
2014-07-09 12:20:17 +04:00
// priority 1: active
if ($a['active'] != $b['active']) {
return $b['active'] - $a['active'];
}
2013-10-14 12:54:38 +04:00
2014-07-09 12:20:17 +04:00
// priority 2: shipped
$aShipped = (array_key_exists('shipped', $a) && $a['shipped'] === 'true') ? 1 : 0;
$bShipped = (array_key_exists('shipped', $b) && $b['shipped'] === 'true') ? 1 : 0;
if ($aShipped !== $bShipped) {
return ($bShipped - $aShipped);
}
2013-10-14 12:54:38 +04:00
2014-07-09 12:20:17 +04:00
// priority 3: recommended
$internalClassA = isset($a['internalclass']) ? $a['internalclass'] : '';
$internalClassB = isset($b['internalclass']) ? $b['internalclass'] : '';
if ($internalClassA != $internalClassB) {
$aTemp = ($internalClassA == 'recommendedapp' ? 1 : 0);
$bTemp = ($internalClassB == 'recommendedapp' ? 1 : 0);
2014-07-09 12:20:17 +04:00
return ($bTemp - $aTemp);
}
2013-10-17 13:35:13 +04:00
2014-07-09 12:20:17 +04:00
// priority 4: alphabetical
return strcasecmp($a['name'], $b['name']);
2013-10-14 12:54:38 +04:00
2014-07-09 12:20:17 +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
}
/**
* get a list of all apps on apps.owncloud.com
2013-02-11 20:44:02 +04:00
* @return array, multi-dimensional array of apps.
* Keys: id, name, type, typename, personid, license, detailpage, preview, changed, description
*/
public static function getAppstoreApps($filter = 'approved', $category = null) {
$categories = array($category);
if (is_null($category)) {
$categoryNames = OC_OCSClient::getCategories();
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 = OC_OCSClient::getApplications($categories, $page, $filter);
$app1 = array();
$i = 0;
$l = \OC::$server->getL10N('core');
foreach ($remoteApps as $app) {
$app1[$i] = $app;
$app1[$i]['author'] = $app['personid'];
$app1[$i]['ocs_id'] = $app['id'];
$app1[$i]['internal'] = $app1[$i]['active'] = 0;
$app1[$i]['update'] = false;
$app1[$i]['groups'] = false;
$app1[$i]['score'] = $app['score'];
$app1[$i]['removable'] = false;
if ($app['label'] == 'recommended') {
$app1[$i]['internallabel'] = $l->t('Recommended');
$app1[$i]['internalclass'] = 'recommendedapp';
}
$i++;
}
if (empty($app1)) {
return false;
} else {
return $app1;
}
}
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;
}
/**
* check if the current enabled apps are compatible with the current
* ownCloud version. disable them if not.
* This is important if you upgrade ownCloud and have non ported 3rd
* party apps installed.
*
* @param array $apps optional app id list to check, uses all enabled apps
* when not specified
*
* @return array containing the list of ids of the disabled apps
*/
2012-09-07 17:22:01 +04:00
public static function checkAppsRequirements($apps = array()) {
$disabledApps = array();
if (empty($apps)) {
$apps = OC_App::getEnabledApps();
}
$version = OC_Util::getVersion();
foreach ($apps as $app) {
// check if the app is compatible with this version of ownCloud
2012-10-14 23:04:08 +04:00
$info = OC_App::getAppInfo($app);
if(!self::isAppCompatible($version, $info)) {
2013-02-11 20:44:02 +04:00
OC_Log::write('core',
'App "' . $info['name'] . '" (' . $app . ') can\'t be used because it is'
. ' not compatible with this version of ownCloud',
2013-02-11 20:44:02 +04:00
OC_Log::ERROR);
OC_App::disable($app);
OC_Hook::emit('update', 'success', 'Disabled ' . $info['name'] . ' app because it is not compatible');
$disabledApps[] = $app;
}
}
return $disabledApps;
}
2012-03-16 19:00:12 +04:00
/**
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
* @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['requiremin'])) {
$requireMin = $appInfo['requiremin'];
} else if (isset($appInfo['require'])) {
$requireMin = $appInfo['require'];
}
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;
if (isset($versions)) { // simple cache, needs to be fixed
2012-06-26 22:53:28 +04:00
return $versions; // when function is used besides in checkUpgrade
}
$versions = array();
try {
$query = OC_DB::prepare('SELECT `appid`, `configvalue` FROM `*PREFIX*appconfig`'
. ' WHERE `configkey` = \'installed_version\'');
$result = $query->execute();
while ($row = $result->fetchRow()) {
$versions[$row['appid']] = $row['configvalue'];
}
return $versions;
} catch (\Exception $e) {
return array();
2012-03-30 15:48:44 +04:00
}
}
/**
* @param mixed $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');
2014-07-09 12:20:17 +04:00
$appData=OC_OCSClient::getApplication($app);
// check if app is a shipped app or not. OCS apps have an integer as id, shipped apps use a string
if(!is_numeric($app)) {
$shippedVersion=self::getAppVersion($app);
2014-07-09 12:20:17 +04:00
if($appData && version_compare($shippedVersion, $appData['version'], '<')) {
$app = self::downloadApp($app);
} else {
$app = OC_Installer::installShippedApp($app);
}
}else{
$app = self::downloadApp($app);
}
if($app!==false) {
// check if the app is compatible with this version of ownCloud
$info = self::getAppInfo($app);
$version=OC_Util::getVersion();
if(!self::isAppCompatible($version, $info)) {
throw new \Exception(
$l->t('App \"%s\" can\'t be installed because it is not compatible with this version of ownCloud.',
array($info['name'])
)
);
}else{
OC_Appconfig::setValue( $app, 'enabled', 'yes' );
2014-07-09 12:20:17 +04:00
if(isset($appData['id'])) {
OC_Appconfig::setValue( $app, 'ocsid', $appData['id'] );
}
\OC_Hook::emit('OC_App', 'post_enable', array('app' => $app));
}
}else{
throw new \Exception($l->t("No app name specified"));
}
return $app;
}
/**
* update the database for the app and call the update script
*
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) {
if (file_exists(self::getAppPath($appId) . '/appinfo/preupdate.php')) {
self::loadApp($appId, false);
2014-07-09 12:20:17 +04:00
include self::getAppPath($appId) . '/appinfo/preupdate.php';
}
2014-07-09 12:20:17 +04:00
if (file_exists(self::getAppPath($appId) . '/appinfo/database.xml')) {
OC_DB::updateDbFromStructure(self::getAppPath($appId) . '/appinfo/database.xml');
}
2014-07-09 12:20:17 +04:00
if (!self::isEnabled($appId)) {
return false;
}
2014-07-09 12:20:17 +04:00
if (file_exists(self::getAppPath($appId) . '/appinfo/update.php')) {
self::loadApp($appId, false);
2014-07-09 12:20:17 +04:00
include self::getAppPath($appId) . '/appinfo/update.php';
}
2012-09-23 04:39:11 +04:00
//set remote/public handlers
2014-07-09 12:20:17 +04:00
$appData = self::getAppInfo($appId);
2014-07-07 18:57:50 +04:00
if (array_key_exists('ocsid', $appData)) {
2014-07-09 12:20:17 +04:00
OC_Appconfig::setValue($appId, 'ocsid', $appData['ocsid']);
2014-07-07 18:57:50 +04:00
}
foreach ($appData['remote'] as $name => $path) {
2014-07-09 12:20:17 +04:00
OCP\CONFIG::setAppValue('core', 'remote_' . $name, $appId . '/' . $path);
}
foreach ($appData['public'] as $name => $path) {
2014-07-09 12:20:17 +04:00
OCP\CONFIG::setAppValue('core', 'public_' . $name, $appId . '/' . $path);
}
2014-07-09 12:20:17 +04:00
self::setAppTypes($appId);
$version = \OC_App::getAppVersion($appId);
\OC_Appconfig::setValue($appId, 'installed_version', $version);
return true;
}
/**
2014-07-09 12:20:17 +04:00
* @param string $appId
* @return \OC\Files\View
*/
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 {
2014-07-09 12:20:17 +04:00
OC_Log::write('core', 'Can\'t get app storage, app ' . $appId . ', user not logged in', OC_Log::ERROR);
return false;
}
} else {
2014-07-09 12:20:17 +04:00
OC_Log::write('core', 'Can\'t get app storage, app ' . $appId . ' not enabled', OC_Log::ERROR);
return false;
}
}
}