lib/private/Installer.php

<?php
/**
 * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
 * @author Bart Visscher <bartv@thisnet.nl>
 * @author Brice Maron <brice@bmaron.net>
 * @author Christian Weiske <cweiske@cweiske.de>
 * @author Christopher Schäpers <kondou@ts.unde.re>
 * @author Frank Karlitschek <frank@karlitschek.de>
 * @author Georg Ehrke <georg@owncloud.com>
 * @author Jakob Sack <mail@jakobsack.de>
 * @author Joas Schilling <coding@schilljs.com>
 * @author Jörn Friedrich Dreyer <jfd@butonic.de>
 * @author Kamil Domanski <kdomanski@kdemail.net>
 * @author Lukas Reschke <lukas@statuscode.ch>
 * @author michag86 <micha_g@arcor.de>
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Robin Appelman <icewind@owncloud.com>
 * @author Roeland Jago Douma <rullzer@owncloud.com>
 * @author Thomas Müller <thomas.mueller@tmit.eu>
 * @author Thomas Tanghus <thomas@tanghus.net>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program 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, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC;

use Doctrine\DBAL\Exception\TableExistsException;
use OC\App\CodeChecker\CodeChecker;
use OC\App\CodeChecker\EmptyCheck;
use OC\App\CodeChecker\PrivateCheck;
use OC\DB\MigrationService;
use OC_App;
use OC_DB;
use OC_Helper;
use OCP\App\AppAlreadyInstalledException;

/**
 * This class provides the functionality needed to install, update and remove plugins/apps
 */
class Installer {

	/**
	 *
	 * 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.
	 *
	 * Installs an app
	 * @param array $data with all information
	 * @throws \Exception
	 * @return integer
	 */
	public static function installApp($data = []) {
		$l = \OC::$server->getL10N('lib');

		list($extractDir, $path) = self::downloadApp($data);

		$info = self::checkAppsIntegrity($data, $extractDir, $path);
		$appId = OC_App::cleanAppId($info['id']);
		$appsFolder = OC_App::getInstallPath();

		if ($appsFolder === null || !\is_writable($appsFolder)) {
			throw new \Exception('Apps folder is not writable');
		}
		$basedir = "$appsFolder/$appId";
		//check if the destination directory already exists
		if (\is_dir($basedir)) {
			OC_Helper::rmdirr($extractDir);
			if ($data['source']=='http') {
				\unlink($path);
			}
			throw new \Exception($l->t("App directory already exists"));
		}

		if (!empty($data['pretent'])) {
			return false;
		}

		//copy the app to the correct place
		if (@!\mkdir($basedir)) {
			OC_Helper::rmdirr($extractDir);
			if ($data['source']=='http') {
				\unlink($path);
			}
			throw new \Exception($l->t("Can't create app folder. Please fix permissions. %s", [$basedir]));
		}

		$extractDir .= '/' . $info['id'];
		if (!\file_exists($extractDir)) {
			OC_Helper::rmdirr($basedir);
			throw new \Exception($l->t("Archive does not contain a directory named %s", $info['id']));
		}
		OC_Helper::copyr($extractDir, $basedir);

		//remove temporary files
		OC_Helper::rmdirr($extractDir);

		//install the database
		if (isset($info['use-migrations']) && $info['use-migrations'] === 'true') {
			$ms = new \OC\DB\MigrationService($appId, \OC::$server->getDatabaseConnection());
			$ms->migrate();
		} else {
			if (\is_file($basedir.'/appinfo/database.xml')) {
				if (\OC::$server->getAppConfig()->getValue($info['id'], 'installed_version') === null) {
					OC_DB::createDbFromStructure($basedir . '/appinfo/database.xml');
				} else {
					OC_DB::updateDbFromStructure($basedir . '/appinfo/database.xml');
				}
			}
		}

		\OC_App::setupBackgroundJobs($info['background-jobs']);

		//run appinfo/install.php
		if ((!isset($data['noinstall']) or $data['noinstall']==false)) {
			self::includeAppScript($basedir . '/appinfo/install.php');
		}

		$appData = OC_App::getAppInfo($appId);
		OC_App::executeRepairSteps($appId, $appData['repair-steps']['install']);

		//set the installed version
		\OC::$server->getConfig()->setAppValue($info['id'], 'installed_version', OC_App::getAppVersion($info['id']));
		\OC::$server->getConfig()->setAppValue($info['id'], 'enabled', 'no');

		//set remote/public handlers
		foreach ($info['remote'] as $name=>$path) {
			\OC::$server->getConfig()->setAppValue('core', 'remote_'.$name, $info['id'].'/'.$path);
		}
		foreach ($info['public'] as $name=>$path) {
			\OC::$server->getConfig()->setAppValue('core', 'public_'.$name, $info['id'].'/'.$path);
		}

		OC_App::setAppTypes($info['id']);

		return $info['id'];
	}

