[REF] Fix error where entryURL does not contain id of the contributio…

[seamuslee001]

…n page when coming from a shortcode which leads to infinite redirect loop if session timesout

Overview

This fixes a slightly unusal issue that can create a very bad situation. To reproduce you can use a local buildkit build of wordpress using the wp-demo build.

Navigate to https:///contribution-page/ and fill in the page and then navigate to the Confirm step.

Now the important thing is to let it sit there for 10-15m, however if you are not patient then you can login to MySQL and truncate the civicrm_cache table (i.e. basically destroy the current session information).

Now if you click back your meant to be taken back to the original main step of the process with a status message saying "We have reset your session because it timed out" or similar.

Before

Infinite loop created

After

No Infinite loop and user is correctly taken back to the original page and status message shows up.

Technical Details

The issue is that the entryUrl doesn't contain the page id but more importantly doesn't have reset=1 to trigger the reset of the session when you are coming from a page built using shortcode

ping @eileenmcnaughton @haystack @kcristiano @JoeMurray

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[kcristiano]

@seamuslee001 I'll take a look and do an r-run @christianwach may have further comments. We discussed and I don't think he has a better way to handle.

[christianwach]

As I said on MM, this seems to fix the issue - although the final URL isn't the default URL for the post where the shortcode is embedded. Without making special checks for WordPress shortcodes here, I don't see a better solution.

[kcristiano]

@seamuslee001

I had reproduced the error. With the patch I do not get an infinite loop. But if I destroy the cache I get a fatal:

Could not find valid value for id

If I submit without waiting/dumping the cahe the form submits correctly

[seamuslee001]

Right well I think this is an improvement then. I'll think about how the entryUrl might be helpful but I would see that as a follow up pr thing @eileenmcnaughton

[eileenmcnaughton]

erm - I don't have my head in this - so if it's agreed that it should be merged by @kcristiano then I will - if you need me to decide I'll have to come back to it

[agileware-justin]

Good one @seamuslee001

We've seen this problem on the Event Registration pages as well.

[mattwire]

I've seen this kind of thing and agree this will be an improvement. Before merge can we get a comment briefly explaining why we need that line of code so the next time a developer looks at that bit they know what it's for.

[kcristiano]

@seamuslee001 I've tested again this time on Ubuntu 20.04, php-fpm 7.3 and Apache 2.4 - still WP 5.7 and CiviCRM Master. lat test was on my macbook.

Kill caches - even restart php-fpm. Then submit

I think the earlier issue was a local issue.

I agree a code comment should be added, otherwise I think this is good to merge.

[eileenmcnaughton]

@seamuslee001 please go ahead & self-merge this once you have added the requested comment

[seamuslee001]

ok I have put a comment message in saying why we are doing this so I think we are right to go now

[agileware-justin]

[kcristiano]

@agileware-justin any comments on the above? is this after the patch and forcing a cache-clear? also what cms role was in use?