From 6fb994257ecf74f65b0951564341561dd40df3a5 Mon Sep 17 00:00:00 2001
From: Tomas Cohen Arazi <tomascohen@theke.io>
Date: Wed, 21 Sep 2016 11:40:09 -0300
Subject: [PATCH] Bug 17318: Allow chosing fixed normalization routines

This patch changes the matching-rules.pl page, so it allows the user to choose
from the different hardcoded normalization routines. It is done using TT blocks
and the routine descriptions are translatable.

To test:
- Create some matching rule
- Have free text values on the 'Normalization rule' field
- Apply the patches
- Create a new routine
=> SUCCESS: You can now only choose between fixed option
- Save the rule
- Open it for editing
=> SUCCESS: Chosen rules are preserved
- Edit the original free-text including rule
=> SUCCESS: Rules fall back to 'None'
- Sign off :-D

TODO: A followup will add a warning about the current value and the fact that
      saving the matching rule will overwrite those, with 'none'.

Sponsored-by: FIT

Signed-off-by: Mark Tompsett <mtompset@hotmail.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
---
 admin/matching-rules.pl                       | 10 +-
 .../prog/en/modules/admin/matching-rules.tt   | 96 +++++++++++++++----
 2 files changed, 85 insertions(+), 21 deletions(-)

diff --git a/admin/matching-rules.pl b/admin/matching-rules.pl
index 191d38b753..20d9f82942 100755
--- a/admin/matching-rules.pl
+++ b/admin/matching-rules.pl
@@ -26,7 +26,7 @@ use C4::Auth;
 use C4::Context;
 use C4::Output;
 use C4::Koha;
-use C4::Matcher;
+use C4::Matcher qw/valid_normalization_routines/;
 
 my $script_name = "/cgi-bin/koha/admin/matching-rules.pl";
 
@@ -47,8 +47,12 @@ $template->param(script_name => $script_name);
 
 my $matcher_id = $input->param("matcher_id");
 