	/**
	 * @brief checks whether or not an app is installed
	 * @param string $app app
	 * @return bool
	 *
	 * Checks whether or not an app is installed, i.e. registered in apps table.
	 */
	public static function isInstalled($app) {
		return (\OC::$server->getConfig()->getAppValue($app, "installed_version", null) !== null);
	}

	/**
	 * @brief Update an application
	 * @param array $info
	 * @param bool $isShipped
	 * @throws \Exception
	 * @return bool
	 *
	 * This function could work like described below, but currently it disables and then
	 * enables the app again. This does result in an updated app.
	 *
	 *
	 * This function installs an app. All information needed are passed in the
	 * associative array $info.
	 * 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::$server->getAppConfig()->getValue($appid, 'installed_version')"
	 */
	public static function updateApp($info= [], $isShipped=false) {
		list($extractDir, $path) = self::downloadApp($info);
		$info = self::checkAppsIntegrity($info, $extractDir, $path, $isShipped);

		$currentDir = OC_App::getAppPath($info['id']);
		if (\is_dir("$currentDir/.git")) {
			throw new AppAlreadyInstalledException("App <{$info['id']}> is a git clone - it will not be updated.");
		}

		$basedir  = OC_App::getInstallPath();
		$basedir .= '/';
		$basedir .= $info['id'];

		if ($currentDir !== false && OC_App::isAppDirWritable($info['id'])) {
			$basedir = $currentDir;
		}

		if (\is_dir($basedir)) {
			OC_Helper::rmdirr($basedir);
		}

		$appInExtractDir = $extractDir;
		if (\substr($extractDir, -1) !== '/') {
			$appInExtractDir .= '/';
		}

		$appInExtractDir .= $info['id'];
		OC_Helper::copyr($appInExtractDir, $basedir);
		OC_Helper::rmdirr($extractDir);

		return OC_App::updateApp($info['id']);
	}

	/**
	 * @param array $data
	 * @return array
	 * @throws \Exception
	 */
	public static function downloadApp($data = []) {
		$l = \OC::$server->getL10N('lib');

		if (!isset($data['source'])) {
			throw new \Exception($l->t("No source specified when installing app"));
		}

		//download the file if necessary
		if ($data['source']=='http') {
			$pathInfo = \pathinfo($data['href']);
			$extension = isset($pathInfo['extension']) ? '.' . $pathInfo['extension'] : '';
			$path = \OC::$server->getTempManager()->getTemporaryFile($extension);
			if (!isset($data['href'])) {
				throw new \Exception($l->t("No href specified when installing app from http"));
			}
			$client = \OC::$server->getHTTPClientService()->newClient();
			$client->get($data['href'], ['save_to' => $path]);
		} else {
			if (!isset($data['path'])) {
				throw new \Exception($l->t("No path specified when installing app from local file"));
			}
			$path=$data['path'];
		}

		//detect the archive type
		$mime = \OC::$server->getMimeTypeDetector()->detect($path);
		if ($mime !=='application/zip' && $mime !== 'application/x-gzip' && $mime !== 'application/gzip' && $mime !== 'application/x-bzip2') {
			throw new \Exception($l->t("Archives of type %s are not supported", [$mime]));
		}

		//extract the archive in a temporary folder
		$extractDir = \OC::$server->getTempManager()->getTemporaryFolder();
		OC_Helper::rmdirr($extractDir);
		\mkdir($extractDir);
		if ($archive=\OC\Archive\Archive::open($path)) {
			$archive->extract($extractDir);
		} else {
			OC_Helper::rmdirr($extractDir);
			if ($data['source']=='http') {
				\unlink($path);
			}
			throw new \Exception($l->t("Failed to open archive when installing app"));
		}

		return [
			$extractDir,
			$path
		];
	}

