[4.0][GSoC 2018] Improve Override Management

[anuragteapot]

With the Google Summer of Code 2018 project Improve override management, we improved the template manager in Joomla! 4. We added a diff view in the override editor. We want to make it possible for every backend user who is allowed to use template manager to see if a template override file is changed during an update. So users can see possible changes in a diff view and decide, if they want to use this changes in there own override file, too.

This is especially important when the changes are security-related.

Features

1. Diff View
2. Override - Quick Icon Notification Plugin
3. Installer - Override Plugin
4. Updated - Overrides history list.

Summary of Changes

Most of the changes done in com_templates component, added two new plugins first to check updated files after the update and for the quick icon notification.
Added diff view of the core and override file so you can see the changes or difference between both the files.
Added new tab to show updated override file list and you can see which files got an update and then you can change your override according to new changes in core.

What type of problem is going to solve ?
like if I created the override of any extension then our frontend always use override file instead of the core, and then after few days some important bug is fixed or some new changes in functions in an update
of that extension then it's not good for the user because now this application creates an issue.

So, using this user can check new updated file changes and feel good :)

Testing Instructions

Video: https://www.youtube.com/watch?v=l0_jFjswObI
For this, you need an extension which has an update with new changes in extension files.
So,

You can use these components
com_helloworld.0.0.1 https://www.dropbox.com/s/106cgn1lclp9dxm/com_helloworld.0.0.1.zip?dl=0
com_helloworld.0.0.2 https://www.dropbox.com/s/xhl8p0nz3wdvapj/com_helloworld.0.0.2.zip?dl=0

1. Download this branch/PR then install fresh Joomla using this branch/PR.
2. Go to the template manager.
3. Create an override of that extension before the update.
4. See the diff view of that file by using a toggle button in the top right corner. ** Expected:** No difference.
5. Now update your extension. ** Expected:** If your created override file got any update in core you can see notification message number of files updated.
6. Go to template manager check new tab you can see which files are updated.
7. Click on the name of the file you will get redirect to edit view of that file.
8. Now you can see the changes in diff view.
9. Adjust your override file if you want and then you can delete that file list history or mark as checked.

Documentation Changes Required

Repo https://github.com/joomla-projects/gsoc18_override_management/
Documentation https://docs.joomla.org/J4.x:Improved_Override_Management

Mentors: @astridx @laoneo

[astridx]

@richard67 Thank you very much for explaining. But I did this. Nevertheless I was not able to select the gsoc branch from Anu1601CS.

[richard67]

@Anu1601CS Oh, seems I missed that. Sorry. All ok.

[anuragteapot]

I found something else to change. (I want to create a PR, but it was not possible for me. I did not see your local repo and branch as a base fork and I do not know how to achieve that.).
Please delete line 184 and change line 185 (https://github.com/joomla/joomla-cms/pull/21851/files#diff-ae4af84085ee35437e316b7653830bc0R184) to
$this->app->enqueueMessage(Text::plural('PLG_INSTALLER_N_OVERRIDE_FILE_UPDATED', $num), 'notice');

@astridx
Current condition is like this

but according to your suggested changes it looks liks

So, i thought to make number background white to make number clear and good.

[richard67]

@astridx As I wrote you have to be in Anu1601CS's repository. But your screenshot shows you are in the core (joomla) repository. There is it normal that some user repositories are not found for selecting the base.
But if you go to https://github.com/Anu1601CS/joomla-cms/, then select there the gsoc branch, and then navigate to the file and edit it in the browser it works.
.

[richard67]

To the maintainers: My test is still valid because since then only CS changes.

---

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

[astridx]

@Anu1601CS
I think you need to put the html for making the number nice into the language string. If I am right, you need to use a number as second parameter in the function plural:

joomla-cms/libraries/src/Language/Text.php

Line 198 in 7fa1893

public static function plural($string, $n)

[brianteeman]

I did comment earlier about switching to plural strings - the markup for styling the number should not however go in the language string if at all possible

[astridx]

@brianteeman Sorry, I could not find your earlier comment. So it is OK use a string as second parameter of this function?

[richard67]

@astridx @brianteeman 's comment is there: #21851 (comment). Is hard to find because initially hidden by GitHub because of very long comment history of this PR.

[astridx]

@richard67
Thank you very much.
First: I have to take a closer look to creating a PR against the branch of another PR.
Second: I searched for "plural". So I could not find it via search.

@brianteeman In this comment you have suggested using plural, right? The function plural have to be given a number as a second parameter. How can we add html, if we should not do it via language string? I found no example ...

[infograf768]

Please do not add any html in a plural string.
It is perfectly OK if the number, which can be literal in the case of 1, i.e. for example in French

COM_REDIRECT_N_LINKS_UPDATED="%d liens mis à jour."
COM_REDIRECT_N_LINKS_UPDATED_1="Un lien a été mis à jour"

is not specifically formatted as it is anyway in a phrase.
It would make it more complex than necessary.

Note: the way you did it "would" be the way to go, but I am not sure we should anyway have html in that kind of file.

$span = '<span class="badge badge-light">' . $num . '</span>';
$this->app->enqueueMessage(Text::plural('PLG_INSTALLER_N_OVERRIDE_FILE_UPDATED', $span), 'notice');

[laoneo]

I would say, that after the language strings cleanup is done. We merge it and then we can finalize further issues directly in this repo. Or are there any more blockers detected?

[brianteeman]

@laoneo agreed

[astridx]

To the maintainers: My test is still valid because since then only one change that I have suggested have occurred. At the time, I also tested these changes.

[laoneo]

Thank you very much @Anu1601CS and @astridx. You guys did an awesome job!! And of course to the whole GosC team who helped whenever we have been struggling.

[anuragteapot]

Thank you very much @astridx @laoneo @brianteeman @richard67 @zero-24 @Quy
For the review and reading such a huge code and finding my mistakes :)

[infograf768]

small typo:
#22024