misc/cronjobs/gather_print_notices.pl

   1 #!/usr/bin/perl -w
   2
   3 use Modern::Perl;
   4
   5 BEGIN {
   6     # find Koha's Perl modules
   7     # test carefully before changing this
   8     use FindBin;
   9     eval { require "$FindBin::Bin/../kohalib.pl" };
  10 }
  11
  12 use CGI qw( utf8 ); # NOT a CGI script, this is just to keep C4::Templates::gettemplate happy
  13 use Koha::Script -cron;
  14 use C4::Context;
  15 use C4::Debug;
  16 use C4::Letters;
  17 use C4::Templates;
  18 use File::Spec;
  19 use Pod::Usage;
  20 use Getopt::Long;
  21 use C4::Log;
  22
  23 use Koha::DateUtils;
  24 use Koha::Util::OpenDocument;
  25 use MIME::Lite;
  26
  27 my (
  28     $help,
  29     $split,
  30     $html,
  31     $csv,
  32     $ods,
  33     $delimiter,
  34     @letter_codes,
  35     $send,
  36     @emails,
  37 );
  38
  39 $send = 1;
  40 GetOptions(
  41     'h|help'  => \$help,
  42     's|split' => \$split,
  43     'html'    => \$html,
  44     'csv'     => \$csv,
  45     'ods'     => \$ods,
  46     'd|delimiter:s' => \$delimiter,
  47     'letter_code:s' => \@letter_codes,
  48     'send!'         => \$send,
  49     'e|email:s'     => \@emails,
  50 ) || pod2usage(1);
  51
  52 pod2usage(0) if $help;
  53
  54 my $output_directory = $ARGV[0];
  55
  56 if ( !$output_directory || !-d $output_directory || !-w $output_directory ) {
  57     pod2usage({
  58         -exitval => 1,
  59         -msg => qq{\nError: You must specify a valid and writeable directory to dump the print notices in.\n},
  60     });
  61 }
  62
  63 # Default value is html
  64 $html = 1 if not $html and not $csv and not $ods;
  65
  66 if ( $csv and @letter_codes != 1 ) {
  67     pod2usage({
  68         -exitval => 1,
  69         -msg => qq{\nIt is not consistent to use --csv without one (and only one) letter_code\n},
  70     });
  71 }
  72
  73 if ( $ods and @letter_codes != 1 ) {
  74     pod2usage({
  75         -exitval => 1,
  76         -msg => qq{\nIt is not consistent to use --ods without one (and only one) letter_code\n},
  77     });
  78 }
  79
  80 $delimiter ||= q|,|;
  81
  82 cronlogaction();
  83
  84 my $today_iso     = output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } ) ;
  85 my $today_syspref = output_pref( { dt => dt_from_string, dateonly => 1 } );
  86
  87 my @all_messages = @{ GetPrintMessages() };
  88
  89 # Filter by letter_code
  90 @all_messages = map {
  91     my $letter_code = $_->{letter_code};
  92     (
  93         grep { $_ eq $letter_code } @letter_codes
  94     ) ? $_ : ()
  95 } @all_messages if @letter_codes;
  96 exit unless @all_messages;
  97
  98 my ( $html_filenames, $csv_filenames, $ods_filenames );
  99 $csv_filenames = print_notices({
 100     messages => \@all_messages,
 101     split => $split,
 102     output_directory => $output_directory,
 103     format => 'csv',
 104 }) if $csv;
 105
 106 $ods_filenames = print_notices({
 107     messages => \@all_messages,
 108     split => $split,
 109     output_directory => $output_directory,
 110     format => 'ods',
 111 }) if $ods;
 112
 113 if ( $html ) {
 114     ## carriage return replaced by <br/> as output is html
 115     foreach my $message (@all_messages) {
 116         local $_ = $message->{'content'};
 117         s/\n/<br \/>/g;
 118         s/\r//g;
 119         $message->{'content'} = $_;
 120     }
 121
 122     $html_filenames = print_notices({
 123         messages => \@all_messages,
 124         split => $split,
 125         output_directory => $output_directory,
 126         format => 'html',
 127     });
 128 }
 129
 130 if ( @emails ) {
 131     my $files = {
 132         html => $html_filenames,
 133         csv  => $csv_filenames,
 134         ods  => $ods_filenames,
 135     };
 136     for my $email ( @emails ) {
 137         send_files({
 138             directory => $output_directory,
 139             files => $files,
 140             to => $email,
 141             from => C4::Context->preference('KohaAdminEmailAddress'), # Should be replaced if bug 8000 is pushed
 142         });
 143     }
 144 }
 145
 146 sub print_notices {
 147     my ( $params ) = @_;
 148
 149     my $messages = $params->{messages};
 150     my $split = $params->{split};
 151     my $output_directory = $params->{output_directory};
 152     my $format = $params->{format} // 'html';
 153
 154     die "Format $format is not known"
 155         unless $format =~ m[^html$|^csv$|^ods$];
 156
 157     my ( @filenames, $messages_by_branch );
 158
 159     if ( $split ) {
 160         foreach my $message (@$messages) {
 161             push( @{ $messages_by_branch->{ $message->{'branchcode'} } }, $message );
 162         }
 163     } else {
 164         $messages_by_branch->{all_branches} = $messages;
 165     }
 166
 167     while ( my ( $branchcode, $branch_messages ) = each %$messages_by_branch ) {
 168         my $letter_codes = @letter_codes == 0 ? 'all' : join '_', @letter_codes;
 169         my $filename = $split
 170             ? "notices_$letter_codes-" . $today_iso . "-$branchcode.$format"
 171             : "notices_$letter_codes-" . $today_iso . ".$format";
 172         my $filepath = File::Spec->catdir( $output_directory, $filename );
 173         if ( $format eq 'html' ) {
 174             generate_html({
 175                 messages => $branch_messages,
 176                 filepath => $filepath,
 177             });
 178         } elsif ( $format eq 'csv' ) {
 179             generate_csv ({
 180                 messages => $branch_messages,
 181                 filepath => $filepath,
 182             });
 183         } elsif ( $format eq 'ods' ) {
 184             _generate_ods ({
 185                 messages => $branch_messages,
 186                 filepath => $filepath,
 187             });
 188         }
 189
 190         if ( $send ) {
 191             foreach my $message ( @$branch_messages ) {
 192                 C4::Letters::_set_message_status(
 193                     {
 194                         message_id => $message->{'message_id'},
 195                         status => 'sent'
 196                     }
 197                 );
 198             }
 199         }
 200         push @filenames, $filename;
 201     }
 202     return \@filenames;
 203 }
 204
 205 sub generate_html {
 206     my ( $params ) = @_;
 207     my $messages = $params->{messages};
 208     my $filepath = $params->{filepath};
 209
 210     my $template =
 211       C4::Templates::gettemplate( 'batch/print-notices.tt', 'intranet',
 212         new CGI );
 213
 214     $template->param(
 215         stylesheet => C4::Context->preference("NoticeCSS"),
 216         today      => $today_syspref,
 217         messages   => $messages,
 218     );
 219
 220     open my $OUTPUT, '>encoding(utf-8)', $filepath
 221         or die "Could not open $filepath: $!";
 222     print $OUTPUT $template->output;
 223     close $OUTPUT;
 224 }
 225
 226 sub generate_csv {
 227     my ( $params ) = @_;
 228     my $messages = $params->{messages};
 229     my $filepath = $params->{filepath};
 230
 231     open my $OUTPUT, '>encoding(utf-8)', $filepath
 232         or die "Could not open $filepath: $!";
 233     my $headers;
 234     foreach my $message ( @$messages ) {
 235         my @lines = split /\n/, $message->{content};
 236         chomp for @lines;
 237
 238         # We don't have headers, get them
 239         unless ( $headers ) {
 240             $headers = $lines[0];
 241             say $OUTPUT $headers;
 242         }
 243
 244         shift @lines;
 245         for my $line ( @lines ) {
 246             next if $line =~ /^\s$/;
 247             say $OUTPUT $line;
 248         }
 249     }
 250 }
 251
 252 sub _generate_ods {
 253     my ( $params ) = @_;
 254     my $messages = $params->{messages};
 255     my $ods_filepath = $params->{filepath};
 256
 257     # Prepare sheet
 258     my $ods_content;
 259     my $has_headers;
 260     foreach my $message ( @$messages ) {
 261         my @message_lines = split /\n/, $message->{content};
 262         chomp for @message_lines;
 263         # Get headers from first message
 264         if ($has_headers) {
 265             shift @message_lines;
 266         } else {
 267             $has_headers = 1;
 268         }
 269         foreach my $message_line ( @message_lines ) {
 270             my @content_row;
 271             my @message_cells = split $delimiter, $message_line;
 272             foreach ( @message_cells ) {
 273                 push @content_row, Encode::encode( 'UTF8', $_ );
 274             }
 275             push @$ods_content, \@content_row;
 276         }
 277     }
 278
 279     # Process
 280     generate_ods($ods_filepath, $ods_content);
 281 }
 282
 283 sub send_files {
 284     my ( $params ) = @_;
 285     my $directory = $params->{directory};
 286     my $files = $params->{files};
 287     my $to = $params->{to};
 288     my $from = $params->{from};
 289     return unless $to and $from;
 290
 291     my $mail = MIME::Lite->new(
 292         From     => $from,
 293         To       => $to,
 294         Subject  => 'Print notices for ' . $today_syspref,
 295         Type     => 'multipart/mixed',
 296     );
 297
 298     while ( my ( $type, $filenames ) = each %$files ) {
 299         for my $filename ( @$filenames ) {
 300             my $mimetype = $type eq 'html'
 301                 ? 'text/html'
 302                 : $type eq 'csv'
 303                     ? 'text/csv'
 304                     : $type eq 'ods'
 305                         ? 'application/vnd.oasis.opendocument.spreadsheet'
 306                         : undef;
 307
 308             next unless $mimetype;
 309
 310             my $filepath = File::Spec->catdir( $directory, $filename );
 311
 312             next unless $filepath or -f $filepath;
 313
 314             $mail->attach(
 315               Type     => $mimetype,
 316               Path     => $filepath,
 317               Filename => $filename,
 318               Encoding => 'base64',
 319             );
 320         }
 321     }
 322
 323     $mail->send;
 324 }
 325
 326 =head1 NAME
 327
 328 gather_print_notices - Print waiting print notices
 329
 330 =head1 SYNOPSIS
 331
 332 gather_print_notices output_directory [-s|--split] [--html] [--csv] [--ods] [--letter_code=LETTER_CODE] [-e|--email=your_email@example.org] [-h|--help]
 333
 334 Will print all waiting print notices to the output_directory.
 335
 336 The generated filename will be notices-TODAY.[csv|html|ods] or notices-TODAY-BRANCHCODE.[csv|html|ods] if the --split parameter is given.
 337
 338 =head1 OPTIONS
 339
 340 =over
 341
 342 =item B<output_directory>
 343
 344 Define the output directory where the files will be generated.
 345
 346 =item B<--send|--nosend>
 347
 348 After files have been generated, messages status is changed from 'pending' to
 349 'sent'. This is the default action, without this parameter or with --send.
 350 Using --nosend, the message status is not changed.
 351
 352 =item B<-s|--split>
 353
 354 Split messages into separate files by borrower home library to OUTPUT_DIRECTORY/notices-CURRENT_DATE-BRANCHCODE.[csv|html|ods]
 355
 356 =item B<--html>
 357
 358 Generate the print notices in a html file (default is --html, if --csv and --ods are not given).
 359
 360 =item B<--csv>
 361
 362 Generate the print notices in a csv file.
 363 If you use this parameter, the template should contain 2 lines.
 364 The first one the csv headers and the second one the value list.
 365
 366 For example:
 367 cardnumber:patron:email:item
 368 <<borrowers.cardnumber>>:<<borrowers.firstname>> <<borrowers.surname>>:<<borrowers.email>>:<<items.barcode>>
 369
 370 You have to combine this option with one (and only one) letter_code.
 371
 372 =item B<--ods>
 373
 374 Generate the print notices in a ods file.
 375
 376 This is the same as the csv parameter but using csv2odf to generate an ods file instead of a csv file.
 377
 378 =item B<--letter_code>
 379
 380 Filter print messages by letter_code.
 381 Several letter_code parameters can be given.
 382
 383 =item B<-e|--email>
 384
 385 Repeatable.
 386 E-mail address to send generated files to.
 387
 388 =item B<-h|--help>
 389
 390 Print a brief help message
 391
 392 =back
 393
 394 =head1 AUTHOR
 395
 396 Jesse Weaver <pianohacker@gmail.com>
 397
 398 Jonathan Druart <jonathan.druart@biblibre.com>
 399
 400 =head1 COPYRIGHT
 401
 402 Copyright 2009 Jesse Weaver
 403
 404 Copyright 2014 BibLibre
 405
 406 =head1 LICENSE
 407 This file is part of Koha.
 408
 409 Koha is free software; you can redistribute it and/or modify it
 410 under the terms of the GNU General Public License as published by
 411 the Free Software Foundation; either version 3 of the License, or
 412 (at your option) any later version.
 413
 414 Koha is distributed in the hope that it will be useful, but
 415 WITHOUT ANY WARRANTY; without even the implied warranty of
 416 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 417 GNU General Public License for more details.
 418
 419 You should have received a copy of the GNU General Public License
 420 along with Koha; if not, see <http://www.gnu.org/licenses>.
 421
 422 =cut