Updater.php 14.7 KB
Newer Older
1
2
<?php
/**
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
3
4
5
6
 * @author Arthur Schiwon <blizzz@owncloud.com>
 * @author Bart Visscher <bartv@thisnet.nl>
 * @author Björn Schießle <schiessle@owncloud.com>
 * @author Frank Karlitschek <frank@owncloud.org>
Lukas Reschke's avatar
Lukas Reschke committed
7
 * @author Joas Schilling <nickvergessen@owncloud.com>
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
8
9
10
 * @author Lukas Reschke <lukas@owncloud.com>
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Robin Appelman <icewind@owncloud.com>
Thomas Müller's avatar
Thomas Müller committed
11
 * @author Robin McCorkell <robin@mccorkell.me.uk>
12
 * @author Steffen Lindner <mail@steffen-lindner.de>
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
13
14
15
16
 * @author Thomas Müller <thomas.mueller@tmit.eu>
 * @author Victor Dubiniuk <dubiniuk@owncloud.com>
 * @author Vincent Petry <pvince81@owncloud.com>
 *
Thomas Müller's avatar
Thomas Müller committed
17
 * @copyright Copyright (c) 2016, ownCloud, Inc.
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 * @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/>
 *
32
 */
33

34
namespace OC;
35

36
use OC\Hooks\BasicEmitter;
Lukas Reschke's avatar
Lukas Reschke committed
37
use OC\IntegrityCheck\Checker;
38
use OC_App;
39
use OC_Installer;
40
use OCP\IConfig;
41
use OC\Setup;
42
use OCP\ILogger;
43
use Symfony\Component\EventDispatcher\GenericEvent;
44

45
/**
Robin Appelman's avatar
Robin Appelman committed
46
 * Class that handles autoupdating of ownCloud
47
48
49
50
51
52
 *
 * Hooks provided in scope \OC\Updater
 *  - maintenanceStart()
 *  - maintenanceEnd()
 *  - dbUpgrade()
 *  - failure(string $message)
53
 */
