3 # Copyright 2000-2003 Katipo Communications
4 # Copyright 2010 BibLibre
5 # Parts Copyright 2010 Catalyst IT
7 # This file is part of Koha.
9 # Koha is free software; you can redistribute it and/or modify it under the
10 # terms of the GNU General Public License as published by the Free Software
11 # Foundation; either version 2 of the License, or (at your option) any later
14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
16 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License along
19 # with Koha; if not, write to the Free Software Foundation, Inc.,
20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 #use warnings; FIXME - Bug 2505
26 use C4::Dates qw(format_date_in_iso format_date);
27 use Digest::MD5 qw(md5_base64);
28 use String::Random qw( random_string );
29 use Date::Calc qw/Today Add_Delta_YM check_date Date_to_Days/;
30 use C4::Log; # logaction
36 use C4::SQLHelper qw(InsertInTable UpdateInTable SearchInTable);
37 use C4::Members::Attributes qw(SearchIdMatchingAttribute);
38 use C4::NewsChannels; #get slip news
40 use DateTime::Format::DateParse;
42 use Text::Unaccent qw( unac_string );
44 our ($VERSION,@ISA,@EXPORT,@EXPORT_OK,$debug);
47 $VERSION = 3.07.00.049;
48 $debug = $ENV{DEBUG} || 0;
60 &GetMemberIssuesAndFines
68 &GetFirstValidEmailAddress
81 &GetHideLostItemsPreference
84 &GetMemberAccountRecords
85 &GetBorNotifyAcctRecord
89 GetBorrowerCategorycode
90 &GetBorrowercategoryList
92 &GetBorrowersToExpunge
93 &GetBorrowersWhoHaveNeverBorrowed
94 &GetBorrowersWithIssuesHistoryOlderThan
104 GetBorrowersWithEmail
125 &ExtendMemberSubscriptionTo
143 C4::Members - Perl Module containing convenience functions for member handling
151 This module contains routines for adding, modifying and deleting members/patrons/borrowers
157 $borrowers_result_array_ref = &Search($filter,$orderby, $limit,
158 $columns_out, $search_on_fields,$searchtype);
160 Looks up patrons (borrowers) on filter. A wrapper for SearchInTable('borrowers').
162 For C<$filter>, C<$orderby>, C<$limit>, C<&columns_out>, C<&search_on_fields> and C<&searchtype>
163 refer to C4::SQLHelper:SearchInTable().
165 Special C<$filter> key '' is effectively expanded to search on surname firstname othernamescw
166 and cardnumber unless C<&search_on_fields> is defined
170 $borrowers = Search('abcd', 'cardnumber');
172 $borrowers = Search({''=>'abcd', category_type=>'I'}, 'surname');
176 sub _express_member_find {
179 # this is used by circulation everytime a new borrowers cardnumber is scanned
180 # so we can check an exact match first, if that works return, otherwise do the rest
181 my $dbh = C4::Context->dbh;
182 my $query = "SELECT borrowernumber FROM borrowers WHERE cardnumber = ?";
183 if ( my $borrowernumber = $dbh->selectrow_array($query, undef, $filter) ) {
184 return( {"borrowernumber"=>$borrowernumber} );
187 my ($search_on_fields, $searchtype);
188 if ( length($filter) == 1 ) {
189 $search_on_fields = [ qw(surname) ];
190 $searchtype = 'start_with';
192 $search_on_fields = [ qw(surname firstname othernames cardnumber) ];
193 $searchtype = 'contain';
196 return (undef, $search_on_fields, $searchtype);
200 my ( $filter, $orderby, $limit, $columns_out, $search_on_fields, $searchtype ) = @_;
205 if ( my $fr = ref $filter ) {
206 if ( $fr eq "HASH" ) {
207 if ( my $search_string = $filter->{''} ) {
208 my ($member_filter, $member_search_on_fields, $member_searchtype) = _express_member_find($search_string);
209 if ($member_filter) {
210 $filter = $member_filter;
213 $search_on_fields ||= $member_search_on_fields;
214 $searchtype ||= $member_searchtype;
219 $search_string = $filter;
223 $search_string = $filter;
224 my ($member_filter, $member_search_on_fields, $member_searchtype) = _express_member_find($search_string);
225 if ($member_filter) {
226 $filter = $member_filter;
229 $search_on_fields ||= $member_search_on_fields;
230 $searchtype ||= $member_searchtype;
234 if ( !$found_borrower && C4::Context->preference('ExtendedPatronAttributes') && $search_string ) {
235 my $matching_records = C4::Members::Attributes::SearchIdMatchingAttribute($search_string);
236 if(scalar(@$matching_records)>0) {
237 if ( my $fr = ref $filter ) {
238 if ( $fr eq "HASH" ) {
240 $filter = [ $filter ];
242 push @$filter, { %f, "borrowernumber"=>$$matching_records };
245 push @$filter, {"borrowernumber"=>$matching_records};
249 $filter = [ $filter ];
250 push @$filter, {"borrowernumber"=>$matching_records};
255 # $showallbranches was not used at the time SearchMember() was mainstreamed into Search().
256 # Mentioning for the reference
258 if ( C4::Context->preference("IndependantBranches") ) { # && !$showallbranches){
259 if ( my $userenv = C4::Context->userenv ) {
260 my $branch = $userenv->{'branch'};
261 if ( ($userenv->{flags} % 2 !=1) && $branch ){
262 if (my $fr = ref $filter) {
263 if ( $fr eq "HASH" ) {
264 $filter->{branchcode} = $branch;
268 $_ = { '' => $_ } unless ref $_;
269 $_->{branchcode} = $branch;
274 $filter = { '' => $filter, branchcode => $branch };
280 if ($found_borrower) {
281 $searchtype = "exact";
283 $searchtype ||= "start_with";
285 return SearchInTable( "borrowers", $filter, $orderby, $limit, $columns_out, $search_on_fields, $searchtype );
288 =head2 GetMemberDetails
290 ($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
292 Looks up a patron and returns information about him or her. If
293 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
294 up the borrower by number; otherwise, it looks up the borrower by card
297 C<$borrower> is a reference-to-hash whose keys are the fields of the
298 borrowers table in the Koha database. In addition,
299 C<$borrower-E<gt>{flags}> is a hash giving more detailed information
300 about the patron. Its keys act as flags :
302 if $borrower->{flags}->{LOST} {
303 # Patron's card was reported lost
306 If the state of a flag means that the patron should not be
307 allowed to borrow any more books, then it will have a C<noissues> key
310 See patronflags for more details.
312 C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
313 about the top-level permissions flags set for the borrower. For example,
314 if a user has the "editcatalogue" permission,
315 C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
320 sub GetMemberDetails {
321 my ( $borrowernumber, $cardnumber ) = @_;
322 my $dbh = C4::Context->dbh;
325 if ($borrowernumber) {
326 $sth = $dbh->prepare("SELECT borrowers.*,category_type,categories.description,reservefee,enrolmentperiod FROM borrowers LEFT JOIN categories ON borrowers.categorycode=categories.categorycode WHERE borrowernumber=?");
327 $sth->execute($borrowernumber);
329 elsif ($cardnumber) {
330 $sth = $dbh->prepare("SELECT borrowers.*,category_type,categories.description,reservefee,enrolmentperiod FROM borrowers LEFT JOIN categories ON borrowers.categorycode=categories.categorycode WHERE cardnumber=?");
331 $sth->execute($cardnumber);
336 my $borrower = $sth->fetchrow_hashref;
337 my ($amount) = GetMemberAccountRecords( $borrowernumber);
338 $borrower->{'amountoutstanding'} = $amount;
339 # FIXME - patronflags calls GetMemberAccountRecords... just have patronflags return $amount
340 my $flags = patronflags( $borrower);
343 $sth = $dbh->prepare("select bit,flag from userflags");
345 while ( my ( $bit, $flag ) = $sth->fetchrow ) {
346 if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
347 $accessflagshash->{$flag} = 1;
350 $borrower->{'flags'} = $flags;
351 $borrower->{'authflags'} = $accessflagshash;
353 # For the purposes of making templates easier, we'll define a
354 # 'showname' which is the alternate form the user's first name if
355 # 'other name' is defined.
356 if ($borrower->{category_type} eq 'I') {
357 $borrower->{'showname'} = $borrower->{'othernames'};
358 $borrower->{'showname'} .= " $borrower->{'firstname'}" if $borrower->{'firstname'};
360 $borrower->{'showname'} = $borrower->{'firstname'};
363 return ($borrower); #, $flags, $accessflagshash);
368 $flags = &patronflags($patron);
370 This function is not exported.
372 The following will be set where applicable:
373 $flags->{CHARGES}->{amount} Amount of debt
374 $flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge)
375 $flags->{CHARGES}->{message} Message -- deprecated
377 $flags->{CREDITS}->{amount} Amount of credit
378 $flags->{CREDITS}->{message} Message -- deprecated
380 $flags->{ GNA } Patron has no valid address
381 $flags->{ GNA }->{noissues} Set for each GNA
382 $flags->{ GNA }->{message} "Borrower has no valid address" -- deprecated
384 $flags->{ LOST } Patron's card reported lost
385 $flags->{ LOST }->{noissues} Set for each LOST
386 $flags->{ LOST }->{message} Message -- deprecated
388 $flags->{DBARRED} Set if patron debarred, no access
389 $flags->{DBARRED}->{noissues} Set for each DBARRED
390 $flags->{DBARRED}->{message} Message -- deprecated
393 $flags->{ NOTES }->{message} The note itself. NOT deprecated
395 $flags->{ ODUES } Set if patron has overdue books.
396 $flags->{ ODUES }->{message} "Yes" -- deprecated
397 $flags->{ ODUES }->{itemlist} ref-to-array: list of overdue books
398 $flags->{ ODUES }->{itemlisttext} Text list of overdue items -- deprecated
400 $flags->{WAITING} Set if any of patron's reserves are available
401 $flags->{WAITING}->{message} Message -- deprecated
402 $flags->{WAITING}->{itemlist} ref-to-array: list of available items
406 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
407 overdue items. Its elements are references-to-hash, each describing an
408 overdue item. The keys are selected fields from the issues, biblio,
409 biblioitems, and items tables of the Koha database.
411 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
412 the overdue items, one per line. Deprecated.
414 =item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
415 available items. Each element is a reference-to-hash whose keys are
416 fields from the reserves table of the Koha database.
420 All the "message" fields that include language generated in this function are deprecated,
421 because such strings belong properly in the display layer.
423 The "message" field that comes from the DB is OK.
427 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
428 # FIXME rename this function.
431 my ( $patroninformation) = @_;
432 my $dbh=C4::Context->dbh;
433 my ($balance, $owing) = GetMemberAccountBalance( $patroninformation->{'borrowernumber'});
436 my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
437 $flaginfo{'message'} = sprintf "Patron owes \$%.02f", $owing;
438 $flaginfo{'amount'} = sprintf "%.02f", $owing;
439 if ( $owing > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
440 $flaginfo{'noissues'} = 1;
442 $flags{'CHARGES'} = \%flaginfo;
444 elsif ( $balance < 0 ) {
446 $flaginfo{'message'} = sprintf "Patron has credit of \$%.02f", -$balance;
447 $flaginfo{'amount'} = sprintf "%.02f", $balance;
448 $flags{'CREDITS'} = \%flaginfo;
450 if ( $patroninformation->{'gonenoaddress'}
451 && $patroninformation->{'gonenoaddress'} == 1 )
454 $flaginfo{'message'} = 'Borrower has no valid address.';
455 $flaginfo{'noissues'} = 1;
456 $flags{'GNA'} = \%flaginfo;
458 if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
460 $flaginfo{'message'} = 'Borrower\'s card reported lost.';
461 $flaginfo{'noissues'} = 1;
462 $flags{'LOST'} = \%flaginfo;
464 if ( $patroninformation->{'debarred'} && check_date( split( /-/, $patroninformation->{'debarred'} ) ) ) {
465 if ( Date_to_Days(Date::Calc::Today) < Date_to_Days( split( /-/, $patroninformation->{'debarred'} ) ) ) {
467 $flaginfo{'debarredcomment'} = $patroninformation->{'debarredcomment'};
468 $flaginfo{'message'} = $patroninformation->{'debarredcomment'};
469 $flaginfo{'noissues'} = 1;
470 $flaginfo{'dateend'} = $patroninformation->{'debarred'};
471 $flags{'DBARRED'} = \%flaginfo;
474 if ( $patroninformation->{'borrowernotes'}
475 && $patroninformation->{'borrowernotes'} )
478 $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
479 $flags{'NOTES'} = \%flaginfo;
481 my ( $odues, $itemsoverdue ) = C4::Overdues::checkoverdues($patroninformation->{'borrowernumber'});
482 if ( $odues && $odues > 0 ) {
484 $flaginfo{'message'} = "Yes";
485 $flaginfo{'itemlist'} = $itemsoverdue;
486 foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
489 $flaginfo{'itemlisttext'} .=
490 "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n"; # newline is display layer
492 $flags{'ODUES'} = \%flaginfo;
494 my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
495 my $nowaiting = scalar @itemswaiting;
496 if ( $nowaiting > 0 ) {
498 $flaginfo{'message'} = "Reserved items available";
499 $flaginfo{'itemlist'} = \@itemswaiting;
500 $flags{'WAITING'} = \%flaginfo;
508 $borrower = &GetMember(%information);
510 Retrieve the first patron record meeting on criteria listed in the
511 C<%information> hash, which should contain one or more
512 pairs of borrowers column names and values, e.g.,
514 $borrower = GetMember(borrowernumber => id);
516 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
517 the C<borrowers> table in the Koha database.
519 FIXME: GetMember() is used throughout the code as a lookup
520 on a unique key such as the borrowernumber, but this meaning is not
521 enforced in the routine itself.
527 my ( %information ) = @_;
528 if (exists $information{borrowernumber} && !defined $information{borrowernumber}) {
529 #passing mysql's kohaadmin?? Makes no sense as a query
532 my $dbh = C4::Context->dbh;
534 q{SELECT borrowers.*, categories.category_type, categories.description
536 LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
539 for (keys %information ) {
547 if (defined $information{$_}) {
549 push @values, $information{$_};
552 $select .= "$_ IS NULL";
555 $debug && warn $select, " ",values %information;
556 my $sth = $dbh->prepare("$select");
557 $sth->execute(map{$information{$_}} keys %information);
558 my $data = $sth->fetchall_arrayref({});
559 #FIXME interface to this routine now allows generation of a result set
560 #so whole array should be returned but bowhere in the current code expects this
568 =head2 GetMemberRelatives
570 @borrowernumbers = GetMemberRelatives($borrowernumber);
572 C<GetMemberRelatives> returns a borrowersnumber's list of guarantor/guarantees of the member given in parameter
575 sub GetMemberRelatives {
576 my $borrowernumber = shift;
577 my $dbh = C4::Context->dbh;
581 my $query = "SELECT guarantorid FROM borrowers WHERE borrowernumber=?";
582 my $sth = $dbh->prepare($query);
583 $sth->execute($borrowernumber);
584 my $data = $sth->fetchrow_arrayref();
585 push @glist, $data->[0] if $data->[0];
586 my $guarantor = $data->[0] ? $data->[0] : undef;
589 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
590 $sth = $dbh->prepare($query);
591 $sth->execute($borrowernumber);
592 while ($data = $sth->fetchrow_arrayref()) {
593 push @glist, $data->[0];
596 # Getting sibling guarantees
598 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
599 $sth = $dbh->prepare($query);
600 $sth->execute($guarantor);
601 while ($data = $sth->fetchrow_arrayref()) {
602 push @glist, $data->[0] if ($data->[0] != $borrowernumber);
609 =head2 IsMemberBlocked
611 my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
613 Returns whether a patron has overdue items that may result
614 in a block or whether the patron has active fine days
615 that would block circulation privileges.
617 C<$block_status> can have the following values:
619 1 if the patron has outstanding fine days, in which case C<$count> is the number of them
621 -1 if the patron has overdue items, in which case C<$count> is the number of them
623 0 if the patron has no overdue items or outstanding fine days, in which case C<$count> is 0
625 Outstanding fine days are checked before current overdue items
628 FIXME: this needs to be split into two functions; a potential block
629 based on the number of current overdue items could be orthogonal
630 to a block based on whether the patron has any fine days accrued.
634 sub IsMemberBlocked {
635 my $borrowernumber = shift;
636 my $dbh = C4::Context->dbh;
638 my $blockeddate = CheckBorrowerDebarred($borrowernumber);
640 return ( 1, $blockeddate ) if $blockeddate;
642 # if he have late issues
643 my $sth = $dbh->prepare(
644 "SELECT COUNT(*) as latedocs
646 WHERE borrowernumber = ?
647 AND date_due < now()"
649 $sth->execute($borrowernumber);
650 my $latedocs = $sth->fetchrow_hashref->{'latedocs'};
652 return ( -1, $latedocs ) if $latedocs > 0;
657 =head2 GetMemberIssuesAndFines
659 ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
661 Returns aggregate data about items borrowed by the patron with the
662 given borrowernumber.
664 C<&GetMemberIssuesAndFines> returns a three-element array. C<$overdue_count> is the
665 number of overdue items the patron currently has borrowed. C<$issue_count> is the
666 number of books the patron currently has borrowed. C<$total_fines> is
667 the total fine currently due by the borrower.
672 sub GetMemberIssuesAndFines {
673 my ( $borrowernumber ) = @_;
674 my $dbh = C4::Context->dbh;
675 my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
677 $debug and warn $query."\n";
678 my $sth = $dbh->prepare($query);
679 $sth->execute($borrowernumber);
680 my $issue_count = $sth->fetchrow_arrayref->[0];
682 $sth = $dbh->prepare(
683 "SELECT COUNT(*) FROM issues
684 WHERE borrowernumber = ?
685 AND date_due < now()"
687 $sth->execute($borrowernumber);
688 my $overdue_count = $sth->fetchrow_arrayref->[0];
690 $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
691 $sth->execute($borrowernumber);
692 my $total_fines = $sth->fetchrow_arrayref->[0];
694 return ($overdue_count, $issue_count, $total_fines);
698 return @{C4::Context->dbh->selectcol_arrayref("SHOW columns from borrowers")};
703 my $success = ModMember(borrowernumber => $borrowernumber,
704 [ field => value ]... );
706 Modify borrower's data. All date fields should ALREADY be in ISO format.
709 true on success, or false on failure
715 # test to know if you must update or not the borrower password
716 if (exists $data{password}) {
717 if ($data{password} eq '****' or $data{password} eq '') {
718 delete $data{password};
720 $data{password} = md5_base64($data{password});
723 my $execute_success=UpdateInTable("borrowers",\%data);
724 if ($execute_success) { # only proceed if the update was a success
725 # ok if its an adult (type) it may have borrowers that depend on it as a guarantor
726 # so when we update information for an adult we should check for guarantees and update the relevant part
727 # of their records, ie addresses and phone numbers
728 my $borrowercategory= GetBorrowercategory( $data{'category_type'} );
729 if ( exists $borrowercategory->{'category_type'} && $borrowercategory->{'category_type'} eq ('A' || 'S') ) {
730 # is adult check guarantees;
731 UpdateGuarantees(%data);
733 logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
735 return $execute_success;
741 $borrowernumber = &AddMember(%borrower);
743 insert new borrower into table
744 Returns the borrowernumber upon success
746 Returns as undef upon any db error without further processing
753 my $dbh = C4::Context->dbh;
755 # generate a proper login if none provided
756 $data{'userid'} = Generate_Userid($data{'borrowernumber'}, $data{'firstname'}, $data{'surname'}) if $data{'userid'} eq '';
758 # add expiration date if it isn't already there
759 unless ( $data{'dateexpiry'} ) {
760 $data{'dateexpiry'} = GetExpiryDate( $data{'categorycode'}, C4::Dates->new()->output("iso") );
763 # add enrollment date if it isn't already there
764 unless ( $data{'dateenrolled'} ) {
765 $data{'dateenrolled'} = C4::Dates->new()->output("iso");
768 # create a disabled account if no password provided
769 $data{'password'} = ($data{'password'})? md5_base64($data{'password'}) : '!';
770 $data{'borrowernumber'}=InsertInTable("borrowers",\%data);
773 # mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
774 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
776 # check for enrollment fee & add it if needed
777 my $sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
778 $sth->execute($data{'categorycode'});
779 my ($enrolmentfee) = $sth->fetchrow;
781 warn sprintf('Database returned the following error: %s', $sth->errstr);
784 if ($enrolmentfee && $enrolmentfee > 0) {
785 # insert fee in patron debts
786 manualinvoice($data{'borrowernumber'}, '', '', 'A', $enrolmentfee);
789 return $data{'borrowernumber'};
794 my ($uid,$member) = @_;
795 my $dbh = C4::Context->dbh;
796 # Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
797 # Then we need to tell the user and have them create a new one.
800 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
801 $sth->execute( $uid, $member );
802 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
810 sub Generate_Userid {
811 my ($borrowernumber, $firstname, $surname) = @_;
815 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
816 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
817 $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
818 $newuid = unac_string('utf-8',$newuid);
819 $newuid .= $offset unless $offset == 0;
822 } while (!Check_Userid($newuid,$borrowernumber));
828 my ( $uid, $member, $digest ) = @_;
829 my $dbh = C4::Context->dbh;
831 #Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
832 #Then we need to tell the user and have them create a new one.
836 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
837 $sth->execute( $uid, $member );
838 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
842 #Everything is good so we can update the information.
845 "update borrowers set userid=?, password=? where borrowernumber=?");
846 $sth->execute( $uid, $digest, $member );
850 logaction("MEMBERS", "CHANGE PASS", $member, "") if C4::Context->preference("BorrowersLog");
856 =head2 fixup_cardnumber
858 Warning: The caller is responsible for locking the members table in write
859 mode, to avoid database corruption.
863 use vars qw( @weightings );
864 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
866 sub fixup_cardnumber {
867 my ($cardnumber) = @_;
868 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
870 # Find out whether member numbers should be generated
871 # automatically. Should be either "1" or something else.
872 # Defaults to "0", which is interpreted as "no".
874 # if ($cardnumber !~ /\S/ && $autonumber_members) {
875 ($autonumber_members) or return $cardnumber;
876 my $checkdigit = C4::Context->preference('checkdigit');
877 my $dbh = C4::Context->dbh;
878 if ( $checkdigit and $checkdigit eq 'katipo' ) {
880 # if checkdigit is selected, calculate katipo-style cardnumber.
881 # otherwise, just use the max()
882 # purpose: generate checksum'd member numbers.
883 # We'll assume we just got the max value of digits 2-8 of member #'s
884 # from the database and our job is to increment that by one,
885 # determine the 1st and 9th digits and return the full string.
886 my $sth = $dbh->prepare(
887 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
890 my $data = $sth->fetchrow_hashref;
891 $cardnumber = $data->{new_num};
892 if ( !$cardnumber ) { # If DB has no values,
893 $cardnumber = 1000000; # start at 1000000
899 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
900 # read weightings, left to right, 1 char at a time
901 my $temp1 = $weightings[$i];
903 # sequence left to right, 1 char at a time
904 my $temp2 = substr( $cardnumber, $i, 1 );
906 # mult each char 1-7 by its corresponding weighting
907 $sum += $temp1 * $temp2;
910 my $rem = ( $sum % 11 );
911 $rem = 'X' if $rem == 10;
913 return "V$cardnumber$rem";
916 my $sth = $dbh->prepare(
917 'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
920 my ($result) = $sth->fetchrow;
923 return $cardnumber; # just here as a fallback/reminder
928 ($num_children, $children_arrayref) = &GetGuarantees($parent_borrno);
929 $child0_cardno = $children_arrayref->[0]{"cardnumber"};
930 $child0_borrno = $children_arrayref->[0]{"borrowernumber"};
932 C<&GetGuarantees> takes a borrower number (e.g., that of a patron
933 with children) and looks up the borrowers who are guaranteed by that
934 borrower (i.e., the patron's children).
936 C<&GetGuarantees> returns two values: an integer giving the number of
937 borrowers guaranteed by C<$parent_borrno>, and a reference to an array
938 of references to hash, which gives the actual results.
944 my ($borrowernumber) = @_;
945 my $dbh = C4::Context->dbh;
948 "select cardnumber,borrowernumber, firstname, surname from borrowers where guarantorid=?"
950 $sth->execute($borrowernumber);
953 my $data = $sth->fetchall_arrayref({});
954 return ( scalar(@$data), $data );
957 =head2 UpdateGuarantees
959 &UpdateGuarantees($parent_borrno);
962 C<&UpdateGuarantees> borrower data for an adult and updates all the guarantees
963 with the modified information
968 sub UpdateGuarantees {
970 my $dbh = C4::Context->dbh;
971 my ( $count, $guarantees ) = GetGuarantees( $data{'borrowernumber'} );
972 foreach my $guarantee (@$guarantees){
973 my $guaquery = qq|UPDATE borrowers
974 SET address=?,fax=?,B_city=?,mobile=?,city=?,phone=?
975 WHERE borrowernumber=?
977 my $sth = $dbh->prepare($guaquery);
978 $sth->execute($data{'address'},$data{'fax'},$data{'B_city'},$data{'mobile'},$data{'city'},$data{'phone'},$guarantee->{'borrowernumber'});
981 =head2 GetPendingIssues
983 my $issues = &GetPendingIssues(@borrowernumber);
985 Looks up what the patron with the given borrowernumber has borrowed.
987 C<&GetPendingIssues> returns a
988 reference-to-array where each element is a reference-to-hash; the
989 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
990 The keys include C<biblioitems> fields except marc and marcxml.
995 sub GetPendingIssues {
996 my @borrowernumbers = @_;
998 unless (@borrowernumbers ) { # return a ref_to_array
999 return \@borrowernumbers; # to not cause surprise to caller
1002 # Borrowers part of the query
1004 for (my $i = 0; $i < @borrowernumbers; $i++) {
1005 $bquery .= ' issues.borrowernumber = ?';
1006 if ($i < $#borrowernumbers ) {
1011 # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
1012 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
1013 # FIXME: circ/ciculation.pl tries to sort by timestamp!
1014 # FIXME: namespace collision: other collisions possible.
1015 # FIXME: most of this data isn't really being used by callers.
1022 biblioitems.itemtype,
1025 biblioitems.publicationyear,
1026 biblioitems.publishercode,
1027 biblioitems.volumedate,
1028 biblioitems.volumedesc,
1031 borrowers.firstname,
1033 borrowers.cardnumber,
1034 issues.timestamp AS timestamp,
1035 issues.renewals AS renewals,
1036 issues.borrowernumber AS borrowernumber,
1037 items.renewals AS totalrenewals
1039 LEFT JOIN items ON items.itemnumber = issues.itemnumber
1040 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1041 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
1042 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
1045 ORDER BY issues.issuedate"
1048 my $sth = C4::Context->dbh->prepare($query);
1049 $sth->execute(@borrowernumbers);
1050 my $data = $sth->fetchall_arrayref({});
1051 my $tz = C4::Context->tz();
1052 my $today = DateTime->now( time_zone => $tz);
1053 foreach (@{$data}) {
1054 if ($_->{issuedate}) {
1055 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
1057 $_->{date_due} or next;
1058 $_->{date_due} = DateTime::Format::DateParse->parse_datetime($_->{date_due}, $tz->name());
1059 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
1068 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
1070 Looks up what the patron with the given borrowernumber has borrowed,
1071 and sorts the results.
1073 C<$sortkey> is the name of a field on which to sort the results. This
1074 should be the name of a field in the C<issues>, C<biblio>,
1075 C<biblioitems>, or C<items> table in the Koha database.
1077 C<$limit> is the maximum number of results to return.
1079 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
1080 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
1081 C<items> tables of the Koha database.
1087 my ( $borrowernumber, $order, $limit ) = @_;
1089 my $dbh = C4::Context->dbh;
1091 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1093 LEFT JOIN items on items.itemnumber=issues.itemnumber
1094 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1095 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1096 WHERE borrowernumber=?
1098 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1100 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
1101 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1102 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1103 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
1104 order by ' . $order;
1106 $query .= " limit $limit";
1109 my $sth = $dbh->prepare($query);
1110 $sth->execute( $borrowernumber, $borrowernumber );
1111 return $sth->fetchall_arrayref( {} );
1115 =head2 GetMemberAccountRecords
1117 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
1119 Looks up accounting data for the patron with the given borrowernumber.
1121 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
1122 reference-to-array, where each element is a reference-to-hash; the
1123 keys are the fields of the C<accountlines> table in the Koha database.
1124 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1125 total amount outstanding for all of the account lines.
1129 sub GetMemberAccountRecords {
1130 my ($borrowernumber) = @_;
1131 my $dbh = C4::Context->dbh;
1137 WHERE borrowernumber=?);
1138 $strsth.=" ORDER BY date desc,timestamp DESC";
1139 my $sth= $dbh->prepare( $strsth );
1140 $sth->execute( $borrowernumber );
1143 while ( my $data = $sth->fetchrow_hashref ) {
1144 if ( $data->{itemnumber} ) {
1145 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1146 $data->{biblionumber} = $biblio->{biblionumber};
1147 $data->{title} = $biblio->{title};
1149 $acctlines[$numlines] = $data;
1151 $total += int(1000 * $data->{'amountoutstanding'}); # convert float to integer to avoid round-off errors
1154 return ( $total, \@acctlines,$numlines);
1157 =head2 GetMemberAccountBalance
1159 ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
1161 Calculates amount immediately owing by the patron - non-issue charges.
1162 Based on GetMemberAccountRecords.
1163 Charges exempt from non-issue are:
1165 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
1166 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
1170 sub GetMemberAccountBalance {
1171 my ($borrowernumber) = @_;
1173 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
1175 my @not_fines = ('Res');
1176 push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
1177 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
1178 my $dbh = C4::Context->dbh;
1179 my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
1180 push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
1182 my %not_fine = map {$_ => 1} @not_fines;
1184 my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
1185 my $other_charges = 0;
1186 foreach (@$acctlines) {
1187 $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
1190 return ( $total, $total - $other_charges, $other_charges);
1193 =head2 GetBorNotifyAcctRecord
1195 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1197 Looks up accounting data for the patron with the given borrowernumber per file number.
1199 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1200 reference-to-array, where each element is a reference-to-hash; the
1201 keys are the fields of the C<accountlines> table in the Koha database.
1202 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1203 total amount outstanding for all of the account lines.
1207 sub GetBorNotifyAcctRecord {
1208 my ( $borrowernumber, $notifyid ) = @_;
1209 my $dbh = C4::Context->dbh;
1212 my $sth = $dbh->prepare(
1215 WHERE borrowernumber=?
1217 AND amountoutstanding != '0'
1218 ORDER BY notify_id,accounttype
1221 $sth->execute( $borrowernumber, $notifyid );
1223 while ( my $data = $sth->fetchrow_hashref ) {
1224 if ( $data->{itemnumber} ) {
1225 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1226 $data->{biblionumber} = $biblio->{biblionumber};
1227 $data->{title} = $biblio->{title};
1229 $acctlines[$numlines] = $data;
1231 $total += int(100 * $data->{'amountoutstanding'});
1234 return ( $total, \@acctlines, $numlines );
1237 =head2 checkuniquemember (OUEST-PROVENCE)
1239 ($result,$categorycode) = &checkuniquemember($collectivity,$surname,$firstname,$dateofbirth);
1241 Checks that a member exists or not in the database.
1243 C<&result> is nonzero (=exist) or 0 (=does not exist)
1244 C<&categorycode> is from categorycode table
1245 C<&collectivity> is 1 (= we add a collectivity) or 0 (= we add a physical member)
1246 C<&surname> is the surname
1247 C<&firstname> is the firstname (only if collectivity=0)
1248 C<&dateofbirth> is the date of birth in ISO format (only if collectivity=0)
1252 # FIXME: This function is not legitimate. Multiple patrons might have the same first/last name and birthdate.
1253 # This is especially true since first name is not even a required field.
1255 sub checkuniquemember {
1256 my ( $collectivity, $surname, $firstname, $dateofbirth ) = @_;
1257 my $dbh = C4::Context->dbh;
1258 my $request = ($collectivity) ?
1259 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? " :
1261 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=? and dateofbirth=?" :
1262 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?";
1263 my $sth = $dbh->prepare($request);
1264 if ($collectivity) {
1265 $sth->execute( uc($surname) );
1266 } elsif($dateofbirth){
1267 $sth->execute( uc($surname), ucfirst($firstname), $dateofbirth );
1269 $sth->execute( uc($surname), ucfirst($firstname));
1271 my @data = $sth->fetchrow;
1272 ( $data[0] ) and return $data[0], $data[1];
1276 sub checkcardnumber {
1277 my ($cardnumber,$borrowernumber) = @_;
1278 # If cardnumber is null, we assume they're allowed.
1279 return 0 if !defined($cardnumber);
1280 my $dbh = C4::Context->dbh;
1281 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1282 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1283 my $sth = $dbh->prepare($query);
1284 if ($borrowernumber) {
1285 $sth->execute($cardnumber,$borrowernumber);
1287 $sth->execute($cardnumber);
1289 if (my $data= $sth->fetchrow_hashref()){
1298 =head2 getzipnamecity (OUEST-PROVENCE)
1300 take all info from table city for the fields city and zip
1301 check for the name and the zip code of the city selected
1305 sub getzipnamecity {
1307 my $dbh = C4::Context->dbh;
1310 "select city_name,city_state,city_zipcode,city_country from cities where cityid=? ");
1311 $sth->execute($cityid);
1312 my @data = $sth->fetchrow;
1313 return $data[0], $data[1], $data[2], $data[3];
1317 =head2 getdcity (OUEST-PROVENCE)
1319 recover cityid with city_name condition
1324 my ($city_name) = @_;
1325 my $dbh = C4::Context->dbh;
1326 my $sth = $dbh->prepare("select cityid from cities where city_name=? ");
1327 $sth->execute($city_name);
1328 my $data = $sth->fetchrow;
1332 =head2 GetFirstValidEmailAddress
1334 $email = GetFirstValidEmailAddress($borrowernumber);
1336 Return the first valid email address for a borrower, given the borrowernumber. For now, the order
1337 is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
1342 sub GetFirstValidEmailAddress {
1343 my $borrowernumber = shift;
1344 my $dbh = C4::Context->dbh;
1345 my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1346 $sth->execute( $borrowernumber );
1347 my $data = $sth->fetchrow_hashref;
1349 if ($data->{'email'}) {
1350 return $data->{'email'};
1351 } elsif ($data->{'emailpro'}) {
1352 return $data->{'emailpro'};
1353 } elsif ($data->{'B_email'}) {
1354 return $data->{'B_email'};
1360 =head2 GetExpiryDate
1362 $expirydate = GetExpiryDate($categorycode, $dateenrolled);
1364 Calculate expiry date given a categorycode and starting date. Date argument must be in ISO format.
1365 Return date is also in ISO format.
1370 my ( $categorycode, $dateenrolled ) = @_;
1372 if ($categorycode) {
1373 my $dbh = C4::Context->dbh;
1374 my $sth = $dbh->prepare("SELECT enrolmentperiod,enrolmentperioddate FROM categories WHERE categorycode=?");
1375 $sth->execute($categorycode);
1376 $enrolments = $sth->fetchrow_hashref;
1378 # die "GetExpiryDate: for enrollmentperiod $enrolmentperiod (category '$categorycode') starting $dateenrolled.\n";
1379 my @date = split (/-/,$dateenrolled);
1380 if($enrolments->{enrolmentperiod}){
1381 return sprintf("%04d-%02d-%02d", Add_Delta_YM(@date,0,$enrolments->{enrolmentperiod}));
1383 return $enrolments->{enrolmentperioddate};
1387 =head2 checkuserpassword (OUEST-PROVENCE)
1389 check for the password and login are not used
1390 return the number of record
1391 0=> NOT USED 1=> USED
1395 sub checkuserpassword {
1396 my ( $borrowernumber, $userid, $password ) = @_;
1397 $password = md5_base64($password);
1398 my $dbh = C4::Context->dbh;
1401 "Select count(*) from borrowers where borrowernumber !=? and userid =? and password=? "
1403 $sth->execute( $borrowernumber, $userid, $password );
1404 my $number_rows = $sth->fetchrow;
1405 return $number_rows;
1409 =head2 GetborCatFromCatType
1411 ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
1413 Looks up the different types of borrowers in the database. Returns two
1414 elements: a reference-to-array, which lists the borrower category
1415 codes, and a reference-to-hash, which maps the borrower category codes
1416 to category descriptions.
1421 sub GetborCatFromCatType {
1422 my ( $category_type, $action, $no_branch_limit ) = @_;
1424 my $branch_limit = $no_branch_limit
1426 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1428 # FIXME - This API seems both limited and dangerous.
1429 my $dbh = C4::Context->dbh;
1432 SELECT categories.categorycode, categories.description
1436 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1439 $request .= " $action ";
1440 $request .= " AND (branchcode = ? OR branchcode IS NULL) GROUP BY description" if $branch_limit;
1442 $request .= " WHERE branchcode = ? OR branchcode IS NULL GROUP BY description" if $branch_limit;
1444 $request .= " ORDER BY categorycode";
1446 my $sth = $dbh->prepare($request);
1448 $action ? $category_type : (),
1449 $branch_limit ? $branch_limit : ()
1455 while ( my $data = $sth->fetchrow_hashref ) {
1456 push @codes, $data->{'categorycode'};
1457 $labels{ $data->{'categorycode'} } = $data->{'description'};
1460 return ( \@codes, \%labels );
1463 =head2 GetBorrowercategory
1465 $hashref = &GetBorrowercategory($categorycode);
1467 Given the borrower's category code, the function returns the corresponding
1468 data hashref for a comprehensive information display.
1472 sub GetBorrowercategory {
1474 my $dbh = C4::Context->dbh;
1478 "SELECT description,dateofbirthrequired,upperagelimit,category_type
1480 WHERE categorycode = ?"
1482 $sth->execute($catcode);
1484 $sth->fetchrow_hashref;
1488 } # sub getborrowercategory
1491 =head2 GetBorrowerCategorycode
1493 $categorycode = &GetBorrowerCategoryCode( $borrowernumber );
1495 Given the borrowernumber, the function returns the corresponding categorycode
1498 sub GetBorrowerCategorycode {
1499 my ( $borrowernumber ) = @_;
1500 my $dbh = C4::Context->dbh;
1501 my $sth = $dbh->prepare( qq{
1504 WHERE borrowernumber = ?
1506 $sth->execute( $borrowernumber );
1507 return $sth->fetchrow;
1510 =head2 GetBorrowercategoryList
1512 $arrayref_hashref = &GetBorrowercategoryList;
1513 If no category code provided, the function returns all the categories.
1517 sub GetBorrowercategoryList {
1518 my $no_branch_limit = @_ ? shift : 0;
1519 my $branch_limit = $no_branch_limit
1521 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1522 my $dbh = C4::Context->dbh;
1523 my $query = "SELECT categories.* FROM categories";
1525 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1526 WHERE branchcode = ? OR branchcode IS NULL GROUP BY description
1528 $query .= " ORDER BY description";
1529 my $sth = $dbh->prepare( $query );
1530 $sth->execute( $branch_limit ? $branch_limit : () );
1531 my $data = $sth->fetchall_arrayref( {} );
1534 } # sub getborrowercategory
1536 =head2 ethnicitycategories
1538 ($codes_arrayref, $labels_hashref) = ðnicitycategories();
1540 Looks up the different ethnic types in the database. Returns two
1541 elements: a reference-to-array, which lists the ethnicity codes, and a
1542 reference-to-hash, which maps the ethnicity codes to ethnicity
1549 sub ethnicitycategories {
1550 my $dbh = C4::Context->dbh;
1551 my $sth = $dbh->prepare("Select code,name from ethnicity order by name");
1555 while ( my $data = $sth->fetchrow_hashref ) {
1556 push @codes, $data->{'code'};
1557 $labels{ $data->{'code'} } = $data->{'name'};
1559 return ( \@codes, \%labels );
1564 $ethn_name = &fixEthnicity($ethn_code);
1566 Takes an ethnicity code (e.g., "european" or "pi") and returns the
1567 corresponding descriptive name from the C<ethnicity> table in the
1568 Koha database ("European" or "Pacific Islander").
1575 my $ethnicity = shift;
1576 return unless $ethnicity;
1577 my $dbh = C4::Context->dbh;
1578 my $sth = $dbh->prepare("Select name from ethnicity where code = ?");
1579 $sth->execute($ethnicity);
1580 my $data = $sth->fetchrow_hashref;
1581 return $data->{'name'};
1582 } # sub fixEthnicity
1586 $dateofbirth,$date = &GetAge($date);
1588 this function return the borrowers age with the value of dateofbirth
1594 my ( $date, $date_ref ) = @_;
1596 if ( not defined $date_ref ) {
1597 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1600 my ( $year1, $month1, $day1 ) = split /-/, $date;
1601 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1603 my $age = $year2 - $year1;
1604 if ( $month1 . $day1 > $month2 . $day2 ) {
1611 =head2 get_institutions
1613 $insitutions = get_institutions();
1615 Just returns a list of all the borrowers of type I, borrownumber and name
1620 sub get_institutions {
1621 my $dbh = C4::Context->dbh();
1624 "SELECT borrowernumber,surname FROM borrowers WHERE categorycode=? ORDER BY surname"
1628 while ( my $data = $sth->fetchrow_hashref() ) {
1629 $orgs{ $data->{'borrowernumber'} } = $data;
1633 } # sub get_institutions
1635 =head2 add_member_orgs
1637 add_member_orgs($borrowernumber,$borrowernumbers);
1639 Takes a borrowernumber and a list of other borrowernumbers and inserts them into the borrowers_to_borrowers table
1644 sub add_member_orgs {
1645 my ( $borrowernumber, $otherborrowers ) = @_;
1646 my $dbh = C4::Context->dbh();
1648 "INSERT INTO borrowers_to_borrowers (borrower1,borrower2) VALUES (?,?)";
1649 my $sth = $dbh->prepare($query);
1650 foreach my $otherborrowernumber (@$otherborrowers) {
1651 $sth->execute( $borrowernumber, $otherborrowernumber );
1654 } # sub add_member_orgs
1658 $cityarrayref = GetCities();
1660 Returns an array_ref of the entries in the cities table
1661 If there are entries in the table an empty row is returned
1662 This is currently only used to populate a popup in memberentry
1668 my $dbh = C4::Context->dbh;
1669 my $city_arr = $dbh->selectall_arrayref(
1670 q|SELECT cityid,city_zipcode,city_name,city_state,city_country FROM cities ORDER BY city_name|,
1672 if ( @{$city_arr} ) {
1673 unshift @{$city_arr}, {
1674 city_zipcode => q{},
1678 city_country => q{},
1685 =head2 GetSortDetails (OUEST-PROVENCE)
1687 ($lib) = &GetSortDetails($category,$sortvalue);
1689 Returns the authorized value details
1690 C<&$lib>return value of authorized value details
1691 C<&$sortvalue>this is the value of authorized value
1692 C<&$category>this is the value of authorized value category
1696 sub GetSortDetails {
1697 my ( $category, $sortvalue ) = @_;
1698 my $dbh = C4::Context->dbh;
1699 my $query = qq|SELECT lib
1700 FROM authorised_values
1702 AND authorised_value=? |;
1703 my $sth = $dbh->prepare($query);
1704 $sth->execute( $category, $sortvalue );
1705 my $lib = $sth->fetchrow;
1706 return ($lib) if ($lib);
1707 return ($sortvalue) unless ($lib);
1710 =head2 MoveMemberToDeleted
1712 $result = &MoveMemberToDeleted($borrowernumber);
1714 Copy the record from borrowers to deletedborrowers table.
1718 # FIXME: should do it in one SQL statement w/ subquery
1719 # Otherwise, we should return the @data on success
1721 sub MoveMemberToDeleted {
1722 my ($member) = shift or return;
1723 my $dbh = C4::Context->dbh;
1724 my $query = qq|SELECT *
1726 WHERE borrowernumber=?|;
1727 my $sth = $dbh->prepare($query);
1728 $sth->execute($member);
1729 my @data = $sth->fetchrow_array;
1730 (@data) or return; # if we got a bad borrowernumber, there's nothing to insert
1732 $dbh->prepare( "INSERT INTO deletedborrowers VALUES ("
1733 . ( "?," x ( scalar(@data) - 1 ) )
1735 $sth->execute(@data);
1740 DelMember($borrowernumber);
1742 This function remove directly a borrower whitout writing it on deleteborrower.
1743 + Deletes reserves for the borrower
1748 my $dbh = C4::Context->dbh;
1749 my $borrowernumber = shift;
1750 #warn "in delmember with $borrowernumber";
1751 return unless $borrowernumber; # borrowernumber is mandatory.
1753 my $query = qq|DELETE
1755 WHERE borrowernumber=?|;
1756 my $sth = $dbh->prepare($query);
1757 $sth->execute($borrowernumber);
1761 WHERE borrowernumber = ?
1763 $sth = $dbh->prepare($query);
1764 $sth->execute($borrowernumber);
1765 logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
1769 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1771 $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1773 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1778 sub ExtendMemberSubscriptionTo {
1779 my ( $borrowerid,$date) = @_;
1780 my $dbh = C4::Context->dbh;
1781 my $borrower = GetMember('borrowernumber'=>$borrowerid);
1783 $date = (C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry') ?
1784 C4::Dates->new($borrower->{'dateexpiry'}, 'iso')->output("iso") :
1785 C4::Dates->new()->output("iso");
1786 $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
1788 my $sth = $dbh->do(<<EOF);
1790 SET dateexpiry='$date'
1791 WHERE borrowernumber='$borrowerid'
1793 # add enrolmentfee if needed
1794 $sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
1795 $sth->execute($borrower->{'categorycode'});
1796 my ($enrolmentfee) = $sth->fetchrow;
1797 if ($enrolmentfee && $enrolmentfee > 0) {
1798 # insert fee in patron debts
1799 manualinvoice($borrower->{'borrowernumber'}, '', '', 'A', $enrolmentfee);
1801 logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
1802 return $date if ($sth);
1806 =head2 GetRoadTypes (OUEST-PROVENCE)
1808 ($idroadtypearrayref, $roadttype_hashref) = &GetRoadTypes();
1810 Looks up the different road type . Returns two
1811 elements: a reference-to-array, which lists the id_roadtype
1812 codes, and a reference-to-hash, which maps the road type of the road .
1817 my $dbh = C4::Context->dbh;
1819 SELECT roadtypeid,road_type
1821 ORDER BY road_type|;
1822 my $sth = $dbh->prepare($query);
1827 # insert empty value to create a empty choice in cgi popup
1829 while ( my $data = $sth->fetchrow_hashref ) {
1831 push @id, $data->{'roadtypeid'};
1832 $roadtype{ $data->{'roadtypeid'} } = $data->{'road_type'};
1835 #test to know if the table contain some records if no the function return nothing
1842 return ( \@id, \%roadtype );
1848 =head2 GetTitles (OUEST-PROVENCE)
1850 ($borrowertitle)= &GetTitles();
1852 Looks up the different title . Returns array with all borrowers title
1857 my @borrowerTitle = split (/,|\|/,C4::Context->preference('BorrowersTitles'));
1858 unshift( @borrowerTitle, "" );
1859 my $count=@borrowerTitle;
1864 return ( \@borrowerTitle);
1868 =head2 GetPatronImage
1870 my ($imagedata, $dberror) = GetPatronImage($cardnumber);
1872 Returns the mimetype and binary image data of the image for the patron with the supplied cardnumber.
1876 sub GetPatronImage {
1877 my ($cardnumber) = @_;
1878 warn "Cardnumber passed to GetPatronImage is $cardnumber" if $debug;
1879 my $dbh = C4::Context->dbh;
1880 my $query = 'SELECT mimetype, imagefile FROM patronimage WHERE cardnumber = ?';
1881 my $sth = $dbh->prepare($query);
1882 $sth->execute($cardnumber);
1883 my $imagedata = $sth->fetchrow_hashref;
1884 warn "Database error!" if $sth->errstr;
1885 return $imagedata, $sth->errstr;
1888 =head2 PutPatronImage
1890 PutPatronImage($cardnumber, $mimetype, $imgfile);
1892 Stores patron binary image data and mimetype in database.
1893 NOTE: This function is good for updating images as well as inserting new images in the database.
1897 sub PutPatronImage {
1898 my ($cardnumber, $mimetype, $imgfile) = @_;
1899 warn "Parameters passed in: Cardnumber=$cardnumber, Mimetype=$mimetype, " . ($imgfile ? "Imagefile" : "No Imagefile") if $debug;
1900 my $dbh = C4::Context->dbh;
1901 my $query = "INSERT INTO patronimage (cardnumber, mimetype, imagefile) VALUES (?,?,?) ON DUPLICATE KEY UPDATE imagefile = ?;";
1902 my $sth = $dbh->prepare($query);
1903 $sth->execute($cardnumber,$mimetype,$imgfile,$imgfile);
1904 warn "Error returned inserting $cardnumber.$mimetype." if $sth->errstr;
1905 return $sth->errstr;
1908 =head2 RmPatronImage
1910 my ($dberror) = RmPatronImage($cardnumber);
1912 Removes the image for the patron with the supplied cardnumber.
1917 my ($cardnumber) = @_;
1918 warn "Cardnumber passed to GetPatronImage is $cardnumber" if $debug;
1919 my $dbh = C4::Context->dbh;
1920 my $query = "DELETE FROM patronimage WHERE cardnumber = ?;";
1921 my $sth = $dbh->prepare($query);
1922 $sth->execute($cardnumber);
1923 my $dberror = $sth->errstr;
1924 warn "Database error!" if $sth->errstr;
1928 =head2 GetHideLostItemsPreference
1930 $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1932 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1933 C<&$hidelostitemspref>return value of function, 0 or 1
1937 sub GetHideLostItemsPreference {
1938 my ($borrowernumber) = @_;
1939 my $dbh = C4::Context->dbh;
1940 my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1941 my $sth = $dbh->prepare($query);
1942 $sth->execute($borrowernumber);
1943 my $hidelostitems = $sth->fetchrow;
1944 return $hidelostitems;
1947 =head2 GetRoadTypeDetails (OUEST-PROVENCE)
1949 ($roadtype) = &GetRoadTypeDetails($roadtypeid);
1951 Returns the description of roadtype
1952 C<&$roadtype>return description of road type
1953 C<&$roadtypeid>this is the value of roadtype s
1957 sub GetRoadTypeDetails {
1958 my ($roadtypeid) = @_;
1959 my $dbh = C4::Context->dbh;
1963 WHERE roadtypeid=?|;
1964 my $sth = $dbh->prepare($query);
1965 $sth->execute($roadtypeid);
1966 my $roadtype = $sth->fetchrow;
1970 =head2 GetBorrowersToExpunge
1972 $borrowers = &GetBorrowersToExpunge(
1973 not_borrowered_since => $not_borrowered_since,
1974 expired_before => $expired_before,
1975 category_code => $category_code,
1976 branchcode => $branchcode
1979 This function get all borrowers based on the given criteria.
1983 sub GetBorrowersToExpunge {
1986 my $filterdate = $params->{'not_borrowered_since'};
1987 my $filterexpiry = $params->{'expired_before'};
1988 my $filtercategory = $params->{'category_code'};
1989 my $filterbranch = $params->{'branchcode'} ||
1990 ((C4::Context->preference('IndependantBranches')
1991 && C4::Context->userenv
1992 && C4::Context->userenv->{flags} % 2 !=1
1993 && C4::Context->userenv->{branch})
1994 ? C4::Context->userenv->{branch}
1997 my $dbh = C4::Context->dbh;
1999 SELECT borrowers.borrowernumber,
2000 MAX(old_issues.timestamp) AS latestissue,
2001 MAX(issues.timestamp) AS currentissue
2003 JOIN categories USING (categorycode)
2004 LEFT JOIN old_issues USING (borrowernumber)
2005 LEFT JOIN issues USING (borrowernumber)
2006 WHERE category_type <> 'S'
2007 AND borrowernumber NOT IN (SELECT guarantorid FROM borrowers WHERE guarantorid IS NOT NULL AND guarantorid <> 0)
2010 if ( $filterbranch && $filterbranch ne "" ) {
2011 $query.= " AND borrowers.branchcode = ? ";
2012 push( @query_params, $filterbranch );
2014 if ( $filterexpiry ) {
2015 $query .= " AND dateexpiry < ? ";
2016 push( @query_params, $filterexpiry );
2018 if ( $filtercategory ) {
2019 $query .= " AND categorycode = ? ";
2020 push( @query_params, $filtercategory );
2022 $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
2023 if ( $filterdate ) {
2024 $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
2025 push @query_params,$filterdate;
2027 warn $query if $debug;
2029 my $sth = $dbh->prepare($query);
2030 if (scalar(@query_params)>0){
2031 $sth->execute(@query_params);
2038 while ( my $data = $sth->fetchrow_hashref ) {
2039 push @results, $data;
2044 =head2 GetBorrowersWhoHaveNeverBorrowed
2046 $results = &GetBorrowersWhoHaveNeverBorrowed
2048 This function get all borrowers who have never borrowed.
2050 I<$result> is a ref to an array which all elements are a hasref.
2054 sub GetBorrowersWhoHaveNeverBorrowed {
2055 my $filterbranch = shift ||
2056 ((C4::Context->preference('IndependantBranches')
2057 && C4::Context->userenv
2058 && C4::Context->userenv->{flags} % 2 !=1
2059 && C4::Context->userenv->{branch})
2060 ? C4::Context->userenv->{branch}
2062 my $dbh = C4::Context->dbh;
2064 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
2066 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
2067 WHERE issues.borrowernumber IS NULL
2070 if ($filterbranch && $filterbranch ne ""){
2071 $query.=" AND borrowers.branchcode= ?";
2072 push @query_params,$filterbranch;
2074 warn $query if $debug;
2076 my $sth = $dbh->prepare($query);
2077 if (scalar(@query_params)>0){
2078 $sth->execute(@query_params);
2085 while ( my $data = $sth->fetchrow_hashref ) {
2086 push @results, $data;
2091 =head2 GetBorrowersWithIssuesHistoryOlderThan
2093 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
2095 this function get all borrowers who has an issue history older than I<$date> given on input arg.
2097 I<$result> is a ref to an array which all elements are a hashref.
2098 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2102 sub GetBorrowersWithIssuesHistoryOlderThan {
2103 my $dbh = C4::Context->dbh;
2104 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
2105 my $filterbranch = shift ||
2106 ((C4::Context->preference('IndependantBranches')
2107 && C4::Context->userenv
2108 && C4::Context->userenv->{flags} % 2 !=1
2109 && C4::Context->userenv->{branch})
2110 ? C4::Context->userenv->{branch}
2113 SELECT count(borrowernumber) as n,borrowernumber
2115 WHERE returndate < ?
2116 AND borrowernumber IS NOT NULL
2119 push @query_params, $date;
2121 $query.=" AND branchcode = ?";
2122 push @query_params, $filterbranch;
2124 $query.=" GROUP BY borrowernumber ";
2125 warn $query if $debug;
2126 my $sth = $dbh->prepare($query);
2127 $sth->execute(@query_params);
2130 while ( my $data = $sth->fetchrow_hashref ) {
2131 push @results, $data;
2136 =head2 GetBorrowersNamesAndLatestIssue
2138 $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
2140 this function get borrowers Names and surnames and Issue information.
2142 I<@borrowernumbers> is an array which all elements are borrowernumbers.
2143 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2147 sub GetBorrowersNamesAndLatestIssue {
2148 my $dbh = C4::Context->dbh;
2149 my @borrowernumbers=@_;
2151 SELECT surname,lastname, phone, email,max(timestamp)
2153 LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
2154 GROUP BY borrowernumber
2156 my $sth = $dbh->prepare($query);
2158 my $results = $sth->fetchall_arrayref({});
2164 my $success = DebarMember( $borrowernumber, $todate );
2166 marks a Member as debarred, and therefore unable to checkout any more
2170 true on success, false on failure
2175 my $borrowernumber = shift;
2178 return unless defined $borrowernumber;
2179 return unless $borrowernumber =~ /^\d+$/;
2182 borrowernumber => $borrowernumber,
2192 my $success = ModPrivacy( $borrowernumber, $privacy );
2194 Update the privacy of a patron.
2197 true on success, false on failure
2204 my $borrowernumber = shift;
2205 my $privacy = shift;
2206 return unless defined $borrowernumber;
2207 return unless $borrowernumber =~ /^\d+$/;
2209 return ModMember( borrowernumber => $borrowernumber,
2210 privacy => $privacy );
2215 AddMessage( $borrowernumber, $message_type, $message, $branchcode );
2217 Adds a message to the messages table for the given borrower.
2226 my ( $borrowernumber, $message_type, $message, $branchcode ) = @_;
2228 my $dbh = C4::Context->dbh;
2230 if ( ! ( $borrowernumber && $message_type && $message && $branchcode ) ) {
2234 my $query = "INSERT INTO messages ( borrowernumber, branchcode, message_type, message ) VALUES ( ?, ?, ?, ? )";
2235 my $sth = $dbh->prepare($query);
2236 $sth->execute( $borrowernumber, $branchcode, $message_type, $message );
2237 logaction("MEMBERS", "ADDCIRCMESSAGE", $borrowernumber, $message) if C4::Context->preference("BorrowersLog");
2243 GetMessages( $borrowernumber, $type );
2245 $type is message type, B for borrower, or L for Librarian.
2246 Empty type returns all messages of any type.
2248 Returns all messages for the given borrowernumber
2253 my ( $borrowernumber, $type, $branchcode ) = @_;
2259 my $dbh = C4::Context->dbh;
2262 branches.branchname,
2265 messages.branchcode LIKE '$branchcode' AS can_delete
2266 FROM messages, branches
2267 WHERE borrowernumber = ?
2268 AND message_type LIKE ?
2269 AND messages.branchcode = branches.branchcode
2270 ORDER BY message_date DESC";
2271 my $sth = $dbh->prepare($query);
2272 $sth->execute( $borrowernumber, $type ) ;
2275 while ( my $data = $sth->fetchrow_hashref ) {
2276 my $d = C4::Dates->new( $data->{message_date}, 'iso' );
2277 $data->{message_date_formatted} = $d->output;
2278 push @results, $data;
2286 GetMessagesCount( $borrowernumber, $type );
2288 $type is message type, B for borrower, or L for Librarian.
2289 Empty type returns all messages of any type.
2291 Returns the number of messages for the given borrowernumber
2295 sub GetMessagesCount {
2296 my ( $borrowernumber, $type, $branchcode ) = @_;
2302 my $dbh = C4::Context->dbh;
2304 my $query = "SELECT COUNT(*) as MsgCount FROM messages WHERE borrowernumber = ? AND message_type LIKE ?";
2305 my $sth = $dbh->prepare($query);
2306 $sth->execute( $borrowernumber, $type ) ;
2309 my $data = $sth->fetchrow_hashref;
2310 my $count = $data->{'MsgCount'};
2317 =head2 DeleteMessage
2319 DeleteMessage( $message_id );
2324 my ( $message_id ) = @_;
2326 my $dbh = C4::Context->dbh;
2327 my $query = "SELECT * FROM messages WHERE message_id = ?";
2328 my $sth = $dbh->prepare($query);
2329 $sth->execute( $message_id );
2330 my $message = $sth->fetchrow_hashref();
2332 $query = "DELETE FROM messages WHERE message_id = ?";
2333 $sth = $dbh->prepare($query);
2334 $sth->execute( $message_id );
2335 logaction("MEMBERS", "DELCIRCMESSAGE", $message->{'borrowernumber'}, $message->{'message'}) if C4::Context->preference("BorrowersLog");
2340 IssueSlip($branchcode, $borrowernumber, $quickslip)
2342 Returns letter hash ( see C4::Letters::GetPreparedLetter )
2344 $quickslip is boolean, to indicate whether we want a quick slip
2349 my ($branch, $borrowernumber, $quickslip) = @_;
2351 # return unless ( C4::Context->boolean_preference('printcirculationslips') );
2353 my $now = POSIX::strftime("%Y-%m-%d", localtime);
2355 my $issueslist = GetPendingIssues($borrowernumber);
2356 foreach my $it (@$issueslist){
2357 if ((substr $it->{'issuedate'}, 0, 10) eq $now || (substr $it->{'lastreneweddate'}, 0, 10) eq $now) {
2360 elsif ((substr $it->{'date_due'}, 0, 10) le $now) {
2361 $it->{'overdue'} = 1;
2364 $it->{'date_due'}=format_date($it->{'date_due'});
2366 my @issues = sort { $b->{'timestamp'} <=> $a->{'timestamp'} } @$issueslist;
2368 my ($letter_code, %repeat);
2370 $letter_code = 'ISSUEQSLIP';
2372 'checkedout' => [ map {
2376 }, grep { $_->{'now'} } @issues ],
2380 $letter_code = 'ISSUESLIP';
2382 'checkedout' => [ map {
2386 }, grep { !$_->{'overdue'} } @issues ],
2388 'overdue' => [ map {
2392 }, grep { $_->{'overdue'} } @issues ],
2395 $_->{'timestamp'} = $_->{'newdate'};
2397 } @{ GetNewsToDisplay("slip") } ],
2401 return C4::Letters::GetPreparedLetter (
2402 module => 'circulation',
2403 letter_code => $letter_code,
2404 branchcode => $branch,
2406 'branches' => $branch,
2407 'borrowers' => $borrowernumber,
2413 =head2 GetBorrowersWithEmail
2415 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
2417 This gets a list of users and their basic details from their email address.
2418 As it's possible for multiple user to have the same email address, it provides
2419 you with all of them. If there is no userid for the user, there will be an
2420 C<undef> there. An empty list will be returned if there are no matches.
2424 sub GetBorrowersWithEmail {
2427 my $dbh = C4::Context->dbh;
2429 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
2430 my $sth=$dbh->prepare($query);
2431 $sth->execute($email);
2433 while (my $ref = $sth->fetch) {
2436 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
2440 sub AddMember_Opac {
2441 my ( %borrower ) = @_;
2443 $borrower{'categorycode'} = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2445 my $sr = new String::Random;
2446 $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
2447 my $password = $sr->randpattern("AAAAAAAAAA");
2448 $borrower{'password'} = $password;
2450 $borrower{'cardnumber'} = fixup_cardnumber();
2452 my $borrowernumber = AddMember(%borrower);
2454 return ( $borrowernumber, $password );
2457 END { } # module clean-up code here (global destructor)