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 );
41 use vars
qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
47 &GetLetters &GetLettersAvailableForALibrary &GetLetterTemplates &DelLetter &GetPreparedLetter &GetWrappedLetter &addalert &getalert &delalert &findrelatedto &SendAlerts &GetPrintMessages &GetMessageTransportTypes
53 C4::Letters - Give functions for Letters management
61 "Letters" is the tool used in Koha to manage informations sent to the patrons and/or the library. This include some cron jobs like
62 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)
64 Letters are managed through "alerts" sent by Koha on some events. All "alert" related functions are in this module too.
66 =head2 GetLetters([$module])
68 $letters = &GetLetters($module);
69 returns informations about letters.
70 if needed, $module filters for letters given module
76 my $module = $filters->{module
};
77 my $code = $filters->{code
};
78 my $branchcode = $filters->{branchcode
};
79 my $dbh = C4
::Context
->dbh;
80 my $letters = $dbh->selectall_arrayref(
82 SELECT module
, code
, branchcode
, name
86 . ( $module ? q
| AND module
= ?
| : q
|| )
87 . ( $code ? q
| AND code
= ?
| : q
|| )
88 . ( defined $branchcode ? q
| AND branchcode
= ?
| : q
|| )
89 . q
| GROUP BY code ORDER BY name
|, { Slice
=> {} }
90 , ( $module ?
$module : () )
91 , ( $code ?
$code : () )
92 , ( defined $branchcode ?
$branchcode : () )
98 =head2 GetLetterTemplates
100 my $letter_templates = GetLetterTemplates(
102 module => 'circulation',
104 branchcode => 'CPL', # '' for default,
108 Return a hashref of letter templates.
109 The key will be the message transport type.
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_hashref(
122 SELECT module
, code
, branchcode
, name
, is_html
, title
, content
, message_transport_type
128 , 'message_transport_type'
130 , $module, $code, $branchcode
136 =head2 GetLettersAvailableForALibrary
138 my $letters = GetLettersAvailableForALibrary(
140 branchcode => 'CPL', # '' for default
141 module => 'circulation',
145 Return an arrayref of letters, sorted by name.
146 If a specific letter exist for the given branchcode, it will be retrieve.
147 Otherwise the default letter will be.
151 sub GetLettersAvailableForALibrary
{
153 my $branchcode = $filters->{branchcode
};
154 my $module = $filters->{module
};
156 croak
"module should be provided" unless $module;
158 my $dbh = C4
::Context
->dbh;
159 my $default_letters = $dbh->selectall_arrayref(
161 SELECT module
, code
, branchcode
, name
165 . q
| AND branchcode
= ''|
166 . ( $module ? q
| AND module
= ?
| : q
|| )
167 . q
| ORDER BY name
|, { Slice
=> {} }
168 , ( $module ?
$module : () )
171 my $specific_letters;
173 $specific_letters = $dbh->selectall_arrayref(
175 SELECT module
, code
, branchcode
, name
179 . q
| AND branchcode
= ?
|
180 . ( $module ? q
| AND module
= ?
| : q
|| )
181 . q
| ORDER BY name
|, { Slice
=> {} }
183 , ( $module ?
$module : () )
188 for my $l (@
$default_letters) {
189 $letters{ $l->{code
} } = $l;
191 for my $l (@
$specific_letters) {
192 # Overwrite the default letter with the specific one.
193 $letters{ $l->{code
} } = $l;
196 return [ map { $letters{$_} }
197 sort { $letters{$a}->{name
} cmp $letters{$b}->{name
} }
203 my ( $module, $code, $branchcode, $message_transport_type ) = @_;
204 $message_transport_type //= '%';
206 if ( C4
::Context
->preference('IndependentBranches')
208 and C4
::Context
->userenv ) {
210 $branchcode = C4
::Context
->userenv->{'branch'};
214 my $dbh = C4
::Context
->dbh;
215 my $sth = $dbh->prepare(q{
218 WHERE module=? AND code=? AND (branchcode = ? OR branchcode = '')
219 AND message_transport_type LIKE ?
220 ORDER BY branchcode DESC LIMIT 1
222 $sth->execute( $module, $code, $branchcode, $message_transport_type );
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 $dbh = C4
::Context
->dbh;
258 | . ( $mtt ? q
| AND message_transport_type
= ?
| : q
|| )
259 , undef, $branchcode, $module, $code, ( $mtt ?
$mtt : () ) );
262 =head2 addalert ($borrowernumber, $type, $externalid)
265 - $borrowernumber : the number of the borrower subscribing to the alert
266 - $type : the type of alert.
267 - $externalid : the primary key of the object to put alert on. For issues, the alert is made on subscriptionid.
269 create an alert and return the alertid (primary key)
274 my ( $borrowernumber, $type, $externalid ) = @_;
275 my $dbh = C4
::Context
->dbh;
278 "insert into alert (borrowernumber, type, externalid) values (?,?,?)");
279 $sth->execute( $borrowernumber, $type, $externalid );
281 # get the alert number newly created and return it
282 my $alertid = $dbh->{'mysql_insertid'};
286 =head2 delalert ($alertid)
289 - alertid : the alert id
295 my $alertid = shift or die "delalert() called without valid argument (alertid)"; # it's gonna die anyway.
296 $debug and warn "delalert: deleting alertid $alertid";
297 my $sth = C4
::Context
->dbh->prepare("delete from alert where alertid=?");
298 $sth->execute($alertid);
301 =head2 getalert ([$borrowernumber], [$type], [$externalid])
304 - $borrowernumber : the number of the borrower subscribing to the alert
305 - $type : the type of alert.
306 - $externalid : the primary key of the object to put alert on. For issues, the alert is made on subscriptionid.
307 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.
312 my ( $borrowernumber, $type, $externalid ) = @_;
313 my $dbh = C4
::Context
->dbh;
314 my $query = "SELECT a.*, b.branchcode FROM alert a JOIN borrowers b USING(borrowernumber) WHERE 1";
316 if ($borrowernumber and $borrowernumber =~ /^\d+$/) {
317 $query .= " AND borrowernumber=?";
318 push @bind, $borrowernumber;
321 $query .= " AND type=?";
325 $query .= " AND externalid=?";
326 push @bind, $externalid;
328 my $sth = $dbh->prepare($query);
329 $sth->execute(@bind);
330 return $sth->fetchall_arrayref({});
333 =head2 findrelatedto($type, $externalid)
336 - $type : the type of alert
337 - $externalid : the id of the "object" to query
339 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.
340 When type=issue, the id is related to a subscriptionid and this sub returns the name of the biblio.
345 # When type=virtual, the id is related to a virtual shelf and this sub returns the name of the sub
348 my $type = shift or return;
349 my $externalid = shift or return;
350 my $q = ($type eq 'issue' ) ?
351 "select title as result from subscription left join biblio on subscription.biblionumber=biblio.biblionumber where subscriptionid=?" :
352 ($type eq 'borrower') ?
353 "select concat(firstname,' ',surname) from borrowers where borrowernumber=?" : undef;
355 warn "findrelatedto(): Illegal type '$type'";
358 my $sth = C4
::Context
->dbh->prepare($q);
359 $sth->execute($externalid);
360 my ($result) = $sth->fetchrow;
366 my $err = &SendAlerts($type, $externalid, $letter_code);
369 - $type : the type of alert
370 - $externalid : the id of the "object" to query
371 - $letter_code : the notice template to use
373 C<&SendAlerts> sends an email notice directly to a patron or a vendor.
375 Currently it supports ($type):
376 - claim serial issues (claimissues)
377 - claim acquisition orders (claimacquisition)
378 - send acquisition orders to the vendor (orderacquisition)
379 - notify patrons about newly received serial issues (issue)
380 - notify patrons when their account is created (members)
382 Returns undef or { error => 'message } on failure.
383 Returns true on success.
388 my ( $type, $externalid, $letter_code ) = @_;
389 my $dbh = C4
::Context
->dbh;
390 if ( $type eq 'issue' ) {
392 # prepare the letter...
393 # search the subscriptionid
396 "SELECT subscriptionid FROM serial WHERE serialid=?");
397 $sth->execute($externalid);
398 my ($subscriptionid) = $sth->fetchrow
399 or warn( "No subscription for '$externalid'" ),
402 # search the biblionumber
405 "SELECT biblionumber FROM subscription WHERE subscriptionid=?");
406 $sth->execute($subscriptionid);
407 my ($biblionumber) = $sth->fetchrow
408 or warn( "No biblionumber for '$subscriptionid'" ),
412 # find the list of borrowers to alert
413 my $alerts = getalert
( '', 'issue', $subscriptionid );
415 my $borinfo = C4
::Members
::GetMember
('borrowernumber' => $_->{'borrowernumber'});
416 my $email = $borinfo->{email
} or next;
418 # warn "sending issues...";
419 my $userenv = C4
::Context
->userenv;
420 my $library = Koha
::Libraries
->find( $_->{branchcode
} );
421 my $letter = GetPreparedLetter
(
423 letter_code
=> $letter_code,
424 branchcode
=> $userenv->{branch
},
426 'branches' => $_->{branchcode
},
427 'biblio' => $biblionumber,
428 'biblioitems' => $biblionumber,
429 'borrowers' => $borinfo,
430 'subscription' => $subscriptionid,
431 'serial' => $externalid,
437 my $message = Koha
::Email
->new();
438 my %mail = $message->create_message_headers(
441 from
=> $library->branchemail,
442 replyto
=> $library->branchreplyto,
443 sender
=> $library->branchreturnpath,
444 subject
=> Encode
::encode
( "UTF-8", "" . $letter->{title
} ),
445 message
=> $letter->{'is_html'}
446 ? _wrap_html
( Encode
::encode
( "UTF-8", $letter->{'content'} ),
447 Encode
::encode
( "UTF-8", "" . $letter->{'title'} ))
448 : Encode
::encode
( "UTF-8", "" . $letter->{'content'} ),
449 contenttype
=> $letter->{'is_html'}
450 ?
'text/html; charset="utf-8"'
451 : 'text/plain; charset="utf-8"',
454 unless( sendmail
(%mail) ) {
455 carp
$Mail::Sendmail
::error
;
456 return { error
=> $Mail::Sendmail
::error
};
460 elsif ( $type eq 'claimacquisition' or $type eq 'claimissues' or $type eq 'orderacquisition' ) {
462 # prepare the letter...
467 if ( $type eq 'claimacquisition') {
469 SELECT aqorders
.*,aqbasket
.*,biblio
.*,biblioitems
.*
471 LEFT JOIN aqbasket ON aqbasket
.basketno
=aqorders
.basketno
472 LEFT JOIN biblio ON aqorders
.biblionumber
=biblio
.biblionumber
473 LEFT JOIN biblioitems ON aqorders
.biblionumber
=biblioitems
.biblionumber
474 WHERE aqorders
.ordernumber IN
(
478 carp
"No order selected";
479 return { error
=> "no_order_selected" };
481 $strsth .= join( ",", ('?') x @
$externalid ) . ")";
482 $action = "ACQUISITION CLAIM";
483 $sthorders = $dbh->prepare($strsth);
484 $sthorders->execute( @
$externalid );
485 $dataorders = $sthorders->fetchall_arrayref( {} );
488 if ($type eq 'claimissues') {
490 SELECT serial
.*,subscription
.*, biblio
.*, aqbooksellers
.*,
491 aqbooksellers
.id AS booksellerid
493 LEFT JOIN subscription ON serial
.subscriptionid
=subscription
.subscriptionid
494 LEFT JOIN biblio ON serial
.biblionumber
=biblio
.biblionumber
495 LEFT JOIN aqbooksellers ON subscription
.aqbooksellerid
=aqbooksellers
.id
496 WHERE serial
.serialid IN
(
500 carp
"No Order selected";
501 return { error
=> "no_order_selected" };
504 $strsth .= join( ",", ('?') x @
$externalid ) . ")";
505 $action = "CLAIM ISSUE";
506 $sthorders = $dbh->prepare($strsth);
507 $sthorders->execute( @
$externalid );
508 $dataorders = $sthorders->fetchall_arrayref( {} );
511 if ( $type eq 'orderacquisition') {
513 SELECT aqorders
.*,aqbasket
.*,biblio
.*,biblioitems
.*
515 LEFT JOIN aqbasket ON aqbasket
.basketno
=aqorders
.basketno
516 LEFT JOIN biblio ON aqorders
.biblionumber
=biblio
.biblionumber
517 LEFT JOIN biblioitems ON aqorders
.biblionumber
=biblioitems
.biblionumber
518 WHERE aqbasket
.basketno
= ?
519 AND orderstatus IN
('new','ordered')
523 carp
"No basketnumber given";
524 return { error
=> "no_basketno" };
526 $action = "ACQUISITION ORDER";
527 $sthorders = $dbh->prepare($strsth);
528 $sthorders->execute($externalid);
529 $dataorders = $sthorders->fetchall_arrayref( {} );
533 $dbh->prepare("select * from aqbooksellers where id=?");
534 $sthbookseller->execute( $dataorders->[0]->{booksellerid
} );
535 my $databookseller = $sthbookseller->fetchrow_hashref;
537 my $addressee = $type eq 'claimacquisition' || $type eq 'orderacquisition' ?
'acqprimary' : 'serialsprimary';
540 $dbh->prepare("SELECT * FROM aqcontacts WHERE booksellerid=? AND $type=1 ORDER BY $addressee DESC");
541 $sthcontact->execute( $dataorders->[0]->{booksellerid
} );
542 my $datacontact = $sthcontact->fetchrow_hashref;
546 push @email, $databookseller->{bookselleremail
} if $databookseller->{bookselleremail
};
547 push @email, $datacontact->{email
} if ( $datacontact && $datacontact->{email
} );
549 warn "Bookseller $dataorders->[0]->{booksellerid} without emails";
550 return { error
=> "no_email" };
553 while ($addlcontact = $sthcontact->fetchrow_hashref) {
554 push @cc, $addlcontact->{email
} if ( $addlcontact && $addlcontact->{email
} );
557 my $userenv = C4
::Context
->userenv;
558 my $letter = GetPreparedLetter
(
560 letter_code
=> $letter_code,
561 branchcode
=> $userenv->{branch
},
563 'branches' => $userenv->{branch
},
564 'aqbooksellers' => $databookseller,
565 'aqcontacts' => $datacontact,
567 repeat
=> $dataorders,
569 ) or return { error
=> "no_letter" };
571 # Remove the order tag
572 $letter->{content
} =~ s/<order>(.*?)<\/order>/$1/gxms
;
575 my $library = Koha
::Libraries
->find( $userenv->{branch
} );
577 To
=> join( ',', @email),
578 Cc
=> join( ',', @cc),
579 From
=> $library->branchemail || C4
::Context
->preference('KohaAdminEmailAddress'),
580 Subject
=> Encode
::encode
( "UTF-8", "" . $letter->{title
} ),
581 Message
=> $letter->{'is_html'}
582 ? _wrap_html
( Encode
::encode
( "UTF-8", $letter->{'content'} ),
583 Encode
::encode
( "UTF-8", "" . $letter->{'title'} ))
584 : Encode
::encode
( "UTF-8", "" . $letter->{'content'} ),
585 'Content-Type' => $letter->{'is_html'}
586 ?
'text/html; charset="utf-8"'
587 : 'text/plain; charset="utf-8"',
590 if ($type eq 'claimacquisition' || $type eq 'claimissues' ) {
591 $mail{'Reply-to'} = C4
::Context
->preference('ReplytoDefault')
592 if C4
::Context
->preference('ReplytoDefault');
593 $mail{'Sender'} = C4
::Context
->preference('ReturnpathDefault')
594 if C4
::Context
->preference('ReturnpathDefault');
595 $mail{'Bcc'} = $userenv->{emailaddress
}
596 if C4
::Context
->preference("ClaimsBccCopy");
599 unless ( sendmail
(%mail) ) {
600 carp
$Mail::Sendmail
::error
;
601 return { error
=> $Mail::Sendmail
::error
};
609 . join( ',', @email )
614 ) if C4
::Context
->preference("LetterLog");
616 # send an "account details" notice to a newly created user
617 elsif ( $type eq 'members' ) {
618 my $library = Koha
::Libraries
->find( $externalid->{branchcode
} )->unblessed;
619 my $letter = GetPreparedLetter
(
621 letter_code
=> $letter_code,
622 branchcode
=> $externalid->{'branchcode'},
624 'branches' => $library,
625 'borrowers' => $externalid->{'borrowernumber'},
627 substitute
=> { 'borrowers.password' => $externalid->{'password'} },
630 return { error
=> "no_email" } unless $externalid->{'emailaddr'};
631 my $email = Koha
::Email
->new();
632 my %mail = $email->create_message_headers(
634 to
=> $externalid->{'emailaddr'},
635 from
=> $library->{branchemail
},
636 replyto
=> $library->{branchreplyto
},
637 sender
=> $library->{branchreturnpath
},
638 subject
=> Encode
::encode
( "UTF-8", "" . $letter->{'title'} ),
639 message
=> $letter->{'is_html'}
640 ? _wrap_html
( Encode
::encode
( "UTF-8", $letter->{'content'} ),
641 Encode
::encode
( "UTF-8", "" . $letter->{'title'} ) )
642 : Encode
::encode
( "UTF-8", "" . $letter->{'content'} ),
643 contenttype
=> $letter->{'is_html'}
644 ?
'text/html; charset="utf-8"'
645 : 'text/plain; charset="utf-8"',
648 unless( sendmail
(%mail) ) {
649 carp
$Mail::Sendmail
::error
;
650 return { error
=> $Mail::Sendmail
::error
};
654 # If we come here, return an OK status
658 =head2 GetPreparedLetter( %params )
661 module => letter module, mandatory
662 letter_code => letter code, mandatory
663 branchcode => for letter selection, if missing default system letter taken
664 tables => a hashref with table names as keys. Values are either:
665 - a scalar - primary key value
666 - an arrayref - primary key values
667 - a hashref - full record
668 substitute => custom substitution key/value pairs
669 repeat => records to be substituted on consecutive lines:
670 - an arrayref - tries to guess what needs substituting by
671 taking remaining << >> tokensr; not recommended
672 - a hashref token => @tables - replaces <token> << >> << >> </token>
673 subtemplate for each @tables row; table is a hashref as above
674 want_librarian => boolean, if set to true triggers librarian details
675 substitution from the userenv
677 letter fields hashref (title & content useful)
681 sub GetPreparedLetter
{
684 my $module = $params{module
} or croak
"No module";
685 my $letter_code = $params{letter_code
} or croak
"No letter_code";
686 my $branchcode = $params{branchcode
} || '';
687 my $mtt = $params{message_transport_type
} || 'email';
689 my $letter = getletter
( $module, $letter_code, $branchcode, $mtt )
690 or warn( "No $module $letter_code letter transported by " . $mtt ),
693 my $tables = $params{tables
} || {};
694 my $substitute = $params{substitute
} || {};
695 my $loops = $params{loops
} || {}; # loops is not supported for historical notices syntax
696 my $repeat = $params{repeat
};
697 %$tables || %$substitute || $repeat || %$loops
698 or carp
( "ERROR: nothing to substitute - both 'tables', 'loops' and 'substitute' are empty" ),
700 my $want_librarian = $params{want_librarian
};
703 while ( my ($token, $val) = each %$substitute ) {
704 if ( $token eq 'items.content' ) {
705 $val =~ s
|\n|<br
/>|g
if $letter->{is_html
};
708 $letter->{title
} =~ s/<<$token>>/$val/g;
709 $letter->{content
} =~ s/<<$token>>/$val/g;
713 my $OPACBaseURL = C4
::Context
->preference('OPACBaseURL');
714 $letter->{content
} =~ s/<<OPACBaseURL>>/$OPACBaseURL/go;
716 if ($want_librarian) {
717 # parsing librarian name
718 my $userenv = C4
::Context
->userenv;
719 $letter->{content
} =~ s/<<LibrarianFirstname>>/$userenv->{firstname}/go;
720 $letter->{content
} =~ s/<<LibrarianSurname>>/$userenv->{surname}/go;
721 $letter->{content
} =~ s/<<LibrarianEmailaddress>>/$userenv->{emailaddress}/go;
724 my ($repeat_no_enclosing_tags, $repeat_enclosing_tags);
727 if (ref ($repeat) eq 'ARRAY' ) {
728 $repeat_no_enclosing_tags = $repeat;
730 $repeat_enclosing_tags = $repeat;
734 if ($repeat_enclosing_tags) {
735 while ( my ($tag, $tag_tables) = each %$repeat_enclosing_tags ) {
736 if ( $letter->{content
} =~ m!<$tag>(.*)</$tag>!s ) {
739 my %subletter = ( title
=> '', content
=> $subcontent );
740 _substitute_tables
( \
%subletter, $_ );
743 $letter->{content
} =~ s!<$tag>.*</$tag>!join( "\n", @lines )!se;
749 _substitute_tables
( $letter, $tables );
752 if ($repeat_no_enclosing_tags) {
753 if ( $letter->{content
} =~ m/[^\n]*<<.*>>[^\n]*/so ) {
758 $c =~ s/<<count>>/$i/go;
759 foreach my $field ( keys %{$_} ) {
760 $c =~ s/(<<[^\.]+.$field>>)/$_->{$field}/;
764 } @
$repeat_no_enclosing_tags;
766 my $replaceby = join( "\n", @lines );
767 $letter->{content
} =~ s/\Q$line\E/$replaceby/s;
771 $letter->{content
} = _process_tt
(
773 content
=> $letter->{content
},
779 $letter->{content
} =~ s/<<\S*>>//go; #remove any stragglers
784 sub _substitute_tables
{
785 my ( $letter, $tables ) = @_;
786 while ( my ($table, $param) = each %$tables ) {
789 my $ref = ref $param;
792 if ($ref && $ref eq 'HASH') {
796 my $sth = _parseletter_sth
($table);
798 warn "_parseletter_sth('$table') failed to return a valid sth. No substitution will be done for that table.";
801 $sth->execute( $ref ? @
$param : $param );
803 $values = $sth->fetchrow_hashref;
807 _parseletter
( $letter, $table, $values );
811 sub _parseletter_sth
{
815 carp
"ERROR: _parseletter_sth() called without argument (table)";
818 # NOTE: we used to check whether we had a statement handle cached in
819 # a %handles module-level variable. This was a dumb move and
820 # broke things for the rest of us. prepare_cached is a better
821 # way to cache statement handles anyway.
823 ($table eq 'biblio' ) ?
"SELECT * FROM $table WHERE biblionumber = ?" :
824 ($table eq 'biblioitems' ) ?
"SELECT * FROM $table WHERE biblionumber = ?" :
825 ($table eq 'items' ) ?
"SELECT * FROM $table WHERE itemnumber = ?" :
826 ($table eq 'issues' ) ?
"SELECT * FROM $table WHERE itemnumber = ?" :
827 ($table eq 'old_issues' ) ?
"SELECT * FROM $table WHERE itemnumber = ? ORDER BY timestamp DESC LIMIT 1" :
828 ($table eq 'reserves' ) ?
"SELECT * FROM $table WHERE borrowernumber = ? and biblionumber = ?" :
829 ($table eq 'borrowers' ) ?
"SELECT * FROM $table WHERE borrowernumber = ?" :
830 ($table eq 'branches' ) ?
"SELECT * FROM $table WHERE branchcode = ?" :
831 ($table eq 'suggestions' ) ?
"SELECT * FROM $table WHERE suggestionid = ?" :
832 ($table eq 'aqbooksellers') ?
"SELECT * FROM $table WHERE id = ?" :
833 ($table eq 'aqorders' ) ?
"SELECT * FROM $table WHERE ordernumber = ?" :
834 ($table eq 'opac_news' ) ?
"SELECT * FROM $table WHERE idnew = ?" :
835 ($table eq 'article_requests') ?
"SELECT * FROM $table WHERE id = ?" :
836 ($table eq 'borrower_modifications') ?
"SELECT * FROM $table WHERE verification_token = ?" :
837 ($table eq 'subscription') ?
"SELECT * FROM $table WHERE subscriptionid = ?" :
838 ($table eq 'serial') ?
"SELECT * FROM $table WHERE serialid = ?" :
841 warn "ERROR: No _parseletter_sth query for table '$table'";
842 return; # nothing to get
844 unless ($sth = C4
::Context
->dbh->prepare_cached($query)) {
845 warn "ERROR: Failed to prepare query: '$query'";
848 return $sth; # now cache is populated for that $table
851 =head2 _parseletter($letter, $table, $values)
854 - $letter : a hash to letter fields (title & content useful)
855 - $table : the Koha table to parse.
856 - $values_in : table record hashref
857 parse all fields from a table, and replace values in title & content with the appropriate value
858 (not exported sub, used only internally)
863 my ( $letter, $table, $values_in ) = @_;
865 # Work on a local copy of $values_in (passed by reference) to avoid side effects
866 # in callers ( by changing / formatting values )
867 my $values = $values_in ?
{ %$values_in } : {};
869 if ( $table eq 'borrowers' && $values->{'dateexpiry'} ){
870 $values->{'dateexpiry'} = format_sqldatetime
( $values->{'dateexpiry'} );
873 if ( $table eq 'reserves' && $values->{'waitingdate'} ) {
874 $values->{'waitingdate'} = output_pref
({ dt
=> dt_from_string
( $values->{'waitingdate'} ), dateonly
=> 1 });
877 if ($letter->{content
} && $letter->{content
} =~ /<<today>>/) {
878 my $todaysdate = output_pref
( DateTime
->now() );
879 $letter->{content
} =~ s/<<today>>/$todaysdate/go;
882 while ( my ($field, $val) = each %$values ) {
883 $val =~ s/\p{P}$// if $val && $table=~/biblio/;
884 #BZ 9886: Assuming that we want to eliminate ISBD punctuation here
885 #Therefore adding the test on biblio. This includes biblioitems,
886 #but excludes items. Removed unneeded global and lookahead.
888 if ( $table=~/^borrowers$/ && $field=~/^streettype$/ ) {
889 my $av = Koha
::AuthorisedValues
->search({ category
=> 'ROADTYPE', authorised_value
=> $val });
890 $val = $av->count ?
$av->next->lib : '';
894 my $replacedby = defined ($val) ?
$val : '';
896 and not $replacedby =~ m
|0000-00-00|
897 and not $replacedby =~ m
|9999-12-31|
898 and $replacedby =~ m
|^\d
{4}-\d
{2}-\d
{2}( \d
{2}:\d
{2}:\d
{2})?
$| )
900 # If the value is XXXX-YY-ZZ[ AA:BB:CC] we assume it is a date
901 my $dateonly = defined $1 ?
0 : 1; #$1 refers to the capture group wrapped in parentheses. In this case, that's the hours, minutes, seconds.
902 my $re_dateonly_filter = qr{ $field( \s* \| \s* dateonly\s*)?>> }xms;
904 for my $letter_field ( qw( title content ) ) {
905 my $filter_string_used = q{};
906 if ( $letter->{ $letter_field } =~ $re_dateonly_filter ) {
907 # We overwrite $dateonly if the filter exists and we have a time in the datetime
908 $filter_string_used = $1 || q{};
909 $dateonly = $1 unless $dateonly;
911 my $replacedby_date = eval {
912 output_pref
({ dt
=> dt_from_string
( $replacedby ), dateonly
=> $dateonly });
915 if ( $letter->{ $letter_field } ) {
916 $letter->{ $letter_field } =~ s/\Q<<$table.$field$filter_string_used>>\E/$replacedby_date/g;
917 $letter->{ $letter_field } =~ s/\Q<<$field$filter_string_used>>\E/$replacedby_date/g;
921 # Other fields replacement
923 for my $letter_field ( qw( title content ) ) {
924 if ( $letter->{ $letter_field } ) {
925 $letter->{ $letter_field } =~ s/<<$table.$field>>/$replacedby/g;
926 $letter->{ $letter_field } =~ s/<<$field>>/$replacedby/g;
932 if ($table eq 'borrowers' && $letter->{content
}) {
933 if ( my $attributes = GetBorrowerAttributes
($values->{borrowernumber
}) ) {
935 foreach (@
$attributes) {
936 my $code = $_->{code
};
937 my $val = $_->{value_description
} || $_->{value
};
938 $val =~ s/\p{P}(?=$)//g if $val;
939 next unless $val gt '';
941 push @
{ $attr{$code} }, $val;
943 while ( my ($code, $val_ar) = each %attr ) {
944 my $replacefield = "<<borrower-attribute:$code>>";
945 my $replacedby = join ',', @
$val_ar;
946 $letter->{content
} =~ s/$replacefield/$replacedby/g;
955 my $success = EnqueueLetter( { letter => $letter,
956 borrowernumber => '12', message_transport_type => 'email' } )
958 places a letter in the message_queue database table, which will
959 eventually get processed (sent) by the process_message_queue.pl
960 cronjob when it calls SendQueuedMessages.
962 return message_id on success
967 my $params = shift or return;
969 return unless exists $params->{'letter'};
970 # return unless exists $params->{'borrowernumber'};
971 return unless exists $params->{'message_transport_type'};
973 my $content = $params->{letter
}->{content
};
974 $content =~ s/\s+//g if(defined $content);
975 if ( not defined $content or $content eq '' ) {
976 warn "Trying to add an empty message to the message queue" if $debug;
980 # If we have any attachments we should encode then into the body.
981 if ( $params->{'attachments'} ) {
982 $params->{'letter'} = _add_attachments
(
983 { letter
=> $params->{'letter'},
984 attachments
=> $params->{'attachments'},
985 message
=> MIME
::Lite
->new( Type
=> 'multipart/mixed' ),
990 my $dbh = C4
::Context
->dbh();
991 my $statement = << 'ENDSQL';
992 INSERT INTO message_queue
993 ( borrowernumber
, subject
, content
, metadata
, letter_code
, message_transport_type
, status
, time_queued
, to_address
, from_address
, content_type
)
995 ( ?
, ?
, ?
, ?
, ?
, ?
, ?
, NOW
(), ?
, ?
, ?
)
998 my $sth = $dbh->prepare($statement);
999 my $result = $sth->execute(
1000 $params->{'borrowernumber'}, # borrowernumber
1001 $params->{'letter'}->{'title'}, # subject
1002 $params->{'letter'}->{'content'}, # content
1003 $params->{'letter'}->{'metadata'} || '', # metadata
1004 $params->{'letter'}->{'code'} || '', # letter_code
1005 $params->{'message_transport_type'}, # message_transport_type
1007 $params->{'to_address'}, # to_address
1008 $params->{'from_address'}, # from_address
1009 $params->{'letter'}->{'content-type'}, # content_type
1011 return $dbh->last_insert_id(undef,undef,'message_queue', undef);
1014 =head2 SendQueuedMessages ([$hashref])
1016 my $sent = SendQueuedMessages( { verbose => 1 } );
1018 sends all of the 'pending' items in the message queue.
1020 returns number of messages sent.
1024 sub SendQueuedMessages
{
1027 my $unsent_messages = _get_unsent_messages
();
1028 MESSAGE
: foreach my $message ( @
$unsent_messages ) {
1029 # warn Data::Dumper->Dump( [ $message ], [ 'message' ] );
1030 warn sprintf( 'sending %s message to patron: %s',
1031 $message->{'message_transport_type'},
1032 $message->{'borrowernumber'} || 'Admin' )
1033 if $params->{'verbose'} or $debug;
1034 # This is just begging for subclassing
1035 next MESSAGE
if ( lc($message->{'message_transport_type'}) eq 'rss' );
1036 if ( lc( $message->{'message_transport_type'} ) eq 'email' ) {
1037 _send_message_by_email
( $message, $params->{'username'}, $params->{'password'}, $params->{'method'} );
1039 elsif ( lc( $message->{'message_transport_type'} ) eq 'sms' ) {
1040 if ( C4
::Context
->preference('SMSSendDriver') eq 'Email' ) {
1041 my $member = C4
::Members
::GetMember
( 'borrowernumber' => $message->{'borrowernumber'} );
1042 my $sms_provider = Koha
::SMS
::Providers
->find( $member->{'sms_provider_id'} );
1043 unless ( $sms_provider ) {
1044 warn sprintf( "Patron %s has no sms provider id set!", $message->{'borrowernumber'} ) if $params->{'verbose'} or $debug;
1047 $message->{to_address
} .= '@' . $sms_provider->domain();
1048 _send_message_by_email
( $message, $params->{'username'}, $params->{'password'}, $params->{'method'} );
1050 _send_message_by_sms
( $message );
1054 return scalar( @
$unsent_messages );
1057 =head2 GetRSSMessages
1059 my $message_list = GetRSSMessages( { limit => 10, borrowernumber => '14' } )
1061 returns a listref of all queued RSS messages for a particular person.
1065 sub GetRSSMessages
{
1068 return unless $params;
1069 return unless ref $params;
1070 return unless $params->{'borrowernumber'};
1072 return _get_unsent_messages
( { message_transport_type
=> 'rss',
1073 limit
=> $params->{'limit'},
1074 borrowernumber
=> $params->{'borrowernumber'}, } );
1077 =head2 GetPrintMessages
1079 my $message_list = GetPrintMessages( { borrowernumber => $borrowernumber } )
1081 Returns a arrayref of all queued print messages (optionally, for a particular
1086 sub GetPrintMessages
{
1087 my $params = shift || {};
1089 return _get_unsent_messages
( { message_transport_type
=> 'print',
1090 borrowernumber
=> $params->{'borrowernumber'},
1094 =head2 GetQueuedMessages ([$hashref])
1096 my $messages = GetQueuedMessage( { borrowernumber => '123', limit => 20 } );
1098 fetches messages out of the message queue.
1101 list of hashes, each has represents a message in the message queue.
1105 sub GetQueuedMessages
{
1108 my $dbh = C4
::Context
->dbh();
1109 my $statement = << 'ENDSQL';
1110 SELECT message_id
, borrowernumber
, subject
, content
, message_transport_type
, status
, time_queued
1116 if ( exists $params->{'borrowernumber'} ) {
1117 push @whereclauses, ' borrowernumber = ? ';
1118 push @query_params, $params->{'borrowernumber'};
1121 if ( @whereclauses ) {
1122 $statement .= ' WHERE ' . join( 'AND', @whereclauses );
1125 if ( defined $params->{'limit'} ) {
1126 $statement .= ' LIMIT ? ';
1127 push @query_params, $params->{'limit'};
1130 my $sth = $dbh->prepare( $statement );
1131 my $result = $sth->execute( @query_params );
1132 return $sth->fetchall_arrayref({});
1135 =head2 GetMessageTransportTypes
1137 my @mtt = GetMessageTransportTypes();
1139 returns an arrayref of transport types
1143 sub GetMessageTransportTypes
{
1144 my $dbh = C4
::Context
->dbh();
1145 my $mtts = $dbh->selectcol_arrayref("
1146 SELECT message_transport_type
1147 FROM message_transport_types
1148 ORDER BY message_transport_type
1155 my $message = C4::Letters::Message($message_id);
1160 my ( $message_id ) = @_;
1161 return unless $message_id;
1162 my $dbh = C4
::Context
->dbh;
1163 return $dbh->selectrow_hashref(q
|
1164 SELECT message_id
, borrowernumber
, subject
, content
, metadata
, letter_code
, message_transport_type
, status
, time_queued
, to_address
, from_address
, content_type
1166 WHERE message_id
= ?
1167 |, {}, $message_id );
1170 =head2 ResendMessage
1172 Attempt to resend a message which has failed previously.
1174 my $has_been_resent = C4::Letters::ResendMessage($message_id);
1176 Updates the message to 'pending' status so that
1177 it will be resent later on.
1179 returns 1 on success, 0 on failure, undef if no message was found
1184 my $message_id = shift;
1185 return unless $message_id;
1187 my $message = GetMessage
( $message_id );
1188 return unless $message;
1190 if ( $message->{status
} ne 'pending' ) {
1191 $rv = C4
::Letters
::_set_message_status
({
1192 message_id
=> $message_id,
1193 status
=> 'pending',
1195 $rv = $rv > 0?
1: 0;
1196 # Clear destination email address to force address update
1197 _update_message_to_address
( $message_id, undef ) if $rv &&
1198 $message->{message_transport_type
} eq 'email';
1203 =head2 _add_attachements
1206 letter - the standard letter hashref
1207 attachments - listref of attachments. each attachment is a hashref of:
1208 type - the mime type, like 'text/plain'
1209 content - the actual attachment
1210 filename - the name of the attachment.
1211 message - a MIME::Lite object to attach these to.
1213 returns your letter object, with the content updated.
1217 sub _add_attachments
{
1220 my $letter = $params->{'letter'};
1221 my $attachments = $params->{'attachments'};
1222 return $letter unless @
$attachments;
1223 my $message = $params->{'message'};
1225 # First, we have to put the body in as the first attachment
1227 Type
=> $letter->{'content-type'} || 'TEXT',
1228 Data
=> $letter->{'is_html'}
1229 ? _wrap_html
($letter->{'content'}, $letter->{'title'})
1230 : $letter->{'content'},
1233 foreach my $attachment ( @
$attachments ) {
1235 Type
=> $attachment->{'type'},
1236 Data
=> $attachment->{'content'},
1237 Filename
=> $attachment->{'filename'},
1240 # we're forcing list context here to get the header, not the count back from grep.
1241 ( $letter->{'content-type'} ) = grep( /^Content-Type:/, split( /\n/, $params->{'message'}->header_as_string ) );
1242 $letter->{'content-type'} =~ s/^Content-Type:\s+//;
1243 $letter->{'content'} = $message->body_as_string;
1249 sub _get_unsent_messages
{
1252 my $dbh = C4
::Context
->dbh();
1253 my $statement = << 'ENDSQL';
1254 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
1255 FROM message_queue mq
1256 LEFT JOIN borrowers b ON b
.borrowernumber
= mq
.borrowernumber
1260 my @query_params = ('pending');
1261 if ( ref $params ) {
1262 if ( $params->{'message_transport_type'} ) {
1263 $statement .= ' AND message_transport_type = ? ';
1264 push @query_params, $params->{'message_transport_type'};
1266 if ( $params->{'borrowernumber'} ) {
1267 $statement .= ' AND borrowernumber = ? ';
1268 push @query_params, $params->{'borrowernumber'};
1270 if ( $params->{'limit'} ) {
1271 $statement .= ' limit ? ';
1272 push @query_params, $params->{'limit'};
1276 $debug and warn "_get_unsent_messages SQL: $statement";
1277 $debug and warn "_get_unsent_messages params: " . join(',',@query_params);
1278 my $sth = $dbh->prepare( $statement );
1279 my $result = $sth->execute( @query_params );
1280 return $sth->fetchall_arrayref({});
1283 sub _send_message_by_email
{
1284 my $message = shift or return;
1285 my ($username, $password, $method) = @_;
1287 my $member = C4
::Members
::GetMember
( 'borrowernumber' => $message->{'borrowernumber'} );
1288 my $to_address = $message->{'to_address'};
1289 unless ($to_address) {
1291 warn "FAIL: No 'to_address' and INVALID borrowernumber ($message->{borrowernumber})";
1292 _set_message_status
( { message_id
=> $message->{'message_id'},
1293 status
=> 'failed' } );
1296 $to_address = C4
::Members
::GetNoticeEmailAddress
( $message->{'borrowernumber'} );
1297 unless ($to_address) {
1298 # warn "FAIL: No 'to_address' and no email for " . ($member->{surname} ||'') . ", borrowernumber ($message->{borrowernumber})";
1299 # warning too verbose for this more common case?
1300 _set_message_status
( { message_id
=> $message->{'message_id'},
1301 status
=> 'failed' } );
1306 my $utf8 = decode
('MIME-Header', $message->{'subject'} );
1307 $message->{subject
}= encode
('MIME-Header', $utf8);
1308 my $subject = encode
('UTF-8', $message->{'subject'});
1309 my $content = encode
('UTF-8', $message->{'content'});
1310 my $content_type = $message->{'content_type'} || 'text/plain; charset="UTF-8"';
1311 my $is_html = $content_type =~ m/html/io;
1312 my $branch_email = undef;
1313 my $branch_replyto = undef;
1314 my $branch_returnpath = undef;
1316 my $library = Koha
::Libraries
->find( $member->{branchcode
} );
1317 $branch_email = $library->branchemail;
1318 $branch_replyto = $library->branchreplyto;
1319 $branch_returnpath = $library->branchreturnpath;
1321 my $email = Koha
::Email
->new();
1322 my %sendmail_params = $email->create_message_headers(
1325 from
=> $message->{'from_address'} || $branch_email,
1326 replyto
=> $branch_replyto,
1327 sender
=> $branch_returnpath,
1328 subject
=> $subject,
1329 message
=> $is_html ? _wrap_html
( $content, $subject ) : $content,
1330 contenttype
=> $content_type
1334 $sendmail_params{'Auth'} = {user
=> $username, pass
=> $password, method
=> $method} if $username;
1335 if ( my $bcc = C4
::Context
->preference('NoticeBcc') ) {
1336 $sendmail_params{ Bcc
} = $bcc;
1339 _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
1341 if ( sendmail
( %sendmail_params ) ) {
1342 _set_message_status
( { message_id
=> $message->{'message_id'},
1343 status
=> 'sent' } );
1346 _set_message_status
( { message_id
=> $message->{'message_id'},
1347 status
=> 'failed' } );
1348 carp
$Mail::Sendmail
::error
;
1354 my ($content, $title) = @_;
1356 my $css = C4
::Context
->preference("NoticeCSS") || '';
1357 $css = qq{<link rel
="stylesheet" type
="text/css" href
="$css">} if $css;
1359 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1360 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1361 <html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
1363 <title>$title</title>
1364 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1375 my ( $message ) = @_;
1376 my $dbh = C4
::Context
->dbh;
1377 my $count = $dbh->selectrow_array(q
|
1380 WHERE message_transport_type
= ?
1381 AND borrowernumber
= ?
1383 AND CAST
(time_queued AS date
) = CAST
(NOW
() AS date
)
1386 |, {}, $message->{message_transport_type
}, $message->{borrowernumber
}, $message->{letter_code
}, $message->{content
} );
1390 sub _send_message_by_sms
{
1391 my $message = shift or return;
1392 my $member = C4
::Members
::GetMember
( 'borrowernumber' => $message->{'borrowernumber'} );
1394 unless ( $member->{smsalertnumber
} ) {
1395 _set_message_status
( { message_id
=> $message->{'message_id'},
1396 status
=> 'failed' } );
1400 if ( _is_duplicate
( $message ) ) {
1401 _set_message_status
( { message_id
=> $message->{'message_id'},
1402 status
=> 'failed' } );
1406 my $success = C4
::SMS
->send_sms( { destination
=> $member->{'smsalertnumber'},
1407 message
=> $message->{'content'},
1409 _set_message_status
( { message_id
=> $message->{'message_id'},
1410 status
=> ($success ?
'sent' : 'failed') } );
1414 sub _update_message_to_address
{
1416 my $dbh = C4
::Context
->dbh();
1417 $dbh->do('UPDATE message_queue SET to_address=? WHERE message_id=?',undef,($to,$id));
1420 sub _set_message_status
{
1421 my $params = shift or return;
1423 foreach my $required_parameter ( qw( message_id status ) ) {
1424 return unless exists $params->{ $required_parameter };
1427 my $dbh = C4
::Context
->dbh();
1428 my $statement = 'UPDATE message_queue SET status= ? WHERE message_id = ?';
1429 my $sth = $dbh->prepare( $statement );
1430 my $result = $sth->execute( $params->{'status'},
1431 $params->{'message_id'} );
1436 my ( $params ) = @_;
1438 my $content = $params->{content
};
1439 my $tables = $params->{tables
};
1440 my $loops = $params->{loops
};
1442 my $use_template_cache = C4
::Context
->config('template_cache_dir') && defined $ENV{GATEWAY_INTERFACE
};
1443 my $template = Template
->new(
1447 PLUGIN_BASE
=> 'Koha::Template::Plugin',
1448 COMPILE_EXT
=> $use_template_cache ?
'.ttc' : '',
1449 COMPILE_DIR
=> $use_template_cache ? C4
::Context
->config('template_cache_dir') : '',
1451 ENCODING
=> 'UTF-8',
1453 ) or die Template
->error();
1455 my $tt_params = { %{ _get_tt_params
( $tables ) }, %{ _get_tt_params
( $loops, 'is_a_loop' ) } };
1457 $content = qq|[% USE KohaDates
%]$content|;
1460 $template->process( \
$content, $tt_params, \
$output ) || croak
"ERROR PROCESSING TEMPLATE: " . $template->error();
1465 sub _get_tt_params
{
1466 my ($tables, $is_a_loop) = @_;
1472 article_requests
=> {
1473 module
=> 'Koha::ArticleRequests',
1474 singular
=> 'article_request',
1475 plural
=> 'article_requests',
1479 module
=> 'Koha::Biblios',
1480 singular
=> 'biblio',
1481 plural
=> 'biblios',
1482 pk
=> 'biblionumber',
1485 module
=> 'Koha::Patrons',
1486 singular
=> 'borrower',
1487 plural
=> 'borrowers',
1488 pk
=> 'borrowernumber',
1491 module
=> 'Koha::Libraries',
1492 singular
=> 'branch',
1493 plural
=> 'branches',
1497 module
=> 'Koha::Items',
1503 module
=> 'Koha::News',
1509 module
=> 'Koha::Tmp::Orders', # Should Koha::Acquisition::Orders when will be based on Koha::Objects
1510 singular
=> 'order',
1512 pk
=> 'ordernumber',
1515 module
=> 'Koha::Holds',
1518 fk
=> [ 'borrowernumber', 'biblionumber' ],
1521 module
=> 'Koha::Serials',
1522 singular
=> 'serial',
1523 plural
=> 'serials',
1527 module
=> 'Koha::Subscriptions',
1528 singular
=> 'subscription',
1529 plural
=> 'subscriptions',
1530 pk
=> 'subscriptionid',
1533 module
=> 'Koha::Suggestions',
1534 singular
=> 'suggestion',
1535 plural
=> 'suggestions',
1536 pk
=> 'suggestionid',
1539 module
=> 'Koha::Checkouts',
1540 singular
=> 'checkout',
1541 plural
=> 'checkouts',
1545 module
=> 'Koha::Old::Checkouts',
1546 singular
=> 'old_checkout',
1547 plural
=> 'old_checkouts',
1550 borrower_modifications
=> {
1551 module
=> 'Koha::Patron::Modifications',
1552 singular
=> 'patron_modification',
1553 plural
=> 'patron_modifications',
1554 fk
=> 'verification_token',
1558 foreach my $table ( keys %$tables ) {
1559 next unless $config->{$table};
1561 my $ref = ref( $tables->{$table} ) || q{};
1562 my $module = $config->{$table}->{module
};
1564 if ( can_load
( modules
=> { $module => undef } ) ) {
1565 my $pk = $config->{$table}->{pk
};
1566 my $fk = $config->{$table}->{fk
};
1569 my $values = $tables->{$table} || [];
1570 unless ( ref( $values ) eq 'ARRAY' ) {
1571 croak
"ERROR processing table $table. Wrong API call.";
1573 my $key = $pk ?
$pk : $fk;
1574 my $objects = $module->search( { $key => { -in => $values } } );
1575 $params->{ $config->{$table}->{plural
} } = $objects;
1577 elsif ( $ref eq q{} || $ref eq 'HASH' ) {
1578 my $id = ref $ref eq 'HASH' ?
$tables->{$table}->{$pk} : $tables->{$table};
1580 if ( $fk ) { # Using a foreign key for lookup
1581 if ( ref( $fk ) eq 'ARRAY' ) { # Foreign key is multi-column
1583 foreach my $key ( @
$fk ) {
1584 $search->{$key} = $id->{$key};
1586 $object = $module->search( $search )->last();
1587 } else { # Foreign key is single column
1588 $object = $module->search( { $fk => $id } )->last();
1590 } else { # using the table's primary key for lookup
1591 $object = $module->find($id);
1593 $params->{ $config->{$table}->{singular
} } = $object;
1595 else { # $ref eq 'ARRAY'
1597 if ( @
{ $tables->{$table} } == 1 ) { # Param is a single key
1598 $object = $module->search( { $pk => $tables->{$table} } )->last();
1600 else { # Params are mutliple foreign keys
1601 croak
"Multiple foreign keys (table $table) should be passed using an hashref";
1603 $params->{ $config->{$table}->{singular
} } = $object;
1607 croak
"ERROR LOADING MODULE $module: $Module::Load::Conditional::ERROR";
1611 $params->{today
} = dt_from_string
();