C4/Letters.pm

   1 package C4::Letters;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #
   5 # This file is part of Koha.
   6 #
   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
  10 # version.
  11 #
  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.
  15 #
  16 # You should have received a copy of the GNU General Public License along with
  17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  18 # Suite 330, Boston, MA  02111-1307 USA
  19
  20 use strict;
  21 use warnings;
  22
  23 use MIME::Lite;
  24 use Mail::Sendmail;
  25 use C4::Members;
  26 use C4::Log;
  27 use C4::SMS;
  28 use C4::Debug;
  29 use Encode;
  30 use Carp;
  31
  32 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  33
  34 BEGIN {
  35         require Exporter;
  36         # set the version for version checking
  37         $VERSION = 3.01;
  38         @ISA = qw(Exporter);
  39         @EXPORT = qw(
  40         &GetLetters &getletter &addalert &getalert &delalert &findrelatedto &SendAlerts
  41         );
  42 }
  43
  44 =head1 NAME
  45
  46 C4::Letters - Give functions for Letters management
  47
  48 =head1 SYNOPSIS
  49
  50   use C4::Letters;
  51
  52 =head1 DESCRIPTION
  53
  54   "Letters" is the tool used in Koha to manage informations sent to the patrons and/or the library. This include some cron jobs like
  55   late issues, as well as other tasks like sending a mail to users that have subscribed to a "serial issue alert" (= being warned every time a new issue has arrived at the library)
  56
  57   Letters are managed through "alerts" sent by Koha on some events. All "alert" related functions are in this module too.
  58
  59 =head2 GetLetters([$category])
  60
  61   $letters = &GetLetters($category);
  62   returns informations about letters.
  63   if needed, $category filters for letters given category
  64   Create a letter selector with the following code
  65
  66 =head3 in PERL SCRIPT
  67
  68 my $letters = GetLetters($cat);
  69 my @letterloop;
  70 foreach my $thisletter (keys %$letters) {
  71     my $selected = 1 if $thisletter eq $letter;
  72     my %row =(
  73         value => $thisletter,
  74         selected => $selected,
  75         lettername => $letters->{$thisletter},
  76     );
  77     push @letterloop, \%row;
  78 }
  79 $template->param(LETTERLOOP => \@letterloop);
  80
  81 =head3 in TEMPLATE
  82
  83     <select name="letter">
  84         <option value="">Default</option>
  85     <!-- TMPL_LOOP name="LETTERLOOP" -->
  86         <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="lettername" --></option>
  87     <!-- /TMPL_LOOP -->
  88     </select>
  89
  90 =cut
  91
  92 sub GetLetters (;$) {
  93
  94     # returns a reference to a hash of references to ALL letters...
  95     my $cat = shift;
  96     my %letters;
  97     my $dbh = C4::Context->dbh;
  98     my $sth;
  99     if (defined $cat) {
 100         my $query = "SELECT * FROM letter WHERE module = ? ORDER BY name";
 101         $sth = $dbh->prepare($query);
 102         $sth->execute($cat);
 103     }
 104     else {
 105         my $query = "SELECT * FROM letter ORDER BY name";
 106         $sth = $dbh->prepare($query);
 107         $sth->execute;
 108     }
 109     while ( my $letter = $sth->fetchrow_hashref ) {
 110         $letters{ $letter->{'code'} } = $letter->{'name'};
 111     }
 112     return \%letters;
 113 }
 114
 115 sub getletter ($$) {
 116     my ( $module, $code ) = @_;
 117     my $dbh = C4::Context->dbh;
 118     my $sth = $dbh->prepare("select * from letter where module=? and code=?");
 119     $sth->execute( $module, $code );
 120     my $line = $sth->fetchrow_hashref;
 121     return $line;
 122 }
 123
 124 =head2 addalert ($borrowernumber, $type, $externalid)
 125
 126     parameters :
 127     - $borrowernumber : the number of the borrower subscribing to the alert
 128     - $type : the type of alert.
 129     - $externalid : the primary key of the object to put alert on. For issues, the alert is made on subscriptionid.
 130
 131     create an alert and return the alertid (primary key)
 132
 133 =cut
 134
 135 sub addalert ($$$) {
 136     my ( $borrowernumber, $type, $externalid ) = @_;
 137     my $dbh = C4::Context->dbh;
 138     my $sth =
 139       $dbh->prepare(
 140         "insert into alert (borrowernumber, type, externalid) values (?,?,?)");
 141     $sth->execute( $borrowernumber, $type, $externalid );
 142
 143     # get the alert number newly created and return it
 144     my $alertid = $dbh->{'mysql_insertid'};
 145     return $alertid;
 146 }
 147
 148 =head2 delalert ($alertid)
 149
 150     parameters :
 151     - alertid : the alert id
 152     deletes the alert
 153
 154 =cut
 155
 156 sub delalert ($) {
 157     my $alertid = shift or die "delalert() called without valid argument (alertid)";    # it's gonna die anyway.
 158     $debug and warn "delalert: deleting alertid $alertid";
 159     my $sth = C4::Context->dbh->prepare("delete from alert where alertid=?");
 160     $sth->execute($alertid);
 161 }
 162
 163 =head2 getalert ([$borrowernumber], [$type], [$externalid])
 164
 165     parameters :
 166     - $borrowernumber : the number of the borrower subscribing to the alert
 167     - $type : the type of alert.
 168     - $externalid : the primary key of the object to put alert on. For issues, the alert is made on subscriptionid.
 169     all parameters NON mandatory. If a parameter is omitted, the query is done without the corresponding parameter. For example, without $externalid, returns all alerts for a borrower on a topic.
 170
 171 =cut
 172
 173 sub getalert (;$$$) {
 174     my ( $borrowernumber, $type, $externalid ) = @_;
 175     my $dbh   = C4::Context->dbh;
 176     my $query = "SELECT * FROM alert WHERE";
 177     my @bind;
 178     if ($borrowernumber and $borrowernumber =~ /^\d+$/) {
 179         $query .= " borrowernumber=? AND ";
 180         push @bind, $borrowernumber;
 181     }
 182     if ($type) {
 183         $query .= " type=? AND ";
 184         push @bind, $type;
 185     }
 186     if ($externalid) {
 187         $query .= " externalid=? AND ";
 188         push @bind, $externalid;
 189     }
 190     $query =~ s/ AND $//;
 191     my $sth = $dbh->prepare($query);
 192     $sth->execute(@bind);
 193     return $sth->fetchall_arrayref({});
 194 }
 195
 196 =head2 findrelatedto($type, $externalid)
 197
 198         parameters :
 199         - $type : the type of alert
 200         - $externalid : the id of the "object" to query
 201
 202         In the table alert, a "id" is stored in the externalid field. This "id" is related to another table, depending on the type of the alert.
 203         When type=issue, the id is related to a subscriptionid and this sub returns the name of the biblio.
 204
 205 =cut
 206
 207 # outmoded POD:
 208 # When type=virtual, the id is related to a virtual shelf and this sub returns the name of the sub
 209
 210 sub findrelatedto ($$) {
 211     my $type       = shift or return undef;
 212     my $externalid = shift or return undef;
 213     my $q = ($type eq 'issue'   ) ?
 214 "select title as result from subscription left join biblio on subscription.biblionumber=biblio.biblionumber where subscriptionid=?" :
 215             ($type eq 'borrower') ?
 216 "select concat(firstname,' ',surname) from borrowers where borrowernumber=?" : undef;
 217     unless ($q) {
 218         warn "findrelatedto(): Illegal type '$type'";
 219         return undef;
 220     }
 221     my $sth = C4::Context->dbh->prepare($q);
 222     $sth->execute($externalid);
 223     my ($result) = $sth->fetchrow;
 224     return $result;
 225 }
 226
 227 =head2 SendAlerts
 228
 229     parameters :
 230     - $type : the type of alert
 231     - $externalid : the id of the "object" to query
 232     - $letter : the letter to send.
 233
 234     send an alert to all borrowers having put an alert on a given subject.
 235
 236 =cut
 237
 238 sub SendAlerts {
 239     my ( $type, $externalid, $letter ) = @_;
 240     my $dbh = C4::Context->dbh;
 241     if ( $type eq 'issue' ) {
 242
 243         #               warn "sending issues...";
 244         my $letter = getletter( 'serial', $letter );
 245
 246         # prepare the letter...
 247         # search the biblionumber
 248         my $sth =
 249           $dbh->prepare(
 250             "SELECT biblionumber FROM subscription WHERE subscriptionid=?");
 251         $sth->execute($externalid);
 252         my ($biblionumber) = $sth->fetchrow;
 253
 254         # parsing branch info
 255         my $userenv = C4::Context->userenv;
 256         parseletter( $letter, 'branches', $userenv->{branch} );
 257
 258         # parsing librarian name
 259         $letter->{content} =~ s/<<LibrarianFirstname>>/$userenv->{firstname}/g;
 260         $letter->{content} =~ s/<<LibrarianSurname>>/$userenv->{surname}/g;
 261         $letter->{content} =~
 262           s/<<LibrarianEmailaddress>>/$userenv->{emailaddress}/g;
 263
 264         # parsing biblio information
 265         parseletter( $letter, 'biblio',      $biblionumber );
 266         parseletter( $letter, 'biblioitems', $biblionumber );
 267
 268         # find the list of borrowers to alert
 269         my $alerts = getalert( '', 'issue', $externalid );
 270         foreach (@$alerts) {
 271
 272             # and parse borrower ...
 273             my $innerletter = $letter;
 274             my $borinfo = GetMember( $_->{'borrowernumber'}, 'borrowernumber' );
 275             parseletter( $innerletter, 'borrowers', $_->{'borrowernumber'} );
 276
 277             # ... then send mail
 278             if ( $borinfo->{email} ) {
 279                 my %mail = (
 280                     To      => $borinfo->{email},
 281                     From    => $borinfo->{email},
 282                     Subject => "" . $innerletter->{title},
 283                     Message => "" . $innerletter->{content},
 284                     'Content-Type' => 'text/plain; charset="utf8"',
 285                     );
 286                 sendmail(%mail);
 287
 288 # warn "sending to $mail{To} From $mail{From} subj $mail{Subject} Mess $mail{Message}";
 289             }
 290         }
 291     }
 292     elsif ( $type eq 'claimacquisition' ) {
 293
 294         #               warn "sending issues...";
 295         my $letter = getletter( 'claimacquisition', $letter );
 296
 297         # prepare the letter...
 298         # search the biblionumber
 299         my $strsth =
 300 "select aqorders.*,aqbasket.*,biblio.*,biblioitems.* from aqorders LEFT JOIN aqbasket on aqbasket.basketno=aqorders.basketno LEFT JOIN biblio on aqorders.biblionumber=biblio.biblionumber LEFT JOIN biblioitems on aqorders.biblioitemnumber=biblioitems.biblioitemnumber where aqorders.ordernumber IN ("
 301           . join( ",", @$externalid ) . ")";
 302         my $sthorders = $dbh->prepare($strsth);
 303         $sthorders->execute;
 304         my $dataorders = $sthorders->fetchall_arrayref( {} );
 305         parseletter( $letter, 'aqbooksellers',
 306             $dataorders->[0]->{booksellerid} );
 307         my $sthbookseller =
 308           $dbh->prepare("select * from aqbooksellers where id=?");
 309         $sthbookseller->execute( $dataorders->[0]->{booksellerid} );
 310         my $databookseller = $sthbookseller->fetchrow_hashref;
 311
 312         # parsing branch info
 313         my $userenv = C4::Context->userenv;
 314         parseletter( $letter, 'branches', $userenv->{branch} );
 315
 316         # parsing librarian name
 317         $letter->{content} =~ s/<<LibrarianFirstname>>/$userenv->{firstname}/g;
 318         $letter->{content} =~ s/<<LibrarianSurname>>/$userenv->{surname}/g;
 319         $letter->{content} =~
 320           s/<<LibrarianEmailaddress>>/$userenv->{emailaddress}/g;
 321         foreach my $data (@$dataorders) {
 322             my $line = $1 if ( $letter->{content} =~ m/(<<.*>>)/ );
 323             foreach my $field ( keys %$data ) {
 324                 $line =~ s/(<<[^\.]+.$field>>)/$data->{$field}/;
 325             }
 326             $letter->{content} =~ s/(<<.*>>)/$line\n$1/;
 327         }
 328         $letter->{content} =~ s/<<[^>]*>>//g;
 329         my $innerletter = $letter;
 330
 331         # ... then send mail
 332         if (   $databookseller->{bookselleremail}
 333             || $databookseller->{contemail} )
 334         {
 335             my %mail = (
 336                 To => $databookseller->{bookselleremail}
 337                   . (
 338                     $databookseller->{contemail}
 339                     ? "," . $databookseller->{contemail}
 340                     : ""
 341                   ),
 342                 From           => $userenv->{emailaddress},
 343                 Subject        => "" . $innerletter->{title},
 344                 Message        => "" . $innerletter->{content},
 345                 'Content-Type' => 'text/plain; charset="utf8"',
 346             );
 347             sendmail(%mail);
 348             warn
 349 "sending to $mail{To} From $mail{From} subj $mail{Subject} Mess $mail{Message}";
 350         }
 351         if ( C4::Context->preference("LetterLog") ) {
 352             logaction(
 353                 "ACQUISITION",
 354                 "Send Acquisition claim letter",
 355                 "",
 356                 "order list : "
 357                   . join( ",", @$externalid )
 358                   . "\n$innerletter->{title}\n$innerletter->{content}"
 359             );
 360         }
 361     }
 362     elsif ( $type eq 'claimissues' ) {
 363
 364         #               warn "sending issues...";
 365         my $letter = getletter( 'claimissues', $letter );
 366
 367         # prepare the letter...
 368         # search the biblionumber
 369         my $strsth =
 370 "select serial.*,subscription.*, biblio.* from serial LEFT JOIN subscription on serial.subscriptionid=subscription.subscriptionid LEFT JOIN biblio on serial.biblionumber=biblio.biblionumber where serial.serialid IN ("
 371           . join( ",", @$externalid ) . ")";
 372         my $sthorders = $dbh->prepare($strsth);
 373         $sthorders->execute;
 374         my $dataorders = $sthorders->fetchall_arrayref( {} );
 375         parseletter( $letter, 'aqbooksellers',
 376             $dataorders->[0]->{aqbooksellerid} );
 377         my $sthbookseller =
 378           $dbh->prepare("select * from aqbooksellers where id=?");
 379         $sthbookseller->execute( $dataorders->[0]->{aqbooksellerid} );
 380         my $databookseller = $sthbookseller->fetchrow_hashref;
 381
 382         # parsing branch info
 383         my $userenv = C4::Context->userenv;
 384         parseletter( $letter, 'branches', $userenv->{branch} );
 385
 386         # parsing librarian name
 387         $letter->{content} =~ s/<<LibrarianFirstname>>/$userenv->{firstname}/g;
 388         $letter->{content} =~ s/<<LibrarianSurname>>/$userenv->{surname}/g;
 389         $letter->{content} =~
 390           s/<<LibrarianEmailaddress>>/$userenv->{emailaddress}/g;
 391         foreach my $data (@$dataorders) {
 392             my $line = $1 if ( $letter->{content} =~ m/(<<.*>>)/ );
 393             foreach my $field ( keys %$data ) {
 394                 $line =~ s/(<<[^\.]+.$field>>)/$data->{$field}/;
 395             }
 396             $letter->{content} =~ s/(<<.*>>)/$line\n$1/;
 397         }
 398         $letter->{content} =~ s/<<[^>]*>>//g;
 399         my $innerletter = $letter;
 400
 401         # ... then send mail
 402         if (   $databookseller->{bookselleremail}
 403             || $databookseller->{contemail} )
 404         {
 405             my %mail = (
 406                 To => $databookseller->{bookselleremail}
 407                   . (
 408                     $databookseller->{contemail}
 409                     ? "," . $databookseller->{contemail}
 410                     : ""
 411                   ),
 412                 From    => $userenv->{emailaddress},
 413                 Subject => "" . $innerletter->{title},
 414                 Message => "" . $innerletter->{content},
 415                 'Content-Type' => 'text/plain; charset="utf8"',
 416             );
 417             sendmail(%mail);
 418             logaction(
 419                 "ACQUISITION",
 420                 "CLAIM ISSUE",
 421                 undef,
 422                 "To="
 423                   . $databookseller->{contemail}
 424                   . " Title="
 425                   . $innerletter->{title}
 426                   . " Content="
 427                   . $innerletter->{content}
 428             ) if C4::Context->preference("LetterLog");
 429         }
 430         warn
 431 "sending to From $userenv->{emailaddress} subj $innerletter->{title} Mess $innerletter->{content}";
 432     }
 433    # send an "account details" notice to a newly created user
 434     elsif ( $type eq 'members' ) {
 435         $letter->{content} =~ s/<<borrowers.title>>/$externalid->{'title'}/g;
 436         $letter->{content} =~ s/<<borrowers.firstname>>/$externalid->{'firstname'}/g;
 437         $letter->{content} =~ s/<<borrowers.surname>>/$externalid->{'surname'}/g;
 438         $letter->{content} =~ s/<<borrowers.userid>>/$externalid->{'userid'}/g;
 439         $letter->{content} =~ s/<<borrowers.password>>/$externalid->{'password'}/g;
 440
 441         my %mail = (
 442                 To      =>     $externalid->{'emailaddr'},
 443                 From    =>  C4::Context->preference("KohaAdminEmailAddress"),
 444                 Subject => $letter->{'title'},
 445                 Message => $letter->{'content'},
 446                 'Content-Type' => 'text/plain; charset="utf8"',
 447         );
 448         sendmail(%mail);
 449     }
 450 }
 451
 452 =head2 parseletter($letter, $table, $pk)
 453
 454     parameters :
 455     - $letter : a hash to letter fields (title & content useful)
 456     - $table : the Koha table to parse.
 457     - $pk : the primary key to query on the $table table
 458     parse all fields from a table, and replace values in title & content with the appropriate value
 459     (not exported sub, used only internally)
 460
 461 =cut
 462
 463 our %handles = ();
 464 our %columns = ();
 465
 466 sub parseletter_sth {
 467     my $table = shift;
 468     unless ($table) {
 469         carp "ERROR: parseletter_sth() called without argument (table)";
 470         return;
 471     }
 472     # check cache first
 473     (defined $handles{$table}) and return $handles{$table};
 474     my $query =
 475     ($table eq 'biblio'       ) ? "SELECT * FROM $table WHERE   biblionumber = ?"                      :
 476     ($table eq 'biblioitems'  ) ? "SELECT * FROM $table WHERE   biblionumber = ?"                      :
 477     ($table eq 'items'        ) ? "SELECT * FROM $table WHERE     itemnumber = ?"                      :
 478     ($table eq 'reserves'     ) ? "SELECT * FROM $table WHERE borrowernumber = ? and biblionumber = ?" :
 479     ($table eq 'borrowers'    ) ? "SELECT * FROM $table WHERE borrowernumber = ?"                      :
 480     ($table eq 'branches'     ) ? "SELECT * FROM $table WHERE     branchcode = ?"                      :
 481     ($table eq 'aqbooksellers') ? "SELECT * FROM $table WHERE             id = ?"                      : undef ;
 482     unless ($query) {
 483         warn "ERROR: No parseletter_sth query for table '$table'";
 484         return;     # nothing to get
 485     }
 486     unless ($handles{$table} = C4::Context->dbh->prepare($query)) {
 487         warn "ERROR: Failed to prepare query: '$query'";
 488         return;
 489     }
 490     return $handles{$table};    # now cache is populated for that $table
 491 }
 492
 493 sub parseletter {
 494     my ( $letter, $table, $pk, $pk2 ) = @_;
 495     unless ($letter) {
 496         carp "ERROR: parseletter() 1st argument 'letter' empty";
 497         return;
 498     }
 499     #   warn "Parseletter : ($letter, $table, $pk ...)";
 500     my $sth = parseletter_sth($table);
 501     unless ($sth) {
 502         warn "parseletter_sth('$table') failed to return a valid sth.  No substitution will be done for that table.";
 503         return;
 504     }
 505     if ( $pk2 ) {
 506         $sth->execute($pk, $pk2);
 507     } else {
 508         $sth->execute($pk);
 509     }
 510
 511     my $values = $sth->fetchrow_hashref;
 512
 513     # and get all fields from the table
 514     my $columns = C4::Context->dbh->prepare("SHOW COLUMNS FROM $table");
 515     $columns->execute;
 516     while ( ( my $field ) = $columns->fetchrow_array ) {
 517         my $replacefield = "<<$table.$field>>";
 518         my $replacedby   = $values->{$field} || '';
 519         ($letter->{title}  ) and $letter->{title}   =~ s/$replacefield/$replacedby/g;
 520         ($letter->{content}) and $letter->{content} =~ s/$replacefield/$replacedby/g;
 521     }
 522 }
 523
 524 =head2 EnqueueLetter
 525
 526 =over 4
 527
 528 my $success = EnqueueLetter( { letter => $letter, borrowernumber => '12', message_transport_type => 'email' } )
 529
 530 places a letter in the message_queue database table, which will
 531 eventually get processed (sent) by the process_message_queue.pl
 532 cronjob when it calls SendQueuedMessages.
 533
 534 return true on success
 535
 536 =back
 537
 538 =cut
 539
 540 sub EnqueueLetter ($) {
 541     my $params = shift or return undef;
 542
 543     return unless exists $params->{'letter'};
 544     return unless exists $params->{'borrowernumber'};
 545     return unless exists $params->{'message_transport_type'};
 546
 547     # If we have any attachments we should encode then into the body.
 548     if ( $params->{'attachments'} ) {
 549         $params->{'letter'} = _add_attachments(
 550             {   letter      => $params->{'letter'},
 551                 attachments => $params->{'attachments'},
 552                 message     => MIME::Lite->new( Type => 'multipart/mixed' ),
 553             }
 554         );
 555     }
 556
 557     my $dbh       = C4::Context->dbh();
 558     my $statement = << 'ENDSQL';
 559 INSERT INTO message_queue
 560 ( borrowernumber, subject, content, message_transport_type, status, time_queued, to_address, from_address, content_type )
 561 VALUES
 562 ( ?,              ?,       ?,       ?,                      ?,      NOW(),       ?,          ?,            ? )
 563 ENDSQL
 564
 565     my $sth    = $dbh->prepare($statement);
 566     my $result = $sth->execute(
 567         $params->{'borrowernumber'},              # borrowernumber
 568         $params->{'letter'}->{'title'},           # subject
 569         $params->{'letter'}->{'content'},         # content
 570         $params->{'message_transport_type'},      # message_transport_type
 571         'pending',                                # status
 572         $params->{'to_address'},                  # to_address
 573         $params->{'from_address'},                # from_address
 574         $params->{'letter'}->{'content-type'},    # content_type
 575     );
 576     return $result;
 577 }
 578
 579 =head2 SendQueuedMessages ([$hashref])
 580
 581 =over 4
 582
 583 sends all of the 'pending' items in the message queue.
 584
 585 my $sent = SendQueuedMessages( { verbose => 1 } );
 586
 587 returns number of messages sent.
 588
 589 =back
 590
 591 =cut
 592
 593 sub SendQueuedMessages (;$) {
 594     my $params = shift;
 595
 596     my $unsent_messages = _get_unsent_messages();
 597     MESSAGE: foreach my $message ( @$unsent_messages ) {
 598         # warn Data::Dumper->Dump( [ $message ], [ 'message' ] );
 599         warn sprintf( 'sending %s message to patron: %s',
 600                       $message->{'message_transport_type'},
 601                       $message->{'borrowernumber'} || 'Admin' )
 602           if $params->{'verbose'} or $debug;
 603         # This is just begging for subclassing
 604         next MESSAGE if ( lc($message->{'message_transport_type'}) eq 'rss' );
 605         if ( lc( $message->{'message_transport_type'} ) eq 'email' ) {
 606             _send_message_by_email( $message );
 607         }
 608         elsif ( lc( $message->{'message_transport_type'} ) eq 'sms' ) {
 609             _send_message_by_sms( $message );
 610         }
 611     }
 612     return scalar( @$unsent_messages );
 613 }
 614
 615 =head2 GetRSSMessages
 616
 617 =over 4
 618
 619 my $message_list = GetRSSMessages( { limit => 10, borrowernumber => '14' } )
 620
 621 returns a listref of all queued RSS messages for a particular person.
 622
 623 =back
 624
 625 =cut
 626
 627 sub GetRSSMessages {
 628     my $params = shift;
 629
 630     return unless $params;
 631     return unless ref $params;
 632     return unless $params->{'borrowernumber'};
 633
 634     return _get_unsent_messages( { message_transport_type => 'rss',
 635                                    limit                  => $params->{'limit'},
 636                                    borrowernumber         => $params->{'borrowernumber'}, } );
 637 }
 638
 639 =head2 GetQueuedMessages ([$hashref])
 640
 641 =over 4
 642
 643 my $messages = GetQueuedMessage( { borrowernumber => '123', limit => 20 } );
 644
 645 fetches messages out of the message queue.
 646
 647 returns:
 648 list of hashes, each has represents a message in the message queue.
 649
 650 =back
 651
 652 =cut
 653
 654 sub GetQueuedMessages {
 655     my $params = shift;
 656
 657     my $dbh = C4::Context->dbh();
 658     my $statement = << 'ENDSQL';
 659 SELECT message_id, borrowernumber, subject, content, message_transport_type, status, time_queued
 660 FROM message_queue
 661 ENDSQL
 662
 663     my @query_params;
 664     my @whereclauses;
 665     if ( exists $params->{'borrowernumber'} ) {
 666         push @whereclauses, ' borrowernumber = ? ';
 667         push @query_params, $params->{'borrowernumber'};
 668     }
 669
 670     if ( @whereclauses ) {
 671         $statement .= ' WHERE ' . join( 'AND', @whereclauses );
 672     }
 673
 674     if ( defined $params->{'limit'} ) {
 675         $statement .= ' LIMIT ? ';
 676         push @query_params, $params->{'limit'};
 677     }
 678
 679     my $sth = $dbh->prepare( $statement );
 680     my $result = $sth->execute( @query_params );
 681     return $sth->fetchall_arrayref({});
 682 }
 683
 684 =head2 _add_attachements
 685
 686 named parameters:
 687 letter - the standard letter hashref
 688 attachments - listref of attachments. each attachment is a hashref of:
 689   type - the mime type, like 'text/plain'
 690   content - the actual attachment
 691   filename - the name of the attachment.
 692 message - a MIME::Lite object to attach these to.
 693
 694 returns your letter object, with the content updated.
 695
 696 =cut
 697
 698 sub _add_attachments {
 699     my $params = shift;
 700
 701     return unless 'HASH' eq ref $params;
 702     foreach my $required_parameter (qw( letter attachments message )) {
 703         return unless exists $params->{$required_parameter};
 704     }
 705     return $params->{'letter'} unless @{ $params->{'attachments'} };
 706
 707     # First, we have to put the body in as the first attachment
 708     $params->{'message'}->attach(
 709         Type => 'TEXT',
 710         Data => $params->{'letter'}->{'content'},
 711     );
 712
 713     foreach my $attachment ( @{ $params->{'attachments'} } ) {
 714         $params->{'message'}->attach(
 715             Type     => $attachment->{'type'},
 716             Data     => $attachment->{'content'},
 717             Filename => $attachment->{'filename'},
 718         );
 719     }
 720     # we're forcing list context here to get the header, not the count back from grep.
 721     ( $params->{'letter'}->{'content-type'} ) = grep( /^Content-Type:/, split( /\n/, $params->{'message'}->header_as_string ) );
 722     $params->{'letter'}->{'content-type'} =~ s/^Content-Type:\s+//;
 723     $params->{'letter'}->{'content'} = $params->{'message'}->body_as_string;
 724
 725     return $params->{'letter'};
 726
 727 }
 728
 729 sub _get_unsent_messages (;$) {
 730     my $params = shift;
 731
 732     my $dbh = C4::Context->dbh();
 733     my $statement = << 'ENDSQL';
 734 SELECT message_id, borrowernumber, subject, content, message_transport_type, status, time_queued, from_address, to_address, content_type
 735   FROM message_queue
 736  WHERE status = ?
 737 ENDSQL
 738
 739     my @query_params = ('pending');
 740     if ( ref $params ) {
 741         if ( $params->{'message_transport_type'} ) {
 742             $statement .= ' AND message_transport_type = ? ';
 743             push @query_params, $params->{'message_transport_type'};
 744         }
 745         if ( $params->{'borrowernumber'} ) {
 746             $statement .= ' AND borrowernumber = ? ';
 747             push @query_params, $params->{'borrowernumber'};
 748         }
 749         if ( $params->{'limit'} ) {
 750             $statement .= ' limit ? ';
 751             push @query_params, $params->{'limit'};
 752         }
 753     }
 754     $debug and warn "_get_unsent_messages SQL: $statement";
 755     $debug and warn "_get_unsent_messages params: " . join(',',@query_params);
 756     my $sth = $dbh->prepare( $statement );
 757     my $result = $sth->execute( @query_params );
 758     return $sth->fetchall_arrayref({});
 759 }
 760
 761 sub _send_message_by_email ($) {
 762     my $message = shift or return;
 763
 764     my $to_address = $message->{to_address};
 765     unless ($to_address) {
 766         my $member = C4::Members::GetMember( $message->{'borrowernumber'} );
 767         unless ($member) {
 768             warn "FAIL: No 'to_address' and INVALID borrowernumber ($message->{borrowernumber})";
 769             _set_message_status( { message_id => $message->{'message_id'},
 770                                    status     => 'failed' } );
 771             return;
 772         }
 773         unless ($to_address = $member->{email}) {   # assigment, not comparison
 774             # warn "FAIL: No 'to_address' and no email for " . ($member->{surname} ||'') . ", borrowernumber ($message->{borrowernumber})";
 775             # warning too verbose for this more common case?
 776             _set_message_status( { message_id => $message->{'message_id'},
 777                                    status     => 'failed' } );
 778             return;
 779         }
 780     }
 781
 782         my $content = encode('utf8', $message->{'content'});
 783     my %sendmail_params = (
 784         To   => $to_address,
 785         From => $message->{'from_address'} || C4::Context->preference('KohaAdminEmailAddress'),
 786         Subject => $message->{'subject'},
 787         charset => 'utf8',
 788         Message => $content,
 789         'content-type' => $message->{'content_type'} || 'text/plain; charset="UTF-8"',
 790     );
 791
 792     my $success = sendmail( %sendmail_params );
 793
 794     if ( $success ) {
 795         # warn "Sendmail OK. Log says: " .  $Mail::Sendmail::log;
 796         _set_message_status( { message_id => $message->{'message_id'},
 797                                status     => 'sent' } );
 798         return $success;
 799     } else {
 800         # warn "Mail::Sendmail::error - " . $Mail::Sendmail::error;
 801         # warn "Mail::Sendmail::log   - " . $Mail::Sendmail::log;
 802         _set_message_status( { message_id => $message->{'message_id'},
 803                                status     => 'failed' } );
 804         return;
 805     }
 806 }
 807
 808 sub _send_message_by_sms ($) {
 809     my $message = shift or return undef;
 810     my $member = C4::Members::GetMember( $message->{'borrowernumber'} );
 811     return unless $member->{'smsalertnumber'};
 812
 813     my $success = C4::SMS->send_sms( { destination => $member->{'smsalertnumber'},
 814                                        message     => $message->{'content'},
 815                                      } );
 816     _set_message_status( { message_id => $message->{'message_id'},
 817                            status     => ($success ? 'sent' : 'failed') } );
 818     return $success;
 819 }
 820
 821 sub _set_message_status ($) {
 822     my $params = shift or return undef;
 823
 824     foreach my $required_parameter ( qw( message_id status ) ) {
 825         return undef unless exists $params->{ $required_parameter };
 826     }
 827
 828     my $dbh = C4::Context->dbh();
 829     my $statement = 'UPDATE message_queue SET status= ? WHERE message_id = ?';
 830     my $sth = $dbh->prepare( $statement );
 831     my $result = $sth->execute( $params->{'status'},
 832                                 $params->{'message_id'} );
 833     return $result;
 834 }
 835
 836
 837 1;
 838 __END__