-
Notifications
You must be signed in to change notification settings - Fork 265
/
Copy pathLetters.pm
2107 lines (1802 loc) · 73.2 KB
/
Letters.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package C4::Letters;
# Copyright 2000-2002 Katipo Communications
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.
use Modern::Perl;
use Carp qw( carp croak );
use Template;
use Module::Load::Conditional qw( can_load );
use Try::Tiny;
use C4::Log qw( logaction );
use C4::Members;
use C4::SMS;
use C4::Templates;
use Koha::Auth::TwoFactorAuth;
use Koha::DateUtils qw( dt_from_string output_pref );
use Koha::Email;
use Koha::Exceptions;
use Koha::Notice::Messages;
use Koha::Notice::Templates;
use Koha::Notice::Util;
use Koha::Patrons;
use Koha::SMS::Providers;
use Koha::SMTP::Servers;
use Koha::Subscriptions;
use Koha::Template::Plugin::KohaDates;
use constant SERIALIZED_EMAIL_CONTENT_TYPE => 'message/rfc822';
our ( @ISA, @EXPORT_OK );
BEGIN {
require Exporter;
@ISA = qw(Exporter);
@EXPORT_OK = qw(
GetLetters
GetLettersAvailableForALibrary
GetLetterTemplates
DelLetter
GetPreparedLetter
GetWrappedLetter
SendAlerts
GetPrintMessages
GetQueuedMessages
GetMessage
GetMessageTransportTypes
EnqueueLetter
SendQueuedMessages
ResendMessage
);
}
our $domain_limits = {};
=head1 NAME
C4::Letters - Give functions for Letters management
=head1 SYNOPSIS
use C4::Letters;
=head1 DESCRIPTION
"Letters" is the tool used in Koha to manage informations sent to the patrons and/or the library. This include some cron jobs like
late issues, as well as other tasks like sending a mail to users that have subscribed to a "serial issue alert" (= being warned every time a new issue has arrived at the library)
Letters are managed through "alerts" sent by Koha on some events. All "alert" related functions are in this module too.
=head2 GetLetters([$module])
$letters = &GetLetters($module);
returns informations about letters.
if needed, $module filters for letters given module
DEPRECATED - You must use Koha::Notice::Templates instead
The group by clause is confusing and can lead to issues
=cut
sub GetLetters {
my ($filters) = @_;
my $module = $filters->{module};
my $code = $filters->{code};
my $branchcode = $filters->{branchcode};
my $dbh = C4::Context->dbh;
my $letters = $dbh->selectall_arrayref(
q|
SELECT code, module, name
FROM letter
WHERE 1
|
. ( $module ? q| AND module = ?| : q|| )
. ( $code ? q| AND code = ?| : q|| )
. ( defined $branchcode ? q| AND branchcode = ?| : q|| )
. q| GROUP BY code, module, name ORDER BY name|, { Slice => {} }
, ( $module ? $module : () )
, ( $code ? $code : () )
, ( defined $branchcode ? $branchcode : () )
);
return $letters;
}
=head2 GetLetterTemplates
my $letter_templates = GetLetterTemplates(
{
module => 'circulation',
code => 'my code',
branchcode => 'CPL', # '' for default,
}
);
Return a hashref of letter templates.
=cut
sub GetLetterTemplates {
my ($params) = @_;
my $module = $params->{module};
my $code = $params->{code};
my $branchcode = $params->{branchcode} // '';
my $dbh = C4::Context->dbh;
return Koha::Notice::Templates->search(
{
module => $module,
code => $code,
branchcode => $branchcode,
(
C4::Context->preference('TranslateNotices')
? ()
: ( lang => 'default' )
)
}
)->unblessed;
}
=head2 GetLettersAvailableForALibrary
my $letters = GetLettersAvailableForALibrary(
{
branchcode => 'CPL', # '' for default
module => 'circulation',
}
);
Return an arrayref of letters, sorted by name.
If a specific letter exist for the given branchcode, it will be retrieve.
Otherwise the default letter will be.
=cut
sub GetLettersAvailableForALibrary {
my ($filters) = @_;
my $branchcode = $filters->{branchcode};
my $module = $filters->{module};
croak "module should be provided" unless $module;
my $dbh = C4::Context->dbh;
my $default_letters = $dbh->selectall_arrayref(
q|
SELECT module, code, branchcode, name
FROM letter
WHERE 1
|
. q| AND branchcode = ''|
. ( $module ? q| AND module = ?| : q|| )
. q| ORDER BY name|, { Slice => {} }
, ( $module ? $module : () )
);
my $specific_letters;
if ($branchcode) {
$specific_letters = $dbh->selectall_arrayref(
q|
SELECT module, code, branchcode, name
FROM letter
WHERE 1
|
. q| AND branchcode = ?|
. ( $module ? q| AND module = ?| : q|| )
. q| ORDER BY name|, { Slice => {} }
, $branchcode
, ( $module ? $module : () )
);
}
my %letters;
for my $l (@$default_letters) {
$letters{ $l->{code} } = $l;
}
for my $l (@$specific_letters) {
# Overwrite the default letter with the specific one.
$letters{ $l->{code} } = $l;
}
return [
map { $letters{$_} }
sort { $letters{$a}->{name} cmp $letters{$b}->{name} }
keys %letters
];
}
=head2 DelLetter
DelLetter(
{
branchcode => 'CPL',
module => 'circulation',
code => 'my code',
[ mtt => 'email', ]
}
);
Delete the letter. The mtt parameter is facultative.
If not given, all templates mathing the other parameters will be removed.
=cut
sub DelLetter {
my ($params) = @_;
my $branchcode = $params->{branchcode};
my $module = $params->{module};
my $code = $params->{code};
my $mtt = $params->{mtt};
my $lang = $params->{lang};
my $dbh = C4::Context->dbh;
$dbh->do(
q|
DELETE FROM letter
WHERE branchcode = ?
AND module = ?
AND code = ?
|
. ( $mtt ? q| AND message_transport_type = ?| : q|| ) . ( $lang ? q| AND lang = ?| : q|| ), undef,
$branchcode, $module, $code, ( $mtt ? $mtt : () ), ( $lang ? $lang : () )
);
}
=head2 SendAlerts
my $err = &SendAlerts($type, $externalid, $letter_code);
Parameters:
- $type : the type of alert
- $externalid : the id of the "object" to query
- $letter_code : the notice template to use
C<&SendAlerts> sends an email notice directly to a patron or a vendor.
Currently it supports ($type):
- claim serial issues (claimissues)
- claim acquisition orders (claimacquisition)
- send acquisition orders to the vendor (orderacquisition)
- notify patrons about newly received serial issues (issue)
- notify patrons when their account is created (members)
Returns undef or { error => 'message } on failure.
Returns true on success.
=cut
sub SendAlerts {
my ( $type, $externalid, $letter_code ) = @_;
my $dbh = C4::Context->dbh;
my $error;
if ( $type eq 'issue' ) {
# prepare the letter...
# search the subscriptionid
my $sth = $dbh->prepare("SELECT subscriptionid FROM serial WHERE serialid=?");
$sth->execute($externalid);
my ($subscriptionid) = $sth->fetchrow
or warn("No subscription for '$externalid'"),
return;
# search the biblionumber
$sth = $dbh->prepare("SELECT biblionumber FROM subscription WHERE subscriptionid=?");
$sth->execute($subscriptionid);
my ($biblionumber) = $sth->fetchrow
or warn("No biblionumber for '$subscriptionid'"),
return;
# find the list of subscribers to notify
my $subscription = Koha::Subscriptions->find($subscriptionid);
my $subscribers = $subscription->subscribers;
while ( my $patron = $subscribers->next ) {
my $email = $patron->notice_email_address or next;
# warn "sending issues...";
my $userenv = C4::Context->userenv;
my $library = $patron->library;
my $letter = GetPreparedLetter(
module => 'serial',
letter_code => $letter_code,
branchcode => $userenv->{branch},
tables => {
'branches' => $library->branchcode,
'biblio' => $biblionumber,
'biblioitems' => $biblionumber,
'borrowers' => $patron->unblessed,
'subscription' => $subscriptionid,
'serial' => $externalid,
},
want_librarian => 1,
) or return;
# FIXME: This 'default' behaviour should be moved to Koha::Email
my $mail = Koha::Email->create(
{
to => $email,
from => $library->branchemail,
reply_to => $library->branchreplyto,
sender => $library->branchreturnpath,
subject => "" . $letter->{title},
template_id => $letter->{id},
}
);
if ( $letter->{is_html} ) {
$mail->html_body( _wrap_html( $letter->{content}, "" . $letter->{title} ) );
} else {
$mail->text_body( $letter->{content} );
}
my $success = try {
$mail->send_or_die( { transport => $library->smtp_server->transport } );
} catch {
# We expect ref($_) eq 'Email::Sender::Failure'
$error = $_->message;
carp "$_";
return;
};
return { error => $error }
unless $success;
}
} elsif ( $type eq 'claimacquisition' or $type eq 'claimissues' or $type eq 'orderacquisition' ) {
# prepare the letter...
my $strsth;
my $sthorders;
my $dataorders;
my $action;
my $basketno;
my %loops;
if ( $type eq 'claimacquisition' ) {
$strsth = qq{
SELECT aqorders.*,aqbasket.*,biblio.*,biblioitems.*
FROM aqorders
LEFT JOIN aqbasket ON aqbasket.basketno=aqorders.basketno
LEFT JOIN biblio ON aqorders.biblionumber=biblio.biblionumber
LEFT JOIN biblioitems ON aqorders.biblionumber=biblioitems.biblionumber
WHERE aqorders.ordernumber IN (
};
if ( !@$externalid ) {
carp "No order selected";
return { error => "no_order_selected" };
}
$strsth .= join( ",", ('?') x @$externalid ) . ")";
$action = "ACQUISITION CLAIM";
$sthorders = $dbh->prepare($strsth);
$sthorders->execute(@$externalid);
$dataorders = $sthorders->fetchall_arrayref( {} );
}
if ( $type eq 'claimissues' ) {
$strsth = qq{
SELECT serial.*,subscription.*, biblio.*, biblioitems.*, aqbooksellers.*,
aqbooksellers.id AS booksellerid
FROM serial
LEFT JOIN subscription ON serial.subscriptionid=subscription.subscriptionid
LEFT JOIN biblio ON serial.biblionumber=biblio.biblionumber
LEFT JOIN biblioitems ON serial.biblionumber = biblioitems.biblionumber
LEFT JOIN aqbooksellers ON subscription.aqbooksellerid=aqbooksellers.id
WHERE serial.serialid IN (
};
if ( !@$externalid ) {
carp "No issues selected";
return { error => "no_issues_selected" };
}
$strsth .= join( ",", ('?') x @$externalid ) . ")";
$action = "SERIAL CLAIM";
$sthorders = $dbh->prepare($strsth);
$sthorders->execute(@$externalid);
$dataorders = $sthorders->fetchall_arrayref( {} );
}
if ( $type eq 'orderacquisition' ) {
$basketno = $externalid;
$strsth = qq{
SELECT aqorders.*,aqbasket.*,biblio.*,biblioitems.*
FROM aqorders
LEFT JOIN aqbasket ON aqbasket.basketno=aqorders.basketno
LEFT JOIN biblio ON aqorders.biblionumber=biblio.biblionumber
LEFT JOIN biblioitems ON aqorders.biblionumber=biblioitems.biblionumber
WHERE aqbasket.basketno = ?
AND orderstatus IN ('new','ordered')
};
unless ($basketno) {
carp "No basketnumber given";
return { error => "no_basketno" };
}
$action = "ACQUISITION ORDER";
$sthorders = $dbh->prepare($strsth);
$sthorders->execute($basketno);
$dataorders = $sthorders->fetchall_arrayref( {} );
%loops = ( aqorders => [ map { $_->{ordernumber} } @$dataorders ] );
}
my $booksellerid = $dataorders->[0]->{booksellerid};
my $addressee = $type eq 'claimacquisition' || $type eq 'orderacquisition' ? 'acqprimary' : 'serialsprimary';
my $sthcontact =
$dbh->prepare("SELECT * FROM aqcontacts WHERE booksellerid=? AND $type=1 ORDER BY $addressee DESC");
$sthcontact->execute($booksellerid);
my $datacontact = $sthcontact->fetchrow_hashref;
my @email;
my @cc;
push @email, $datacontact->{email} if ( $datacontact && $datacontact->{email} );
unless (@email) {
warn "Bookseller $booksellerid without emails";
return { error => "no_email" };
}
my $addlcontact;
while ( $addlcontact = $sthcontact->fetchrow_hashref ) {
push @cc, $addlcontact->{email} if ( $addlcontact && $addlcontact->{email} );
}
my $userenv = C4::Context->userenv;
my $letter = GetPreparedLetter(
module => $type,
letter_code => $letter_code,
branchcode => $userenv->{branch},
tables => {
'branches' => $userenv->{branch},
'aqbooksellers' => $booksellerid,
'aqcontacts' => $datacontact,
'aqbasket' => $basketno,
},
repeat => $dataorders,
loops => \%loops,
want_librarian => 1,
) or return { error => "no_letter" };
# Remove the order tag
$letter->{content} =~ s/<order>(.*?)<\/order>/$1/gxms;
# ... then send mail
my $library = Koha::Libraries->find( $userenv->{branch} );
my $mail = Koha::Email->create(
{
to => join( ',', @email ),
cc => join( ',', @cc ),
(
(
C4::Context->preference("ClaimsBccCopy") && ( $type eq 'claimacquisition'
|| $type eq 'claimissues' )
)
? ( bcc => $userenv->{emailaddress} )
: ()
),
from => (
$type eq 'claimissues'
? C4::Context->preference('SerialsDefaultEmailAddress')
: C4::Context->preference('AcquisitionsDefaultEmailAddress')
)
|| $library->branchemail
|| C4::Context->preference('KohaAdminEmailAddress'),
(
$type eq 'claimissues' && C4::Context->preference('SerialsDefaultReplyTo')
? ( reply_to => C4::Context->preference('SerialsDefaultReplyTo') )
: (
( $type eq 'claimacquisition' || $type eq 'orderacquisition' )
&& C4::Context->preference('AcquisitionsDefaultReplyTo')
? ( reply_to => C4::Context->preference('AcquisitionsDefaultReplyTo') )
: ()
)
),
subject => "" . $letter->{title},
template_id => $letter->{id},
}
);
if ( $letter->{is_html} ) {
$mail->html_body( _wrap_html( $letter->{content}, "" . $letter->{title} ) );
} else {
$mail->text_body( "" . $letter->{content} );
}
my $success = try {
$mail->send_or_die( { transport => $library->smtp_server->transport } );
} catch {
# We expect ref($_) eq 'Email::Sender::Failure'
$error = $_->message;
carp "$_";
return;
};
return { error => $error }
unless $success;
my $log_object = $action eq 'ACQUISITION ORDER' ? $externalid : undef;
my $module = $action eq 'ACQUISITION ORDER' ? 'ACQUISITIONS' : 'CLAIMS';
logaction(
$module,
$action,
$log_object,
"To=" . join( ',', @email ) . " Title=" . $letter->{title} . " Content=" . $letter->{content}
) if C4::Context->preference("ClaimsLog");
}
# If we come here, return an OK status
return 1;
}
=head2 GetPreparedLetter( %params )
my $letter = GetPreparedLetter(
{
module => "letter module", # mandatory
letter_code => "letter code", # mandatory
branchcode => "for letter selection", # if missing default system letter taken
objects => {}, # a hashref with object names as keys and objects as values
tables => {}, # a hashref with table names as keys. Values are either:
# - a scalar - primary key value
# - an arrayref - primary key values
# - a hashref - full record
substitute => {}, # custom substitution key/value pairs
repeat => '', # records to be substituted on consecutive lines, accepts either:
# - an arrayref
# tries to guess what needs substituting by taking remaining
# << >> tokensr; not recommended
# - a hashref token => @tables
# replaces <token> << >> << >> </token> subtemplate for each
# @tables row; table is a hashref as above
want_librarian => '' # boolean, if set to true triggers librarian details substitution
# from the userenv
}
);
Return value: letter fields hashref (title & content useful)
=cut
sub GetPreparedLetter {
my %params = @_;
my $letter = $params{letter};
my $lang = $params{lang} || 'default';
unless ($letter) {
my $module = $params{module} or croak "No module";
my $letter_code = $params{letter_code} or croak "No letter_code";
my $branchcode = $params{branchcode} || '';
my $mtt = $params{message_transport_type} || 'email';
my $template = Koha::Notice::Templates->find_effective_template(
{
module => $module,
code => $letter_code,
branchcode => $branchcode,
message_transport_type => $mtt,
lang => $lang
}
);
unless ($template) {
warn( "No $module $letter_code letter transported by " . $mtt );
return;
}
$letter = $template->unblessed;
$letter->{'content-type'} = 'text/html; charset="UTF-8"' if $letter->{is_html};
}
$lang = $letter->{'lang'};
my $objects = $params{objects} || {};
my $tables = $params{tables} || {};
my $substitute = $params{substitute} || {};
my $loops = $params{loops} || {}; # loops is not supported for historical notices syntax
my $repeat = $params{repeat};
%$tables || %$substitute || $repeat || %$loops || %$objects
or carp("ERROR: nothing to substitute - all of 'objects', 'tables', 'loops' and 'substitute' are empty"),
return;
my $want_librarian = $params{want_librarian};
if ($want_librarian) {
my $userenv = C4::Context->userenv;
$objects->{librarian} = Koha::Patrons->find( C4::Context->userenv->{number} ) if ($userenv);
}
# Best guess at language 'default' notice is written for include handling
if ( $lang eq 'default' ) {
# Pick the first selected syspref language
my @languages = split /,/, C4::Context->preference('OPACLanguages');
$lang = shift @languages;
}
$Template::Stash::SCALAR_OPS->{strftime} = sub {
return Koha::Template::Plugin::KohaDates->strftime(@_);
};
$letter->{content} = _process_tt(
{
content => $letter->{content},
lang => $lang,
loops => $loops,
objects => $objects,
substitute => $substitute,
tables => $tables,
}
);
$letter->{title} = _process_tt(
{
content => $letter->{title},
lang => $lang,
loops => $loops,
objects => $objects,
substitute => $substitute,
tables => $tables,
}
);
if (%$substitute) {
while ( my ( $token, $val ) = each %$substitute ) {
$val //= q{};
if ( $token eq 'items.content' ) {
$val =~ s|\n|<br/>|g if $letter->{is_html};
}
$letter->{title} =~ s/<<$token>>/$val/g;
$letter->{content} =~ s/<<$token>>/$val/g;
}
}
my $OPACBaseURL = C4::Context->preference('OPACBaseURL');
$letter->{content} =~ s/<<OPACBaseURL>>/$OPACBaseURL/go;
if ($want_librarian) {
# parsing librarian name
my $userenv = C4::Context->userenv;
$letter->{content} =~ s/<<LibrarianFirstname>>/$userenv->{firstname}/go;
$letter->{content} =~ s/<<LibrarianSurname>>/$userenv->{surname}/go;
$letter->{content} =~ s/<<LibrarianEmailaddress>>/$userenv->{emailaddress}/go;
}
my ( $repeat_no_enclosing_tags, $repeat_enclosing_tags );
if ($repeat) {
if ( ref($repeat) eq 'ARRAY' ) {
$repeat_no_enclosing_tags = $repeat;
} else {
$repeat_enclosing_tags = $repeat;
}
}
if ($repeat_enclosing_tags) {
while ( my ( $tag, $tag_tables ) = each %$repeat_enclosing_tags ) {
if ( $letter->{content} =~ m!<$tag>(.*)</$tag>!s ) {
my $subcontent = $1;
my @lines = map {
my %subletter = ( title => '', content => $subcontent );
_substitute_tables( \%subletter, $_ );
$subletter{content};
} @$tag_tables;
$letter->{content} =~ s!<$tag>.*</$tag>!join( "\n", @lines )!se;
}
}
}
if (%$tables) {
_substitute_tables( $letter, $tables );
}
if ($repeat_no_enclosing_tags) {
if ( $letter->{content} =~ m/[^\n]*<<.*>>[^\n]*/so ) {
my $line = $&;
my $i = 1;
my @lines = map {
my $c = $line;
$c =~ s/<<count>>/$i/go;
foreach my $field ( keys %{$_} ) {
$c =~ s/(<<[^\.]+.$field>>)/$_->{$field}/;
}
$i++;
$c;
} @$repeat_no_enclosing_tags;
my $replaceby = join( "\n", @lines );
$letter->{content} =~ s/\Q$line\E/$replaceby/s;
}
}
$letter->{content} =~ s/<<\S*>>//go; #remove any stragglers
Koha::Plugins->call( 'transform_prepared_letter', { letter => $letter, params => \%params } );
return $letter;
}
sub _substitute_tables {
my ( $letter, $tables ) = @_;
while ( my ( $table, $param ) = each %$tables ) {
next unless $param;
my $ref = ref $param;
my $values;
if ( $ref && $ref eq 'HASH' ) {
$values = $param;
} else {
my $sth = _parseletter_sth($table);
unless ($sth) {
warn
"_parseletter_sth('$table') failed to return a valid sth. No substitution will be done for that table.";
return;
}
$sth->execute( $ref ? @$param : $param );
$values = $sth->fetchrow_hashref;
$sth->finish();
}
_parseletter( $letter, $table, $values );
}
}
sub _parseletter_sth {
my $table = shift;
my $sth;
unless ($table) {
carp "ERROR: _parseletter_sth() called without argument (table)";
return;
}
# NOTE: we used to check whether we had a statement handle cached in
# a %handles module-level variable. This was a dumb move and
# broke things for the rest of us. prepare_cached is a better
# way to cache statement handles anyway.
my $query =
( $table eq 'accountlines' ) ? "SELECT * FROM $table WHERE accountlines_id = ?"
: ( $table eq 'biblio' ) ? "SELECT * FROM $table WHERE biblionumber = ?"
: ( $table eq 'biblioitems' ) ? "SELECT * FROM $table WHERE biblionumber = ?"
: ( $table eq 'tickets' ) ? "SELECT * FROM $table WHERE id = ?"
: ( $table eq 'ticket_updates' ) ? "SELECT * FROM $table WHERE id = ?"
: ( $table eq 'credits' ) ? "SELECT * FROM accountlines WHERE accountlines_id = ?"
: ( $table eq 'debits' ) ? "SELECT * FROM accountlines WHERE accountlines_id = ?"
: ( $table eq 'items' ) ? "SELECT * FROM $table WHERE itemnumber = ?"
: ( $table eq 'issues' ) ? "SELECT * FROM $table WHERE itemnumber = ?"
: ( $table eq 'old_issues' ) ? "SELECT * FROM $table WHERE issue_id = ?"
: ( $table eq 'reserves' ) ? "SELECT * FROM $table WHERE borrowernumber = ? and biblionumber = ?"
: ( $table eq 'borrowers' ) ? "SELECT * FROM $table WHERE borrowernumber = ?"
: ( $table eq 'branches' ) ? "SELECT * FROM $table WHERE branchcode = ?"
: ( $table eq 'suggestions' ) ? "SELECT * FROM $table WHERE suggestionid = ?"
: ( $table eq 'aqbooksellers' ) ? "SELECT * FROM $table WHERE id = ?"
: ( $table eq 'aqorders' ) ? "SELECT * FROM $table WHERE ordernumber = ?"
: ( $table eq 'aqbasket' ) ? "SELECT * FROM $table WHERE basketno = ?"
: ( $table eq 'illrequests' ) ? "SELECT * FROM $table WHERE illrequest_id = ?"
: ( $table eq 'article_requests' ) ? "SELECT * FROM $table WHERE id = ?"
: ( $table eq 'borrower_modifications' ) ? "SELECT * FROM $table WHERE verification_token = ?"
: ( $table eq 'subscription' ) ? "SELECT * FROM $table WHERE subscriptionid = ?"
: ( $table eq 'serial' ) ? "SELECT * FROM $table WHERE serialid = ?"
: ( $table eq 'problem_reports' ) ? "SELECT * FROM $table WHERE reportid = ?"
: ( $table eq 'additional_contents' || $table eq 'opac_news' )
? "SELECT * FROM additional_contents_localizations WHERE id = ?"
: ( $table eq 'recalls' ) ? "SELECT * FROM $table WHERE recall_id = ?"
: undef;
unless ($query) {
warn "ERROR: No _parseletter_sth query for table '$table'";
return; # nothing to get
}
unless ( $sth = C4::Context->dbh->prepare_cached($query) ) {
warn "ERROR: Failed to prepare query: '$query'";
return;
}
return $sth; # now cache is populated for that $table
}
=head2 _parseletter($letter, $table, $values)
parameters :
- $letter : a hash to letter fields (title & content useful)
- $table : the Koha table to parse.
- $values_in : table record hashref
parse all fields from a table, and replace values in title & content with the appropriate value
(not exported sub, used only internally)
=cut
sub _parseletter {
my ( $letter, $table, $values_in ) = @_;
# Work on a local copy of $values_in (passed by reference) to avoid side effects
# in callers ( by changing / formatting values )
my $values = $values_in ? {%$values_in} : {};
# FIXME Dates formatting must be done in notice's templates
if ( $table eq 'borrowers' && $values->{'dateexpiry'} ) {
$values->{'dateexpiry'} = output_pref( { dt => dt_from_string( $values->{'dateexpiry'} ), dateonly => 1 } );
}
if ( $table eq 'reserves' && $values->{'waitingdate'} ) {
$values->{'waitingdate'} = output_pref( { dt => dt_from_string( $values->{'waitingdate'} ), dateonly => 1 } );
}
if ( $letter->{content} && $letter->{content} =~ /<<today>>/ ) {
my $todaysdate = output_pref( dt_from_string() );
$letter->{content} =~ s/<<today>>/$todaysdate/go;
}
while ( my ( $field, $val ) = each %$values ) {
$val =~ s/\p{P}$// if $val && $table =~ /biblio/;
#BZ 9886: Assuming that we want to eliminate ISBD punctuation here
#Therefore adding the test on biblio. This includes biblioitems,
#but excludes items. Removed unneeded global and lookahead.
if ( $table =~ /^borrowers$/ && $field =~ /^streettype$/ ) {
my $av = Koha::AuthorisedValues->search( { category => 'ROADTYPE', authorised_value => $val } );
$val = $av->count ? $av->next->lib : '';
}
# Dates replacement
my $replacedby = defined($val) ? $val : '';
if ( $replacedby
and not $replacedby =~ m|9999-12-31|
and $replacedby =~ m|^\d{4}-\d{2}-\d{2}( \d{2}:\d{2}:\d{2})?$| )
{
# If the value is XXXX-YY-ZZ[ AA:BB:CC] we assume it is a date
my $dateonly =
defined $1
? 0
: 1
; #$1 refers to the capture group wrapped in parentheses. In this case, that's the hours, minutes, seconds.
my $re_dateonly_filter = qr{ $field( \s* \| \s* dateonly\s*)?>> }xms;
for my $letter_field (qw( title content )) {
my $filter_string_used = q{};
if ( $letter->{$letter_field} =~ $re_dateonly_filter ) {
# We overwrite $dateonly if the filter exists and we have a time in the datetime
$filter_string_used = $1 || q{};
$dateonly = $1 unless $dateonly;
}
my $replacedby_date =
eval { output_pref( { dt => scalar dt_from_string($replacedby), dateonly => $dateonly } ); };
$replacedby_date //= q{};
if ( $letter->{$letter_field} ) {
$letter->{$letter_field} =~ s/\Q<<$table.$field$filter_string_used>>\E/$replacedby_date/g;
$letter->{$letter_field} =~ s/\Q<<$field$filter_string_used>>\E/$replacedby_date/g;
}
}
}
# Other fields replacement
else {
for my $letter_field (qw( title content )) {
if ( $letter->{$letter_field} ) {
$letter->{$letter_field} =~ s/<<$table.$field>>/$replacedby/g;
$letter->{$letter_field} =~ s/<<$field>>/$replacedby/g;
}
}
}
}
if ( $table eq 'borrowers' && $letter->{content} ) {
my $patron = Koha::Patrons->find( $values->{borrowernumber} );
if ($patron) {
my $attributes = $patron->extended_attributes;
my %attr;
while ( my $attribute = $attributes->next ) {
my $code = $attribute->code;
my $val = $attribute->description; # FIXME - we always display intranet description here!
$val =~ s/\p{P}(?=$)//g if $val;
next unless $val gt '';
$attr{$code} ||= [];
push @{ $attr{$code} }, $val;
}
while ( my ( $code, $val_ar ) = each %attr ) {
my $replacefield = "<<borrower-attribute:$code>>";
my $replacedby = join ',', @$val_ar;
$letter->{content} =~ s/$replacefield/$replacedby/g;
}
}
}
return $letter;
}
=head2 EnqueueLetter
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 message_id on success
Parameters
* letter - required; A letter hashref as returned from GetPreparedLetter
* message_transport_type - required; One of the available mtts
* borrowernumber - optional if 'to_address' is passed; The borrowernumber of the patron we enqueuing the notice for
* to_address - optional if 'borrowernumber' is passed; The destination email address for the notice (defaults to patron->notice_email_address)
* from_address - optional; The from address for the notice, defaults to patron->library->from_email_address
* reply_address - optional; The reply address for the notice, defaults to patron->library->reply_to
=cut
sub EnqueueLetter {
my $params = shift or return;
return unless exists $params->{'letter'};
# return unless exists $params->{'borrowernumber'};
return unless exists $params->{'message_transport_type'};
my $content = $params->{letter}->{content};
$content =~ s/\s+//g if ( defined $content );
if ( not defined $content or $content eq '' ) {
Koha::Logger->get->info("Trying to add an empty message to the message queue");
return;
}
# 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'},
}
);
}
if ( $params->{message_transport_type} eq 'sms' ) {
my $limit = C4::Context->preference('SMSSendMaxChar');
$params->{letter}->{content} = substr( $params->{letter}->{content}, 0, $limit - 3 ) . '...'
if ( $limit && length( $params->{letter}->{content} ) > $limit );
}
my $message = Koha::Notice::Message->new(
{
letter_id => $params->{letter}->{id} || undef,
borrowernumber => $params->{borrowernumber},
subject => $params->{letter}->{title},
content => $params->{letter}->{content},
metadata => $params->{letter}->{metadata} || q{},
letter_code => $params->{letter}->{code} || q{},
message_transport_type => $params->{message_transport_type},
status => 'pending',
time_queued => dt_from_string(),
to_address => $params->{to_address},
from_address => $params->{from_address},
reply_address => $params->{reply_address},
content_type => $params->{letter}->{'content-type'},
failure_code => $params->{failure_code} || q{},
}
)->store();
return $message->id;
}
=head2 SendQueuedMessages ([$hashref])