394 lines
11 KiB
PHP
394 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
|
|
* This file is licensed under the Affero General Public License version 3 or
|
|
* later.
|
|
* See the COPYING-README file.
|
|
*/
|
|
|
|
namespace OC;
|
|
|
|
use OC\Hooks\BasicEmitter;
|
|
use OC_App;
|
|
use OC_Util;
|
|
use OCP\IConfig;
|
|
use OC\Setup;
|
|
|
|
/**
|
|
* Class that handles autoupdating of ownCloud
|
|
*
|
|
* Hooks provided in scope \OC\Updater
|
|
* - maintenanceStart()
|
|
* - maintenanceEnd()
|
|
* - dbUpgrade()
|
|
* - failure(string $message)
|
|
*/
|
|
class Updater extends BasicEmitter {
|
|
|
|
/** @var \OC\Log $log */
|
|
private $log;
|
|
|
|
/** @var \OC\HTTPHelper $helper */
|
|
private $httpHelper;
|
|
|
|
/** @var IConfig */
|
|
private $config;
|
|
|
|
/** @var bool */
|
|
private $simulateStepEnabled;
|
|
|
|
/** @var bool */
|
|
private $updateStepEnabled;
|
|
|
|
/**
|
|
* @param HTTPHelper $httpHelper
|
|
* @param IConfig $config
|
|
* @param \OC\Log $log
|
|
*/
|
|
public function __construct(HTTPHelper $httpHelper, IConfig $config, $log = null) {
|
|
$this->httpHelper = $httpHelper;
|
|
$this->log = $log;
|
|
$this->config = $config;
|
|
$this->simulateStepEnabled = true;
|
|
$this->updateStepEnabled = true;
|
|
}
|
|
|
|
/**
|
|
* Sets whether the database migration simulation must
|
|
* be enabled.
|
|
* This can be set to false to skip this test.
|
|
*
|
|
* @param bool $flag true to enable simulation, false otherwise
|
|
*/
|
|
public function setSimulateStepEnabled($flag) {
|
|
$this->simulateStepEnabled = $flag;
|
|
}
|
|
|
|
/**
|
|
* Sets whether the update must be performed.
|
|
* This can be set to false to skip the actual update.
|
|
*
|
|
* @param bool $flag true to enable update, false otherwise
|
|
*/
|
|
public function setUpdateStepEnabled($flag) {
|
|
$this->updateStepEnabled = $flag;
|
|
}
|
|
|
|
/**
|
|
* Check if a new version is available
|
|
*
|
|
* @param string $updaterUrl the url to check, i.e. 'http://apps.owncloud.com/updater.php'
|
|
* @return array|bool
|
|
*/
|
|
public function check($updaterUrl = null) {
|
|
|
|
// Look up the cache - it is invalidated all 30 minutes
|
|
if (((int)$this->config->getAppValue('core', 'lastupdatedat') + 1800) > time()) {
|
|
return json_decode($this->config->getAppValue('core', 'lastupdateResult'), true);
|
|
}
|
|
|
|
if (is_null($updaterUrl)) {
|
|
$updaterUrl = 'https://apps.owncloud.com/updater.php';
|
|
}
|
|
|
|
$this->config->setAppValue('core', 'lastupdatedat', time());
|
|
|
|
if ($this->config->getAppValue('core', 'installedat', '') == '') {
|
|
$this->config->setAppValue('core', 'installedat', microtime(true));
|
|
}
|
|
|
|
$version = \OC_Util::getVersion();
|
|
$version['installed'] = $this->config->getAppValue('core', 'installedat');
|
|
$version['updated'] = $this->config->getAppValue('core', 'lastupdatedat');
|
|
$version['updatechannel'] = \OC_Util::getChannel();
|
|
$version['edition'] = \OC_Util::getEditionString();
|
|
$version['build'] = \OC_Util::getBuild();
|
|
$versionString = implode('x', $version);
|
|
|
|
//fetch xml data from updater
|
|
$url = $updaterUrl . '?version=' . $versionString;
|
|
|
|
// set a sensible timeout of 10 sec to stay responsive even if the update server is down.
|
|
|
|
$tmp = array();
|
|
$xml = $this->httpHelper->getUrlContent($url);
|
|
if ($xml) {
|
|
$loadEntities = libxml_disable_entity_loader(true);
|
|
$data = @simplexml_load_string($xml);
|
|
libxml_disable_entity_loader($loadEntities);
|
|
if ($data !== false) {
|
|
$tmp['version'] = $data->version;
|
|
$tmp['versionstring'] = $data->versionstring;
|
|
$tmp['url'] = $data->url;
|
|
$tmp['web'] = $data->web;
|
|
}
|
|
} else {
|
|
$data = array();
|
|
}
|
|
|
|
// Cache the result
|
|
$this->config->setAppValue('core', 'lastupdateResult', json_encode($data));
|
|
return $tmp;
|
|
}
|
|
|
|
/**
|
|
* runs the update actions in maintenance mode, does not upgrade the source files
|
|
* except the main .htaccess file
|
|
*
|
|
* @return bool true if the operation succeeded, false otherwise
|
|
*/
|
|
public function upgrade() {
|
|
$this->config->setSystemValue('maintenance', true);
|
|
|
|
$installedVersion = $this->config->getSystemValue('version', '0.0.0');
|
|
$currentVersion = implode('.', \OC_Util::getVersion());
|
|
if ($this->log) {
|
|
$this->log->debug('starting upgrade from ' . $installedVersion . ' to ' . $currentVersion, array('app' => 'core'));
|
|
}
|
|
$this->emit('\OC\Updater', 'maintenanceStart');
|
|
|
|
try {
|
|
$this->doUpgrade($currentVersion, $installedVersion);
|
|
} catch (\Exception $exception) {
|
|
$this->emit('\OC\Updater', 'failure', array($exception->getMessage()));
|
|
}
|
|
|
|
$this->config->setSystemValue('maintenance', false);
|
|
$this->emit('\OC\Updater', 'maintenanceEnd');
|
|
}
|
|
|
|
/**
|
|
* Whether an upgrade to a specified version is possible
|
|
* @param string $oldVersion
|
|
* @param string $newVersion
|
|
* @return bool
|
|
*/
|
|
public function isUpgradePossible($oldVersion, $newVersion) {
|
|
$oldVersion = explode('.', $oldVersion);
|
|
$newVersion = explode('.', $newVersion);
|
|
|
|
if($newVersion[0] > ($oldVersion[0] + 1) || $oldVersion[0] > $newVersion[0]) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Forward messages emitted by the repair routine
|
|
*
|
|
* @param Repair $repair repair routine
|
|
*/
|
|
private function emitRepairMessages(Repair $repair) {
|
|
$repair->listen('\OC\Repair', 'warning', function ($description) {
|
|
$this->emit('\OC\Updater', 'repairWarning', array($description));
|
|
});
|
|
$repair->listen('\OC\Repair', 'error', function ($description) {
|
|
$this->emit('\OC\Updater', 'repairError', array($description));
|
|
});
|
|
}
|
|
|
|
/**
|
|
* runs the update actions in maintenance mode, does not upgrade the source files
|
|
* except the main .htaccess file
|
|
*
|
|
* @param string $currentVersion current version to upgrade to
|
|
* @param string $installedVersion previous version from which to upgrade from
|
|
*
|
|
* @throws \Exception
|
|
* @return bool true if the operation succeeded, false otherwise
|
|
*/
|
|
private function doUpgrade($currentVersion, $installedVersion) {
|
|
// Stop update if the update is over several major versions
|
|
if (!self::isUpgradePossible($installedVersion, $currentVersion)) {
|
|
throw new \Exception('Updates between multiple major versions are unsupported.');
|
|
}
|
|
|
|
// Update .htaccess files
|
|
try {
|
|
Setup::updateHtaccess();
|
|
Setup::protectDataDirectory();
|
|
} catch (\Exception $e) {
|
|
throw new \Exception($e->getMessage());
|
|
}
|
|
|
|
// create empty file in data dir, so we can later find
|
|
// out that this is indeed an ownCloud data directory
|
|
// (in case it didn't exist before)
|
|
file_put_contents($this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/.ocdata', '');
|
|
|
|
// pre-upgrade repairs
|
|
$repair = new Repair(Repair::getBeforeUpgradeRepairSteps());
|
|
$this->emitRepairMessages($repair);
|
|
$repair->run();
|
|
|
|
// simulate DB upgrade
|
|
if ($this->simulateStepEnabled) {
|
|
$this->checkCoreUpgrade();
|
|
|
|
// simulate apps DB upgrade
|
|
$this->checkAppUpgrade($currentVersion);
|
|
|
|
}
|
|
|
|
if ($this->updateStepEnabled) {
|
|
$this->doCoreUpgrade();
|
|
|
|
$this->checkAppsRequirements();
|
|
$this->doAppUpgrade();
|
|
|
|
// post-upgrade repairs
|
|
$repair = new Repair(Repair::getRepairSteps());
|
|
$this->emitRepairMessages($repair);
|
|
$repair->run();
|
|
|
|
//Invalidate update feed
|
|
$this->config->setAppValue('core', 'lastupdatedat', 0);
|
|
|
|
// only set the final version if everything went well
|
|
$this->config->setSystemValue('version', implode('.', \OC_Util::getVersion()));
|
|
}
|
|
}
|
|
|
|
protected function checkCoreUpgrade() {
|
|
// simulate core DB upgrade
|
|
\OC_DB::simulateUpdateDbFromStructure(\OC::$SERVERROOT . '/db_structure.xml');
|
|
|
|
$this->emit('\OC\Updater', 'dbSimulateUpgrade');
|
|
}
|
|
|
|
protected function doCoreUpgrade() {
|
|
// do the real upgrade
|
|
\OC_DB::updateDbFromStructure(\OC::$SERVERROOT . '/db_structure.xml');
|
|
|
|
$this->emit('\OC\Updater', 'dbUpgrade');
|
|
}
|
|
|
|
/**
|
|
* @param string $version the oc version to check app compatibility with
|
|
*/
|
|
protected function checkAppUpgrade($version) {
|
|
$apps = \OC_App::getEnabledApps();
|
|
|
|
foreach ($apps as $appId) {
|
|
$info = \OC_App::getAppInfo($appId);
|
|
$compatible = \OC_App::isAppCompatible($version, $info);
|
|
$isShipped = \OC_App::isShipped($appId);
|
|
|
|
if ($compatible && $isShipped && \OC_App::shouldUpgrade($appId)) {
|
|
/**
|
|
* FIXME: The preupdate check is performed before the database migration, otherwise database changes
|
|
* are not possible anymore within it. - Consider this when touching the code.
|
|
* @link https://github.com/owncloud/core/issues/10980
|
|
* @see \OC_App::updateApp
|
|
*/
|
|
if (file_exists(\OC_App::getAppPath($appId) . '/appinfo/preupdate.php')) {
|
|
$this->includePreUpdate($appId);
|
|
}
|
|
if (file_exists(\OC_App::getAppPath($appId) . '/appinfo/database.xml')) {
|
|
\OC_DB::simulateUpdateDbFromStructure(\OC_App::getAppPath($appId) . '/appinfo/database.xml');
|
|
}
|
|
}
|
|
}
|
|
|
|
$this->emit('\OC\Updater', 'appUpgradeCheck');
|
|
}
|
|
|
|
/**
|
|
* Includes the pre-update file. Done here to prevent namespace mixups.
|
|
* @param string $appId
|
|
*/
|
|
private function includePreUpdate($appId) {
|
|
include \OC_App::getAppPath($appId) . '/appinfo/preupdate.php';
|
|
}
|
|
|
|
|
|
/**
|
|
* upgrades all apps within a major ownCloud upgrade. Also loads "priority"
|
|
* (types authentication, filesystem, logging, in that order) afterwards.
|
|
*
|
|
* @throws NeedsUpdateException
|
|
*/
|
|
protected function doAppUpgrade() {
|
|
$apps = \OC_App::getEnabledApps();
|
|
$priorityTypes = array('authentication', 'filesystem', 'logging');
|
|
$pseudoOtherType = 'other';
|
|
$stacks = array($pseudoOtherType => array());
|
|
|
|
foreach ($apps as $appId) {
|
|
$priorityType = false;
|
|
foreach ($priorityTypes as $type) {
|
|
if(!isset($stacks[$type])) {
|
|
$stacks[$type] = array();
|
|
}
|
|
if (\OC_App::isType($appId, $type)) {
|
|
$stacks[$type][] = $appId;
|
|
$priorityType = true;
|
|
break;
|
|
}
|
|
}
|
|
if (!$priorityType) {
|
|
$stacks[$pseudoOtherType][] = $appId;
|
|
}
|
|
}
|
|
foreach ($stacks as $type => $stack) {
|
|
foreach ($stack as $appId) {
|
|
if (\OC_App::shouldUpgrade($appId)) {
|
|
\OC_App::updateApp($appId);
|
|
$this->emit('\OC\Updater', 'appUpgrade', array($appId, \OC_App::getAppVersion($appId)));
|
|
}
|
|
if($type !== $pseudoOtherType) {
|
|
// load authentication, filesystem and logging apps after
|
|
// upgrading them. Other apps my need to rely on modifying
|
|
// user and/or filesystem aspects.
|
|
\OC_App::loadApp($appId, 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.
|
|
*/
|
|
private function checkAppsRequirements() {
|
|
$isCoreUpgrade = $this->isCodeUpgrade();
|
|
$apps = OC_App::getEnabledApps();
|
|
$version = OC_Util::getVersion();
|
|
foreach ($apps as $app) {
|
|
// check if the app is compatible with this version of ownCloud
|
|
$info = OC_App::getAppInfo($app);
|
|
if(!OC_App::isAppCompatible($version, $info)) {
|
|
OC_App::disable($app);
|
|
$this->emit('\OC\Updater', 'incompatibleAppDisabled', array($app));
|
|
}
|
|
// no need to disable any app in case this is a non-core upgrade
|
|
if (!$isCoreUpgrade) {
|
|
continue;
|
|
}
|
|
// shipped apps will remain enabled
|
|
if (OC_App::isShipped($app)) {
|
|
continue;
|
|
}
|
|
// authentication and session apps will remain enabled as well
|
|
if (OC_App::isType($app, ['session', 'authentication'])) {
|
|
continue;
|
|
}
|
|
|
|
// disable any other 3rd party apps
|
|
\OC_App::disable($app);
|
|
$this->emit('\OC\Updater', 'thirdPartyAppDisabled', array($app));
|
|
}
|
|
}
|
|
|
|
private function isCodeUpgrade() {
|
|
$installedVersion = $this->config->getSystemValue('version', '0.0.0');
|
|
$currentVersion = implode('.', OC_Util::getVersion());
|
|
if (version_compare($currentVersion, $installedVersion, '>')) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|