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 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
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.
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.
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 'claimacquisition') {
200 push @
{$field_selection}, add_fields
('aqbooksellers', 'aqorders', 'biblio', 'biblioitems');
202 elsif ($module eq 'claimissues') {
203 push @
{$field_selection}, add_fields
('aqbooksellers', 'serial', 'subscription');
204 push @
{$field_selection},
207 text
=> '---BIBLIO---'
209 foreach(qw(title author serial)) {
210 push @
{$field_selection}, {value
=> "biblio.$_", text
=> ucfirst $_ };
213 elsif ($module eq 'suggestions') {
214 push @
{$field_selection}, add_fields
('suggestions', 'borrowers', 'biblio');
217 push @
{$field_selection}, add_fields
('biblio','biblioitems'),
219 {value
=> 'items.content', text
=> 'items.content'},
220 {value
=> 'items.fine', text
=> 'items.fine'},
221 add_fields
('borrowers');
222 if ($module eq 'circulation') {
223 push @
{$field_selection}, add_fields
('opac_news');
227 if ( $module eq 'circulation' && $code eq "CHECKIN" ) {
228 push @
{$field_selection}, add_fields
('old_issues');
230 push @
{$field_selection}, add_fields
('issues');
236 branchloop
=> _branchloop
($branchcode),
237 SQLfieldname
=> $field_selection,
243 my $dbh = C4
::Context
->dbh;
244 my $branchcode = $input->param('branchcode') || '';
245 my $module = $input->param('module');
246 my $oldmodule = $input->param('oldmodule');
247 my $code = $input->param('code');
248 my $name = $input->param('name');
249 my @mtt = $input->param('message_transport_type');
250 my @title = $input->param('title');
251 my @content = $input->param('content');
252 for my $mtt ( @mtt ) {
253 my $is_html = $input->param("is_html_$mtt");
254 my $title = shift @title;
255 my $content = shift @content;
256 my $letter = C4
::Letters
::getletter
( $oldmodule, $code, $branchcode, $mtt);
258 # getletter can return the default letter even if we pass a branchcode
259 # If we got the default one and we needed the specific one, we didn't get the one we needed!
260 if ( $letter and $branchcode ne $letter->{branchcode
} ) {
263 unless ( $title and $content ) {
264 # Delete this mtt if no title or content given
265 delete_confirmed
( $branchcode, $oldmodule, $code, $mtt );
268 elsif ( $letter and $letter->{message_transport_type
} eq $mtt ) {
272 SET branchcode = ?, module = ?, name = ?, is_html = ?, title = ?, content = ?
273 WHERE branchcode = ? AND module = ? AND code = ? AND message_transport_type = ?
276 $branchcode, $module, $name, $is_html || 0, $title, $content,
277 $branchcode, $oldmodule, $code, $mtt
281 q{INSERT INTO letter (branchcode,module,code,name,is_html,title,content,message_transport_type) VALUES (?,?,?,?,?,?,?,?)},
283 $branchcode, $module, $code, $name, $is_html || 0, $title, $content, $mtt
287 # set up default display
288 default_display
($branchcode);
293 my ($branchcode, $module, $code) = @_;
294 my $dbh = C4
::Context
->dbh;
295 my $letter = C4
::Letters
::getletter
($module, $code, $branchcode);
296 my @values = values %$letter;
303 sub delete_confirmed
{
304 my ($branchcode, $module, $code, $mtt) = @_;
305 C4
::Letters
::DelLetter
(
307 branchcode
=> $branchcode,
313 # setup default display for screen
314 default_display
($branchcode);
318 sub retrieve_letters
{
319 my ($branchcode, $searchstring) = @_;
321 $branchcode = $my_branch if $branchcode && $my_branch;
323 my $dbh = C4
::Context
->dbh;
324 my ($sql, @where, @args);
325 $sql = "SELECT branchcode, module, code, name, branchname
327 LEFT OUTER JOIN branches USING (branchcode)
329 if ($searchstring && $searchstring=~m/(\S+)/) {
330 $searchstring = $1 . q{%};
331 push @where, 'code LIKE ?';
332 push @args, $searchstring;
334 elsif ($branchcode) {
335 push @where, 'branchcode = ?';
336 push @args, $branchcode || '';
339 push @where, "(branchcode = ? OR branchcode = '')";
340 push @args, $my_branch;
343 $sql .= " WHERE ".join(" AND ", @where) if @where;
344 $sql .= " GROUP BY branchcode,module,code";
345 $sql .= " ORDER BY module, code, branchcode";
347 return $dbh->selectall_arrayref($sql, { Slice
=> {} }, @args);
350 sub default_display
{
351 my ($branchcode, $searchfield) = @_;
353 if ( $searchfield ) {
354 $template->param( search
=> 1 );
356 my $results = retrieve_letters
($branchcode,$searchfield);
359 my $protected_letters = protected_letters
();
360 foreach my $row (@
{$results}) {
361 $row->{protected
} = !$row->{branchcode
} && $protected_letters->{ $row->{code
} };
362 push @
{$loop_data}, $row;
367 letter
=> $loop_data,
368 branchloop
=> _branchloop
($branchcode),
373 my ($branchcode) = @_;
375 my $branches = GetBranches
();
377 for my $thisbranch (sort { $branches->{$a}->{branchname
} cmp $branches->{$b}->{branchname
} } keys %$branches) {
379 value
=> $thisbranch,
380 selected
=> $branchcode && $thisbranch eq $branchcode,
381 branchname
=> $branches->{$thisbranch}->{'branchname'},
392 for my $table (@tables) {
393 push @fields, get_columns_for
($table);
399 sub get_columns_for
{
401 # FIXME untranslateable
403 aqbooksellers
=> '---BOOKSELLERS---',
404 aqorders
=> '---ORDERS---',
405 serial
=> '---SERIALS---',
406 reserves
=> '---HOLDS---',
407 suggestions
=> '---SUGGESTIONS---',
410 if (exists $column_map{$table} ) {
413 text
=> $column_map{$table} ,
417 my $tlabel = '---' . uc $table;
425 my $sql = "SHOW COLUMNS FROM $table";# TODO not db agnostic
426 my $table_prefix = $table . q
|.|;
427 my $rows = C4
::Context
->dbh->selectall_arrayref($sql, { Slice
=> {} });
428 for my $row (@
{$rows}) {
429 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
431 value
=> $table_prefix . $row->{Field
},
432 text
=> $table_prefix . $row->{Field
},
435 if ($table eq 'borrowers') {
436 if ( my $attributes = C4
::Members
::Attributes
::GetAttributes
() ) {
437 foreach (@
$attributes) {
439 value
=> "borrower-attribute:$_",
440 text
=> "attribute:$_",