Jroute between sites #16879

izharaazmi · 2017-06-27T09:27:45Z

Most of the work was originally done by @andrepereiradasilva. This is a redo of his work and more additions from me.

Summary of Changes

This PR is for allowing JRoute to generate URL's from admin to site and vice-versa.

This is a current problem especially if you are trying to make links from the backend to the frontend.

So, with this PR, there is no need anymore to make special code just to get the frontend link from the backend. With this PR we just need to use JRoute, like all other links. The same will work to links from frontend to backend. After this PR, no need to hardcode frontend to admin links.

We will be able to use following syntax:

// Build a frontend URL irrespective of in which context (site/admin) the code is running
JRoute::link('site', $url, $xthml = true, $ssl = null);

// Build a backend URL irrespective of in which context (site/admin) the code is running
JRoute::link('administrator', $url, $xthml = true, $ssl = null);

This should not affect the existing JRoute::_() method.

Testing Instructions

Test various URLs for different extensions (articles, menu items, etc).
You should try with the several combinations of site settings like:
- SEF/non-SEF
- With or without URL rewriting
- With or without multi-language (i.e. with or without language filter plugin enabled).

Test 1: Links from `admin` to `site`

Use latest staging with sample data from at least two languages (en-GB, fr-FR)
Add to isis template index.php file...

$app = JFactory::getApplication();
$app->enqueueMessage('1. Admin to Admin: ' . JRoute::_('index.php'));
$app->enqueueMessage('2. Admin to Admin: ' . JRoute::_('index.php?option=com_content'));
$app->enqueueMessage('3. Admin to Site: ' . JRoute::link('site', 'index.php?option=com_content'));
$app->enqueueMessage('4. Admin to Site (MutilLanguage 1): ' . JRoute::link('site', 'index.php?option=com_content&lang=fr'));
$app->enqueueMessage('5. Admin to Site (MutilLanguage 2): ' . JRoute::link('site', 'index.php?option=com_users&lang=en'));

Open any admin page. Check the URL in resulting message are correct.

Test 2: Links from `site` to `admin`

Add to protostar template index.php file...

$app = JFactory::getApplication();
$app->enqueueMessage('1. Site to Site: ' . JRoute::_('index.php'));
$app->enqueueMessage('2. Site to Site: ' . JRoute::_('index.php?option=com_content'));
$app->enqueueMessage('3. Site to Admin: ' . JRoute::link('administrator', 'index.php?option=com_content'));

Open any frontend page. Check the URL in resulting message are correct.

Test 3: Code Review

Do a code review.

Test 4: Current URLs

Check if current URL generated by JRouter are exactly the same, i.e. no change in current URL.
Probably the best is to leave the patch applied for some time, while you do other things and check there are no problems with the current URLs.

Thanks to @mbabker, @ggppdk and @infograf768 for helping out with this one.

Maintainers, to make sure that are no unintended consequences it would be good if this can be also reviewed from someone that understand the Router better than I do.

…d via JRoute

mbabker · 2017-06-27T12:40:03Z

libraries/joomla/application/route.php

+			return static::_($arguments[0], $xhtml, $ssl, $name);
+		}
+
+		return null;


This should be a trigger_error() call because you in essence have a "call to undefined function" error here.

If we check for a valid client name here, the behavior would be different when called using undescore function. That function fails silently on invalid router and we need to keep it like that for B/C, imho.

And here we are only checking for missing first parameter coz we need to populate 4th parameter.

Another alternate way that comes to my mind is to not modify the undescore function signature and add another common function that accepts client name as first parameter.

We might then not need the magic function too. Your opinion please.

Personally I hate the use of magic functions. They usually expose unwanted behavior and do not handle error conditions appropriately (in an error state they should do the same thing as the native PHP engine does for whatever that magic function is overloading). Even in the Framework's database repo, I removed __call() and just made "real" stub methods for the shorthand q(), qn(), and e() methods.

So personally I'd just add stub real methods and avoid the magic as a first option. If the magic method is really needed, then it needs to error trap/handle properly.

That function fails silently on invalid router and we need to keep it like that for B/C, imho.

If the system can't generate a route, it shouldn't silently fail over. There needs to be an error raised.

mbabker · 2017-06-27T12:41:30Z

plugins/system/languagefilter/languagefilter.php

-			$router->attachBuildRule(array($this, 'preprocessBuildRule'), JRouter::PROCESS_BEFORE);
-			$router->attachBuildRule(array($this, 'buildRule'), JRouter::PROCESS_DURING);
+		// We need to make sure we are always using the site router, even if the language plugin is executed in admin app.
+		$router = $this->app->isClient('site') ? $this->app->getRouter() : JApplicationCms::getInstance('site')->getRouter('site');


