6 # find Koha's Perl modules
7 # test carefully before changing this
9 eval { require "$FindBin::Bin/../kohalib.pl" };
12 use CGI qw( utf8 ); # NOT a CGI script, this is just to keep C4::Templates::gettemplate happy
23 use File::Basename qw( dirname );
47 'd|delimiter:s' => \$delimiter,
48 'letter_code:s' => \@letter_codes,
50 'e|email:s' => \@emails,
53 pod2usage(0) if $help;
55 my $output_directory = $ARGV[0];
57 if ( !$output_directory || !-d $output_directory || !-w $output_directory ) {
60 -msg => qq{\nError: You must specify a valid and writeable directory to dump the print notices in.\n},
64 # Default value is html
65 $html = 1 if not $html and not $csv and not $ods;
67 if ( $csv and @letter_codes != 1 ) {
70 -msg => qq{\nIt is not consistent to use --csv without one (and only one) letter_code\n},
74 if ( $ods and @letter_codes != 1 ) {
77 -msg => qq{\nIt is not consistent to use --ods without one (and only one) letter_code\n},
85 my $today = C4::Dates->new();
86 my @all_messages = @{ GetPrintMessages() };
88 # Filter by letter_code
90 my $letter_code = $_->{letter_code};
92 grep { /^$letter_code$/ } @letter_codes
94 } @all_messages if @letter_codes;
95 exit unless @all_messages;
97 my ( $html_filenames, $csv_filenames, $ods_filenames );
98 $csv_filenames = print_notices({
99 messages => \@all_messages,
101 output_directory => $output_directory,
105 $ods_filenames = print_notices({
106 messages => \@all_messages,
108 output_directory => $output_directory,
113 ## carriage return replaced by <br/> as output is html
114 foreach my $message (@all_messages) {
115 local $_ = $message->{'content'};
118 $message->{'content'} = $_;
121 $html_filenames = print_notices({
122 messages => \@all_messages,
124 output_directory => $output_directory,
131 html => $html_filenames,
132 csv => $csv_filenames,
133 ods => $ods_filenames,
135 for my $email ( @emails ) {
137 directory => $output_directory,
140 from => C4::Context->preference('KohaAdminEmailAddress'), # Should be replaced if bug 8000 is pushed
148 my $messages = $params->{messages};
149 my $split = $params->{split};
150 my $output_directory = $params->{output_directory};
151 my $format = $params->{format} // 'html';
153 die "Format $format is not known"
154 unless $format =~ m[^html$|^csv$|^ods$];
156 my ( @filenames, $messages_by_branch );
159 foreach my $message (@$messages) {
160 push( @{ $messages_by_branch->{ $message->{'branchcode'} } }, $message );
163 $messages_by_branch->{all_branches} = $messages;
166 while ( my ( $branchcode, $branch_messages ) = each %$messages_by_branch ) {
167 my $letter_codes = @letter_codes == 0 ? 'all' : join '_', @letter_codes;
168 my $filename = $split
169 ? "notices_$letter_codes-" . $today->output('iso') . "-$branchcode.$format"
170 : "notices_$letter_codes-" . $today->output('iso') . ".$format";
171 my $filepath = File::Spec->catdir( $output_directory, $filename );
172 if ( $format eq 'html' ) {
174 messages => $branch_messages,
175 filepath => $filepath,
177 } elsif ( $format eq 'csv' ) {
179 messages => $branch_messages,
180 filepath => $filepath,
182 } elsif ( $format eq 'ods' ) {
184 messages => $branch_messages,
185 filepath => $filepath,
190 foreach my $message ( @$branch_messages ) {
191 C4::Letters::_set_message_status(
193 message_id => $message->{'message_id'},
199 push @filenames, $filename;
206 my $messages = $params->{messages};
207 my $filepath = $params->{filepath};
210 C4::Templates::gettemplate( 'batch/print-notices.tt', 'intranet',
214 stylesheet => C4::Context->preference("NoticeCSS"),
215 today => $today->output(),
216 messages => $messages,
219 open my $OUTPUT, '>encoding(utf-8)', $filepath
220 or die "Could not open $filepath: $!";
221 print $OUTPUT $template->output;
227 my $messages = $params->{messages};
228 my $filepath = $params->{filepath};
230 open my $OUTPUT, '>encoding(utf-8)', $filepath
231 or die "Could not open $filepath: $!";
232 my ( @csv_lines, $headers );
233 foreach my $message ( @$messages ) {
234 my @lines = split /\n/, $message->{content};
237 # We don't have headers, get them
238 unless ( $headers ) {
239 $headers = $lines[0];
240 say $OUTPUT $headers;
244 for my $line ( @lines ) {
245 next if $line =~ /^\s$/;
253 my $messages = $params->{messages};
254 my $filepath = $params->{filepath};
256 use OpenOffice::OODoc;
257 my $tmpdir = dirname $filepath;
258 odfWorkingDirectory( $tmpdir );
259 my $container = odfContainer( $filepath, create => 'spreadsheet' );
260 my $doc = odfDocument (
261 container => $container,
264 my $table = $doc->getTable(0);
267 my ( $nb_rows, $nb_cols, $i ) = ( scalar(@$messages), 0, 0 );
268 foreach my $message ( @$messages ) {
269 my @lines = split /\n/, $message->{content};
272 # We don't have headers, get them
273 unless ( @headers ) {
274 @headers = split $delimiter, $lines[0];
277 $doc->expandTable( $table, $nb_rows + 1, $nb_cols );
278 my $row = $doc->getRow( $table, 0 );
280 for my $header ( @headers ) {
281 $doc->cellValue( $row, $j, Encode::encode( 'UTF8', $header ) );
287 shift @lines; # remove headers
288 for my $line ( @lines ) {
289 my @row_data = split $delimiter, $line;
290 my $row = $doc->getRow( $table, $i );
291 # Note scalar(@$row_data) should be equal to $nb_cols
292 for ( my $j = 0 ; $j < scalar(@row_data) ; $j++ ) {
293 my $value = Encode::encode( 'UTF8', $row_data[$j] );
294 $doc->cellValue( $row, $j, $value );
304 my $directory = $params->{directory};
305 my $files = $params->{files};
306 my $to = $params->{to};
307 my $from = $params->{from};
308 return unless $to and $from;
310 my $mail = MIME::Lite->new(
313 Subject => 'Print notices for ' . $today->output(),
314 Type => 'multipart/mixed',
317 while ( my ( $type, $filenames ) = each %$files ) {
318 for my $filename ( @$filenames ) {
319 my $mimetype = $type eq 'html'
324 ? 'application/vnd.oasis.opendocument.spreadsheet'
327 next unless $mimetype;
329 my $filepath = File::Spec->catdir( $directory, $filename );
331 next unless $filepath or -f $filepath;
336 Filename => $filename,
337 Encoding => 'base64',
347 gather_print_notices - Print waiting print notices
351 gather_print_notices output_directory [-s|--split] [--html] [--csv] [--ods] [--letter_code=LETTER_CODE] [-e|--email=your_email@example.org] [-h|--help]
353 Will print all waiting print notices to the output_directory.
355 The generated filename will be notices-TODAY.[csv|html|ods] or notices-TODAY-BRANCHCODE.[csv|html|ods] if the --split parameter is given.
361 =item B<output_directory>
363 Define the output directory where the files will be generated.
365 =item B<--send|--nosend>
367 After files have been generated, messages status is changed from 'pending' to
368 'sent'. This is the default action, without this parameter or with --send.
369 Using --nosend, the message status is not changed.
373 Split messages into separate files by borrower home library to OUTPUT_DIRECTORY/notices-CURRENT_DATE-BRANCHCODE.[csv|html|ods]
377 Generate the print notices in a html file (default is --html, if --csv and --ods are not given).
381 Generate the print notices in a csv file.
382 If you use this parameter, the template should contain 2 lines.
383 The first one the csv headers and the second one the value list.
386 cardnumber:patron:email:item
387 <<borrowers.cardnumber>>:<<borrowers.firstname>> <<borrowers.surname>>:<<borrowers.email>>:<<items.barcode>>
389 You have to combine this option with one (and only one) letter_code.
393 Generate the print notices in a ods file.
395 This is the same as the csv parameter but using csv2odf to generate an ods file instead of a csv file.
397 =item B<--letter_code>
399 Filter print messages by letter_code.
400 Several letter_code parameters can be given.
405 E-mail address to send generated files to.
409 Print a brief help message
415 Jesse Weaver <pianohacker@gmail.com>
417 Jonathan Druart <jonathan.druart@biblibre.com>
421 Copyright 2009 Jesse Weaver
423 Copyright 2014 BibLibre
426 This file is part of Koha.
428 Koha is free software; you can redistribute it and/or modify it
429 under the terms of the GNU General Public License as published by
430 the Free Software Foundation; either version 3 of the License, or
431 (at your option) any later version.
433 Koha is distributed in the hope that it will be useful, but
434 WITHOUT ANY WARRANTY; without even the implied warranty of
435 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
436 GNU General Public License for more details.
438 You should have received a copy of the GNU General Public License
439 along with Koha; if not, see <http://www.gnu.org/licenses>.