dev/core#1931 Prevent PayPal from double-encoding the IPN Notify URL

[christianwach]

Overview

Solves this issue on the Lab.

Before

PayPal IPN return URLs contain double-encoded entities, e.g.

"POST /2020/09/04/donation-shortcode/?civiwp=CiviCRM&q=civicrm%252Fpayment%252Fipn%252F3 HTTP/1.1" 200

After

PayPal IPN return URLs do not contain double-encoded entities, e.g.

"POST /2020/09/04/donation-shortcode/?civiwp=CiviCRM&q=civicrm/payment/ipn/3 HTTP/1.1"

Technical Details

When CiviCRM does not use Clean URLs (or, in WordPress, if a Shortcode is used for a Contribution Page) then IPN notifications fail to register contributions as "Completed". This applies to all CMSes where Clean URLs are not in use.

[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).

[mattwire]

@christianwach style warning

[christianwach]

@mattwire Argh, thanks for the heads up.

[agileware-justin]

Thanks @christianwach

[eileenmcnaughton]

@agileware-justin are you able to test this?

[agileware-justin]

@eileenmcnaughton patch has been deployed to production for 2 days - no issues reported. OK to merge AFAIK

[kcristiano]

I have done r-run on this as well. I have been adding to our PayPal sites and it fixes the issues as described.

OK to merge.

This should also be a considered for 5.32.

[seamuslee001]

Merging based on review of @kcristiano and @agileware-justin

[eileenmcnaughton]

@kcristiano @christianwach per "This should also be a considered for 5.32." - if you want to put up a PR against 5.32 I'm happy to merge it to the rc / look at it for any future 5.31 releases. It's not clear to what extent it's a regression but I guess it at least sort of is

[kcristiano]

@eileenmcnaughton I think it's a PayPal regression :) It might be an issue related to the work we did in 5.26 for the WP URL changes, or something PayPal did. It's a big enough deal that I'd like it in sooner rather than later.

#18996

[agileware-justin]

PSA? https://lab.civicrm.org/dev/core/-/issues/1931#note_50638