Just have this always call JApplicationCms::getInstance('site')->getRouter('site'), the singleton instance in JApplicationCms will be the same as the one in JFactory::$application if you're on the frontend anyway.

izharaazmi · 2017-06-27T16:24:26Z

@mbabker Please review the changes now. I have kept the magic method and it does not ignore any errors. If you suggest I can also remove that altogether.

wilsonge · 2017-06-27T19:50:08Z

libraries/joomla/application/route.php

+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public static function link($client, $url, $xhtml = true, $ssl = null)


This signature should be public static function link($url, $client=null, $xhtml = true, $ssl = null) (we should be explicit the default client variable is null rather than making it compulsory and then passing in null in JRoute::_)

From where I see this, the undescore function is the dedicated interface for the cases where the programmer wants to use active client.

This method link() should ideally be used in cases where the specific $client value has the main significance. It will also improve the readability of the code as a bonus.

Therefore, IMO, this signature looks fit for the purpose. If someone still insist on using link() for what _ is meant for, then we've no reason to stop them.

Then the link method shouldn't have support for injecting $client = null. That logic should move into _.

Yeah that makes sense. I'll update it this afternoon.

Done.
The Travis failure is probably something unrelated.

Can you check just to make sure? The builds for this pull request didn't start failing until this last change.

These tests are failing with Routing related issues. I think they are as a result of this PR

…client value in JRoute::link()

mbabker · 2017-07-02T16:35:46Z

I started digging into the test problems. We're in dependency hell.

Problem 1 - TestMockApplicationCms::getMethods() needs to include the getName method
Problem 2 - For JPaginationTest, need to add this line to configure the application mock in the setUp method (note that there will be some places that need to change the mock return to administrator in that test class)

$app->expects($this->any())->method('getName')->willReturn('site');

Problem 3 - JApplicationCms::getRouter() is static, it cannot be mocked, so we have to work with a real router (or use Reflection and push a mock into the JRoute::$_router property)
Problem 4 - JRouter::getInstance() does not support constructor injection of the application and menu objects for the JRouterSite subclass, so there is no way to inject stuff, meaning that code is falling onto the defaults
Problem 5 - The JRouterSite constructor calls JApplicationCms::getInstance('site'), this tries to create a JApplicationSite object with default behaviors since there isn't a mock application set up in JApplicationCms::$instances, and this ultimately leads up to a session start failure
Problem 6 - I got too deep into this and said "no more" 😆

wilsonge · 2017-07-02T17:23:17Z

So if you change https://github.com/izharaazmi/joomla-cms/blob/c7dd17d70bebe41230c28140612eccce5d727506/libraries/joomla/application/route.php#L87 to be if (!isset(self::$_router[$client])) (i.e. allow $client to be null), then unit tests pass and effectively replicate the current behaviour (admittedly the incorrect behaviour).

mbabker · 2017-07-02T17:52:45Z

Well, good thing JRouter isn't abstract then.

izharaazmi · 2017-08-31T04:04:42Z

@mbabker Its post beta4 now. Is there still any change getting this in?

izharaazmi · 2017-09-15T12:08:10Z

Conflicts resolved.

euismod2336 · 2017-09-29T15:27:46Z

I have tested this item ✅ successfully on b3136c4

Love this PR.

Both in frontend as backend the expected url's show up, both with SEF enabled and disabled.

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

ghost · 2017-09-29T16:19:04Z

RTC after two successful tests.

ctech-design · 2018-02-09T07:38:42Z

I have tested this and really need this PR to be added in Joomla soon, It's been month how long do we have to wait. Please consider releasing this soon

tonypartridge · 2018-02-09T07:46:01Z

@asfaqueali

Unfortunately this cannot be added into joomla! Until 3.9 since new features cannot go into 3.8 as that would break versioning.

ctech-design · 2018-02-09T07:50:54Z

@tonypartridge yeah I understand, but its been almost 4 months and release date of 3.9 is not defined so far.

tonypartridge · 2018-02-09T07:52:34Z

It won’t be merged into 3.9 until 3.9 is ready to be merged to the staging branch. @wilsonge is the 3.9 release lead I believe and won’t miss it out I’m sure.

…

On 9 Feb 2018, 07:51 +0000, Asfaque Ali Ansari ***@***.***>, wrote: @tonypartridge yeah I understand, but its been almost 4 months and release date of 3.9 is not defined so far. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

wilsonge · 2018-03-09T02:21:45Z

Merged - awesome work :)