	/**
	 * check an app's integrity
	 * @param array $data
	 * @param string $extractDir
	 * @param string $path
	 * @param bool $isShipped
	 * @return array
	 * @throws \Exception
	 */
	public static function checkAppsIntegrity($data, $extractDir, $path, $isShipped = false) {
		$l = \OC::$server->getL10N('lib');
		//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);
			if (\is_resource($dh)) {
				while (($folder = \readdir($dh)) !== false) {
					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_Helper::rmdirr($extractDir);
			if ($data['source'] === 'http') {
				\unlink($path);
			}
			throw new \Exception($l->t("App does not provide an info.xml file"));
		}

		$info = OC_App::getAppInfo($extractDir.'/appinfo/info.xml', true);
		if (!\is_array($info)) {
			throw new \Exception($l->t('App cannot be installed because appinfo file cannot be read.'));
		}

		// We can't trust the parsed info.xml file as it may have been tampered
		// with by an attacker and thus we need to use the local data to check
		// whether the application needs to be signed.
		if (\file_exists("$extractDir/appinfo/signature.json")) {
			\OC::$server->getConfig()->setAppValue($info['id'], 'signed', 'true');
			$integrityResult = \OC::$server->getIntegrityCodeChecker()
				->verifyAppSignature(
					$info['id'],
					$extractDir
				);
			if ($integrityResult !== []) {
				$e = new \Exception(
					$l->t(
						'Signature could not get checked. Please contact the app developer and check your admin screen.'
					)
				);
				throw $e;
			}
		}

		// check if the app is compatible with this version of ownCloud
		if (!OC_App::isAppCompatible(\OCP\Util::getVersion(), $info)) {
			OC_Helper::rmdirr($extractDir);
			throw new \Exception($l->t("App can't be installed because it is not compatible with this version of ownCloud"));
		}

		// check if shipped tag is set which is only allowed for apps that are shipped with ownCloud
		if (!$isShipped && isset($info['shipped']) && ($info['shipped']=='true')) {
			OC_Helper::rmdirr($extractDir);
			throw new \Exception($l->t("App can't be installed because it contains the <shipped>true</shipped> tag which is not allowed for non shipped apps"));
		}

		// check if the ocs version is the same as the version in info.xml/version
		$version = \trim($info['version']);

		if (isset($data['appdata']['version']) && $version<>\trim($data['appdata']['version'])) {
			OC_Helper::rmdirr($extractDir);
			throw new \Exception($l->t("App can't be installed because the version in info.xml is not the same as the version reported from the app store"));
		}

		return $info;
	}

	/**
	 * Check if app is already downloaded
	 * @param string $name name of the application to remove
	 * @return boolean
	 *
	 * The function will check if the app is already downloaded in the apps repository
	 */
	public static function isDownloaded($name) {
		foreach (\OC::$APPSROOTS as $dir) {
			$dirToTest  = $dir['path'];
			$dirToTest .= '/';
			$dirToTest .= $name;
			$dirToTest .= '/';

			if (\is_dir($dirToTest)) {
				return true;
			}
		}

		return false;
	}

	/**
	 * Removes an app
	 * @param string $appId name of the application to remove
	 * @return boolean
	 * @throws AppAlreadyInstalledException
	 *
	 *
	 * This function works as follows
	 *   -# call uninstall repair steps
	 *   -# 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($appId) {
		if (Installer::isDownloaded($appId)) {
			$appDir = OC_App::getAppPath($appId);
			if ($appDir === false) {
				return false;
			}
			if (\is_dir("$appDir/.git")) {
				throw new AppAlreadyInstalledException("App <$appId> is a git clone - it will not be deleted.");
			}

			OC_Helper::rmdirr($appDir);

			return true;
		}
		\OCP\Util::writeLog('core', 'can\'t remove app '.$appId.'. It is not installed.', \OCP\Util::ERROR);

		return false;
	}

	protected static function getShippedApps() {
		$shippedApps = [];
		foreach (\OC::$APPSROOTS as $app_dir) {
			if ($dir = \opendir($app_dir['path'])) {
				$nodes = \scandir($app_dir['path']);
				foreach ($nodes as $filename) {
					// Since core 10.5.0, enterprise_key app is no longer used
					// Be sure not to accidentally enable it if it has been
					// left behind in an apps dir.
					if ($filename === 'enterprise_key') {
						continue;
					}
					if (\substr($filename, 0, 1) != '.' and \is_dir($app_dir['path']."/$filename")) {
						if (\file_exists($app_dir['path']."/$filename/appinfo/info.xml")) {
							if (!Installer::isInstalled($filename)) {
								$info=OC_App::getAppInfo($filename);
								$enabled = isset($info['default_enable']);
								if (($enabled || \in_array($filename, \OC::$server->getAppManager()->getAlwaysEnabledApps()))
									&& \OC::$server->getConfig()->getAppValue($filename, 'enabled') !== 'no') {
									$shippedApps[] = $filename;
								}
							}
						}
					}
				}
				\closedir($dir);
			}
		}

		// Fix the order - make files first
		$shippedApps = \array_diff($shippedApps, ['files', 'dav']);
		\array_unshift($shippedApps, 'dav');
		\array_unshift($shippedApps, 'files');
		return $shippedApps;
	}

	/**
	 * Installs shipped apps
	 *
	 * This function installs all apps found in the 'apps' directory that should be enabled by default;
	 * @param bool $softErrors When updating we ignore errors and simply log them, better to have a
	 *                         working ownCloud at the end instead of an aborted update.
	 * @return array Array of error messages (appid => Exception)
	 */
	public static function installShippedApps($softErrors = false) {
		$errors = [];
		$appsToInstall = Installer::getShippedApps();

		foreach ($appsToInstall as $appToInstall) {
			if (!Installer::isInstalled($appToInstall)) {
				if ($softErrors) {
					try {
						Installer::installShippedApp($appToInstall);
					} catch (TableExistsException $e) {
						\OC::$server->getLogger()->logException($e, ['app' => __CLASS__]);
						$errors[$appToInstall] = $e;
						continue;
					}
				} else {
					Installer::installShippedApp($appToInstall);
				}
				\OC::$server->getConfig()->setAppValue($appToInstall, 'enabled', 'yes');
			}
		}

		return $errors;
	}

	/**
	 * install an app already placed in the app folder
	 * @param string $app id of the app to install
	 * @return integer|false
	 */
	public static function installShippedApp($app) {
		\OC::$server->getLogger()->info('Attempting to install shipped app: '.$app);

		$info = OC_App::getAppInfo($app);
		if ($info === null) {
			return false;
		}

		//install the database
		$appPath = OC_App::getAppPath($app);
		if (isset($info['use-migrations']) && $info['use-migrations'] === 'true') {
			\OC::$server->getLogger()->debug('Running app database migrations');
			$ms = new MigrationService($app, \OC::$server->getDatabaseConnection());
			$ms->migrate();
		} else {
			if (\is_file($appPath.'/appinfo/database.xml')) {
				\OC::$server->getLogger()->debug('Create app database from schema file');
				OC_DB::createDbFromStructure($appPath . '/appinfo/database.xml');
			}
		}

		//run appinfo/install.php
		\OC_App::registerAutoloading($app, $appPath);

		\OC::$server->getLogger()->debug('Running app install script');
		self::includeAppScript("$appPath/appinfo/install.php");

		\OC_App::setupBackgroundJobs($info['background-jobs']);

		\OC::$server->getLogger()->debug('Running app install repair steps');
		OC_App::executeRepairSteps($app, $info['repair-steps']['install']);

		$config = \OC::$server->getConfig();

		$config->setAppValue($app, 'installed_version', OC_App::getAppVersion($app));

		//set remote/public handlers
		foreach ($info['remote'] as $name=>$path) {
			$config->setAppValue('core', 'remote_'.$name, $app.'/'.$path);
		}
		foreach ($info['public'] as $name=>$path) {
			$config->setAppValue('core', 'public_'.$name, $app.'/'.$path);
		}

		OC_App::setAppTypes($info['id']);

		return $info['id'];
	}

	/**
	 * @param $script
	 */
	private static function includeAppScript($script) {
		if (\file_exists($script)) {
			include $script;
		}
	}
}