admin/matching-rules.pl

   1 #! /usr/bin/perl
   2 #
   3 # Copyright 2007 LibLime
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19 #
  20
  21 use Modern::Perl;
  22
  23 use CGI qw ( -utf8 );
  24 use C4::Auth;
  25 use C4::Context;
  26 use C4::Output;
  27 use C4::Koha;
  28 use C4::Matcher qw/valid_normalization_routines/;
  29
  30 my $script_name = "/cgi-bin/koha/admin/matching-rules.pl";
  31
  32 our $input = new CGI;
  33 my $op = $input->param('op') || '';
  34
  35
  36 my ($template, $loggedinuser, $cookie)
  37     = get_template_and_user({template_name => "admin/matching-rules.tt",
  38                  query => $input,
  39                  type => "intranet",
  40                  authnotrequired => 0,
  41                  flagsrequired => { parameters => 'manage_matching_rules' },
  42                  debug => 1,
  43                  });
  44
  45 $template->param(script_name => $script_name);
  46
  47 my $matcher_id = $input->param("matcher_id");
  48
  49 $template->param( max_matchpoint => 0 );
  50 $template->param( max_matchcheck => 0 );
  51 my @valid_norms = C4::Matcher::valid_normalization_routines();
  52 unshift @valid_norms, 'none';
  53 $template->param( valid_norms => \@valid_norms );
  54
  55 my $display_list = 0;
  56 if ($op eq "edit_matching_rule") {
  57     edit_matching_rule_form($template, $matcher_id);
  58 } elsif ($op eq "edit_matching_rule_confirmed") {
  59     add_update_matching_rule($template, $matcher_id);
  60     $display_list = 1;
  61 } elsif ($op eq "add_matching_rule") {
  62     add_matching_rule_form($template);
  63 } elsif ($op eq "add_matching_rule_confirmed") {
  64     add_update_matching_rule($template, $matcher_id);
  65     $display_list = 1;
  66 } elsif ($op eq "delete_matching_rule") {
  67     delete_matching_rule_form($template, $matcher_id);
  68 } elsif ($op eq "delete_matching_rule_confirmed") {
  69     delete_matching_rule($template, $matcher_id);
  70     $display_list = 1;
  71 } else {
  72     $display_list = 1;
  73 }
  74
  75 if ($display_list) {
  76     matching_rule_list($template);
  77 }
  78
  79 output_html_with_http_headers $input, $cookie, $template->output;
  80
  81 exit 0;
  82
  83 sub add_matching_rule_form {
  84     my $template = shift;
  85
  86     $template->param(
  87         matching_rule_form => 1,
  88         confirm_op => 'add_matching_rule_confirmed',
  89         max_matchpoint => 1,
  90         max_matchcheck => 1
  91     );
  92
  93 }
  94
  95 sub add_update_matching_rule {
  96     my $template = shift;
  97     my $matcher_id = shift;
  98     my $record_type = $input->param('record_type') || 'biblio';
  99
 100     # do parsing
 101     my $matcher = C4::Matcher->new($record_type, 1000);
 102     $matcher->code(scalar $input->param('code'));
 103     $matcher->description(scalar $input->param('description'));
 104     $matcher->threshold(scalar $input->param('threshold'));
 105
 106     # matchpoints
 107     my @mp_nums = sort map { /^mp_(\d+)_search_index/ ? int($1): () } $input->multi_param;
 108     foreach my $mp_num (@mp_nums) {
 109         my $index = $input->param("mp_${mp_num}_search_index");
 110         my $score = $input->param("mp_${mp_num}_score");
 111         # components
 112         my $components = [];
 113         my @comp_nums = sort map { /^mp_${mp_num}_c_(\d+)_tag/ ? int($1): () } $input->multi_param;
 114         foreach my $comp_num (@comp_nums) {
 115             my $component = {};
 116             $component->{'tag'} = $input->param("mp_${mp_num}_c_${comp_num}_tag");
 117             $component->{'subfields'} = $input->param("mp_${mp_num}_c_${comp_num}_subfields");
 118             $component->{'offset'} = $input->param("mp_${mp_num}_c_${comp_num}_offset");
 119             $component->{'length'} = $input->param("mp_${mp_num}_c_${comp_num}_length");
 120             # norms
 121             $component->{'norms'} = [];
 122             my @norm_nums = sort map { /^mp_${mp_num}_c_${comp_num}_n_(\d+)_norm/ ? int($1): () } $input->multi_param;
 123             foreach my $norm_num (@norm_nums) {
 124                 push @{ $component->{'norms'} }, $input->multi_param("mp_${mp_num}_c_${comp_num}_n_${norm_num}_norm");
 125             }
 126             push @$components, $component;
 127         }
 128         $matcher->add_matchpoint($index, $score, $components);
 129     }
 130
 131     # match checks
 132     my @mc_nums = sort map { /^mc_(\d+)_id/ ? int($1): () } $input->multi_param;
 133     foreach my $mc_num (@mc_nums) {
 134         # source components
 135         my $src_components = [];
 136         my @src_comp_nums = sort map { /^mc_${mc_num}_src_c_(\d+)_tag/ ? int($1): () } $input->multi_param;
 137         foreach my $comp_num (@src_comp_nums) {
 138             my $component = {};
 139             $component->{'tag'} = $input->param("mc_${mc_num}_src_c_${comp_num}_tag");
 140             $component->{'subfields'} = $input->param("mc_${mc_num}_src_c_${comp_num}_subfields");
 141             $component->{'offset'} = $input->param("mc_${mc_num}_src_c_${comp_num}_offset");
 142             $component->{'length'} = $input->param("mc_${mc_num}_src_c_${comp_num}_length");
 143             # norms
 144             $component->{'norms'} = [];
 145             my @norm_nums = sort map { /^mc_${mc_num}_src_c_${comp_num}_n_(\d+)_norm/ ? int($1): () } $input->multi_param;
 146             foreach my $norm_num (@norm_nums) {
 147                 push @{ $component->{'norms'} }, $input->multi_param("mc_${mc_num}_src_c_${comp_num}_n_${norm_num}_norm");
 148             }
 149             push @$src_components, $component;
 150         }
 151         # target components
 152         my $tgt_components = [];
 153         my @tgt_comp_nums = sort map { /^mc_${mc_num}_tgt_c_(\d+)_tag/ ? int($1): () } $input->multi_param;
 154         foreach my $comp_num (@tgt_comp_nums) {
 155             my $component = {};
 156             $component->{'tag'} = $input->param("mc_${mc_num}_tgt_c_${comp_num}_tag");
 157             $component->{'subfields'} = $input->param("mc_${mc_num}_tgt_c_${comp_num}_subfields");
 158             $component->{'offset'} = $input->param("mc_${mc_num}_tgt_c_${comp_num}_offset");
 159             $component->{'length'} = $input->param("mc_${mc_num}_tgt_c_${comp_num}_length");
 160             # norms
 161             $component->{'norms'} = [];
 162             my @norm_nums = sort map { /^mc_${mc_num}_tgt_c_${comp_num}_n_(\d+)_norm/ ? int($1): () } $input->multi_param;
 163             foreach my $norm_num (@norm_nums) {
 164                 push @{ $component->{'norms'} }, $input->multi_param("mc_${mc_num}_tgt_c_${comp_num}_n_${norm_num}_norm");
 165             }
 166             push @$tgt_components, $component;
 167         }
 168         $matcher->add_required_check($src_components, $tgt_components);
 169     }
 170
 171     if (defined $matcher_id and $matcher_id =~ /^\d+/) {
 172         $matcher->_id($matcher_id);
 173         $template->param(edited_matching_rule => $matcher->code());
 174     } else {
 175         $template->param(added_matching_rule => $matcher->code());
 176     }
 177     $matcher_id = $matcher->store();
 178 }
 179
 180 sub delete_matching_rule_form {
 181     my $template = shift;
 182     my $matcher_id = shift;
 183
 184     my $matcher = C4::Matcher->fetch($matcher_id);
 185     $template->param(
 186         delete_matching_rule_form => 1,
 187         confirm_op => "delete_matching_rule_confirmed",
 188         matcher_id => $matcher_id,
 189         code => $matcher->code(),
 190         description => $matcher->description(),
 191     );
 192 }
 193
 194 sub delete_matching_rule {
 195     my $template = shift;
 196     my $matcher_id = shift;
 197
 198     my $matcher = C4::Matcher->fetch($matcher_id);
 199     $template->param(deleted_matching_rule => $matcher->code(),
 200                     );
 201     C4::Matcher->delete($matcher_id);
 202 }
 203
 204 sub edit_matching_rule_form {
 205     my $template = shift;
 206     my $matcher_id = shift;
 207
 208     my $matcher = C4::Matcher->fetch($matcher_id);
 209
 210     $template->{VARS}->{'matcher_id'} = $matcher_id;
 211     $template->{VARS}->{'code'} = $matcher->code();
 212     $template->{VARS}->{'description'} = $matcher->description();
 213     $template->{VARS}->{'threshold'} = $matcher->threshold();
 214     $template->{VARS}->{'record_type'} = $matcher->record_type();
 215
 216     my $matcher_info = $matcher->dump();
 217     my @matchpoints = ();
 218     my $mp_num = 0;
 219     foreach my $matchpoint (@{ $matcher_info->{'matchpoints'} }) {
 220         $mp_num++;
 221         my @components = _parse_components($matchpoint->{'components'});
 222         push @matchpoints, {
 223             mp_num => $mp_num,
 224             index => $matchpoint->{'index'},
 225             score => $matchpoint->{'score'},
 226             components => \@components
 227         };
 228     }
 229     $template->param(matchpoints => \@matchpoints);
 230
 231     my $mc_num = 0;
 232     my @matchchecks = ();
 233     foreach my $matchcheck (@{ $matcher_info->{'matchchecks'} }) {
 234         $mc_num++;
 235         my @src_components = _parse_components($matchcheck->{'source_matchpoint'}->{'components'});
 236         my @tgt_components = _parse_components($matchcheck->{'target_matchpoint'}->{'components'});
 237         push @matchchecks, {
 238             mc_num => $mc_num,
 239             src_components => \@src_components,
 240             tgt_components => \@tgt_components
 241         };
 242     }
 243     $template->param(matchchecks => \@matchchecks);
 244
 245     $template->param(
 246         matching_rule_form => 1,
 247         edit_matching_rule => 1,
 248         confirm_op => 'edit_matching_rule_confirmed',
 249         max_matchpoint => $mp_num,
 250         max_matchcheck => $mc_num
 251     );
 252
 253 }
 254
 255 sub _parse_components {
 256     my $components_ref = shift;
 257     my @components = ();
 258
 259     my $comp_num = 0;
 260     foreach my $component (@{ $components_ref  }) {
 261         $comp_num++;
 262         my $norm_num = 0;
 263         my @norms;
 264         foreach my $norm (@{ $component->{'norms'} }) {
 265             $norm_num++;
 266             push @norms, { norm_num => $norm_num, norm => $norm };
 267         }
 268         push @components, {
 269             comp_num => $comp_num,
 270             tag => $component->{'tag'},
 271             subfields => join("", sort keys %{ $component->{'subfields'} }),
 272             offset => $component->{'offset'},
 273             'length' => $component->{'length'},
 274             norms => \@norms
 275         };
 276     }
 277
 278     return @components;
 279 }
 280
 281 sub matching_rule_list {
 282     my $template = shift;
 283
 284     my @matching_rules = C4::Matcher::GetMatcherList();
 285     $template->param(available_matching_rules => \@matching_rules);
 286     $template->param(display_list => 1);
 287 }