Component Framework/Setup: Make Setup handle Legacy Plugins

1 Initial Problem

With the (Project) Component Revision the distinction between core components and plugins will vanish from the code. All components, core components and plugins alike, will be will be handled the same. To make this happen, plugins will need to be moved to the new infrastructure, just as we did with the core components. To give some time to transition, ILIAS should be able to handle old style plugins and new plugins for a while.

2 Conceptual Summary

• ILIAS will be able to handle old style plugins for ILIAS 10, but will remove according infrastructure for ILIAS 11.
• The options for separate handling of plugins in the setup will be renamed:
  • "--no-plugins" will be renamed to "--no-legacy-plugins"
  • "--plugin" will be renamed to "--legacy-plugin"
  • "--skip" will be renamed to "--skip-legacy-plugin"
• Only legacy plugins will receive special treatment by the setup, new style plugins that integrate into the component framework will be treated just as other components.

3 User Interface Modifications

3.1 List of Affected Views

• cli/setup.php will be affected

3.2 User Interface Details

• options will be renamed as described

3.3 New User Interface Concepts

Not applicable.

3.4 Accessibility Implications

There will be some additional mental load for people using the setup.php: What's a "legacy" plugin? What's a normal plugin? Hence, documentation will need to be adjusted accordingly.

4 Technical Information

None.

5 Privacy

None

6 Security

As this will blur the line between plugins and core components, as intended by the (Project) Component Revision, administrators might need to adjust their understanding of the sources of their code. As for the dependencies in ILIAS, it is important for administrators to understand who supplies which code to look into implications for the security of their installations. Before the change, code that is not supplied by the ILIAS community was to be found in Customizing. After change, all code is listed under "./components" and further separated into one directory per vendor.

7 Contact

• Author of the Request: Richard Klees
• Maintainer: Richard Klees
• Implementation of the feature is done by: CaT ILIAS Team

8 Funding

If you are interest in funding this feature, please add your name and institution to this list.

• …

9 Discussion

JourFixe, ILIAS [jourfixe], 04 MAR 2024: We highly appreciate this suggestion and schedule the feature for ILIAS 10. Please create also a abandon request for abondonning legacy plugins with ILIAS 11.

10 Implementation

No surprises, also adjusted some documentation in components/ILIAS/setup_/README.md already.

Test Cases

Test cases adjusted at 2024-10-09 by Klees, Richard [rklees]

• 42407 : Installation of a plug-in without own setup integration
• 42408 :  Installing a plug-in with its own setup integration 
• 42409 : Exclusion of plug-ins via option 
• 42410 : Plugin exclusion via plugin.php 
  

Privacy

No PRIVACY.md currently exists.

Approval

Approved at 2024-10-09 by Klees, Richard [rklees].