[Bug 42559] New: OpacFavicon double-encodes custom favicon URLs
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 Bug ID: 42559 Summary: OpacFavicon double-encodes custom favicon URLs Initiative type: --- Sponsorship --- status: Product: Koha Version: Main Hardware: All OS: All Status: NEW Severity: normal Priority: P5 - low Component: System Administration Assignee: Laura.escamilla@bywatersolutions.com Reporter: Laura.escamilla@bywatersolutions.com QA Contact: testopia@bugs.koha-community.org CC: gmcharlt@gmail.com The OpacFavicon system preference is documented as accepting a complete URL to an image for the OPAC favicon. However, the OPAC template outputs the value using the url filter. If the URL contains an already-encoded character, such as %20 for a space in a filename, the % is encoded again and the rendered URL becomes %2520. This causes the browser to request an invalid favicon URL. The staff interface does not have this issue because IntranetFavicon is output with the html filter instead. The OPAC should handle custom favicon URLs consistently with the staff client. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 Laura Escamilla <Laura.escamilla@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 --- Comment #1 from Laura Escamilla <Laura.escamilla@bywatersolutions.com> --- Created attachment 198799 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=198799&action=edit Bug 42559: Prevent OpacFavicon URLs from being double-encoded Test plan: 1. Apply the patch. 2. Set OpacFavicon to a URL containing an encoded space, for example: https://raw.githubusercontent.com/bywatersolutions/web-assets/master/sites/k... 3. Restart services and clear cache if needed. 4. View the OPAC page source. 5. Confirm the favicon URL is rendered with %20 and not %2520. 6. Confirm the favicon loads in the browser. 7. Clear the OpacFavicon system preference. 8. Confirm the default Koha favicon still loads. 9. Sign off and have a great day! :D -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 Owen Leonard <oleonard@myacpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch complexity|--- |Trivial patch Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 Owen Leonard <oleonard@myacpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #198799|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 --- Comment #2 from Owen Leonard <oleonard@myacpl.org> --- Created attachment 198823 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=198823&action=edit Bug 42559: Prevent OpacFavicon URLs from being double-encoded Test plan: 1. Apply the patch. 2. Set OpacFavicon to a URL containing an encoded space, for example: https://raw.githubusercontent.com/bywatersolutions/web-assets/master/sites/k... 3. Restart services and clear cache if needed. 4. View the OPAC page source. 5. Confirm the favicon URL is rendered with %20 and not %2520. 6. Confirm the favicon loads in the browser. 7. Clear the OpacFavicon system preference. 8. Confirm the default Koha favicon still loads. 9. Sign off and have a great day! :D Signed-off-by: Owen Leonard <oleonard@myacpl.org> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 Lisette Scheer <lisette@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |lisette@bywatersolutions.co | |m QA Contact|testopia@bugs.koha-communit |jacob.omara@openfifth.co.uk |y.org | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 Andrew Fuerste-Henry <andrew@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|Laura.escamilla@bywatersolu |andrew@bywatersolutions.com |tions.com | Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 Andrew Fuerste-Henry <andrew@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #198823|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 --- Comment #3 from Andrew Fuerste-Henry <andrew@bywatersolutions.com> --- Created attachment 204506 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=204506&action=edit Bug 42559: Prevent OpacFavicon URLs from being double-encoded Test plan: 1. Apply the patch. 2. Set OpacFavicon to a URL containing an encoded space, for example: https://raw.githubusercontent.com/bywatersolutions/web-assets/master/sites/k... 3. Restart services and clear cache if needed. 4. View the OPAC page source. 5. Confirm the favicon URL is rendered with %20 and not %2520. 6. Confirm the favicon loads in the browser. 7. Clear the OpacFavicon system preference. 8. Confirm the default Koha favicon still loads. 9. Sign off and have a great day! :D Signed-off-by: Owen Leonard <oleonard@myacpl.org> Signed-off-by: Andrew Fuerste Henry <andrew@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 Andrew Fuerste-Henry <andrew@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- QA Contact|jacob.omara@openfifth.co.uk |andrew@bywatersolutions.com Assignee|andrew@bywatersolutions.com |Laura.escamilla@bywatersolu | |tions.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 Pedro Amorim (ammopt) <pedro.amorim@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Failed QA CC| |pedro.amorim@openfifth.co.u | |k --- Comment #4 from Pedro Amorim (ammopt) <pedro.amorim@openfifth.co.uk> --- Hi guys, should we not make sure that everywhere OpacFavicon is used also follows this? grep --color=always -rn "Koha.Preference('OpacFavicon') | url\|OpacFavicon | url" --include="*.tt" koha-tmpl/ -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 --- Comment #5 from Owen Leonard <oleonard@myacpl.org> --- (In reply to Pedro Amorim (ammopt) from comment #4)
Hi guys, should we not make sure that everywhere OpacFavicon is used also follows this?
Now I'm wondering if this patch is correct... Are we talking about an image/icon file which is stored as literally 'favicon%20002.png' ? If so don't we want it to be double-encoded? Double-encoded link works: https://static.myacpl.org/public/img/koha/koha%2520dev%2520favicon.ico Not double-encoded, fails: https://static.myacpl.org/public/img/koha/koha%20dev%20favicon.ico -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=42559 Laura Escamilla <Laura.escamilla@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Failed QA |In Discussion --- Comment #6 from Laura Escamilla <Laura.escamilla@bywatersolutions.com> --- Thanks for the feedback! Looking at Owen's example, I can see how double encoding may be necessary when `%20` is literally part of the filename. My original report was based on a URL where `%20` represented an encoded space, and the additional encoding caused the favicon not to load. Given these different scenarios, I'm wondering whether this is an issue with how `OpacFavicon` handles URLs or whether we should clarify the expected format in the system preference documentation. Would it make sense to keep this open for further discussion, or do we consider the current behavior expected? -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org