Bug 12571 - Add ability to customize SIP2 screen messages
Summary: Add ability to customize SIP2 screen messages
Status: CLOSED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: SIP2 (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement
Assignee: Kyle M Hall (khall)
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-07-14 13:50 UTC by Kyle M Hall (khall)
Modified: 2018-04-09 10:29 UTC (History)
7 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Medium patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
Circulation function:


Attachments
Bug 12571 - Add ability to customize SIP2 screen messages (8.74 KB, patch)
2014-07-14 13:55 UTC, Kyle M Hall (khall)
Details | Diff | Splinter Review
Bug 12571 - Add ability to customize SIP2 screen messages (8.75 KB, patch)
2014-07-14 14:06 UTC, Kyle M Hall (khall)
Details | Diff | Splinter Review
Bug 12571 - Add ability to customize SIP2 screen messages (8.73 KB, patch)
2014-07-14 14:26 UTC, Kyle M Hall (khall)
Details | Diff | Splinter Review
Bug 12571 - Add ability to customize SIP2 screen messages (8.78 KB, patch)
2014-07-29 15:30 UTC, Biblibre Sandboxes
Details | Diff | Splinter Review
Bug 12571 - Add ability to customize SIP2 screen messages (8.83 KB, patch)
2014-10-10 20:26 UTC, Paul Poulain
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Kyle M Hall (khall) 2014-07-14 13:50:17 UTC
We should add the ability to apply a regular expression to screen messages for the SIP2 server. This would allow libraries to not only customize the screen messages the patron sees, but can also allow screen messages to be translated.
Comment 1 Kyle M Hall (khall) 2014-07-14 13:55:05 UTC Comment hidden (obsolete)
Comment 2 Kyle M Hall (khall) 2014-07-14 14:06:00 UTC Comment hidden (obsolete)
Comment 3 Kyle M Hall (khall) 2014-07-14 14:26:25 UTC Comment hidden (obsolete)
Comment 4 Biblibre Sandboxes 2014-07-29 15:29:43 UTC
Patch tested with a sandbox, by Jason Burds <jburds@dubuque.lib.ia.us>
Comment 5 Biblibre Sandboxes 2014-07-29 15:30:10 UTC Comment hidden (obsolete)
Comment 6 Kyle M Hall (khall) 2014-07-29 16:05:23 UTC
I assisted Jason Burds with the testing of this patch. We used the sandbox for sign-off so he wouldn't need to create an account.
Comment 7 Paul Poulain 2014-10-10 20:26:08 UTC
QA comment
 * passes koha-qa.pl
 * I could not test this patch, because I've no SIP2 equipment
 * the code looks OK, even if I feel that when you have a lot of strings, it may be CPU consuming (regexp on each string, on each SIP2 request)
 But that's a valuable enhancement, that non english speaking libraries will like very much, so passing QA
Comment 8 Paul Poulain 2014-10-10 20:26:59 UTC
Created attachment 32206 [details] [review]
Bug 12571 - Add ability to customize SIP2 screen messages

We should add the ability to apply a regular expression to screen
messages for the SIP2 server. This would allow libraries to not only
customize the screen messages the patron sees, but can also allow screen
messages to be translated.

Test Plan:
1) Apply this patch
2) Inspect etc/SIPconfig.xml, note the new screen_msg_regex tags
   that can be nested inside a given login tag.
3) Add one or more screen_msg_regex tags to your own SIP config
   Recommendation: s/Greetings from Koha./Welcome to your library!/g
4) Restart your SIP2 server
5) Test with a SIP2 machine, or use /misc/sip_cli_emulator.pl
6) Note your new AF fields!

Signed-off-by: Jason Burds <jburds@dubuque.lib.ia.us>

Signed-off-by: Paul Poulain <paul.poulain@biblibre.com>
Comment 9 Colin Campbell 2014-10-14 14:03:04 UTC
Would it not be better to load the strings from a separate file. So that if multiple configs are used they could share them. Also to force the variable to be an array ref instead of the rather ugly testing that for each message
Comment 10 Tomás Cohen Arazi (tcohen) 2014-10-28 13:25:15 UTC
Patch pushed to master.

Thanks Kyle!