phpOMS/Application/ApplicationManager.php

<?php

/**
 * Karaka
 *
 * PHP Version 8.1
 *
 * @package   phpOMS\Application
 * @copyright Dennis Eichhorn
 * @license   OMS License 1.0
 * @version   1.0.0
 * @link      https://karaka.app
 */

declare(strict_types=1);

namespace phpOMS\Application;

use phpOMS\System\File\Local\Directory;
use phpOMS\System\File\PathException;

/**
 * Application manager class.
 *
 * General application managing functionality.
 *
 * @package phpOMS\Application
 * @license OMS License 1.0
 * @link    https://karaka.app
 * @since   1.0.0
 */
final class ApplicationManager
{
    /**
     * Application instance.
     *
     * @var ApplicationAbstract
     * @since 1.0.0
     */
    private ApplicationAbstract $app;

    /**
     * Installed modules.
     *
     * @var array<string, ApplicationInfo>
     * @since 1.0.0
     */
    private array $installed = [];

    /**
     * Constructor.
     *
     * @param ApplicationAbstract $app Application
     *
     * @since 1.0.0
     */
    public function __construct(ApplicationAbstract $app)
    {
        $this->app = $app;
    }

    /**
     * Load info of application.
     *
     * @param string $appPath Application path
     *
     * @return ApplicationInfo
     *
     * @since 1.0.0
     */
    private function loadInfo(string $appPath) : ApplicationInfo
    {
        $path = \realpath($appPath);
        if ($path === false) {
            throw new PathException($appPath);
        }

        $info = new ApplicationInfo($path);
        $info->load();

        return $info;
    }

    /**
     * Install the application
     *
     * @param string $source      Source of the application
     * @param string $destination Destination of the application
     * @param string $theme       Theme
     *
     * @return bool
     *
     * @since 1.0.0
     */
    public function install(string $source, string $destination, string $theme = 'Default') : bool
    {
        $destination = \rtrim($destination, '\\/');
        $source      = \rtrim($source, '/\\');

        if (!\is_dir($source) || \is_dir($destination)
            || !\is_file($source . '/Admin/Installer.php')
        ) {
            return false;
        }

        try {
            $info                                      = $this->loadInfo($source . '/info.json');
            $this->installed[$info->getInternalName()] = $info;

            $this->installFiles($source, $destination);
            $this->replacePlaceholder($destination);

            if (($path = \realpath($destination)) === false) {
                return false; // @codeCoverageIgnore
            }

            $classPath = \substr($path . '/Admin/Installer', (int) \strlen((string) \realpath(__DIR__ . '/../../')));

            // @var class-string<InstallerAbstract> $class
            $class = \str_replace('/', '\\', $classPath);
            $class::install($this->app, $info, $this->app->appSettings);

            return true;
        } catch (\Throwable $t) {
            return false; // @codeCoverageIgnore
        }
    }

    /**
     * Uninstall the application
     *
     * @param string $source Source of the application
     *
     * @return bool
     *
     * @since 1.0.0
     */
    public function uninstall(string $source) : bool
    {
        $source = \rtrim($source, '/\\');
        if (($path = \realpath($source)) === false || !\is_file($source . '/Admin/Uninstaller.php')) {
            return false;
        }

        try {
            $info                                      = $this->loadInfo($source . '/info.json');
            $this->installed[$info->getInternalName()] = $info;

            $classPath = \substr($path . '/Admin/Uninstaller', (int) \strlen((string) \realpath(__DIR__ . '/../../')));

            // @var class-string<UninstallerAbstract> $class
            $class = \str_replace('/', '\\', $classPath);
            $class::uninstall($this->app->dbPool, $info, $this->app->appSettings);

            $this->uninstallFiles($source);

            return true;
        } catch (\Throwable $t) {
            return false; // @codeCoverageIgnore
        }
    }

    /**
     * Re-init application.
     *
     * @param string $appPath App path
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function reInit(string $appPath) : void
    {
        $info = $this->loadInfo($appPath . '/info.json');
        if ($info === null) {
            return;
        }

        if (($path = \realpath($appPath)) === false) {
            return; // @codeCoverageIgnore
        }

        // @var class-string<InstallerAbstract> $class
        $classPath = \substr($path . '/Admin/Installer', (int) \strlen((string) \realpath(__DIR__ . '/../../')));
        $class     = \str_replace('/', '\\', $classPath);

        /** @var $class InstallerAbstract */
        $class::reInit($info);
    }

    /**
     * Get all applications who are providing for a specific module.
     *
     * @param string $module Module to check providings for
     *
     * @return array<string, string[]>
     *
     * @since 1.0.0
     */
    public function getProvidingForModule(string $module) : array
    {
        $providing = [];
        $installed = $this->getInstalledApplications();

        foreach ($installed as $app => $info) {
            if (!isset($providing[$app])) {
                $providing[$app] = [];
            }

            $appProviding = $info->getProviding();
            foreach ($appProviding as $for => $version) {
                if ($for !== $module) {
                    continue;
                }

                $providing[$app][] = $for;
            }
        }

        return $providing;
    }

    /**
     * Get all installed modules.
     *
     * @param bool   $useCache Use Cache
     * @param string $basePath Base path for the applications
     *
     * @return array<string, ApplicationInfo>
     *
     * @since 1.0.0
     */
    public function getInstalledApplications(bool $useCache = true, string $basePath = __DIR__ . '/../../Web') : array
    {
        if (empty($this->installed) || !$useCache) {
            $apps = \scandir($basePath);

            if ($apps === false) {
                return $this->installed; // @codeCoverageIgnore
            }

            foreach ($apps as $app) {
                if ($app === '.' || $app === '..' || !\is_file($basePath . '/' . $app . '/info.json')) {
                    continue;
                }

                $this->installed[$app] = $this->loadInfo($basePath . '/' . $app . '/info.json');
            }
        }

        return $this->installed;
    }

    /**
     * Install the files to the destination
     *
     * @param string $source      Source path
     * @param string $destination Destination of the application
     *
     * @return void
     *
     * @since 1.0.0
     */
    private function installFiles(string $source, string $destination) : void
    {
        Directory::copy($source, $destination);
    }

    /**
     * Uninstall files
     *
     * @param string $source Source path
     *
     * @return void
     *
     * @since 1.0.0
     */
    private function uninstallFiles(string $source) : void
    {
        Directory::delete($source);
    }

    /**
     * Replace placeholder string (application placeholder name)
     *
     * @param string $destination Destination of the application
     *
     * @return void
     *
     * @since 1.0.0
     */
    private function replacePlaceholder(string $destination) : void
    {
        $files = Directory::list($destination, '*', true);
        foreach ($files as $file) {
            if (!\is_file($destination . '/' . $file)) {
                continue;
            }

            $content = \file_get_contents($destination . '/' . $file);
            if ($content === false) {
                continue; // @codeCoverageIgnore
            }

            \file_put_contents($destination . '/' . $file, \str_replace('{APPNAME}', \basename($destination), $content));
        }
    }
}