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::Branch; # GetBranches
51 use C4::Members::Attributes;
53 # $protected_letters = protected_letters()
54 # - return a hashref of letter_codes representing letters that should never be deleted
55 sub protected_letters {
56 my $dbh = C4::Context->dbh;
57 my $codes = $dbh->selectall_arrayref(q{SELECT DISTINCT letter_code FROM message_transports});
58 return { map { $_->[0] => 1 } @{$codes} };
62 my $searchfield = $input->param('searchfield');
63 my $script_name = '/cgi-bin/koha/tools/letter.pl';
64 our $branchcode = $input->param('branchcode');
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 $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 $op = q{}; # we return to the default screen for the next operation
99 if ($op eq 'copy_form') {
100 my $oldbranchcode = $input->param('oldbranchcode') || q||;
101 my $branchcode = $input->param('branchcode') || q||;
102 add_form($oldbranchcode, $module, $code);
104 oldbranchcode => $oldbranchcode,
105 branchcode => $branchcode,
106 branchloop => _branchloop($branchcode),
111 elsif ( $op eq 'add_form' ) {
112 add_form($branchcode, $module, $code);
114 elsif ( $op eq 'delete_confirm' ) {
115 delete_confirm($branchcode, $module, $code);
117 elsif ( $op eq 'delete_confirmed' ) {
118 delete_confirmed($branchcode, $module, $code);
119 $op = q{}; # next operation is to return to default screen
122 default_display($branchcode,$searchfield);
125 # Do this last as delete_confirmed resets
127 $template->param($op => 1);
129 $template->param(no_op_set => 1);
132 output_html_with_http_headers $input, $cookie, $template->output;
135 my ( $branchcode,$module, $code ) = @_;
138 # if code has been passed we can identify letter and its an update action
140 $letters = C4::Letters::GetLetterTemplates(
142 branchcode => $branchcode,
149 my $message_transport_types = GetMessageTransportTypes();
155 branchcode => $branchcode,
158 # The letter name is contained into each mtt row.
159 # So we can only sent the first one to the template.
160 for my $mtt ( @$message_transport_types ) {
162 if ( $first_flag and $letters->{$mtt}{name} ) {
164 letter_name=> $letters->{$mtt}{name},
170 message_transport_type => $mtt,
171 is_html => $letters->{$mtt}{is_html},
172 title => $letters->{$mtt}{title},
173 content => $letters->{$mtt}{content}//'',
177 else { # initialize the new fields
178 for my $mtt ( @$message_transport_types ) {
180 message_transport_type => $mtt,
184 branchcode => $branchcode,
187 $template->param( adding => 1 );
191 letters => \@letter_loop,
195 push @{$field_selection}, add_fields('branches');
196 if ($module eq 'reserves') {
197 push @{$field_selection}, add_fields('borrowers', 'reserves', 'biblio', 'items');
199 elsif ( $module eq 'acquisition' ) {
200 push @{$field_selection}, add_fields('aqbooksellers', 'aqorders', 'biblio', 'items');
202 elsif ($module eq 'claimacquisition') {
203 push @{$field_selection}, add_fields('aqbooksellers', 'aqorders', 'biblio', 'biblioitems');
205 elsif ($module eq 'claimissues') {
206 push @{$field_selection}, add_fields('aqbooksellers', 'serial', 'subscription');
207 push @{$field_selection},
210 text => '---BIBLIO---'
212 foreach(qw(title author serial)) {
213 push @{$field_selection}, {value => "biblio.$_", text => ucfirst $_ };
216 elsif ($module eq 'suggestions') {
217 push @{$field_selection}, add_fields('suggestions', 'borrowers', 'biblio');
220 push @{$field_selection}, add_fields('biblio','biblioitems'),
222 {value => 'items.content', text => 'items.content'},
223 {value => 'items.fine', text => 'items.fine'},
224 add_fields('borrowers');
225 if ($module eq 'circulation') {
226 push @{$field_selection}, add_fields('opac_news');
230 if ( $module eq 'circulation' and $code and $code eq "CHECKIN" ) {
231 push @{$field_selection}, add_fields('old_issues');
233 push @{$field_selection}, add_fields('issues');
239 branchloop => _branchloop($branchcode),
240 SQLfieldnames => $field_selection,
246 my $dbh = C4::Context->dbh;
247 my $branchcode = $input->param('branchcode') || '';
248 my $module = $input->param('module');
249 my $oldmodule = $input->param('oldmodule');
250 my $code = $input->param('code');
251 my $name = $input->param('name');
252 my @mtt = $input->param('message_transport_type');
253 my @title = $input->param('title');
254 my @content = $input->param('content');
255 for my $mtt ( @mtt ) {
256 my $is_html = $input->param("is_html_$mtt");
257 my $title = shift @title;
258 my $content = shift @content;
259 my $letter = C4::Letters::getletter( $oldmodule, $code, $branchcode, $mtt);
261 # getletter can return the default letter even if we pass a branchcode
262 # If we got the default one and we needed the specific one, we didn't get the one we needed!
263 if ( $letter and $branchcode ne $letter->{branchcode} ) {
266 unless ( $title and $content ) {
267 # Delete this mtt if no title or content given
268 delete_confirmed( $branchcode, $oldmodule, $code, $mtt );
271 elsif ( $letter and $letter->{message_transport_type} eq $mtt ) {
275 SET branchcode = ?, module = ?, name = ?, is_html = ?, title = ?, content = ?
276 WHERE branchcode = ? AND module = ? AND code = ? AND message_transport_type = ?
279 $branchcode, $module, $name, $is_html || 0, $title, $content,
280 $branchcode, $oldmodule, $code, $mtt
284 q{INSERT INTO letter (branchcode,module,code,name,is_html,title,content,message_transport_type) VALUES (?,?,?,?,?,?,?,?)},
286 $branchcode, $module, $code, $name, $is_html || 0, $title, $content, $mtt
290 # set up default display
291 default_display($branchcode);
296 my ($branchcode, $module, $code) = @_;
297 my $dbh = C4::Context->dbh;
298 my $letter = C4::Letters::getletter($module, $code, $branchcode);
299 my @values = values %$letter;
306 sub delete_confirmed {
307 my ($branchcode, $module, $code, $mtt) = @_;
308 C4::Letters::DelLetter(
310 branchcode => $branchcode,
316 # setup default display for screen
317 default_display($branchcode);
321 sub retrieve_letters {
322 my ($branchcode, $searchstring) = @_;
324 $branchcode = $my_branch if $branchcode && $my_branch;
326 my $dbh = C4::Context->dbh;
327 my ($sql, @where, @args);
328 $sql = "SELECT branchcode, module, code, name, branchname
330 LEFT OUTER JOIN branches USING (branchcode)
332 if ($searchstring && $searchstring=~m/(\S+)/) {
333 $searchstring = $1 . q{%};
334 push @where, 'code LIKE ?';
335 push @args, $searchstring;
337 elsif ($branchcode) {
338 push @where, 'branchcode = ?';
339 push @args, $branchcode || '';
342 push @where, "(branchcode = ? OR branchcode = '')";
343 push @args, $my_branch;
346 $sql .= " WHERE ".join(" AND ", @where) if @where;
347 $sql .= " GROUP BY branchcode,module,code";
348 $sql .= " ORDER BY module, code, branchcode";
350 return $dbh->selectall_arrayref($sql, { Slice => {} }, @args);
353 sub default_display {
354 my ($branchcode, $searchfield) = @_;
356 if ( $searchfield ) {
357 $template->param( search => 1 );
359 my $results = retrieve_letters($branchcode,$searchfield);
362 my $protected_letters = protected_letters();
363 foreach my $row (@{$results}) {
364 $row->{protected} = !$row->{branchcode} && $protected_letters->{ $row->{code} };
365 push @{$loop_data}, $row;
370 letter => $loop_data,
371 branchloop => _branchloop($branchcode),
376 my ($branchcode) = @_;
378 my $branches = GetBranches();
380 for my $thisbranch (sort { $branches->{$a}->{branchname} cmp $branches->{$b}->{branchname} } keys %$branches) {
382 value => $thisbranch,
383 selected => $branchcode && $thisbranch eq $branchcode,
384 branchname => $branches->{$thisbranch}->{'branchname'},
395 for my $table (@tables) {
396 push @fields, get_columns_for($table);
402 sub get_columns_for {
404 # FIXME untranslatable
406 aqbooksellers => '---BOOKSELLERS---',
407 aqorders => '---ORDERS---',
408 serial => '---SERIALS---',
409 reserves => '---HOLDS---',
410 suggestions => '---SUGGESTIONS---',
413 if (exists $column_map{$table} ) {
416 text => $column_map{$table} ,
420 my $tlabel = '---' . uc $table;
428 my $sql = "SHOW COLUMNS FROM $table";# TODO not db agnostic
429 my $table_prefix = $table . q|.|;
430 my $rows = C4::Context->dbh->selectall_arrayref($sql, { Slice => {} });
431 for my $row (@{$rows}) {
432 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
434 value => $table_prefix . $row->{Field},
435 text => $table_prefix . $row->{Field},
438 if ($table eq 'borrowers') {
439 if ( my $attributes = C4::Members::Attributes::GetAttributes() ) {
440 foreach (@$attributes) {
442 value => "borrower-attribute:$_",
443 text => "attribute:$_",