54
55
class Updater extends BasicEmitter {

56
	/** @var ILogger $log */
57
	private $log;
58
	
59
	/** @var IConfig */
Victor Dubiniuk's avatar
Victor Dubiniuk committed
60
	private $config;
61

Lukas Reschke's avatar
Lukas Reschke committed
62
63
64
	/** @var Checker */
	private $checker;

65
	/** @var bool */
66
67
	private $simulateStepEnabled;

68
	/** @var bool */
69
70
	private $updateStepEnabled;

Steffen Lindner's avatar
Steffen Lindner committed
71
72
73
	/** @var bool */
	private $skip3rdPartyAppsDisable;

74
75
76
77
78
79
80
81
	private $logLevelNames = [
		0 => 'Debug',
		1 => 'Info',
		2 => 'Warning',
		3 => 'Error',
		4 => 'Fatal',
	];

82
	/**
83
	 * @param IConfig $config
Lukas Reschke's avatar
Lukas Reschke committed
84
	 * @param Checker $checker
85
	 * @param ILogger $log
86
	 */
87
	public function __construct(IConfig $config,
Lukas Reschke's avatar
Lukas Reschke committed
88
								Checker $checker,
89
								ILogger $log = null) {
90
		$this->log = $log;
Victor Dubiniuk's avatar
Victor Dubiniuk committed
91
		$this->config = $config;
Lukas Reschke's avatar
Lukas Reschke committed
92
		$this->checker = $checker;
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
		$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;
116
	}
117

Steffen Lindner's avatar
Steffen Lindner committed
118
119
120
121
122
123
124
125
126
127
	/**
	 * Sets whether the update disables 3rd party apps.
	 * This can be set to true to skip the disable.
	 *
	 * @param bool $flag false to not disable, true otherwise
	 */
	public function setSkip3rdPartyAppsDisable($flag) {
		$this->skip3rdPartyAppsDisable = $flag;
	}

128
129
	/**
	 * runs the update actions in maintenance mode, does not upgrade the source files
Lukas Reschke's avatar
Lukas Reschke committed
130
	 * except the main .htaccess file
131
132
	 *
	 * @return bool true if the operation succeeded, false otherwise
133
134
	 */
	public function upgrade() {
135
136
		$this->emitRepairEvents();

137
138
139
140
		$logLevel = $this->config->getSystemValue('loglevel', \OCP\Util::WARN);
		$this->emit('\OC\Updater', 'setDebugLogLevel', [ $logLevel, $this->logLevelNames[$logLevel] ]);
		$this->config->setSystemValue('loglevel', \OCP\Util::DEBUG);

141
142
143
144
145
146
		$wasMaintenanceModeEnabled = $this->config->getSystemValue('maintenance', false);

		if(!$wasMaintenanceModeEnabled) {
			$this->config->setSystemValue('maintenance', true);
			$this->emit('\OC\Updater', 'maintenanceEnabled');
		}
147

148
		$installedVersion = $this->config->getSystemValue('version', '0.0.0');
149
		$currentVersion = implode('.', \OCP\Util::getVersion());
Thomas Müller's avatar
Thomas Müller committed
150
		$this->log->debug('starting upgrade from ' . $installedVersion . ' to ' . $currentVersion, array('app' => 'core'));
151

152
		$success = true;
153
154
155
		try {
			$this->doUpgrade($currentVersion, $installedVersion);
		} catch (\Exception $exception) {
Thomas Müller's avatar
Thomas Müller committed
156
			$this->log->logException($exception, ['app' => 'core']);
157
158
			$this->emit('\OC\Updater', 'failure', array(get_class($exception) . ': ' .$exception->getMessage()));
			$success = false;
159
160
		}

161
		$this->emit('\OC\Updater', 'updateEnd', array($success));
162

163
		if(!$wasMaintenanceModeEnabled && $success) {
164
165
166
167
168
			$this->config->setSystemValue('maintenance', false);
			$this->emit('\OC\Updater', 'maintenanceDisabled');
		} else {
			$this->emit('\OC\Updater', 'maintenanceActive');
		}
169

170
171
172
		$this->emit('\OC\Updater', 'resetLogLevel', [ $logLevel, $this->logLevelNames[$logLevel] ]);
		$this->config->setSystemValue('loglevel', $logLevel);

173
		return $success;
174
175
	}

176
177
178
179
180
181
182
183
	/**
	 * Return version from which this version is allowed to upgrade from
	 *
	 * @return string allowed previous version
	 */
	private function getAllowedPreviousVersion() {
		// this should really be a JSON file
		require \OC::$SERVERROOT . '/version.php';
Thomas Müller's avatar
Thomas Müller committed
184
		/** @var array $OC_VersionCanBeUpgradedFrom */
185
186
187
		return implode('.', $OC_VersionCanBeUpgradedFrom);
	}

188
189
190
191
	/**
	 * Whether an upgrade to a specified version is possible
	 * @param string $oldVersion
	 * @param string $newVersion
192
	 * @param string $allowedPreviousVersion
193
194
	 * @return bool
	 */
195
	public function isUpgradePossible($oldVersion, $newVersion, $allowedPreviousVersion) {
Vincent Petry's avatar
Vincent Petry committed
196
		return (version_compare($allowedPreviousVersion, $oldVersion, '<=')
197
			&& (version_compare($oldVersion, $newVersion, '<=') || $this->config->getSystemValue('debug', false)));
198
199
	}

200
201
202
203
204
205
206
	/**
	 * 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
	 *
207
	 * @throws \Exception
208
209
	 */
	private function doUpgrade($currentVersion, $installedVersion) {
210
		// Stop update if the update is over several major versions
211
212
213
		$allowedPreviousVersion = $this->getAllowedPreviousVersion();
		if (!self::isUpgradePossible($installedVersion, $currentVersion, $allowedPreviousVersion)) {
			throw new \Exception('Updates between multiple major versions and downgrades are unsupported.');
214
215
		}

216
217
218
219
220
221
		// Update .htaccess files
		try {
			Setup::updateHtaccess();
			Setup::protectDataDirectory();
		} catch (\Exception $e) {
			throw new \Exception($e->getMessage());
Lukas Reschke's avatar
Lukas Reschke committed
222
223
		}

224
225
226
		// 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)
227
		file_put_contents($this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/.ocdata', '');
228

229
		// pre-upgrade repairs
230
		$repair = new Repair(Repair::getBeforeUpgradeRepairSteps(), \OC::$server->getEventDispatcher());
231
		$repair->run();
232

233
		// simulate DB upgrade
234
		if ($this->simulateStepEnabled) {
235
			$this->checkCoreUpgrade();
236
237

			// simulate apps DB upgrade
238
			$this->checkAppUpgrade($currentVersion);
239

240
		}
241

242
		if ($this->updateStepEnabled) {
243
			$this->doCoreUpgrade();
244

245
246
			// update all shipped apps
			$disabledApps = $this->checkAppsRequirements();
247
			$this->doAppUpgrade();
248

249
250
251
			// upgrade appstore apps
			$this->upgradeAppStoreApps($disabledApps);

252
253
			// install new shipped apps on upgrade
			OC_App::loadApps('authentication');
254
255
256
257
258
259
			$errors = OC_Installer::installShippedApps(true);
			foreach ($errors as $appId => $exception) {
				/** @var \Exception $exception */
				$this->log->logException($exception, ['app' => $appId]);
				$this->emit('\OC\Updater', 'failure', [$appId . ': ' . $exception->getMessage()]);
			}
260

261
			// post-upgrade repairs
262
			$repair = new Repair(Repair::getRepairSteps(), \OC::$server->getEventDispatcher());
263
264
265
			$repair->run();

			//Invalidate update feed
266
			$this->config->setAppValue('core', 'lastupdatedat', 0);
267

268
269
			// Check for code integrity if not disabled
			if(\OC::$server->getIntegrityCodeChecker()->isCodeCheckEnforced()) {
Lukas Reschke's avatar
Lukas Reschke committed
270
271
272
273
274
				$this->emit('\OC\Updater', 'startCheckCodeIntegrity');
				$this->checker->runInstanceVerification();
				$this->emit('\OC\Updater', 'finishedCheckCodeIntegrity');
			}

275
			// only set the final version if everything went well
276
			$this->config->setSystemValue('version', implode('.', \OCP\Util::getVersion()));
277
		}
278
	}
279
280

	protected function checkCoreUpgrade() {
281
282
		$this->emit('\OC\Updater', 'dbSimulateUpgradeBefore');

283
284
285
286
287
288
289
		// simulate core DB upgrade
		\OC_DB::simulateUpdateDbFromStructure(\OC::$SERVERROOT . '/db_structure.xml');

		$this->emit('\OC\Updater', 'dbSimulateUpgrade');
	}

	protected function doCoreUpgrade() {
290
291
		$this->emit('\OC\Updater', 'dbUpgradeBefore');

292
293
294
295
296
297
298
		// do the real upgrade
		\OC_DB::updateDbFromStructure(\OC::$SERVERROOT . '/db_structure.xml');

		$this->emit('\OC\Updater', 'dbUpgrade');
	}

	/**
299
	 * @param string $version the oc version to check app compatibility with
300
301
302
	 */
	protected function checkAppUpgrade($version) {
		$apps = \OC_App::getEnabledApps();
303
		$this->emit('\OC\Updater', 'appUpgradeCheckBefore');
304
305

		foreach ($apps as $appId) {
306
307
308
			$info = \OC_App::getAppInfo($appId);
			$compatible = \OC_App::isAppCompatible($version, $info);
			$isShipped = \OC_App::isShipped($appId);
309

310
			if ($compatible && $isShipped && \OC_App::shouldUpgrade($appId)) {
Lukas Reschke's avatar
Lukas Reschke committed
311
312
313
314
315
316
317
318
319
				/**
				 * 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);
				}
320
				if (file_exists(\OC_App::getAppPath($appId) . '/appinfo/database.xml')) {
321
					$this->emit('\OC\Updater', 'appSimulateUpdate', array($appId));
322
323
324
325
326
327
328
329
					\OC_DB::simulateUpdateDbFromStructure(\OC_App::getAppPath($appId) . '/appinfo/database.xml');
				}
			}
		}

		$this->emit('\OC\Updater', 'appUpgradeCheck');
	}

Lukas Reschke's avatar
Lukas Reschke committed
330
331
332
333
334
335
336
337
	/**
	 * 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';
	}

Arthur Schiwon's avatar
Arthur Schiwon committed
338
339
340
341
342
343
	/**
	 * upgrades all apps within a major ownCloud upgrade. Also loads "priority"
	 * (types authentication, filesystem, logging, in that order) afterwards.
	 *
	 * @throws NeedsUpdateException
	 */
344
345
	protected function doAppUpgrade() {
		$apps = \OC_App::getEnabledApps();
Arthur Schiwon's avatar
Arthur Schiwon committed
346
347
348
		$priorityTypes = array('authentication', 'filesystem', 'logging');
		$pseudoOtherType = 'other';
		$stacks = array($pseudoOtherType => array());
349
350

		foreach ($apps as $appId) {
Arthur Schiwon's avatar
Arthur Schiwon committed
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
			$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)) {
369
					$this->emit('\OC\Updater', 'appUpgradeStarted', [$appId, \OC_App::getAppVersion($appId)]);
Arthur Schiwon's avatar
Arthur Schiwon committed
370
					\OC_App::updateApp($appId);
371
					$this->emit('\OC\Updater', 'appUpgrade', [$appId, \OC_App::getAppVersion($appId)]);
Arthur Schiwon's avatar
Arthur Schiwon committed
372
373
374
375
376
377
378
				}
				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);
				}
379
380
381
			}
		}
	}
