3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
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.
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.
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>.
20 =head1 tools/letter.pl
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
29 - if primary key (module + code) exists, this is a modification,so we read the required record
30 - builds the add/modify form
32 - the user has just send data, so we create/modify the record
34 - we show the record selected and ask for confirmation
36 - we delete the designated record
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
45 use C4::Auth qw( get_template_and_user );
47 use C4::Output qw( output_html_with_http_headers );
48 use C4::Letters qw( GetMessageTransportTypes );
49 use C4::Log qw( logaction );
51 use Koha::Notice::Templates;
52 use Koha::Patron::Attribute::Types;
54 # $protected_letters = protected_letters()
55 # - return a hashref of letter_codes representing letters that should never be deleted
56 sub protected_letters {
57 my $dbh = C4::Context->dbh;
58 my $codes = $dbh->selectall_arrayref(q{SELECT DISTINCT letter_code FROM message_transports});
60 OVERDUE_FINE_DESC => 1,
61 map { $_->[0] => 1 } @{$codes}
65 our $input = CGI->new;
66 my $searchfield = $input->param('searchfield');
67 my $script_name = '/cgi-bin/koha/tools/letter.pl';
68 our $branchcode = $input->param('branchcode');
69 $branchcode = '' if defined $branchcode and $branchcode eq '*';
70 my $code = $input->param('code');
71 my $module = $input->param('module') || '';
72 my $content = $input->param('content');
73 my $op = $input->param('op') || '';
74 my $redirect = $input->param('redirect');
75 my $section = $input->param('section');
76 my $langtab = $input->param('langtab');
78 my $dbh = C4::Context->dbh;
80 our ( $template, $borrowernumber, $cookie, $staffflags ) = get_template_and_user(
82 template_name => 'tools/letter.tt',
85 flagsrequired => { tools => 'edit_notices' },
89 our $my_branch = C4::Context->preference("IndependentBranches") && !$staffflags->{'superlibrarian'}
90 ? C4::Context->userenv()->{'branch'}
92 # we show only the TMPL_VAR names $op
95 independant_branch => $my_branch,
96 script_name => $script_name,
97 searchfield => $searchfield,
98 branchcode => $branchcode,
101 action => $script_name
104 if ( $op eq 'add_validate' or $op eq 'copy_validate' ) {
106 if( $redirect eq "just_save" ){
107 print $input->redirect("/cgi-bin/koha/tools/letter.pl?op=add_form&branchcode=$branchcode&module=$module&code=$code&redirect=done§ion=$section&langtab=$langtab");
110 $op = q{}; # we return to the default screen for the next operation
113 if ($op eq 'copy_form') {
114 my $oldbranchcode = $input->param('oldbranchcode') || q||;
115 my $branchcode = $input->param('branchcode');
116 add_form($oldbranchcode, $module, $code);
118 oldbranchcode => $oldbranchcode,
119 branchcode => $branchcode,
124 elsif ( $op eq 'add_form' ) {
125 add_form($branchcode, $module, $code);
127 elsif ( $op eq 'delete_confirm' ) {
128 delete_confirm($branchcode, $module, $code);
130 elsif ( $op eq 'delete_confirmed' ) {
131 delete_confirmed($branchcode, $module, $code);
132 $op = q{}; # next operation is to return to default screen
135 default_display($branchcode,$searchfield);
138 # Do this last as delete_confirmed resets
140 $template->param($op => 1);
142 $template->param(no_op_set => 1);
145 output_html_with_http_headers $input, $cookie, $template->output;
148 my ( $branchcode,$module, $code ) = @_;
151 # if code has been passed we can identify letter and its an update action
153 $letters = C4::Letters::GetLetterTemplates(
155 branchcode => $branchcode,
162 my $message_transport_types = GetMessageTransportTypes();
163 my $templates = { map { $_ => { message_transport_type => $_ } } sort @$message_transport_types };
164 my %letters = ( default => { templates => $templates } );
166 if ( C4::Context->preference('TranslateNotices') ) {
167 my $translated_languages =
168 C4::Languages::getTranslatedLanguages( 'opac',
169 C4::Context->preference('template') );
170 for my $language (@$translated_languages) {
171 for my $sublanguage( @{ $language->{sublanguages_loop} } ) {
172 if ( $language->{plural} ) {
173 $letters{ $sublanguage->{rfc4646_subtag} } = {
174 description => $sublanguage->{native_description}
176 . $sublanguage->{region_description} . ' ('
177 . $sublanguage->{rfc4646_subtag} . ')',
178 templates => { %$templates },
182 $letters{ $sublanguage->{rfc4646_subtag} } = {
183 description => $sublanguage->{native_description}
185 . $sublanguage->{rfc4646_subtag} . ')',
186 templates => { %$templates },
191 $template->param( languages => $translated_languages );
198 my $first_flag_name = 1;
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 ) {
204 if ( $first_flag_name and $letter->{name} ) {
206 letter_name=> $letter->{name},
208 $first_flag_name = 0;
211 my $lang = $letter->{lang};
212 my $mtt = $letter->{message_transport_type};
213 $letters{ $lang }{templates}{$mtt} = {
214 message_transport_type => $letter->{message_transport_type},
215 is_html => $letter->{is_html},
216 updated_on => $letter->{updated_on},
217 title => $letter->{title},
218 content => $letter->{content} // '',
223 $template->param( adding => 1 );
227 letters => \%letters,
231 push @{$field_selection}, add_fields('branches');
232 if ($module eq 'reserves') {
233 push @{$field_selection}, add_fields('borrowers', 'reserves', 'biblio', 'biblioitems', 'items');
235 elsif ( $module eq 'acquisition' ) {
236 push @{$field_selection}, add_fields('aqbooksellers', 'aqorders', 'biblio', 'items');
238 elsif ($module eq 'claimacquisition' || $module eq 'orderacquisition') {
239 push @{$field_selection}, add_fields('aqbooksellers', 'aqbasket', 'aqorders', 'biblio', 'biblioitems');
241 elsif ($module eq 'claimissues') {
242 push @{$field_selection}, add_fields('aqbooksellers', 'serial', 'subscription', 'biblio', 'biblioitems');
244 elsif ($module eq 'serial') {
245 push @{$field_selection}, add_fields('branches', 'biblio', 'biblioitems', 'borrowers', 'subscription', 'serial');
247 elsif ($module eq 'suggestions') {
248 push @{$field_selection}, add_fields('suggestions', 'borrowers', 'biblio');
251 push @{$field_selection}, add_fields('biblio','biblioitems'),
253 {value => 'items.content', text => 'items.content'},
254 {value => 'items.fine', text => 'items.fine'},
255 add_fields('borrowers');
256 if ($module eq 'circulation') {
257 push @{$field_selection}, add_fields('additional_contents', 'recalls');
261 if ( $module eq 'circulation' and $code and ( $code eq "CHECKIN" or $code eq "CHECKINSLIP" ) ) {
262 push @{$field_selection}, add_fields('old_issues');
264 push @{$field_selection}, add_fields('issues');
267 if ( $module eq 'circulation' and $code and $code =~ /^AR_/ ) {
268 push @{$field_selection}, add_fields('article_requests');
271 if ( $module eq 'members' and $code and $code eq 'PROBLEM_REPORT' ) {
272 push @{$field_selection}, add_fields('problem_reports');
275 if ( $module eq 'ill' ) {
276 push @{$field_selection}, add_fields('illrequests');
280 my $preview_is_available = 0;
283 $preview_is_available = grep {$_ eq $code } qw( CHECKIN CHECKOUT HOLD_SLIP );
288 SQLfieldnames => $field_selection,
289 branchcode => $branchcode,
290 preview_is_available => $preview_is_available,
296 my $dbh = C4::Context->dbh;
297 my $branchcode = $input->param('branchcode');
298 my $module = $input->param('module');
299 my $oldmodule = $input->param('oldmodule');
300 my $code = $input->param('code');
301 my $name = $input->param('name');
302 my @mtt = $input->multi_param('message_transport_type');
303 my @title = $input->multi_param('title');
304 my @content = $input->multi_param('content');
305 my @lang = $input->multi_param('lang');
306 for my $mtt ( @mtt ) {
307 my $lang = shift @lang;
308 my $is_html = $input->param("is_html_$mtt\_$lang");
309 my $title = shift @title;
310 my $content = shift @content;
311 my $letter = Koha::Notice::Templates->find(
313 module => $oldmodule,
315 branchcode => $branchcode,
316 message_transport_type => $mtt,
321 unless ( $title and $content ) {
322 # Delete this mtt if no title or content given
323 delete_confirmed( $branchcode, $oldmodule, $code, $mtt, $lang );
327 logaction( 'NOTICES', 'MODIFY', $letter->id, $content,
329 if ( C4::Context->preference("NoticesLog")
330 && $content ne $letter->content );
334 branchcode => $branchcode || '',
337 is_html => $is_html || 0,
345 my $letter = Koha::Notice::Template->new(
347 branchcode => $branchcode,
354 message_transport_type => $mtt,
358 logaction( 'NOTICES', 'CREATE', $letter->id, $letter->content,
360 if C4::Context->preference("NoticesLog");
363 # set up default display
364 default_display($branchcode);
369 my ($branchcode, $module, $code) = @_;
370 my $dbh = C4::Context->dbh;
371 my $letter = Koha::Notice::Templates->search(
372 { module => $module, code => $code, branchcode => $branchcode } );
374 letter => $letter ? $letter->next : undef,
379 sub delete_confirmed {
380 my ( $branchcode, $module, $code, $mtt, $lang ) = @_;
381 my $letters = Koha::Notice::Templates->search(
383 branchcode => $branchcode || '',
386 ( $mtt ? ( message_transport_type => $mtt ) : () ),
387 ( $lang ? ( lang => $lang ) : () ),
390 while ( my $letter = $letters->next ) {
391 logaction( 'NOTICES', 'DELETE', $letter->id, $letter->content,
393 if C4::Context->preference("NoticesLog");
397 # setup default display for screen
398 default_display($branchcode);
402 sub retrieve_letters {
403 my ($branchcode, $searchstring) = @_;
405 $branchcode = $my_branch if $branchcode && $my_branch;
407 my $dbh = C4::Context->dbh;
408 my ($sql, @where, @args);
409 $sql = "SELECT branchcode, module, code, name, branchname, MAX(updated_on) as updated_on
411 LEFT OUTER JOIN branches USING (branchcode)
413 if ($searchstring && $searchstring=~m/(\S+)/) {
414 $searchstring = $1 . q{%};
415 push @where, 'code LIKE ?';
416 push @args, $searchstring;
418 elsif ($branchcode) {
419 push @where, 'branchcode = ?';
420 push @args, $branchcode || '';
423 push @where, "(branchcode = ? OR branchcode = '')";
424 push @args, $my_branch;
427 $sql .= " WHERE ".join(" AND ", @where) if @where;
428 $sql .= " GROUP BY branchcode,module,code,name,branchname";
430 $sql .= " ORDER BY module, code, branchcode";
432 return $dbh->selectall_arrayref($sql, { Slice => {} }, @args);
435 sub default_display {
436 my ($branchcode, $searchfield) = @_;
438 unless ( defined $branchcode ) {
439 if ( C4::Context->preference('DefaultToLoggedInLibraryNoticesSlips') ) {
440 $branchcode = C4::Context::mybranch();
444 if ( $searchfield ) {
445 $template->param( search => 1 );
447 my $results = retrieve_letters($branchcode,$searchfield);
450 my $protected_letters = protected_letters();
451 foreach my $row (@{$results}) {
452 $row->{protected} = !$row->{branchcode} && $protected_letters->{ $row->{code} };
453 push @{$loop_data}, $row;
458 letter => $loop_data,
459 branchcode => $branchcode,
467 for my $table (@tables) {
468 push @fields, get_columns_for($table);
474 sub get_columns_for {
476 # FIXME untranslatable
478 aqbooksellers => '---BOOKSELLERS---',
479 aqorders => '---ORDERS---',
480 serial => '---SERIALS---',
481 reserves => '---HOLDS---',
482 suggestions => '---SUGGESTIONS---',
485 if (exists $column_map{$table} ) {
488 text => $column_map{$table} ,
492 my $tlabel = '---' . uc $table;
500 my $sql = "SHOW COLUMNS FROM $table";# TODO not db agnostic
501 my $table_prefix = $table . q|.|;
502 my $rows = C4::Context->dbh->selectall_arrayref($sql, { Slice => {} });
503 for my $row (@{$rows}) {
504 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
506 value => $table_prefix . $row->{Field},
507 text => $table_prefix . $row->{Field},
510 if ($table eq 'borrowers') {
511 my $attribute_types = Koha::Patron::Attribute::Types->search(
513 { order_by => 'code' },
515 while ( my $at = $attribute_types->next ) {
517 value => "borrower-attribute:" . $at->code,
518 text => "attribute:" . $at->code,