Locator.php

Go to the documentation of this file.

<?php
 
namespace Elgg\Upgrade;
 
use Elgg\Database\Plugins;
use Elgg\Exceptions\InvalidArgumentException;
use Elgg\Includer;
use Elgg\Project\Paths;
 
class Locator {
 
    public function __construct(protected Plugins $plugins) {
    }
 
    public function locate() {
        $pending_upgrades = [];
 
        // Check for core upgrades
        $core_upgrades = Includer::includeFile(Paths::elgg() . 'engine/upgrades.php');
 
        foreach ($core_upgrades as $class) {
            $upgrade = $this->getUpgrade($class, 'core');
            if ($upgrade) {
                $pending_upgrades[] = $upgrade;
            }
        }
 
        $plugins = $this->plugins->find('active');
 
        // Check for plugin upgrades
        foreach ($plugins as $plugin) {
            $batches = $plugin->getStaticConfig('upgrades');
 
            if (empty($batches)) {
                continue;
            }
 
            $plugin_id = $plugin->getID();
 
            foreach ($batches as $class) {
                $upgrade = $this->getUpgrade($class, $plugin_id);
                if ($upgrade) {
                    $pending_upgrades[] = $upgrade;
                }
            }
        }
 
        return $pending_upgrades;
    }
 
    public function getUpgrade(string $class, string $component_id): \ElggUpgrade {
        $batch = $this->getBatch($class);
 
        $version = $batch->getVersion();
        $upgrade_id = "{$component_id}:{$version}";
 
        $upgrade = $this->upgradeExists($upgrade_id);
 
        if (!$upgrade) {
            $upgrade = elgg_call(ELGG_IGNORE_ACCESS, function () use ($upgrade_id, $class, $component_id, $version) {
                // Create a new ElggUpgrade to represent the upgrade in the database
                $upgrade = new \ElggUpgrade();
 
                $upgrade->id = $upgrade_id;
                $upgrade->class = $class;
                $upgrade->save();
 
                return $upgrade;
            });
        }
 
        return $upgrade;
    }
 
    public function getBatch(string $class, ?\ElggUpgrade $upgrade = null): Batch {
        if (!class_exists($class)) {
            throw new InvalidArgumentException("Upgrade class {$class} was not found");
        }
 
        if (!is_subclass_of($class, Batch::class)) {
            throw new InvalidArgumentException("Upgrade class {$class} should implement " . Batch::class);
        }
 
        return new $class($upgrade);
    }
 
    public function upgradeExists($upgrade_id) {
        return elgg_call(ELGG_IGNORE_ACCESS, function () use ($upgrade_id) {
            $upgrades = \Elgg\Database\Entities::find([
                'type' => 'object',
                'subtype' => 'elgg_upgrade',
                'metadata_name_value_pairs' => [
                    [
                        'name' => 'id',
                        'value' => (string) $upgrade_id,
                    ],
                ],
            ]);
 
            return $upgrades ? $upgrades[0] : false;
        });
    }
 
    public function getUpgradeByClass(string $class_name) {
        return elgg_call(ELGG_IGNORE_ACCESS, function () use ($class_name) {
            $upgrades = \Elgg\Database\Entities::find([
                'type' => 'object',
                'subtype' => 'elgg_upgrade',
                'metadata_name_value_pairs' => [
                    [
                        'name' => 'class',
                        'value' => $class_name,
                    ],
                ],
            ]);
 
            return $upgrades ? $upgrades[0] : false;
        });
    }
}