ctech-design · 2018-03-09T04:40:10Z

@tonypartridge @wilsonge Thanks for merging it. @izharaazmi thanks for this commit.

tonypartridge · 2018-03-09T08:54:38Z

Thanks George! I’ll try and get onto the view in site button next week for menu items

…

On 9 Mar 2018, 04:40 +0000, Asfaque Ali Ansari ***@***.***>, wrote: @tonypartridge @wilsonge Thanks for merging it. @izharaazmi thanks for this commit. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

bascherz · 2019-05-02T03:33:02Z

Hi guys,

I am not having a successful experience using the new JRoute::link method. It simply doesn't appear to work in my plugin at all. The code is below. The calls to link are commented-out because they simply don't do anything.

// Build article links
$rel_link = str_replace('/administrator','',JRoute::_(ContentHelperRoute::getArticleRoute($article->id,$article->catid)));
$abs_link = str_replace('/administrator','',JURI::base().$rel_link);
$abs_link = str_replace(':/','://',str_replace('//','/',$abs_link));
// $abs_link = JRoute::link('site',$abs_link);
// $rel_link = JRoute::link('site',$rel_link);

As you can see, I still have to remove the "administrator//" part of back end links and for back end links I still get no SEF URL out of JRoute::link. This particular plugin has a feature that allows either an absolute or relative link to be inserted into the template being used to email a notification that an article was just published or updated.

I'm hoping someone here can show me the err of my ways and, if applicable, point me to where I should have posted this comment.

Thanks,
Bruce

ghost · 2019-05-02T04:44:31Z

@bascherz please open a new Issue (link to this PR) as comments on closed Pull Requests didn't get much notice.

tonypartridge · 2019-05-02T07:47:18Z

@bascherz - Your code is wrong, you are trying to JRoute a JRouted URL you cannot do that, you need to call the url non-routed i.e. with index.php?option=com_content etc. So try removing the JRoute::_() on the $rel_link = . Also you shouldn't need to replace administrator.

wilsonge · 2019-05-02T08:51:47Z

Documentation for this is available at https://docs.joomla.org/J3.x:Supporting_SEF_URLs_in_your_component#Creating_Frontend_SEF_URLs_in_the_Administrator as of approximately 5 minutes ago :)

bascherz · 2019-05-03T14:03:36Z

Documentation for this is available at https://docs.joomla.org/J3.x:Supporting_SEF_URLs_in_your_component#Creating_Frontend_SEF_URLs_in_the_Administrator as of approximately 5 minutes ago :)

Somewhat a brute force method, but it does work. Some of my URLs are not SEF (for whatever reason) and that threw me off a bit as well. No need to open an issue @franz-wohlkoenig.

Here's the code now. Category ID apparently is not needed.

$rel_link = JRoute::link('site','index.php?option=com_content&view=article&id='.$article->id);
$abs_link = JURI::base().$rel_link;

Thanks everyone.

wilsonge · 2019-05-04T07:35:06Z

It's not required but probably helpful to get exactly the same url as the frontend

infograf768 · 2019-05-04T09:24:49Z

Also missing language ;)

		if ($article->language && Multilanguage::isEnabled())
		{
			// Get the sef prefix for the language
			$query->clear()
				->select('sef')
				->from($db->quoteName('#__languages'))
				->where($db->quoteName('published') . '= 1')
				->where($db->quoteName('lang_code') . ' = ' . $db->quote($article->language));
			$db->setQuery($query);

			$sef = $db->loadResult();

			if ($article->language != '*')
			{
				$lang = '&amp;lang=' . $sef;
			}
		}

andrepereiradasilva and others added 15 commits April 23, 2016 00:20

allow to force site client when we are in admin

69f4f3f

allow from site to admin too

d8e7a5d

first try to make language filter router work on admin too when calle…

9c1a3a8

…d via JRoute

revert

7933bdb

revert 2

173c231

make language filter pluign work with JRoute from admin

0faa289

cs

2ad9ffd

cs 2

0f1d95b

Merge branch 'staging' into jroute-between-sites

4502d6f

use app

d07ee16

solve php notices

3ef9ba2

Merge branch 'staging' into jroute-between-sites

a4eaa94

Merge branch 'staging' into jroute-between-sites

219438b

Merge joomla-cms/staging into jroute-between-sites

129d14c

Few tweaks for the PR

671b504

joomla-cms-bot added the PR-staging label Jun 27, 2017

izharaazmi force-pushed the jroute-between-sites branch from fab065f to 671b504 Compare June 27, 2017 10:17

andrepereiradasilva mentioned this pull request Jun 27, 2017