382
383
384
385
386
387

	/**
	 * 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.
388
389
390
	 *
	 * @return array
	 * @throws \Exception
391
392
	 */
	private function checkAppsRequirements() {
393
		$isCoreUpgrade = $this->isCodeUpgrade();
394
		$apps = OC_App::getEnabledApps();
395
		$version = \OCP\Util::getVersion();
396
		$disabledApps = [];
397
398
399
400
401
402
403
		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));
			}
404
405
406
407
			// no need to disable any app in case this is a non-core upgrade
			if (!$isCoreUpgrade) {
				continue;
			}
408
409
410
			// shipped apps will remain enabled
			if (OC_App::isShipped($app)) {
				continue;
411
			}
412
413
414
415
416
			// authentication and session apps will remain enabled as well
			if (OC_App::isType($app, ['session', 'authentication'])) {
				continue;
			}

Steffen Lindner's avatar
Steffen Lindner committed
417
418
419
420
421
422
			// disable any other 3rd party apps if not overriden
			if(!$this->skip3rdPartyAppsDisable) {
				\OC_App::disable($app);
				$disabledApps[]= $app;
				$this->emit('\OC\Updater', 'thirdPartyAppDisabled', array($app));
			};
423
		}
424
		return $disabledApps;
425
	}
426

427
428
429
	/**
	 * @return bool
	 */
