123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384 |
- <?php
- /**
- * ownCloud
- *
- * @author Robin Appelman
- * @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
- */
- 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.
- */
- public static function installApp( $data = array()){
- if(!isset($data['source'])){
- OC_Log::write('core','No source specified when installing app',OC_Log::ERROR);
- return false;
- }
-
- //download the file if necesary
- if($data['source']=='http'){
- $path=OC_Helper::tmpFile();
- if(!isset($data['href'])){
- OC_Log::write('core','No href specified when installing app from http',OC_Log::ERROR);
- return false;
- }
- copy($data['href'],$path);
- }else{
- if(!isset($data['path'])){
- OC_Log::write('core','No path specified when installing app from local file',OC_Log::ERROR);
- return false;
- }
- $path=$data['path'];
- }
-
- //detect the archive type
- $mime=OC_Helper::getMimeType($path);
- if($mime=='application/zip'){
- rename($path,$path.'.zip');
- $path.='.zip';
- }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;
- }
-
- //extract the archive in a temporary folder
- $extractDir=OC_Helper::tmpFolder();
- OC_Helper::rmdirr($extractDir);
- mkdir($extractDir);
- if($archive=OC_Archive::open($path)){
- $archive->extract($extractDir);
- } else {
- OC_Log::write('core','Failed to open archive when installing app',OC_Log::ERROR);
- OC_Helper::rmdirr($extractDir);
- if($data['source']=='http'){
- unlink($path);
- }
- return false;
- }
-
- //load the info.xml file of the app
- if(!is_file($extractDir.'/appinfo/info.xml')){
- //try to find it in a subdir
- $dh=opendir($extractDir);
- while($folder=readdir($dh)){
- if($folder[0]!='.' and is_dir($extractDir.'/'.$folder)){
- if(is_file($extractDir.'/'.$folder.'/appinfo/info.xml')){
- $extractDir.='/'.$folder;
- }
- }
- }
- }
- if(!is_file($extractDir.'/appinfo/info.xml')){
- OC_Log::write('core','App does not provide an info.xml file',OC_Log::ERROR);
- OC_Helper::rmdirr($extractDir);
- if($data['source']=='http'){
- unlink($path);
- }
- return false;
- }
- $info=OC_App::getAppInfo($extractDir.'/appinfo/info.xml',true);
- $basedir=OC::$APPSROOT.'/apps/'.$info['id'];
- // 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);
- return false;
- }
- // 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);
- return false;
- }
- //check if an app with the same id is already installed
- if(self::isInstalled( $info['id'] )){
- OC_Log::write('core','App already installed',OC_Log::WARN);
- OC_Helper::rmdirr($extractDir);
- if($data['source']=='http'){
- unlink($path);
- }
- return false;
- }
- //check if the destination directory already exists
- if(is_dir($basedir)){
- OC_Log::write('core','App directory already exists',OC_Log::WARN);
- OC_Helper::rmdirr($extractDir);
- if($data['source']=='http'){
- unlink($path);
- }
- return false;
- }
-
- if(isset($data['pretent']) and $data['pretent']==true){
- return false;
- }
-
- //copy the app to the correct place
- if(@!mkdir($basedir)){
- OC_Log::write('core','Can\'t create app folder. Please fix permissions. ('.$basedir.')',OC_Log::ERROR);
- OC_Helper::rmdirr($extractDir);
- if($data['source']=='http'){
- unlink($path);
- }
- return false;
- }
- OC_Helper::copyr($extractDir,$basedir);
-
- //remove temporary files
- OC_Helper::rmdirr($extractDir);
-
- //install the database
- if(is_file($basedir.'/appinfo/database.xml')){
- OC_DB::createDbFromStructure($basedir.'/appinfo/database.xml');
- }
-
- //run appinfo/install.php
- if((!isset($data['noinstall']) or $data['noinstall']==false) and file_exists($basedir.'/appinfo/install.php')){
- include($basedir.'/appinfo/install.php');
- }
-
- //set the installed version
- OC_Appconfig::setValue($info['id'],'installed_version',OC_App::getAppVersion($info['id']));
- OC_Appconfig::setValue($info['id'],'enabled','no');
- //set remote/public handelers
- foreach($info['remote'] as $name=>$path){
- OCP\CONFIG::setAppValue('core', 'remote_'.$name, '/apps/'.$info['id'].'/'.$path);
- }
- foreach($info['public'] as $name=>$path){
- OCP\CONFIG::setAppValue('core', 'public_'.$name, '/apps/'.$info['id'].'/'.$path);
- }
- OC_App::setAppTypes($info['id']);
-
- 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.
- */
- public static function isInstalled( $app ){
- 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
- *
- * upgrade.php can determine the current installed version of the app using "OC_Appconfig::getValue($appid,'installed_version')"
- */
- 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().
- */
- 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;
- */
- public static function installShippedApps(){
- $dir = opendir( OC::$APPSROOT."/apps" );
- while( false !== ( $filename = readdir( $dir ))){
- if( substr( $filename, 0, 1 ) != '.' and is_dir(OC::$APPSROOT."/apps/$filename") ){
- if( file_exists( OC::$APPSROOT."/apps/$filename/appinfo/app.php" )){
- if(!OC_Installer::isInstalled($filename)){
- $info=OC_App::getAppInfo($filename);
- $enabled = isset($info['default_enable']);
- if( $enabled ){
- OC_Installer::installShippedApp($filename);
- OC_Appconfig::setValue($filename,'enabled','yes');
- }
- }
- }
- }
- }
- closedir( $dir );
- }
- /**
- * install an app already placed in the app folder
- * @param string $app id of the app to install
- * @returns array see OC_App::getAppInfo
- */
- public static function installShippedApp($app){
- //install the database
- if(is_file(OC::$APPSROOT."/apps/$app/appinfo/database.xml")){
- OC_DB::createDbFromStructure(OC::$APPSROOT."/apps/$app/appinfo/database.xml");
- }
- //run appinfo/install.php
- if(is_file(OC::$APPSROOT."/apps/$app/appinfo/install.php")){
- include(OC::$APPSROOT."/apps/$app/appinfo/install.php");
- }
- $info=OC_App::getAppInfo($app);
- OC_Appconfig::setValue($app,'installed_version',OC_App::getAppVersion($app));
-
- //set remote/public handelers
- foreach($info['remote'] as $name=>$path){
- OCP\CONFIG::setAppValue('core', 'remote_'.$name, '/apps/'.$app.'/'.$path);
- }
- foreach($info['public'] as $name=>$path){
- OCP\CONFIG::setAppValue('core', 'public_'.$name, '/apps/'.$app.'/'.$path);
- }
-
- OC_App::setAppTypes($info['id']);
-
- return $info;
- }
- /**
- * 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?
- 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;
-
- }else{
- return true;
- }
- }
- }
|