[4.0] Show changelog - GSoC Expand Extensions Manager

[NunoLopesPT]

Introduction

At this time, users have to look for external sources of information about changes in an extension, when they are going to update their extensions. In most cases, users install an extension without checking the changelog due to the difficulty to find the associated changelog. With this new feature, users can review the changelog of the extensions when they are about to install an update (granted that the changelog is provided by the extension's developer), and after the extension is installed.

Summary of Changes

Added a new parameter on the xml updateserver files 'changelogurl' and adding it to #__updates table.

Testing Instructions

I made some changes in the core databases so before testing you should fix your database:

Extensions -> Database -> Fix
Extensions -> Updates -> Find Updates

Update View

Install my component: https://github.com/NunoLopes96/component_joomla
By default you will have always an update from 0.0.2 to 4.0.0 just for testing

If the changelog is not available it will show N/A like in the Folder column

It will open a modal with an iframe of the changelogurl in the body.
The title of the modal is version ' - ' component_name

Manage View

The changelogurl is supported for Components, Libraries, Modules, Plugins and Packages, you just need to add tags in your instalation xml with a valid url inside.

To test this you can use these modified packages:

(To test Package, Component, Module, Plugin)
pkg_weblinks_3.4.1-changelog.zip

(To test Libraries)
lib_fof30-3.1.0-changelog.zip

(To test languages)
The language installer its diferent from the others so you may want to test 2 cases:
1-Install without having it already in your extensions
2-Install without changelogurl and then install again with a changelogurl

This happens because it has 1 function to install and another one to update ( they are similar )

admin_pt-PT.zip
Extension name: Português (pt-PT)

(To test templates)
et_kidtoy_joomla_template_install_package_free.zip
Extension name: etkidtoy

(To test Files)
cli2zoombie.zip
Extension name: Zoombie - CLI Application

Expected result

In Updates View you will have a new column that will show a changelog button to open a modal if there is a changelogurl in the #__updates table.
In Manage View you will have an tag in the version with a info icon on the right side if your extension has a changelogurl in the #__extensions table.

Documentation Changes Required

Add changelogurl parameter on updatesite information and in extension

[roland-d]

I have started to bring this PR inline with the 4.0-dev codebase and work out the issues and improve the featureset.

I am sure @Quy will help me with codestyle :) Now I also need help with styling the modal containing the updates. Have a look at this:

This contains all the possible sections that are available. @ciar4n is this something you can help me with?

As for the changelog.xml I am now using this format, any feedback for this is appreciated as well.

<?xml version="1.0" encoding="utf-8"?>
<changelogs>
    <changelog>
        <element>com_lists</element>
        <type>component</type>
        <version>0.0.4</version>
	<entries>
        <security>
            <item>CVE 1</item>
            <item>CVE 2</item>
        </security>
        <fix>
            <item>FIX 1</item>
            <item>FIX 2</item>
        </fix>
        <language>
            <item>LANG 1</item>
            <item>LANG 2</item>
        </language>
        <addition>
            <item>ADD 1</item>
            <item>ADD 2</item>
        </addition>
        <change>
            <item>CHANGE 1</item>
            <item>CHANGE 2</item>
        </change>
        <removed>
            <item>REMOVE 1</item>
            <item>REMOVE 2</item>
        </removed>
        <note>
            <item>NOTE 1</item>
            <item>NOTE 2</item>
        </note>
</entries>
    </changelog>
</changelogs>

This PR is not ready yet but I would appreciate feedback already so we can get this into a ready state.

[brianteeman]

why is this _LANGUAGE ?? or is it the "Changelog" that is wrong?

[roland-d]

It is actually "Changelog" that is wrong. This needs to be "Language" as it is about language file changes listed in the changelog.

[brianteeman]

Thanks

[brianteeman]

please namespacce JLog

+use Joomla\CMS\Log\Log;

[Quy]

Change to 10

[Quy]

Sort keys in alpha order

[roland-d]

@Quy What is not sorted here? CA is before CH.

[Quy]

Sort keys from lines 10 - 16.

[roland-d]

All done.

[Quy]

No need to be in else statement.

[Quy]

Add space before :

[Quy]

Add space before :

[Quy]

Add space before and after :

[Quy]

Add space before and after :

[Quy]

Add ; and space

[wilsonge]

I don't think you need the type in your schema. This living on a foreign server where you are already matching against the element so I don't see what value it's providing?

Additionally I think we only need fix and note - not change - they should be covered by the other things

[roland-d]

@wilsonge The reason the type is there is because we have it that way in the update XMLs as well. The only reason I took it as well is because I figured we can use it for better checking we have the correct type.

Additionally I think we only need fix and note - not change - they should be covered by the other things

As an extension developer I use all of them to clearly identify where the entry belongs to. Each has their own merit to me at least. I don't see any harm in offering them, extension developers don't have to use them of course. They are there for those who want to use more distinction.

[brianteeman]

Agree with roland - hardly changelog without listing any changes ;)

[roland-d]

Closing this as I can't push to the repo anymore. Continuing in #24026