nextcloud/lib/installer.php

384 lines
12 KiB
PHP
Raw Normal View History

<?php
/**
* ownCloud
*
* @author Robin Appelman
2012-05-26 21:14:24 +04:00
* @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 provides the functionality needed to install, update and remove plugins/apps
*/
2011-07-29 23:36:03 +04:00
class OC_Installer{
/**
* @brief Installs an app
* @param $data array with all information
* @returns integer
*
* This function installs an app. All information needed are passed in the
* associative array $data.
* The following keys are required:
* - source: string, can be "path" or "http"
*
* One of the following keys is required:
* - path: path to the file containing the app
* - href: link to the downloadable file containing the app
*
* The following keys are optional:
* - pretend: boolean, if set true the system won't do anything
* - noinstall: boolean, if true appinfo/install.php won't be loaded
* - inactive: boolean, if set true the appconfig/app.sample.php won't be
* renamed
*
* This function works as follows
* -# fetching the file
* -# unzipping it
* -# check the code
* -# installing the database at appinfo/database.xml
* -# including appinfo/install.php
* -# setting the installed version
*
* It is the task of oc_app_install to create the tables and do whatever is
* needed to get the app working.
*/
2012-10-16 19:57:07 +04:00
public static function installApp( $data = array()) {
if(!isset($data['source'])) {
2011-10-16 23:42:24 +04:00
OC_Log::write('core','No source specified when installing app',OC_Log::ERROR);
return false;
}
2012-10-16 19:57:07 +04:00
//download the file if necesary
2012-10-16 19:57:07 +04:00
if($data['source']=='http') {
$path=OC_Helper::tmpFile();
2012-10-16 19:57:07 +04:00
if(!isset($data['href'])) {
2011-10-16 23:42:24 +04:00
OC_Log::write('core','No href specified when installing app from http',OC_Log::ERROR);
return false;
}
copy($data['href'],$path);
}else{
2012-10-16 19:57:07 +04:00
if(!isset($data['path'])) {
2011-10-16 23:42:24 +04:00
OC_Log::write('core','No path specified when installing app from local file',OC_Log::ERROR);
return false;
}
$path=$data['path'];
}
2012-10-16 19:57:07 +04:00
//detect the archive type
$mime=OC_Helper::getMimeType($path);
2012-10-16 19:57:07 +04:00
if($mime=='application/zip') {
rename($path,$path.'.zip');
$path.='.zip';
2012-10-16 19:57:07 +04:00
}elseif($mime=='application/x-gzip') {
rename($path,$path.'.tgz');
$path.='.tgz';
}else{
OC_Log::write('core','Archives of type '.$mime.' are not supported',OC_Log::ERROR);
return false;
}
2012-10-16 19:57:07 +04:00
//extract the archive in a temporary folder
$extractDir=OC_Helper::tmpFolder();
OC_Helper::rmdirr($extractDir);
mkdir($extractDir);
2012-10-16 19:57:07 +04:00
if($archive=OC_Archive::open($path)) {
$archive->extract($extractDir);
} else {
2011-10-16 23:42:24 +04:00
OC_Log::write('core','Failed to open archive when installing app',OC_Log::ERROR);
2011-07-29 23:36:03 +04:00
OC_Helper::rmdirr($extractDir);
2012-10-16 19:57:07 +04:00
if($data['source']=='http') {
unlink($path);
}
return false;
}
2012-10-16 19:57:07 +04:00
//load the info.xml file of the app
2012-10-16 19:57:07 +04:00
if(!is_file($extractDir.'/appinfo/info.xml')) {
//try to find it in a subdir
$dh=opendir($extractDir);
2012-10-16 19:57:07 +04:00
while($folder=readdir($dh)) {
if($folder[0]!='.' and is_dir($extractDir.'/'.$folder)) {
if(is_file($extractDir.'/'.$folder.'/appinfo/info.xml')) {
$extractDir.='/'.$folder;
}
}
}
}
2012-10-16 19:57:07 +04:00
if(!is_file($extractDir.'/appinfo/info.xml')) {
2011-10-16 23:42:24 +04:00
OC_Log::write('core','App does not provide an info.xml file',OC_Log::ERROR);
2011-07-29 23:36:03 +04:00
OC_Helper::rmdirr($extractDir);
2012-10-16 19:57:07 +04:00
if($data['source']=='http') {
unlink($path);
}
return false;
}
2012-03-30 15:48:44 +04:00
$info=OC_App::getAppInfo($extractDir.'/appinfo/info.xml',true);
2012-10-16 19:57:07 +04:00
// check the code for not allowed calls
if(!OC_Installer::checkCode($info['id'],$extractDir)) {
OC_Log::write('core','App can\'t be installed because of not allowed code in the App',OC_Log::ERROR);
OC_Helper::rmdirr($extractDir);
2012-10-16 19:57:07 +04:00
return false;
}
2012-10-16 19:57:07 +04:00
// check if the app is compatible with this version of ownCloud
$version=OC_Util::getVersion();
if(!isset($info['require']) or ($version[0]>$info['require'])) {
OC_Log::write('core','App can\'t be installed because it is not compatible with this version of ownCloud',OC_Log::ERROR);
OC_Helper::rmdirr($extractDir);
2012-10-16 19:57:07 +04:00
return false;
}
//check if an app with the same id is already installed
2012-10-16 19:57:07 +04:00
if(self::isInstalled( $info['id'] )) {
2011-10-16 23:42:24 +04:00
OC_Log::write('core','App already installed',OC_Log::WARN);
2011-07-29 23:36:03 +04:00
OC_Helper::rmdirr($extractDir);
2012-10-16 19:57:07 +04:00
if($data['source']=='http') {
unlink($path);
}
return false;
}
$basedir=OC_App::getInstallPath().'/'.$info['id'];
//check if the destination directory already exists
2012-10-16 19:57:07 +04:00
if(is_dir($basedir)) {
2011-10-16 23:42:24 +04:00
OC_Log::write('core','App directory already exists',OC_Log::WARN);
2011-07-29 23:36:03 +04:00
OC_Helper::rmdirr($extractDir);
2012-10-16 19:57:07 +04:00
if($data['source']=='http') {
2011-06-20 00:42:33 +04:00
unlink($path);
}
return false;
}
2012-10-16 19:57:07 +04:00
if(isset($data['pretent']) and $data['pretent']==true) {
return false;
}
2012-10-16 19:57:07 +04:00
//copy the app to the correct place
2012-10-16 19:57:07 +04:00
if(@!mkdir($basedir)) {
OC_Log::write('core','Can\'t create app folder. Please fix permissions. ('.$basedir.')',OC_Log::ERROR);
2011-07-29 23:36:03 +04:00
OC_Helper::rmdirr($extractDir);
2012-10-16 19:57:07 +04:00
if($data['source']=='http') {
unlink($path);
}
return false;
}
2011-07-29 23:36:03 +04:00
OC_Helper::copyr($extractDir,$basedir);
2012-10-16 19:57:07 +04:00
//remove temporary files
2011-07-29 23:36:03 +04:00
OC_Helper::rmdirr($extractDir);
2012-10-16 19:57:07 +04:00
//install the database
2012-10-16 19:57:07 +04:00
if(is_file($basedir.'/appinfo/database.xml')) {
OC_DB::createDbFromStructure($basedir.'/appinfo/database.xml');
}
2012-10-16 19:57:07 +04:00
//run appinfo/install.php
2012-10-16 19:57:07 +04:00
if((!isset($data['noinstall']) or $data['noinstall']==false) and file_exists($basedir.'/appinfo/install.php')) {
include($basedir.'/appinfo/install.php');
}
2012-10-16 19:57:07 +04:00
//set the installed version
OC_Appconfig::setValue($info['id'],'installed_version',OC_App::getAppVersion($info['id']));
2011-07-29 23:36:03 +04:00
OC_Appconfig::setValue($info['id'],'enabled','no');
//set remote/public handelers
2012-10-16 19:57:07 +04:00
foreach($info['remote'] as $name=>$path) {
OCP\CONFIG::setAppValue('core', 'remote_'.$name, $info['id'].'/'.$path);
}
2012-10-16 19:57:07 +04:00
foreach($info['public'] as $name=>$path) {
OCP\CONFIG::setAppValue('core', 'public_'.$name, $info['id'].'/'.$path);
}
OC_App::setAppTypes($info['id']);
2012-10-16 19:57:07 +04:00
2012-01-27 20:34:47 +04:00
return $info['id'];
}
/**
* @brief checks whether or not an app is installed
* @param $app app
* @returns true/false
*
* Checks whether or not an app is installed, i.e. registered in apps table.
*/
2012-10-16 19:57:07 +04:00
public static function isInstalled( $app ) {
2012-10-16 19:57:07 +04:00
if( null == OC_Appconfig::getValue( $app, "installed_version" )) {
return false;
}
return true;
}
/**
* @brief Update an application
* @param $data array with all information
* @returns integer
*
* This function installs an app. All information needed are passed in the
* associative array $data.
* The following keys are required:
* - source: string, can be "path" or "http"
*
* One of the following keys is required:
* - path: path to the file containing the app
* - href: link to the downloadable file containing the app
*
* The following keys are optional:
* - pretend: boolean, if set true the system won't do anything
* - noupgrade: boolean, if true appinfo/upgrade.php won't be loaded
*
* This function works as follows
* -# fetching the file
* -# removing the old files
* -# unzipping new file
* -# including appinfo/upgrade.php
* -# setting the installed version
*
2011-07-29 23:36:03 +04:00
* upgrade.php can determine the current installed version of the app using "OC_Appconfig::getValue($appid,'installed_version')"
*/
2012-10-16 19:57:07 +04:00
public static function upgradeApp( $data = array()) {
// TODO: write function
return true;
}
/**
* @brief Removes an app
* @param $name name of the application to remove
* @param $options array with options
* @returns true/false
*
* This function removes an app. $options is an associative array. The
* following keys are optional:ja
* - keeppreferences: boolean, if true the user preferences won't be deleted
* - keepappconfig: boolean, if true the config will be kept
* - keeptables: boolean, if true the database will be kept
* - keepfiles: boolean, if true the user files will be kept
*
* This function works as follows
* -# including appinfo/remove.php
* -# removing the files
*
* The function will not delete preferences, tables and the configuration,
* this has to be done by the function oc_app_uninstall().
*/
2012-10-16 19:57:07 +04:00
public static function removeApp( $name, $options = array()) {
// TODO: write function
return true;
}
/**
* @brief Installs shipped apps
*
* This function installs all apps found in the 'apps' directory that should be enabled by default;
*/
2012-10-16 19:57:07 +04:00
public static function installShippedApps() {
foreach(OC::$APPSROOTS as $app_dir) {
2012-10-16 19:57:07 +04:00
if($dir = opendir( $app_dir['path'] )) {
while( false !== ( $filename = readdir( $dir ))) {
if( substr( $filename, 0, 1 ) != '.' and is_dir($app_dir['path']."/$filename") ) {
if( file_exists( $app_dir['path']."/$filename/appinfo/app.php" )) {
if(!OC_Installer::isInstalled($filename)) {
$info=OC_App::getAppInfo($filename);
$enabled = isset($info['default_enable']);
2012-10-16 19:57:07 +04:00
if( $enabled ) {
OC_Installer::installShippedApp($filename);
OC_Appconfig::setValue($filename,'enabled','yes');
}
}
}
}
}
2012-06-23 18:21:47 +04:00
closedir( $dir );
}
}
}
2011-08-22 16:17:38 +04:00
/**
* install an app already placed in the app folder
* @param string $app id of the app to install
* @returns array see OC_App::getAppInfo
2011-08-22 16:17:38 +04:00
*/
2012-10-16 19:57:07 +04:00
public static function installShippedApp($app) {
2011-08-22 16:17:38 +04:00
//install the database
2012-10-16 19:57:07 +04:00
if(is_file(OC_App::getAppPath($app)."/appinfo/database.xml")) {
2012-06-02 02:11:03 +04:00
OC_DB::createDbFromStructure(OC_App::getAppPath($app)."/appinfo/database.xml");
2011-08-22 16:17:38 +04:00
}
//run appinfo/install.php
2012-10-16 19:57:07 +04:00
if(is_file(OC_App::getAppPath($app)."/appinfo/install.php")) {
2012-06-02 02:11:03 +04:00
include(OC_App::getAppPath($app)."/appinfo/install.php");
2011-08-22 16:17:38 +04:00
}
2012-03-30 15:48:44 +04:00
$info=OC_App::getAppInfo($app);
2012-04-15 13:05:55 +04:00
OC_Appconfig::setValue($app,'installed_version',OC_App::getAppVersion($app));
2012-10-16 19:57:07 +04:00
//set remote/public handelers
2012-10-16 19:57:07 +04:00
foreach($info['remote'] as $name=>$path) {
OCP\CONFIG::setAppValue('core', 'remote_'.$name, $app.'/'.$path);
}
2012-10-16 19:57:07 +04:00
foreach($info['public'] as $name=>$path) {
OCP\CONFIG::setAppValue('core', 'public_'.$name, $app.'/'.$path);
}
2012-10-16 19:57:07 +04:00
OC_App::setAppTypes($info['id']);
2012-10-16 19:57:07 +04:00
return $info['id'];
2011-08-22 16:17:38 +04:00
}
2012-10-16 19:57:07 +04:00
/**
* check the code of an app with some static code checks
* @param string $folder the folder of the app to check
* @returns true for app is o.k. and false for app is not o.k.
*/
public static function checkCode($appname,$folder) {
$blacklist=array(
'exec(',
'eval('
// more evil pattern will go here later
// will will also check if an app is using private api once the public api is in place
);
// is the code checker enabled?
2012-10-16 19:57:07 +04:00
if(OC_Config::getValue('appcodechecker', false)) {
// check if grep is installed
$grep = exec('which grep');
if($grep=='') {
OC_Log::write('core','grep not installed. So checking the code of the app "'.$appname.'" was not possible',OC_Log::ERROR);
return true;
}
// iterate the bad patterns
foreach($blacklist as $bl) {
$cmd = 'grep -ri '.escapeshellarg($bl).' '.$folder.'';
$result = exec($cmd);
// bad pattern found
if($result<>'') {
OC_Log::write('core','App "'.$appname.'" is using a not allowed call "'.$bl.'". Installation refused.',OC_Log::ERROR);
return false;
}
}
return true;
2012-10-16 19:57:07 +04:00
}else{
2012-10-16 19:57:07 +04:00
return true;
}
2012-10-16 19:57:07 +04:00
}
}