-
Notifications
You must be signed in to change notification settings - Fork 54
/
Members.pm
2873 lines (2336 loc) · 86.2 KB
/
Members.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::Members;
# Copyright 2000-2003 Katipo Communications
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation; either version 2 of the License, or (at your option) any later
# version.
#
# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
# Suite 330, Boston, MA 02111-1307 USA
use strict;
use warnings;
use Carp qw(carp cluck croak confess);
use Koha;
use C4::Context;
use C4::Dates qw(format_date_in_iso);
use Digest::MD5 qw(md5_base64);
use Date::Calc qw/Today Add_Delta_YM/;
use C4::Log; # logaction
use C4::Branch qw(GetBranchDetail);
use C4::Overdues;
use C4::Reserves;
use C4::Accounts;
use C4::Biblio;
use C4::Items;
use C4::Koha qw( GetAuthValCode );
use C4::Auth qw();
our ($VERSION,@ISA,@EXPORT,@EXPORT_OK,$debug);
BEGIN {
$VERSION = 3.02;
$debug = $ENV{DEBUG} || 0;
require Exporter;
@ISA = qw(Exporter);
#Get data
push @EXPORT, qw(
&SearchMember
&SearchMemberAdvanced
&SearchMemberBySQL
&GetMemberDetails
&GetMember
&GetGuarantees
&GetMemberIssuesAndFines
&GetPendingIssues
&GetAllIssues
&GetEarliestDueDate
&get_institutions
&getzipnamecity
&getidcity
&GetFirstValidEmailAddress
&GetAge
&GetCities
&GetRoadTypes
&GetRoadTypeDetails
&GetSortDetails
&GetTitles
&GetPatronImage
&PutPatronImage
&RmPatronImage
&GetBorNotifyAcctRecord
&GetLostStats
&GetNotifiedMembers
&GetborCatFromCatType
&GetBorrowercategory
&GetBorrowercategoryList
&GetBorrowersWhoHaveNotBorrowedSince
&GetBorrowersWhoHaveNeverBorrowed
&GetBorrowersWithIssuesHistoryOlderThan
&GetExpiryDate
&AddMessage
&DeleteMessage
&GetMessages
&GetMessagesCount
&GetMemberRevisions
&SetDisableReadingHistory
);
#Modify data
push @EXPORT, qw(
&ModMember
&changepassword
&MarkMemberReported
);
#Delete data
push @EXPORT, qw(
&DelMember
);
#Insert data
push @EXPORT, qw(
&AddMember
&add_member_orgs
&MoveMemberToDeleted
&ExtendMemberSubscriptionTo
);
#Check data
push @EXPORT, qw(
&checkuniquemember
&checkuserpassword
&Check_Userid
&Generate_Userid
&fixEthnicity
ðnicitycategories
&fixup_cardnumber
&checkcardnumber
);
}
=head1 NAME
C4::Members - Perl Module containing convenience functions for member handling
=head1 SYNOPSIS
use C4::Members;
=head1 DESCRIPTION
This module contains routines for adding, modifying and deleting members/patrons/borrowers
=head1 FUNCTIONS
=over 2
=item SearchMember
($count, $borrowers) = &SearchMember($searchstring, $orderby, $type, $category_type);
=back
Looks up patrons (borrowers) by name.
C<$type> is now used to determine type of search.
if $type is "simple", search is performed on the first letter of the
surname only.
$category_type is used to get a specified type of user.
(mainly adults when creating a child.)
C<$searchstring> is a space-separated list of search terms. Each term
must match the beginning a borrower's surname, first name, other
name, or initials.
C<&SearchMember> returns a two-element list. C<$borrowers> is a
reference-to-array; each element is a reference-to-hash, whose keys
are the fields of the C<borrowers> table in the Koha database.
C<$count> is the number of elements in C<$borrowers>.
=cut
sub _constrain_sql_by_branchcategory {
my ($query, @bind) = @_;
if ( C4::Branch::CategoryTypeIsUsed('patrons')
&& $ENV{REQUEST_METHOD} # need a nicer way to do this, but check if we're command line vs. CGI
&& !C4::Auth::haspermission(undef, {superlibrarian => 1})
)
{
my $mybranch = (C4::Context->userenv) ? C4::Context->userenv->{branch} : undef;
confess 'Unable to determine selected branch' if not $mybranch;
my @sibling_branchcodes = C4::Branch::GetSiblingBranchesOfType($mybranch, 'patrons');
my $clause = sprintf ' borrowers.branchcode IN (%s) ', join(',', map {'?'} @sibling_branchcodes) ;
# This doesn't work if we don't have a WHERE clause
$query =~ s/WHERE/WHERE $clause AND /;
unshift @bind, @sibling_branchcodes;
}
return ($query, @bind);
}
sub SearchMember {
my ($searchstring, $orderby, $type, $category_type, $limits) = @_;
$orderby ||= 'surname';
$limits //= {offset => 0, limit => C4::Context->preference('PatronsPerPage')};
# FIXME: find where in members.pl this function is being called a second time with no args
return (0, []) if (!$searchstring);
my $dbh = C4::Context->dbh;
my $sth;
my @bind;
my $query = q{
SELECT *
FROM borrowers
LEFT JOIN categories
ON borrowers.categorycode=categories.categorycode
WHERE 1
};
($query, @bind) = _constrain_sql_by_branchcategory($query);
# this is used by circulation everytime a new borrowers cardnumber is scanned
# so we can check an exact match first, if that works return, otherwise do the rest
if (($searchstring !~ /\D/) && C4::Context->preference('patronbarcodelength')) {
## this handles the edge case of multiple barcodes with same right-hand
## significant digits, different branch prefixes.
my @in = @{_prefix_cardnum_multibranch($searchstring)};
$sth = $dbh->prepare(
sprintf("$query AND cardnumber IN (%s) LIMIT 1",
join(',', map {'?'} @in)
));
$sth->execute(@bind, @in);
}
else {
$sth = $dbh->prepare("$query AND cardnumber=? LIMIT 1");
$sth->execute(@bind, $searchstring);
}
my $data = $sth->fetchrow_hashref();
if ($data) {
return (1, [$data]);
}
$query =~ s/\*/COUNT(borrowernumber)/xms;
if ($category_type) {
$query .= ' AND category_type = ? ';
push @bind, $category_type;
}
# simple search for one letter only
if ($type ~~ 'simple') {
$query .= ' AND (surname LIKE ? OR cardnumber LIKE ?) ';
push @bind, ("$searchstring%","$searchstring");
}
# advanced search looking in surname, firstname, othernames, and initials
else {
my @data = split(' ', $searchstring);
my $count = @data;
$query .= ' AND (';
for ( my $i = 0 ; $i < $count ; $i++ ) {
my $term = $data[$i];
$query .= "(surname LIKE ? OR surname LIKE ?
OR firstname LIKE ? OR firstname LIKE ?
OR othernames LIKE ?
OR initials LIKE ? ) AND ";
push( @bind, "$term%", "% $term%", "$term%", "% $term%", "$term%", "$term%" );
}
$query =~ s/ AND $/ /;
$query .= ') ';
}
$data = $dbh->selectrow_arrayref($query, undef, @bind);
my $row_count = $data->[0];
$query =~ s/COUNT\(borrowernumber\)/*/xms;
$query .= " ORDER BY $orderby ";
if ($limits->{limit}) {
$query .= sprintf(' LIMIT %d,%d',
$limits->{offset} // 0,
$limits->{limit} // C4::Context->preference('PatronsPerPage'));
}
$data = $dbh->selectall_arrayref($query, {Slice => {}}, @bind);
# This assumes a lost barcode search will never match a patron's name.
# Not necessarily an absolute guarantee, but it's worth the performance tradeoff.
if (not scalar @$data) {
$query = q/
SELECT borrowers.*, categories.*
FROM borrowers
LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
LEFT JOIN statistics ON borrowers.borrowernumber = statistics.borrowernumber
WHERE statistics.type = 'card_replaced' AND statistics.other = ?
/;
($query, @bind) = _constrain_sql_by_branchcategory($query, $searchstring);
$sth = $dbh->prepare( $query );
$sth->execute( @bind );
my $prevcards_data = $sth->fetchall_arrayref({});
foreach my $row ( @$prevcards_data ) {
$row->{'PreviousCardnumber'} = 1;
}
$data = [ @$prevcards_data, @$data ];
}
return ( $row_count, $data );
}
sub SearchMemberBySQL {
my ( $query ) = @_;
my @sql_params;
($query, @sql_params) = _constrain_sql_by_branchcategory($query);
my $data = C4::Context->dbh->selectall_arrayref($query, {Slice=>{}}, @sql_params);
return (scalar @$data, $data);
}
=head2 GetMemberDetails
($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
Looks up a patron and returns information about him or her. If
C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
up the borrower by number; otherwise, it looks up the borrower by card
number.
C<$borrower> is a reference-to-hash whose keys are the fields of the
borrowers table in the Koha database. In addition,
C<$borrower-E<gt>{flags}> is a hash giving more detailed information
about the patron. Its keys act as flags :
if $borrower->{flags}->{LOST} {
# Patron's card was reported lost
}
If the state of a flag means that the patron should not be
allowed to borrow any more books, then it will have a C<noissues> key
with a true value.
See patronflags for more details.
C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
about the top-level permissions flags set for the borrower. For example,
if a user has the "editcatalogue" permission,
C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
the value "1".
=cut
# not an exported function
# used to get patron categories that are of type 'S' staff
sub GetStaffCategories
{
my $dbh = C4::Context->dbh;
my $sth = $dbh->prepare("SELECT categorycode FROM categories
WHERE category_type = 'S'");
$sth->execute();
my @all = ();
while (my $row = $sth->fetchrow_hashref()) {
push @all, $row->{categorycode};
}
return wantarray? @all : \@all;
}
sub GetMemberDetails {
my ( $borrowernumber, $cardnumber, $circ_session ) = @_;
$circ_session ||= {};
my $dbh = C4::Context->dbh;
my $sth;
my $sql = q{
SELECT borrowers.*, category_type, categories.description
FROM borrowers
LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
WHERE
};
my @params;
if ($borrowernumber) {
$sql .= ' borrowernumber=?';
push @params, $borrowernumber;
}
elsif ($cardnumber) {
$sql .= ' cardnumber=?';
push @params, $cardnumber;
}
else {
return;
}
($sql, @params) = _constrain_sql_by_branchcategory($sql, @params);
my $borrower = $dbh->selectrow_hashref($sql, undef, @params);
return if !$borrower;
my $amount = C4::Accounts::MemberAllAccounts(
borrowernumber => $borrower->{borrowernumber},
total_only => 1
);
$borrower->{'amountoutstanding'} = $amount;
# FIXME - just have patronflags return $amount
my $flags = patronflags( $borrower, $circ_session );
my $accessflagshash;
$sth = $dbh->prepare('SELECT bit,flag FROM userflags');
$sth->execute;
while ( my ( $bit, $flag ) = $sth->fetchrow ) {
if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
$accessflagshash->{$flag} = 1;
}
}
$sth->finish;
$borrower->{'flags'} = $flags;
$borrower->{'authflags'} = $accessflagshash;
# find out how long the membership lasts
$sth = $dbh->prepare(
'SELECT enrolmentperiod FROM categories WHERE categorycode = ?');
$sth->execute( $borrower->{'categorycode'} );
my $enrolment = $sth->fetchrow;
$borrower->{'enrolmentperiod'} = $enrolment;
return ($borrower); #, $flags, $accessflagshash);
}
=head2 patronflags
$flags = &patronflags($patron);
This function is not exported.
The following will be set where applicable:
$flags->{CHARGES}->{amount} Amount of debt
$flags->{CHARGES}->{noissues} Set if debt amount >$5.00
or circ_block_threshold by patron category
$flags->{CHARGES}->{message} Message -- deprecated
$flags->{CREDITS}->{amount} Amount of credit
$flags->{CREDITS}->{message} Message -- deprecated
$flags->{ GNA } Patron has no valid address
$flags->{ GNA }->{noissues} Set for each GNA
$flags->{ GNA }->{message} "Borrower has no valid address" -- deprecated
$flags->{ LOST } Patron's card reported lost
$flags->{ LOST }->{noissues} Set for each LOST
$flags->{ LOST }->{message} Message -- deprecated
$flags->{DBARRED} Set if patron debarred, no access
$flags->{DBARRED}->{noissues} Set for each DBARRED
$flags->{DBARRED}->{message} Message -- deprecated
$flags->{ NOTES }
$flags->{ NOTES }->{message} The note itself. NOT deprecated
$flags->{ ODUES } Set if patron has overdue books.
$flags->{ ODUES }->{message} "Yes" -- deprecated
$flags->{ ODUES }->{itemlist} ref-to-array: list of overdue books
$flags->{ ODUES }->{itemlisttext} Text list of overdue items -- deprecated
$flags->{WAITING} Set if any of patron's reserves are available
$flags->{WAITING}->{message} Message -- deprecated
$flags->{WAITING}->{itemlist} ref-to-array: list of available items
=over 4
C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
overdue items. Its elements are references-to-hash, each describing an
overdue item. The keys are selected fields from the issues, biblio,
biblioitems, and items tables of the Koha database.
C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
the overdue items, one per line. Deprecated.
C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
available items. Each element is a reference-to-hash whose keys are
fields from the reserves table of the Koha database.
=back
All the "message" fields that include language generated in this function are deprecated,
because such strings belong properly in the display layer.
The "message" field that comes from the DB is OK.
=cut
# TODO: use {anonymous => hashes} instead of a dozen %flaginfo
# FIXME rename this function.
sub patronflags {
my %flags;
my ( $patroninformation, $circ_session ) = @_;
$circ_session ||= {};
my $amount = C4::Accounts::MemberAllAccounts(
borrowernumber => $patroninformation->{'borrowernumber'},
total_only => 1
);
$amount //= 0;
my $cat = GetCategoryInfo($$patroninformation{categorycode});
if ( $amount > 0 ) {
my %flaginfo;
my $cat = GetCategoryInfo($$patroninformation{categorycode});
my $blockamount = (($$cat{circ_block_threshold}//0) > 0)? $$cat{circ_block_threshold} : 5;
$flaginfo{'message'} = sprintf "Patron owes \$%.02f", $amount;
$flaginfo{'amount'} = sprintf "%.02f",$amount;
if ( ($amount > $blockamount) && !$circ_session->{'charges_overridden'} ) {
$flaginfo{'noissues'} = 1;
}
$flags{'CHARGES'} = \%flaginfo;
}
elsif ( $amount < 0 ) {
my %flaginfo;
$flaginfo{'message'} = sprintf "Patron has credit of \$%.02f", -$amount;
$flaginfo{'amount'} = sprintf "%.02f", $amount;
$flags{'CREDITS'} = \%flaginfo;
}
if ($patroninformation->{'gonenoaddress'} ~~ 1) {
my %flaginfo;
$flaginfo{'message'} = 'Borrower has no valid address.';
$flaginfo{'noissues'} = 1;
$flags{'GNA'} = \%flaginfo;
}
if ($patroninformation->{'lost'} ~~ 1 ) {
my %flaginfo;
$flaginfo{'message'} = 'Borrower\'s card reported lost.';
$flaginfo{'noissues'} = 1;
$flags{'LOST'} = \%flaginfo;
}
if ($patroninformation->{'debarred'} ~~ 1) {
my %flaginfo;
$flaginfo{'message'} = 'Borrower is Debarred.';
$flaginfo{'noissues'} = 1;
$flags{'DBARRED'} = \%flaginfo;
}
if ($patroninformation->{'borrowernotes'}) {
my %flaginfo;
$flaginfo{'message'} = $patroninformation->{'borrowernotes'};
$flags{'NOTES'} = \%flaginfo;
}
my ( $odues, $itemsoverdue ) = checkoverdues($patroninformation->{'borrowernumber'});
if ( $odues > 0 ) {
my %flaginfo;
$flaginfo{'message'} = "Yes";
$flaginfo{'itemlist'} = $itemsoverdue;
foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
@$itemsoverdue )
{
my $dd = $$_{date_due} // '';
my $bc = $$_{barcode} // '';
my $ti = $$_{title} // '';
$flaginfo{'itemlisttext'} .= "$dd $bc $ti \n"; # newline is display layer
}
$flags{'ODUES'} = \%flaginfo;
}
my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
my $nowaiting = scalar @itemswaiting;
if ( $nowaiting > 0 ) {
my %flaginfo;
$flaginfo{'message'} = "Reserved items available";
$flaginfo{'itemlist'} = \@itemswaiting;
$flags{'WAITING'} = \%flaginfo;
}
return ( \%flags );
}
=head2 GetMember
$borrower = &GetMember($information, $type);
C<$type> should be one of 'borrowernumber', 'userid', or
'cardnumber' with C<$information> containing the appropriate value.
If not specified, C<$type> defaults to 'borrowernumber'.
Returns a reference-to-hash whose keys are the fields of
the C<borrowers> table in the Koha database. If the borrower is a staff
member, an additional 'worklibraries' arrayref is included in the fields.
=cut
#'
sub GetMember {
my ( $information, $type ) = @_;
$type //= 'borrowernumber';
my $select = qq{
SELECT borrowers.*, categories.category_type, categories.description
FROM borrowers
LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
WHERE $type = ?
};
my @params = ($information);
($select, @params) = _constrain_sql_by_branchcategory($select, @params);
my $borrower = C4::Context->dbh->selectrow_hashref($select, undef, @params);
return undef if !$borrower;
if ($borrower->{category_type} ~~ 'S') { # staff
$borrower->{worklibraries} = GetWorkLibraries($borrower->{borrowernumber});
}
return $borrower;
}
=head2 GetMemberIssuesAndFines
($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
Returns aggregate data about items borrowed by the patron with the
given borrowernumber.
C<&GetMemberIssuesAndFines> returns a three-element array. C<$overdue_count> is the
number of overdue items the patron currently has borrowed. C<$issue_count> is the
number of books the patron currently has borrowed. C<$total_fines> is
the total fine currently due by the borrower.
=cut
#'
sub GetMemberIssuesAndFines {
my ( $borrowernumber ) = @_;
my $dbh = C4::Context->dbh;
my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
$debug and warn $query."\n";
my $sth = $dbh->prepare($query);
$sth->execute($borrowernumber);
my $issue_count = $sth->fetchrow_arrayref->[0];
$sth->finish;
# subtract Claims Returned items
$sth = $dbh->prepare("SELECT COUNT(*) FROM lost_items
WHERE borrowernumber = ?
AND claims_returned = 1");
$sth->execute($borrowernumber);
$issue_count -= ($sth->fetchrow_array)[0];
$sth = $dbh->prepare(
"SELECT COUNT(*) FROM issues
WHERE borrowernumber = ?
AND date_due < now()"
);
$sth->execute($borrowernumber);
my $overdue_count = $sth->fetchrow_arrayref->[0];
$sth->finish;
$sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
$sth->execute($borrowernumber);
my $total_fines = $sth->fetchrow_arrayref->[0];
$sth->finish;
return ($overdue_count, $issue_count, $total_fines);
}
sub columns(;$) {
return @{C4::Context->dbh->selectcol_arrayref("SHOW columns from borrowers")};
}
=head2
=head2 ModMember
=over 4
my $success = ModMember(borrowernumber => $borrowernumber, [ field => value ]... );
Modify borrower's data. All date fields should ALREADY be in ISO format.
return :
true on success, or false on failure
=back
=cut
sub ModMember {
my (%data) = @_;
my $dbh = C4::Context->dbh;
my $member = GetMemberDetails( $data{'borrowernumber'} );
return if not defined $member;
if ( exists $data{'cardnumber'} and $member->{'cardnumber'} ne $data{'cardnumber'} ) {
my $branch = (C4::Context->userenv) ? C4::Context->userenv->{branch} : undef;
C4::Stats::UpdateStats( $branch, 'card_replaced', '', $member->{'cardnumber'}, '', '', $data{'borrowernumber'} );
}
my ($oldval,$newval);
my $staffnumber = C4::Context->userenv->{'number'};
delete $data{'staffnumber'};
my $worklibraries = $data{worklibrary};
delete $data{worklibrary};
my $sth;
my $query = "
INSERT INTO borrower_edits
(borrowernumber,staffnumber,field,before_value,after_value)
VALUES (?,?,?,?,?)";
foreach (keys %data) {
if ($member->{$_} ne $data{$_}) {
$oldval = $member->{$_};
$newval = $data{$_};
next if ($_ eq 'password' && ($newval eq '****'));
$sth = $dbh->prepare($query);
$sth->execute($data{'borrowernumber'},$staffnumber,$_,$oldval,$newval);
}
}
my $iso_re = C4::Dates->new()->regexp('iso');
foreach (qw(dateofbirth dateexpiry dateenrolled)) {
if (my $tempdate = $data{$_}) { # assignment, not comparison
($tempdate =~ /$iso_re/) and next; # Congatulations, you sent a valid ISO date.
warn "ModMember given $_ not in ISO format ($tempdate)";
my $tempdate2 = format_date_in_iso($tempdate);
if (!$tempdate2 or $tempdate2 eq '0000-00-00') {
warn "ModMember cannot convert '$tempdate' (from syspref to ISO)";
next;
}
$data{$_} = $tempdate2;
}
}
if (!$data{'dateofbirth'}){
delete $data{'dateofbirth'};
}
my @columns = &columns;
my %hashborrowerfields = (map {$_=>1} @columns);
$query = "UPDATE borrowers SET \n";
my @parameters;
# test to know if you must update or not the borrower password
if (exists $data{password}) {
if ($data{password} eq '****' or $data{password} eq '') {
delete $data{password};
} else {
$data{password} = md5_base64($data{password});
}
}
# modify cardnumber if necessary.
if(C4::Context->preference('patronbarcodelength') && exists($data{'cardnumber'})){
$data{'cardnumber'} = _prefix_cardnum(cardnumber=>$data{'cardnumber'});
# TODO : generate error if cardnumber does not match barcode schema,
# or length not sufficient to prefix without corrupting input string.
}
my @badkeys;
foreach (keys %data) {
next if ($_ eq 'borrowernumber' or $_ eq 'flags');
next if $_ eq 'select_city';
if ($hashborrowerfields{$_}){
$query .= " $_=?, ";
push @parameters,$data{$_};
} else {
push @badkeys, $_;
delete $data{$_};
}
}
(@badkeys) and warn scalar(@badkeys) . " Illegal key(s) passed to ModMember: " . join(',',@badkeys);
$query =~ s/, $//;
$query .= " WHERE borrowernumber=?";
push @parameters, $data{'borrowernumber'};
$debug and print STDERR "$query (executed w/ arg: $data{'borrowernumber'})";
$sth = $dbh->prepare($query);
my $execute_success = $sth->execute(@parameters);
$sth->finish;
# ok if its an adult (type) it may have borrowers that depend on it as a guarantor
# so when we update information for an adult we should check for guarantees and update the relevant part
# of their records, ie addresses and phone numbers
my $borrowercategory= GetBorrowercategory( $data{'category_type'} );
if ( exists $borrowercategory->{'category_type'} && $borrowercategory->{'category_type'} eq ('A' || 'S') ) {
# is adult check guarantees;
UpdateGuarantees(%data);
}
logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "$query (executed w/ arg: $data{'borrowernumber'})")
if C4::Context->preference("BorrowersLog");
# a staff member's work libraries
if (defined $worklibraries) {
$sth = $dbh->prepare("DELETE FROM borrower_worklibrary
WHERE borrowernumber = ?");
$sth->execute($data{borrowernumber});
foreach(@$worklibraries) {
$sth = $dbh->prepare("INSERT INTO borrower_worklibrary
(borrowernumber,branchcode) VALUES (?,?)");
$sth->execute($data{borrowernumber},$_);
}
}
return $execute_success;
}
sub GetWorkLibraries {
my $borrowernumber = shift;
my $branches
= C4::Context->dbh->selectcol_arrayref(q{
SELECT branchcode as worklibrary
FROM borrower_worklibrary
WHERE borrowernumber = ?
}, undef, $borrowernumber);
return wantarray ? @{$branches} : $branches;
}
=head2
=head2 AddMember
$borrowernumber = &AddMember(%borrower);
insert new borrower into table
Returns the borrowernumber
=cut
#'
sub AddMember {
my (%data) = @_;
my $dbh = C4::Context->dbh;
$data{'userid'} = '' unless $data{'password'};
$data{'password'} = md5_base64( $data{'password'} ) if $data{'password'};
$data{'cardnumber'} = _prefix_cardnum(cardnumber=>$data{'cardnumber'}) if(C4::Context->preference('patronbarcodelength'));
# WE SHOULD NEVER PASS THIS SUBROUTINE ANYTHING OTHER THAN ISO DATES
# IF YOU UNCOMMENT THESE LINES YOU BETTER HAVE A DARN COMPELLING REASON
# $data{'dateofbirth'} = format_date_in_iso( $data{'dateofbirth'} );
# $data{'dateenrolled'} = format_date_in_iso( $data{'dateenrolled'});
# $data{'dateexpiry'} = format_date_in_iso( $data{'dateexpiry'} );
# This query should be rewritten to use "?" at execute.
# Done -hQ
if (!$data{'dateofbirth'}){
undef ($data{'dateofbirth'});
}
$data{exclude_from_collection} ||= 0;
my @f = qw(cardnumber surname firstname title othernames initials
streetnumber streettype address address2 zipcode country city
phone email mobile phonepro opacnote guarantorid dateofbirth
branchcode categorycode dateenrolled contactname
borrowernotes dateexpiry contactnote
B_address B_address2 B_zipcode B_country B_city B_email
B_streetnumber B_streettype
password userid sort1 sort2
contacttitle emailpro contactfirstname
sex fax relationship gonenoaddress
exclude_from_collection lost debarred
ethnicity ethnotes
altcontactsurname altcontactfirstname
altcontactaddress1 altcontactaddress2 altcontactaddress3
altcontactzipcode altcontactcountry altcontactphone
disable_reading_history
);
my @params = ();
my $query = sprintf("insert into borrowers(%s) values(%s)",
join(',', @f),
join(',',map{'?'}@f),
);
foreach(@f) { push @params, $data{$_} };
my $sth = $dbh->prepare($query);
# print "Executing SQL: $query\n";
$sth->execute(@params) or die sprintf "Failed to insert member data: %s\n", $dbh->errstr;
$sth->finish;
$data{'borrowernumber'} = $dbh->{'mysql_insertid'}; # unneeded w/ autoincrement ?
# mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
# check for enrollment fee & add it if needed
$sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
$sth->execute($data{'categorycode'});
my ($enrolmentfee) = $sth->fetchrow;
if ($enrolmentfee && $enrolmentfee > 0) {
# insert fee in patron debts
C4::Accounts::manualinvoice(
borrowernumber => $data{'borrowernumber'},
accounttype => 'A',
amount => $enrolmentfee
);
}
# work libraries
if (@{$data{worklibrary} // []}) {
$sth = $dbh->prepare("DELETE FROM borrower_worklibrary
WHERE borrowernumber = ?") || die $dbh->errstr();
$sth->execute($data{borrowernumber});
foreach(@{$data{worklibrary}}) {
$sth = $dbh->prepare("INSERT INTO borrower_worklibrary
(borrowernumber,branchcode) VALUES(?,?)") || die $dbh->errstr();
$sth->execute($data{borrowernumber},$_) || die $dbh->errstr();
}
}
return $data{'borrowernumber'};
}
sub Check_Userid {
my ($uid,$member) = @_;
my $dbh = C4::Context->dbh;
# Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
# Then we need to tell the user and have them create a new one.
my $sth =
$dbh->prepare(
"SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
$sth->execute( $uid, $member );
if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
return 0;
}
else {
return 1;
}
}
sub Generate_Userid {
my ($borrowernumber, $firstname, $surname) = @_;
my $newuid;
my $offset = 0;
do {
$firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
$surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
$newuid = lc("$firstname.$surname");
$newuid .= $offset unless $offset == 0;
$offset++;
} while (!Check_Userid($newuid,$borrowernumber));
return $newuid;
}
sub changepassword {
my ( $uid, $member, $digest ) = @_;
my $dbh = C4::Context->dbh;
#Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
#Then we need to tell the user and have them create a new one.
my $resultcode;
my $sth =
$dbh->prepare(
"SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
$sth->execute( $uid, $member );
if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
$resultcode=0;
}
else {
#Everything is good so we can update the information.
$sth =
$dbh->prepare(
"update borrowers set userid=?, password=? where borrowernumber=?");
$sth->execute( $uid, $digest, $member );
$resultcode=1;
}
logaction("MEMBERS", "CHANGE PASS", $member, "") if C4::Context->preference("BorrowersLog");
return $resultcode;
}
=head2 fixup_cardnumber
get next available cardnumber.
Warning: The caller is responsible for locking the members table in write
mode, to avoid database corruption.
=cut
use vars qw( @weightings );
my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
sub fixup_cardnumber {
my ($cardnumber, $branch) = @_;
my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
# Find out whether member numbers should be generated
# automatically. Should be either "1" or something else.
# Defaults to "0", which is interpreted as "no".
($autonumber_members) or return $cardnumber;
my $checkdigit = C4::Context->preference('checkdigit');
my $dbh = C4::Context->dbh;
if ( $checkdigit and $checkdigit eq 'katipo' ) {
# if checkdigit is selected, calculate katipo-style cardnumber.
# purpose: generate checksum'd member numbers.
# We'll assume we just got the max value of digits 2-8 of member #'s
# from the database and our job is to increment that by one,
# determine the 1st and 9th digits and return the full string.
my $sth = $dbh->prepare(
"select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
);
$sth->execute;
my $data = $sth->fetchrow_hashref;
$cardnumber = $data->{new_num};
if ( !$cardnumber ) { # If DB has no values,
$cardnumber = 1000000; # start at 1000000
} else {
$cardnumber += 1;
}
my $sum = 0;
for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
# read weightings, left to right, 1 char at a time
my $temp1 = $weightings[$i];
# sequence left to right, 1 char at a time
my $temp2 = substr( $cardnumber, $i, 1 );
# mult each char 1-7 by its corresponding weighting
$sum += $temp1 * $temp2;
}