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 Date::Calc qw/Today Add_Delta_YM check_date Date_to_Days/;
29 use C4::Log; # logaction
35 use C4::SQLHelper qw(InsertInTable UpdateInTable SearchInTable);
36 use C4::Members::Attributes qw(SearchIdMatchingAttribute);
37 use C4::NewsChannels; #get slip news
39 use DateTime::Format::DateParse;
41 use Text::Unaccent qw( unac_string );
43 our ($VERSION,@ISA,@EXPORT,@EXPORT_OK,$debug);
46 $VERSION = 3.07.00.049;
47 $debug = $ENV{DEBUG} || 0;
59 &GetMemberIssuesAndFines
67 &GetFirstValidEmailAddress
80 &GetHideLostItemsPreference
83 &GetMemberAccountRecords
84 &GetBorNotifyAcctRecord
88 GetBorrowerCategorycode
89 &GetBorrowercategoryList
91 &GetBorrowersWhoHaveNotBorrowedSince
92 &GetBorrowersWhoHaveNeverBorrowed
93 &GetBorrowersWithIssuesHistoryOlderThan
103 GetBorrowersWithEmail
123 &ExtendMemberSubscriptionTo
141 C4::Members - Perl Module containing convenience functions for member handling
149 This module contains routines for adding, modifying and deleting members/patrons/borrowers
155 $borrowers_result_array_ref = &Search($filter,$orderby, $limit,
156 $columns_out, $search_on_fields,$searchtype);
158 Looks up patrons (borrowers) on filter. A wrapper for SearchInTable('borrowers').
160 For C<$filter>, C<$orderby>, C<$limit>, C<&columns_out>, C<&search_on_fields> and C<&searchtype>
161 refer to C4::SQLHelper:SearchInTable().
163 Special C<$filter> key '' is effectively expanded to search on surname firstname othernamescw
164 and cardnumber unless C<&search_on_fields> is defined
168 $borrowers = Search('abcd', 'cardnumber');
170 $borrowers = Search({''=>'abcd', category_type=>'I'}, 'surname');
174 sub _express_member_find {
177 # this is used by circulation everytime a new borrowers cardnumber is scanned
178 # so we can check an exact match first, if that works return, otherwise do the rest
179 my $dbh = C4::Context->dbh;
180 my $query = "SELECT borrowernumber FROM borrowers WHERE cardnumber = ?";
181 if ( my $borrowernumber = $dbh->selectrow_array($query, undef, $filter) ) {
182 return( {"borrowernumber"=>$borrowernumber} );
185 my ($search_on_fields, $searchtype);
186 if ( length($filter) == 1 ) {
187 $search_on_fields = [ qw(surname) ];
188 $searchtype = 'start_with';
190 $search_on_fields = [ qw(surname firstname othernames cardnumber) ];
191 $searchtype = 'contain';
194 return (undef, $search_on_fields, $searchtype);
198 my ( $filter, $orderby, $limit, $columns_out, $search_on_fields, $searchtype ) = @_;
203 if ( my $fr = ref $filter ) {
204 if ( $fr eq "HASH" ) {
205 if ( my $search_string = $filter->{''} ) {
206 my ($member_filter, $member_search_on_fields, $member_searchtype) = _express_member_find($search_string);
207 if ($member_filter) {
208 $filter = $member_filter;
211 $search_on_fields ||= $member_search_on_fields;
212 $searchtype ||= $member_searchtype;
217 $search_string = $filter;
221 $search_string = $filter;
222 my ($member_filter, $member_search_on_fields, $member_searchtype) = _express_member_find($search_string);
223 if ($member_filter) {
224 $filter = $member_filter;
227 $search_on_fields ||= $member_search_on_fields;
228 $searchtype ||= $member_searchtype;
232 if ( !$found_borrower && C4::Context->preference('ExtendedPatronAttributes') && $search_string ) {
233 my $matching_records = C4::Members::Attributes::SearchIdMatchingAttribute($search_string);
234 if(scalar(@$matching_records)>0) {
235 if ( my $fr = ref $filter ) {
236 if ( $fr eq "HASH" ) {
238 $filter = [ $filter ];
240 push @$filter, { %f, "borrowernumber"=>$$matching_records };
243 push @$filter, {"borrowernumber"=>$matching_records};
247 $filter = [ $filter ];
248 push @$filter, {"borrowernumber"=>$matching_records};
253 # $showallbranches was not used at the time SearchMember() was mainstreamed into Search().
254 # Mentioning for the reference
256 if ( C4::Context->preference("IndependantBranches") ) { # && !$showallbranches){
257 if ( my $userenv = C4::Context->userenv ) {
258 my $branch = $userenv->{'branch'};
259 if ( ($userenv->{flags} % 2 !=1) &&
260 $branch && $branch ne "insecure" ){
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 ($amount) = GetMemberAccountRecords( $patroninformation->{'borrowernumber'});
436 my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
437 $flaginfo{'message'} = sprintf "Patron owes \$%.02f", $amount;
438 $flaginfo{'amount'} = sprintf "%.02f", $amount;
439 if ( $amount > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
440 $flaginfo{'noissues'} = 1;
442 $flags{'CHARGES'} = \%flaginfo;
444 elsif ( $amount < 0 ) {
446 $flaginfo{'message'} = sprintf "Patron has credit of \$%.02f", -$amount;
447 $flaginfo{'amount'} = sprintf "%.02f", $amount;
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;
754 # generate a proper login if none provided
755 $data{'userid'} = Generate_Userid($data{'borrowernumber'}, $data{'firstname'}, $data{'surname'}) if $data{'userid'} eq '';
756 # create a disabled account if no password provided
757 $data{'password'} = ($data{'password'})? md5_base64($data{'password'}) : '!';
758 $data{'borrowernumber'}=InsertInTable("borrowers",\%data);
759 # mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
760 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
762 # check for enrollment fee & add it if needed
763 my $sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
764 $sth->execute($data{'categorycode'});
765 my ($enrolmentfee) = $sth->fetchrow;
767 warn sprintf('Database returned the following error: %s', $sth->errstr);
770 if ($enrolmentfee && $enrolmentfee > 0) {
771 # insert fee in patron debts
772 manualinvoice($data{'borrowernumber'}, '', '', 'A', $enrolmentfee);
775 return $data{'borrowernumber'};
780 my ($uid,$member) = @_;
781 my $dbh = C4::Context->dbh;
782 # Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
783 # Then we need to tell the user and have them create a new one.
786 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
787 $sth->execute( $uid, $member );
788 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
796 sub Generate_Userid {
797 my ($borrowernumber, $firstname, $surname) = @_;
801 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
802 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
803 $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
804 $newuid = unac_string('utf-8',$newuid);
805 $newuid .= $offset unless $offset == 0;
808 } while (!Check_Userid($newuid,$borrowernumber));
814 my ( $uid, $member, $digest ) = @_;
815 my $dbh = C4::Context->dbh;
817 #Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
818 #Then we need to tell the user and have them create a new one.
822 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
823 $sth->execute( $uid, $member );
824 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
828 #Everything is good so we can update the information.
831 "update borrowers set userid=?, password=? where borrowernumber=?");
832 $sth->execute( $uid, $digest, $member );
836 logaction("MEMBERS", "CHANGE PASS", $member, "") if C4::Context->preference("BorrowersLog");
842 =head2 fixup_cardnumber
844 Warning: The caller is responsible for locking the members table in write
845 mode, to avoid database corruption.
849 use vars qw( @weightings );
850 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
852 sub fixup_cardnumber {
853 my ($cardnumber) = @_;
854 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
856 # Find out whether member numbers should be generated
857 # automatically. Should be either "1" or something else.
858 # Defaults to "0", which is interpreted as "no".
860 # if ($cardnumber !~ /\S/ && $autonumber_members) {
861 ($autonumber_members) or return $cardnumber;
862 my $checkdigit = C4::Context->preference('checkdigit');
863 my $dbh = C4::Context->dbh;
864 if ( $checkdigit and $checkdigit eq 'katipo' ) {
866 # if checkdigit is selected, calculate katipo-style cardnumber.
867 # otherwise, just use the max()
868 # purpose: generate checksum'd member numbers.
869 # We'll assume we just got the max value of digits 2-8 of member #'s
870 # from the database and our job is to increment that by one,
871 # determine the 1st and 9th digits and return the full string.
872 my $sth = $dbh->prepare(
873 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
876 my $data = $sth->fetchrow_hashref;
877 $cardnumber = $data->{new_num};
878 if ( !$cardnumber ) { # If DB has no values,
879 $cardnumber = 1000000; # start at 1000000
885 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
886 # read weightings, left to right, 1 char at a time
887 my $temp1 = $weightings[$i];
889 # sequence left to right, 1 char at a time
890 my $temp2 = substr( $cardnumber, $i, 1 );
892 # mult each char 1-7 by its corresponding weighting
893 $sum += $temp1 * $temp2;
896 my $rem = ( $sum % 11 );
897 $rem = 'X' if $rem == 10;
899 return "V$cardnumber$rem";
902 my $sth = $dbh->prepare(
903 'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
906 my ($result) = $sth->fetchrow;
909 return $cardnumber; # just here as a fallback/reminder
914 ($num_children, $children_arrayref) = &GetGuarantees($parent_borrno);
915 $child0_cardno = $children_arrayref->[0]{"cardnumber"};
916 $child0_borrno = $children_arrayref->[0]{"borrowernumber"};
918 C<&GetGuarantees> takes a borrower number (e.g., that of a patron
919 with children) and looks up the borrowers who are guaranteed by that
920 borrower (i.e., the patron's children).
922 C<&GetGuarantees> returns two values: an integer giving the number of
923 borrowers guaranteed by C<$parent_borrno>, and a reference to an array
924 of references to hash, which gives the actual results.
930 my ($borrowernumber) = @_;
931 my $dbh = C4::Context->dbh;
934 "select cardnumber,borrowernumber, firstname, surname from borrowers where guarantorid=?"
936 $sth->execute($borrowernumber);
939 my $data = $sth->fetchall_arrayref({});
940 return ( scalar(@$data), $data );
943 =head2 UpdateGuarantees
945 &UpdateGuarantees($parent_borrno);
948 C<&UpdateGuarantees> borrower data for an adult and updates all the guarantees
949 with the modified information
954 sub UpdateGuarantees {
956 my $dbh = C4::Context->dbh;
957 my ( $count, $guarantees ) = GetGuarantees( $data{'borrowernumber'} );
958 foreach my $guarantee (@$guarantees){
959 my $guaquery = qq|UPDATE borrowers
960 SET address=?,fax=?,B_city=?,mobile=?,city=?,phone=?
961 WHERE borrowernumber=?
963 my $sth = $dbh->prepare($guaquery);
964 $sth->execute($data{'address'},$data{'fax'},$data{'B_city'},$data{'mobile'},$data{'city'},$data{'phone'},$guarantee->{'borrowernumber'});
967 =head2 GetPendingIssues
969 my $issues = &GetPendingIssues(@borrowernumber);
971 Looks up what the patron with the given borrowernumber has borrowed.
973 C<&GetPendingIssues> returns a
974 reference-to-array where each element is a reference-to-hash; the
975 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
976 The keys include C<biblioitems> fields except marc and marcxml.
981 sub GetPendingIssues {
982 my @borrowernumbers = @_;
984 unless (@borrowernumbers ) { # return a ref_to_array
985 return \@borrowernumbers; # to not cause surprise to caller
988 # Borrowers part of the query
990 for (my $i = 0; $i < @borrowernumbers; $i++) {
991 $bquery .= ' issues.borrowernumber = ?';
992 if ($i < $#borrowernumbers ) {
997 # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
998 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
999 # FIXME: circ/ciculation.pl tries to sort by timestamp!
1000 # FIXME: namespace collision: other collisions possible.
1001 # FIXME: most of this data isn't really being used by callers.
1008 biblioitems.itemtype,
1011 biblioitems.publicationyear,
1012 biblioitems.publishercode,
1013 biblioitems.volumedate,
1014 biblioitems.volumedesc,
1017 borrowers.firstname,
1019 borrowers.cardnumber,
1020 issues.timestamp AS timestamp,
1021 issues.renewals AS renewals,
1022 issues.borrowernumber AS borrowernumber,
1023 items.renewals AS totalrenewals
1025 LEFT JOIN items ON items.itemnumber = issues.itemnumber
1026 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1027 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
1028 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
1031 ORDER BY issues.issuedate"
1034 my $sth = C4::Context->dbh->prepare($query);
1035 $sth->execute(@borrowernumbers);
1036 my $data = $sth->fetchall_arrayref({});
1037 my $tz = C4::Context->tz();
1038 my $today = DateTime->now( time_zone => $tz);
1039 foreach (@{$data}) {
1040 if ($_->{issuedate}) {
1041 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
1043 $_->{date_due} or next;
1044 $_->{date_due} = DateTime::Format::DateParse->parse_datetime($_->{date_due}, $tz->name());
1045 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
1054 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
1056 Looks up what the patron with the given borrowernumber has borrowed,
1057 and sorts the results.
1059 C<$sortkey> is the name of a field on which to sort the results. This
1060 should be the name of a field in the C<issues>, C<biblio>,
1061 C<biblioitems>, or C<items> table in the Koha database.
1063 C<$limit> is the maximum number of results to return.
1065 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
1066 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
1067 C<items> tables of the Koha database.
1073 my ( $borrowernumber, $order, $limit ) = @_;
1075 #FIXME: sanity-check order and limit
1076 my $dbh = C4::Context->dbh;
1078 "SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1080 LEFT JOIN items on items.itemnumber=issues.itemnumber
1081 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1082 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1083 WHERE borrowernumber=?
1085 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1087 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
1088 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1089 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1090 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
1092 if ( $limit != 0 ) {
1093 $query .= " limit $limit";
1096 my $sth = $dbh->prepare($query);
1097 $sth->execute($borrowernumber, $borrowernumber);
1100 while ( my $data = $sth->fetchrow_hashref ) {
1101 push @result, $data;
1108 =head2 GetMemberAccountRecords
1110 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
1112 Looks up accounting data for the patron with the given borrowernumber.
1114 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
1115 reference-to-array, where each element is a reference-to-hash; the
1116 keys are the fields of the C<accountlines> table in the Koha database.
1117 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1118 total amount outstanding for all of the account lines.
1123 sub GetMemberAccountRecords {
1124 my ($borrowernumber,$date) = @_;
1125 my $dbh = C4::Context->dbh;
1131 WHERE borrowernumber=?);
1132 my @bind = ($borrowernumber);
1133 if ($date && $date ne ''){
1134 $strsth.=" AND date < ? ";
1137 $strsth.=" ORDER BY date desc,timestamp DESC";
1138 my $sth= $dbh->prepare( $strsth );
1139 $sth->execute( @bind );
1141 while ( my $data = $sth->fetchrow_hashref ) {
1142 if ( $data->{itemnumber} ) {
1143 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1144 $data->{biblionumber} = $biblio->{biblionumber};
1145 $data->{title} = $biblio->{title};
1147 $acctlines[$numlines] = $data;
1149 $total += int(1000 * $data->{'amountoutstanding'}); # convert float to integer to avoid round-off errors
1152 return ( $total, \@acctlines,$numlines);
1155 =head2 GetBorNotifyAcctRecord
1157 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1159 Looks up accounting data for the patron with the given borrowernumber per file number.
1161 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1162 reference-to-array, where each element is a reference-to-hash; the
1163 keys are the fields of the C<accountlines> table in the Koha database.
1164 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1165 total amount outstanding for all of the account lines.
1169 sub GetBorNotifyAcctRecord {
1170 my ( $borrowernumber, $notifyid ) = @_;
1171 my $dbh = C4::Context->dbh;
1174 my $sth = $dbh->prepare(
1177 WHERE borrowernumber=?
1179 AND amountoutstanding != '0'
1180 ORDER BY notify_id,accounttype
1183 $sth->execute( $borrowernumber, $notifyid );
1185 while ( my $data = $sth->fetchrow_hashref ) {
1186 if ( $data->{itemnumber} ) {
1187 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1188 $data->{biblionumber} = $biblio->{biblionumber};
1189 $data->{title} = $biblio->{title};
1191 $acctlines[$numlines] = $data;
1193 $total += int(100 * $data->{'amountoutstanding'});
1196 return ( $total, \@acctlines, $numlines );
1199 =head2 checkuniquemember (OUEST-PROVENCE)
1201 ($result,$categorycode) = &checkuniquemember($collectivity,$surname,$firstname,$dateofbirth);
1203 Checks that a member exists or not in the database.
1205 C<&result> is nonzero (=exist) or 0 (=does not exist)
1206 C<&categorycode> is from categorycode table
1207 C<&collectivity> is 1 (= we add a collectivity) or 0 (= we add a physical member)
1208 C<&surname> is the surname
1209 C<&firstname> is the firstname (only if collectivity=0)
1210 C<&dateofbirth> is the date of birth in ISO format (only if collectivity=0)
1214 # FIXME: This function is not legitimate. Multiple patrons might have the same first/last name and birthdate.
1215 # This is especially true since first name is not even a required field.
1217 sub checkuniquemember {
1218 my ( $collectivity, $surname, $firstname, $dateofbirth ) = @_;
1219 my $dbh = C4::Context->dbh;
1220 my $request = ($collectivity) ?
1221 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? " :
1223 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=? and dateofbirth=?" :
1224 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?";
1225 my $sth = $dbh->prepare($request);
1226 if ($collectivity) {
1227 $sth->execute( uc($surname) );
1228 } elsif($dateofbirth){
1229 $sth->execute( uc($surname), ucfirst($firstname), $dateofbirth );
1231 $sth->execute( uc($surname), ucfirst($firstname));
1233 my @data = $sth->fetchrow;
1234 ( $data[0] ) and return $data[0], $data[1];
1238 sub checkcardnumber {
1239 my ($cardnumber,$borrowernumber) = @_;
1240 # If cardnumber is null, we assume they're allowed.
1241 return 0 if !defined($cardnumber);
1242 my $dbh = C4::Context->dbh;
1243 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1244 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1245 my $sth = $dbh->prepare($query);
1246 if ($borrowernumber) {
1247 $sth->execute($cardnumber,$borrowernumber);
1249 $sth->execute($cardnumber);
1251 if (my $data= $sth->fetchrow_hashref()){
1260 =head2 getzipnamecity (OUEST-PROVENCE)
1262 take all info from table city for the fields city and zip
1263 check for the name and the zip code of the city selected
1267 sub getzipnamecity {
1269 my $dbh = C4::Context->dbh;
1272 "select city_name,city_state,city_zipcode,city_country from cities where cityid=? ");
1273 $sth->execute($cityid);
1274 my @data = $sth->fetchrow;
1275 return $data[0], $data[1], $data[2], $data[3];
1279 =head2 getdcity (OUEST-PROVENCE)
1281 recover cityid with city_name condition
1286 my ($city_name) = @_;
1287 my $dbh = C4::Context->dbh;
1288 my $sth = $dbh->prepare("select cityid from cities where city_name=? ");
1289 $sth->execute($city_name);
1290 my $data = $sth->fetchrow;
1294 =head2 GetFirstValidEmailAddress
1296 $email = GetFirstValidEmailAddress($borrowernumber);
1298 Return the first valid email address for a borrower, given the borrowernumber. For now, the order
1299 is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
1304 sub GetFirstValidEmailAddress {
1305 my $borrowernumber = shift;
1306 my $dbh = C4::Context->dbh;
1307 my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1308 $sth->execute( $borrowernumber );
1309 my $data = $sth->fetchrow_hashref;
1311 if ($data->{'email'}) {
1312 return $data->{'email'};
1313 } elsif ($data->{'emailpro'}) {
1314 return $data->{'emailpro'};
1315 } elsif ($data->{'B_email'}) {
1316 return $data->{'B_email'};
1322 =head2 GetExpiryDate
1324 $expirydate = GetExpiryDate($categorycode, $dateenrolled);
1326 Calculate expiry date given a categorycode and starting date. Date argument must be in ISO format.
1327 Return date is also in ISO format.
1332 my ( $categorycode, $dateenrolled ) = @_;
1334 if ($categorycode) {
1335 my $dbh = C4::Context->dbh;
1336 my $sth = $dbh->prepare("SELECT enrolmentperiod,enrolmentperioddate FROM categories WHERE categorycode=?");
1337 $sth->execute($categorycode);
1338 $enrolments = $sth->fetchrow_hashref;
1340 # die "GetExpiryDate: for enrollmentperiod $enrolmentperiod (category '$categorycode') starting $dateenrolled.\n";
1341 my @date = split (/-/,$dateenrolled);
1342 if($enrolments->{enrolmentperiod}){
1343 return sprintf("%04d-%02d-%02d", Add_Delta_YM(@date,0,$enrolments->{enrolmentperiod}));
1345 return $enrolments->{enrolmentperioddate};
1349 =head2 checkuserpassword (OUEST-PROVENCE)
1351 check for the password and login are not used
1352 return the number of record
1353 0=> NOT USED 1=> USED
1357 sub checkuserpassword {
1358 my ( $borrowernumber, $userid, $password ) = @_;
1359 $password = md5_base64($password);
1360 my $dbh = C4::Context->dbh;
1363 "Select count(*) from borrowers where borrowernumber !=? and userid =? and password=? "
1365 $sth->execute( $borrowernumber, $userid, $password );
1366 my $number_rows = $sth->fetchrow;
1367 return $number_rows;
1371 =head2 GetborCatFromCatType
1373 ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
1375 Looks up the different types of borrowers in the database. Returns two
1376 elements: a reference-to-array, which lists the borrower category
1377 codes, and a reference-to-hash, which maps the borrower category codes
1378 to category descriptions.
1383 sub GetborCatFromCatType {
1384 my ( $category_type, $action ) = @_;
1385 # FIXME - This API seems both limited and dangerous.
1386 my $dbh = C4::Context->dbh;
1387 my $request = qq| SELECT categorycode,description
1390 ORDER BY categorycode|;
1391 my $sth = $dbh->prepare($request);
1393 $sth->execute($category_type);
1402 while ( my $data = $sth->fetchrow_hashref ) {
1403 push @codes, $data->{'categorycode'};
1404 $labels{ $data->{'categorycode'} } = $data->{'description'};
1406 return ( \@codes, \%labels );
1409 =head2 GetBorrowercategory
1411 $hashref = &GetBorrowercategory($categorycode);
1413 Given the borrower's category code, the function returns the corresponding
1414 data hashref for a comprehensive information display.
1418 sub GetBorrowercategory {
1420 my $dbh = C4::Context->dbh;
1424 "SELECT description,dateofbirthrequired,upperagelimit,category_type
1426 WHERE categorycode = ?"
1428 $sth->execute($catcode);
1430 $sth->fetchrow_hashref;
1434 } # sub getborrowercategory
1437 =head2 GetBorrowerCategorycode
1439 $categorycode = &GetBorrowerCategoryCode( $borrowernumber );
1441 Given the borrowernumber, the function returns the corresponding categorycode
1444 sub GetBorrowerCategorycode {
1445 my ( $borrowernumber ) = @_;
1446 my $dbh = C4::Context->dbh;
1447 my $sth = $dbh->prepare( qq{
1450 WHERE borrowernumber = ?
1452 $sth->execute( $borrowernumber );
1453 return $sth->fetchrow;
1456 =head2 GetBorrowercategoryList
1458 $arrayref_hashref = &GetBorrowercategoryList;
1459 If no category code provided, the function returns all the categories.
1463 sub GetBorrowercategoryList {
1464 my $dbh = C4::Context->dbh;
1469 ORDER BY description"
1473 $sth->fetchall_arrayref({});
1475 } # sub getborrowercategory
1477 =head2 ethnicitycategories
1479 ($codes_arrayref, $labels_hashref) = ðnicitycategories();
1481 Looks up the different ethnic types in the database. Returns two
1482 elements: a reference-to-array, which lists the ethnicity codes, and a
1483 reference-to-hash, which maps the ethnicity codes to ethnicity
1490 sub ethnicitycategories {
1491 my $dbh = C4::Context->dbh;
1492 my $sth = $dbh->prepare("Select code,name from ethnicity order by name");
1496 while ( my $data = $sth->fetchrow_hashref ) {
1497 push @codes, $data->{'code'};
1498 $labels{ $data->{'code'} } = $data->{'name'};
1500 return ( \@codes, \%labels );
1505 $ethn_name = &fixEthnicity($ethn_code);
1507 Takes an ethnicity code (e.g., "european" or "pi") and returns the
1508 corresponding descriptive name from the C<ethnicity> table in the
1509 Koha database ("European" or "Pacific Islander").
1516 my $ethnicity = shift;
1517 return unless $ethnicity;
1518 my $dbh = C4::Context->dbh;
1519 my $sth = $dbh->prepare("Select name from ethnicity where code = ?");
1520 $sth->execute($ethnicity);
1521 my $data = $sth->fetchrow_hashref;
1522 return $data->{'name'};
1523 } # sub fixEthnicity
1527 $dateofbirth,$date = &GetAge($date);
1529 this function return the borrowers age with the value of dateofbirth
1535 my ( $date, $date_ref ) = @_;
1537 if ( not defined $date_ref ) {
1538 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1541 my ( $year1, $month1, $day1 ) = split /-/, $date;
1542 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1544 my $age = $year2 - $year1;
1545 if ( $month1 . $day1 > $month2 . $day2 ) {
1552 =head2 get_institutions
1554 $insitutions = get_institutions();
1556 Just returns a list of all the borrowers of type I, borrownumber and name
1561 sub get_institutions {
1562 my $dbh = C4::Context->dbh();
1565 "SELECT borrowernumber,surname FROM borrowers WHERE categorycode=? ORDER BY surname"
1569 while ( my $data = $sth->fetchrow_hashref() ) {
1570 $orgs{ $data->{'borrowernumber'} } = $data;
1574 } # sub get_institutions
1576 =head2 add_member_orgs
1578 add_member_orgs($borrowernumber,$borrowernumbers);
1580 Takes a borrowernumber and a list of other borrowernumbers and inserts them into the borrowers_to_borrowers table
1585 sub add_member_orgs {
1586 my ( $borrowernumber, $otherborrowers ) = @_;
1587 my $dbh = C4::Context->dbh();
1589 "INSERT INTO borrowers_to_borrowers (borrower1,borrower2) VALUES (?,?)";
1590 my $sth = $dbh->prepare($query);
1591 foreach my $otherborrowernumber (@$otherborrowers) {
1592 $sth->execute( $borrowernumber, $otherborrowernumber );
1595 } # sub add_member_orgs
1599 $cityarrayref = GetCities();
1601 Returns an array_ref of the entries in the cities table
1602 If there are entries in the table an empty row is returned
1603 This is currently only used to populate a popup in memberentry
1609 my $dbh = C4::Context->dbh;
1610 my $city_arr = $dbh->selectall_arrayref(
1611 q|SELECT cityid,city_zipcode,city_name,city_state,city_country FROM cities ORDER BY city_name|,
1613 if ( @{$city_arr} ) {
1614 unshift @{$city_arr}, {
1615 city_zipcode => q{},
1619 city_country => q{},
1626 =head2 GetSortDetails (OUEST-PROVENCE)
1628 ($lib) = &GetSortDetails($category,$sortvalue);
1630 Returns the authorized value details
1631 C<&$lib>return value of authorized value details
1632 C<&$sortvalue>this is the value of authorized value
1633 C<&$category>this is the value of authorized value category
1637 sub GetSortDetails {
1638 my ( $category, $sortvalue ) = @_;
1639 my $dbh = C4::Context->dbh;
1640 my $query = qq|SELECT lib
1641 FROM authorised_values
1643 AND authorised_value=? |;
1644 my $sth = $dbh->prepare($query);
1645 $sth->execute( $category, $sortvalue );
1646 my $lib = $sth->fetchrow;
1647 return ($lib) if ($lib);
1648 return ($sortvalue) unless ($lib);
1651 =head2 MoveMemberToDeleted
1653 $result = &MoveMemberToDeleted($borrowernumber);
1655 Copy the record from borrowers to deletedborrowers table.
1659 # FIXME: should do it in one SQL statement w/ subquery
1660 # Otherwise, we should return the @data on success
1662 sub MoveMemberToDeleted {
1663 my ($member) = shift or return;
1664 my $dbh = C4::Context->dbh;
1665 my $query = qq|SELECT *
1667 WHERE borrowernumber=?|;
1668 my $sth = $dbh->prepare($query);
1669 $sth->execute($member);
1670 my @data = $sth->fetchrow_array;
1671 (@data) or return; # if we got a bad borrowernumber, there's nothing to insert
1673 $dbh->prepare( "INSERT INTO deletedborrowers VALUES ("
1674 . ( "?," x ( scalar(@data) - 1 ) )
1676 $sth->execute(@data);
1681 DelMember($borrowernumber);
1683 This function remove directly a borrower whitout writing it on deleteborrower.
1684 + Deletes reserves for the borrower
1689 my $dbh = C4::Context->dbh;
1690 my $borrowernumber = shift;
1691 #warn "in delmember with $borrowernumber";
1692 return unless $borrowernumber; # borrowernumber is mandatory.
1694 my $query = qq|DELETE
1696 WHERE borrowernumber=?|;
1697 my $sth = $dbh->prepare($query);
1698 $sth->execute($borrowernumber);
1702 WHERE borrowernumber = ?
1704 $sth = $dbh->prepare($query);
1705 $sth->execute($borrowernumber);
1706 logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
1710 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1712 $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1714 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1719 sub ExtendMemberSubscriptionTo {
1720 my ( $borrowerid,$date) = @_;
1721 my $dbh = C4::Context->dbh;
1722 my $borrower = GetMember('borrowernumber'=>$borrowerid);
1724 $date = (C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry') ?
1725 C4::Dates->new($borrower->{'dateexpiry'}, 'iso')->output("iso") :
1726 C4::Dates->new()->output("iso");
1727 $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
1729 my $sth = $dbh->do(<<EOF);
1731 SET dateexpiry='$date'
1732 WHERE borrowernumber='$borrowerid'
1734 # add enrolmentfee if needed
1735 $sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
1736 $sth->execute($borrower->{'categorycode'});
1737 my ($enrolmentfee) = $sth->fetchrow;
1738 if ($enrolmentfee && $enrolmentfee > 0) {
1739 # insert fee in patron debts
1740 manualinvoice($borrower->{'borrowernumber'}, '', '', 'A', $enrolmentfee);
1742 logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
1743 return $date if ($sth);
1747 =head2 GetRoadTypes (OUEST-PROVENCE)
1749 ($idroadtypearrayref, $roadttype_hashref) = &GetRoadTypes();
1751 Looks up the different road type . Returns two
1752 elements: a reference-to-array, which lists the id_roadtype
1753 codes, and a reference-to-hash, which maps the road type of the road .
1758 my $dbh = C4::Context->dbh;
1760 SELECT roadtypeid,road_type
1762 ORDER BY road_type|;
1763 my $sth = $dbh->prepare($query);
1768 # insert empty value to create a empty choice in cgi popup
1770 while ( my $data = $sth->fetchrow_hashref ) {
1772 push @id, $data->{'roadtypeid'};
1773 $roadtype{ $data->{'roadtypeid'} } = $data->{'road_type'};
1776 #test to know if the table contain some records if no the function return nothing
1783 return ( \@id, \%roadtype );
1789 =head2 GetTitles (OUEST-PROVENCE)
1791 ($borrowertitle)= &GetTitles();
1793 Looks up the different title . Returns array with all borrowers title
1798 my @borrowerTitle = split (/,|\|/,C4::Context->preference('BorrowersTitles'));
1799 unshift( @borrowerTitle, "" );
1800 my $count=@borrowerTitle;
1805 return ( \@borrowerTitle);
1809 =head2 GetPatronImage
1811 my ($imagedata, $dberror) = GetPatronImage($cardnumber);
1813 Returns the mimetype and binary image data of the image for the patron with the supplied cardnumber.
1817 sub GetPatronImage {
1818 my ($cardnumber) = @_;
1819 warn "Cardnumber passed to GetPatronImage is $cardnumber" if $debug;
1820 my $dbh = C4::Context->dbh;
1821 my $query = 'SELECT mimetype, imagefile FROM patronimage WHERE cardnumber = ?';
1822 my $sth = $dbh->prepare($query);
1823 $sth->execute($cardnumber);
1824 my $imagedata = $sth->fetchrow_hashref;
1825 warn "Database error!" if $sth->errstr;
1826 return $imagedata, $sth->errstr;
1829 =head2 PutPatronImage
1831 PutPatronImage($cardnumber, $mimetype, $imgfile);
1833 Stores patron binary image data and mimetype in database.
1834 NOTE: This function is good for updating images as well as inserting new images in the database.
1838 sub PutPatronImage {
1839 my ($cardnumber, $mimetype, $imgfile) = @_;
1840 warn "Parameters passed in: Cardnumber=$cardnumber, Mimetype=$mimetype, " . ($imgfile ? "Imagefile" : "No Imagefile") if $debug;
1841 my $dbh = C4::Context->dbh;
1842 my $query = "INSERT INTO patronimage (cardnumber, mimetype, imagefile) VALUES (?,?,?) ON DUPLICATE KEY UPDATE imagefile = ?;";
1843 my $sth = $dbh->prepare($query);
1844 $sth->execute($cardnumber,$mimetype,$imgfile,$imgfile);
1845 warn "Error returned inserting $cardnumber.$mimetype." if $sth->errstr;
1846 return $sth->errstr;
1849 =head2 RmPatronImage
1851 my ($dberror) = RmPatronImage($cardnumber);
1853 Removes the image for the patron with the supplied cardnumber.
1858 my ($cardnumber) = @_;
1859 warn "Cardnumber passed to GetPatronImage is $cardnumber" if $debug;
1860 my $dbh = C4::Context->dbh;
1861 my $query = "DELETE FROM patronimage WHERE cardnumber = ?;";
1862 my $sth = $dbh->prepare($query);
1863 $sth->execute($cardnumber);
1864 my $dberror = $sth->errstr;
1865 warn "Database error!" if $sth->errstr;
1869 =head2 GetHideLostItemsPreference
1871 $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1873 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1874 C<&$hidelostitemspref>return value of function, 0 or 1
1878 sub GetHideLostItemsPreference {
1879 my ($borrowernumber) = @_;
1880 my $dbh = C4::Context->dbh;
1881 my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1882 my $sth = $dbh->prepare($query);
1883 $sth->execute($borrowernumber);
1884 my $hidelostitems = $sth->fetchrow;
1885 return $hidelostitems;
1888 =head2 GetRoadTypeDetails (OUEST-PROVENCE)
1890 ($roadtype) = &GetRoadTypeDetails($roadtypeid);
1892 Returns the description of roadtype
1893 C<&$roadtype>return description of road type
1894 C<&$roadtypeid>this is the value of roadtype s
1898 sub GetRoadTypeDetails {
1899 my ($roadtypeid) = @_;
1900 my $dbh = C4::Context->dbh;
1904 WHERE roadtypeid=?|;
1905 my $sth = $dbh->prepare($query);
1906 $sth->execute($roadtypeid);
1907 my $roadtype = $sth->fetchrow;
1911 =head2 GetBorrowersWhoHaveNotBorrowedSince
1913 &GetBorrowersWhoHaveNotBorrowedSince($date)
1915 this function get all borrowers who haven't borrowed since the date given on input arg.
1919 sub GetBorrowersWhoHaveNotBorrowedSince {
1920 my $filterdate = shift||POSIX::strftime("%Y-%m-%d",localtime());
1921 my $filterexpiry = shift;
1922 my $filterbranch = shift ||
1923 ((C4::Context->preference('IndependantBranches')
1924 && C4::Context->userenv
1925 && C4::Context->userenv->{flags} % 2 !=1
1926 && C4::Context->userenv->{branch})
1927 ? C4::Context->userenv->{branch}
1929 my $dbh = C4::Context->dbh;
1931 SELECT borrowers.borrowernumber,
1932 max(old_issues.timestamp) as latestissue,
1933 max(issues.timestamp) as currentissue
1935 JOIN categories USING (categorycode)
1936 LEFT JOIN old_issues USING (borrowernumber)
1937 LEFT JOIN issues USING (borrowernumber)
1938 WHERE category_type <> 'S'
1939 AND borrowernumber NOT IN (SELECT guarantorid FROM borrowers WHERE guarantorid IS NOT NULL AND guarantorid <> 0)
1942 if ($filterbranch && $filterbranch ne ""){
1943 $query.=" AND borrowers.branchcode= ?";
1944 push @query_params,$filterbranch;
1947 $query .= " AND dateexpiry < ? ";
1948 push @query_params,$filterdate;
1950 $query.=" GROUP BY borrowers.borrowernumber";
1952 $query.=" HAVING (latestissue < ? OR latestissue IS NULL)
1953 AND currentissue IS NULL";
1954 push @query_params,$filterdate;
1956 warn $query if $debug;
1957 my $sth = $dbh->prepare($query);
1958 if (scalar(@query_params)>0){
1959 $sth->execute(@query_params);
1966 while ( my $data = $sth->fetchrow_hashref ) {
1967 push @results, $data;
1972 =head2 GetBorrowersWhoHaveNeverBorrowed
1974 $results = &GetBorrowersWhoHaveNeverBorrowed
1976 This function get all borrowers who have never borrowed.
1978 I<$result> is a ref to an array which all elements are a hasref.
1982 sub GetBorrowersWhoHaveNeverBorrowed {
1983 my $filterbranch = shift ||
1984 ((C4::Context->preference('IndependantBranches')
1985 && C4::Context->userenv
1986 && C4::Context->userenv->{flags} % 2 !=1
1987 && C4::Context->userenv->{branch})
1988 ? C4::Context->userenv->{branch}
1990 my $dbh = C4::Context->dbh;
1992 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
1994 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
1995 WHERE issues.borrowernumber IS NULL
1998 if ($filterbranch && $filterbranch ne ""){
1999 $query.=" AND borrowers.branchcode= ?";
2000 push @query_params,$filterbranch;
2002 warn $query if $debug;
2004 my $sth = $dbh->prepare($query);
2005 if (scalar(@query_params)>0){
2006 $sth->execute(@query_params);
2013 while ( my $data = $sth->fetchrow_hashref ) {
2014 push @results, $data;
2019 =head2 GetBorrowersWithIssuesHistoryOlderThan
2021 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
2023 this function get all borrowers who has an issue history older than I<$date> given on input arg.
2025 I<$result> is a ref to an array which all elements are a hashref.
2026 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2030 sub GetBorrowersWithIssuesHistoryOlderThan {
2031 my $dbh = C4::Context->dbh;
2032 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
2033 my $filterbranch = shift ||
2034 ((C4::Context->preference('IndependantBranches')
2035 && C4::Context->userenv
2036 && C4::Context->userenv->{flags} % 2 !=1
2037 && C4::Context->userenv->{branch})
2038 ? C4::Context->userenv->{branch}
2041 SELECT count(borrowernumber) as n,borrowernumber
2043 WHERE returndate < ?
2044 AND borrowernumber IS NOT NULL
2047 push @query_params, $date;
2049 $query.=" AND branchcode = ?";
2050 push @query_params, $filterbranch;
2052 $query.=" GROUP BY borrowernumber ";
2053 warn $query if $debug;
2054 my $sth = $dbh->prepare($query);
2055 $sth->execute(@query_params);
2058 while ( my $data = $sth->fetchrow_hashref ) {
2059 push @results, $data;
2064 =head2 GetBorrowersNamesAndLatestIssue
2066 $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
2068 this function get borrowers Names and surnames and Issue information.
2070 I<@borrowernumbers> is an array which all elements are borrowernumbers.
2071 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2075 sub GetBorrowersNamesAndLatestIssue {
2076 my $dbh = C4::Context->dbh;
2077 my @borrowernumbers=@_;
2079 SELECT surname,lastname, phone, email,max(timestamp)
2081 LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
2082 GROUP BY borrowernumber
2084 my $sth = $dbh->prepare($query);
2086 my $results = $sth->fetchall_arrayref({});
2092 my $success = DebarMember( $borrowernumber, $todate );
2094 marks a Member as debarred, and therefore unable to checkout any more
2098 true on success, false on failure
2103 my $borrowernumber = shift;
2106 return unless defined $borrowernumber;
2107 return unless $borrowernumber =~ /^\d+$/;
2110 borrowernumber => $borrowernumber,
2120 my $success = ModPrivacy( $borrowernumber, $privacy );
2122 Update the privacy of a patron.
2125 true on success, false on failure
2132 my $borrowernumber = shift;
2133 my $privacy = shift;
2134 return unless defined $borrowernumber;
2135 return unless $borrowernumber =~ /^\d+$/;
2137 return ModMember( borrowernumber => $borrowernumber,
2138 privacy => $privacy );
2143 AddMessage( $borrowernumber, $message_type, $message, $branchcode );
2145 Adds a message to the messages table for the given borrower.
2154 my ( $borrowernumber, $message_type, $message, $branchcode ) = @_;
2156 my $dbh = C4::Context->dbh;
2158 if ( ! ( $borrowernumber && $message_type && $message && $branchcode ) ) {
2162 my $query = "INSERT INTO messages ( borrowernumber, branchcode, message_type, message ) VALUES ( ?, ?, ?, ? )";
2163 my $sth = $dbh->prepare($query);
2164 $sth->execute( $borrowernumber, $branchcode, $message_type, $message );
2165 logaction("MEMBERS", "ADDCIRCMESSAGE", $borrowernumber, $message) if C4::Context->preference("BorrowersLog");
2171 GetMessages( $borrowernumber, $type );
2173 $type is message type, B for borrower, or L for Librarian.
2174 Empty type returns all messages of any type.
2176 Returns all messages for the given borrowernumber
2181 my ( $borrowernumber, $type, $branchcode ) = @_;
2187 my $dbh = C4::Context->dbh;
2190 branches.branchname,
2193 messages.branchcode LIKE '$branchcode' AS can_delete
2194 FROM messages, branches
2195 WHERE borrowernumber = ?
2196 AND message_type LIKE ?
2197 AND messages.branchcode = branches.branchcode
2198 ORDER BY message_date DESC";
2199 my $sth = $dbh->prepare($query);
2200 $sth->execute( $borrowernumber, $type ) ;
2203 while ( my $data = $sth->fetchrow_hashref ) {
2204 my $d = C4::Dates->new( $data->{message_date}, 'iso' );
2205 $data->{message_date_formatted} = $d->output;
2206 push @results, $data;
2214 GetMessagesCount( $borrowernumber, $type );
2216 $type is message type, B for borrower, or L for Librarian.
2217 Empty type returns all messages of any type.
2219 Returns the number of messages for the given borrowernumber
2223 sub GetMessagesCount {
2224 my ( $borrowernumber, $type, $branchcode ) = @_;
2230 my $dbh = C4::Context->dbh;
2232 my $query = "SELECT COUNT(*) as MsgCount FROM messages WHERE borrowernumber = ? AND message_type LIKE ?";
2233 my $sth = $dbh->prepare($query);
2234 $sth->execute( $borrowernumber, $type ) ;
2237 my $data = $sth->fetchrow_hashref;
2238 my $count = $data->{'MsgCount'};
2245 =head2 DeleteMessage
2247 DeleteMessage( $message_id );
2252 my ( $message_id ) = @_;
2254 my $dbh = C4::Context->dbh;
2255 my $query = "SELECT * FROM messages WHERE message_id = ?";
2256 my $sth = $dbh->prepare($query);
2257 $sth->execute( $message_id );
2258 my $message = $sth->fetchrow_hashref();
2260 $query = "DELETE FROM messages WHERE message_id = ?";
2261 $sth = $dbh->prepare($query);
2262 $sth->execute( $message_id );
2263 logaction("MEMBERS", "DELCIRCMESSAGE", $message->{'borrowernumber'}, $message->{'message'}) if C4::Context->preference("BorrowersLog");
2268 IssueSlip($branchcode, $borrowernumber, $quickslip)
2270 Returns letter hash ( see C4::Letters::GetPreparedLetter )
2272 $quickslip is boolean, to indicate whether we want a quick slip
2277 my ($branch, $borrowernumber, $quickslip) = @_;
2279 # return unless ( C4::Context->boolean_preference('printcirculationslips') );
2281 my $now = POSIX::strftime("%Y-%m-%d", localtime);
2283 my $issueslist = GetPendingIssues($borrowernumber);
2284 foreach my $it (@$issueslist){
2285 if ((substr $it->{'issuedate'}, 0, 10) eq $now) {
2288 elsif ((substr $it->{'date_due'}, 0, 10) le $now) {
2289 $it->{'overdue'} = 1;
2292 $it->{'date_due'}=format_date($it->{'date_due'});
2294 my @issues = sort { $b->{'timestamp'} <=> $a->{'timestamp'} } @$issueslist;
2296 my ($letter_code, %repeat);
2298 $letter_code = 'ISSUEQSLIP';
2300 'checkedout' => [ map {
2304 }, grep { $_->{'now'} } @issues ],
2308 $letter_code = 'ISSUESLIP';
2310 'checkedout' => [ map {
2314 }, grep { !$_->{'overdue'} } @issues ],
2316 'overdue' => [ map {
2320 }, grep { $_->{'overdue'} } @issues ],
2323 $_->{'timestamp'} = $_->{'newdate'};
2325 } @{ GetNewsToDisplay("slip") } ],
2329 return C4::Letters::GetPreparedLetter (
2330 module => 'circulation',
2331 letter_code => $letter_code,
2332 branchcode => $branch,
2334 'branches' => $branch,
2335 'borrowers' => $borrowernumber,
2341 =head2 GetBorrowersWithEmail
2343 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
2345 This gets a list of users and their basic details from their email address.
2346 As it's possible for multiple user to have the same email address, it provides
2347 you with all of them. If there is no userid for the user, there will be an
2348 C<undef> there. An empty list will be returned if there are no matches.
2352 sub GetBorrowersWithEmail {
2355 my $dbh = C4::Context->dbh;
2357 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
2358 my $sth=$dbh->prepare($query);
2359 $sth->execute($email);
2361 while (my $ref = $sth->fetch) {
2364 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
2369 END { } # module clean-up code here (global destructor)