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 Try::Tiny;
  46
  47 use C4::Auth qw( get_template_and_user );
  48 use C4::Context;
  49 use C4::Output qw( output_html_with_http_headers );
  50 use C4::Letters qw( GetMessageTransportTypes );
  51 use C4::Log qw( logaction );
  52
  53 use Koha::Notice::Templates;
  54 use Koha::Patron::Attribute::Types;
  55
  56 # $protected_letters = protected_letters()
  57 # - return a hashref of letter_codes representing letters that should never be deleted
  58 sub protected_letters {
  59     my $dbh = C4::Context->dbh;
  60     my $codes = $dbh->selectall_arrayref(q{SELECT DISTINCT letter_code FROM message_transports});
  61     return { map { $_->[0] => 1 } @{$codes} };
  62 }
  63
  64 our $input       = CGI->new;
  65 my $searchfield = $input->param('searchfield');
  66 my $script_name = '/cgi-bin/koha/tools/letter.pl';
  67 our $branchcode  = $input->param('branchcode');
  68 $branchcode = '' if defined $branchcode and $branchcode eq '*';
  69 my $code        = $input->param('code');
  70 my $module      = $input->param('module') || '';
  71 my $content     = $input->param('content');
  72 my $op          = $input->param('op') || '';
  73 my $redirect    = $input->param('redirect');
  74 my $section     = $input->param('section');
  75 my $langtab     = $input->param('langtab');
  76
  77 my $dbh = C4::Context->dbh;
  78
  79 our ( $template, $borrowernumber, $cookie, $staffflags ) = get_template_and_user(
  80     {
  81         template_name   => 'tools/letter.tt',
  82         query           => $input,
  83         type            => 'intranet',
  84         flagsrequired   => { tools => 'edit_notices' },
  85     }
  86 );
  87
  88 our $my_branch = C4::Context->preference("IndependentBranches") && !$staffflags->{'superlibrarian'}
  89   ?  C4::Context->userenv()->{'branch'}
  90   : undef;
  91 # we show only the TMPL_VAR names $op
  92
  93 $template->param(
  94     independant_branch => $my_branch,
  95     script_name        => $script_name,
  96     searchfield        => $searchfield,
  97     branchcode         => $branchcode,
  98     section            => $section,
  99     langtab            => $langtab,
 100     action             => $script_name
 101 );
 102
 103 if ( $op eq 'cud-add_validate' or $op eq 'cud-copy_validate' ) {
 104     add_validate();
 105     if( $redirect eq "just_save" ){
 106         print $input->redirect("/cgi-bin/koha/tools/letter.pl?op=add_form&branchcode=$branchcode&module=$module&code=$code&redirect=done&section=$section&langtab=$langtab");
 107         exit;
 108     } else {
 109         $op = q{}; # we return to the default screen for the next operation
 110     }
 111 }
 112 if ($op eq 'cud-copy_form') {
 113     my $oldbranchcode = $input->param('oldbranchcode') || q||;
 114     my $branchcode = $input->param('branchcode');
 115     add_form($oldbranchcode, $module, $code);
 116     $template->param(
 117         oldbranchcode => $oldbranchcode,
 118         branchcode => $branchcode,
 119         copying => 1,
 120         modify => 0,
 121     );
 122 }
 123 elsif ( $op eq 'add_form' ) {
 124     add_form($branchcode, $module, $code);
 125 }
 126 elsif ( $op eq 'delete_confirm' ) {
 127     delete_confirm($branchcode, $module, $code);
 128 }
 129 elsif ( $op eq 'cud-delete_confirmed' ) {
 130     delete_confirmed($branchcode, $module, $code);
 131     $op = q{}; # next operation is to return to default screen
 132 }
 133 else {
 134     default_display($branchcode,$searchfield);
 135 }
 136
 137 # Do this last as delete_confirmed resets
 138 if ($op) {
 139     $template->param($op  => 1);
 140 } else {
 141     $template->param(no_op_set => 1);
 142 }
 143
 144 output_html_with_http_headers $input, $cookie, $template->output;
 145
 146 sub add_form {
 147     my ( $branchcode,$module, $code ) = @_;
 148
 149     my $letters;
 150     # if code has been passed we can identify letter and its an update action
 151     if ($code) {
 152         $letters = C4::Letters::GetLetterTemplates(
 153             {
 154                 branchcode => $branchcode,
 155                 module     => $module,
 156                 code       => $code,
 157             }
 158         );
 159     }
 160
 161     my $message_transport_types = GetMessageTransportTypes();
 162     my $templates = { map { $_ => { message_transport_type => $_ } } sort @$message_transport_types };
 163     my %letters = ( default => { templates => $templates } );
 164
 165     if ( C4::Context->preference('TranslateNotices') ) {
 166         my $translated_languages =
 167           C4::Languages::getTranslatedLanguages( 'opac',
 168             C4::Context->preference('template') );
 169         for my $language (@$translated_languages) {
 170             for my $sublanguage( @{ $language->{sublanguages_loop} } ) {
 171                 if ( $language->{plural} ) {
 172                     $letters{ $sublanguage->{rfc4646_subtag} } = {
 173                         description => $sublanguage->{native_description}
 174                           . ' '
 175                           . $sublanguage->{region_description} . ' ('
 176                           . $sublanguage->{rfc4646_subtag} . ')',
 177                         templates => { %$templates },
 178                     };
 179                 }
 180                 else {
 181                     $letters{ $sublanguage->{rfc4646_subtag} } = {
 182                         description => $sublanguage->{native_description}
 183                           . ' ('
 184                           . $sublanguage->{rfc4646_subtag} . ')',
 185                         templates => { %$templates },
 186                     };
 187                 }
 188             }
 189         }
 190         $template->param( languages => $translated_languages );
 191     }
 192     if ($letters) {
 193         $template->param(
 194             modify     => 1,
 195             code       => $code,
 196         );
 197         my $first_flag_name = 1;
 198         my $lang;
 199
 200         # The letter name is contained into each mtt row.
 201         # So we can only sent the first one to the template.
 202         for my $letter ( @$letters ) {
 203             # The letter_name
 204             if ( $first_flag_name and $letter->{name} ) {
 205                 $template->param(
 206                     letter_name=> $letter->{name},
 207                 );
 208                 $first_flag_name = 0;
 209             }
 210
 211             # Catch template issues
 212             try {
 213                 C4::Letters::_process_tt($letter);
 214             } catch {
 215                 my $error = $_;
 216                 $error =~ s/^ERROR PROCESSING TEMPLATE: //;
 217                 $error =~ s/at .*\/tools\/letter\.pl line 213\.$//;
 218                 $letter->{tt_error} = $error;
 219             };
 220
 221             my $lang = $letter->{lang};
 222             my $mtt = $letter->{message_transport_type};
 223             $letters{ $lang }{templates}{$mtt} = {
 224                 message_transport_type => $letter->{message_transport_type},
 225                 is_html    => $letter->{is_html},
 226                 updated_on => $letter->{updated_on},
 227                 title      => $letter->{title},
 228                 content    => $letter->{content} // '',
 229                 tt_error   => $letter->{tt_error},
 230             };
 231         }
 232     }
 233     else {
 234         $template->param( adding => 1 );
 235     }
 236
 237     $template->param(
 238         letters => \%letters,
 239     );
 240
 241     my $field_selection;
 242     push @{$field_selection}, add_fields('branches');
 243     if ( $module eq 'reserves' ) {
 244         push @{$field_selection}, add_fields( 'borrowers', 'reserves', 'biblio', 'biblioitems', 'items' );
 245     } elsif ( $module eq 'acquisition' ) {
 246         push @{$field_selection}, add_fields( 'aqbooksellers', 'aqorders', 'biblio', 'items' );
 247     } elsif ( $module eq 'claimacquisition' || $module eq 'orderacquisition' ) {
 248         push @{$field_selection}, add_fields( 'aqbooksellers', 'aqbasket', 'aqorders', 'biblio', 'biblioitems' );
 249     } elsif ( $module eq 'claimissues' ) {
 250         push @{$field_selection}, add_fields( 'aqbooksellers', 'serial', 'subscription', 'biblio', 'biblioitems' );
 251     } elsif ( $module eq 'patron_slip' ) {
 252         push @{$field_selection}, add_fields('borrowers');
 253     } elsif ( $module eq 'serial' ) {
 254         push @{$field_selection},
 255             add_fields( 'branches', 'biblio', 'biblioitems', 'borrowers', 'subscription', 'serial' );
 256     } elsif ( $module eq 'suggestions' ) {
 257         push @{$field_selection}, add_fields( 'suggestions', 'borrowers', 'biblio' );
 258     } else {
 259         push @{$field_selection}, add_fields( 'biblio', 'biblioitems' ),
 260             add_fields('items'),
 261             { value => 'items.content', text => 'items.content' },
 262             { value => 'items.fine',    text => 'items.fine' },
 263             add_fields('borrowers');
 264         if ( $module eq 'circulation' ) {
 265             push @{$field_selection}, add_fields( 'additional_contents', 'recalls' );
 266
 267         }
 268
 269         if ( $module eq 'circulation' and $code and ( $code eq "CHECKIN" or $code eq "CHECKINSLIP" ) ) {
 270             push @{$field_selection}, add_fields('old_issues');
 271         } else {
 272             push @{$field_selection}, add_fields('issues');
 273         }
 274
 275         if ( $module eq 'circulation' and $code and $code =~ /^AR_/ ) {
 276             push @{$field_selection}, add_fields('article_requests');
 277         }
 278
 279         if ( $module eq 'members' and $code and $code eq 'PROBLEM_REPORT' ) {
 280             push @{$field_selection}, add_fields('problem_reports');
 281         }
 282
 283         if ( $module eq 'ill' ) {
 284             push @{$field_selection}, add_fields('illrequests');
 285         }
 286     }
 287
 288     my $preview_is_available = 0;
 289
 290     if ($code) {
 291         $preview_is_available = grep {$_ eq $code } qw( CHECKIN CHECKOUT HOLD_SLIP );
 292     }
 293
 294     $template->param(
 295         module     => $module,
 296         SQLfieldnames => $field_selection,
 297         branchcode => $branchcode,
 298         preview_is_available => $preview_is_available,
 299     );
 300     return;
 301 }
 302
 303 sub add_validate {
 304     my $dbh        = C4::Context->dbh;
 305     my $branchcode    = $input->param('branchcode');
 306     my $module        = $input->param('module');
 307     my $oldmodule     = $input->param('oldmodule');
 308     my $code          = $input->param('code');
 309     my $name          = $input->param('name');
 310     my @mtt           = $input->multi_param('message_transport_type');
 311     my @title         = $input->multi_param('title');
 312     my @content       = $input->multi_param('content');
 313     my @lang          = $input->multi_param('lang');
 314     for my $mtt ( @mtt ) {
 315         my $lang = shift @lang;
 316         my $is_html = $input->param("is_html_$mtt\_$lang");
 317         my $title   = shift @title;
 318         my $content = shift @content;
 319         my $letter = Koha::Notice::Templates->find(
 320             {
 321                 module                 => $oldmodule,
 322                 code                   => $code,
 323                 branchcode             => $branchcode,
 324                 message_transport_type => $mtt,
 325                 lang                   => $lang
 326             }
 327         );
 328
 329         unless ( $title and $content ) {
 330             # Delete this mtt if no title or content given
 331             delete_confirmed( $branchcode, $oldmodule, $code, $mtt, $lang );
 332             next;
 333         }
 334         elsif ( $letter ) {
 335             logaction( 'NOTICES', 'MODIFY', $letter->id, $content,
 336                 'Intranet' )
 337               if ( C4::Context->preference("NoticesLog")
 338                 && $content ne $letter->content );
 339
 340             $letter->set(
 341                 {
 342                     branchcode => $branchcode || '',
 343                     module     => $module,
 344                     name       => $name,
 345                     is_html    => $is_html || 0,
 346                     title      => $title,
 347                     content    => $content,
 348                     lang       => $lang
 349                 }
 350             )->store;
 351
 352         } else {
 353             my $letter = Koha::Notice::Template->new(
 354                 {
 355                     branchcode             => $branchcode,
 356                     module                 => $module,
 357                     code                   => $code,
 358                     name                   => $name,
 359                     is_html                => $is_html,
 360                     title                  => $title,
 361                     content                => $content,
 362                     message_transport_type => $mtt,
 363                     lang                   => $lang
 364                 }
 365             )->store;
 366             logaction( 'NOTICES', 'CREATE', $letter->id, $letter->content,
 367                 'Intranet' )
 368               if C4::Context->preference("NoticesLog");
 369         }
 370     }
 371     # set up default display
 372     default_display($branchcode);
 373     return 1;
 374 }
 375
 376 sub delete_confirm {
 377     my ($branchcode, $module, $code) = @_;
 378     my $dbh = C4::Context->dbh;
 379     my $letter = Koha::Notice::Templates->search(
 380         { module => $module, code => $code, branchcode => $branchcode } );
 381     $template->param(
 382         letter => $letter ? $letter->next : undef,
 383     );
 384     return;
 385 }
 386
 387 sub delete_confirmed {
 388     my ( $branchcode, $module, $code, $mtt, $lang ) = @_;
 389     my $letters = Koha::Notice::Templates->search(
 390         {
 391             branchcode => $branchcode || '',
 392             module     => $module,
 393             code       => $code,
 394             ( $mtt ? ( message_transport_type => $mtt ) : () ),
 395             ( $lang ? ( lang => $lang ) : () ),
 396         }
 397     );
 398     while ( my $letter = $letters->next ) {
 399         logaction( 'NOTICES', 'DELETE', $letter->id, $letter->content,
 400             'Intranet' )
 401           if C4::Context->preference("NoticesLog");
 402         $letter->delete;
 403     }
 404
 405     # setup default display for screen
 406     default_display($branchcode);
 407     return;
 408 }
 409
 410 sub retrieve_letters {
 411     my ($branchcode, $searchstring) = @_;
 412
 413     $branchcode = $my_branch if $branchcode && $my_branch;
 414
 415     my $dbh = C4::Context->dbh;
 416     my ($sql, @where, @args);
 417     $sql = "SELECT branchcode, module, code, name, branchname, MAX(updated_on) as updated_on
 418             FROM letter
 419             LEFT OUTER JOIN branches USING (branchcode)
 420     ";
 421     if ($searchstring && $searchstring=~m/(\S+)/) {
 422         $searchstring = $1 . q{%};
 423         push @where, 'code LIKE ?';
 424         push @args, $searchstring;
 425     }
 426     elsif ($branchcode) {
 427         push @where, 'branchcode = ?';
 428         push @args, $branchcode || '';
 429     }
 430     elsif ($my_branch) {
 431         push @where, "(branchcode = ? OR branchcode = '')";
 432         push @args, $my_branch;
 433     }
 434
 435     $sql .= " WHERE ".join(" AND ", @where) if @where;
 436     $sql .= " GROUP BY branchcode,module,code,name,branchname";
 437
 438     $sql .= " ORDER BY module, code, branchcode";
 439
 440     return $dbh->selectall_arrayref($sql, { Slice => {} }, @args);
 441 }
 442
 443 sub default_display {
 444     my ($branchcode, $searchfield) = @_;
 445
 446     unless ( defined $branchcode ) {
 447         if ( C4::Context->preference('DefaultToLoggedInLibraryNoticesSlips') ) {
 448             $branchcode = C4::Context::mybranch();
 449         }
 450     }
 451
 452     if ( $searchfield  ) {
 453         $template->param( search      => 1 );
 454     }
 455     my $results = retrieve_letters($branchcode,$searchfield);
 456
 457     my $loop_data = [];
 458     my $protected_letters = protected_letters();
 459
 460     foreach my $row (@{$results}) {
 461         $row->{protected} = !$row->{branchcode} && $protected_letters->{ $row->{code} };
 462         push @{$loop_data}, $row;
 463
 464     }
 465
 466     $template->param(
 467         letter => $loop_data,
 468         branchcode => $branchcode,
 469     );
 470 }
 471
 472 sub add_fields {
 473     my @tables = @_;
 474     my @fields = ();
 475
 476     for my $table (@tables) {
 477         push @fields, get_columns_for($table);
 478
 479     }
 480     return @fields;
 481 }
 482
 483 sub get_columns_for {
 484     my $table = shift;
 485 # FIXME untranslatable
 486     my %column_map = (
 487         aqbooksellers => '---BOOKSELLERS---',
 488         aqorders      => '---ORDERS---',
 489         serial        => '---SERIALS---',
 490         reserves      => '---HOLDS---',
 491         suggestions   => '---SUGGESTIONS---',
 492     );
 493     my @fields = ();
 494     if (exists $column_map{$table} ) {
 495         push @fields, {
 496             value => q{},
 497             text  => $column_map{$table} ,
 498         };
 499     }
 500     else {
 501         my $tlabel = '---' . uc $table;
 502         $tlabel.= '---';
 503         push @fields, {
 504             value => q{},
 505             text  => $tlabel,
 506         };
 507     }
 508
 509     my $sql = "SHOW COLUMNS FROM $table";# TODO not db agnostic
 510     my $table_prefix = $table . q|.|;
 511     my $rows = C4::Context->dbh->selectall_arrayref($sql, { Slice => {} });
 512     for my $row (@{$rows}) {
 513         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
 514         next if $row->{'Field'} eq 'password'; # passwords can no longer be shown in notices so the password field should be removed as a template option
 515         push @fields, {
 516             value => $table_prefix . $row->{Field},
 517             text  => $table_prefix . $row->{Field},
 518         }
 519     }
 520     if ($table eq 'borrowers') {
 521         my $attribute_types = Koha::Patron::Attribute::Types->search(
 522             {},
 523             { order_by => 'code' },
 524         );
 525         while ( my $at = $attribute_types->next ) {
 526             push @fields, {
 527                 value => "borrower-attribute:" . $at->code,
 528                 text  => "attribute:" . $at->code,
 529             }
 530         }
 531     }
 532     return @fields;
 533 }