Feature PR-5.3-dev Pending

User tests: Successful: Unsuccessful:

avatar BrainforgeUK
BrainforgeUK
6 May 2025

Allow update server administrator to return a message to the Joomla admin.

Pull Request for Issue # .

Summary of Changes

Add a preupdatemessage field to the XML returned by the update server.

Testing Instructions

Install test plugin:
https://www.brainforge.co.uk/media/extra_downloads/test/test.zip

Check for updates and the test plugin will appear.
Tick the box and run update.
In this example a simple error message will appear and the update aborted.
... a warning / information message could been used instead.

Actual result BEFORE applying this Pull Request

Update works as expected - although the version number is unchanged!
So it only temporarily disappears from the available update list.

Expected result AFTER applying this Pull Request

Error message displayed and the update does not happen.

The benefit of this is that an update server manager can send a message to the Joomla administrator.
e.g. 'Please contact us.'

The following documentation requires updating:
https://manual.joomla.org/docs/building-extensions/install-update/update-server/
See file: https://www.brainforge.co.uk/media/extra_downloads/test/updatetest.xml

Link to documentations

Please select:

  • Documentation link for docs.joomla.org:

  • No documentation changes for docs.joomla.org needed

  • Pull Request link for manual.joomla.org:

  • No documentation changes for manual.joomla.org needed

avatar BrainforgeUK BrainforgeUK - open - 6 May 2025
avatar BrainforgeUK BrainforgeUK - change - 6 May 2025
Status New Pending
avatar joomla-cms-bot joomla-cms-bot - change - 6 May 2025
Category Administration com_installer
avatar QuyTon
QuyTon - comment - 6 May 2025
avatar BrainforgeUK BrainforgeUK - change - 6 May 2025
Labels Added: PR-5.3-dev
7e90539 7 May 2025 avatar QuyTon cs
avatar richard67 richard67 - change - 9 May 2025
Title
Update UpdateModel.php
[5.3] Allow update server administrator to return a message to the Joomla admin.
avatar richard67 richard67 - edited - 9 May 2025
avatar SniperSister
SniperSister - comment - 10 May 2025

I would like to see a strip_tags being applied to the message, to make sure that devs don't start to inject HTML tags into those messages -> XSS

avatar BrainforgeUK BrainforgeUK - change - 11 May 2025
Labels Added: Feature
avatar BrainforgeUK
BrainforgeUK - comment - 11 May 2025

Good idea adding strip_tags.
Also added message to avoid a silent failure.

avatar QuyTon
QuyTon - comment - 11 May 2025
avatar richard67
richard67 - comment - 11 May 2025

As it's a new feature it can't go into 5.3-dev. It has to be moved to either 5.4-dev or 6.0-dev. We discuss that and come back with a decision.

avatar BrainforgeUK
BrainforgeUK - comment - 11 May 2025

I suggest 5.4-dev as too much else going on with 6.0.dev

Add a Comment

Login with GitHub to post a comment