[Bug 10237] New: Enforce authorized value character limitations
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 Bug ID: 10237 Summary: Enforce authorized value character limitations Classification: Unclassified Change sponsored?: --- Product: Koha Version: master Hardware: All URL: /cgi-bin/koha/admin/authorised_values.pl OS: All Status: NEW Severity: normal Priority: P5 - low Component: System Administration Assignee: koha-bugs@lists.koha-community.org Reporter: oleonard@myacpl.org CC: gmcharlt@gmail.com According to the manual, "Authorized value is limited to 80 characters and cannot have spaces or special characters other than underscores and hyphens in it." We know that breaking this rule causes problems with searching and bugs like Bug 10229. We should enforce this rule on the client and server side to prevent the user from entering invalid data. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 Owen Leonard <oleonard@myacpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 --- Comment #1 from Owen Leonard <oleonard@myacpl.org> --- Created attachment 18117 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=18117&action=edit Bug 10237 - Enforce authorized value character limitations An authorized value should not have spaces or special characters other than underscores and hyphens in it, but this limitation is not enforced. This patch adds client-side validation blocking entries which contain anything other than numbers, letters, underscores, or dashes. Changes include: - The addition of a custom alphanumeric validation scheme which can be used anywhere in Koha. - The addition of a new translatable warning message which appears when the alphanumeric validation scheme is violated. - The addition of rules to the authorized_values.tt template to enable the new alphanumeric validation scheme. To test, apply the patch and clear your browser cache. With an existing category of authorized values (like ccode): - Click to add new authorized value - Try to enter invalid data in the "authorized value" form field. You should see a warning. - Try to submit a form with the invalid data. You should be prevented from doing to. - Correct the invalid data to conform to the validation rules. Warnings should disappear. - Submit the form. It should submit correctly. With a new category: - Click to create a new category. - Try to enter invalid data in the "category" and "authorized value" form fields. You should see warnings. - Try to submit a form with the invalid data. You should be prevented from doing to. - Correct the invalid data to conform to the validation rules. Warnings should disappear. - Submit the form. It should submit correctly. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |katrin.fischer@bsz-bw.de --- Comment #2 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Should we also discourage the use dashes? Dashes in collection and location can cause problems with your search not being as exact as you expected it to be (being interpretated as multiple words by zebra). -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 --- Comment #3 from Owen Leonard <oleonard@myacpl.org> --- (In reply to comment #2)
Should we also discourage the use dashes?
It's easy to modify the regex if that's the right thing to do. I was simply following what the manual recommended. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 --- Comment #4 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- It took me a bit to find it, but Joy wrote something on the topic a while ago: http://bywatersolutions.com/2012/07/05/naming-conventions-in-koha/ -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 --- Comment #5 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Hm, thinking more about this - there are values where this won't work so nicely - one of them is MANUAL_INV. The code is the value that will be shown for your custom fee type and therefore enforcing upper case, no spaces and no umlauts would not be good. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #18117|0 |1 is obsolete| | --- Comment #6 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 19002 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=19002&action=edit Bug 10237 - Enforce authorized value character limitations An authorized value should not have spaces or special characters other than underscores and hyphens in it, but this limitation is not enforced. This patch adds client-side validation blocking entries which contain anything other than numbers, letters, underscores, or dashes. Changes include: - The addition of a custom alphanumeric validation scheme which can be used anywhere in Koha. - The addition of a new translatable warning message which appears when the alphanumeric validation scheme is violated. - The addition of rules to the authorized_values.tt template to enable the new alphanumeric validation scheme. To test, apply the patch and clear your browser cache. With an existing category of authorized values (like ccode): - Click to add new authorized value - Try to enter invalid data in the "authorized value" form field. You should see a warning. - Try to submit a form with the invalid data. You should be prevented from doing to. - Correct the invalid data to conform to the validation rules. Warnings should disappear. - Submit the form. It should submit correctly. With a new category: - Click to create a new category. - Try to enter invalid data in the "category" and "authorized value" form fields. You should see warnings. - Try to submit a form with the invalid data. You should be prevented from doing to. - Correct the invalid data to conform to the validation rules. Warnings should disappear. - Submit the form. It should submit correctly. Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 --- Comment #7 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Kyle, did you test what I noted in comment 5? -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 Jonathan Druart <jonathan.druart@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Failed QA CC| |jonathan.druart@biblibre.co | |m --- Comment #8 from Jonathan Druart <jonathan.druart@biblibre.com> --- (In reply to comment #5)
Hm, thinking more about this - there are values where this won't work so nicely - one of them is MANUAL_INV. The code is the value that will be shown for your custom fee type and therefore enforcing upper case, no spaces and no umlauts would not be good.
I confirm that many values contain spaces (I found '|', '(', ')', '-', '/' too). Marked as Failed QA. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 Owen Leonard <oleonard@myacpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Failed QA |ASSIGNED --- Comment #9 from Owen Leonard <oleonard@myacpl.org> --- Okay, let's approach it this way: Which default authorized value categories can contain non-alphanumeric characters? I'll build an explicit check applying the validation rules for only categories which require it. Asort1 Asort2 BOR_NOTES Bsort1 Bsort2 CCODE DAMAGED DEPARTMENT INST LOC LOST MANUAL_INV NOT_LOAN PA_CLASS REPORT_GROUP REPORT_SUBGROUP RESTRICTED SUGGEST SUGGEST_STATUS SUPPRESS School TERM WITHDRAWN YES_NO -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 Owen Leonard <oleonard@myacpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |oleonard@myacpl.org |ity.org | -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 --- Comment #10 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Hm, I don't have school in my installations. I think MANUAL_INV and BOR_NOTES would be candidates probably. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 --- Comment #11 from Jonathan Druart <jonathan.druart@biblibre.com> --- (In reply to Jonathan Druart from comment #8)
(In reply to comment #5)
Hm, thinking more about this - there are values where this won't work so nicely - one of them is MANUAL_INV. The code is the value that will be shown for your custom fee type and therefore enforcing upper case, no spaces and no umlauts would not be good.
I confirm that many values contain spaces (I found '|', '(', ')', '-', '/' too). Marked as Failed QA.
Hum... forget that, I don't know how I found that... On my side, I found SUGGEST and LOC: installer/data/mysql/fr-FR/marcflavour/unimarc_lecture_pub/Obligatoire/framework_DEFAULT.sql:INSERT INTO `authorised_values` (`id`, `category`, `authorised_value`, `lib`) VALUES (144, 'SUGGEST', 'Pas assez de budget', 'Pas assez de budget'); installer/data/mysql/fr-FR/1-Obligatoire/authorised_values.sql:INSERT INTO `authorised_values` ( `category`, `authorised_value`, `lib`) VALUES ( 'LOC', 'Salle de lecture', 'Salle de lecture'); I think it is not correct and the authorised_value field should be a code. But they exist as it in sample data. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 --- Comment #12 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- I think having spaces in the LOC code can lead to unexpected search results. I know there is a bug reporting problems for very similar codes, like EBOOK and EBOOKX. I tend to have the restrictions being put on LOC, because in general it seems more safe to use good codes there. For SUGG it probably doesn't give you trouble, but I think the codes are not displayed anywhere, so maybe the codes could be cleaned up? -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10237 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|ASSIGNED |RESOLVED Resolution|--- |DUPLICATE --- Comment #13 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- *** This bug has been marked as a duplicate of bug 7013 *** -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org