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
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
24 use Date::Calc qw( Add_Delta_Days );
28 use Module::Load::Conditional qw(can_load);
31 use C4::Members::Attributes qw(GetBorrowerAttributes);
36 use Koha::SMS::Providers;
39 use Koha::DateUtils qw( format_sqldatetime dt_from_string );
42 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
48 &GetLetters &GetLettersAvailableForALibrary &GetLetterTemplates &DelLetter &GetPreparedLetter &GetWrappedLetter &addalert &getalert &delalert &findrelatedto &SendAlerts &GetPrintMessages &GetMessageTransportTypes
54 C4::Letters - Give functions for Letters management
62 "Letters" is the tool used in Koha to manage informations sent to the patrons and/or the library. This include some cron jobs like
63 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)
65 Letters are managed through "alerts" sent by Koha on some events. All "alert" related functions are in this module too.
67 =head2 GetLetters([$module])
69 $letters = &GetLetters($module);
70 returns informations about letters.
71 if needed, $module filters for letters given module
77 my $module = $filters->{module};
78 my $code = $filters->{code};
79 my $branchcode = $filters->{branchcode};
80 my $dbh = C4::Context->dbh;
81 my $letters = $dbh->selectall_arrayref(
83 SELECT module, code, branchcode, name
87 . ( $module ? q| AND module = ?| : q|| )
88 . ( $code ? q| AND code = ?| : q|| )
89 . ( defined $branchcode ? q| AND branchcode = ?| : q|| )
90 . q| GROUP BY code ORDER BY name|, { Slice => {} }
91 , ( $module ? $module : () )
92 , ( $code ? $code : () )
93 , ( defined $branchcode ? $branchcode : () )
99 =head2 GetLetterTemplates
101 my $letter_templates = GetLetterTemplates(
103 module => 'circulation',
105 branchcode => 'CPL', # '' for default,
109 Return a hashref of letter templates.
113 sub GetLetterTemplates {
116 my $module = $params->{module};
117 my $code = $params->{code};
118 my $branchcode = $params->{branchcode} // '';
119 my $dbh = C4::Context->dbh;
120 my $letters = $dbh->selectall_arrayref(
122 SELECT module, code, branchcode, name, is_html, title, content, message_transport_type, lang
129 , $module, $code, $branchcode
135 =head2 GetLettersAvailableForALibrary
137 my $letters = GetLettersAvailableForALibrary(
139 branchcode => 'CPL', # '' for default
140 module => 'circulation',
144 Return an arrayref of letters, sorted by name.
145 If a specific letter exist for the given branchcode, it will be retrieve.
146 Otherwise the default letter will be.
150 sub GetLettersAvailableForALibrary {
152 my $branchcode = $filters->{branchcode};
153 my $module = $filters->{module};
155 croak "module should be provided" unless $module;
157 my $dbh = C4::Context->dbh;
158 my $default_letters = $dbh->selectall_arrayref(
160 SELECT module, code, branchcode, name
164 . q| AND branchcode = ''|
165 . ( $module ? q| AND module = ?| : q|| )
166 . q| ORDER BY name|, { Slice => {} }
167 , ( $module ? $module : () )
170 my $specific_letters;
172 $specific_letters = $dbh->selectall_arrayref(
174 SELECT module, code, branchcode, name
178 . q| AND branchcode = ?|
179 . ( $module ? q| AND module = ?| : q|| )
180 . q| ORDER BY name|, { Slice => {} }
182 , ( $module ? $module : () )
187 for my $l (@$default_letters) {
188 $letters{ $l->{code} } = $l;
190 for my $l (@$specific_letters) {
191 # Overwrite the default letter with the specific one.
192 $letters{ $l->{code} } = $l;
195 return [ map { $letters{$_} }
196 sort { $letters{$a}->{name} cmp $letters{$b}->{name} }
202 my ( $module, $code, $branchcode, $message_transport_type, $lang) = @_;
203 $message_transport_type //= '%';
204 $lang = 'default' unless( $lang && C4::Context->preference('TranslateNotices') );
207 my $only_my_library = C4::Context->only_my_library;
208 if ( $only_my_library and $branchcode ) {
209 $branchcode = C4::Context::mybranch();
213 my $dbh = C4::Context->dbh;
214 my $sth = $dbh->prepare(q{
217 WHERE module=? AND code=? AND (branchcode = ? OR branchcode = '')
218 AND message_transport_type LIKE ?
220 ORDER BY branchcode DESC LIMIT 1
222 $sth->execute( $module, $code, $branchcode, $message_transport_type, $lang );
223 my $line = $sth->fetchrow_hashref
225 $line->{'content-type'} = 'text/html; charset="UTF-8"' if $line->{is_html};
235 module => 'circulation',
241 Delete the letter. The mtt parameter is facultative.
242 If not given, all templates mathing the other parameters will be removed.
248 my $branchcode = $params->{branchcode};
249 my $module = $params->{module};
250 my $code = $params->{code};
251 my $mtt = $params->{mtt};
252 my $lang = $params->{lang};
253 my $dbh = C4::Context->dbh;
260 . ( $mtt ? q| AND message_transport_type = ?| : q|| )
261 . ( $lang? q| AND lang = ?| : q|| )
262 , undef, $branchcode, $module, $code, ( $mtt ? $mtt : () ), ( $lang ? $lang : () ) );
265 =head2 addalert ($borrowernumber, $type, $externalid)
268 - $borrowernumber : the number of the borrower subscribing to the alert
269 - $type : the type of alert.
270 - $externalid : the primary key of the object to put alert on. For issues, the alert is made on subscriptionid.
272 create an alert and return the alertid (primary key)
277 my ( $borrowernumber, $type, $externalid ) = @_;
278 my $dbh = C4::Context->dbh;
281 "insert into alert (borrowernumber, type, externalid) values (?,?,?)");
282 $sth->execute( $borrowernumber, $type, $externalid );
284 # get the alert number newly created and return it
285 my $alertid = $dbh->{'mysql_insertid'};
289 =head2 delalert ($alertid)
292 - alertid : the alert id
298 my $alertid = shift or die "delalert() called without valid argument (alertid)"; # it's gonna die anyway.
299 $debug and warn "delalert: deleting alertid $alertid";
300 my $sth = C4::Context->dbh->prepare("delete from alert where alertid=?");
301 $sth->execute($alertid);
304 =head2 getalert ([$borrowernumber], [$type], [$externalid])
307 - $borrowernumber : the number of the borrower subscribing to the alert
308 - $type : the type of alert.
309 - $externalid : the primary key of the object to put alert on. For issues, the alert is made on subscriptionid.
310 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.
315 my ( $borrowernumber, $type, $externalid ) = @_;
316 my $dbh = C4::Context->dbh;
317 my $query = "SELECT a.*, b.branchcode FROM alert a JOIN borrowers b USING(borrowernumber) WHERE 1";
319 if ($borrowernumber and $borrowernumber =~ /^\d+$/) {
320 $query .= " AND borrowernumber=?";
321 push @bind, $borrowernumber;
324 $query .= " AND type=?";
328 $query .= " AND externalid=?";
329 push @bind, $externalid;
331 my $sth = $dbh->prepare($query);
332 $sth->execute(@bind);
333 return $sth->fetchall_arrayref({});
336 =head2 findrelatedto($type, $externalid)
339 - $type : the type of alert
340 - $externalid : the id of the "object" to query
342 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.
343 When type=issue, the id is related to a subscriptionid and this sub returns the name of the biblio.
348 # When type=virtual, the id is related to a virtual shelf and this sub returns the name of the sub
351 my $type = shift or return;
352 my $externalid = shift or return;
353 my $q = ($type eq 'issue' ) ?
354 "select title as result from subscription left join biblio on subscription.biblionumber=biblio.biblionumber where subscriptionid=?" :
355 ($type eq 'borrower') ?
356 "select concat(firstname,' ',surname) from borrowers where borrowernumber=?" : undef;
358 warn "findrelatedto(): Illegal type '$type'";
361 my $sth = C4::Context->dbh->prepare($q);
362 $sth->execute($externalid);
363 my ($result) = $sth->fetchrow;
369 my $err = &SendAlerts($type, $externalid, $letter_code);
372 - $type : the type of alert
373 - $externalid : the id of the "object" to query
374 - $letter_code : the notice template to use
376 C<&SendAlerts> sends an email notice directly to a patron or a vendor.
378 Currently it supports ($type):
379 - claim serial issues (claimissues)
380 - claim acquisition orders (claimacquisition)
381 - send acquisition orders to the vendor (orderacquisition)
382 - notify patrons about newly received serial issues (issue)
383 - notify patrons when their account is created (members)
385 Returns undef or { error => 'message } on failure.
386 Returns true on success.
391 my ( $type, $externalid, $letter_code ) = @_;
392 my $dbh = C4::Context->dbh;
393 if ( $type eq 'issue' ) {
395 # prepare the letter...
396 # search the subscriptionid
399 "SELECT subscriptionid FROM serial WHERE serialid=?");
400 $sth->execute($externalid);
401 my ($subscriptionid) = $sth->fetchrow
402 or warn( "No subscription for '$externalid'" ),
405 # search the biblionumber
408 "SELECT biblionumber FROM subscription WHERE subscriptionid=?");
409 $sth->execute($subscriptionid);
410 my ($biblionumber) = $sth->fetchrow
411 or warn( "No biblionumber for '$subscriptionid'" ),
415 # find the list of borrowers to alert
416 my $alerts = getalert( '', 'issue', $subscriptionid );
418 my $patron = Koha::Patrons->find( $_->{borrowernumber} );
419 next unless $patron; # Just in case
420 my $email = $patron->email or next;
422 # warn "sending issues...";
423 my $userenv = C4::Context->userenv;
424 my $library = Koha::Libraries->find( $_->{branchcode} );
425 my $letter = GetPreparedLetter (
427 letter_code => $letter_code,
428 branchcode => $userenv->{branch},
430 'branches' => $_->{branchcode},
431 'biblio' => $biblionumber,
432 'biblioitems' => $biblionumber,
433 'borrowers' => $patron->unblessed,
434 'subscription' => $subscriptionid,
435 'serial' => $externalid,
441 my $message = Koha::Email->new();
442 my %mail = $message->create_message_headers(
445 from => $library->branchemail,
446 replyto => $library->branchreplyto,
447 sender => $library->branchreturnpath,
448 subject => Encode::encode( "UTF-8", "" . $letter->{title} ),
449 message => $letter->{'is_html'}
450 ? _wrap_html( Encode::encode( "UTF-8", $letter->{'content'} ),
451 Encode::encode( "UTF-8", "" . $letter->{'title'} ))
452 : Encode::encode( "UTF-8", "" . $letter->{'content'} ),
453 contenttype => $letter->{'is_html'}
454 ? 'text/html; charset="utf-8"'
455 : 'text/plain; charset="utf-8"',
458 unless( sendmail(%mail) ) {
459 carp $Mail::Sendmail::error;
460 return { error => $Mail::Sendmail::error };
464 elsif ( $type eq 'claimacquisition' or $type eq 'claimissues' or $type eq 'orderacquisition' ) {
466 # prepare the letter...
471 if ( $type eq 'claimacquisition') {
473 SELECT aqorders.*,aqbasket.*,biblio.*,biblioitems.*
475 LEFT JOIN aqbasket ON aqbasket.basketno=aqorders.basketno
476 LEFT JOIN biblio ON aqorders.biblionumber=biblio.biblionumber
477 LEFT JOIN biblioitems ON aqorders.biblionumber=biblioitems.biblionumber
478 WHERE aqorders.ordernumber IN (
482 carp "No order selected";
483 return { error => "no_order_selected" };
485 $strsth .= join( ",", ('?') x @$externalid ) . ")";
486 $action = "ACQUISITION CLAIM";
487 $sthorders = $dbh->prepare($strsth);
488 $sthorders->execute( @$externalid );
489 $dataorders = $sthorders->fetchall_arrayref( {} );
492 if ($type eq 'claimissues') {
494 SELECT serial.*,subscription.*, biblio.*, aqbooksellers.*,
495 aqbooksellers.id AS booksellerid
497 LEFT JOIN subscription ON serial.subscriptionid=subscription.subscriptionid
498 LEFT JOIN biblio ON serial.biblionumber=biblio.biblionumber
499 LEFT JOIN aqbooksellers ON subscription.aqbooksellerid=aqbooksellers.id
500 WHERE serial.serialid IN (
504 carp "No Order selected";
505 return { error => "no_order_selected" };
508 $strsth .= join( ",", ('?') x @$externalid ) . ")";
509 $action = "CLAIM ISSUE";
510 $sthorders = $dbh->prepare($strsth);
511 $sthorders->execute( @$externalid );
512 $dataorders = $sthorders->fetchall_arrayref( {} );
515 if ( $type eq 'orderacquisition') {
517 SELECT aqorders.*,aqbasket.*,biblio.*,biblioitems.*
519 LEFT JOIN aqbasket ON aqbasket.basketno=aqorders.basketno
520 LEFT JOIN biblio ON aqorders.biblionumber=biblio.biblionumber
521 LEFT JOIN biblioitems ON aqorders.biblionumber=biblioitems.biblionumber
522 WHERE aqbasket.basketno = ?
523 AND orderstatus IN ('new','ordered')
527 carp "No basketnumber given";
528 return { error => "no_basketno" };
530 $action = "ACQUISITION ORDER";
531 $sthorders = $dbh->prepare($strsth);
532 $sthorders->execute($externalid);
533 $dataorders = $sthorders->fetchall_arrayref( {} );
537 $dbh->prepare("select * from aqbooksellers where id=?");
538 $sthbookseller->execute( $dataorders->[0]->{booksellerid} );
539 my $databookseller = $sthbookseller->fetchrow_hashref;
541 my $addressee = $type eq 'claimacquisition' || $type eq 'orderacquisition' ? 'acqprimary' : 'serialsprimary';
544 $dbh->prepare("SELECT * FROM aqcontacts WHERE booksellerid=? AND $type=1 ORDER BY $addressee DESC");
545 $sthcontact->execute( $dataorders->[0]->{booksellerid} );
546 my $datacontact = $sthcontact->fetchrow_hashref;
550 push @email, $databookseller->{bookselleremail} if $databookseller->{bookselleremail};
551 push @email, $datacontact->{email} if ( $datacontact && $datacontact->{email} );
553 warn "Bookseller $dataorders->[0]->{booksellerid} without emails";
554 return { error => "no_email" };
557 while ($addlcontact = $sthcontact->fetchrow_hashref) {
558 push @cc, $addlcontact->{email} if ( $addlcontact && $addlcontact->{email} );
561 my $userenv = C4::Context->userenv;
562 my $letter = GetPreparedLetter (
564 letter_code => $letter_code,
565 branchcode => $userenv->{branch},
567 'branches' => $userenv->{branch},
568 'aqbooksellers' => $databookseller,
569 'aqcontacts' => $datacontact,
571 repeat => $dataorders,
573 ) or return { error => "no_letter" };
575 # Remove the order tag
576 $letter->{content} =~ s/<order>(.*?)<\/order>/$1/gxms;
579 my $library = Koha::Libraries->find( $userenv->{branch} );
581 To => join( ',', @email),
582 Cc => join( ',', @cc),
583 From => $library->branchemail || C4::Context->preference('KohaAdminEmailAddress'),
584 Subject => Encode::encode( "UTF-8", "" . $letter->{title} ),
585 Message => $letter->{'is_html'}
586 ? _wrap_html( Encode::encode( "UTF-8", $letter->{'content'} ),
587 Encode::encode( "UTF-8", "" . $letter->{'title'} ))
588 : Encode::encode( "UTF-8", "" . $letter->{'content'} ),
589 'Content-Type' => $letter->{'is_html'}
590 ? 'text/html; charset="utf-8"'
591 : 'text/plain; charset="utf-8"',
594 if ($type eq 'claimacquisition' || $type eq 'claimissues' ) {
595 $mail{'Reply-to'} = C4::Context->preference('ReplytoDefault')
596 if C4::Context->preference('ReplytoDefault');
597 $mail{'Sender'} = C4::Context->preference('ReturnpathDefault')
598 if C4::Context->preference('ReturnpathDefault');
599 $mail{'Bcc'} = $userenv->{emailaddress}
600 if C4::Context->preference("ClaimsBccCopy");
603 unless ( sendmail(%mail) ) {
604 carp $Mail::Sendmail::error;
605 return { error => $Mail::Sendmail::error };
613 . join( ',', @email )
618 ) if C4::Context->preference("LetterLog");
620 # send an "account details" notice to a newly created user
621 elsif ( $type eq 'members' ) {
622 my $library = Koha::Libraries->find( $externalid->{branchcode} )->unblessed;
623 my $letter = GetPreparedLetter (
625 letter_code => $letter_code,
626 branchcode => $externalid->{'branchcode'},
628 'branches' => $library,
629 'borrowers' => $externalid->{'borrowernumber'},
631 substitute => { 'borrowers.password' => $externalid->{'password'} },
634 return { error => "no_email" } unless $externalid->{'emailaddr'};
635 my $email = Koha::Email->new();
636 my %mail = $email->create_message_headers(
638 to => $externalid->{'emailaddr'},
639 from => $library->{branchemail},
640 replyto => $library->{branchreplyto},
641 sender => $library->{branchreturnpath},
642 subject => Encode::encode( "UTF-8", "" . $letter->{'title'} ),
643 message => $letter->{'is_html'}
644 ? _wrap_html( Encode::encode( "UTF-8", $letter->{'content'} ),
645 Encode::encode( "UTF-8", "" . $letter->{'title'} ) )
646 : Encode::encode( "UTF-8", "" . $letter->{'content'} ),
647 contenttype => $letter->{'is_html'}
648 ? 'text/html; charset="utf-8"'
649 : 'text/plain; charset="utf-8"',
652 unless( sendmail(%mail) ) {
653 carp $Mail::Sendmail::error;
654 return { error => $Mail::Sendmail::error };
658 # If we come here, return an OK status
662 =head2 GetPreparedLetter( %params )
665 module => letter module, mandatory
666 letter_code => letter code, mandatory
667 branchcode => for letter selection, if missing default system letter taken
668 tables => a hashref with table names as keys. Values are either:
669 - a scalar - primary key value
670 - an arrayref - primary key values
671 - a hashref - full record
672 substitute => custom substitution key/value pairs
673 repeat => records to be substituted on consecutive lines:
674 - an arrayref - tries to guess what needs substituting by
675 taking remaining << >> tokensr; not recommended
676 - a hashref token => @tables - replaces <token> << >> << >> </token>
677 subtemplate for each @tables row; table is a hashref as above
678 want_librarian => boolean, if set to true triggers librarian details
679 substitution from the userenv
681 letter fields hashref (title & content useful)
685 sub GetPreparedLetter {
688 my $module = $params{module} or croak "No module";
689 my $letter_code = $params{letter_code} or croak "No letter_code";
690 my $branchcode = $params{branchcode} || '';
691 my $mtt = $params{message_transport_type} || 'email';
692 my $lang = $params{lang} || 'default';
694 my $letter = getletter( $module, $letter_code, $branchcode, $mtt, $lang );
697 $letter = getletter( $module, $letter_code, $branchcode, $mtt, 'default' )
698 or warn( "No $module $letter_code letter transported by " . $mtt ),
702 my $tables = $params{tables} || {};
703 my $substitute = $params{substitute} || {};
704 my $loops = $params{loops} || {}; # loops is not supported for historical notices syntax
705 my $repeat = $params{repeat};
706 %$tables || %$substitute || $repeat || %$loops
707 or carp( "ERROR: nothing to substitute - both 'tables', 'loops' and 'substitute' are empty" ),
709 my $want_librarian = $params{want_librarian};
712 while ( my ($token, $val) = each %$substitute ) {
713 if ( $token eq 'items.content' ) {
714 $val =~ s|\n|<br/>|g if $letter->{is_html};
717 $letter->{title} =~ s/<<$token>>/$val/g;
718 $letter->{content} =~ s/<<$token>>/$val/g;
722 my $OPACBaseURL = C4::Context->preference('OPACBaseURL');
723 $letter->{content} =~ s/<<OPACBaseURL>>/$OPACBaseURL/go;
725 if ($want_librarian) {
726 # parsing librarian name
727 my $userenv = C4::Context->userenv;
728 $letter->{content} =~ s/<<LibrarianFirstname>>/$userenv->{firstname}/go;
729 $letter->{content} =~ s/<<LibrarianSurname>>/$userenv->{surname}/go;
730 $letter->{content} =~ s/<<LibrarianEmailaddress>>/$userenv->{emailaddress}/go;
733 my ($repeat_no_enclosing_tags, $repeat_enclosing_tags);
736 if (ref ($repeat) eq 'ARRAY' ) {
737 $repeat_no_enclosing_tags = $repeat;
739 $repeat_enclosing_tags = $repeat;
743 if ($repeat_enclosing_tags) {
744 while ( my ($tag, $tag_tables) = each %$repeat_enclosing_tags ) {
745 if ( $letter->{content} =~ m!<$tag>(.*)</$tag>!s ) {
748 my %subletter = ( title => '', content => $subcontent );
749 _substitute_tables( \%subletter, $_ );
752 $letter->{content} =~ s!<$tag>.*</$tag>!join( "\n", @lines )!se;
758 _substitute_tables( $letter, $tables );
761 if ($repeat_no_enclosing_tags) {
762 if ( $letter->{content} =~ m/[^\n]*<<.*>>[^\n]*/so ) {
767 $c =~ s/<<count>>/$i/go;
768 foreach my $field ( keys %{$_} ) {
769 $c =~ s/(<<[^\.]+.$field>>)/$_->{$field}/;
773 } @$repeat_no_enclosing_tags;
775 my $replaceby = join( "\n", @lines );
776 $letter->{content} =~ s/\Q$line\E/$replaceby/s;
780 $letter->{content} = _process_tt(
782 content => $letter->{content},
785 substitute => $substitute,
789 $letter->{content} =~ s/<<\S*>>//go; #remove any stragglers
794 sub _substitute_tables {
795 my ( $letter, $tables ) = @_;
796 while ( my ($table, $param) = each %$tables ) {
799 my $ref = ref $param;
802 if ($ref && $ref eq 'HASH') {
806 my $sth = _parseletter_sth($table);
808 warn "_parseletter_sth('$table') failed to return a valid sth. No substitution will be done for that table.";
811 $sth->execute( $ref ? @$param : $param );
813 $values = $sth->fetchrow_hashref;
817 _parseletter ( $letter, $table, $values );
821 sub _parseletter_sth {
825 carp "ERROR: _parseletter_sth() called without argument (table)";
828 # NOTE: we used to check whether we had a statement handle cached in
829 # a %handles module-level variable. This was a dumb move and
830 # broke things for the rest of us. prepare_cached is a better
831 # way to cache statement handles anyway.
833 ($table eq 'biblio' ) ? "SELECT * FROM $table WHERE biblionumber = ?" :
834 ($table eq 'biblioitems' ) ? "SELECT * FROM $table WHERE biblionumber = ?" :
835 ($table eq 'items' ) ? "SELECT * FROM $table WHERE itemnumber = ?" :
836 ($table eq 'issues' ) ? "SELECT * FROM $table WHERE itemnumber = ?" :
837 ($table eq 'old_issues' ) ? "SELECT * FROM $table WHERE itemnumber = ? ORDER BY timestamp DESC LIMIT 1" :
838 ($table eq 'reserves' ) ? "SELECT * FROM $table WHERE borrowernumber = ? and biblionumber = ?" :
839 ($table eq 'borrowers' ) ? "SELECT * FROM $table WHERE borrowernumber = ?" :
840 ($table eq 'branches' ) ? "SELECT * FROM $table WHERE branchcode = ?" :
841 ($table eq 'suggestions' ) ? "SELECT * FROM $table WHERE suggestionid = ?" :
842 ($table eq 'aqbooksellers') ? "SELECT * FROM $table WHERE id = ?" :
843 ($table eq 'aqorders' ) ? "SELECT * FROM $table WHERE ordernumber = ?" :
844 ($table eq 'opac_news' ) ? "SELECT * FROM $table WHERE idnew = ?" :
845 ($table eq 'article_requests') ? "SELECT * FROM $table WHERE id = ?" :
846 ($table eq 'borrower_modifications') ? "SELECT * FROM $table WHERE verification_token = ?" :
847 ($table eq 'subscription') ? "SELECT * FROM $table WHERE subscriptionid = ?" :
848 ($table eq 'serial') ? "SELECT * FROM $table WHERE serialid = ?" :
851 warn "ERROR: No _parseletter_sth query for table '$table'";
852 return; # nothing to get
854 unless ($sth = C4::Context->dbh->prepare_cached($query)) {
855 warn "ERROR: Failed to prepare query: '$query'";
858 return $sth; # now cache is populated for that $table
861 =head2 _parseletter($letter, $table, $values)
864 - $letter : a hash to letter fields (title & content useful)
865 - $table : the Koha table to parse.
866 - $values_in : table record hashref
867 parse all fields from a table, and replace values in title & content with the appropriate value
868 (not exported sub, used only internally)
873 my ( $letter, $table, $values_in ) = @_;
875 # Work on a local copy of $values_in (passed by reference) to avoid side effects
876 # in callers ( by changing / formatting values )
877 my $values = $values_in ? { %$values_in } : {};
879 if ( $table eq 'borrowers' && $values->{'dateexpiry'} ){
880 $values->{'dateexpiry'} = format_sqldatetime( $values->{'dateexpiry'} );
883 if ( $table eq 'reserves' && $values->{'waitingdate'} ) {
884 $values->{'waitingdate'} = output_pref({ dt => dt_from_string( $values->{'waitingdate'} ), dateonly => 1 });
887 if ($letter->{content} && $letter->{content} =~ /<<today>>/) {
888 my $todaysdate = output_pref( DateTime->now() );
889 $letter->{content} =~ s/<<today>>/$todaysdate/go;
892 while ( my ($field, $val) = each %$values ) {
893 $val =~ s/\p{P}$// if $val && $table=~/biblio/;
894 #BZ 9886: Assuming that we want to eliminate ISBD punctuation here
895 #Therefore adding the test on biblio. This includes biblioitems,
896 #but excludes items. Removed unneeded global and lookahead.
898 if ( $table=~/^borrowers$/ && $field=~/^streettype$/ ) {
899 my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $val });
900 $val = $av->count ? $av->next->lib : '';
904 my $replacedby = defined ($val) ? $val : '';
906 and not $replacedby =~ m|0000-00-00|
907 and not $replacedby =~ m|9999-12-31|
908 and $replacedby =~ m|^\d{4}-\d{2}-\d{2}( \d{2}:\d{2}:\d{2})?$| )
910 # If the value is XXXX-YY-ZZ[ AA:BB:CC] we assume it is a date
911 my $dateonly = defined $1 ? 0 : 1; #$1 refers to the capture group wrapped in parentheses. In this case, that's the hours, minutes, seconds.
912 my $re_dateonly_filter = qr{ $field( \s* \| \s* dateonly\s*)?>> }xms;
914 for my $letter_field ( qw( title content ) ) {
915 my $filter_string_used = q{};
916 if ( $letter->{ $letter_field } =~ $re_dateonly_filter ) {
917 # We overwrite $dateonly if the filter exists and we have a time in the datetime
918 $filter_string_used = $1 || q{};
919 $dateonly = $1 unless $dateonly;
921 my $replacedby_date = eval {
922 output_pref({ dt => dt_from_string( $replacedby ), dateonly => $dateonly });
925 if ( $letter->{ $letter_field } ) {
926 $letter->{ $letter_field } =~ s/\Q<<$table.$field$filter_string_used>>\E/$replacedby_date/g;
927 $letter->{ $letter_field } =~ s/\Q<<$field$filter_string_used>>\E/$replacedby_date/g;
931 # Other fields replacement
933 for my $letter_field ( qw( title content ) ) {
934 if ( $letter->{ $letter_field } ) {
935 $letter->{ $letter_field } =~ s/<<$table.$field>>/$replacedby/g;
936 $letter->{ $letter_field } =~ s/<<$field>>/$replacedby/g;
942 if ($table eq 'borrowers' && $letter->{content}) {
943 if ( my $attributes = GetBorrowerAttributes($values->{borrowernumber}) ) {
945 foreach (@$attributes) {
946 my $code = $_->{code};
947 my $val = $_->{value_description} || $_->{value};
948 $val =~ s/\p{P}(?=$)//g if $val;
949 next unless $val gt '';
951 push @{ $attr{$code} }, $val;
953 while ( my ($code, $val_ar) = each %attr ) {
954 my $replacefield = "<<borrower-attribute:$code>>";
955 my $replacedby = join ',', @$val_ar;
956 $letter->{content} =~ s/$replacefield/$replacedby/g;
965 my $success = EnqueueLetter( { letter => $letter,
966 borrowernumber => '12', message_transport_type => 'email' } )
968 places a letter in the message_queue database table, which will
969 eventually get processed (sent) by the process_message_queue.pl
970 cronjob when it calls SendQueuedMessages.
972 return message_id on success
977 my $params = shift or return;
979 return unless exists $params->{'letter'};
980 # return unless exists $params->{'borrowernumber'};
981 return unless exists $params->{'message_transport_type'};
983 my $content = $params->{letter}->{content};
984 $content =~ s/\s+//g if(defined $content);
985 if ( not defined $content or $content eq '' ) {
986 warn "Trying to add an empty message to the message queue" if $debug;
990 # If we have any attachments we should encode then into the body.
991 if ( $params->{'attachments'} ) {
992 $params->{'letter'} = _add_attachments(
993 { letter => $params->{'letter'},
994 attachments => $params->{'attachments'},
995 message => MIME::Lite->new( Type => 'multipart/mixed' ),
1000 my $dbh = C4::Context->dbh();
1001 my $statement = << 'ENDSQL';
1002 INSERT INTO message_queue
1003 ( borrowernumber, subject, content, metadata, letter_code, message_transport_type, status, time_queued, to_address, from_address, content_type )
1005 ( ?, ?, ?, ?, ?, ?, ?, NOW(), ?, ?, ? )
1008 my $sth = $dbh->prepare($statement);
1009 my $result = $sth->execute(
1010 $params->{'borrowernumber'}, # borrowernumber
1011 $params->{'letter'}->{'title'}, # subject
1012 $params->{'letter'}->{'content'}, # content
1013 $params->{'letter'}->{'metadata'} || '', # metadata
1014 $params->{'letter'}->{'code'} || '', # letter_code
1015 $params->{'message_transport_type'}, # message_transport_type
1017 $params->{'to_address'}, # to_address
1018 $params->{'from_address'}, # from_address
1019 $params->{'letter'}->{'content-type'}, # content_type
1021 return $dbh->last_insert_id(undef,undef,'message_queue', undef);
1024 =head2 SendQueuedMessages ([$hashref])
1026 my $sent = SendQueuedMessages( { verbose => 1 } );
1028 sends all of the 'pending' items in the message queue.
1030 returns number of messages sent.
1034 sub SendQueuedMessages {
1037 my $unsent_messages = _get_unsent_messages( { limit => $params->{limit} } );
1038 MESSAGE: foreach my $message ( @$unsent_messages ) {
1039 # warn Data::Dumper->Dump( [ $message ], [ 'message' ] );
1040 warn sprintf( 'sending %s message to patron: %s',
1041 $message->{'message_transport_type'},
1042 $message->{'borrowernumber'} || 'Admin' )
1043 if $params->{'verbose'} or $debug;
1044 # This is just begging for subclassing
1045 next MESSAGE if ( lc($message->{'message_transport_type'}) eq 'rss' );
1046 if ( lc( $message->{'message_transport_type'} ) eq 'email' ) {
1047 _send_message_by_email( $message, $params->{'username'}, $params->{'password'}, $params->{'method'} );
1049 elsif ( lc( $message->{'message_transport_type'} ) eq 'sms' ) {
1050 if ( C4::Context->preference('SMSSendDriver') eq 'Email' ) {
1051 my $patron = Koha::Patrons->find( $message->{borrowernumber} );
1052 my $sms_provider = Koha::SMS::Providers->find( $patron->sms_provider_id );
1053 unless ( $sms_provider ) {
1054 warn sprintf( "Patron %s has no sms provider id set!", $message->{'borrowernumber'} ) if $params->{'verbose'} or $debug;
1055 _set_message_status( { message_id => $message->{'message_id'}, status => 'failed' } );
1058 $message->{to_address} ||= $patron->smsalertnumber;
1059 unless ( $message->{to_address} && $patron->smsalertnumber ) {
1060 _set_message_status( { message_id => $message->{'message_id'}, status => 'failed' } );
1061 warn sprintf( "No smsalertnumber found for patron %s!", $message->{'borrowernumber'} ) if $params->{'verbose'} or $debug;
1064 $message->{to_address} .= '@' . $sms_provider->domain();
1065 _update_message_to_address($message->{'message_id'},$message->{to_address});
1066 _send_message_by_email( $message, $params->{'username'}, $params->{'password'}, $params->{'method'} );
1068 _send_message_by_sms( $message );
1072 return scalar( @$unsent_messages );
1075 =head2 GetRSSMessages
1077 my $message_list = GetRSSMessages( { limit => 10, borrowernumber => '14' } )
1079 returns a listref of all queued RSS messages for a particular person.
1083 sub GetRSSMessages {
1086 return unless $params;
1087 return unless ref $params;
1088 return unless $params->{'borrowernumber'};
1090 return _get_unsent_messages( { message_transport_type => 'rss',
1091 limit => $params->{'limit'},
1092 borrowernumber => $params->{'borrowernumber'}, } );
1095 =head2 GetPrintMessages
1097 my $message_list = GetPrintMessages( { borrowernumber => $borrowernumber } )
1099 Returns a arrayref of all queued print messages (optionally, for a particular
1104 sub GetPrintMessages {
1105 my $params = shift || {};
1107 return _get_unsent_messages( { message_transport_type => 'print',
1108 borrowernumber => $params->{'borrowernumber'},
1112 =head2 GetQueuedMessages ([$hashref])
1114 my $messages = GetQueuedMessage( { borrowernumber => '123', limit => 20 } );
1116 fetches messages out of the message queue.
1119 list of hashes, each has represents a message in the message queue.
1123 sub GetQueuedMessages {
1126 my $dbh = C4::Context->dbh();
1127 my $statement = << 'ENDSQL';
1128 SELECT message_id, borrowernumber, subject, content, message_transport_type, status, time_queued
1134 if ( exists $params->{'borrowernumber'} ) {
1135 push @whereclauses, ' borrowernumber = ? ';
1136 push @query_params, $params->{'borrowernumber'};
1139 if ( @whereclauses ) {
1140 $statement .= ' WHERE ' . join( 'AND', @whereclauses );
1143 if ( defined $params->{'limit'} ) {
1144 $statement .= ' LIMIT ? ';
1145 push @query_params, $params->{'limit'};
1148 my $sth = $dbh->prepare( $statement );
1149 my $result = $sth->execute( @query_params );
1150 return $sth->fetchall_arrayref({});
1153 =head2 GetMessageTransportTypes
1155 my @mtt = GetMessageTransportTypes();
1157 returns an arrayref of transport types
1161 sub GetMessageTransportTypes {
1162 my $dbh = C4::Context->dbh();
1163 my $mtts = $dbh->selectcol_arrayref("
1164 SELECT message_transport_type
1165 FROM message_transport_types
1166 ORDER BY message_transport_type
1173 my $message = C4::Letters::Message($message_id);
1178 my ( $message_id ) = @_;
1179 return unless $message_id;
1180 my $dbh = C4::Context->dbh;
1181 return $dbh->selectrow_hashref(q|
1182 SELECT message_id, borrowernumber, subject, content, metadata, letter_code, message_transport_type, status, time_queued, to_address, from_address, content_type
1184 WHERE message_id = ?
1185 |, {}, $message_id );
1188 =head2 ResendMessage
1190 Attempt to resend a message which has failed previously.
1192 my $has_been_resent = C4::Letters::ResendMessage($message_id);
1194 Updates the message to 'pending' status so that
1195 it will be resent later on.
1197 returns 1 on success, 0 on failure, undef if no message was found
1202 my $message_id = shift;
1203 return unless $message_id;
1205 my $message = GetMessage( $message_id );
1206 return unless $message;
1208 if ( $message->{status} ne 'pending' ) {
1209 $rv = C4::Letters::_set_message_status({
1210 message_id => $message_id,
1211 status => 'pending',
1213 $rv = $rv > 0? 1: 0;
1214 # Clear destination email address to force address update
1215 _update_message_to_address( $message_id, undef ) if $rv &&
1216 $message->{message_transport_type} eq 'email';
1221 =head2 _add_attachements
1224 letter - the standard letter hashref
1225 attachments - listref of attachments. each attachment is a hashref of:
1226 type - the mime type, like 'text/plain'
1227 content - the actual attachment
1228 filename - the name of the attachment.
1229 message - a MIME::Lite object to attach these to.
1231 returns your letter object, with the content updated.
1235 sub _add_attachments {
1238 my $letter = $params->{'letter'};
1239 my $attachments = $params->{'attachments'};
1240 return $letter unless @$attachments;
1241 my $message = $params->{'message'};
1243 # First, we have to put the body in as the first attachment
1245 Type => $letter->{'content-type'} || 'TEXT',
1246 Data => $letter->{'is_html'}
1247 ? _wrap_html($letter->{'content'}, $letter->{'title'})
1248 : $letter->{'content'},
1251 foreach my $attachment ( @$attachments ) {
1253 Type => $attachment->{'type'},
1254 Data => $attachment->{'content'},
1255 Filename => $attachment->{'filename'},
1258 # we're forcing list context here to get the header, not the count back from grep.
1259 ( $letter->{'content-type'} ) = grep( /^Content-Type:/, split( /\n/, $params->{'message'}->header_as_string ) );
1260 $letter->{'content-type'} =~ s/^Content-Type:\s+//;
1261 $letter->{'content'} = $message->body_as_string;
1267 sub _get_unsent_messages {
1270 my $dbh = C4::Context->dbh();
1272 SELECT mq.message_id, mq.borrowernumber, mq.subject, mq.content, mq.message_transport_type, mq.status, mq.time_queued, mq.from_address, mq.to_address, mq.content_type, b.branchcode, mq.letter_code
1273 FROM message_queue mq
1274 LEFT JOIN borrowers b ON b.borrowernumber = mq.borrowernumber
1278 my @query_params = ('pending');
1279 if ( ref $params ) {
1280 if ( $params->{'message_transport_type'} ) {
1281 $statement .= ' AND message_transport_type = ? ';
1282 push @query_params, $params->{'message_transport_type'};
1284 if ( $params->{'borrowernumber'} ) {
1285 $statement .= ' AND borrowernumber = ? ';
1286 push @query_params, $params->{'borrowernumber'};
1288 if ( $params->{'limit'} ) {
1289 $statement .= ' limit ? ';
1290 push @query_params, $params->{'limit'};
1294 $debug and warn "_get_unsent_messages SQL: $statement";
1295 $debug and warn "_get_unsent_messages params: " . join(',',@query_params);
1296 my $sth = $dbh->prepare( $statement );
1297 my $result = $sth->execute( @query_params );
1298 return $sth->fetchall_arrayref({});
1301 sub _send_message_by_email {
1302 my $message = shift or return;
1303 my ($username, $password, $method) = @_;
1305 my $patron = Koha::Patrons->find( $message->{borrowernumber} );
1306 my $to_address = $message->{'to_address'};
1307 unless ($to_address) {
1309 warn "FAIL: No 'to_address' and INVALID borrowernumber ($message->{borrowernumber})";
1310 _set_message_status( { message_id => $message->{'message_id'},
1311 status => 'failed' } );
1314 $to_address = C4::Members::GetNoticeEmailAddress( $message->{'borrowernumber'} );
1315 unless ($to_address) {
1316 # warn "FAIL: No 'to_address' and no email for " . ($member->{surname} ||'') . ", borrowernumber ($message->{borrowernumber})";
1317 # warning too verbose for this more common case?
1318 _set_message_status( { message_id => $message->{'message_id'},
1319 status => 'failed' } );
1324 my $utf8 = decode('MIME-Header', $message->{'subject'} );
1325 $message->{subject}= encode('MIME-Header', $utf8);
1326 my $subject = encode('UTF-8', $message->{'subject'});
1327 my $content = encode('UTF-8', $message->{'content'});
1328 my $content_type = $message->{'content_type'} || 'text/plain; charset="UTF-8"';
1329 my $is_html = $content_type =~ m/html/io;
1330 my $branch_email = undef;
1331 my $branch_replyto = undef;
1332 my $branch_returnpath = undef;
1334 my $library = $patron->library;
1335 $branch_email = $library->branchemail;
1336 $branch_replyto = $library->branchreplyto;
1337 $branch_returnpath = $library->branchreturnpath;
1339 my $email = Koha::Email->new();
1340 my %sendmail_params = $email->create_message_headers(
1343 from => $message->{'from_address'} || $branch_email,
1344 replyto => $branch_replyto,
1345 sender => $branch_returnpath,
1346 subject => $subject,
1347 message => $is_html ? _wrap_html( $content, $subject ) : $content,
1348 contenttype => $content_type
1352 $sendmail_params{'Auth'} = {user => $username, pass => $password, method => $method} if $username;
1353 if ( my $bcc = C4::Context->preference('NoticeBcc') ) {
1354 $sendmail_params{ Bcc } = $bcc;
1357 _update_message_to_address($message->{'message_id'},$to_address) unless $message->{to_address}; #if initial message address was empty, coming here means that a to address was found and queue should be updated
1359 if ( sendmail( %sendmail_params ) ) {
1360 _set_message_status( { message_id => $message->{'message_id'},
1361 status => 'sent' } );
1364 _set_message_status( { message_id => $message->{'message_id'},
1365 status => 'failed' } );
1366 carp $Mail::Sendmail::error;
1372 my ($content, $title) = @_;
1374 my $css = C4::Context->preference("NoticeCSS") || '';
1375 $css = qq{<link rel="stylesheet" type="text/css" href="$css">} if $css;
1377 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1378 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1379 <html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
1381 <title>$title</title>
1382 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1393 my ( $message ) = @_;
1394 my $dbh = C4::Context->dbh;
1395 my $count = $dbh->selectrow_array(q|
1398 WHERE message_transport_type = ?
1399 AND borrowernumber = ?
1401 AND CAST(time_queued AS date) = CAST(NOW() AS date)
1404 |, {}, $message->{message_transport_type}, $message->{borrowernumber}, $message->{letter_code}, $message->{content} );
1408 sub _send_message_by_sms {
1409 my $message = shift or return;
1410 my $patron = Koha::Patrons->find( $message->{borrowernumber} );
1412 unless ( $patron and $patron->smsalertnumber ) {
1413 _set_message_status( { message_id => $message->{'message_id'},
1414 status => 'failed' } );
1418 if ( _is_duplicate( $message ) ) {
1419 _set_message_status( { message_id => $message->{'message_id'},
1420 status => 'failed' } );
1424 my $success = C4::SMS->send_sms( { destination => $patron->smsalertnumber,
1425 message => $message->{'content'},
1427 _set_message_status( { message_id => $message->{'message_id'},
1428 status => ($success ? 'sent' : 'failed') } );
1432 sub _update_message_to_address {
1434 my $dbh = C4::Context->dbh();
1435 $dbh->do('UPDATE message_queue SET to_address=? WHERE message_id=?',undef,($to,$id));
1438 sub _set_message_status {
1439 my $params = shift or return;
1441 foreach my $required_parameter ( qw( message_id status ) ) {
1442 return unless exists $params->{ $required_parameter };
1445 my $dbh = C4::Context->dbh();
1446 my $statement = 'UPDATE message_queue SET status= ? WHERE message_id = ?';
1447 my $sth = $dbh->prepare( $statement );
1448 my $result = $sth->execute( $params->{'status'},
1449 $params->{'message_id'} );
1454 my ( $params ) = @_;
1456 my $content = $params->{content};
1457 my $tables = $params->{tables};
1458 my $loops = $params->{loops};
1459 my $substitute = $params->{substitute} || {};
1461 my $use_template_cache = C4::Context->config('template_cache_dir') && defined $ENV{GATEWAY_INTERFACE};
1462 my $template = Template->new(
1466 PLUGIN_BASE => 'Koha::Template::Plugin',
1467 COMPILE_EXT => $use_template_cache ? '.ttc' : '',
1468 COMPILE_DIR => $use_template_cache ? C4::Context->config('template_cache_dir') : '',
1470 ENCODING => 'UTF-8',
1472 ) or die Template->error();
1474 my $tt_params = { %{ _get_tt_params( $tables ) }, %{ _get_tt_params( $loops, 'is_a_loop' ) }, %$substitute };
1476 $content = qq|[% USE KohaDates %]$content|;
1479 $template->process( \$content, $tt_params, \$output ) || croak "ERROR PROCESSING TEMPLATE: " . $template->error();
1484 sub _get_tt_params {
1485 my ($tables, $is_a_loop) = @_;
1491 article_requests => {
1492 module => 'Koha::ArticleRequests',
1493 singular => 'article_request',
1494 plural => 'article_requests',
1498 module => 'Koha::Biblios',
1499 singular => 'biblio',
1500 plural => 'biblios',
1501 pk => 'biblionumber',
1504 module => 'Koha::Patrons',
1505 singular => 'borrower',
1506 plural => 'borrowers',
1507 pk => 'borrowernumber',
1510 module => 'Koha::Libraries',
1511 singular => 'branch',
1512 plural => 'branches',
1516 module => 'Koha::Items',
1522 module => 'Koha::News',
1528 module => 'Koha::Acquisition::Orders',
1529 singular => 'order',
1531 pk => 'ordernumber',
1534 module => 'Koha::Holds',
1537 fk => [ 'borrowernumber', 'biblionumber' ],
1540 module => 'Koha::Serials',
1541 singular => 'serial',
1542 plural => 'serials',
1546 module => 'Koha::Subscriptions',
1547 singular => 'subscription',
1548 plural => 'subscriptions',
1549 pk => 'subscriptionid',
1552 module => 'Koha::Suggestions',
1553 singular => 'suggestion',
1554 plural => 'suggestions',
1555 pk => 'suggestionid',
1558 module => 'Koha::Checkouts',
1559 singular => 'checkout',
1560 plural => 'checkouts',
1564 module => 'Koha::Old::Checkouts',
1565 singular => 'old_checkout',
1566 plural => 'old_checkouts',
1570 module => 'Koha::Checkouts',
1571 singular => 'overdue',
1572 plural => 'overdues',
1575 borrower_modifications => {
1576 module => 'Koha::Patron::Modifications',
1577 singular => 'patron_modification',
1578 plural => 'patron_modifications',
1579 fk => 'verification_token',
1583 foreach my $table ( keys %$tables ) {
1584 next unless $config->{$table};
1586 my $ref = ref( $tables->{$table} ) || q{};
1587 my $module = $config->{$table}->{module};
1589 if ( can_load( modules => { $module => undef } ) ) {
1590 my $pk = $config->{$table}->{pk};
1591 my $fk = $config->{$table}->{fk};
1594 my $values = $tables->{$table} || [];
1595 unless ( ref( $values ) eq 'ARRAY' ) {
1596 croak "ERROR processing table $table. Wrong API call.";
1598 my $key = $pk ? $pk : $fk;
1599 # $key does not come from user input
1600 my $objects = $module->search(
1601 { $key => $values },
1603 # We want to retrieve the data in the same order
1605 # field is a MySQLism, but they are no other way to do it
1606 # To be generic we could do it in perl, but we will need to fetch
1607 # all the data then order them
1608 @$values ? ( order_by => \[ "field($key, " . join( ', ', @$values ) . ")" ] ) : ()
1611 $params->{ $config->{$table}->{plural} } = $objects;
1613 elsif ( $ref eq q{} || $ref eq 'HASH' ) {
1614 my $id = ref $ref eq 'HASH' ? $tables->{$table}->{$pk} : $tables->{$table};
1616 if ( $fk ) { # Using a foreign key for lookup
1617 if ( ref( $fk ) eq 'ARRAY' ) { # Foreign key is multi-column
1619 foreach my $key ( @$fk ) {
1620 $search->{$key} = $id->{$key};
1622 $object = $module->search( $search )->last();
1623 } else { # Foreign key is single column
1624 $object = $module->search( { $fk => $id } )->last();
1626 } else { # using the table's primary key for lookup
1627 $object = $module->find($id);
1629 $params->{ $config->{$table}->{singular} } = $object;
1631 else { # $ref eq 'ARRAY'
1633 if ( @{ $tables->{$table} } == 1 ) { # Param is a single key
1634 $object = $module->search( { $pk => $tables->{$table} } )->last();
1636 else { # Params are mutliple foreign keys
1637 croak "Multiple foreign keys (table $table) should be passed using an hashref";
1639 $params->{ $config->{$table}->{singular} } = $object;
1643 croak "ERROR LOADING MODULE $module: $Module::Load::Conditional::ERROR";
1647 $params->{today} = output_pref({ dt => dt_from_string, dateformat => 'iso' });
1652 =head2 get_item_content
1654 my $item = Koha::Items->find(...)->unblessed;
1655 my @item_content_fields = qw( date_due title barcode author itemnumber );
1656 my $item_content = C4::Letters::get_item_content({
1658 item_content_fields => \@item_content_fields
1661 This function generates a tab-separated list of values for the passed item. Dates
1662 are formatted following the current setup.
1666 sub get_item_content {
1667 my ( $params ) = @_;
1668 my $item = $params->{item};
1669 my $dateonly = $params->{dateonly} || 0;
1670 my $item_content_fields = $params->{item_content_fields} || [];
1672 return unless $item;
1674 my @item_info = map {
1678 { dt => dt_from_string( $item->{$_} ), dateonly => $dateonly } );
1682 } @$item_content_fields;
1683 return join( "\t", @item_info ) . "\n";