[4.2] Extension installer script enhancements

[laoneo]

Summary of Changes

This pr adds an interface for the installer script to have a common way for installer actions for extensions. Additionally the extension can use the container for to get dependencies during install operation.

With this new approach the extension developer doesn't have to create a class with a special class name like mod_installer_legacyInstallerScript anymore and has more freedom and flexibility during the install routine. Using the old way is getting deprecated. It is one step further to use injected dependencies.

Examples can be found here:

• Container based script mod_installer_container.zip
• Script based script mod_installer_script.zip
• Legacy script mod_installer_legacy.zip

A script can look like:

<?php

use Joomla\CMS\Application\AdministratorApplication;
use Joomla\CMS\Installer\InstallerAdapter;
use Joomla\CMS\Installer\InstallerScriptInterface;
use Joomla\DI\Container;
use Joomla\DI\ServiceProviderInterface;

return new class () implements ServiceProviderInterface {
    public function register(Container $container)
    {
        $container->set(InstallerScriptInterface::class, new class ($container->get(AdministratorApplication::class)) implements InstallerScriptInterface {
            private $app;

            public function __construct(AdministratorApplication $app)
            {
                $this->app = $app;
            }

            public function install(InstallerAdapter $parent): bool
            {
                $this->app->enqueueMessage('Installed by container!!');
                return true;
            }

            public function update(InstallerAdapter $parent): bool
            {
                $this->app->enqueueMessage('Update by container!!');
                return true;
            }

            public function uninstall(InstallerAdapter $parent): bool
            {
                return true;
            }

            public function preflight(string $type, InstallerAdapter $parent): bool
            {
                return true;
            }

            public function postflight(string $type, InstallerAdapter $parent): bool
            {
                return true;
            }
        });
    }
};

Or return directly an instance of the installer script interface:

<?php
use Joomla\CMS\Factory;
use Joomla\CMS\Installer\InstallerAdapter;
use Joomla\CMS\Installer\InstallerScriptInterface;

return new class () implements InstallerScriptInterface {
    public function install(InstallerAdapter $parent): bool
    {
        Factory::getApplication()->enqueueMessage('Installed by instance!!');
        return true;
    }

    public function update(InstallerAdapter $parent): bool
    {
        Factory::getApplication()->enqueueMessage('Update by instance!!');
        return true;
    }

    public function uninstall(InstallerAdapter $parent): bool
    {
        return true;
    }

    public function preflight(string $type, InstallerAdapter $parent): bool
    {
        return true;
    }

    public function postflight(string $type, InstallerAdapter $parent): bool
    {
        return true;
    }
};

The legacy way is still supported for backwards compatibility.

Testing Instructions

• Install the container module from the link above
• Install the script module from the link above
• Install the legacy module from the link above

Actual result BEFORE applying this Pull Request

• The container module shows no text "Installed by container!!"
• The container module shows no text "Installed by script!!"
• The container module shows text "Installed by legacy!!"

Expected result AFTER applying this Pull Request

• The container module shows text "Installed by container!!"
• The container module shows text "Installed by script!!"
• The container module shows text "Installed by legacy!!"

Documentation Changes Required

Needs to be documented in the docs.

[laoneo]

Thanks @brianteeman

[brianteeman]

sorry drone errors are my fault

[laoneo]

@regularlabs can you test that pr also?

[regularlabs]

I'll try to do that this week...

How does this PR align with the TUF they are currently working on at the hackathon?

[laoneo]

Don't know what a TUF is 🤷‍♂️

[regularlabs]

https://twitter.com/elisasophia/status/1505586120666591239

[regularlabs]

"The Update Framework"

[SniperSister]

TUF would kick in even before the extension package is extracted, so it’s unrelated to the extension installer script.

[dgrammatiko]

I have tested this item ✅ successfully on 3e26ed8

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/37091.}

[regularlabs]

I have tested this item ✅ successfully on 3e26ed8

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/37091.}

[Quy]

RTC

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/37091.}

[roland-d]

@laoneo Could you please update with the base branch? Thank you.

[roland-d]

Thank you everybody

[joeforjoomla]

[joeforjoomla]

It's no longer possible to install any extension after this PR using the legacy script currently working on 4.1
Whats going on there?

[joeforjoomla]

Try to install for example Acymailing or whatever other extension:

[joeforjoomla]

It seems that there is a serious b/c break here. I've found that all functions of the legacy installer script must have an explicit 'return true' otherwise this error is the result.

[drmenzelit]

I can confirm this: fresh installed Joomla 4.2, no able to install extensions

[laoneo]

I'm on it, will come up with a pr soon.

[laoneo]

Can you guys test #37374?

[nikosdion]

My best guess is that would affect core updates, not extension updates. Of course I’ve already talked about that in *checks notes* ah right 2017. Why does it take Joomla 5 years to act on something basic is beyond me but then again it’s Joomla so I’m not even surprised. Anyway, can you check this PR Peter so maybe just maybe we can improve on the crappy, outdates extensions upgrade code since the JED doesn’t actually allow us to use our own update frameworks?

[regularlabs]

I have changed the way my installer works (now using more of Joomla's own manifest capability). So that could hopefully also deal with some issues the new installer ran into.
I will try to test this out next week and see what I find...

[regularlabs]

I have no issues installing my packages on the current nightly build: 4.2.4-dev