UpgradeService.php

Go to the documentation of this file.

<?php

namespace Elgg;

use Elgg\Cli\Progress;
use Elgg\Database\Clauses\EntitySortByClause;
use Elgg\Database\Mutex;
use Elgg\I18n\Translator;
use Elgg\Traits\Loggable;
use Elgg\Upgrade\Locator;
use Elgg\Upgrade\Loop;
use Elgg\Upgrade\Result;
use React\Promise\PromiseInterface;
use function React\Promise\all;
use React\Promise\Deferred;
use React\Promise\Promise;

class UpgradeService {

    use Loggable;

    public function __construct(
        protected Locator $locator,
        protected Translator $translator,
        protected EventsService $events,
        protected Config $config,
        protected Mutex $mutex,
        protected SystemMessagesService $system_messages,
        protected Progress $progress
    ) {
    }

    protected function up(): Promise {
        return new Promise(function ($resolve, $reject) {
            Application::migrate();

            if (!$this->events->triggerBefore('upgrade', 'system', null)) {
                return $reject(new \RuntimeException($this->translator->translate('upgrade:terminated')));
            }

            // prevent someone from running the upgrade script in parallel (see #4643)
            if (!$this->mutex->lock('upgrade')) {
                return $reject(new \RuntimeException($this->translator->translate('upgrade:locked')));
            }

            // Clear system caches
            \Elgg\Cache\EventHandlers::disable();
            elgg_clear_caches();

            return $resolve(true);
        });
    }

    protected function down(): Promise {
        return new Promise(function ($resolve, $reject) {
            if (!$this->events->trigger('upgrade', 'system', null)) {
                return $reject(false);
            }

            elgg_invalidate_caches();

            $this->mutex->unlock('upgrade');

            $this->events->triggerAfter('upgrade', 'system', null);

            return $resolve(true);
        });
    }

    protected function runUpgrades($upgrades): PromiseInterface {
        $promises = [];

        foreach ($upgrades as $upgrade) {
            if (!$upgrade instanceof \ElggUpgrade) {
                continue;
            }
            
            $promises[] = new Promise(function ($resolve, $reject) use ($upgrade) {
                try {
                    $result = $this->executeUpgrade($upgrade, 0);
                } catch (\Throwable $ex) {
                    return $reject($ex);
                }

                if ($result->getFailureCount()) {
                    $msg = elgg_echo('admin:upgrades:failed', [
                        $upgrade->getDisplayName(),
                    ]);

                    return $reject(new \RuntimeException($msg));
                }
                
                return $resolve($result);
            });
        }

        return all($promises);
    }

    public function run($upgrades = null): PromiseInterface {
        // turn off time limit
        set_time_limit(3600);

        $deferred = new Deferred();

        $promise = $deferred->promise();

        $resolve = function ($value) use ($deferred) {
            $deferred->resolve($value);
        };

        $reject = function ($error) use ($deferred) {
            $deferred->reject($error);
        };

        if (!isset($upgrades)) {
            $upgrades = $this->getPendingUpgrades(false);
        }

        $this->up()->then(
            function () use ($resolve, $reject, $upgrades) {
                all([
                    $this->runUpgrades($upgrades),
                ])->finally(
                    function () use ($resolve, $reject) {
                        $this->down()->then(
                            function ($result) use ($resolve) {
                                return $resolve($result);
                            },
                            $reject
                        );
                    },
                    $reject
                );
            },
            $reject
        );

        return $promise;
    }

    public function getPendingUpgrades(bool $async = true): array {
        $pending = [];

        $upgrades = $this->locator->locate();

        foreach ($upgrades as $upgrade) {
            if ($upgrade->isCompleted()) {
                continue;
            }

            $batch = $upgrade->getBatch();
            if (!$batch) {
                continue;
            }

            $pending[] = $upgrade;
        }

        if (!$async) {
            $pending = array_filter($pending, function(\ElggUpgrade $upgrade) {
                return !$upgrade->isAsynchronous();
            });
        }

        return $pending;
    }
    
    public function getCompletedUpgrades(bool $async = true): array {
        // make sure always to return all upgrade entities
        return elgg_call(
            ELGG_IGNORE_ACCESS | ELGG_SHOW_DISABLED_ENTITIES | ELGG_SHOW_DELETED_ENTITIES,
            function () use ($async) {
                $completed = [];
                
                $order_by_completed_time = new EntitySortByClause();
                $order_by_completed_time->direction = 'DESC';
                $order_by_completed_time->property = 'completed_time';
                
                $upgrades = elgg_get_entities([
                    'type' => 'object',
                    'subtype' => 'elgg_upgrade',
                    'metadata_name' => 'class', // filters old upgrades
                    'metadata_name_value_pairs' => [
                        'name' => 'is_completed',
                        'value' => true,
                    ],
                    'order_by' => $order_by_completed_time,
                    'limit' => false,
                    'batch' => true,
                ]);
                /* @var $upgrade \ElggUpgrade */
                foreach ($upgrades as $upgrade) {
                    $batch = $upgrade->getBatch();
                    if (!$batch) {
                        continue;
                    }
        
                    $completed[] = $upgrade;
                }
        
                if (!$async) {
                    $completed = array_filter($completed, function(\ElggUpgrade $upgrade) {
                        return !$upgrade->isAsynchronous();
                    });
                }
        
                return $completed;
            }
        );
    }

    public function executeUpgrade(\ElggUpgrade $upgrade, ?int $max_duration = null): Result {
        // Upgrade also disabled data, so the compatibility is
        // preserved in case the data ever gets enabled again
        return elgg_call(
            ELGG_IGNORE_ACCESS | ELGG_SHOW_DISABLED_ENTITIES | ELGG_SHOW_DELETED_ENTITIES,
            function () use ($upgrade, $max_duration) {
                return $this->events->triggerResultsSequence('upgrade:execute', 'system', ['object' => $upgrade], null, function() use ($upgrade, $max_duration) {
                    $result = new Result();
                    
                    $loop = new Loop(
                        $upgrade,
                        $result,
                        $this->progress,
                        $this->getLogger()
                    );
                    
                    $loop->loop($max_duration);
                    
                    return $result;
                });
            }
        );
    }
}