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;
42 our ($VERSION,@ISA,@EXPORT,@EXPORT_OK,$debug);
46 $debug = $ENV{DEBUG} || 0;
58 &GetMemberIssuesAndFines
66 &GetFirstValidEmailAddress
79 &GetHideLostItemsPreference
82 &GetMemberAccountRecords
83 &GetBorNotifyAcctRecord
87 &GetBorrowercategoryList
89 &GetBorrowersWhoHaveNotBorrowedSince
90 &GetBorrowersWhoHaveNeverBorrowed
91 &GetBorrowersWithIssuesHistoryOlderThan
101 GetBorrowersWithEmail
121 &ExtendMemberSubscriptionTo
139 C4::Members - Perl Module containing convenience functions for member handling
147 This module contains routines for adding, modifying and deleting members/patrons/borrowers
153 $borrowers_result_array_ref = &Search($filter,$orderby, $limit,
154 $columns_out, $search_on_fields,$searchtype);
156 Looks up patrons (borrowers) on filter. A wrapper for SearchInTable('borrowers').
158 For C<$filter>, C<$orderby>, C<$limit>, C<&columns_out>, C<&search_on_fields> and C<&searchtype>
159 refer to C4::SQLHelper:SearchInTable().
161 Special C<$filter> key '' is effectively expanded to search on surname firstname othernamescw
162 and cardnumber unless C<&search_on_fields> is defined
166 $borrowers = Search('abcd', 'cardnumber');
168 $borrowers = Search({''=>'abcd', category_type=>'I'}, 'surname');
172 sub _express_member_find {
175 # this is used by circulation everytime a new borrowers cardnumber is scanned
176 # so we can check an exact match first, if that works return, otherwise do the rest
177 my $dbh = C4::Context->dbh;
178 my $query = "SELECT borrowernumber FROM borrowers WHERE cardnumber = ?";
179 if ( my $borrowernumber = $dbh->selectrow_array($query, undef, $filter) ) {
180 return( {"borrowernumber"=>$borrowernumber} );
183 my ($search_on_fields, $searchtype);
184 if ( length($filter) == 1 ) {
185 $search_on_fields = [ qw(surname) ];
186 $searchtype = 'start_with';
188 $search_on_fields = [ qw(surname firstname othernames cardnumber) ];
189 $searchtype = 'contain';
192 return (undef, $search_on_fields, $searchtype);
196 my ( $filter, $orderby, $limit, $columns_out, $search_on_fields, $searchtype ) = @_;
201 if ( my $fr = ref $filter ) {
202 if ( $fr eq "HASH" ) {
203 if ( my $search_string = $filter->{''} ) {
204 my ($member_filter, $member_search_on_fields, $member_searchtype) = _express_member_find($search_string);
205 if ($member_filter) {
206 $filter = $member_filter;
209 $search_on_fields ||= $member_search_on_fields;
210 $searchtype ||= $member_searchtype;
215 $search_string = $filter;
219 $search_string = $filter;
220 my ($member_filter, $member_search_on_fields, $member_searchtype) = _express_member_find($search_string);
221 if ($member_filter) {
222 $filter = $member_filter;
225 $search_on_fields ||= $member_search_on_fields;
226 $searchtype ||= $member_searchtype;
230 if ( !$found_borrower && C4::Context->preference('ExtendedPatronAttributes') && $search_string ) {
231 my $matching_records = C4::Members::Attributes::SearchIdMatchingAttribute($search_string);
232 if(scalar(@$matching_records)>0) {
233 if ( my $fr = ref $filter ) {
234 if ( $fr eq "HASH" ) {
236 $filter = [ $filter ];
238 push @$filter, { %f, "borrowernumber"=>$$matching_records };
241 push @$filter, {"borrowernumber"=>$matching_records};
245 $filter = [ $filter ];
246 push @$filter, {"borrowernumber"=>$matching_records};
251 # $showallbranches was not used at the time SearchMember() was mainstreamed into Search().
252 # Mentioning for the reference
254 if ( C4::Context->preference("IndependantBranches") ) { # && !$showallbranches){
255 if ( my $userenv = C4::Context->userenv ) {
256 my $branch = $userenv->{'branch'};
257 if ( ($userenv->{flags} % 2 !=1) &&
258 $branch && $branch ne "insecure" ){
260 if (my $fr = ref $filter) {
261 if ( $fr eq "HASH" ) {
262 $filter->{branchcode} = $branch;
266 $_ = { '' => $_ } unless ref $_;
267 $_->{branchcode} = $branch;
272 $filter = { '' => $filter, branchcode => $branch };
278 if ($found_borrower) {
279 $searchtype = "exact";
281 $searchtype ||= "start_with";
283 return SearchInTable( "borrowers", $filter, $orderby, $limit, $columns_out, $search_on_fields, $searchtype );
286 =head2 GetMemberDetails
288 ($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
290 Looks up a patron and returns information about him or her. If
291 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
292 up the borrower by number; otherwise, it looks up the borrower by card
295 C<$borrower> is a reference-to-hash whose keys are the fields of the
296 borrowers table in the Koha database. In addition,
297 C<$borrower-E<gt>{flags}> is a hash giving more detailed information
298 about the patron. Its keys act as flags :
300 if $borrower->{flags}->{LOST} {
301 # Patron's card was reported lost
304 If the state of a flag means that the patron should not be
305 allowed to borrow any more books, then it will have a C<noissues> key
308 See patronflags for more details.
310 C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
311 about the top-level permissions flags set for the borrower. For example,
312 if a user has the "editcatalogue" permission,
313 C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
318 sub GetMemberDetails {
319 my ( $borrowernumber, $cardnumber ) = @_;
320 my $dbh = C4::Context->dbh;
323 if ($borrowernumber) {
324 $sth = $dbh->prepare("SELECT borrowers.*,category_type,categories.description,reservefee,enrolmentperiod FROM borrowers LEFT JOIN categories ON borrowers.categorycode=categories.categorycode WHERE borrowernumber=?");
325 $sth->execute($borrowernumber);
327 elsif ($cardnumber) {
328 $sth = $dbh->prepare("SELECT borrowers.*,category_type,categories.description,reservefee,enrolmentperiod FROM borrowers LEFT JOIN categories ON borrowers.categorycode=categories.categorycode WHERE cardnumber=?");
329 $sth->execute($cardnumber);
334 my $borrower = $sth->fetchrow_hashref;
335 my ($amount) = GetMemberAccountRecords( $borrowernumber);
336 $borrower->{'amountoutstanding'} = $amount;
337 # FIXME - patronflags calls GetMemberAccountRecords... just have patronflags return $amount
338 my $flags = patronflags( $borrower);
341 $sth = $dbh->prepare("select bit,flag from userflags");
343 while ( my ( $bit, $flag ) = $sth->fetchrow ) {
344 if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
345 $accessflagshash->{$flag} = 1;
348 $borrower->{'flags'} = $flags;
349 $borrower->{'authflags'} = $accessflagshash;
351 # For the purposes of making templates easier, we'll define a
352 # 'showname' which is the alternate form the user's first name if
353 # 'other name' is defined.
354 if ($borrower->{category_type} eq 'I') {
355 $borrower->{'showname'} = $borrower->{'othernames'};
356 $borrower->{'showname'} .= " $borrower->{'firstname'}" if $borrower->{'firstname'};
358 $borrower->{'showname'} = $borrower->{'firstname'};
361 return ($borrower); #, $flags, $accessflagshash);
366 $flags = &patronflags($patron);
368 This function is not exported.
370 The following will be set where applicable:
371 $flags->{CHARGES}->{amount} Amount of debt
372 $flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge)
373 $flags->{CHARGES}->{message} Message -- deprecated
375 $flags->{CREDITS}->{amount} Amount of credit
376 $flags->{CREDITS}->{message} Message -- deprecated
378 $flags->{ GNA } Patron has no valid address
379 $flags->{ GNA }->{noissues} Set for each GNA
380 $flags->{ GNA }->{message} "Borrower has no valid address" -- deprecated
382 $flags->{ LOST } Patron's card reported lost
383 $flags->{ LOST }->{noissues} Set for each LOST
384 $flags->{ LOST }->{message} Message -- deprecated
386 $flags->{DBARRED} Set if patron debarred, no access
387 $flags->{DBARRED}->{noissues} Set for each DBARRED
388 $flags->{DBARRED}->{message} Message -- deprecated
391 $flags->{ NOTES }->{message} The note itself. NOT deprecated
393 $flags->{ ODUES } Set if patron has overdue books.
394 $flags->{ ODUES }->{message} "Yes" -- deprecated
395 $flags->{ ODUES }->{itemlist} ref-to-array: list of overdue books
396 $flags->{ ODUES }->{itemlisttext} Text list of overdue items -- deprecated
398 $flags->{WAITING} Set if any of patron's reserves are available
399 $flags->{WAITING}->{message} Message -- deprecated
400 $flags->{WAITING}->{itemlist} ref-to-array: list of available items
404 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
405 overdue items. Its elements are references-to-hash, each describing an
406 overdue item. The keys are selected fields from the issues, biblio,
407 biblioitems, and items tables of the Koha database.
409 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
410 the overdue items, one per line. Deprecated.
412 =item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
413 available items. Each element is a reference-to-hash whose keys are
414 fields from the reserves table of the Koha database.
418 All the "message" fields that include language generated in this function are deprecated,
419 because such strings belong properly in the display layer.
421 The "message" field that comes from the DB is OK.
425 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
426 # FIXME rename this function.
429 my ( $patroninformation) = @_;
430 my $dbh=C4::Context->dbh;
431 my ($amount) = GetMemberAccountRecords( $patroninformation->{'borrowernumber'});
434 my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
435 $flaginfo{'message'} = sprintf "Patron owes \$%.02f", $amount;
436 $flaginfo{'amount'} = sprintf "%.02f", $amount;
437 if ( $amount > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
438 $flaginfo{'noissues'} = 1;
440 $flags{'CHARGES'} = \%flaginfo;
442 elsif ( $amount < 0 ) {
444 $flaginfo{'message'} = sprintf "Patron has credit of \$%.02f", -$amount;
445 $flaginfo{'amount'} = sprintf "%.02f", $amount;
446 $flags{'CREDITS'} = \%flaginfo;
448 if ( $patroninformation->{'gonenoaddress'}
449 && $patroninformation->{'gonenoaddress'} == 1 )
452 $flaginfo{'message'} = 'Borrower has no valid address.';
453 $flaginfo{'noissues'} = 1;
454 $flags{'GNA'} = \%flaginfo;
456 if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
458 $flaginfo{'message'} = 'Borrower\'s card reported lost.';
459 $flaginfo{'noissues'} = 1;
460 $flags{'LOST'} = \%flaginfo;
462 if ( $patroninformation->{'debarred'} && check_date( split( /-/, $patroninformation->{'debarred'} ) ) ) {
463 if ( Date_to_Days(Date::Calc::Today) < Date_to_Days( split( /-/, $patroninformation->{'debarred'} ) ) ) {
465 $flaginfo{'debarredcomment'} = $patroninformation->{'debarredcomment'};
466 $flaginfo{'message'} = $patroninformation->{'debarredcomment'};
467 $flaginfo{'noissues'} = 1;
468 $flaginfo{'dateend'} = $patroninformation->{'debarred'};
469 $flags{'DBARRED'} = \%flaginfo;
472 if ( $patroninformation->{'borrowernotes'}
473 && $patroninformation->{'borrowernotes'} )
476 $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
477 $flags{'NOTES'} = \%flaginfo;
479 my ( $odues, $itemsoverdue ) = C4::Overdues::checkoverdues($patroninformation->{'borrowernumber'});
480 if ( $odues && $odues > 0 ) {
482 $flaginfo{'message'} = "Yes";
483 $flaginfo{'itemlist'} = $itemsoverdue;
484 foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
487 $flaginfo{'itemlisttext'} .=
488 "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n"; # newline is display layer
490 $flags{'ODUES'} = \%flaginfo;
492 my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
493 my $nowaiting = scalar @itemswaiting;
494 if ( $nowaiting > 0 ) {
496 $flaginfo{'message'} = "Reserved items available";
497 $flaginfo{'itemlist'} = \@itemswaiting;
498 $flags{'WAITING'} = \%flaginfo;
506 $borrower = &GetMember(%information);
508 Retrieve the first patron record meeting on criteria listed in the
509 C<%information> hash, which should contain one or more
510 pairs of borrowers column names and values, e.g.,
512 $borrower = GetMember(borrowernumber => id);
514 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
515 the C<borrowers> table in the Koha database.
517 FIXME: GetMember() is used throughout the code as a lookup
518 on a unique key such as the borrowernumber, but this meaning is not
519 enforced in the routine itself.
525 my ( %information ) = @_;
526 if (exists $information{borrowernumber} && !defined $information{borrowernumber}) {
527 #passing mysql's kohaadmin?? Makes no sense as a query
530 my $dbh = C4::Context->dbh;
532 q{SELECT borrowers.*, categories.category_type, categories.description
534 LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
537 for (keys %information ) {
545 if (defined $information{$_}) {
547 push @values, $information{$_};
550 $select .= "$_ IS NULL";
553 $debug && warn $select, " ",values %information;
554 my $sth = $dbh->prepare("$select");
555 $sth->execute(map{$information{$_}} keys %information);
556 my $data = $sth->fetchall_arrayref({});
557 #FIXME interface to this routine now allows generation of a result set
558 #so whole array should be returned but bowhere in the current code expects this
566 =head2 GetMemberRelatives
568 @borrowernumbers = GetMemberRelatives($borrowernumber);
570 C<GetMemberRelatives> returns a borrowersnumber's list of guarantor/guarantees of the member given in parameter
573 sub GetMemberRelatives {
574 my $borrowernumber = shift;
575 my $dbh = C4::Context->dbh;
579 my $query = "SELECT guarantorid FROM borrowers WHERE borrowernumber=?";
580 my $sth = $dbh->prepare($query);
581 $sth->execute($borrowernumber);
582 my $data = $sth->fetchrow_arrayref();
583 push @glist, $data->[0] if $data->[0];
584 my $guarantor = $data->[0] if $data->[0];
587 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
588 $sth = $dbh->prepare($query);
589 $sth->execute($borrowernumber);
590 while ($data = $sth->fetchrow_arrayref()) {
591 push @glist, $data->[0];
594 # Getting sibling guarantees
596 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
597 $sth = $dbh->prepare($query);
598 $sth->execute($guarantor);
599 while ($data = $sth->fetchrow_arrayref()) {
600 push @glist, $data->[0] if ($data->[0] != $borrowernumber);
607 =head2 IsMemberBlocked
609 my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
611 Returns whether a patron has overdue items that may result
612 in a block or whether the patron has active fine days
613 that would block circulation privileges.
615 C<$block_status> can have the following values:
617 1 if the patron has outstanding fine days, in which case C<$count> is the number of them
619 -1 if the patron has overdue items, in which case C<$count> is the number of them
621 0 if the patron has no overdue items or outstanding fine days, in which case C<$count> is 0
623 Outstanding fine days are checked before current overdue items
626 FIXME: this needs to be split into two functions; a potential block
627 based on the number of current overdue items could be orthogonal
628 to a block based on whether the patron has any fine days accrued.
632 sub IsMemberBlocked {
633 my $borrowernumber = shift;
634 my $dbh = C4::Context->dbh;
636 my $blockeddate = CheckBorrowerDebarred($borrowernumber);
638 return ( 1, $blockeddate ) if $blockeddate;
640 # if he have late issues
641 my $sth = $dbh->prepare(
642 "SELECT COUNT(*) as latedocs
644 WHERE borrowernumber = ?
645 AND date_due < now()"
647 $sth->execute($borrowernumber);
648 my $latedocs = $sth->fetchrow_hashref->{'latedocs'};
650 return ( -1, $latedocs ) if $latedocs > 0;
655 =head2 GetMemberIssuesAndFines
657 ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
659 Returns aggregate data about items borrowed by the patron with the
660 given borrowernumber.
662 C<&GetMemberIssuesAndFines> returns a three-element array. C<$overdue_count> is the
663 number of overdue items the patron currently has borrowed. C<$issue_count> is the
664 number of books the patron currently has borrowed. C<$total_fines> is
665 the total fine currently due by the borrower.
670 sub GetMemberIssuesAndFines {
671 my ( $borrowernumber ) = @_;
672 my $dbh = C4::Context->dbh;
673 my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
675 $debug and warn $query."\n";
676 my $sth = $dbh->prepare($query);
677 $sth->execute($borrowernumber);
678 my $issue_count = $sth->fetchrow_arrayref->[0];
680 $sth = $dbh->prepare(
681 "SELECT COUNT(*) FROM issues
682 WHERE borrowernumber = ?
683 AND date_due < now()"
685 $sth->execute($borrowernumber);
686 my $overdue_count = $sth->fetchrow_arrayref->[0];
688 $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
689 $sth->execute($borrowernumber);
690 my $total_fines = $sth->fetchrow_arrayref->[0];
692 return ($overdue_count, $issue_count, $total_fines);
697 my $success = ModMember(borrowernumber => $borrowernumber,
698 [ field => value ]... );
700 Modify borrower's data. All date fields should ALREADY be in ISO format.
703 true on success, or false on failure
709 # test to know if you must update or not the borrower password
710 if (exists $data{password}) {
711 if ($data{password} eq '****' or $data{password} eq '') {
712 delete $data{password};
714 $data{password} = md5_base64($data{password});
717 my $execute_success=UpdateInTable("borrowers",\%data);
718 if ($execute_success) { # only proceed if the update was a success
719 # ok if its an adult (type) it may have borrowers that depend on it as a guarantor
720 # so when we update information for an adult we should check for guarantees and update the relevant part
721 # of their records, ie addresses and phone numbers
722 my $borrowercategory= GetBorrowercategory( $data{'category_type'} );
723 if ( exists $borrowercategory->{'category_type'} && $borrowercategory->{'category_type'} eq ('A' || 'S') ) {
724 # is adult check guarantees;
725 UpdateGuarantees(%data);
727 logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
729 return $execute_success;
735 $borrowernumber = &AddMember(%borrower);
737 insert new borrower into table
738 Returns the borrowernumber upon success
740 Returns as undef upon any db error without further processing
747 my $dbh = C4::Context->dbh;
748 # generate a proper login if none provided
749 $data{'userid'} = Generate_Userid($data{'borrowernumber'}, $data{'firstname'}, $data{'surname'}) if $data{'userid'} eq '';
750 # create a disabled account if no password provided
751 $data{'password'} = ($data{'password'})? md5_base64($data{'password'}) : '!';
752 $data{'borrowernumber'}=InsertInTable("borrowers",\%data);
753 # mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
754 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
756 # check for enrollment fee & add it if needed
757 my $sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
758 $sth->execute($data{'categorycode'});
759 my ($enrolmentfee) = $sth->fetchrow;
761 warn sprintf('Database returned the following error: %s', $sth->errstr);
764 if ($enrolmentfee && $enrolmentfee > 0) {
765 # insert fee in patron debts
766 manualinvoice($data{'borrowernumber'}, '', '', 'A', $enrolmentfee);
769 return $data{'borrowernumber'};
774 my ($uid,$member) = @_;
775 my $dbh = C4::Context->dbh;
776 # Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
777 # Then we need to tell the user and have them create a new one.
780 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
781 $sth->execute( $uid, $member );
782 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
790 sub Generate_Userid {
791 my ($borrowernumber, $firstname, $surname) = @_;
795 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
796 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
797 $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
798 $newuid .= $offset unless $offset == 0;
801 } while (!Check_Userid($newuid,$borrowernumber));
807 my ( $uid, $member, $digest ) = @_;
808 my $dbh = C4::Context->dbh;
810 #Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
811 #Then we need to tell the user and have them create a new one.
815 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
816 $sth->execute( $uid, $member );
817 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
821 #Everything is good so we can update the information.
824 "update borrowers set userid=?, password=? where borrowernumber=?");
825 $sth->execute( $uid, $digest, $member );
829 logaction("MEMBERS", "CHANGE PASS", $member, "") if C4::Context->preference("BorrowersLog");
835 =head2 fixup_cardnumber
837 Warning: The caller is responsible for locking the members table in write
838 mode, to avoid database corruption.
842 use vars qw( @weightings );
843 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
845 sub fixup_cardnumber ($) {
846 my ($cardnumber) = @_;
847 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
849 # Find out whether member numbers should be generated
850 # automatically. Should be either "1" or something else.
851 # Defaults to "0", which is interpreted as "no".
853 # if ($cardnumber !~ /\S/ && $autonumber_members) {
854 ($autonumber_members) or return $cardnumber;
855 my $checkdigit = C4::Context->preference('checkdigit');
856 my $dbh = C4::Context->dbh;
857 if ( $checkdigit and $checkdigit eq 'katipo' ) {
859 # if checkdigit is selected, calculate katipo-style cardnumber.
860 # otherwise, just use the max()
861 # purpose: generate checksum'd member numbers.
862 # We'll assume we just got the max value of digits 2-8 of member #'s
863 # from the database and our job is to increment that by one,
864 # determine the 1st and 9th digits and return the full string.
865 my $sth = $dbh->prepare(
866 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
869 my $data = $sth->fetchrow_hashref;
870 $cardnumber = $data->{new_num};
871 if ( !$cardnumber ) { # If DB has no values,
872 $cardnumber = 1000000; # start at 1000000
878 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
879 # read weightings, left to right, 1 char at a time
880 my $temp1 = $weightings[$i];
882 # sequence left to right, 1 char at a time
883 my $temp2 = substr( $cardnumber, $i, 1 );
885 # mult each char 1-7 by its corresponding weighting
886 $sum += $temp1 * $temp2;
889 my $rem = ( $sum % 11 );
890 $rem = 'X' if $rem == 10;
892 return "V$cardnumber$rem";
895 # MODIFIED BY JF: mysql4.1 allows casting as an integer, which is probably
896 # better. I'll leave the original in in case it needs to be changed for you
897 # my $sth=$dbh->prepare("select max(borrowers.cardnumber) from borrowers");
898 my $sth = $dbh->prepare(
899 "select max(cast(cardnumber as signed)) from borrowers"
902 my ($result) = $sth->fetchrow;
905 return $cardnumber; # just here as a fallback/reminder
910 ($num_children, $children_arrayref) = &GetGuarantees($parent_borrno);
911 $child0_cardno = $children_arrayref->[0]{"cardnumber"};
912 $child0_borrno = $children_arrayref->[0]{"borrowernumber"};
914 C<&GetGuarantees> takes a borrower number (e.g., that of a patron
915 with children) and looks up the borrowers who are guaranteed by that
916 borrower (i.e., the patron's children).
918 C<&GetGuarantees> returns two values: an integer giving the number of
919 borrowers guaranteed by C<$parent_borrno>, and a reference to an array
920 of references to hash, which gives the actual results.
926 my ($borrowernumber) = @_;
927 my $dbh = C4::Context->dbh;
930 "select cardnumber,borrowernumber, firstname, surname from borrowers where guarantorid=?"
932 $sth->execute($borrowernumber);
935 my $data = $sth->fetchall_arrayref({});
936 return ( scalar(@$data), $data );
939 =head2 UpdateGuarantees
941 &UpdateGuarantees($parent_borrno);
944 C<&UpdateGuarantees> borrower data for an adult and updates all the guarantees
945 with the modified information
950 sub UpdateGuarantees {
952 my $dbh = C4::Context->dbh;
953 my ( $count, $guarantees ) = GetGuarantees( $data{'borrowernumber'} );
954 foreach my $guarantee (@$guarantees){
955 my $guaquery = qq|UPDATE borrowers
956 SET address=?,fax=?,B_city=?,mobile=?,city=?,phone=?
957 WHERE borrowernumber=?
959 my $sth = $dbh->prepare($guaquery);
960 $sth->execute($data{'address'},$data{'fax'},$data{'B_city'},$data{'mobile'},$data{'city'},$data{'phone'},$guarantee->{'borrowernumber'});
963 =head2 GetPendingIssues
965 my $issues = &GetPendingIssues(@borrowernumber);
967 Looks up what the patron with the given borrowernumber has borrowed.
969 C<&GetPendingIssues> returns a
970 reference-to-array where each element is a reference-to-hash; the
971 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
972 The keys include C<biblioitems> fields except marc and marcxml.
977 sub GetPendingIssues {
978 my @borrowernumbers = @_;
980 unless (@borrowernumbers ) { # return a ref_to_array
981 return \@borrowernumbers; # to not cause surprise to caller
984 # Borrowers part of the query
986 for (my $i = 0; $i < @borrowernumbers; $i++) {
987 $bquery .= ' issues.borrowernumber = ?';
988 if ($i < $#borrowernumbers ) {
993 # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
994 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
995 # FIXME: circ/ciculation.pl tries to sort by timestamp!
996 # FIXME: C4::Print::printslip tries to sort by timestamp!
997 # FIXME: namespace collision: other collisions possible.
998 # FIXME: most of this data isn't really being used by callers.
1005 biblioitems.itemtype,
1008 biblioitems.publicationyear,
1009 biblioitems.publishercode,
1010 biblioitems.volumedate,
1011 biblioitems.volumedesc,
1014 borrowers.firstname,
1016 borrowers.cardnumber,
1017 issues.timestamp AS timestamp,
1018 issues.renewals AS renewals,
1019 issues.borrowernumber AS borrowernumber,
1020 items.renewals AS totalrenewals
1022 LEFT JOIN items ON items.itemnumber = issues.itemnumber
1023 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1024 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
1025 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
1028 ORDER BY issues.issuedate"
1031 my $sth = C4::Context->dbh->prepare($query);
1032 $sth->execute(@borrowernumbers);
1033 my $data = $sth->fetchall_arrayref({});
1034 my $tz = C4::Context->tz();
1035 my $today = DateTime->now( time_zone => $tz);
1036 foreach (@{$data}) {
1037 if ($_->{issuedate}) {
1038 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
1040 $_->{date_due} or next;
1041 $_->{date_due} = DateTime::Format::DateParse->parse_datetime($_->{date_due}, $tz->name());
1042 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
1051 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
1053 Looks up what the patron with the given borrowernumber has borrowed,
1054 and sorts the results.
1056 C<$sortkey> is the name of a field on which to sort the results. This
1057 should be the name of a field in the C<issues>, C<biblio>,
1058 C<biblioitems>, or C<items> table in the Koha database.
1060 C<$limit> is the maximum number of results to return.
1062 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
1063 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
1064 C<items> tables of the Koha database.
1070 my ( $borrowernumber, $order, $limit ) = @_;
1072 #FIXME: sanity-check order and limit
1073 my $dbh = C4::Context->dbh;
1075 "SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1077 LEFT JOIN items on items.itemnumber=issues.itemnumber
1078 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1079 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1080 WHERE borrowernumber=?
1082 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1084 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
1085 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1086 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1087 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
1089 if ( $limit != 0 ) {
1090 $query .= " limit $limit";
1093 my $sth = $dbh->prepare($query);
1094 $sth->execute($borrowernumber, $borrowernumber);
1097 while ( my $data = $sth->fetchrow_hashref ) {
1098 push @result, $data;
1105 =head2 GetMemberAccountRecords
1107 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
1109 Looks up accounting data for the patron with the given borrowernumber.
1111 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
1112 reference-to-array, where each element is a reference-to-hash; the
1113 keys are the fields of the C<accountlines> table in the Koha database.
1114 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1115 total amount outstanding for all of the account lines.
1120 sub GetMemberAccountRecords {
1121 my ($borrowernumber,$date) = @_;
1122 my $dbh = C4::Context->dbh;
1128 WHERE borrowernumber=?);
1129 my @bind = ($borrowernumber);
1130 if ($date && $date ne ''){
1131 $strsth.=" AND date < ? ";
1134 $strsth.=" ORDER BY date desc,timestamp DESC";
1135 my $sth= $dbh->prepare( $strsth );
1136 $sth->execute( @bind );
1138 while ( my $data = $sth->fetchrow_hashref ) {
1139 if ( $data->{itemnumber} ) {
1140 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1141 $data->{biblionumber} = $biblio->{biblionumber};
1142 $data->{title} = $biblio->{title};
1144 $acctlines[$numlines] = $data;
1146 $total += int(1000 * $data->{'amountoutstanding'}); # convert float to integer to avoid round-off errors
1149 return ( $total, \@acctlines,$numlines);
1152 =head2 GetBorNotifyAcctRecord
1154 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1156 Looks up accounting data for the patron with the given borrowernumber per file number.
1158 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1159 reference-to-array, where each element is a reference-to-hash; the
1160 keys are the fields of the C<accountlines> table in the Koha database.
1161 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1162 total amount outstanding for all of the account lines.
1166 sub GetBorNotifyAcctRecord {
1167 my ( $borrowernumber, $notifyid ) = @_;
1168 my $dbh = C4::Context->dbh;
1171 my $sth = $dbh->prepare(
1174 WHERE borrowernumber=?
1176 AND amountoutstanding != '0'
1177 ORDER BY notify_id,accounttype
1180 $sth->execute( $borrowernumber, $notifyid );
1182 while ( my $data = $sth->fetchrow_hashref ) {
1183 $acctlines[$numlines] = $data;
1185 $total += int(100 * $data->{'amountoutstanding'});
1188 return ( $total, \@acctlines, $numlines );
1191 =head2 checkuniquemember (OUEST-PROVENCE)
1193 ($result,$categorycode) = &checkuniquemember($collectivity,$surname,$firstname,$dateofbirth);
1195 Checks that a member exists or not in the database.
1197 C<&result> is nonzero (=exist) or 0 (=does not exist)
1198 C<&categorycode> is from categorycode table
1199 C<&collectivity> is 1 (= we add a collectivity) or 0 (= we add a physical member)
1200 C<&surname> is the surname
1201 C<&firstname> is the firstname (only if collectivity=0)
1202 C<&dateofbirth> is the date of birth in ISO format (only if collectivity=0)
1206 # FIXME: This function is not legitimate. Multiple patrons might have the same first/last name and birthdate.
1207 # This is especially true since first name is not even a required field.
1209 sub checkuniquemember {
1210 my ( $collectivity, $surname, $firstname, $dateofbirth ) = @_;
1211 my $dbh = C4::Context->dbh;
1212 my $request = ($collectivity) ?
1213 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? " :
1215 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=? and dateofbirth=?" :
1216 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?";
1217 my $sth = $dbh->prepare($request);
1218 if ($collectivity) {
1219 $sth->execute( uc($surname) );
1220 } elsif($dateofbirth){
1221 $sth->execute( uc($surname), ucfirst($firstname), $dateofbirth );
1223 $sth->execute( uc($surname), ucfirst($firstname));
1225 my @data = $sth->fetchrow;
1226 ( $data[0] ) and return $data[0], $data[1];
1230 sub checkcardnumber {
1231 my ($cardnumber,$borrowernumber) = @_;
1232 # If cardnumber is null, we assume they're allowed.
1233 return 0 if !defined($cardnumber);
1234 my $dbh = C4::Context->dbh;
1235 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1236 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1237 my $sth = $dbh->prepare($query);
1238 if ($borrowernumber) {
1239 $sth->execute($cardnumber,$borrowernumber);
1241 $sth->execute($cardnumber);
1243 if (my $data= $sth->fetchrow_hashref()){
1252 =head2 getzipnamecity (OUEST-PROVENCE)
1254 take all info from table city for the fields city and zip
1255 check for the name and the zip code of the city selected
1259 sub getzipnamecity {
1261 my $dbh = C4::Context->dbh;
1264 "select city_name,city_state,city_zipcode,city_country from cities where cityid=? ");
1265 $sth->execute($cityid);
1266 my @data = $sth->fetchrow;
1267 return $data[0], $data[1], $data[2], $data[3];
1271 =head2 getdcity (OUEST-PROVENCE)
1273 recover cityid with city_name condition
1278 my ($city_name) = @_;
1279 my $dbh = C4::Context->dbh;
1280 my $sth = $dbh->prepare("select cityid from cities where city_name=? ");
1281 $sth->execute($city_name);
1282 my $data = $sth->fetchrow;
1286 =head2 GetFirstValidEmailAddress
1288 $email = GetFirstValidEmailAddress($borrowernumber);
1290 Return the first valid email address for a borrower, given the borrowernumber. For now, the order
1291 is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
1296 sub GetFirstValidEmailAddress {
1297 my $borrowernumber = shift;
1298 my $dbh = C4::Context->dbh;
1299 my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1300 $sth->execute( $borrowernumber );
1301 my $data = $sth->fetchrow_hashref;
1303 if ($data->{'email'}) {
1304 return $data->{'email'};
1305 } elsif ($data->{'emailpro'}) {
1306 return $data->{'emailpro'};
1307 } elsif ($data->{'B_email'}) {
1308 return $data->{'B_email'};
1314 =head2 GetExpiryDate
1316 $expirydate = GetExpiryDate($categorycode, $dateenrolled);
1318 Calculate expiry date given a categorycode and starting date. Date argument must be in ISO format.
1319 Return date is also in ISO format.
1324 my ( $categorycode, $dateenrolled ) = @_;
1326 if ($categorycode) {
1327 my $dbh = C4::Context->dbh;
1328 my $sth = $dbh->prepare("SELECT enrolmentperiod,enrolmentperioddate FROM categories WHERE categorycode=?");
1329 $sth->execute($categorycode);
1330 $enrolments = $sth->fetchrow_hashref;
1332 # die "GetExpiryDate: for enrollmentperiod $enrolmentperiod (category '$categorycode') starting $dateenrolled.\n";
1333 my @date = split (/-/,$dateenrolled);
1334 if($enrolments->{enrolmentperiod}){
1335 return sprintf("%04d-%02d-%02d", Add_Delta_YM(@date,0,$enrolments->{enrolmentperiod}));
1337 return $enrolments->{enrolmentperioddate};
1341 =head2 checkuserpassword (OUEST-PROVENCE)
1343 check for the password and login are not used
1344 return the number of record
1345 0=> NOT USED 1=> USED
1349 sub checkuserpassword {
1350 my ( $borrowernumber, $userid, $password ) = @_;
1351 $password = md5_base64($password);
1352 my $dbh = C4::Context->dbh;
1355 "Select count(*) from borrowers where borrowernumber !=? and userid =? and password=? "
1357 $sth->execute( $borrowernumber, $userid, $password );
1358 my $number_rows = $sth->fetchrow;
1359 return $number_rows;
1363 =head2 GetborCatFromCatType
1365 ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
1367 Looks up the different types of borrowers in the database. Returns two
1368 elements: a reference-to-array, which lists the borrower category
1369 codes, and a reference-to-hash, which maps the borrower category codes
1370 to category descriptions.
1375 sub GetborCatFromCatType {
1376 my ( $category_type, $action ) = @_;
1377 # FIXME - This API seems both limited and dangerous.
1378 my $dbh = C4::Context->dbh;
1379 my $request = qq| SELECT categorycode,description
1382 ORDER BY categorycode|;
1383 my $sth = $dbh->prepare($request);
1385 $sth->execute($category_type);
1394 while ( my $data = $sth->fetchrow_hashref ) {
1395 push @codes, $data->{'categorycode'};
1396 $labels{ $data->{'categorycode'} } = $data->{'description'};
1398 return ( \@codes, \%labels );
1401 =head2 GetBorrowercategory
1403 $hashref = &GetBorrowercategory($categorycode);
1405 Given the borrower's category code, the function returns the corresponding
1406 data hashref for a comprehensive information display.
1408 $arrayref_hashref = &GetBorrowercategory;
1410 If no category code provided, the function returns all the categories.
1414 sub GetBorrowercategory {
1416 my $dbh = C4::Context->dbh;
1420 "SELECT description,dateofbirthrequired,upperagelimit,category_type
1422 WHERE categorycode = ?"
1424 $sth->execute($catcode);
1426 $sth->fetchrow_hashref;
1430 } # sub getborrowercategory
1432 =head2 GetBorrowercategoryList
1434 $arrayref_hashref = &GetBorrowercategoryList;
1435 If no category code provided, the function returns all the categories.
1439 sub GetBorrowercategoryList {
1440 my $dbh = C4::Context->dbh;
1445 ORDER BY description"
1449 $sth->fetchall_arrayref({});
1451 } # sub getborrowercategory
1453 =head2 ethnicitycategories
1455 ($codes_arrayref, $labels_hashref) = ðnicitycategories();
1457 Looks up the different ethnic types in the database. Returns two
1458 elements: a reference-to-array, which lists the ethnicity codes, and a
1459 reference-to-hash, which maps the ethnicity codes to ethnicity
1466 sub ethnicitycategories {
1467 my $dbh = C4::Context->dbh;
1468 my $sth = $dbh->prepare("Select code,name from ethnicity order by name");
1472 while ( my $data = $sth->fetchrow_hashref ) {
1473 push @codes, $data->{'code'};
1474 $labels{ $data->{'code'} } = $data->{'name'};
1476 return ( \@codes, \%labels );
1481 $ethn_name = &fixEthnicity($ethn_code);
1483 Takes an ethnicity code (e.g., "european" or "pi") and returns the
1484 corresponding descriptive name from the C<ethnicity> table in the
1485 Koha database ("European" or "Pacific Islander").
1492 my $ethnicity = shift;
1493 return unless $ethnicity;
1494 my $dbh = C4::Context->dbh;
1495 my $sth = $dbh->prepare("Select name from ethnicity where code = ?");
1496 $sth->execute($ethnicity);
1497 my $data = $sth->fetchrow_hashref;
1498 return $data->{'name'};
1499 } # sub fixEthnicity
1503 $dateofbirth,$date = &GetAge($date);
1505 this function return the borrowers age with the value of dateofbirth
1511 my ( $date, $date_ref ) = @_;
1513 if ( not defined $date_ref ) {
1514 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1517 my ( $year1, $month1, $day1 ) = split /-/, $date;
1518 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1520 my $age = $year2 - $year1;
1521 if ( $month1 . $day1 > $month2 . $day2 ) {
1528 =head2 get_institutions
1530 $insitutions = get_institutions();
1532 Just returns a list of all the borrowers of type I, borrownumber and name
1537 sub get_institutions {
1538 my $dbh = C4::Context->dbh();
1541 "SELECT borrowernumber,surname FROM borrowers WHERE categorycode=? ORDER BY surname"
1545 while ( my $data = $sth->fetchrow_hashref() ) {
1546 $orgs{ $data->{'borrowernumber'} } = $data;
1550 } # sub get_institutions
1552 =head2 add_member_orgs
1554 add_member_orgs($borrowernumber,$borrowernumbers);
1556 Takes a borrowernumber and a list of other borrowernumbers and inserts them into the borrowers_to_borrowers table
1561 sub add_member_orgs {
1562 my ( $borrowernumber, $otherborrowers ) = @_;
1563 my $dbh = C4::Context->dbh();
1565 "INSERT INTO borrowers_to_borrowers (borrower1,borrower2) VALUES (?,?)";
1566 my $sth = $dbh->prepare($query);
1567 foreach my $otherborrowernumber (@$otherborrowers) {
1568 $sth->execute( $borrowernumber, $otherborrowernumber );
1571 } # sub add_member_orgs
1575 $cityarrayref = GetCities();
1577 Returns an array_ref of the entries in the cities table
1578 If there are entries in the table an empty row is returned
1579 This is currently only used to populate a popup in memberentry
1585 my $dbh = C4::Context->dbh;
1586 my $city_arr = $dbh->selectall_arrayref(
1587 q|SELECT cityid,city_zipcode,city_name,city_state,city_country FROM cities ORDER BY city_name|,
1589 if ( @{$city_arr} ) {
1590 unshift @{$city_arr}, {
1591 city_zipcode => q{},
1595 city_country => q{},
1602 =head2 GetSortDetails (OUEST-PROVENCE)
1604 ($lib) = &GetSortDetails($category,$sortvalue);
1606 Returns the authorized value details
1607 C<&$lib>return value of authorized value details
1608 C<&$sortvalue>this is the value of authorized value
1609 C<&$category>this is the value of authorized value category
1613 sub GetSortDetails {
1614 my ( $category, $sortvalue ) = @_;
1615 my $dbh = C4::Context->dbh;
1616 my $query = qq|SELECT lib
1617 FROM authorised_values
1619 AND authorised_value=? |;
1620 my $sth = $dbh->prepare($query);
1621 $sth->execute( $category, $sortvalue );
1622 my $lib = $sth->fetchrow;
1623 return ($lib) if ($lib);
1624 return ($sortvalue) unless ($lib);
1627 =head2 MoveMemberToDeleted
1629 $result = &MoveMemberToDeleted($borrowernumber);
1631 Copy the record from borrowers to deletedborrowers table.
1635 # FIXME: should do it in one SQL statement w/ subquery
1636 # Otherwise, we should return the @data on success
1638 sub MoveMemberToDeleted {
1639 my ($member) = shift or return;
1640 my $dbh = C4::Context->dbh;
1641 my $query = qq|SELECT *
1643 WHERE borrowernumber=?|;
1644 my $sth = $dbh->prepare($query);
1645 $sth->execute($member);
1646 my @data = $sth->fetchrow_array;
1647 (@data) or return; # if we got a bad borrowernumber, there's nothing to insert
1649 $dbh->prepare( "INSERT INTO deletedborrowers VALUES ("
1650 . ( "?," x ( scalar(@data) - 1 ) )
1652 $sth->execute(@data);
1657 DelMember($borrowernumber);
1659 This function remove directly a borrower whitout writing it on deleteborrower.
1660 + Deletes reserves for the borrower
1665 my $dbh = C4::Context->dbh;
1666 my $borrowernumber = shift;
1667 #warn "in delmember with $borrowernumber";
1668 return unless $borrowernumber; # borrowernumber is mandatory.
1670 my $query = qq|DELETE
1672 WHERE borrowernumber=?|;
1673 my $sth = $dbh->prepare($query);
1674 $sth->execute($borrowernumber);
1678 WHERE borrowernumber = ?
1680 $sth = $dbh->prepare($query);
1681 $sth->execute($borrowernumber);
1682 logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
1686 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1688 $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1690 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1695 sub ExtendMemberSubscriptionTo {
1696 my ( $borrowerid,$date) = @_;
1697 my $dbh = C4::Context->dbh;
1698 my $borrower = GetMember('borrowernumber'=>$borrowerid);
1700 $date = (C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry') ?
1701 C4::Dates->new($borrower->{'dateexpiry'}, 'iso')->output("iso") :
1702 C4::Dates->new()->output("iso");
1703 $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
1705 my $sth = $dbh->do(<<EOF);
1707 SET dateexpiry='$date'
1708 WHERE borrowernumber='$borrowerid'
1710 # add enrolmentfee if needed
1711 $sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
1712 $sth->execute($borrower->{'categorycode'});
1713 my ($enrolmentfee) = $sth->fetchrow;
1714 if ($enrolmentfee && $enrolmentfee > 0) {
1715 # insert fee in patron debts
1716 manualinvoice($borrower->{'borrowernumber'}, '', '', 'A', $enrolmentfee);
1718 logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
1719 return $date if ($sth);
1723 =head2 GetRoadTypes (OUEST-PROVENCE)
1725 ($idroadtypearrayref, $roadttype_hashref) = &GetRoadTypes();
1727 Looks up the different road type . Returns two
1728 elements: a reference-to-array, which lists the id_roadtype
1729 codes, and a reference-to-hash, which maps the road type of the road .
1734 my $dbh = C4::Context->dbh;
1736 SELECT roadtypeid,road_type
1738 ORDER BY road_type|;
1739 my $sth = $dbh->prepare($query);
1744 # insert empty value to create a empty choice in cgi popup
1746 while ( my $data = $sth->fetchrow_hashref ) {
1748 push @id, $data->{'roadtypeid'};
1749 $roadtype{ $data->{'roadtypeid'} } = $data->{'road_type'};
1752 #test to know if the table contain some records if no the function return nothing
1759 return ( \@id, \%roadtype );
1765 =head2 GetTitles (OUEST-PROVENCE)
1767 ($borrowertitle)= &GetTitles();
1769 Looks up the different title . Returns array with all borrowers title
1774 my @borrowerTitle = split (/,|\|/,C4::Context->preference('BorrowersTitles'));
1775 unshift( @borrowerTitle, "" );
1776 my $count=@borrowerTitle;
1781 return ( \@borrowerTitle);
1785 =head2 GetPatronImage
1787 my ($imagedata, $dberror) = GetPatronImage($cardnumber);
1789 Returns the mimetype and binary image data of the image for the patron with the supplied cardnumber.
1793 sub GetPatronImage {
1794 my ($cardnumber) = @_;
1795 warn "Cardnumber passed to GetPatronImage is $cardnumber" if $debug;
1796 my $dbh = C4::Context->dbh;
1797 my $query = 'SELECT mimetype, imagefile FROM patronimage WHERE cardnumber = ?';
1798 my $sth = $dbh->prepare($query);
1799 $sth->execute($cardnumber);
1800 my $imagedata = $sth->fetchrow_hashref;
1801 warn "Database error!" if $sth->errstr;
1802 return $imagedata, $sth->errstr;
1805 =head2 PutPatronImage
1807 PutPatronImage($cardnumber, $mimetype, $imgfile);
1809 Stores patron binary image data and mimetype in database.
1810 NOTE: This function is good for updating images as well as inserting new images in the database.
1814 sub PutPatronImage {
1815 my ($cardnumber, $mimetype, $imgfile) = @_;
1816 warn "Parameters passed in: Cardnumber=$cardnumber, Mimetype=$mimetype, " . ($imgfile ? "Imagefile" : "No Imagefile") if $debug;
1817 my $dbh = C4::Context->dbh;
1818 my $query = "INSERT INTO patronimage (cardnumber, mimetype, imagefile) VALUES (?,?,?) ON DUPLICATE KEY UPDATE imagefile = ?;";
1819 my $sth = $dbh->prepare($query);
1820 $sth->execute($cardnumber,$mimetype,$imgfile,$imgfile);
1821 warn "Error returned inserting $cardnumber.$mimetype." if $sth->errstr;
1822 return $sth->errstr;
1825 =head2 RmPatronImage
1827 my ($dberror) = RmPatronImage($cardnumber);
1829 Removes the image for the patron with the supplied cardnumber.
1834 my ($cardnumber) = @_;
1835 warn "Cardnumber passed to GetPatronImage is $cardnumber" if $debug;
1836 my $dbh = C4::Context->dbh;
1837 my $query = "DELETE FROM patronimage WHERE cardnumber = ?;";
1838 my $sth = $dbh->prepare($query);
1839 $sth->execute($cardnumber);
1840 my $dberror = $sth->errstr;
1841 warn "Database error!" if $sth->errstr;
1845 =head2 GetHideLostItemsPreference
1847 $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1849 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1850 C<&$hidelostitemspref>return value of function, 0 or 1
1854 sub GetHideLostItemsPreference {
1855 my ($borrowernumber) = @_;
1856 my $dbh = C4::Context->dbh;
1857 my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1858 my $sth = $dbh->prepare($query);
1859 $sth->execute($borrowernumber);
1860 my $hidelostitems = $sth->fetchrow;
1861 return $hidelostitems;
1864 =head2 GetRoadTypeDetails (OUEST-PROVENCE)
1866 ($roadtype) = &GetRoadTypeDetails($roadtypeid);
1868 Returns the description of roadtype
1869 C<&$roadtype>return description of road type
1870 C<&$roadtypeid>this is the value of roadtype s
1874 sub GetRoadTypeDetails {
1875 my ($roadtypeid) = @_;
1876 my $dbh = C4::Context->dbh;
1880 WHERE roadtypeid=?|;
1881 my $sth = $dbh->prepare($query);
1882 $sth->execute($roadtypeid);
1883 my $roadtype = $sth->fetchrow;
1887 =head2 GetBorrowersWhoHaveNotBorrowedSince
1889 &GetBorrowersWhoHaveNotBorrowedSince($date)
1891 this function get all borrowers who haven't borrowed since the date given on input arg.
1895 sub GetBorrowersWhoHaveNotBorrowedSince {
1896 my $filterdate = shift||POSIX::strftime("%Y-%m-%d",localtime());
1897 my $filterexpiry = shift;
1898 my $filterbranch = shift ||
1899 ((C4::Context->preference('IndependantBranches')
1900 && C4::Context->userenv
1901 && C4::Context->userenv->{flags} % 2 !=1
1902 && C4::Context->userenv->{branch})
1903 ? C4::Context->userenv->{branch}
1905 my $dbh = C4::Context->dbh;
1907 SELECT borrowers.borrowernumber,
1908 max(old_issues.timestamp) as latestissue,
1909 max(issues.timestamp) as currentissue
1911 JOIN categories USING (categorycode)
1912 LEFT JOIN old_issues USING (borrowernumber)
1913 LEFT JOIN issues USING (borrowernumber)
1914 WHERE category_type <> 'S'
1915 AND borrowernumber NOT IN (SELECT guarantorid FROM borrowers WHERE guarantorid IS NOT NULL AND guarantorid <> 0)
1918 if ($filterbranch && $filterbranch ne ""){
1919 $query.=" AND borrowers.branchcode= ?";
1920 push @query_params,$filterbranch;
1923 $query .= " AND dateexpiry < ? ";
1924 push @query_params,$filterdate;
1926 $query.=" GROUP BY borrowers.borrowernumber";
1928 $query.=" HAVING (latestissue < ? OR latestissue IS NULL)
1929 AND currentissue IS NULL";
1930 push @query_params,$filterdate;
1932 warn $query if $debug;
1933 my $sth = $dbh->prepare($query);
1934 if (scalar(@query_params)>0){
1935 $sth->execute(@query_params);
1942 while ( my $data = $sth->fetchrow_hashref ) {
1943 push @results, $data;
1948 =head2 GetBorrowersWhoHaveNeverBorrowed
1950 $results = &GetBorrowersWhoHaveNeverBorrowed
1952 This function get all borrowers who have never borrowed.
1954 I<$result> is a ref to an array which all elements are a hasref.
1958 sub GetBorrowersWhoHaveNeverBorrowed {
1959 my $filterbranch = shift ||
1960 ((C4::Context->preference('IndependantBranches')
1961 && C4::Context->userenv
1962 && C4::Context->userenv->{flags} % 2 !=1
1963 && C4::Context->userenv->{branch})
1964 ? C4::Context->userenv->{branch}
1966 my $dbh = C4::Context->dbh;
1968 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
1970 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
1971 WHERE issues.borrowernumber IS NULL
1974 if ($filterbranch && $filterbranch ne ""){
1975 $query.=" AND borrowers.branchcode= ?";
1976 push @query_params,$filterbranch;
1978 warn $query if $debug;
1980 my $sth = $dbh->prepare($query);
1981 if (scalar(@query_params)>0){
1982 $sth->execute(@query_params);
1989 while ( my $data = $sth->fetchrow_hashref ) {
1990 push @results, $data;
1995 =head2 GetBorrowersWithIssuesHistoryOlderThan
1997 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
1999 this function get all borrowers who has an issue history older than I<$date> given on input arg.
2001 I<$result> is a ref to an array which all elements are a hashref.
2002 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2006 sub GetBorrowersWithIssuesHistoryOlderThan {
2007 my $dbh = C4::Context->dbh;
2008 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
2009 my $filterbranch = shift ||
2010 ((C4::Context->preference('IndependantBranches')
2011 && C4::Context->userenv
2012 && C4::Context->userenv->{flags} % 2 !=1
2013 && C4::Context->userenv->{branch})
2014 ? C4::Context->userenv->{branch}
2017 SELECT count(borrowernumber) as n,borrowernumber
2019 WHERE returndate < ?
2020 AND borrowernumber IS NOT NULL
2023 push @query_params, $date;
2025 $query.=" AND branchcode = ?";
2026 push @query_params, $filterbranch;
2028 $query.=" GROUP BY borrowernumber ";
2029 warn $query if $debug;
2030 my $sth = $dbh->prepare($query);
2031 $sth->execute(@query_params);
2034 while ( my $data = $sth->fetchrow_hashref ) {
2035 push @results, $data;
2040 =head2 GetBorrowersNamesAndLatestIssue
2042 $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
2044 this function get borrowers Names and surnames and Issue information.
2046 I<@borrowernumbers> is an array which all elements are borrowernumbers.
2047 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2051 sub GetBorrowersNamesAndLatestIssue {
2052 my $dbh = C4::Context->dbh;
2053 my @borrowernumbers=@_;
2055 SELECT surname,lastname, phone, email,max(timestamp)
2057 LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
2058 GROUP BY borrowernumber
2060 my $sth = $dbh->prepare($query);
2062 my $results = $sth->fetchall_arrayref({});
2068 my $success = DebarMember( $borrowernumber, $todate );
2070 marks a Member as debarred, and therefore unable to checkout any more
2074 true on success, false on failure
2079 my $borrowernumber = shift;
2082 return unless defined $borrowernumber;
2083 return unless $borrowernumber =~ /^\d+$/;
2086 borrowernumber => $borrowernumber,
2096 my $success = ModPrivacy( $borrowernumber, $privacy );
2098 Update the privacy of a patron.
2101 true on success, false on failure
2108 my $borrowernumber = shift;
2109 my $privacy = shift;
2110 return unless defined $borrowernumber;
2111 return unless $borrowernumber =~ /^\d+$/;
2113 return ModMember( borrowernumber => $borrowernumber,
2114 privacy => $privacy );
2119 AddMessage( $borrowernumber, $message_type, $message, $branchcode );
2121 Adds a message to the messages table for the given borrower.
2130 my ( $borrowernumber, $message_type, $message, $branchcode ) = @_;
2132 my $dbh = C4::Context->dbh;
2134 if ( ! ( $borrowernumber && $message_type && $message && $branchcode ) ) {
2138 my $query = "INSERT INTO messages ( borrowernumber, branchcode, message_type, message ) VALUES ( ?, ?, ?, ? )";
2139 my $sth = $dbh->prepare($query);
2140 $sth->execute( $borrowernumber, $branchcode, $message_type, $message );
2141 logaction("MEMBERS", "ADDCIRCMESSAGE", $borrowernumber, $message) if C4::Context->preference("BorrowersLog");
2147 GetMessages( $borrowernumber, $type );
2149 $type is message type, B for borrower, or L for Librarian.
2150 Empty type returns all messages of any type.
2152 Returns all messages for the given borrowernumber
2157 my ( $borrowernumber, $type, $branchcode ) = @_;
2163 my $dbh = C4::Context->dbh;
2166 branches.branchname,
2169 messages.branchcode LIKE '$branchcode' AS can_delete
2170 FROM messages, branches
2171 WHERE borrowernumber = ?
2172 AND message_type LIKE ?
2173 AND messages.branchcode = branches.branchcode
2174 ORDER BY message_date DESC";
2175 my $sth = $dbh->prepare($query);
2176 $sth->execute( $borrowernumber, $type ) ;
2179 while ( my $data = $sth->fetchrow_hashref ) {
2180 my $d = C4::Dates->new( $data->{message_date}, 'iso' );
2181 $data->{message_date_formatted} = $d->output;
2182 push @results, $data;
2190 GetMessagesCount( $borrowernumber, $type );
2192 $type is message type, B for borrower, or L for Librarian.
2193 Empty type returns all messages of any type.
2195 Returns the number of messages for the given borrowernumber
2199 sub GetMessagesCount {
2200 my ( $borrowernumber, $type, $branchcode ) = @_;
2206 my $dbh = C4::Context->dbh;
2208 my $query = "SELECT COUNT(*) as MsgCount FROM messages WHERE borrowernumber = ? AND message_type LIKE ?";
2209 my $sth = $dbh->prepare($query);
2210 $sth->execute( $borrowernumber, $type ) ;
2213 my $data = $sth->fetchrow_hashref;
2214 my $count = $data->{'MsgCount'};
2221 =head2 DeleteMessage
2223 DeleteMessage( $message_id );
2228 my ( $message_id ) = @_;
2230 my $dbh = C4::Context->dbh;
2231 my $query = "SELECT * FROM messages WHERE message_id = ?";
2232 my $sth = $dbh->prepare($query);
2233 $sth->execute( $message_id );
2234 my $message = $sth->fetchrow_hashref();
2236 $query = "DELETE FROM messages WHERE message_id = ?";
2237 $sth = $dbh->prepare($query);
2238 $sth->execute( $message_id );
2239 logaction("MEMBERS", "DELCIRCMESSAGE", $message->{'borrowernumber'}, $message->{'message'}) if C4::Context->preference("BorrowersLog");
2244 IssueSlip($branchcode, $borrowernumber, $quickslip)
2246 Returns letter hash ( see C4::Letters::GetPreparedLetter )
2248 $quickslip is boolean, to indicate whether we want a quick slip
2253 my ($branch, $borrowernumber, $quickslip) = @_;
2255 # return unless ( C4::Context->boolean_preference('printcirculationslips') );
2257 my $today = POSIX::strftime("%Y-%m-%d", localtime);
2259 my $issueslist = GetPendingIssues($borrowernumber);
2260 foreach my $it (@$issueslist){
2261 if ($it->{'issuedate'} eq $today) {
2264 elsif ($it->{'date_due'} le $today) {
2265 $it->{'overdue'} = 1;
2268 $it->{'date_due'}=format_date($it->{'date_due'});
2270 my @issues = sort { $b->{'timestamp'} <=> $a->{'timestamp'} } @$issueslist;
2272 my ($letter_code, %repeat);
2274 $letter_code = 'ISSUEQSLIP';
2276 'checkedout' => [ map {
2280 }, grep { $_->{'today'} } @issues ],
2284 $letter_code = 'ISSUESLIP';
2286 'checkedout' => [ map {
2290 }, grep { !$_->{'overdue'} } @issues ],
2292 'overdue' => [ map {
2296 }, grep { $_->{'overdue'} } @issues ],
2299 $_->{'timestamp'} = $_->{'newdate'};
2301 } @{ GetNewsToDisplay("slip") } ],
2305 return C4::Letters::GetPreparedLetter (
2306 module => 'circulation',
2307 letter_code => $letter_code,
2308 branchcode => $branch,
2310 'branches' => $branch,
2311 'borrowers' => $borrowernumber,
2317 =head2 GetBorrowersWithEmail
2319 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
2321 This gets a list of users and their basic details from their email address.
2322 As it's possible for multiple user to have the same email address, it provides
2323 you with all of them. If there is no userid for the user, there will be an
2324 C<undef> there. An empty list will be returned if there are no matches.
2328 sub GetBorrowersWithEmail {
2331 my $dbh = C4::Context->dbh;
2333 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
2334 my $sth=$dbh->prepare($query);
2335 $sth->execute($email);
2337 while (my $ref = $sth->fetch) {
2340 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
2345 END { } # module clean-up code here (global destructor)