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 with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
29 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
33 # set the version for version checking
37 &GetLetters &getletter &addalert &getalert &delalert &findrelatedto &SendAlerts
43 C4::Letters - Give functions for Letters management
51 "Letters" is the tool used in Koha to manage informations sent to the patrons and/or the library. This include some cron jobs like
52 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)
54 Letters are managed through "alerts" sent by Koha on some events. All "alert" related functions are in this module too.
60 $letters = &getletters($category);
61 returns informations about letters.
62 if needed, $category filters for letters given category
63 Create a letter selector with the following code
67 my $letters = GetLetters($cat);
69 foreach my $thisletter (keys %$letters) {
70 my $selected = 1 if $thisletter eq $letter;
73 selected => $selected,
74 lettername => $letters->{$thisletter},
76 push @letterloop, \%row;
81 <select name="letter">
82 <option value="">Default</option>
83 <!-- TMPL_LOOP name="letterloop" -->
84 <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="lettername" --></option>
92 # returns a reference to a hash of references to ALL letters...
95 my $dbh = C4::Context->dbh;
99 my $query = "SELECT * FROM letter WHERE module = ? ORDER BY name";
100 $sth = $dbh->prepare($query);
104 my $query = " SELECT * FROM letter ORDER BY name";
105 $sth = $dbh->prepare($query);
108 while ( my $letter = $sth->fetchrow_hashref ) {
109 $letters{ $letter->{'code'} } = $letter->{'name'};
115 my ( $module, $code ) = @_;
116 my $dbh = C4::Context->dbh;
117 my $sth = $dbh->prepare("select * from letter where module=? and code=?");
118 $sth->execute( $module, $code );
119 my $line = $sth->fetchrow_hashref;
126 - $borrowernumber : the number of the borrower subscribing to the alert
127 - $type : the type of alert.
128 - externalid : the primary key of the object to put alert on. For issues, the alert is made on subscriptionid.
130 create an alert and return the alertid (primary key)
135 my ( $borrowernumber, $type, $externalid ) = @_;
136 my $dbh = C4::Context->dbh;
139 "insert into alert (borrowernumber, type, externalid) values (?,?,?)");
140 $sth->execute( $borrowernumber, $type, $externalid );
142 # get the alert number newly created and return it
143 my $alertid = $dbh->{'mysql_insertid'};
150 - alertid : the alert id
158 #warn "ALERTID : $alertid";
159 my $dbh = C4::Context->dbh;
160 my $sth = $dbh->prepare("delete from alert where alertid=?");
161 $sth->execute($alertid);
167 - $borrowernumber : the number of the borrower subscribing to the alert
168 - $type : the type of alert.
169 - externalid : the primary key of the object to put alert on. For issues, the alert is made on subscriptionid.
170 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.
175 my ( $borrowernumber, $type, $externalid ) = @_;
176 my $dbh = C4::Context->dbh;
177 my $query = "SELECT * FROM alert WHERE";
179 if ($borrowernumber =~ /^\d+$/) {
180 $query .= " borrowernumber=? AND ";
181 push @bind, $borrowernumber;
184 $query .= " type=? AND ";
188 $query .= " externalid=? AND ";
189 push @bind, $externalid;
191 $query =~ s/ AND $//;
192 my $sth = $dbh->prepare($query);
193 $sth->execute(@bind);
195 while ( my $line = $sth->fetchrow_hashref ) {
204 - $type : the type of alert
205 - $externalid : the id of the "object" to query
207 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.
208 When type=issue, the id is related to a subscriptionid and this sub returns the name of the biblio.
209 When type=virtual, the id is related to a virtual shelf and this sub returns the name of the sub
214 my ( $type, $externalid ) = @_;
215 my $dbh = C4::Context->dbh;
217 if ( $type eq 'issue' ) {
220 "select title as result from subscription left join biblio on subscription.biblionumber=biblio.biblionumber where subscriptionid=?"
223 if ( $type eq 'borrower' ) {
226 "select concat(firstname,' ',surname) from borrowers where borrowernumber=?"
229 $sth->execute($externalid);
230 my ($result) = $sth->fetchrow;
237 - $type : the type of alert
238 - $externalid : the id of the "object" to query
239 - $letter : the letter to send.
241 send an alert to all borrowers having put an alert on a given subject.
246 my ( $type, $externalid, $letter ) = @_;
247 my $dbh = C4::Context->dbh;
248 if ( $type eq 'issue' ) {
250 # warn "sending issues...";
251 my $letter = getletter( 'serial', $letter );
253 # prepare the letter...
254 # search the biblionumber
257 "SELECT biblionumber FROM subscription WHERE subscriptionid=?");
258 $sth->execute($externalid);
259 my ($biblionumber) = $sth->fetchrow;
261 # parsing branch info
262 my $userenv = C4::Context->userenv;
263 parseletter( $letter, 'branches', $userenv->{branch} );
265 # parsing librarian name
266 $letter->{content} =~ s/<<LibrarianFirstname>>/$userenv->{firstname}/g;
267 $letter->{content} =~ s/<<LibrarianSurname>>/$userenv->{surname}/g;
268 $letter->{content} =~
269 s/<<LibrarianEmailaddress>>/$userenv->{emailaddress}/g;
271 # parsing biblio information
272 parseletter( $letter, 'biblio', $biblionumber );
273 parseletter( $letter, 'biblioitems', $biblionumber );
275 # find the list of borrowers to alert
276 my $alerts = getalert( '', 'issue', $externalid );
279 # and parse borrower ...
280 my $innerletter = $letter;
281 my $borinfo = GetMember( $_->{'borrowernumber'}, 'borrowernumber' );
282 parseletter( $innerletter, 'borrowers', $_->{'borrowernumber'} );
285 if ( $borinfo->{email} ) {
287 To => $borinfo->{email},
288 From => $borinfo->{email},
289 Subject => "" . $innerletter->{title},
290 Message => "" . $innerletter->{content},
291 'Content-Type' => 'text/plain; charset="utf8"',
295 # warn "sending to $mail{To} From $mail{From} subj $mail{Subject} Mess $mail{Message}";
299 elsif ( $type eq 'claimacquisition' ) {
301 # warn "sending issues...";
302 my $letter = getletter( 'claimacquisition', $letter );
304 # prepare the letter...
305 # search the biblionumber
307 "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 ("
308 . join( ",", @$externalid ) . ")";
309 my $sthorders = $dbh->prepare($strsth);
311 my $dataorders = $sthorders->fetchall_arrayref( {} );
312 parseletter( $letter, 'aqbooksellers',
313 $dataorders->[0]->{booksellerid} );
315 $dbh->prepare("select * from aqbooksellers where id=?");
316 $sthbookseller->execute( $dataorders->[0]->{booksellerid} );
317 my $databookseller = $sthbookseller->fetchrow_hashref;
319 # parsing branch info
320 my $userenv = C4::Context->userenv;
321 parseletter( $letter, 'branches', $userenv->{branch} );
323 # parsing librarian name
324 $letter->{content} =~ s/<<LibrarianFirstname>>/$userenv->{firstname}/g;
325 $letter->{content} =~ s/<<LibrarianSurname>>/$userenv->{surname}/g;
326 $letter->{content} =~
327 s/<<LibrarianEmailaddress>>/$userenv->{emailaddress}/g;
328 foreach my $data (@$dataorders) {
329 my $line = $1 if ( $letter->{content} =~ m/(<<.*>>)/ );
330 foreach my $field ( keys %$data ) {
331 $line =~ s/(<<[^\.]+.$field>>)/$data->{$field}/;
333 $letter->{content} =~ s/(<<.*>>)/$line\n$1/;
335 $letter->{content} =~ s/<<[^>]*>>//g;
336 my $innerletter = $letter;
339 if ( $databookseller->{bookselleremail}
340 || $databookseller->{contemail} )
343 To => $databookseller->{bookselleremail}
345 $databookseller->{contemail}
346 ? "," . $databookseller->{contemail}
349 From => $userenv->{emailaddress},
350 Subject => "" . $innerletter->{title},
351 Message => "" . $innerletter->{content},
352 'Content-Type' => 'text/plain; charset="utf8"',
356 "sending to $mail{To} From $mail{From} subj $mail{Subject} Mess $mail{Message}";
358 if ( C4::Context->preference("LetterLog") ) {
361 "Send Acquisition claim letter",
364 . join( ",", @$externalid )
365 . "\n$innerletter->{title}\n$innerletter->{content}"
369 elsif ( $type eq 'claimissues' ) {
371 # warn "sending issues...";
372 my $letter = getletter( 'claimissues', $letter );
374 # prepare the letter...
375 # search the biblionumber
377 "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 ("
378 . join( ",", @$externalid ) . ")";
379 my $sthorders = $dbh->prepare($strsth);
381 my $dataorders = $sthorders->fetchall_arrayref( {} );
382 parseletter( $letter, 'aqbooksellers',
383 $dataorders->[0]->{aqbooksellerid} );
385 $dbh->prepare("select * from aqbooksellers where id=?");
386 $sthbookseller->execute( $dataorders->[0]->{aqbooksellerid} );
387 my $databookseller = $sthbookseller->fetchrow_hashref;
389 # parsing branch info
390 my $userenv = C4::Context->userenv;
391 parseletter( $letter, 'branches', $userenv->{branch} );
393 # parsing librarian name
394 $letter->{content} =~ s/<<LibrarianFirstname>>/$userenv->{firstname}/g;
395 $letter->{content} =~ s/<<LibrarianSurname>>/$userenv->{surname}/g;
396 $letter->{content} =~
397 s/<<LibrarianEmailaddress>>/$userenv->{emailaddress}/g;
398 foreach my $data (@$dataorders) {
399 my $line = $1 if ( $letter->{content} =~ m/(<<.*>>)/ );
400 foreach my $field ( keys %$data ) {
401 $line =~ s/(<<[^\.]+.$field>>)/$data->{$field}/;
403 $letter->{content} =~ s/(<<.*>>)/$line\n$1/;
405 $letter->{content} =~ s/<<[^>]*>>//g;
406 my $innerletter = $letter;
409 if ( $databookseller->{bookselleremail}
410 || $databookseller->{contemail} )
413 To => $databookseller->{bookselleremail}
415 $databookseller->{contemail}
416 ? "," . $databookseller->{contemail}
419 From => $userenv->{emailaddress},
420 Subject => "" . $innerletter->{title},
421 Message => "" . $innerletter->{content},
422 'Content-Type' => 'text/plain; charset="utf8"',
430 . $databookseller->{contemail}
432 . $innerletter->{title}
434 . $innerletter->{content}
435 ) if C4::Context->preference("LetterLog");
438 "sending to From $userenv->{emailaddress} subj $innerletter->{title} Mess $innerletter->{content}";
440 # send an "account details" notice to a newly created user
441 elsif ( $type eq 'members' ) {
442 $letter->{content} =~ s/<<borrowers.title>>/$externalid->{'title'}/g;
443 $letter->{content} =~ s/<<borrowers.firstname>>/$externalid->{'firstname'}/g;
444 $letter->{content} =~ s/<<borrowers.surname>>/$externalid->{'surname'}/g;
445 $letter->{content} =~ s/<<borrowers.userid>>/$externalid->{'userid'}/g;
446 $letter->{content} =~ s/<<borrowers.password>>/$externalid->{'password'}/g;
449 To => $externalid->{'emailaddr'},
450 From => C4::Context->preference("KohaAdminEmailAddress"),
451 Subject => $letter->{'title'},
452 Message => $letter->{'content'},
453 'Content-Type' => 'text/plain; charset="utf8"',
462 - $letter : a hash to letter fields (title & content useful)
463 - $table : the Koha table to parse.
464 - $pk : the primary key to query on the $table table
465 parse all fields from a table, and replace values in title & content with the appropriate value
466 (not exported sub, used only internally)
473 sub parseletter_sth {
476 carp "ERROR: parseletter_sth() called without argument (table)";
480 (defined $handles{$table}) and return $handles{$table};
482 ($table eq 'biblio' ) ? "SELECT * FROM $table WHERE biblionumber = ?" :
483 ($table eq 'biblioitems' ) ? "SELECT * FROM $table WHERE biblionumber = ?" :
484 ($table eq 'items' ) ? "SELECT * FROM $table WHERE itemnumber = ?" :
485 ($table eq 'reserves' ) ? "SELECT * FROM $table WHERE borrowernumber = ? and biblionumber = ?" :
486 ($table eq 'borrowers' ) ? "SELECT * FROM $table WHERE borrowernumber = ?" :
487 ($table eq 'branches' ) ? "SELECT * FROM $table WHERE branchcode = ?" :
488 ($table eq 'aqbooksellers') ? "SELECT * FROM $table WHERE id = ?" : undef ;
490 warn "ERROR: No parseletter_sth query for table '$table'";
491 return; # nothing to get
493 unless ($handles{$table} = C4::Context->dbh->prepare($query)) {
494 warn "ERROR: Failed to prepare query: '$query'";
497 return $handles{$table}; # now cache is populated for that $table
501 my ( $letter, $table, $pk, $pk2 ) = @_;
503 carp "ERROR: parseletter() 1st argument 'letter' empty";
506 # warn "Parseletter : ($letter, $table, $pk ...)";
507 my $sth = parseletter_sth($table);
509 warn "parseletter_sth('$table') failed to return a valid sth. No substitution will be done for that table.";
513 $sth->execute($pk, $pk2);
518 my $values = $sth->fetchrow_hashref;
520 # and get all fields from the table
521 my $columns = C4::Context->dbh->prepare("SHOW COLUMNS FROM $table");
523 while ( ( my $field ) = $columns->fetchrow_array ) {
524 my $replacefield = "<<$table.$field>>";
525 my $replacedby = $values->{$field} || '';
526 ($letter->{title} ) and $letter->{title} =~ s/$replacefield/$replacedby/g;
527 ($letter->{content}) and $letter->{content} =~ s/$replacefield/$replacedby/g;
535 my $success = EnqueueLetter( { letter => $letter, borrowernumber => '12', message_transport_type => 'email' } )
537 places a letter in the message_queue database table, which will
538 eventually get processed (sent) by the process_message_queue.pl
539 cronjob when it calls SendQueuedMessages.
541 return true on success
550 return unless exists $params->{'letter'};
551 return unless exists $params->{'borrowernumber'};
552 return unless exists $params->{'message_transport_type'};
554 # If we have any attachments we should encode then into the body.
555 if ( $params->{'attachments'} ) {
556 $params->{'letter'} = _add_attachments(
557 { letter => $params->{'letter'},
558 attachments => $params->{'attachments'},
559 message => MIME::Lite->new( Type => 'multipart/mixed' ),
564 my $dbh = C4::Context->dbh();
565 my $statement = << 'ENDSQL';
566 INSERT INTO message_queue
567 ( borrowernumber, subject, content, metadata, letter_code, message_transport_type, status, time_queued, to_address, from_address, content_type )
569 ( ?, ?, ?, ?, ?, ?, ?, NOW(), ?, ?, ? )
572 my $sth = $dbh->prepare($statement);
573 my $result = $sth->execute(
574 $params->{'borrowernumber'}, # borrowernumber
575 $params->{'letter'}->{'title'}, # subject
576 $params->{'letter'}->{'content'}, # content
577 $params->{'letter'}->{'metadata'} || '', # metadata
578 $params->{'letter'}->{'code'} || '', # letter_code
579 $params->{'message_transport_type'}, # message_transport_type
581 $params->{'to_address'}, # to_address
582 $params->{'from_address'}, # from_address
583 $params->{'letter'}->{'content-type'}, # content_type
588 =head2 SendQueuedMessages
594 sends all of the 'pending' items in the message queue.
596 my $sent = SendQueuedMessages( { verbose => 1 } )
598 returns number of messages sent.
604 sub SendQueuedMessages {
607 my $unsent_messages = _get_unsent_messages();
608 MESSAGE: foreach my $message ( @$unsent_messages ) {
609 # warn Data::Dumper->Dump( [ $message ], [ 'message' ] );
610 warn sprintf( 'sending %s message to patron: %s',
611 $message->{'message_transport_type'},
612 $message->{'borrowernumber'} || 'Admin' )
613 if $params->{'verbose'};
614 # This is just begging for subclassing
615 next MESSAGE if ( lc( $message->{'message_transport_type'} eq 'rss' ) );
616 if ( lc( $message->{'message_transport_type'} ) eq 'email' ) {
617 _send_message_by_email( $message );
619 if ( lc( $message->{'message_transport_type'} ) eq 'sms' ) {
620 _send_message_by_sms( $message );
623 return scalar( @$unsent_messages );
626 =head2 GetRSSMessages
630 my $message_list = GetRSSMessages( { limit => 10, borrowernumber => '14' } )
632 returns a listref of all queued RSS messages for a particular person.
641 return unless $params;
642 return unless ref $params;
643 return unless $params->{'borrowernumber'};
645 return _get_unsent_messages( { message_transport_type => 'rss',
646 limit => $params->{'limit'},
647 borrowernumber => $params->{'borrowernumber'}, } );
650 =head2 GetQueuedMessages
654 my $messages = GetQueuedMessage( { borrowernumber => '123', limit => 20 } );
656 fetches messages out of the message queue.
659 list of hashes, each has represents a message in the message queue.
665 sub GetQueuedMessages {
668 my $dbh = C4::Context->dbh();
669 my $statement = << 'ENDSQL';
670 SELECT message_id, borrowernumber, subject, content, message_transport_type, status, time_queued
676 if ( exists $params->{'borrowernumber'} ) {
677 push @whereclauses, ' borrowernumber = ? ';
678 push @query_params, $params->{'borrowernumber'};
681 if ( @whereclauses ) {
682 $statement .= ' WHERE ' . join( 'AND', @whereclauses );
685 if ( defined $params->{'limit'} ) {
686 $statement .= ' LIMIT ? ';
687 push @query_params, $params->{'limit'};
690 my $sth = $dbh->prepare( $statement );
691 my $result = $sth->execute( @query_params );
692 my $messages = $sth->fetchall_arrayref({});
696 =head2 _add_attachements
699 letter - the standard letter hashref
700 attachments - listref of attachments. each attachment is a hashref of:
701 type - the mime type, like 'text/plain'
702 content - the actual attachment
703 filename - the name of the attachment.
704 message - a MIME::Lite object to attach these to.
706 returns your letter object, with the content updated.
710 sub _add_attachments {
713 return unless 'HASH' eq ref $params;
714 foreach my $required_parameter (qw( letter attachments message )) {
715 return unless exists $params->{$required_parameter};
717 return $params->{'letter'} unless @{ $params->{'attachments'} };
719 # First, we have to put the body in as the first attachment
720 $params->{'message'}->attach(
722 Data => $params->{'letter'}->{'content'},
725 foreach my $attachment ( @{ $params->{'attachments'} } ) {
726 $params->{'message'}->attach(
727 Type => $attachment->{'type'},
728 Data => $attachment->{'content'},
729 Filename => $attachment->{'filename'},
732 # we're forcing list context here to get the header, not the count back from grep.
733 ( $params->{'letter'}->{'content-type'} ) = grep( /^Content-Type:/, split( /\n/, $params->{'message'}->header_as_string ) );
734 $params->{'letter'}->{'content-type'} =~ s/^Content-Type:\s+//;
735 $params->{'letter'}->{'content'} = $params->{'message'}->body_as_string;
737 return $params->{'letter'};
741 sub _get_unsent_messages {
744 my $dbh = C4::Context->dbh();
745 my $statement = << 'ENDSQL';
746 SELECT message_id, borrowernumber, subject, content, message_transport_type, status, time_queued, from_address, to_address, content_type
748 WHERE status = 'pending'
753 if ( $params->{'message_transport_type'} ) {
754 $statement .= ' AND message_transport_type = ? ';
755 push @query_params, $params->{'message_transport_type'};
757 if ( $params->{'borrowernumber'} ) {
758 $statement .= ' AND borrowernumber = ? ';
759 push @query_params, $params->{'borrowernumber'};
761 if ( $params->{'limit'} ) {
762 $statement .= ' limit ? ';
763 push @query_params, $params->{'limit'};
767 my $sth = $dbh->prepare( $statement );
768 my $result = $sth->execute( @query_params );
769 my $unsent_messages = $sth->fetchall_arrayref({});
770 return $unsent_messages;
773 sub _send_message_by_email {
776 my $member = C4::Members::GetMember( $message->{'borrowernumber'} );
777 return unless $message->{'to_address'} or $member->{'email'};
779 my $content = encode('utf8', $message->{'content'});
780 my %sendmail_params = (
781 To => $message->{'to_address'} || $member->{'email'},
782 From => $message->{'from_address'} || C4::Context->preference('KohaAdminEmailAddress'),
783 Subject => $message->{'subject'},
787 if ($message->{'content_type'}) {
788 $sendmail_params{'content-type'} = $message->{'content_type'};
790 $sendmail_params{'content-type'} = 'text/plain; charset="UTF-8"';
793 my $success = sendmail( %sendmail_params );
796 # warn "OK. Log says:\n", $Mail::Sendmail::log;
797 _set_message_status( { message_id => $message->{'message_id'},
798 status => 'sent' } );
801 # warn $Mail::Sendmail::error;
802 _set_message_status( { message_id => $message->{'message_id'},
803 status => 'failed' } );
808 sub _send_message_by_sms {
811 my $member = C4::Members::GetMember( $message->{'borrowernumber'} );
812 return unless $member->{'smsalertnumber'};
814 my $success = C4::SMS->send_sms( { destination => $member->{'smsalertnumber'},
815 message => $message->{'content'},
818 _set_message_status( { message_id => $message->{'message_id'},
819 status => 'sent' } );
822 _set_message_status( { message_id => $message->{'message_id'},
823 status => 'failed' } );
828 sub _set_message_status {
831 foreach my $required_parameter ( qw( message_id status ) ) {
832 return unless exists $params->{ $required_parameter };
835 my $dbh = C4::Context->dbh();
836 my $statement = 'UPDATE message_queue SET status= ? WHERE message_id = ?';
837 my $sth = $dbh->prepare( $statement );
838 my $result = $sth->execute( $params->{'status'},
839 $params->{'message_id'} );