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
49 use C4
::Members
::Attributes
;
51 # $protected_letters = protected_letters()
52 # - return a hashref of letter_codes representing letters that should never be deleted
53 sub protected_letters
{
54 my $dbh = C4
::Context
->dbh;
55 my $codes = $dbh->selectall_arrayref(q{SELECT DISTINCT letter_code FROM message_transports});
56 return { map { $_->[0] => 1 } @
{$codes} };
60 my $searchfield = $input->param('searchfield');
61 my $script_name = '/cgi-bin/koha/tools/letter.pl';
62 our $branchcode = $input->param('branchcode');
63 $branchcode = '' if defined $branchcode and $branchcode eq '*';
64 my $code = $input->param('code');
65 my $module = $input->param('module') || '';
66 my $content = $input->param('content');
67 my $op = $input->param('op') || '';
68 my $redirect = $input->param('redirect');
69 my $dbh = C4
::Context
->dbh;
71 our ( $template, $borrowernumber, $cookie, $staffflags ) = get_template_and_user
(
73 template_name
=> 'tools/letter.tt',
77 flagsrequired
=> { tools
=> 'edit_notices' },
82 our $my_branch = C4
::Context
->preference("IndependentBranches") && !$staffflags->{'superlibrarian'}
83 ? C4
::Context
->userenv()->{'branch'}
85 # we show only the TMPL_VAR names $op
88 independant_branch
=> $my_branch,
89 script_name
=> $script_name,
90 searchfield
=> $searchfield,
91 branchcode
=> $branchcode,
92 action
=> $script_name
95 if ( $op eq 'add_validate' or $op eq 'copy_validate' ) {
97 if( $redirect eq "just_save" ){
98 print $input->redirect("/cgi-bin/koha/tools/letter.pl?op=add_form&branchcode=$branchcode&module=$module&code=$code&redirect=done");
101 $op = q{}; # we return to the default screen for the next operation
104 if ($op eq 'copy_form') {
105 my $oldbranchcode = $input->param('oldbranchcode') || q
||;
106 my $branchcode = $input->param('branchcode');
107 add_form
($oldbranchcode, $module, $code);
109 oldbranchcode
=> $oldbranchcode,
110 branchcode
=> $branchcode,
115 elsif ( $op eq 'add_form' ) {
116 add_form
($branchcode, $module, $code);
118 elsif ( $op eq 'delete_confirm' ) {
119 delete_confirm
($branchcode, $module, $code);
121 elsif ( $op eq 'delete_confirmed' ) {
122 delete_confirmed
($branchcode, $module, $code);
123 $op = q{}; # next operation is to return to default screen
126 default_display
($branchcode,$searchfield);
129 # Do this last as delete_confirmed resets
131 $template->param($op => 1);
133 $template->param(no_op_set
=> 1);
136 output_html_with_http_headers
$input, $cookie, $template->output;
139 my ( $branchcode,$module, $code ) = @_;
142 # if code has been passed we can identify letter and its an update action
144 $letters = C4
::Letters
::GetLetterTemplates
(
146 branchcode
=> $branchcode,
153 my $message_transport_types = GetMessageTransportTypes
();
154 my $templates = { map { $_ => { message_transport_type
=> $_ } } sort @
$message_transport_types };
155 my %letters = ( default => { templates
=> $templates } );
157 if ( C4
::Context
->preference('TranslateNotices') ) {
158 my $translated_languages =
159 C4
::Languages
::getTranslatedLanguages
( 'opac',
160 C4
::Context
->preference('template') );
161 for my $language (@
$translated_languages) {
162 for my $sublanguage( @
{ $language->{sublanguages_loop
} } ) {
163 if ( $language->{plural
} ) {
164 $letters{ $sublanguage->{rfc4646_subtag
} } = {
165 description
=> $sublanguage->{native_description
}
167 . $sublanguage->{region_description
} . ' ('
168 . $sublanguage->{rfc4646_subtag
} . ')',
169 templates
=> { %$templates },
173 $letters{ $sublanguage->{rfc4646_subtag
} } = {
174 description
=> $sublanguage->{native_description
}
176 . $sublanguage->{rfc4646_subtag
} . ')',
177 templates
=> { %$templates },
182 $template->param( languages
=> $translated_languages );
189 my $first_flag_name = 1;
190 my ( $lang, @templates );
191 # The letter name is contained into each mtt row.
192 # So we can only sent the first one to the template.
193 for my $letter ( @
$letters ) {
195 if ( $first_flag_name and $letter->{name
} ) {
197 letter_name
=> $letter->{name
},
199 $first_flag_name = 0;
202 my $lang = $letter->{lang
};
203 my $mtt = $letter->{message_transport_type
};
204 $letters{ $lang }{templates
}{$mtt} = {
205 message_transport_type
=> $letter->{message_transport_type
},
206 is_html
=> $letter->{is_html
},
207 title
=> $letter->{title
},
208 content
=> $letter->{content
} // '',
213 $template->param( adding
=> 1 );
217 letters
=> \
%letters,
221 push @
{$field_selection}, add_fields
('branches');
222 if ($module eq 'reserves') {
223 push @
{$field_selection}, add_fields
('borrowers', 'reserves', 'biblio', 'biblioitems', 'items');
225 elsif ( $module eq 'acquisition' ) {
226 push @
{$field_selection}, add_fields
('aqbooksellers', 'aqorders', 'biblio', 'items');
228 elsif ($module eq 'claimacquisition' || $module eq 'orderacquisition') {
229 push @
{$field_selection}, add_fields
('aqbooksellers', 'aqbasket', 'aqorders', 'biblio', 'biblioitems');
231 elsif ($module eq 'claimissues') {
232 push @
{$field_selection}, add_fields
('aqbooksellers', 'serial', 'subscription');
233 push @
{$field_selection},
236 text
=> '---BIBLIO---'
238 foreach(qw(title author serial)) {
239 push @
{$field_selection}, {value
=> "biblio.$_", text
=> ucfirst $_ };
242 elsif ($module eq 'serial') {
243 push @
{$field_selection}, add_fields
('branches', 'biblio', 'biblioitems', 'borrowers', 'subscription', 'serial');
245 elsif ($module eq 'suggestions') {
246 push @
{$field_selection}, add_fields
('suggestions', 'borrowers', 'biblio');
249 push @
{$field_selection}, add_fields
('biblio','biblioitems'),
251 {value
=> 'items.content', text
=> 'items.content'},
252 {value
=> 'items.fine', text
=> 'items.fine'},
253 add_fields
('borrowers');
254 if ($module eq 'circulation') {
255 push @
{$field_selection}, add_fields
('opac_news');
259 if ( $module eq 'circulation' and $code and $code eq "CHECKIN" ) {
260 push @
{$field_selection}, add_fields
('old_issues');
262 push @
{$field_selection}, add_fields
('issues');
265 if ( $module eq 'circulation' and $code =~ /^AR_/ ) {
266 push @
{$field_selection}, add_fields
('article_requests');
270 my $preview_is_available = grep {/^$code$/} qw(
271 CHECKIN CHECKOUT HOLD_SLIP
275 SQLfieldnames
=> $field_selection,
276 branchcode
=> $branchcode,
277 preview_is_available
=> $preview_is_available,
283 my $dbh = C4
::Context
->dbh;
284 my $branchcode = $input->param('branchcode');
285 my $module = $input->param('module');
286 my $oldmodule = $input->param('oldmodule');
287 my $code = $input->param('code');
288 my $name = $input->param('name');
289 my @mtt = $input->multi_param('message_transport_type');
290 my @title = $input->multi_param('title');
291 my @content = $input->multi_param('content');
292 my @lang = $input->multi_param('lang');
293 for my $mtt ( @mtt ) {
294 my $is_html = $input->param("is_html_$mtt");
295 my $title = shift @title;
296 my $content = shift @content;
297 my $lang = shift @lang;
298 my $letter = C4
::Letters
::getletter
( $oldmodule, $code, $branchcode, $mtt, $lang );
300 # getletter can return the default letter even if we pass a branchcode
301 # If we got the default one and we needed the specific one, we didn't get the one we needed!
302 if ( $letter and $branchcode and $branchcode ne $letter->{branchcode
} ) {
305 unless ( $title and $content ) {
306 # Delete this mtt if no title or content given
307 delete_confirmed
( $branchcode, $oldmodule, $code, $mtt, $lang );
310 elsif ( $letter and $letter->{message_transport_type
} eq $mtt and $letter->{lang
} eq $lang ) {
314 SET branchcode = ?, module = ?, name = ?, is_html = ?, title = ?, content = ?, lang = ?
315 WHERE branchcode = ? AND module = ? AND code = ? AND message_transport_type = ? AND lang = ?
318 $branchcode || '', $module, $name, $is_html || 0, $title, $content, $lang,
319 $branchcode, $oldmodule, $code, $mtt, $lang
323 q{INSERT INTO letter (branchcode,module,code,name,is_html,title,content,message_transport_type, lang) VALUES (?,?,?,?,?,?,?,?,?)},
325 $branchcode || '', $module, $code, $name, $is_html || 0, $title, $content, $mtt, $lang
329 # set up default display
330 default_display
($branchcode);
335 my ($branchcode, $module, $code) = @_;
336 my $dbh = C4
::Context
->dbh;
337 my $letter = C4
::Letters
::getletter
($module, $code, $branchcode);
338 my @values = values %$letter;
345 sub delete_confirmed
{
346 my ($branchcode, $module, $code, $mtt, $lang) = @_;
347 C4
::Letters
::DelLetter
(
349 branchcode
=> $branchcode || '',
356 # setup default display for screen
357 default_display
($branchcode);
361 sub retrieve_letters
{
362 my ($branchcode, $searchstring) = @_;
364 $branchcode = $my_branch if $branchcode && $my_branch;
366 my $dbh = C4
::Context
->dbh;
367 my ($sql, @where, @args);
368 $sql = "SELECT branchcode, module, code, name, branchname
370 LEFT OUTER JOIN branches USING (branchcode)
372 if ($searchstring && $searchstring=~m/(\S+)/) {
373 $searchstring = $1 . q{%};
374 push @where, 'code LIKE ?';
375 push @args, $searchstring;
377 elsif ($branchcode) {
378 push @where, 'branchcode = ?';
379 push @args, $branchcode || '';
382 push @where, "(branchcode = ? OR branchcode = '')";
383 push @args, $my_branch;
386 $sql .= " WHERE ".join(" AND ", @where) if @where;
387 $sql .= " GROUP BY branchcode,module,code";
388 $sql .= " ORDER BY module, code, branchcode";
390 return $dbh->selectall_arrayref($sql, { Slice
=> {} }, @args);
393 sub default_display
{
394 my ($branchcode, $searchfield) = @_;
396 unless ( defined $branchcode ) {
397 if ( C4
::Context
->preference('DefaultToLoggedInLibraryNoticesSlips') ) {
398 $branchcode = C4
::Context
::mybranch
();
402 if ( $searchfield ) {
403 $template->param( search
=> 1 );
405 my $results = retrieve_letters
($branchcode,$searchfield);
408 my $protected_letters = protected_letters
();
409 foreach my $row (@
{$results}) {
410 $row->{protected
} = !$row->{branchcode
} && $protected_letters->{ $row->{code
} };
411 push @
{$loop_data}, $row;
416 letter
=> $loop_data,
417 branchcode
=> $branchcode,
425 for my $table (@tables) {
426 push @fields, get_columns_for
($table);
432 sub get_columns_for
{
434 # FIXME untranslatable
436 aqbooksellers
=> '---BOOKSELLERS---',
437 aqorders
=> '---ORDERS---',
438 serial
=> '---SERIALS---',
439 reserves
=> '---HOLDS---',
440 suggestions
=> '---SUGGESTIONS---',
443 if (exists $column_map{$table} ) {
446 text
=> $column_map{$table} ,
450 my $tlabel = '---' . uc $table;
458 my $sql = "SHOW COLUMNS FROM $table";# TODO not db agnostic
459 my $table_prefix = $table . q
|.|;
460 my $rows = C4
::Context
->dbh->selectall_arrayref($sql, { Slice
=> {} });
461 for my $row (@
{$rows}) {
462 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
464 value
=> $table_prefix . $row->{Field
},
465 text
=> $table_prefix . $row->{Field
},
468 if ($table eq 'borrowers') {
469 if ( my $attributes = C4
::Members
::Attributes
::GetAttributes
() ) {
470 foreach (@
$attributes) {
472 value
=> "borrower-attribute:$_",
473 text
=> "attribute:$_",