Next steps to v5

[peterpp]

As many of you may have noticed, I merged the version5 branch into the main as we are getting closer to the v5 release. We also have the very first official Docker image 🎉 What more do we need? I could spend endless time with further refactoring, polishing, merging features from recent Adminer versions, testing, fixing, staring at the stars in the sky...

Let's finish the first chapter of this rollercoaster ride. I would like to analyze and implement the last two things:

• Simplification of plugins configuration. Adminer introduced a new way of loading plugins that I honestly don't like very much. But the key part, that I do like, is eliminating direct use of the mediating class (Pluginer in our case).
• Autologin / 3rd party login options.

And that's all 😉

[peterpp]

Support for 3rd party login along with autologin is implemented in the new ExternalLoginPlugin. So this is done ✅

[peterpp]

I also prepared simplified configuration and plugins setup in new-admin-setup branch. It is very similar to what Adminer has, with two differences:

• All plugins have to be enabled explicitly. I consider it less confusing.
• Custom object derived from the Admin class can be also defined in autoloaded file.

Configuration

Configuration can be defined in adminneo-config.php file placed in the AdminNeo's current working directory.

– adminneo.php
– adminneo-config.php

The file adminneo-config.php will just return the configuration array:

<?php

// Define configuration.
return [
    "colorVariant" => "green",
];

Plugins

Plugins can be placed into the adminneo-plugins folder. All plugins in this folder will be autoloaded (but not enabled).

- adminneo-plugins
    - JsonPreviewPlugin.php
    - XmlDumpPlugin.php
    - FileUploadPlugin.php
    - ...
- adminneo.php
- adminneo-plugins.php

adminneo-plugins.php:

<?php
  
// Enable plugins. Files in `adminneo-plugins` are autoloaded, so including the source files is not necessary.
return [
    new \AdminNeo\JsonPreviewPlugin(),
    new \AdminNeo\XmlDumpPlugin(),
    new \AdminNeo\FileUploadPlugin("data/"),
    // ...
];

Custom Admin class

- adminneo.php
- adminneo-instance.php

adminneo-instance.php:

<?php
class CustomAdmin extends \AdminNeo\Admin
{
    public function getServiceTitle(): string
    {
        return "Custom Service";
    }
}

// Use factory method to create CustomAdmin instance.
return CustomAdmin::create();

Custom index.php

The old way.

<?php

function adminneo_instance() 
{
    class CustomAdmin extends \AdminNeo\Admin
    {
        public function getServiceTitle(): string
        {
            return "Custom Service";
        }
    }

    // Define configuration.
    $config = [
        "colorVariant" => "green",
    ];
    
    // Enable plugins.
    $plugins = [
        new \AdminNeo\JsonPreviewPlugin(),
        new \AdminNeo\XmlDumpPlugin(),
        new \AdminNeo\FileUploadPlugin("data/"),
        // ...
    ];
	
    // Use factory method to create Admin instance.
    return CustomAdmin::create($config, $plugins);
}

// Include AdminNeo file.
include "/non-public-path/adminneo.php";

(I renamed create_adminneo() function to the prefixed version adminneo_instance() to be consistent with adminneo-instance.php file.

Any thoughts or complains? 😉

[peterpp]

Merged to the main branch.

[peterpp]

And one more thing. I'm reconsidering PHP 5 support. It is a prehistory for me, but Jakub trod the path in Adminer. He bumped PHP to 7.4 in the source code and implemented a conversion to PHP 5 during compilation into the single file. Our situation is more complicated because I use more language features than just strict typing, which can be stripped relatively easily. But I think it can be done and we can go down to PHP 5.6, maybe even to 5.4.

So what do you think? Would it be worth it?

I can imagine that people like @adrianbj will be happy, but maybe also a little bit angry. Because the public interface of the Admin class will be changed... again 🤦‍♂️ It is important to make this decision now, because it would be quite messy in future versions.

[adrianbj]

It would definitely simplify my life if compilation to PHP 5 was implemented. It would also mean all the great new features and design would be available to those using PHP 5 - at the moment I am having to fallback to AdminNeo 4 with your old custom theme (which is still pretty good, but not as good as the new default theme).

Regarding plugin autoloading - I don't really care either way - manual hasn't been a problem and has allowed for some flexibility in my case where I am loading different version of plugins (and different plugins like AdminerTableHeaderScroll) for v4 vs v5, but if you take the compilation to PHP5 route, then this won't be needed anyway.

[peterpp]

I wonder, why do you need PHP 5 support? And with version exactly? Because ProcessWire officially supports PHP 7+.

[adrianbj]

That change to 7.1+ for PW is quite recent. Until then it was 5.4.4 and I still have that version listed as the minimum requirement for my PW TracyDebugger implementation (which has my custom Adminer/neo panel). Perhaps it's time to move on (personally I am running PHP 8.4 everywhere), but there might be some users out there who can benefits from improvements/security updates to my module and Adminer/neo but for some reason can't upgrade their version of PHP.

I suppose it really depends on how much work it is for you to get the compilation to work.

[peterpp]

I report success, compiled version now supports PHP 5.4+ 😎 I did basic tests on PHP 5.6 and it looks good. I have no option to install lower PHP versions in my testing environment. Even official Docker image for PHP 5.4 no longer works.

Small limitations:

• Custom password defined in defaultPasswordHash config option requires PHP 5.5. With PHP 5.4, it is only possible to disable the password.
• MongoDB driver requires PHP 7.0.

Implementation is in php-5 branch.

[adrianbj]

Thanks @peterpp - unfortunately I don't have a 5.x anything to test on.

[peterpp]

Branch php-5 is merged into the main.

I've also made a few changes to the compilation:

• Compiled files are saved into the compiled subdirectory for better naming consistency.
• Command php bin/compile.php default will include ALL color variants. (I removed + wildcard character.)
• The compilation script also rewrites all plugins for PHP 5 compatibility. They are saved into the compiled/adminneo-plugins directory.

@adrianbj, @devinemke, @wintstar and others, could you check that compiled version is working for you, please?

[adrianbj]

@peterpp - looks great at my end - thanks so much for this - I've been able to remove a lot of conditional logic and old legacy plugins and themes.

[wintstar]

No problems

***@hp-highway:~/websites/html/adminneo5$ php bin/compile.php mysql,pgsql de,en default
project:   admin
drivers:   mysql, pgsql
languages: de, en
themes:    default-blue, default-green, default-red
config:    no
output:    compiled/adminneo.php (402515 B)
****@hp-highway:~/websites/html/adminneo5$ 

The dir "adminneo-plugins" was created.

New german translate
%s und %s müssen ein mit der Methode %s erstelltes Objekt zurückgeben.

Great work. Many thanks

[devinemke]

all good. @peterpp thanks for all of your hard work on this.

php bin/compile.php mysql en ./compiled/config.json

project:   admin
drivers:   mysql
languages: en
themes:    default-blue
config:    yes
output:    compiled/adminneo-mysql-en.php (304636 B)

[peterpp]

I have restored the automated Katalon tests inherited from Adminer 4 and they all pass in both development and compiled AdminNeo on PHP 5.6 up to 8.4. It looks like we have a release candidate here 😉