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
50 use C4
::Members
::Attributes
;
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...
62 # $sql .= " AND branchcode = ?";
63 # push @args, $branchcode;
65 # $sql .= " AND branchcode IS NULL";
68 return ($sql, \
@args);
71 # letter_exists($branchcode,$module, $code)
72 # - return true if a letter with the given $branchcode, $module and $code exists
74 my ($sql, $args) = _letter_from_where
(@_);
75 my $dbh = C4
::Context
->dbh;
76 my $letter = $dbh->selectrow_hashref("SELECT * $sql", undef, @
$args);
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} };
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;
98 our ( $template, $borrowernumber, $cookie, $staffflags ) = get_template_and_user
(
100 template_name
=> 'tools/letter.tmpl',
103 authnotrequired
=> 0,
104 flagsrequired
=> { tools
=> 'edit_notices' },
109 our $my_branch = C4
::Context
->preference("IndependantBranches") && !$staffflags->{'superlibrarian'}
110 ? C4
::Context
->userenv()->{'branch'}
112 # we show only the TMPL_VAR names $op
115 independant_branch
=> $my_branch,
116 script_name
=> $script_name,
117 searchfield
=> $searchfield,
118 branchcode
=> $branchcode,
119 action
=> $script_name
127 if ($op eq 'add_form') {
128 add_form
($branchcode, $module, $code);
130 elsif ( $op eq 'add_validate' ) {
132 $op = q{}; # next operation is to return to default screen
134 elsif ( $op eq 'delete_confirm' ) {
135 delete_confirm
($branchcode, $module, $code);
137 elsif ( $op eq 'delete_confirmed' ) {
138 delete_confirmed
($branchcode, $module, $code);
139 $op = q{}; # next operation is to return to default screen
142 default_display
($branchcode,$searchfield);
145 # Do this last as delete_confirmed resets
147 $template->param($op => 1);
149 $template->param(no_op_set
=> 1);
152 output_html_with_http_headers
$input, $cookie, $template->output;
155 my ($branchcode,$module, $code ) = @_;
158 # if code has been passed we can identify letter and its an update action
160 $letter = letter_exists
($branchcode,$module, $code);
163 $template->param( modify
=> 1 );
164 $template->param( code
=> $letter->{code
} );
166 else { # initialize the new fields
168 branchcode
=> $branchcode,
171 $template->param( adding
=> 1 );
175 push @
{$field_selection}, add_fields
('branches');
176 if ($module eq 'reserves') {
177 push @
{$field_selection}, add_fields
('borrowers', 'reserves', 'biblio', 'items');
179 elsif ($module eq 'claimacquisition') {
180 push @
{$field_selection}, add_fields
('aqbooksellers', 'aqorders', 'biblio', 'biblioitems');
182 elsif ($module eq 'claimissues') {
183 push @
{$field_selection}, add_fields
('aqbooksellers', 'serial', 'subscription');
184 push @
{$field_selection},
187 text
=> '---BIBLIO---'
189 foreach(qw(title author serial)) {
190 push @
{$field_selection}, {value
=> "biblio.$_", text
=> ucfirst $_ };
193 elsif ($module eq 'suggestions') {
194 push @
{$field_selection}, add_fields
('suggestions', 'borrowers', 'biblio');
197 push @
{$field_selection}, add_fields
('biblio','biblioitems'),
198 {value
=> q{}, text
=> '---ITEMS---' },
199 {value
=> 'items.content', text
=> 'items.content'},
200 add_fields
('borrowers');
201 if ($module eq 'circulation') {
202 push @
{$field_selection}, add_fields
('opac_news');
206 if ( $module eq 'circulation' && $code eq "CHECKIN" ) {
207 push @
{$field_selection}, add_fields
('old_issues');
209 push @
{$field_selection}, add_fields
('issues');
214 branchcode
=> $letter->{branchcode
},
215 name
=> $letter->{name
},
216 is_html
=> $letter->{is_html
},
217 title
=> $letter->{title
},
218 content
=> $letter->{content
},
221 branchloop
=> _branchloop
($branchcode),
222 SQLfieldname
=> $field_selection,
228 my $dbh = C4
::Context
->dbh;
229 my $oldbranchcode = $input->param('oldbranchcode');
230 my $branchcode = $input->param('branchcode') || '';
231 my $module = $input->param('module');
232 my $oldmodule = $input->param('oldmodule');
233 my $code = $input->param('code');
234 my $name = $input->param('name');
235 my $is_html = $input->param('is_html');
236 my $title = $input->param('title');
237 my $content = $input->param('content');
238 if (letter_exists
($oldbranchcode,$oldmodule, $code)) {
240 q{UPDATE letter SET branchcode = ?, module = ?, name = ?, is_html = ?, title = ?, content = ? WHERE branchcode = ? AND module = ? AND code = ?},
242 $branchcode, $module, $name, $is_html || 0, $title, $content,
243 $oldbranchcode, $oldmodule, $code
247 q{INSERT INTO letter (branchcode,module,code,name,is_html,title,content) VALUES (?,?,?,?,?,?,?)},
249 $branchcode, $module, $code, $name, $is_html || 0, $title, $content
252 # set up default display
253 default_display
($branchcode);
257 my $dbh = C4
::Context
->dbh;
258 my $oldbranchcode = $input->param('oldbranchcode');
259 my $branchcode = $input->param('branchcode');
260 my $module = $input->param('module');
261 my $code = $input->param('code');
263 return if letter_exists
($branchcode,$module, $code);
265 my $old_letter = letter_exists
($oldbranchcode,$module, $code);
268 q{INSERT INTO letter (branchcode,module,code,name,is_html,title,content) VALUES (?,?,?,?,?,?,?)},
270 $branchcode, $module, $code, $old_letter->{name
}, $old_letter->{is_html
}, $old_letter->{title
}, $old_letter->{content
}
275 my ($branchcode, $module, $code) = @_;
276 my $dbh = C4
::Context
->dbh;
277 my $letter = letter_exists
($branchcode, $module, $code);
278 $template->param( branchcode
=> $branchcode, branchname
=> GetBranchName
($branchcode) );
279 $template->param( code
=> $code );
280 $template->param( module
=> $module);
281 $template->param( name
=> $letter->{name
});
285 sub delete_confirmed
{
286 my ($branchcode, $module, $code) = @_;
287 my ($sql, $args) = _letter_from_where
($branchcode, $module, $code);
288 my $dbh = C4
::Context
->dbh;
289 $dbh->do("DELETE $sql", undef, @
$args);
290 # setup default display for screen
291 default_display
($branchcode);
295 sub retrieve_letters
{
296 my ($branchcode, $searchstring) = @_;
298 $branchcode = $my_branch if $branchcode && $my_branch;
300 my $dbh = C4
::Context
->dbh;
301 my ($sql, @where, @args);
302 $sql = "SELECT branchcode, module, code, name, branchname
304 LEFT OUTER JOIN branches USING (branchcode)";
305 if ($searchstring && $searchstring=~m/(\S+)/) {
306 $searchstring = $1 . q{%};
307 push @where, 'code LIKE ?';
308 push @args, $searchstring;
310 elsif ($branchcode) {
311 push @where, 'branchcode = ?';
312 push @args, $branchcode || '';
315 push @where, "(branchcode = ? OR branchcode = '')";
316 push @args, $my_branch;
319 $sql .= " WHERE ".join(" AND ", @where) if @where;
320 $sql .= " ORDER BY module, code, branchcode";
321 # use Data::Dumper; die Dumper($sql, \@args);
322 return $dbh->selectall_arrayref($sql, { Slice
=> {} }, @args);
325 sub default_display
{
326 my ($branchcode, $searchfield) = @_;
328 if ( $searchfield ) {
329 $template->param( search
=> 1 );
331 my $results = retrieve_letters
($branchcode,$searchfield);
334 my $protected_letters = protected_letters
();
335 foreach my $row (@
{$results}) {
336 $row->{protected
} = !$row->{branchcode
} && $protected_letters->{ $row->{code
} };
337 push @
{$loop_data}, $row;
342 letter
=> $loop_data,
343 branchloop
=> _branchloop
($branchcode),
348 my ($branchcode) = @_;
350 my $branches = GetBranches
();
352 for my $thisbranch (sort { $branches->{$a}->{branchname
} cmp $branches->{$b}->{branchname
} } keys %$branches) {
354 value
=> $thisbranch,
355 selected
=> $branchcode && $thisbranch eq $branchcode,
356 branchname
=> $branches->{$thisbranch}->{'branchname'},
367 for my $table (@tables) {
368 push @fields, get_columns_for
($table);
374 sub get_columns_for
{
376 # FIXME untranslateable
378 aqbooksellers
=> '---BOOKSELLERS---',
379 aqorders
=> '---ORDERS---',
380 serial
=> '---SERIALS---',
381 reserves
=> '---HOLDS---',
382 suggestions
=> '---SUGGESTIONS---',
385 if (exists $column_map{$table} ) {
388 text
=> $column_map{$table} ,
392 my $tlabel = '---' . uc $table;
400 my $sql = "SHOW COLUMNS FROM $table";# TODO not db agnostic
401 my $table_prefix = $table . q
|.|;
402 my $rows = C4
::Context
->dbh->selectall_arrayref($sql, { Slice
=> {} });
403 for my $row (@
{$rows}) {
404 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
406 value
=> $table_prefix . $row->{Field
},
407 text
=> $table_prefix . $row->{Field
},
410 if ($table eq 'borrowers') {
411 if ( my $attributes = C4
::Members
::Attributes
::GetAttributes
() ) {
412 foreach (@
$attributes) {
414 value
=> "borrower-attribute:$_",
415 text
=> "attribute:$_",