# Suite 330, Boston, MA 02111-1307 USA
use strict;
+use MIME::Lite;
use Mail::Sendmail;
-# use C4::Date;
-# use Date::Manip;
-# use C4::Suggestions;
use C4::Members;
use C4::Log;
-require Exporter;
-
-our ( $VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS );
-
-# set the version for version checking
-$VERSION = 3.00;
+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
=cut
-@ISA = qw(Exporter);
-@EXPORT =
- qw(&GetLetters &getletter &addalert &getalert &delalert &findrelatedto &SendAlerts);
-
=head2 GetLetters
$letters = &getletters($category);
sub getalert {
my ( $borrowernumber, $type, $externalid ) = @_;
my $dbh = C4::Context->dbh;
- my $query = "select * from alert where";
+ my $query = "SELECT * FROM alert WHERE";
my @bind;
- if ($borrowernumber) {
- $query .= " borrowernumber=? and";
+ if ($borrowernumber =~ /^\d+$/) {
+ $query .= " borrowernumber=? AND ";
push @bind, $borrowernumber;
}
if ($type) {
- $query .= " type=? and";
+ $query .= " type=? AND ";
push @bind, $type;
}
if ($externalid) {
- $query .= " externalid=? and";
+ $query .= " externalid=? AND ";
push @bind, $externalid;
}
- $query =~ s/ and$//;
+ $query =~ s/ AND $//;
my $sth = $dbh->prepare($query);
$sth->execute(@bind);
my @result;
while ( my $line = $sth->fetchrow_hashref ) {
push @result, $line;
}
- return \@result if $#result >= 0; # return only if there is one result.
- return;
+ return \@result;
}
=head2 findrelatedto
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 {
# search the biblionumber
my $sth =
$dbh->prepare(
- "select biblionumber from subscription where subscriptionid=?");
+ "SELECT biblionumber FROM subscription WHERE subscriptionid=?");
$sth->execute($externalid);
my ($biblionumber) = $sth->fetchrow;
parseletter( $innerletter, 'borrowers', $_->{'borrowernumber'} );
# ... then send mail
- if ( $borinfo->{emailaddress} ) {
+ if ( $borinfo->{email} ) {
my %mail = (
- To => $borinfo->{emailaddress},
- From => $userenv->{emailaddress},
+ 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}";
}
if ( C4::Context->preference("LetterLog") ) {
logaction(
- $userenv->{number},
"ACQUISITION",
"Send Acquisition claim letter",
"",
From => $userenv->{emailaddress},
Subject => "" . $innerletter->{title},
Message => "" . $innerletter->{content},
+ 'Content-Type' => 'text/plain; charset="utf8"',
);
sendmail(%mail);
- &logaction(
- C4::Context->userenv->{'number'},
+ logaction(
"ACQUISITION",
"CLAIM ISSUE",
undef,
}
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/<<borrowers.title>>/$externalid->{'title'}/g;
+ $letter->{content} =~ s/<<borrowers.firstname>>/$externalid->{'firstname'}/g;
+ $letter->{content} =~ s/<<borrowers.surname>>/$externalid->{'surname'}/g;
+ $letter->{content} =~ s/<<borrowers.userid>>/$externalid->{'userid'}/g;
+ $letter->{content} =~ s/<<borrowers.password>>/$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);
}
}
}
}
-END { } # module clean-up code here (global destructor)
+=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'} );
+ 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__
projects / koha_fer / blobdiff