nextcloud/lib/private/app.php

1020 lines
29 KiB
PHP
Raw Normal View History

<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @author Jakob Sack
* @copyright 2012 Frank Karlitschek frank@owncloud.org
*
* 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
* owncloud ecosystem. Furthermore, this class is responsible for installing,
* upgrading and removing apps.
*/
2011-07-29 23:36:03 +04:00
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();
/**
* @brief 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);
}
/**
* @brief loads all apps
* @param array $types
2012-09-23 04:39:11 +04:00
* @return bool
*
* This function walks through the owncloud directory and loads all apps
* it can find. A directory contains an app if the file /appinfo/app.php
* exists.
*
* if $types is set, only apps of those types will be loaded
*/
2012-09-07 17:22:01 +04:00
public static function loadApps($types=null) {
// Load the enabled apps here
2012-03-30 16:00:24 +04:00
$apps = self::getEnabledApps();
// prevent app.php from printing output
ob_start();
2012-09-07 17:22:01 +04:00
foreach( $apps as $app ) {
2012-09-04 14:32:27 +04:00
if((is_null($types) or self::isType($app, $types)) && !in_array($app, self::$loadedApps)) {
self::$loadedApps[] = $app;
self::loadApp($app);
}
}
ob_end_clean();
2012-09-04 14:32:27 +04:00
if (!defined('DEBUG') || !DEBUG) {
if (is_null($types)
&& empty(OC_Util::$coreScripts)
&& empty(OC_Util::$coreStyles)) {
OC_Util::$coreScripts = OC_Util::$scripts;
2013-02-09 20:27:57 +04:00
OC_Util::$scripts = array();
OC_Util::$coreStyles = OC_Util::$styles;
2013-02-09 20:27:57 +04:00
OC_Util::$styles = array();
}
}
2013-01-22 01:17:48 +04:00
// return
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
*/
2012-09-04 14:32:27 +04:00
public static function loadApp($app) {
2012-09-04 16:21:52 +04:00
if(is_file(self::getAppPath($app).'/appinfo/app.php')) {
self::checkUpgrade($app);
2012-09-04 14:32:27 +04:00
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
* @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) {
2012-09-04 14:32:27 +04:00
if(is_string($types)) {
$types=array($types);
}
2012-04-14 19:53:02 +04:00
$appTypes=self::getAppTypes($app);
2012-09-07 17:22:01 +04:00
foreach($types as $type) {
2012-09-04 14:32:27 +04:00
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
* @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
2012-09-04 14:32:27 +04:00
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
2012-09-04 14:32:27 +04:00
if(isset(self::$appTypes[$app])) {
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);
2012-09-04 14:32:27 +04:00
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
* @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.
*/
2012-07-30 23:03:41 +04:00
public static function isShipped($appid){
$info = self::getAppInfo($appid);
2013-02-09 19:46:55 +04:00
if(isset($info['shipped']) && $info['shipped']=='true') {
return true;
} else {
return false;
}
}
2012-03-30 16:00:24 +04:00
/**
* get all enabled apps
*/
private static $enabledAppsCache = array();
public static function getEnabledApps($forceRefresh = false) {
if(!OC_Config::getValue('installed', false)) {
return array();
}
if(!$forceRefresh && !empty(self::$enabledAppsCache)) {
return self::$enabledAppsCache;
}
2012-05-03 22:47:18 +04:00
$apps=array('files');
$sql = 'SELECT `appid` FROM `*PREFIX*appconfig`'
. ' WHERE `configkey` = \'enabled\' AND `configvalue`=\'yes\''
. ' ORDER BY `appid`';
if (OC_Config::getValue( 'dbtype', 'sqlite' ) === 'oci') {
//FIXME oracle hack: need to explicitly cast CLOB to CHAR for comparison
$sql = 'SELECT `appid` FROM `*PREFIX*appconfig`'
. ' WHERE `configkey` = \'enabled\' AND to_char(`configvalue`)=\'yes\''
. ' ORDER BY `appid`';
}
$query = OC_DB::prepare( $sql );
$result=$query->execute();
2013-04-29 14:25:27 +04:00
if( \OC_DB::isError($result)) {
throw new DatabaseException($result->getMessage(), $query);
}
2012-09-07 17:22:01 +04:00
while($row=$result->fetchRow()) {
2012-09-04 14:32:27 +04:00
if(array_search($row['appid'], $apps)===false) {
2012-05-03 22:47:18 +04:00
$apps[]=$row['appid'];
}
2012-03-30 16:00:24 +04:00
}
self::$enabledAppsCache = $apps;
2012-03-30 16:00:24 +04:00
return $apps;
}
/**
* @brief 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.
*/
2012-09-07 17:22:01 +04:00
public static function isEnabled( $app ) {
if('files' == $app) {
return true;
}
$enabledApps = self::getEnabledApps();
return in_array($app, $enabledApps);
}
/**
* @brief enables an app
2012-09-23 04:39:11 +04:00
* @param mixed $app app
* @throws \Exception
* @return void
*
* This function set an app as enabled in appconfig.
*/
2012-09-07 17:22:01 +04:00
public static function enable( $app ) {
self::$enabledAppsCache = array(); // flush
2012-09-04 14:32:27 +04:00
if(!OC_Installer::isInstalled($app)) {
// check if app is a shipped app or not. OCS apps have an integer as id, shipped apps use a string
2012-09-04 14:32:27 +04:00
if(!is_numeric($app)) {
$app = OC_Installer::installShippedApp($app);
}else{
$appdata=OC_OCSClient::getApplication($app);
2012-09-04 14:32:27 +04:00
$download=OC_OCSClient::getApplicationDownload($app, 1);
if(isset($download['downloadlink']) and $download['downloadlink']!='') {
2013-02-11 20:44:02 +04:00
$info = array('source'=>'http', 'href'=>$download['downloadlink'], 'appdata'=>$appdata);
$app=OC_Installer::installApp($info);
}
}
2011-08-22 16:17:38 +04:00
}
$l = OC_L10N::get('core');
2012-09-04 14:32:27 +04:00
if($app!==false) {
// check if the app is compatible with this version of ownCloud
$info=OC_App::getAppInfo($app);
$version=OC_Util::getVersion();
if(!isset($info['require']) or !self::isAppVersionCompatible($version, $info['require'])) {
2013-08-09 20:01:49 +04:00
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' );
2013-01-31 13:27:02 +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"));
}
}
/**
2011-11-09 14:32:06 +04:00
* @brief disables an app
2012-09-23 04:39:11 +04:00
* @param string $app app
* @return boolean|null
*
2011-11-09 14:32:06 +04:00
* This function set an app as disabled in appconfig.
*/
2012-09-07 17:22:01 +04:00
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));
2011-07-29 23:36:03 +04:00
OC_Appconfig::setValue( $app, 'enabled', 'no' );
2013-01-31 13:27:02 +04:00
// check if app is a shipped app or not. if not delete
2013-02-09 19:46:55 +04:00
if(!OC_App::isShipped( $app )) {
OC_Installer::removeApp( $app );
2013-01-31 13:27:02 +04:00
}
}
/**
* @brief 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.
*/
2012-09-07 17:22:01 +04:00
public static function addNavigationEntry( $data ) {
OC::$server->getNavigationManager()->add($data);
return true;
}
/**
* @brief 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.
*/
2012-09-07 17:22:01 +04:00
public static function setActiveNavigationEntry( $id ) {
OC::$server->getNavigationManager()->setActiveEntry($id);
return true;
}
/**
* @brief Get the navigation entries for the $app
* @param string $app app
* @return 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
/**
* @brief 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
}
/**
2011-04-17 21:38:04 +04:00
* @brief 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() {
2012-08-31 01:51:44 +04:00
$l=OC_L10N::get('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" ),
"name" => $l->t("Help"),
"icon" => OC_Helper::imagePath( "settings", "help.svg" )
)
);
}
// 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" ),
"name" => $l->t("Personal"),
"icon" => OC_Helper::imagePath( "settings", "personal.svg" )
);
2012-09-23 04:39:11 +04:00
// if there are some settings forms
if(!empty(self::$settingsForms)) {
// settings menu
2013-02-11 20:44:02 +04:00
$settings[]=array(
"id" => "settings",
"order" => 1000,
"href" => OC_Helper::linkToRoute( "settings_settings" ),
"name" => $l->t("Settings"),
"icon" => OC_Helper::imagePath( "settings", "settings.svg" )
);
}
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" ),
"name" => $l->t("Users"),
"icon" => OC_Helper::imagePath( "settings", "users.svg" )
);
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
2013-02-11 20:44:02 +04:00
$settings[]=array(
"id" => "admin",
"order" => 1000,
"href" => OC_Helper::linkToRoute( "settings_admin" ),
"name" => $l->t("Admin"),
"icon" => OC_Helper::imagePath( "settings", "admin.svg" )
);
}
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
2012-09-07 17:22:01 +04:00
private static function proceedNavigation( $list ) {
$activeapp = OC::$server->getNavigationManager()->getActiveEntry();
2012-09-07 17:22:01 +04:00
foreach( $list as &$naventry ) {
if( $naventry['id'] == $activeapp ) {
2011-06-20 21:50:25 +04:00
$naventry['active'] = true;
2011-04-16 12:26:18 +04:00
}
2011-04-17 21:38:04 +04:00
else{
2011-06-20 21:50:25 +04:00
$naventry['active'] = false;
2011-04-17 21:38:04 +04:00
}
2011-06-20 21:50:25 +04:00
} unset( $naventry );
2011-04-16 12:26:18 +04:00
2012-09-07 17:22:01 +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;
}
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];
}
foreach(OC::$APPSROOTS as $dir) {
if(file_exists($dir['path'].'/'.$appid)) {
2012-06-28 23:54:33 +04:00
return $app_dir[$appid]=$dir;
}
}
2012-09-23 04:39:11 +04:00
return false;
}
2012-06-02 02:05:20 +04:00
/**
* Get the directory for the given app.
2013-07-16 07:56:52 +04:00
* If the app is defined in multiple directories, the first one is taken. (false if not found)
2012-06-02 02:05:20 +04:00
*/
public static function getAppPath($appid) {
if( ($dir = self::findAppInDirectories($appid)) != false) {
return $dir['path'].'/'.$appid;
}
2012-09-23 04:39:11 +04:00
return false;
}
/**
* Get the path for the given app on the access
2013-07-16 07:56:52 +04:00
* If the app is defined in multiple directories, the first one is taken. (false if not found)
*/
public static function getAppWebPath($appid) {
if( ($dir = self::findAppInDirectories($appid)) != false) {
2012-06-22 11:56:54 +04:00
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
* @return string
*/
2012-09-07 17:22:01 +04:00
public static function getAppVersion($appid) {
2012-06-02 02:05:20 +04:00
$file= self::getAppPath($appid).'/appinfo/version';
if(is_file($file) && $version = trim(file_get_contents($file))) {
return $version;
}else{
$appData=self::getAppInfo($appid);
return isset($appData['version'])? $appData['version'] : '';
}
}
/**
* @brief Read all app metadata from the info.xml file
* @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)
* @return array
* @note all data is read from info.xml, not just pre-defined fields
*/
2012-11-02 22:53:02 +04:00
public static function getAppInfo($appid, $path=false) {
2012-09-04 14:32:27 +04:00
if($path) {
$file=$appid;
}else{
2012-09-04 14:32:27 +04:00
if(isset(self::$appInfo[$appid])) {
return self::$appInfo[$appid];
}
2012-06-02 02:05:20 +04:00
$file= self::getAppPath($appid).'/appinfo/info.xml';
}
$data=array();
$content=@file_get_contents($file);
2012-09-04 14:32:27 +04:00
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();
2012-09-07 17:22:01 +04:00
foreach($xml->children() as $child) {
2012-09-23 04:39:11 +04:00
/**
* @var $child SimpleXMLElement
*/
2012-09-04 14:32:27 +04:00
if($child->getName()=='remote') {
2012-09-07 17:22:01 +04:00
foreach($child->children() as $remote) {
2012-09-23 04:39:11 +04:00
/**
* @var $remote SimpleXMLElement
*/
$data['remote'][$remote->getName()]=(string)$remote;
}
2012-09-04 14:32:27 +04:00
}elseif($child->getName()=='public') {
2012-09-07 17:22:01 +04:00
foreach($child->children() as $public) {
2012-09-23 04:39:11 +04:00
/**
* @var $public SimpleXMLElement
*/
$data['public'][$public->getName()]=(string)$public;
}
2012-09-04 14:32:27 +04:00
}elseif($child->getName()=='types') {
$data['types']=array();
2012-09-07 17:22:01 +04:00
foreach($child->children() as $type) {
2012-09-23 04:39:11 +04:00
/**
* @var $type SimpleXMLElement
*/
$data['types'][]=$type->getName();
}
2012-09-04 14:32:27 +04:00
}elseif($child->getName()=='description') {
2012-08-31 00:17:54 +04:00
$xml=(string)$child->asXML();
2012-09-04 14:32:27 +04:00
$data[$child->getName()]=substr($xml, 13, -14);//script <description> tags
2014-01-17 17:05:39 +04:00
}elseif($child->getName()=='documentation') {
foreach($child as $subchild) {
$data["documentation"][$subchild->getName()] = (string)$subchild;
}
}else{
$data[$child->getName()]=(string)$child;
}
}
self::$appInfo[$appid]=$data;
2012-10-14 23:04:08 +04:00
return $data;
}
/**
* @brief Returns the navigation
* @return string
*
* 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);
2012-09-04 14:32:27 +04:00
$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);
}
}
2012-09-04 14:32:27 +04:00
if($topFolder=='apps') {
$length=strlen($topFolder);
2012-09-04 14:32:27 +04:00
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();
2012-09-07 17:22:01 +04:00
switch($type) {
case 'settings':
2013-02-09 20:27:57 +04:00
$source=self::$settingsForms;
break;
case 'admin':
2013-02-09 20:27:57 +04:00
$source=self::$adminForms;
break;
case 'personal':
2013-02-09 20:27:57 +04:00
$source=self::$personalForms;
break;
2012-09-23 04:39:11 +04:00
default:
2013-02-09 20:27:57 +04:00
return array();
}
2012-09-07 17:22:01 +04:00
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
/**
* @brief: get a list of all apps in the apps folder
* @return array or 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
2011-08-10 14:20:43 +04:00
$apps=array();
2012-10-14 23:04:08 +04:00
foreach ( OC::$APPSROOTS as $apps_dir ) {
2012-09-19 23:26:57 +04:00
if(! is_readable($apps_dir['path'])) {
2012-10-23 10:35:54 +04:00
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
/**
* @brief: Lists all apps, this is used in apps.php
* @return array
*/
public static function listAllApps() {
$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
$blacklist = array('files');//we dont want to show configuration for these
$appList = array();
foreach ( $installedApps as $app ) {
if ( array_search( $app, $blacklist ) === false ) {
$info=OC_App::getAppInfo($app);
if (!isset($info['name'])) {
OC_Log::write('core', 'App id "'.$app.'" has no name in appinfo', OC_Log::ERROR);
continue;
}
if ( OC_Appconfig::getValue( $app, 'enabled', 'no') == 'yes' ) {
$active = true;
} else {
$active = false;
}
$info['active'] = $active;
if(isset($info['shipped']) and ($info['shipped']=='true')) {
$info['internal']=true;
$info['internallabel']='Internal App';
$info['internalclass']='';
$info['update']=false;
2013-01-22 01:18:11 +04:00
} else {
$info['internal']=false;
$info['internallabel']='3rd Party';
$info['internalclass']='externalapp';
$info['update']=OC_Installer::isUpdateAvailable($app);
2013-01-22 01:18:11 +04:00
}
$info['preview'] = OC_Helper::imagePath('settings', 'trans.png');
$info['version'] = OC_App::getAppVersion($app);
$appList[] = $info;
}
}
$remoteApps = OC_App::getAppstoreApps();
if ( $remoteApps ) {
2013-01-31 13:27:02 +04:00
// Remove duplicates
2013-01-22 01:18:11 +04:00
foreach ( $appList as $app ) {
foreach ( $remoteApps AS $key => $remote ) {
if (
$app['name'] == $remote['name']
2013-01-31 13:27:02 +04:00
// To set duplicate detection to use OCS ID instead of string name,
// enable this code, remove the line of code above,
// and add <ocs_id>[ID]</ocs_id> to info.xml of each 3rd party app:
// OR $app['ocs_id'] == $remote['ocs_id']
2013-01-22 01:18:11 +04:00
) {
unset( $remoteApps[$key]);
2013-02-09 20:27:57 +04:00
}
2013-01-22 01:18:11 +04:00
}
}
2013-02-09 20:27:57 +04:00
$combinedApps = array_merge( $appList, $remoteApps );
} else {
$combinedApps = $appList;
2013-01-22 01:18:11 +04:00
}
2013-10-14 12:54:38 +04:00
// bring the apps into the right order with a custom sort funtion
2013-10-14 12:57:00 +04:00
usort( $combinedApps, '\OC_App::customSort' );
2013-10-14 12:54:38 +04:00
2013-02-09 20:27:57 +04:00
return $combinedApps;
}
2013-01-22 01:18:11 +04:00
2013-10-14 12:54:38 +04:00
/**
* @brief: Internal custom sort funtion to bring the app into the right order. Should only be called by listAllApps
* @return array
*/
private static function customSort($a, $b) {
// prio 1: active
if ($a['active'] != $b['active']) {
return $b['active'] - $a['active'];
}
// prio 2: shipped
2013-10-17 13:35:13 +04:00
$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
}
2013-10-17 13:35:13 +04:00
2013-10-14 12:54:38 +04:00
// prio 3: recommended
if ($a['internalclass'] != $b['internalclass']) {
2013-10-14 12:57:00 +04:00
$atemp = ($a['internalclass'] == 'recommendedapp' ? 1 : 0);
$btemp = ($b['internalclass'] == 'recommendedapp' ? 1 : 0);
2013-10-14 12:54:38 +04:00
return ($btemp - $atemp);
}
// prio 4: alphabetical
2013-10-14 13:15:04 +04:00
return strcasecmp($a['name'], $b['name']);
2013-10-14 12:54:38 +04:00
}
/**
* @brief: 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' ) {
2013-02-10 02:37:42 +04:00
$categoryNames = OC_OCSClient::getCategories();
if ( is_array( $categoryNames ) ) {
// Check that categories of apps were retrieved correctly
2013-02-10 02:37:42 +04:00
if ( ! $categories = array_keys( $categoryNames ) ) {
return false;
}
2012-10-14 23:04:08 +04:00
$page = 0;
$remoteApps = OC_OCSClient::getApplications( $categories, $page, $filter );
$app1 = array();
$i = 0;
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;
2013-02-09 19:46:55 +04:00
if($app['label']=='recommended') {
$app1[$i]['internallabel'] = 'Recommended';
$app1[$i]['internalclass'] = 'recommendedapp';
}else{
$app1[$i]['internallabel'] = '3rd Party';
$app1[$i]['internalclass'] = 'externalapp';
}
// rating img
2012-12-15 02:16:32 +04:00
if($app['score']>=0 and $app['score']<5) $img=OC_Helper::imagePath( "core", "rating/s1.png" );
elseif($app['score']>=5 and $app['score']<15) $img=OC_Helper::imagePath( "core", "rating/s2.png" );
elseif($app['score']>=15 and $app['score']<25) $img=OC_Helper::imagePath( "core", "rating/s3.png" );
elseif($app['score']>=25 and $app['score']<35) $img=OC_Helper::imagePath( "core", "rating/s4.png" );
elseif($app['score']>=35 and $app['score']<45) $img=OC_Helper::imagePath( "core", "rating/s5.png" );
elseif($app['score']>=45 and $app['score']<55) $img=OC_Helper::imagePath( "core", "rating/s6.png" );
elseif($app['score']>=55 and $app['score']<65) $img=OC_Helper::imagePath( "core", "rating/s7.png" );
elseif($app['score']>=65 and $app['score']<75) $img=OC_Helper::imagePath( "core", "rating/s8.png" );
elseif($app['score']>=75 and $app['score']<85) $img=OC_Helper::imagePath( "core", "rating/s9.png" );
elseif($app['score']>=85 and $app['score']<95) $img=OC_Helper::imagePath( "core", "rating/s10.png" );
elseif($app['score']>=95 and $app['score']<100) $img=OC_Helper::imagePath( "core", "rating/s11.png" );
$app1[$i]['score'] = '<img src="'.$img.'"> Score: '.$app['score'].'%';
$i++;
}
}
if ( empty( $app1 ) ) {
return false;
} else {
return $app1;
}
}
2012-03-16 19:00:12 +04:00
/**
2013-07-16 07:56:52 +04:00
* check if the app needs updating and update when needed
* @param string $app
*/
public static function checkUpgrade($app) {
if (in_array($app, self::$checkedApps)) {
return;
}
self::$checkedApps[] = $app;
2012-03-30 15:48:44 +04:00
$versions = self::getAppVersions();
$currentVersion=OC_App::getAppVersion($app);
if ($currentVersion) {
$installedVersion = $versions[$app];
if (version_compare($currentVersion, $installedVersion, '>')) {
$info = self::getAppInfo($app);
2013-02-11 20:44:02 +04:00
OC_Log::write($app,
'starting app upgrade from '.$installedVersion.' to '.$currentVersion,
OC_Log::DEBUG);
2012-09-22 01:32:52 +04:00
try {
OC_App::updateApp($app);
OC_Hook::emit('update', 'success', 'Updated '.$info['name'].' app');
2012-09-22 01:32:52 +04:00
}
catch (Exception $e) {
OC_Hook::emit('update', 'failure', 'Failed to update '.$info['name'].' app: '.$e->getMessage());
2013-07-23 01:04:14 +04:00
$l = OC_L10N::get('lib');
throw new RuntimeException($l->t('Failed to upgrade "%s".', array($app)), 0, $e);
2012-09-22 01:32:52 +04:00
}
OC_Appconfig::setValue($app, 'installed_version', OC_App::getAppVersion($app));
}
}
}
/**
* 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.
*/
2012-09-07 17:22:01 +04:00
public static function checkAppsRequirements($apps = 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(!isset($info['require']) or !self::isAppVersionCompatible($version, $info['require'])) {
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',
OC_Log::ERROR);
OC_App::disable( $app );
OC_Hook::emit('update', 'success', 'Disabled '.$info['name'].' app because it is not compatible');
}
}
}
2012-03-16 19:00:12 +04:00
/**
* Compares the app version with the owncloud version to see if the app
* requires a newer version than the currently active one
* @param array $owncloudVersions array with 3 entries: major minor bugfix
* @param string $appRequired the required version from the xml
* major.minor.bugfix
* @return boolean true if compatible, otherwise false
*/
public static function isAppVersionCompatible($owncloudVersions, $appRequired){
$appVersions = explode('.', $appRequired);
for($i=0; $i<count($appVersions); $i++){
$appVersion = (int) $appVersions[$i];
if(isset($owncloudVersions[$i])){
$owncloudVersion = $owncloudVersions[$i];
} else {
$owncloudVersion = 0;
}
if($owncloudVersion < $appVersion){
return false;
} elseif ($owncloudVersion > $appVersion) {
return true;
}
}
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
return $versions; // when function is used besides in checkUpgrade
}
2012-03-30 15:48:44 +04:00
$versions=array();
2013-02-11 20:44:02 +04:00
$query = OC_DB::prepare( 'SELECT `appid`, `configvalue` FROM `*PREFIX*appconfig`'
.' WHERE `configkey` = \'installed_version\'' );
2012-03-30 15:48:44 +04:00
$result = $query->execute();
2012-09-07 17:22:01 +04:00
while($row = $result->fetchRow()) {
2012-03-30 15:48:44 +04:00
$versions[$row['appid']]=$row['configvalue'];
}
return $versions;
}
/**
* update the database for the app and call the update script
2012-09-23 04:39:11 +04:00
* @param string $appid
*/
2012-09-07 17:22:01 +04:00
public static function updateApp($appid) {
if(file_exists(self::getAppPath($appid).'/appinfo/preupdate.php')) {
self::loadApp($appid);
include self::getAppPath($appid).'/appinfo/preupdate.php';
}
2012-09-04 14:32:27 +04:00
if(file_exists(self::getAppPath($appid).'/appinfo/database.xml')) {
2012-06-02 02:05:20 +04:00
OC_DB::updateDbFromStructure(self::getAppPath($appid).'/appinfo/database.xml');
}
2012-09-04 14:32:27 +04:00
if(!self::isEnabled($appid)) {
return;
}
2012-09-04 14:32:27 +04:00
if(file_exists(self::getAppPath($appid).'/appinfo/update.php')) {
2012-06-15 13:18:38 +04:00
self::loadApp($appid);
2012-06-02 02:05:20 +04:00
include self::getAppPath($appid).'/appinfo/update.php';
}
2012-09-23 04:39:11 +04:00
//set remote/public handlers
$appData=self::getAppInfo($appid);
2012-09-07 17:22:01 +04:00
foreach($appData['remote'] as $name=>$path) {
2012-07-14 00:44:35 +04:00
OCP\CONFIG::setAppValue('core', 'remote_'.$name, $appid.'/'.$path);
}
2012-09-07 17:22:01 +04:00
foreach($appData['public'] as $name=>$path) {
OCP\CONFIG::setAppValue('core', 'public_'.$name, $appid.'/'.$path);
}
self::setAppTypes($appid);
}
/**
2012-09-23 04:39:11 +04:00
* @param string $appid
* @return \OC\Files\View
*/
2012-09-07 17:22:01 +04:00
public static function getStorage($appid) {
2012-09-04 14:32:27 +04:00
if(OC_App::isEnabled($appid)) {//sanity check
if(OC_User::isLoggedIn()) {
$view = new \OC\Files\View('/'.OC_User::getUser());
if(!$view->file_exists($appid)) {
$view->mkdir($appid);
}
return new \OC\Files\View('/'.OC_User::getUser().'/'.$appid);
}else{
OC_Log::write('core', 'Can\'t get app storage, app '.$appid.', user not logged in', OC_Log::ERROR);
return false;
}
}else{
2012-09-04 14:32:27 +04:00
OC_Log::write('core', 'Can\'t get app storage, app '.$appid.' not enabled', OC_Log::ERROR);
return false;
}
}
}