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 under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 2 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  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 strict;
  44 use warnings;
  45 use CGI;
  46 use C4::Auth;
  47 use C4::Context;
  48 use C4::Output;
  49 use C4::Branch; # GetBranches
  50 use C4::Members::Attributes;
  51
  52 # _letter_from_where($branchcode,$module, $code)
  53 # - return FROM WHERE clause and bind args for a letter
  54 sub _letter_from_where {
  55     my ($branchcode, $module, $code) = @_;
  56     my $sql = q{FROM letter WHERE branchcode = ? AND module = ? AND code = ?};
  57     my @args = ($branchcode || '', $module, $code);
  58 # Mysql is retarded. cause branchcode is part of the primary key it cannot be null. How does that
  59 # work with foreign key constraint I wonder...
  60
  61 #   if ($branchcode) {
  62 #       $sql .= " AND branchcode = ?";
  63 #       push @args, $branchcode;
  64 #   } else {
  65 #       $sql .= " AND branchcode IS NULL";
  66 #   }
  67
  68     return ($sql, \@args);
  69 }
  70
  71 # letter_exists($branchcode,$module, $code)
  72 # - return true if a letter with the given $branchcode, $module and $code exists
  73 sub letter_exists {
  74     my ($sql, $args) = _letter_from_where(@_);
  75     my $dbh = C4::Context->dbh;
  76     my $letter = $dbh->selectrow_hashref("SELECT * $sql", undef, @$args);
  77     return $letter;
  78 }
  79
  80 # $protected_letters = protected_letters()
  81 # - return a hashref of letter_codes representing letters that should never be deleted
  82 sub protected_letters {
  83     my $dbh = C4::Context->dbh;
  84     my $codes = $dbh->selectall_arrayref(q{SELECT DISTINCT letter_code FROM message_transports});
  85     return { map { $_->[0] => 1 } @{$codes} };
  86 }
  87
  88 our $input       = new CGI;
  89 my $searchfield = $input->param('searchfield');
  90 my $script_name = '/cgi-bin/koha/tools/letter.pl';
  91 our $branchcode  = $input->param('branchcode');
  92 my $code        = $input->param('code');
  93 my $module      = $input->param('module');
  94 my $content     = $input->param('content');
  95 my $op          = $input->param('op') || '';
  96 my $dbh = C4::Context->dbh;
  97
  98 our ( $template, $borrowernumber, $cookie, $staffflags ) = get_template_and_user(
  99     {
 100         template_name   => 'tools/letter.tmpl',
 101         query           => $input,
 102         type            => 'intranet',
 103         authnotrequired => 0,
 104         flagsrequired   => { tools => 'edit_notices' },
 105         debug           => 1,
 106     }
 107 );
 108
 109 our $my_branch = C4::Context->preference("IndependantBranches") && !$staffflags->{'superlibrarian'}
 110   ?  C4::Context->userenv()->{'branch'}
 111   : undef;
 112 # we show only the TMPL_VAR names $op
 113
 114 $template->param(
 115     independant_branch => $my_branch,
 116         script_name => $script_name,
 117   searchfield => $searchfield,
 118         action => $script_name
 119 );
 120
 121 if ($op eq 'copy') {
 122     add_copy();
 123     $op = 'add_form';
 124 }
 125
 126 if ($op eq 'add_form') {
 127     add_form($branchcode, $module, $code);
 128 }
 129 elsif ( $op eq 'add_validate' ) {
 130     add_validate();
 131     $op = q{}; # next operation is to return to default screen
 132 }
 133 elsif ( $op eq 'delete_confirm' ) {
 134     delete_confirm($branchcode, $module, $code);
 135 }
 136 elsif ( $op eq 'delete_confirmed' ) {
 137     delete_confirmed($branchcode, $module, $code);
 138     $op = q{}; # next operation is to return to default screen
 139 }
 140 else {
 141     default_display($branchcode,$searchfield);
 142 }
 143
 144 # Do this last as delete_confirmed resets
 145 if ($op) {
 146     $template->param($op  => 1);
 147 } else {
 148     $template->param(no_op_set => 1);
 149 }
 150
 151 output_html_with_http_headers $input, $cookie, $template->output;
 152
 153 sub add_form {
 154     my ($branchcode,$module, $code ) = @_;
 155
 156     my $letter;
 157     # if code has been passed we can identify letter and its an update action
 158     if ($code) {
 159         $letter = letter_exists($branchcode,$module, $code);
 160     }
 161     if ($letter) {
 162         $template->param( modify => 1 );
 163         $template->param( code   => $letter->{code} );
 164     }
 165     else { # initialize the new fields
 166         $letter = {
 167             branchcode => $branchcode,
 168             module     => $module,
 169         };
 170         $template->param( adding => 1 );
 171     }
 172
 173     my $field_selection;
 174     push @{$field_selection}, add_fields('branches');
 175     if ($module eq 'reserves') {
 176         push @{$field_selection}, add_fields('borrowers', 'reserves', 'biblio', 'items');
 177     }
 178     elsif ($module eq 'claimacquisition') {
 179         push @{$field_selection}, add_fields('aqbooksellers', 'aqorders', 'biblio', 'biblioitems');
 180     }
 181     elsif ($module eq 'claimissues') {
 182         push @{$field_selection}, add_fields('aqbooksellers', 'serial', 'subscription');
 183         push @{$field_selection},
 184         {
 185             value => q{},
 186             text => '---BIBLIO---'
 187         };
 188         foreach(qw(title author serial)) {
 189             push @{$field_selection}, {value => "biblio.$_", text => ucfirst $_ };
 190         }
 191     }
 192     elsif ($module eq 'suggestions') {
 193         push @{$field_selection}, add_fields('suggestions', 'borrowers', 'biblio');
 194     }
 195     else {
 196         push @{$field_selection}, add_fields('biblio','biblioitems'),
 197             {value => q{},             text => '---ITEMS---'  },
 198             {value => 'items.content', text => 'items.content'},
 199             add_fields('issues','borrowers');
 200         if ($module eq 'circulation') {
 201             push @{$field_selection}, add_fields('opac_news');
 202         }
 203     }
 204
 205     $template->param(
 206         branchcode => $letter->{branchcode},
 207         name       => $letter->{name},
 208         is_html    => $letter->{is_html},
 209         title      => $letter->{title},
 210         content    => $letter->{content},
 211         module     => $module,
 212         $module    => 1,
 213         branchloop => _branchloop($branchcode),
 214         SQLfieldname => $field_selection,
 215     );
 216     return;
 217 }
 218
 219 sub add_validate {
 220     my $dbh        = C4::Context->dbh;
 221     my $oldbranchcode = $input->param('oldbranchcode');
 222     my $branchcode    = $input->param('branchcode') || '';
 223     my $module        = $input->param('module');
 224     my $oldmodule     = $input->param('oldmodule');
 225     my $code          = $input->param('code');
 226     my $name          = $input->param('name');
 227     my $is_html       = $input->param('is_html');
 228     my $title         = $input->param('title');
 229     my $content       = $input->param('content');
 230     if (letter_exists($oldbranchcode,$oldmodule, $code)) {
 231         $dbh->do(
 232             q{UPDATE letter SET branchcode = ?, module = ?, name = ?, is_html = ?, title = ?, content = ? WHERE branchcode = ? AND module = ? AND code = ?},
 233             undef,
 234             $branchcode, $module, $name, $is_html || 0, $title, $content,
 235             $oldbranchcode, $oldmodule, $code
 236         );
 237     } else {
 238         $dbh->do(
 239             q{INSERT INTO letter (branchcode,module,code,name,is_html,title,content) VALUES (?,?,?,?,?,?,?)},
 240             undef,
 241             $branchcode, $module, $code, $name, $is_html || 0, $title, $content
 242         );
 243     }
 244     # set up default display
 245     default_display($branchcode);
 246 }
 247
 248 sub add_copy {
 249     my $dbh        = C4::Context->dbh;
 250     my $oldbranchcode = $input->param('oldbranchcode');
 251     my $branchcode    = $input->param('branchcode');
 252     my $module        = $input->param('module');
 253     my $code          = $input->param('code');
 254
 255     return if letter_exists($branchcode,$module, $code);
 256
 257     my $old_letter = letter_exists($oldbranchcode,$module, $code);
 258
 259     $dbh->do(
 260         q{INSERT INTO letter (branchcode,module,code,name,is_html,title,content) VALUES (?,?,?,?,?,?,?)},
 261         undef,
 262         $branchcode, $module, $code, $old_letter->{name}, $old_letter->{is_html}, $old_letter->{title}, $old_letter->{content}
 263     );
 264 }
 265
 266 sub delete_confirm {
 267     my ($branchcode, $module, $code) = @_;
 268     my $dbh = C4::Context->dbh;
 269     my $letter = letter_exists($branchcode, $module, $code);
 270     $template->param( branchcode => $branchcode, branchname => GetBranchName($branchcode) );
 271     $template->param( code => $code );
 272     $template->param( module => $module);
 273     $template->param( name => $letter->{name});
 274     return;
 275 }
 276
 277 sub delete_confirmed {
 278     my ($branchcode, $module, $code) = @_;
 279     my ($sql, $args) = _letter_from_where($branchcode, $module, $code);
 280     my $dbh    = C4::Context->dbh;
 281     $dbh->do("DELETE $sql", undef, @$args);
 282     # setup default display for screen
 283     default_display($branchcode);
 284     return;
 285 }
 286
 287 sub retrieve_letters {
 288     my ($branchcode, $searchstring) = @_;
 289
 290     $branchcode = $my_branch if $branchcode && $my_branch;
 291
 292     my $dbh = C4::Context->dbh;
 293     my ($sql, @where, @args);
 294     $sql = "SELECT branchcode, module, code, name, branchname
 295             FROM letter
 296             LEFT OUTER JOIN branches USING (branchcode)";
 297     if ($searchstring && $searchstring=~m/(\S+)/) {
 298         $searchstring = $1 . q{%};
 299         push @where, 'code LIKE ?';
 300         push @args, $searchstring;
 301     }
 302     elsif ($branchcode) {
 303         push @where, 'branchcode = ?';
 304         push @args, $branchcode || '';
 305     }
 306     elsif ($my_branch) {
 307         push @where, "(branchcode = ? OR branchcode = '')";
 308         push @args, $my_branch;
 309     }
 310
 311     $sql .= " WHERE ".join(" AND ", @where) if @where;
 312     $sql .= " ORDER BY module, code, branchcode";
 313 #   use Data::Dumper; die Dumper($sql, \@args);
 314     return $dbh->selectall_arrayref($sql, { Slice => {} }, @args);
 315 }
 316
 317 sub default_display {
 318     my ($branchcode, $searchfield) = @_;
 319
 320     if ( $searchfield  ) {
 321         $template->param( search      => 1 );
 322     }
 323     my $results = retrieve_letters($branchcode,$searchfield);
 324
 325     my $loop_data = [];
 326     my $protected_letters = protected_letters();
 327     foreach my $row (@{$results}) {
 328         $row->{protected} = !$row->{branchcode} && $protected_letters->{ $row->{code} };
 329         push @{$loop_data}, $row;
 330
 331     }
 332
 333     $template->param(
 334         letter => $loop_data,
 335         branchloop => _branchloop($branchcode),
 336     );
 337 }
 338
 339 sub _branchloop {
 340     my ($branchcode) = @_;
 341
 342     my $branches = GetBranches();
 343     my @branchloop;
 344     for my $thisbranch (sort { $branches->{$a}->{branchname} cmp $branches->{$b}->{branchname} } keys %$branches) {
 345         push @branchloop, {
 346             value      => $thisbranch,
 347             selected   => $branchcode && $thisbranch eq $branchcode,
 348             branchname => $branches->{$thisbranch}->{'branchname'},
 349         };
 350     }
 351
 352     return \@branchloop;
 353 }
 354
 355 sub add_fields {
 356     my @tables = @_;
 357     my @fields = ();
 358
 359     for my $table (@tables) {
 360         push @fields, get_columns_for($table);
 361
 362     }
 363     return @fields;
 364 }
 365
 366 sub get_columns_for {
 367     my $table = shift;
 368 # FIXME untranslateable
 369     my %column_map = (
 370         aqbooksellers => '---BOOKSELLERS---',
 371         aqorders      => '---ORDERS---',
 372         serial        => '---SERIALS---',
 373         reserves      => '---HOLDS---',
 374         suggestions   => '---SUGGESTIONS---',
 375     );
 376     my @fields = ();
 377     if (exists $column_map{$table} ) {
 378         push @fields, {
 379             value => q{},
 380             text  => $column_map{$table} ,
 381         };
 382     }
 383     else {
 384         my $tlabel = '---' . uc $table;
 385         $tlabel.= '---';
 386         push @fields, {
 387             value => q{},
 388             text  => $tlabel,
 389         };
 390     }
 391
 392     my $sql = "SHOW COLUMNS FROM $table";# TODO not db agnostic
 393     my $table_prefix = $table . q|.|;
 394     my $rows = C4::Context->dbh->selectall_arrayref($sql, { Slice => {} });
 395     for my $row (@{$rows}) {
 396         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
 397         push @fields, {
 398             value => $table_prefix . $row->{Field},
 399             text  => $table_prefix . $row->{Field},
 400         }
 401     }
 402     if ($table eq 'borrowers') {
 403         if ( my $attributes = C4::Members::Attributes::GetAttributes() ) {
 404             foreach (@$attributes) {
 405                 push @fields, {
 406                     value => "borrower-attribute:$_",
 407                     text  => "attribute:$_",
 408                 }
 409             }
 410         }
 411     }
 412     return @fields;
 413 }