430
431
	private function isCodeUpgrade() {
		$installedVersion = $this->config->getSystemValue('version', '0.0.0');
432
		$currentVersion = implode('.', \OCP\Util::getVersion());
433
434
435
436
437
		if (version_compare($currentVersion, $installedVersion, '>')) {
			return true;
		}
		return false;
	}
438

439
440
441
442
443
	/**
	 * @param array $disabledApps
	 * @throws \Exception
	 */
	private function upgradeAppStoreApps(array $disabledApps) {
444
		foreach($disabledApps as $app) {
445
446
447
			try {
				if (OC_Installer::isUpdateAvailable($app)) {
					$ocsId = \OC::$server->getConfig()->getAppValue($app, 'ocsid', '');
448

449
450
451
452
453
					$this->emit('\OC\Updater', 'upgradeAppStoreApp', array($app));
					OC_Installer::updateAppByOCSId($ocsId);
				}
			} catch (\Exception $ex) {
				$this->log->logException($ex, ['app' => 'core']);
454
455
456
			}
		}
	}
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484

	/**
	 * Forward messages emitted by the repair routine
	 */
	private function emitRepairEvents() {
		$dispatcher = \OC::$server->getEventDispatcher();
		$dispatcher->addListener('\OC\Repair::warning', function ($event) {
			if ($event instanceof GenericEvent) {
				$this->emit('\OC\Updater', 'repairWarning', $event->getArguments());
			}
		});
		$dispatcher->addListener('\OC\Repair::error', function ($event) {
			if ($event instanceof GenericEvent) {
				$this->emit('\OC\Updater', 'repairError', $event->getArguments());
			}
		});
		$dispatcher->addListener('\OC\Repair::info', function ($event) {
			if ($event instanceof GenericEvent) {
				$this->emit('\OC\Updater', 'repairInfo', $event->getArguments());
			}
		});
		$dispatcher->addListener('\OC\Repair::step', function ($event) {
			if ($event instanceof GenericEvent) {
				$this->emit('\OC\Updater', 'repairStep', $event->getArguments());
			}
		});
	}

485
}
486