Display a warning whenever an menu item's alias has changed #13856

marrouchi · 2017-02-02T15:23:57Z

Display a warning message whenever a menu item's alias has been updated. The message suggests to the admin user to create a new redirection to the old alias in order to avoid 404 errors from existing urls.

Pull Request for Issue #13851.

Summary of Changes

Added two methods to the redirect plugin:

onContentbeforeSave : Check if the menu item's alias has changed. If it's the case, then display a warning message that suggests to the admin user to create a redirection to the old alias.
onContentPrepareForm : Alter menu item edit form whenever there's GET params (old_alias & new_alias) in order to set default values for the fields old_url & new_url

An enable/disable field (Watch Alias) has been added to the plugin config form if there's need a disable this feature.

Testing Instructions

First, make sure that the redirect plugin is enabled.

When enabled :

Edit an existing menu item and change the alias. Then hit the Save button.
A warning message should be displayed that says : "You should create a new redirection to avoid 404 errors that could be generated by the old alias's urls : Create a new redirection"
Click on the link Create a new redirection and you should be redirected to a new redirection form with the two fields old_url & new_url filled with default values. Hit the Save button.
Access the old URL in frontend (that uses the old alias) and you should be redirected to the new one.

When disabled :

Go the redirect plugin config form and disable Watch Alias
Back to the menu manager, Edit an existing menu item and change the alias. Then hit the Save button.
There will be no warning message.

Documentation Changes Required

No.

tonypartridge · 2017-02-02T15:32:37Z

@marrouchi great minds think a like ;-) I just created an issue today about this

issue #13851

I was thinking of going one step further and auto-creating the redirect if a user wishes. I'll run some tests on this.

marrouchi · 2017-02-02T15:36:24Z

@tonypartridge Yes i saw your issue and i've coded a PR right away :)

tonypartridge · 2017-02-02T15:39:14Z

@marrouchi I am just wondering if a plugin is needed. Can we not just adjust the com_menus component? Since the plugin is called on every save when it is only needed on a menu item save.

marrouchi · 2017-02-02T15:46:20Z

I thought of this approach would be better to keep the menu item controller clean, since this feature is related to two components (com_menus & com_redirect).

tonypartridge · 2017-02-02T15:49:09Z

I see your point completely, but it's then a plugin which is also then still requires both components. But both components ship with the core.

@zero-24 @mbabker what are your thoughts on this?

I was thinking of checking if com_redirects plugin is enabled and if so basically doing what Marrouchi has done. But within the component controller opposed to a plugin?

mbabker · 2017-02-02T15:50:03Z

Why not throw it in the existing redirect plugin? The notice seems like a good idea to me and that plugin already has to be active to make use of the system, so...

tonypartridge · 2017-02-02T15:54:51Z

Duhh good idea! @mbabker

@marrouchi do you want to do the changes?

marrouchi · 2017-02-02T15:55:16Z

Yes good idead ! Should i create a new PR ?

tonypartridge · 2017-02-02T15:56:13Z

I don't think so? Just remove this plugin from your GIT and add the changes to the system and push your changes they should come through for us to review again.

ghost · 2017-02-02T16:13:45Z

One should only get a message or action link (whatever) if sef is enabled.
And there should be an option in the plugin to deactivate this feature completely, please. Because of other extensions that also deal with aliases.

tonypartridge · 2017-02-02T16:19:53Z

I disagree re see as some people might disable it on testing environments when doing something or other. But an option to disable it is a good idea.

…

