package C4::Letters; # Copyright 2000-2002 Katipo Communications # # This file is part of Koha. # # Koha is free software; you can redistribute it and/or modify it under the # terms of the GNU General Public License as published by the Free Software # Foundation; either version 2 of the License, or (at your option) any later # version. # # Koha is distributed in the hope that it will be useful, but WITHOUT ANY # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR # A PARTICULAR PURPOSE. See the GNU General Public License for more details. # # You should have received a copy of the GNU General Public License along with # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place, # Suite 330, Boston, MA 02111-1307 USA use strict; use MIME::Lite; use Mail::Sendmail; use C4::Members; use C4::Log; use C4::SMS; use Encode; use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS); BEGIN { require Exporter; # set the version for version checking $VERSION = 3.01; @ISA = qw(Exporter); @EXPORT = qw( &GetLetters &getletter &addalert &getalert &delalert &findrelatedto &SendAlerts ); } =head1 NAME C4::Letters - Give functions for Letters management =head1 SYNOPSIS use C4::Letters; =head1 DESCRIPTION "Letters" is the tool used in Koha to manage informations sent to the patrons and/or the library. This include some cron jobs like 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) Letters are managed through "alerts" sent by Koha on some events. All "alert" related functions are in this module too. =cut =head2 GetLetters $letters = &getletters($category); returns informations about letters. if needed, $category filters for letters given category Create a letter selector with the following code =head3 in PERL SCRIPT my $letters = GetLetters($cat); my @letterloop; foreach my $thisletter (keys %$letters) { my $selected = 1 if $thisletter eq $letter; my %row =( value => $thisletter, selected => $selected, lettername => $letters->{$thisletter}, ); push @letterloop, \%row; } =head3 in TEMPLATE =cut sub GetLetters { # returns a reference to a hash of references to ALL letters... my $cat = shift; my %letters; my $dbh = C4::Context->dbh; $dbh->quote($cat); my $sth; if ( $cat ne "" ) { my $query = "SELECT * FROM letter WHERE module = ? ORDER BY name"; $sth = $dbh->prepare($query); $sth->execute($cat); } else { my $query = " SELECT * FROM letter ORDER BY name"; $sth = $dbh->prepare($query); $sth->execute; } while ( my $letter = $sth->fetchrow_hashref ) { $letters{ $letter->{'code'} } = $letter->{'name'}; } return \%letters; } sub getletter { my ( $module, $code ) = @_; my $dbh = C4::Context->dbh; my $sth = $dbh->prepare("select * from letter where module=? and code=?"); $sth->execute( $module, $code ); my $line = $sth->fetchrow_hashref; return $line; } =head2 addalert parameters : - $borrowernumber : the number of the borrower subscribing to the alert - $type : the type of alert. - externalid : the primary key of the object to put alert on. For issues, the alert is made on subscriptionid. create an alert and return the alertid (primary key) =cut sub addalert { my ( $borrowernumber, $type, $externalid ) = @_; my $dbh = C4::Context->dbh; my $sth = $dbh->prepare( "insert into alert (borrowernumber, type, externalid) values (?,?,?)"); $sth->execute( $borrowernumber, $type, $externalid ); # get the alert number newly created and return it my $alertid = $dbh->{'mysql_insertid'}; return $alertid; } =head2 delalert parameters : - alertid : the alert id deletes the alert =cut sub delalert { my ($alertid) = @_; #warn "ALERTID : $alertid"; my $dbh = C4::Context->dbh; my $sth = $dbh->prepare("delete from alert where alertid=?"); $sth->execute($alertid); } =head2 getalert parameters : - $borrowernumber : the number of the borrower subscribing to the alert - $type : the type of alert. - externalid : the primary key of the object to put alert on. For issues, the alert is made on subscriptionid. 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. =cut sub getalert { my ( $borrowernumber, $type, $externalid ) = @_; my $dbh = C4::Context->dbh; my $query = "SELECT * FROM alert WHERE"; my @bind; if ($borrowernumber =~ /^\d+$/) { $query .= " borrowernumber=? AND "; push @bind, $borrowernumber; } if ($type) { $query .= " type=? AND "; push @bind, $type; } if ($externalid) { $query .= " externalid=? AND "; push @bind, $externalid; } $query =~ s/ AND $//; my $sth = $dbh->prepare($query); $sth->execute(@bind); my @result; while ( my $line = $sth->fetchrow_hashref ) { push @result, $line; } return \@result; } =head2 findrelatedto parameters : - $type : the type of alert - $externalid : the id of the "object" to query 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. When type=issue, the id is related to a subscriptionid and this sub returns the name of the biblio. When type=virtual, the id is related to a virtual shelf and this sub returns the name of the sub =cut sub findrelatedto { my ( $type, $externalid ) = @_; my $dbh = C4::Context->dbh; my $sth; if ( $type eq 'issue' ) { $sth = $dbh->prepare( "select title as result from subscription left join biblio on subscription.biblionumber=biblio.biblionumber where subscriptionid=?" ); } if ( $type eq 'borrower' ) { $sth = $dbh->prepare( "select concat(firstname,' ',surname) from borrowers where borrowernumber=?" ); } $sth->execute($externalid); my ($result) = $sth->fetchrow; return $result; } =head2 SendAlerts parameters : - $type : the type of alert - $externalid : the id of the "object" to query - $letter : the letter to send. send an alert to all borrowers having put an alert on a given subject. =cut sub SendAlerts { my ( $type, $externalid, $letter ) = @_; my $dbh = C4::Context->dbh; if ( $type eq 'issue' ) { # warn "sending issues..."; my $letter = getletter( 'serial', $letter ); # prepare the letter... # search the biblionumber my $sth = $dbh->prepare( "SELECT biblionumber FROM subscription WHERE subscriptionid=?"); $sth->execute($externalid); my ($biblionumber) = $sth->fetchrow; # parsing branch info my $userenv = C4::Context->userenv; parseletter( $letter, 'branches', $userenv->{branch} ); # parsing librarian name $letter->{content} =~ s/<>/$userenv->{firstname}/g; $letter->{content} =~ s/<>/$userenv->{surname}/g; $letter->{content} =~ s/<>/$userenv->{emailaddress}/g; # parsing biblio information parseletter( $letter, 'biblio', $biblionumber ); parseletter( $letter, 'biblioitems', $biblionumber ); # find the list of borrowers to alert my $alerts = getalert( '', 'issue', $externalid ); foreach (@$alerts) { # and parse borrower ... my $innerletter = $letter; my $borinfo = GetMember( $_->{'borrowernumber'}, 'borrowernumber' ); parseletter( $innerletter, 'borrowers', $_->{'borrowernumber'} ); # ... then send mail if ( $borinfo->{email} ) { my %mail = ( To => $borinfo->{email}, From => $borinfo->{email}, Subject => "" . $innerletter->{title}, Message => "" . $innerletter->{content}, 'Content-Type' => 'text/plain; charset="utf8"', ); sendmail(%mail); # warn "sending to $mail{To} From $mail{From} subj $mail{Subject} Mess $mail{Message}"; } } } elsif ( $type eq 'claimacquisition' ) { # warn "sending issues..."; my $letter = getletter( 'claimacquisition', $letter ); # prepare the letter... # search the biblionumber my $strsth = "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 (" . join( ",", @$externalid ) . ")"; my $sthorders = $dbh->prepare($strsth); $sthorders->execute; my $dataorders = $sthorders->fetchall_arrayref( {} ); parseletter( $letter, 'aqbooksellers', $dataorders->[0]->{booksellerid} ); my $sthbookseller = $dbh->prepare("select * from aqbooksellers where id=?"); $sthbookseller->execute( $dataorders->[0]->{booksellerid} ); my $databookseller = $sthbookseller->fetchrow_hashref; # parsing branch info my $userenv = C4::Context->userenv; parseletter( $letter, 'branches', $userenv->{branch} ); # parsing librarian name $letter->{content} =~ s/<>/$userenv->{firstname}/g; $letter->{content} =~ s/<>/$userenv->{surname}/g; $letter->{content} =~ s/<>/$userenv->{emailaddress}/g; foreach my $data (@$dataorders) { my $line = $1 if ( $letter->{content} =~ m/(<<.*>>)/ ); foreach my $field ( keys %$data ) { $line =~ s/(<<[^\.]+.$field>>)/$data->{$field}/; } $letter->{content} =~ s/(<<.*>>)/$line\n$1/; } $letter->{content} =~ s/<<[^>]*>>//g; my $innerletter = $letter; # ... then send mail if ( $databookseller->{bookselleremail} || $databookseller->{contemail} ) { my %mail = ( To => $databookseller->{bookselleremail} . ( $databookseller->{contemail} ? "," . $databookseller->{contemail} : "" ), From => $userenv->{emailaddress}, Subject => "" . $innerletter->{title}, Message => "" . $innerletter->{content}, 'Content-Type' => 'text/plain; charset="utf8"', ); sendmail(%mail); warn "sending to $mail{To} From $mail{From} subj $mail{Subject} Mess $mail{Message}"; } if ( C4::Context->preference("LetterLog") ) { logaction( "ACQUISITION", "Send Acquisition claim letter", "", "order list : " . join( ",", @$externalid ) . "\n$innerletter->{title}\n$innerletter->{content}" ); } } elsif ( $type eq 'claimissues' ) { # warn "sending issues..."; my $letter = getletter( 'claimissues', $letter ); # prepare the letter... # search the biblionumber my $strsth = "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 (" . join( ",", @$externalid ) . ")"; my $sthorders = $dbh->prepare($strsth); $sthorders->execute; my $dataorders = $sthorders->fetchall_arrayref( {} ); parseletter( $letter, 'aqbooksellers', $dataorders->[0]->{aqbooksellerid} ); my $sthbookseller = $dbh->prepare("select * from aqbooksellers where id=?"); $sthbookseller->execute( $dataorders->[0]->{aqbooksellerid} ); my $databookseller = $sthbookseller->fetchrow_hashref; # parsing branch info my $userenv = C4::Context->userenv; parseletter( $letter, 'branches', $userenv->{branch} ); # parsing librarian name $letter->{content} =~ s/<>/$userenv->{firstname}/g; $letter->{content} =~ s/<>/$userenv->{surname}/g; $letter->{content} =~ s/<>/$userenv->{emailaddress}/g; foreach my $data (@$dataorders) { my $line = $1 if ( $letter->{content} =~ m/(<<.*>>)/ ); foreach my $field ( keys %$data ) { $line =~ s/(<<[^\.]+.$field>>)/$data->{$field}/; } $letter->{content} =~ s/(<<.*>>)/$line\n$1/; } $letter->{content} =~ s/<<[^>]*>>//g; my $innerletter = $letter; # ... then send mail if ( $databookseller->{bookselleremail} || $databookseller->{contemail} ) { my %mail = ( To => $databookseller->{bookselleremail} . ( $databookseller->{contemail} ? "," . $databookseller->{contemail} : "" ), From => $userenv->{emailaddress}, Subject => "" . $innerletter->{title}, Message => "" . $innerletter->{content}, 'Content-Type' => 'text/plain; charset="utf8"', ); sendmail(%mail); logaction( "ACQUISITION", "CLAIM ISSUE", undef, "To=" . $databookseller->{contemail} . " Title=" . $innerletter->{title} . " Content=" . $innerletter->{content} ) if C4::Context->preference("LetterLog"); } warn "sending to From $userenv->{emailaddress} subj $innerletter->{title} Mess $innerletter->{content}"; } # send an "account details" notice to a newly created user elsif ( $type eq 'members' ) { $letter->{content} =~ s/<>/$externalid->{'title'}/g; $letter->{content} =~ s/<>/$externalid->{'firstname'}/g; $letter->{content} =~ s/<>/$externalid->{'surname'}/g; $letter->{content} =~ s/<>/$externalid->{'userid'}/g; $letter->{content} =~ s/<>/$externalid->{'password'}/g; my %mail = ( To => $externalid->{'emailaddr'}, From => C4::Context->preference("KohaAdminEmailAddress"), Subject => $letter->{'title'}, Message => $letter->{'content'}, 'Content-Type' => 'text/plain; charset="utf8"', ); sendmail(%mail); } } =head2 parseletter parameters : - $letter : a hash to letter fields (title & content useful) - $table : the Koha table to parse. - $pk : the primary key to query on the $table table parse all fields from a table, and replace values in title & content with the appropriate value (not exported sub, used only internally) =cut sub parseletter { my ( $letter, $table, $pk, $pk2 ) = @_; # warn "Parseletter : ($letter,$table,$pk)"; my $dbh = C4::Context->dbh; my $sth; if ( $table eq 'biblio' ) { $sth = $dbh->prepare("select * from biblio where biblionumber=?"); } elsif ( $table eq 'biblioitems' ) { $sth = $dbh->prepare("select * from biblioitems where biblionumber=?"); } elsif ( $table eq 'items' ) { $sth = $dbh->prepare("select * from items where itemnumber=?"); } elsif ( $table eq 'reserves' ) { $sth = $dbh->prepare("select * from reserves where borrowernumber = ? and biblionumber=?"); } elsif ( $table eq 'borrowers' ) { $sth = $dbh->prepare("select * from borrowers where borrowernumber=?"); } elsif ( $table eq 'branches' ) { $sth = $dbh->prepare("select * from branches where branchcode=?"); } elsif ( $table eq 'aqbooksellers' ) { $sth = $dbh->prepare("select * from aqbooksellers where id=?"); } if ( $pk2 ) { $sth->execute($pk, $pk2); } else { $sth->execute($pk); } # store the result in an hash my $values = $sth->fetchrow_hashref; # and get all fields from the table $sth = $dbh->prepare("show columns from $table"); $sth->execute; while ( ( my $field ) = $sth->fetchrow_array ) { my $replacefield = "<<$table.$field>>"; my $replacedby = $values->{$field}; $letter->{title} =~ s/$replacefield/$replacedby/g; $letter->{content} =~ s/$replacefield/$replacedby/g; } } =head2 EnqueueLetter =over 4 my $success = EnqueueLetter( { letter => $letter, borrowernumber => '12', message_transport_type => 'email' } ) places a letter in the message_queue database table, which will eventually get processed (sent) by the process_message_queue.pl cronjob when it calls SendQueuedMessages. return true on success =back =cut sub EnqueueLetter { my $params = shift; return unless exists $params->{'letter'}; return unless exists $params->{'borrowernumber'}; return unless exists $params->{'message_transport_type'}; # If we have any attachments we should encode then into the body. if ( $params->{'attachments'} ) { $params->{'letter'} = _add_attachments( { letter => $params->{'letter'}, attachments => $params->{'attachments'}, message => MIME::Lite->new( Type => 'multipart/mixed' ), } ); } my $dbh = C4::Context->dbh(); my $statement = << 'ENDSQL'; INSERT INTO message_queue ( borrowernumber, subject, content, message_transport_type, status, time_queued, to_address, from_address, content_type ) VALUES ( ?, ?, ?, ?, ?, NOW(), ?, ?, ? ) ENDSQL my $sth = $dbh->prepare($statement); my $result = $sth->execute( $params->{'borrowernumber'}, # borrowernumber $params->{'letter'}->{'title'}, # subject $params->{'letter'}->{'content'}, # content $params->{'message_transport_type'}, # message_transport_type 'pending', # status $params->{'to_address'}, # to_address $params->{'from_address'}, # from_address $params->{'letter'}->{'content-type'}, # content_type ); return $result; } =head2 SendQueuedMessages =over 4 SendQueuedMessages() sends all of the 'pending' items in the message queue. my $sent = SendQueuedMessages( { verbose => 1 } ) returns number of messages sent. =back =cut sub SendQueuedMessages { my $params = shift; my $unsent_messages = _get_unsent_messages(); MESSAGE: foreach my $message ( @$unsent_messages ) { # warn Data::Dumper->Dump( [ $message ], [ 'message' ] ); warn sprintf( 'sending %s message to patron: %s', $message->{'message_transport_type'}, $message->{'borrowernumber'} || 'Admin' ) if $params->{'verbose'}; # This is just begging for subclassing next MESSAGE if ( lc( $message->{'message_transport_type'} eq 'rss' ) ); if ( lc( $message->{'message_transport_type'} ) eq 'email' ) { _send_message_by_email( $message ); } if ( lc( $message->{'message_transport_type'} ) eq 'sms' ) { _send_message_by_sms( $message ); } } return scalar( @$unsent_messages ); } =head2 GetRSSMessages =over 4 my $message_list = GetRSSMessages( { limit => 10, borrowernumber => '14' } ) returns a listref of all queued RSS messages for a particular person. =back =cut sub GetRSSMessages { my $params = shift; return unless $params; return unless ref $params; return unless $params->{'borrowernumber'}; return _get_unsent_messages( { message_transport_type => 'rss', limit => $params->{'limit'}, borrowernumber => $params->{'borrowernumber'}, } ); } =head2 GetQueuedMessages =over 4 my $messages = GetQueuedMessage( { borrowernumber => '123', limit => 20 } ); fetches messages out of the message queue. returns: list of hashes, each has represents a message in the message queue. =back =cut sub GetQueuedMessages { my $params = shift; my $dbh = C4::Context->dbh(); my $statement = << 'ENDSQL'; SELECT message_id, borrowernumber, subject, content, message_transport_type, status, time_queued FROM message_queue ENDSQL my @query_params; my @whereclauses; if ( exists $params->{'borrowernumber'} ) { push @whereclauses, ' borrowernumber = ? '; push @query_params, $params->{'borrowernumber'}; } if ( @whereclauses ) { $statement .= ' WHERE ' . join( 'AND', @whereclauses ); } if ( defined $params->{'limit'} ) { $statement .= ' LIMIT ? '; push @query_params, $params->{'limit'}; } my $sth = $dbh->prepare( $statement ); my $result = $sth->execute( @query_params ); my $messages = $sth->fetchall_arrayref({}); return $messages; } =head2 _add_attachements named parameters: letter - the standard letter hashref attachments - listref of attachments. each attachment is a hashref of: type - the mime type, like 'text/plain' content - the actual attachment filename - the name of the attachment. message - a MIME::Lite object to attach these to. returns your letter object, with the content updated. =cut sub _add_attachments { my $params = shift; return unless 'HASH' eq ref $params; foreach my $required_parameter (qw( letter attachments message )) { return unless exists $params->{$required_parameter}; } return $params->{'letter'} unless @{ $params->{'attachments'} }; # First, we have to put the body in as the first attachment $params->{'message'}->attach( Type => 'TEXT', Data => $params->{'letter'}->{'content'}, ); foreach my $attachment ( @{ $params->{'attachments'} } ) { $params->{'message'}->attach( Type => $attachment->{'type'}, Data => $attachment->{'content'}, Filename => $attachment->{'filename'}, ); } # we're forcing list context here to get the header, not the count back from grep. ( $params->{'letter'}->{'content-type'} ) = grep( /^Content-Type:/, split( /\n/, $params->{'message'}->header_as_string ) ); $params->{'letter'}->{'content-type'} =~ s/^Content-Type:\s+//; $params->{'letter'}->{'content'} = $params->{'message'}->body_as_string; return $params->{'letter'}; } sub _get_unsent_messages { my $params = shift; my $dbh = C4::Context->dbh(); my $statement = << 'ENDSQL'; SELECT message_id, borrowernumber, subject, content, message_transport_type, status, time_queued, from_address, to_address, content_type FROM message_queue WHERE status = 'pending' ENDSQL my @query_params; if ( ref $params ) { if ( $params->{'message_transport_type'} ) { $statement .= ' AND message_transport_type = ? '; push @query_params, $params->{'message_transport_type'}; } if ( $params->{'borrowernumber'} ) { $statement .= ' AND borrowernumber = ? '; push @query_params, $params->{'borrowernumber'}; } if ( $params->{'limit'} ) { $statement .= ' limit ? '; push @query_params, $params->{'limit'}; } } my $sth = $dbh->prepare( $statement ); my $result = $sth->execute( @query_params ); my $unsent_messages = $sth->fetchall_arrayref({}); return $unsent_messages; } sub _send_message_by_email { my $message = shift; my $member = C4::Members::GetMember( $message->{'borrowernumber'} ); return unless $message->{'to_address'} or $member->{'email'}; my $content = encode('utf8', $message->{'content'}); my %sendmail_params = ( To => $message->{'to_address'} || $member->{'email'}, From => $message->{'from_address'} || C4::Context->preference('KohaAdminEmailAddress'), Subject => $message->{'subject'}, charset => 'utf8', Message => $content, ); if ($message->{'content_type'}) { $sendmail_params{'content-type'} = $message->{'content_type'}; } my $success = sendmail( %sendmail_params ); if ( $success ) { # warn "OK. Log says:\n", $Mail::Sendmail::log; _set_message_status( { message_id => $message->{'message_id'}, status => 'sent' } ); return $success; } else { # warn $Mail::Sendmail::error; _set_message_status( { message_id => $message->{'message_id'}, status => 'failed' } ); return; } } sub _send_message_by_sms { my $message = shift; my $member = C4::Members::GetMember( $message->{'borrowernumber'} ); return unless $member->{'smsalertnumber'}; my $success = C4::SMS->send_sms( { destination => $member->{'smsalertnumber'}, message => $message->{'content'}, } ); if ( $success ) { _set_message_status( { message_id => $message->{'message_id'}, status => 'sent' } ); return $success; } else { _set_message_status( { message_id => $message->{'message_id'}, status => 'failed' } ); return; } } sub _set_message_status { my $params = shift; foreach my $required_parameter ( qw( message_id status ) ) { return unless exists $params->{ $required_parameter }; } my $dbh = C4::Context->dbh(); my $statement = 'UPDATE message_queue SET status= ? WHERE message_id = ?'; my $sth = $dbh->prepare( $statement ); my $result = $sth->execute( $params->{'status'}, $params->{'message_id'} ); return $result; } 1; __END__