JRoute between clients (site -> admin | admin -> site) #11060

Closed

mbabker reviewed Jun 27, 2017

View reviewed changes

mbabker added this to Testing/Review in [3.8] Routing Jun 27, 2017

Suggestions from @mbabker, and few other improvements.

94bdfc5

wilsonge reviewed Jun 27, 2017

View reviewed changes

Moved active client detection logic to JRoute::_() and disallow null …

c7dd17d

…client value in JRoute::link()

wilsonge approved these changes Jun 29, 2017

View reviewed changes

mbabker changed the base branch from staging to 3.8-dev July 2, 2017 15:52

Merge origin/staging into jroute-between-sites

a91cd6d

izharaazmi force-pushed the jroute-between-sites branch from b721b98 to a91cd6d Compare September 15, 2017 12:06

joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Sep 29, 2017

mbabker changed the base branch from staging to 3.9-dev October 15, 2017 15:56

mbabker added this to the Joomla 3.9.0 milestone Oct 15, 2017

wilsonge merged commit 8a51f23 into joomla:3.9-dev Mar 9, 2018

joomla-cms-bot added PR-3.9-dev and removed RTC This Pull Request is Ready To Commit labels Mar 9, 2018

izharaazmi deleted the jroute-between-sites branch March 12, 2018 12:21

brianteeman removed the PR-staging label Mar 17, 2018

wilsonge moved this from Testing/Review to Completed in [3.9] General Aug 10, 2018

wilsonge mentioned this pull request Mar 15, 2019

[4.0] Make the preview url respect SEF settings #24195

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Jroute between sites #16879

Jroute between sites #16879

izharaazmi commented Jun 27, 2017 •

edited by joomla-cms-bot

mbabker Jun 27, 2017

izharaazmi Jun 27, 2017

mbabker Jun 27, 2017

mbabker Jun 27, 2017

izharaazmi Jun 27, 2017

izharaazmi commented Jun 27, 2017

wilsonge Jun 27, 2017

izharaazmi Jun 27, 2017

mbabker Jun 27, 2017

izharaazmi Jun 27, 2017

izharaazmi Jun 28, 2017

mbabker Jun 30, 2017

wilsonge Jul 2, 2017

mbabker commented Jul 2, 2017

wilsonge commented Jul 2, 2017

mbabker commented Jul 2, 2017

izharaazmi commented Aug 31, 2017

izharaazmi commented Sep 15, 2017

euismod2336 commented Sep 29, 2017

ghost commented Sep 29, 2017

ctech-design commented Feb 9, 2018

tonypartridge commented Feb 9, 2018

ctech-design commented Feb 9, 2018

tonypartridge commented Feb 9, 2018 via email

wilsonge commented Mar 9, 2018

ctech-design commented Mar 9, 2018

tonypartridge commented Mar 9, 2018 via email

bascherz commented May 2, 2019 •

edited by HLeithner

ghost commented May 2, 2019

tonypartridge commented May 2, 2019

wilsonge commented May 2, 2019

bascherz commented May 3, 2019

wilsonge commented May 4, 2019

infograf768 commented May 4, 2019

Jroute between sites #16879

Jroute between sites #16879

Conversation

izharaazmi commented Jun 27, 2017 • edited by joomla-cms-bot

Summary of Changes

Testing Instructions

Test 1: Links from admin to site

Test 2: Links from site to admin

Test 3: Code Review

Test 4: Current URLs

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

izharaazmi commented Jun 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mbabker commented Jul 2, 2017

wilsonge commented Jul 2, 2017

mbabker commented Jul 2, 2017

izharaazmi commented Aug 31, 2017

izharaazmi commented Sep 15, 2017

euismod2336 commented Sep 29, 2017

ghost commented Sep 29, 2017

ctech-design commented Feb 9, 2018

tonypartridge commented Feb 9, 2018

ctech-design commented Feb 9, 2018

tonypartridge commented Feb 9, 2018 via email

wilsonge commented Mar 9, 2018

ctech-design commented Mar 9, 2018

tonypartridge commented Mar 9, 2018 via email

bascherz commented May 2, 2019 • edited by HLeithner

ghost commented May 2, 2019

tonypartridge commented May 2, 2019

wilsonge commented May 2, 2019

bascherz commented May 3, 2019

wilsonge commented May 4, 2019

infograf768 commented May 4, 2019

izharaazmi commented Jun 27, 2017 •

edited by joomla-cms-bot

Test 1: Links from `admin` to `site`

Test 2: Links from `site` to `admin`

bascherz commented May 2, 2019 •

edited by HLeithner