On 2 Feb 2017, 16:14 +0000, bertmert ***@***.***>, wrote: One should only get a message or action link (whatever) if sef is enabled. And there should be an option in the plugin to deactivate this feature completely, please. Because of other extensions that also deal with aliases. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub (#13856 (comment)), or mute the thread (https://github.com/notifications/unsubscribe-auth/ABVglvCy8DrGyuHBsTeH68yfez9HNSaZks5rYgDAgaJpZM4L1Pd0).

… updated (using the redirect plugin).

marrouchi · 2017-02-02T17:22:54Z

Done ! I've added a enable/disable button of this features in the redirect plugin config form.

Ready to test 👍

ghost · 2017-02-02T17:46:23Z

I have tested this item 🔴 unsuccessfully on 429b80d

Point 1-3 of Testing Instructions works.

Not working Point 4: Using old Url get redirected on Homepage. Using modern Router.

Another Point: If User have Redirect-Plugin disabled, they got no Hint.

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

marrouchi · 2017-02-02T19:28:50Z

@franz-wohlkoenig This PR does not alter the redirection mechanism. Redirection does not seem to work when modern routing is enabled and that's an new issue that must be addressed. To confirm this, please revert the patch and try a redirection when having modern routing enabled.

ghost · 2017-02-04T08:02:18Z

Test on legacy Router, Plugin "Redirect" enabled.

Got on Point 4 (using old alias using-joomla) a 404 Category not found. Category is enabled, in Plugin is a new, disabled Link index.php/using-joomla without new URL.

Test on:

Joomla! 3.7.0-beta1
macOS Sierra, 10.12.3
Firefox 50.1.0
PHP 7.0.4
MySQLi 5.5.53-0

brianteeman · 2017-09-09T14:26:49Z

Can you look at resolving the conflicts so that this can be tested please.

raoulyemetio · 2018-07-23T11:17:49Z

I have tested this item 🔴 unsuccessfully on b9ac171

I apply the patch, watch alias was enabled
then i changed an existing menu item
but i got no warning message
@icampus

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

coolcat-creations · 2018-07-23T11:32:27Z

I have tested this item 🔴 unsuccessfully on b9ac171

I would love to have this feature, but i had an error on testing.

0 Using $this when not in object context
/Applications/MAMP/htdocs/joomla-cms/libraries/src/Application/CMSApplication.php:369

@YEMETIO if you restest later open the plugin and save the settings

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

fatmaakay · 2018-07-23T13:22:59Z

I have tested this item ✅ successfully on b9ac171

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

fatmaakay · 2018-07-23T13:23:39Z

I have tested this item ✅ successfully on b9ac171

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

durubayram · 2018-07-23T13:23:45Z

I have tested this item ✅ successfully on b9ac171

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

ghost · 2018-07-23T13:25:31Z

Ready to Commit after two successful tests considering 2 unsuccessful tests so Maintainers have to decide (as always).

durubayram · 2018-07-23T14:07:54Z

I have tested this item 🔴 unsuccessfully on b9ac171

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

brianteeman · 2018-07-23T14:10:18Z

please remove the rtc status

Quy · 2018-07-23T14:12:04Z

Removed RTC

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

fatmaakay · 2018-07-23T14:16:14Z

I have tested this item 🔴 unsuccessfully on b9ac171

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

coolcat-creations · 2018-07-23T14:43:43Z

@marrouchi
Can you change the Line I reviewed, and fix the Code Style for 3.8 ?

Would be great to have this watcher also on trashing and on unpublishing the item.
Thank you for this great addition.

Quy · 2018-07-23T14:50:27Z

plugins/system/redirect/redirect.php

+	 * @return  boolean   true if function not enabled, is in frontend or is new. Else true or
+	 *                    false depending on success of save function.
+	 *
+	 * @since   1.6


Change to __DEPLOY_VERSION__

Quy · 2018-07-23T14:50:38Z

plugins/system/redirect/redirect.php

+	 *
+	 * @return  boolean
+	 *
+	 * @since   1.6


Change to __DEPLOY_VERSION__

Quy · 2018-07-23T14:54:25Z

plugins/system/redirect/redirect.php

+	{
+		if (!($form instanceof JForm))
+		{
+			$this->_subject->setError('JERROR_NOT_A_FORM');


Missing language string

coolcat-creations · 2018-07-23T14:06:23Z

plugins/system/redirect/redirect.php

+	{
+		if (!$isNew && $context == 'com_menus.item' && $this->params->get('watch_alias'))
+		{
+			$menu = & JSite::getMenu();


Please change this line to

$menu = (new \Joomla\CMS\Application\SiteApplication)->getMenu();

to make the PR work.

HLeithner · 2019-06-30T22:59:49Z

Hi @marrouchi,

as this is a new feature it will not go into J3.x series because of the feature freeze. Also it seams it doesn't work (4 failing tests).
If you still interested to bring this feature into Joomla please rebase the PR on J4 branch and correct the reported errors.

Thx for your work and time you invested into Joomla! I'm closing this PR and hope you find time to create a new one for J4.

joomla-cms-bot added Language Change This is for Translators PR-staging labels Feb 2, 2017

marrouchi mentioned this pull request Feb 2, 2017

Changing menu Item Alias causes 404's #13851

Closed

marrouchi changed the title ~~[imp] New plugin that displays a warning whenever an menu item's has changed~~ [imp] New plugin that displays a warning whenever an menu item's alias has changed Feb 2, 2017

marrouchi closed this Feb 2, 2017

marrouchi force-pushed the staging-new-plugin branch from 5925236 to 61189b3 Compare February 2, 2017 17:06

joomla-cms-bot removed the Language Change This is for Translators label Feb 2, 2017

[imp] Display a warning message whenever a menu item's alias has been…

5eef60f

… updated (using the redirect plugin).

marrouchi reopened this Feb 2, 2017

Added an enable/disable button + lang fixes

429b80d

joomla-cms-bot added the Language Change This is for Translators label Feb 2, 2017

marrouchi changed the title ~~[imp] New plugin that displays a warning whenever an menu item's alias has changed~~ [imp] Display a warning whenever an menu item's alias has changed Feb 2, 2017

Merge branch 'staging' into staging-new-plugin

c87edc3

Merge branch 'staging' into staging-new-plugin

b9ac171

joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Jul 23, 2018

joomla-cms-bot removed the RTC This Pull Request is Ready To Commit label Jul 23, 2018

Quy reviewed Jul 23, 2018

View reviewed changes

plugins/system/redirect/redirect.php

*

* @return boolean

*

* @since 1.6

Copy link

Contributor

Quy Jul 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to __DEPLOY_VERSION__

Quy reviewed Jul 23, 2018

View reviewed changes

coolcat-creations reviewed Jul 23, 2018

View reviewed changes

ghost added the J3 Issue label Apr 5, 2019

ghost removed the J3 Issue label Apr 19, 2019

ghost changed the title ~~[imp] Display a warning whenever an menu item's alias has changed~~ Display a warning whenever an menu item's alias has changed Apr 19, 2019

HLeithner closed this Jun 30, 2019

ghost added the J4 Rebase label Jul 1, 2019

HLeithner added this to Not rebased for J4 in [3.x-4.0] Closed feature PRs Jul 1, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Display a warning whenever an menu item's alias has changed #13856

Display a warning whenever an menu item's alias has changed #13856

marrouchi commented Feb 2, 2017 •

edited by joomla-cms-bot

tonypartridge commented Feb 2, 2017

marrouchi commented Feb 2, 2017

tonypartridge commented Feb 2, 2017 •

edited

marrouchi commented Feb 2, 2017

tonypartridge commented Feb 2, 2017

mbabker commented Feb 2, 2017

tonypartridge commented Feb 2, 2017

marrouchi commented Feb 2, 2017

tonypartridge commented Feb 2, 2017

ghost commented Feb 2, 2017

tonypartridge commented Feb 2, 2017 via email

marrouchi commented Feb 2, 2017

ghost commented Feb 2, 2017 •

edited by ghost

marrouchi commented Feb 2, 2017

ghost commented Feb 4, 2017

brianteeman commented Sep 9, 2017

raoulyemetio commented Jul 23, 2018 •

edited

coolcat-creations commented Jul 23, 2018

fatmaakay commented Jul 23, 2018

fatmaakay commented Jul 23, 2018

durubayram commented Jul 23, 2018

ghost commented Jul 23, 2018

durubayram commented Jul 23, 2018

brianteeman commented Jul 23, 2018

Quy commented Jul 23, 2018

fatmaakay commented Jul 23, 2018

coolcat-creations commented Jul 23, 2018

Quy Jul 23, 2018

Quy Jul 23, 2018

Quy Jul 23, 2018

coolcat-creations Jul 23, 2018

HLeithner commented Jun 30, 2019

Display a warning whenever an menu item's alias has changed #13856

Display a warning whenever an menu item's alias has changed #13856

Conversation

marrouchi commented Feb 2, 2017 • edited by joomla-cms-bot

Summary of Changes

Testing Instructions

Documentation Changes Required

tonypartridge commented Feb 2, 2017

marrouchi commented Feb 2, 2017

tonypartridge commented Feb 2, 2017 • edited

marrouchi commented Feb 2, 2017

tonypartridge commented Feb 2, 2017

mbabker commented Feb 2, 2017

tonypartridge commented Feb 2, 2017

marrouchi commented Feb 2, 2017

tonypartridge commented Feb 2, 2017

ghost commented Feb 2, 2017

tonypartridge commented Feb 2, 2017 via email

marrouchi commented Feb 2, 2017

ghost commented Feb 2, 2017 • edited by ghost

marrouchi commented Feb 2, 2017

ghost commented Feb 4, 2017

Test on:

brianteeman commented Sep 9, 2017

raoulyemetio commented Jul 23, 2018 • edited

coolcat-creations commented Jul 23, 2018

fatmaakay commented Jul 23, 2018

fatmaakay commented Jul 23, 2018

durubayram commented Jul 23, 2018

ghost commented Jul 23, 2018

durubayram commented Jul 23, 2018

brianteeman commented Jul 23, 2018

Quy commented Jul 23, 2018

fatmaakay commented Jul 23, 2018

coolcat-creations commented Jul 23, 2018

Quy Jul 23, 2018

Choose a reason for hiding this comment

Quy Jul 23, 2018

Choose a reason for hiding this comment

Quy Jul 23, 2018

Choose a reason for hiding this comment

coolcat-creations Jul 23, 2018

Choose a reason for hiding this comment

HLeithner commented Jun 30, 2019

marrouchi commented Feb 2, 2017 •

edited by joomla-cms-bot

tonypartridge commented Feb 2, 2017 •

edited

ghost commented Feb 2, 2017 •

edited by ghost

raoulyemetio commented Jul 23, 2018 •

edited