-$template->param(max_matchpoint => 0);
-$template->param(max_matchcheck => 0);
+$template->param( max_matchpoint => 0 );
+$template->param( max_matchcheck => 0 );
+my @valid_norms = C4::Matcher::valid_normalization_routines();
+unshift @valid_norms, 'none';
+$template->param( valid_norms => \@valid_norms );
+
 my $display_list = 0;
 if ($op eq "edit_matching_rule") {
     edit_matching_rule_form($template, $matcher_id);
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/matching-rules.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/matching-rules.tt
index acb33a7638..07bbc7af91 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/matching-rules.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/matching-rules.tt
@@ -13,6 +13,39 @@
 </title>
 [% INCLUDE 'doc-head-close.inc' %]
 
+[% BLOCK norms_text %]
+[%    SWITCH norm %]
+[%        CASE 'none'           %]None
+[%        CASE 'remove_spaces'  %]Remove spaces
+[%        CASE 'upper_case'     %]Uppercase
+[%        CASE 'lower_case'     %]Lowercase
+[%        CASE 'legacy_default' %]Legacy default
+[%        CASE %][% norm %]
+[%    END %]
+[% END %]
+
+[% BLOCK norms_options %]
+[%# PARAMS: selected_norm %]
+[%    FOREACH norm IN valid_norms %]
+[%        IF ( norm == selected_norm ) %]
+        <option value="[% norm %]" selected="selected">[% PROCESS norms_text norm=norm %]</option>
+[%        ELSE %]
+        <option value="[% norm %]">[% PROCESS norms_text norm=norm %]</option>
+[%        END %]
+[%    END %]
+[% END %]
+
+[% BLOCK norms_select %]
+[%# PARAMS: selected_norm, id, name %]
+[%    UNLESS valid_norms.grep(selected_norm).size %]
+[%#       Fallback to 'none' %]
+[%        selected_norm = 'none' %]
+[%    END %]
+    <select id="[% id %]" name="[% name %]">
+[%    PROCESS norms_options selected_norm=selected_norm %]
+    </select>
+[% END %]
+
 <script type="text/javascript">
 //<![CDATA[
 
@@ -295,10 +328,11 @@ function CheckRuleForm(f) {
               [% FOREACH norm IN component.norms %]
               <li id="mp_[% matchpoint.mp_num %]_c_[% component.comp_num %]_n_[% norm.norm_num %]">
                 <label for="mp_[% matchpoint.mp_num %]_c_[% component.comp_num %]_n__[% norm.norm_num %]_norm">Normalization rule: </label>
-                <input type="text" id="mp_[% norm.mp_num %]_c_[% component.comp_num %]_n__[% norm.norm_num %]_norm" 
-                       name="mp_[% matchpoint.mp_num %]_c_[% component.comp_num %]_n_[% norm.norm_num %]_norm" 
-                       value="[% norm.norm |html %]"
-                       size="20" maxlength="50" />
+                [% PROCESS norms_select
+                     selected_norm=norm.norm
+                     id="mp_${norm.mp_num}_c_${component.comp_num}_n__${norm.norm_num}_norm"
+                     name="mp_${matchpoint.mp_num}_c_${component.comp_num}_n_${norm.norm_num}_norm"
+                %]
               </li>
               [% END %]
         </ol>
@@ -346,7 +380,11 @@ function CheckRuleForm(f) {
           </li>
             <li id="mp_1_c_1_n_1">
               <label for="mp_1_c_1_n_1_norm">Normalization rule: </label>
-              <input type="text" id="mp_1_c_1_n_1_norm" name="mp_1_c_1_n_1_norm" size="20" maxlength="50" />
+                [% PROCESS norms_select
+                     selected_norm="none"
+                     id="mp_1_c_1_n_1_norm"
+                     name="mp_1_c_1_n_1_norm"
+                %]
             </li>
         </ol>
     </fieldset>
@@ -403,10 +441,11 @@ function CheckRuleForm(f) {
           [% FOREACH norm IN src_component.norms %]
             <li id="mc_[% matchcheck.mc_num %]_src_c_[% src_component.comp_num %]_n_[% norm.norm_num %]">
               <label for="mc_[% matchcheck.mc_num %]_src_c_[% src_component.comp_num %]_n_[% norm.norm_num %]_norm">Normalization rule: </label>
-              <input type="text" id="mc_[% matchcheck.mc_num %]_src_c_[% src_component.comp_num %]_n_[% norm.norm_num %]_norm" 
-                     name="mc_[% matchcheck.mc_num %]_src_c_[% src_component.comp_num %]_n_[% norm.norm_num %]_norm" 
-                    value="[% norm.norm |html %]"
-                    size="20" maxlength="50" />
+               [% PROCESS norms_select
+                     selected_norm=norm.norm
+                     id="mc_${matchcheck.mc_num}_src_c_${src_component.comp_num}_n_${norm.norm_num}_norm"
+                     name="mc_${matchcheck.mc_num}_src_c_${src_component.comp_num}_n_${norm.norm_num}_norm"
+                %]
             </li>
           [% END %]
         </ol>
@@ -447,10 +486,11 @@ function CheckRuleForm(f) {
           [% FOREACH norm IN tgt_component.norms %]
             <li id="mc_[% matchcheck.mc_num %]_tgt_c_[% tgt_component.comp_num %]_n_[% norm.norm_num %]">
               <label for="mc_[% matchcheck.mc_num %]_tgt_c_[% tgt_component.comp_num %]_n_[% norm.norm_num %]_norm">Normalization rule: </label>
-              <input type="text" id="mc_[% matchcheck.mc_num %]_tgt_c_[% tgt_component.comp_num %]_n_[% norm.norm_num %]_norm" 
-                     name="mc_[% matchcheck.mc_num %]_tgt_c_[% tgt_component.comp_num %]_n_[% norm.norm_num %]_norm" 
-                    value="[% norm.norm |html %]"
-                    size="20" maxlength="50" />
+               [% PROCESS norms_select
+                     selected_norm=norm.norm
+                     id="mc_${matchcheck.mc_num}_tgt_c_${tgt_component.comp_num}_n_${norm.norm_num}_norm"
+                     name="mc_${matchcheck.mc_num}_tgt_c_${tgt_component.comp_num}_n_${norm.norm_num}_norm"
+                %]
             </li>
           [% END %]
         </ol>
@@ -486,7 +526,11 @@ function CheckRuleForm(f) {
           </li>
             <li id="mc_1_src_c_1_n_1">
               <label for="mc_1_src_c_1_n_1_norm">Normalization rule: </label>
-              <input type="text" id="mc_1_src_c_1_n_1_norm" name="mc_1_src_c_1_n_1_norm" size="20" maxlength="50" />
+               [% PROCESS norms_select
+                     selected_norm="none"
+                     id="mc_1_src_c_1_n_1_norm"
+                     name="mc_1_src_c_1_n_1_norm"
+                %]
             </li>
         </ol>
       </fieldset>
@@ -512,7 +556,11 @@ function CheckRuleForm(f) {
           </li>
             <li id="mc_1_tgt_c_1_n_1">
               <label for="mc_1_tgt_c_1_n_1_norm">Normalization rule: </label>
-              <input type="text" id="mc_1_tgt_c_1_n_1_norm" name="mc_1_tgt_c_1_n_1_norm" size="20" maxlength="50" />
+               [% PROCESS norms_select
+                     selected_norm="none"
+                     id="mc_1_tgt_c_1_n_1_norm"
+                     name="mc_1_tgt_c_1_n_1_norm"
+                %]
             </li>
         </ol>
       </fieldset>
@@ -623,7 +671,11 @@ function CheckRuleForm(f) {
           </li>
             <li id="mp_num_c_1_n_1">
               <label for="mp_num_c_1_n_1_norm">Normalization rule: </label>
-              <input type="text" id="mp_num_c_1_n_1_norm" name="mp_num_c_1_n_1_norm" size="20" maxlength="50" />
+               [% PROCESS norms_select
+                     selected_norm="none"
+                     id="mp_num_c_1_n_1_norm"
+                     name="mp_num_c_1_n_1_norm"
+                %]
             </li>
         </ol>
       </fieldset>
@@ -656,7 +708,11 @@ function CheckRuleForm(f) {
         </li>
           <li id="mc_num_src_c_1_n_1">
             <label for="mc_num_src_c_1_n_1_norm">Normalization rule: </label>
-            <input type="text" id="mc_num_src_c_1_n_1_norm" name="mc_num_src_c_1_n_1_norm" size="20" maxlength="50" />
+               [% PROCESS norms_select
+                     selected_norm="none"
+                     id="mc_num_src_c_1_n_1_norm"
+                     name="mc_num_src_c_1_n_1_norm"
+                %]
           </li>
       </ol>
     </fieldset>
@@ -681,7 +737,11 @@ function CheckRuleForm(f) {
         </li>
           <li id="mc_num_tgt_c_1_n_1">
             <label for="mc_num_tgt_c_1_n_1_norm">Normalization rule: </label>
-            <input type="text" id="mc_num_tgt_c_1_n_1_norm" name="mc_num_tgt_c_1_n_1_norm" size="20" maxlength="50" />
+               [% PROCESS norms_select
+                     selected_norm="none"
+                     id="mc_num_tgt_c_1_n_1_norm"
+                     name="mc_num_tgt_c_1_n_1_norm"
+                %]
           </li>
       </ol>
     </fieldset>
-- 
2.39.5