tools/letter.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2000-2002 Katipo Communications
   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 =head1 tools/letter.pl
  21
  22  ALGO :
  23  this script use an $op to know what to do.
  24  if $op is empty or none of the values listed below,
  25         - the default screen is built (with all or filtered (if search string is set) records).
  26         - the   user can click on add, modify or delete record.
  27     - filtering is done on the code field
  28  if $op=add_form
  29         - if primary key (module + code) exists, this is a modification,so we read the required record
  30         - builds the add/modify form
  31  if $op=add_validate
  32         - the user has just send data, so we create/modify the record
  33  if $op=delete_form
  34         - we show the record selected and ask for confirmation
  35  if $op=delete_confirm
  36         - we delete the designated record
  37
  38 =cut
  39
  40 # TODO This script drives the CRUD operations on the letter table
  41 # The DB interaction should be handled by calls to C4/Letters.pm
  42
  43 use Modern::Perl;
  44 use CGI qw ( -utf8 );
  45 use C4::Auth;
  46 use C4::Context;
  47 use C4::Output;
  48 use C4::Letters;
  49
  50 use Koha::Patron::Attribute::Types;
  51
  52 # $protected_letters = protected_letters()
  53 # - return a hashref of letter_codes representing letters that should never be deleted
  54 sub protected_letters {
  55     my $dbh = C4::Context->dbh;
  56     my $codes = $dbh->selectall_arrayref(q{SELECT DISTINCT letter_code FROM message_transports});
  57     return { map { $_->[0] => 1 } @{$codes} };
  58 }
  59
  60 our $input       = CGI->new;
  61 my $searchfield = $input->param('searchfield');
  62 my $script_name = '/cgi-bin/koha/tools/letter.pl';
  63 our $branchcode  = $input->param('branchcode');
  64 $branchcode = '' if defined $branchcode and $branchcode eq '*';
  65 my $code        = $input->param('code');
  66 my $module      = $input->param('module') || '';
  67 my $content     = $input->param('content');
  68 my $op          = $input->param('op') || '';
  69 my $redirect    = $input->param('redirect');
  70 my $section     = $input->param('section');
  71
  72 my $dbh = C4::Context->dbh;
  73
  74 our ( $template, $borrowernumber, $cookie, $staffflags ) = get_template_and_user(
  75     {
  76         template_name   => 'tools/letter.tt',
  77         query           => $input,
  78         type            => 'intranet',
  79         flagsrequired   => { tools => 'edit_notices' },
  80         debug           => 1,
  81     }
  82 );
  83
  84 our $my_branch = C4::Context->preference("IndependentBranches") && !$staffflags->{'superlibrarian'}
  85   ?  C4::Context->userenv()->{'branch'}
  86   : undef;
  87 # we show only the TMPL_VAR names $op
  88
  89 $template->param(
  90     independant_branch => $my_branch,
  91         script_name => $script_name,
  92   searchfield => $searchfield,
  93     branchcode => $branchcode,
  94     section => $section,
  95         action => $script_name
  96 );
  97
  98 if ( $op eq 'add_validate' or $op eq 'copy_validate' ) {
  99     add_validate();
 100     if( $redirect eq "just_save" ){
 101         print $input->redirect("/cgi-bin/koha/tools/letter.pl?op=add_form&branchcode=$branchcode&module=$module&code=$code&redirect=done&section=$section");
 102         exit;
 103     } else {
 104         $op = q{}; # we return to the default screen for the next operation
 105     }
 106 }
 107 if ($op eq 'copy_form') {
 108     my $oldbranchcode = $input->param('oldbranchcode') || q||;
 109     my $branchcode = $input->param('branchcode');
 110     add_form($oldbranchcode, $module, $code);
 111     $template->param(
 112         oldbranchcode => $oldbranchcode,
 113         branchcode => $branchcode,
 114         copying => 1,
 115         modify => 0,
 116     );
 117 }
 118 elsif ( $op eq 'add_form' ) {
 119     add_form($branchcode, $module, $code);
 120 }
 121 elsif ( $op eq 'delete_confirm' ) {
 122     delete_confirm($branchcode, $module, $code);
 123 }
 124 elsif ( $op eq 'delete_confirmed' ) {
 125     delete_confirmed($branchcode, $module, $code);
 126     $op = q{}; # next operation is to return to default screen
 127 }
 128 else {
 129     default_display($branchcode,$searchfield);
 130 }
 131
 132 # Do this last as delete_confirmed resets
 133 if ($op) {
 134     $template->param($op  => 1);
 135 } else {
 136     $template->param(no_op_set => 1);
 137 }
 138
 139 output_html_with_http_headers $input, $cookie, $template->output;
 140
 141 sub add_form {
 142     my ( $branchcode,$module, $code ) = @_;
 143
 144     my $letters;
 145     # if code has been passed we can identify letter and its an update action
 146     if ($code) {
 147         $letters = C4::Letters::GetLetterTemplates(
 148             {
 149                 branchcode => $branchcode,
 150                 module     => $module,
 151                 code       => $code,
 152             }
 153         );
 154     }
 155
 156     my $message_transport_types = GetMessageTransportTypes();
 157     my $templates = { map { $_ => { message_transport_type => $_ } } sort @$message_transport_types };
 158     my %letters = ( default => { templates => $templates } );
 159
 160     if ( C4::Context->preference('TranslateNotices') ) {
 161         my $translated_languages =
 162           C4::Languages::getTranslatedLanguages( 'opac',
 163             C4::Context->preference('template') );
 164         for my $language (@$translated_languages) {
 165             for my $sublanguage( @{ $language->{sublanguages_loop} } ) {
 166                 if ( $language->{plural} ) {
 167                     $letters{ $sublanguage->{rfc4646_subtag} } = {
 168                         description => $sublanguage->{native_description}
 169                           . ' '
 170                           . $sublanguage->{region_description} . ' ('
 171                           . $sublanguage->{rfc4646_subtag} . ')',
 172                         templates => { %$templates },
 173                     };
 174                 }
 175                 else {
 176                     $letters{ $sublanguage->{rfc4646_subtag} } = {
 177                         description => $sublanguage->{native_description}
 178                           . ' ('
 179                           . $sublanguage->{rfc4646_subtag} . ')',
 180                         templates => { %$templates },
 181                     };
 182                 }
 183             }
 184         }
 185         $template->param( languages => $translated_languages );
 186     }
 187     if ($letters) {
 188         $template->param(
 189             modify     => 1,
 190             code       => $code,
 191         );
 192         my $first_flag_name = 1;
 193         my $lang;
 194         # The letter name is contained into each mtt row.
 195         # So we can only sent the first one to the template.
 196         for my $letter ( @$letters ) {
 197             # The letter_name
 198             if ( $first_flag_name and $letter->{name} ) {
 199                 $template->param(
 200                     letter_name=> $letter->{name},
 201                 );
 202                 $first_flag_name = 0;
 203             }
 204
 205             my $lang = $letter->{lang};
 206             my $mtt = $letter->{message_transport_type};
 207             $letters{ $lang }{templates}{$mtt} = {
 208                 message_transport_type => $letter->{message_transport_type},
 209                 is_html    => $letter->{is_html},
 210                 updated_on => $letter->{updated_on},
 211                 title      => $letter->{title},
 212                 content    => $letter->{content} // '',
 213             };
 214         }
 215     }
 216     else {
 217         $template->param( adding => 1 );
 218     }
 219
 220     $template->param(
 221         letters => \%letters,
 222     );
 223
 224     my $field_selection;
 225     push @{$field_selection}, add_fields('branches');
 226     if ($module eq 'reserves') {
 227         push @{$field_selection}, add_fields('borrowers', 'reserves', 'biblio', 'biblioitems', 'items');
 228     }
 229     elsif ( $module eq 'acquisition' ) {
 230         push @{$field_selection}, add_fields('aqbooksellers', 'aqorders', 'biblio', 'items');
 231     }
 232     elsif ($module eq 'claimacquisition' || $module eq 'orderacquisition') {
 233         push @{$field_selection}, add_fields('aqbooksellers', 'aqbasket', 'aqorders', 'biblio', 'biblioitems');
 234     }
 235     elsif ($module eq 'claimissues') {
 236         push @{$field_selection}, add_fields('aqbooksellers', 'serial', 'subscription', 'biblio', 'biblioitems');
 237     }
 238     elsif ($module eq 'serial') {
 239         push @{$field_selection}, add_fields('branches', 'biblio', 'biblioitems', 'borrowers', 'subscription', 'serial');
 240     }
 241     elsif ($module eq 'suggestions') {
 242         push @{$field_selection}, add_fields('suggestions', 'borrowers', 'biblio');
 243     }
 244     else {
 245         push @{$field_selection}, add_fields('biblio','biblioitems'),
 246             add_fields('items'),
 247             {value => 'items.content', text => 'items.content'},
 248             {value => 'items.fine',    text => 'items.fine'},
 249             add_fields('borrowers');
 250         if ($module eq 'circulation') {
 251             push @{$field_selection}, add_fields('opac_news');
 252
 253         }
 254
 255         if ( $module eq 'circulation' and $code and ( $code eq "CHECKIN" or $code eq "CHECKINSLIP" ) ) {
 256             push @{$field_selection}, add_fields('old_issues');
 257         } else {
 258             push @{$field_selection}, add_fields('issues');
 259         }
 260
 261         if ( $module eq 'circulation' and $code and $code =~ /^AR_/  ) {
 262             push @{$field_selection}, add_fields('article_requests');
 263         }
 264
 265         if ( $module eq 'members' and $code and $code eq 'PROBLEM_REPORT' ) {
 266             push @{$field_selection}, add_fields('problem_reports');
 267         }
 268
 269         if ( $module eq 'ill' ) {
 270             push @{$field_selection}, add_fields('illrequests');
 271         }
 272     }
 273
 274     my $preview_is_available = 0;
 275
 276     if ($code) {
 277         $preview_is_available = grep {$_ eq $code } qw( CHECKIN CHECKOUT HOLD_SLIP );
 278     }
 279
 280     $template->param(
 281         module     => $module,
 282         SQLfieldnames => $field_selection,
 283         branchcode => $branchcode,
 284         preview_is_available => $preview_is_available,
 285     );
 286     return;
 287 }
 288
 289 sub add_validate {
 290     my $dbh        = C4::Context->dbh;
 291     my $branchcode    = $input->param('branchcode');
 292     my $module        = $input->param('module');
 293     my $oldmodule     = $input->param('oldmodule');
 294     my $code          = $input->param('code');
 295     my $name          = $input->param('name');
 296     my @mtt           = $input->multi_param('message_transport_type');
 297     my @title         = $input->multi_param('title');
 298     my @content       = $input->multi_param('content');
 299     my @lang          = $input->multi_param('lang');
 300     for my $mtt ( @mtt ) {
 301         my $lang = shift @lang;
 302         my $is_html = $input->param("is_html_$mtt\_$lang");
 303         my $title   = shift @title;
 304         my $content = shift @content;
 305         my $letter = C4::Letters::getletter( $oldmodule, $code, $branchcode, $mtt, $lang );
 306
 307         # getletter can return the default letter even if we pass a branchcode
 308         # If we got the default one and we needed the specific one, we didn't get the one we needed!
 309         if ( $letter and $branchcode and $branchcode ne $letter->{branchcode} ) {
 310             $letter = undef;
 311         }
 312         unless ( $title and $content ) {
 313             # Delete this mtt if no title or content given
 314             delete_confirmed( $branchcode, $oldmodule, $code, $mtt, $lang );
 315             next;
 316         }
 317         elsif ( $letter and $letter->{message_transport_type} eq $mtt and $letter->{lang} eq $lang ) {
 318             $dbh->do(
 319                 q{
 320                     UPDATE letter
 321                     SET branchcode = ?, module = ?, name = ?, is_html = ?, title = ?, content = ?, lang = ?
 322                     WHERE branchcode = ? AND module = ? AND code = ? AND message_transport_type = ? AND lang = ?
 323                 },
 324                 undef,
 325                 $branchcode || '', $module, $name, $is_html || 0, $title, $content, $lang,
 326                 $branchcode, $oldmodule, $code, $mtt, $lang
 327             );
 328         } else {
 329             $dbh->do(
 330                 q{INSERT INTO letter (branchcode,module,code,name,is_html,title,content,message_transport_type, lang) VALUES (?,?,?,?,?,?,?,?,?)},
 331                 undef,
 332                 $branchcode || '', $module, $code, $name, $is_html || 0, $title, $content, $mtt, $lang
 333             );
 334         }
 335     }
 336     # set up default display
 337     default_display($branchcode);
 338     return 1;
 339 }
 340
 341 sub delete_confirm {
 342     my ($branchcode, $module, $code) = @_;
 343     my $dbh = C4::Context->dbh;
 344     my $letter = C4::Letters::getletter($module, $code, $branchcode);
 345     my @values = values %$letter;
 346     $template->param(
 347         letter => $letter,
 348     );
 349     return;
 350 }
 351
 352 sub delete_confirmed {
 353     my ($branchcode, $module, $code, $mtt, $lang) = @_;
 354     C4::Letters::DelLetter(
 355         {
 356             branchcode => $branchcode || '',
 357             module     => $module,
 358             code       => $code,
 359             mtt        => $mtt,
 360             lang       => $lang,
 361         }
 362     );
 363     # setup default display for screen
 364     default_display($branchcode);
 365     return;
 366 }
 367
 368 sub retrieve_letters {
 369     my ($branchcode, $searchstring) = @_;
 370
 371     $branchcode = $my_branch if $branchcode && $my_branch;
 372
 373     my $dbh = C4::Context->dbh;
 374     my ($sql, @where, @args);
 375     $sql = "SELECT branchcode, module, code, name, branchname, MAX(updated_on) as updated_on
 376             FROM letter
 377             LEFT OUTER JOIN branches USING (branchcode)
 378     ";
 379     if ($searchstring && $searchstring=~m/(\S+)/) {
 380         $searchstring = $1 . q{%};
 381         push @where, 'code LIKE ?';
 382         push @args, $searchstring;
 383     }
 384     elsif ($branchcode) {
 385         push @where, 'branchcode = ?';
 386         push @args, $branchcode || '';
 387     }
 388     elsif ($my_branch) {
 389         push @where, "(branchcode = ? OR branchcode = '')";
 390         push @args, $my_branch;
 391     }
 392
 393     $sql .= " WHERE ".join(" AND ", @where) if @where;
 394     $sql .= " GROUP BY branchcode,module,code,name,branchname";
 395
 396     $sql .= " ORDER BY module, code, branchcode";
 397
 398     return $dbh->selectall_arrayref($sql, { Slice => {} }, @args);
 399 }
 400
 401 sub default_display {
 402     my ($branchcode, $searchfield) = @_;
 403
 404     unless ( defined $branchcode ) {
 405         if ( C4::Context->preference('DefaultToLoggedInLibraryNoticesSlips') ) {
 406             $branchcode = C4::Context::mybranch();
 407         }
 408     }
 409
 410     if ( $searchfield  ) {
 411         $template->param( search      => 1 );
 412     }
 413     my $results = retrieve_letters($branchcode,$searchfield);
 414
 415     my $loop_data = [];
 416     my $protected_letters = protected_letters();
 417     foreach my $row (@{$results}) {
 418         $row->{protected} = !$row->{branchcode} && $protected_letters->{ $row->{code} };
 419         push @{$loop_data}, $row;
 420
 421     }
 422
 423     $template->param(
 424         letter => $loop_data,
 425         branchcode => $branchcode,
 426     );
 427 }
 428
 429 sub add_fields {
 430     my @tables = @_;
 431     my @fields = ();
 432
 433     for my $table (@tables) {
 434         push @fields, get_columns_for($table);
 435
 436     }
 437     return @fields;
 438 }
 439
 440 sub get_columns_for {
 441     my $table = shift;
 442 # FIXME untranslatable
 443     my %column_map = (
 444         aqbooksellers => '---BOOKSELLERS---',
 445         aqorders      => '---ORDERS---',
 446         serial        => '---SERIALS---',
 447         reserves      => '---HOLDS---',
 448         suggestions   => '---SUGGESTIONS---',
 449     );
 450     my @fields = ();
 451     if (exists $column_map{$table} ) {
 452         push @fields, {
 453             value => q{},
 454             text  => $column_map{$table} ,
 455         };
 456     }
 457     else {
 458         my $tlabel = '---' . uc $table;
 459         $tlabel.= '---';
 460         push @fields, {
 461             value => q{},
 462             text  => $tlabel,
 463         };
 464     }
 465
 466     my $sql = "SHOW COLUMNS FROM $table";# TODO not db agnostic
 467     my $table_prefix = $table . q|.|;
 468     my $rows = C4::Context->dbh->selectall_arrayref($sql, { Slice => {} });
 469     for my $row (@{$rows}) {
 470         next if $row->{'Field'} eq 'timestamp'; # this is really an irrelevant field and there may be other common fields that should be excluded from the list
 471         push @fields, {
 472             value => $table_prefix . $row->{Field},
 473             text  => $table_prefix . $row->{Field},
 474         }
 475     }
 476     if ($table eq 'borrowers') {
 477         my $attribute_types = Koha::Patron::Attribute::Types->search(
 478             {},
 479             { order_by => 'code' },
 480         );
 481         while ( my $at = $attribute_types->next ) {
 482             push @fields, {
 483                 value => "borrower-attribute:" . $at->code,
 484                 text  => "attribute:" . $at->code,
 485             }
 486         }
 487     }
 488     return @fields;
 489 }