3 # Copyright 2000-2003 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
23 use C4::Dates qw(format_date_in_iso);
24 use Digest::MD5 qw(md5_base64);
25 use Date::Calc qw/Today Add_Delta_YM/;
26 use C4::Log; # logaction
32 our ($VERSION,@ISA,@EXPORT,@EXPORT_OK,$debug);
36 $debug = $ENV{DEBUG} || 0;
47 &GetMemberIssuesAndFines
66 &GetMemberAccountRecords
67 &GetBorNotifyAcctRecord
71 &GetBorrowercategoryList
73 &GetBorrowersWhoHaveNotBorrowedSince
74 &GetBorrowersWhoHaveNeverBorrowed
75 &GetBorrowersWithIssuesHistoryOlderThan
96 &ExtendMemberSubscriptionTo
114 C4::Members - Perl Module containing convenience functions for member handling
122 This module contains routines for adding, modifying and deleting members/patrons/borrowers
130 ($count, $borrowers) = &SearchMember($searchstring, $type,$category_type,$filter,$showallbranches);
134 Looks up patrons (borrowers) by name.
136 BUGFIX 499: C<$type> is now used to determine type of search.
137 if $type is "simple", search is performed on the first letter of the
140 $category_type is used to get a specified type of user.
141 (mainly adults when creating a child.)
143 C<$searchstring> is a space-separated list of search terms. Each term
144 must match the beginning a borrower's surname, first name, or other
147 C<$filter> is assumed to be a list of elements to filter results on
149 C<$showallbranches> is used in IndependantBranches Context to display all branches results.
151 C<&SearchMember> returns a two-element list. C<$borrowers> is a
152 reference-to-array; each element is a reference-to-hash, whose keys
153 are the fields of the C<borrowers> table in the Koha database.
154 C<$count> is the number of elements in C<$borrowers>.
159 #used by member enquiries from the intranet
160 #called by member.pl and circ/circulation.pl
162 my ($searchstring, $orderby, $type,$category_type,$filter,$showallbranches ) = @_;
163 my $dbh = C4::Context->dbh;
169 # this is used by circulation everytime a new borrowers cardnumber is scanned
170 # so we can check an exact match first, if that works return, otherwise do the rest
171 $query = "SELECT * FROM borrowers
172 LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
174 my $sth = $dbh->prepare("$query WHERE cardnumber = ?");
175 $sth->execute($searchstring);
176 my $data = $sth->fetchall_arrayref({});
178 return ( scalar(@$data), $data );
182 if ( $type eq "simple" ) # simple search for one letter only
184 $query .= ($category_type ? " AND category_type = ".$dbh->quote($category_type) : "");
185 $query .= " WHERE (surname LIKE ? OR cardnumber like ?) ";
186 if (C4::Context->preference("IndependantBranches") && !$showallbranches){
187 if (C4::Context->userenv && C4::Context->userenv->{flags}!=1 && C4::Context->userenv->{'branch'}){
188 $query.=" AND borrowers.branchcode =".$dbh->quote(C4::Context->userenv->{'branch'}) unless (C4::Context->userenv->{'branch'} eq "insecure");
191 $query.=" ORDER BY $orderby";
192 @bind = ("$searchstring%","$searchstring");
194 else # advanced search looking in surname, firstname and othernames
196 @data = split( ' ', $searchstring );
199 if (C4::Context->preference("IndependantBranches") && !$showallbranches){
200 if (C4::Context->userenv && C4::Context->userenv->{flags}!=1 && C4::Context->userenv->{'branch'}){
201 $query.=" borrowers.branchcode =".$dbh->quote(C4::Context->userenv->{'branch'})." AND " unless (C4::Context->userenv->{'branch'} eq "insecure");
204 $query.="((surname LIKE ? OR surname LIKE ?
205 OR firstname LIKE ? OR firstname LIKE ?
206 OR othernames LIKE ? OR othernames LIKE ?)
208 ($category_type?" AND category_type = ".$dbh->quote($category_type):"");
210 "$data[0]%", "% $data[0]%", "$data[0]%", "% $data[0]%",
211 "$data[0]%", "% $data[0]%"
213 for ( my $i = 1 ; $i < $count ; $i++ ) {
214 $query = $query . " AND (" . " surname LIKE ? OR surname LIKE ?
215 OR firstname LIKE ? OR firstname LIKE ?
216 OR othernames LIKE ? OR othernames LIKE ?)";
218 "$data[$i]%", "% $data[$i]%", "$data[$i]%",
219 "% $data[$i]%", "$data[$i]%", "% $data[$i]%" );
223 $query = $query . ") OR cardnumber LIKE ? ";
224 push( @bind, $searchstring );
225 if (C4::Context->preference('ExtendedPatronAttributes')) {
226 $query .= "OR borrowernumber IN (
227 SELECT borrowernumber
228 FROM borrower_attributes
229 JOIN borrower_attribute_types USING (code)
230 WHERE staff_searchable = 1
233 push (@bind, $searchstring);
235 $query .= "order by $orderby";
240 $sth = $dbh->prepare($query);
242 $debug and print STDERR "Q $orderby : $query\n";
243 $sth->execute(@bind);
245 $data = $sth->fetchall_arrayref({});
248 return ( scalar(@$data), $data );
251 =head2 GetMemberDetails
253 ($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
255 Looks up a patron and returns information about him or her. If
256 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
257 up the borrower by number; otherwise, it looks up the borrower by card
260 C<$borrower> is a reference-to-hash whose keys are the fields of the
261 borrowers table in the Koha database. In addition,
262 C<$borrower-E<gt>{flags}> is a hash giving more detailed information
263 about the patron. Its keys act as flags :
265 if $borrower->{flags}->{LOST} {
266 # Patron's card was reported lost
269 Each flag has a C<message> key, giving a human-readable explanation of
270 the flag. If the state of a flag means that the patron should not be
271 allowed to borrow any more books, then it will have a C<noissues> key
274 The possible flags are:
280 =item Shows the patron's credit or debt, if any.
288 =item (Gone, no address.) Set if the patron has left without giving a
297 =item Set if the patron's card has been reported as lost.
305 =item Set if the patron has been debarred.
313 =item Any additional notes about the patron.
321 =item Set if the patron has overdue items. This flag has several keys:
323 C<$flags-E<gt>{ODUES}{itemlist}> is a reference-to-array listing the
324 overdue items. Its elements are references-to-hash, each describing an
325 overdue item. The keys are selected fields from the issues, biblio,
326 biblioitems, and items tables of the Koha database.
328 C<$flags-E<gt>{ODUES}{itemlist}> is a string giving a text listing of
329 the overdue items, one per line.
337 =item Set if any items that the patron has reserved are available.
339 C<$flags-E<gt>{WAITING}{itemlist}> is a reference-to-array listing the
340 available items. Each element is a reference-to-hash whose keys are
341 fields from the reserves table of the Koha database.
345 C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
346 about the top-level permissions flags set for the borrower. For example,
347 if a user has the "editcatalogue" permission,
348 C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
353 sub GetMemberDetails {
354 my ( $borrowernumber, $cardnumber ) = @_;
355 my $dbh = C4::Context->dbh;
358 if ($borrowernumber) {
359 $sth = $dbh->prepare("select borrowers.*,category_type,categories.description from borrowers left join categories on borrowers.categorycode=categories.categorycode where borrowernumber=?");
360 $sth->execute($borrowernumber);
362 elsif ($cardnumber) {
363 $sth = $dbh->prepare("select borrowers.*,category_type,categories.description from borrowers left join categories on borrowers.categorycode=categories.categorycode where cardnumber=?");
364 $sth->execute($cardnumber);
369 my $borrower = $sth->fetchrow_hashref;
370 my ($amount) = GetMemberAccountRecords( $borrowernumber);
371 $borrower->{'amountoutstanding'} = $amount;
372 # FIXME - patronflags calls GetMemberAccountRecords... just have patronflags return $amount
373 my $flags = patronflags( $borrower);
376 $sth = $dbh->prepare("select bit,flag from userflags");
378 while ( my ( $bit, $flag ) = $sth->fetchrow ) {
379 if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
380 $accessflagshash->{$flag} = 1;
384 $borrower->{'flags'} = $flags;
385 $borrower->{'authflags'} = $accessflagshash;
387 # find out how long the membership lasts
390 "select enrolmentperiod from categories where categorycode = ?");
391 $sth->execute( $borrower->{'categorycode'} );
392 my $enrolment = $sth->fetchrow;
393 $borrower->{'enrolmentperiod'} = $enrolment;
394 return ($borrower); #, $flags, $accessflagshash);
401 NOTE!: If you change this function, be sure to update the POD for
404 $flags = &patronflags($patron);
407 {message} Message showing patron's credit or debt
408 {noissues} Set if patron owes >$5.00
409 {GNA} Set if patron gone w/o address
410 {message} "Borrower has no valid address"
412 {LOST} Set if patron's card reported lost
413 {message} Message to this effect
415 {DBARRED} Set is patron is debarred
416 {message} Message to this effect
418 {NOTES} Set if patron has notes
419 {message} Notes about patron
420 {ODUES} Set if patron has overdue books
422 {itemlist} ref-to-array: list of overdue books
423 {itemlisttext} Text list of overdue items
424 {WAITING} Set if there are items available that the
426 {message} Message to this effect
427 {itemlist} ref-to-array: list of available items
430 # FIXME rename this function.
433 my ( $patroninformation) = @_;
434 my $dbh=C4::Context->dbh;
435 my ($amount) = GetMemberAccountRecords( $patroninformation->{'borrowernumber'});
438 my $noissuescharge = C4::Context->preference("noissuescharge");
439 $flaginfo{'message'} = sprintf "Patron owes \$%.02f", $amount;
440 $flaginfo{'amount'} = sprintf "%.02f",$amount;
441 if ( $amount > $noissuescharge ) {
442 $flaginfo{'noissues'} = 1;
444 $flags{'CHARGES'} = \%flaginfo;
446 elsif ( $amount < 0 ) {
448 $flaginfo{'message'} = sprintf "Patron has credit of \$%.02f", -$amount;
449 $flags{'CREDITS'} = \%flaginfo;
451 if ( $patroninformation->{'gonenoaddress'}
452 && $patroninformation->{'gonenoaddress'} == 1 )
455 $flaginfo{'message'} = 'Borrower has no valid address.';
456 $flaginfo{'noissues'} = 1;
457 $flags{'GNA'} = \%flaginfo;
459 if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
461 $flaginfo{'message'} = 'Borrower\'s card reported lost.';
462 $flaginfo{'noissues'} = 1;
463 $flags{'LOST'} = \%flaginfo;
465 if ( $patroninformation->{'debarred'}
466 && $patroninformation->{'debarred'} == 1 )
469 $flaginfo{'message'} = 'Borrower is Debarred.';
470 $flaginfo{'noissues'} = 1;
471 $flags{'DBARRED'} = \%flaginfo;
473 if ( $patroninformation->{'borrowernotes'}
474 && $patroninformation->{'borrowernotes'} )
477 $flaginfo{'message'} = "$patroninformation->{'borrowernotes'}";
478 $flags{'NOTES'} = \%flaginfo;
480 my ( $odues, $itemsoverdue ) =
481 checkoverdues( $patroninformation->{'borrowernumber'}, $dbh );
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";
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, $type);
510 Looks up information about a patron (borrower) by either card number
511 ,firstname, or borrower number, depending on $type value.
512 If C<$type> == 'cardnumber', C<&GetBorrower>
513 searches by cardnumber then by firstname if not found in cardnumber;
514 otherwise, it searches by borrowernumber.
516 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
517 the C<borrowers> table in the Koha database.
523 my ( $information, $type ) = @_;
524 my $dbh = C4::Context->dbh;
527 SELECT borrowers.*, categories.category_type, categories.description
529 LEFT JOIN categories on borrowers.categorycode=categories.categorycode
531 if (defined($type) and ( $type eq 'cardnumber' || $type eq 'firstname'|| $type eq 'userid'|| $type eq 'borrowernumber' ) ){
532 $information = uc $information;
533 $sth = $dbh->prepare("$select WHERE $type=?");
535 $sth = $dbh->prepare("$select WHERE borrowernumber=?");
537 $sth->execute($information);
538 my $data = $sth->fetchrow_hashref;
539 ($data) and return ($data);
541 if (defined($type) and ($type eq 'cardnumber' || $type eq 'firstname')) { # otherwise, try with firstname
542 $sth = $dbh->prepare("$select WHERE firstname like ?");
543 $sth->execute($information);
544 $data = $sth->fetchrow_hashref;
545 ($data) and return ($data);
550 =head2 GetMemberIssuesAndFines
552 ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
554 Returns aggregate data about items borrowed by the patron with the
555 given borrowernumber.
557 C<&GetMemberIssuesAndFines> returns a three-element array. C<$overdue_count> is the
558 number of overdue items the patron currently has borrowed. C<$issue_count> is the
559 number of books the patron currently has borrowed. C<$total_fines> is
560 the total fine currently due by the borrower.
565 sub GetMemberIssuesAndFines {
566 my ( $borrowernumber ) = @_;
567 my $dbh = C4::Context->dbh;
568 my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
570 $debug and warn $query."\n";
571 my $sth = $dbh->prepare($query);
572 $sth->execute($borrowernumber);
573 my $issue_count = $sth->fetchrow_arrayref->[0];
576 $sth = $dbh->prepare(
577 "SELECT COUNT(*) FROM issues
578 WHERE borrowernumber = ?
579 AND date_due < now()"
581 $sth->execute($borrowernumber);
582 my $overdue_count = $sth->fetchrow_arrayref->[0];
585 $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
586 $sth->execute($borrowernumber);
587 my $total_fines = $sth->fetchrow_arrayref->[0];
590 return ($overdue_count, $issue_count, $total_fines);
594 return @{C4::Context->dbh->selectcol_arrayref("SHOW columns from borrowers")};
603 my $success = ModMember(borrowernumber => $borrowernumber, [ field => value ]... );
605 Modify borrower's data. All date fields should ALREADY be in ISO format.
608 true on success, or false on failure
616 my $dbh = C4::Context->dbh;
617 my $iso_re = C4::Dates->new()->regexp('iso');
618 foreach (qw(dateofbirth dateexpiry dateenrolled)) {
619 if (my $tempdate = $data{$_}) { # assignment, not comparison
620 ($tempdate =~ /$iso_re/) and next; # Congatulations, you sent a valid ISO date.
621 warn "ModMember given $_ not in ISO format ($tempdate)";
622 my $tempdate2 = format_date_in_iso($tempdate);
623 if (!$tempdate2 or $tempdate2 eq '0000-00-00') {
624 warn "ModMember cannot convert '$tempdate' (from syspref to ISO)";
627 $data{$_} = $tempdate2;
630 if (!$data{'dateofbirth'}){
631 delete $data{'dateofbirth'};
633 my @columns = &columns;
634 my %hashborrowerfields = (map {$_=>1} @columns);
635 my $query = "UPDATE borrowers SET \n";
639 # test to know if you must update or not the borrower password
640 if (exists $data{password}) {
641 if ($data{password} eq '****' or $data{password} eq '') {
642 delete $data{password};
644 $data{password} = md5_base64($data{password});
648 foreach (keys %data) {
649 next if ($_ eq 'borrowernumber' or $_ eq 'flags');
650 if ($hashborrowerfields{$_}){
652 push @parameters,$data{$_};
658 (@badkeys) and warn scalar(@badkeys) . " Illegal key(s) passed to ModMember: " . join(',',@badkeys);
660 $query .= " WHERE borrowernumber=?";
661 push @parameters, $data{'borrowernumber'};
662 $debug and print STDERR "$query (executed w/ arg: $data{'borrowernumber'})";
663 $sth = $dbh->prepare($query);
664 my $execute_success = $sth->execute(@parameters);
667 # ok if its an adult (type) it may have borrowers that depend on it as a guarantor
668 # so when we update information for an adult we should check for guarantees and update the relevant part
669 # of their records, ie addresses and phone numbers
670 my $borrowercategory= GetBorrowercategory( $data{'category_type'} );
671 if ( exists $borrowercategory->{'category_type'} && $borrowercategory->{'category_type'} eq ('A' || 'S') ) {
672 # is adult check guarantees;
673 UpdateGuarantees(%data);
675 logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "$query (executed w/ arg: $data{'borrowernumber'})")
676 if C4::Context->preference("BorrowersLog");
678 return $execute_success;
686 $borrowernumber = &AddMember(%borrower);
688 insert new borrower into table
689 Returns the borrowernumber
696 my $dbh = C4::Context->dbh;
697 $data{'userid'} = '' unless $data{'password'};
698 $data{'password'} = md5_base64( $data{'password'} ) if $data{'password'};
700 # WE SHOULD NEVER PASS THIS SUBROUTINE ANYTHING OTHER THAN ISO DATES
701 # IF YOU UNCOMMENT THESE LINES YOU BETTER HAVE A DARN COMPELLING REASON
702 # $data{'dateofbirth'} = format_date_in_iso( $data{'dateofbirth'} );
703 # $data{'dateenrolled'} = format_date_in_iso( $data{'dateenrolled'});
704 # $data{'dateexpiry'} = format_date_in_iso( $data{'dateexpiry'} );
705 # This query should be rewritten to use "?" at execute.
706 if (!$data{'dateofbirth'}){
707 undef ($data{'dateofbirth'});
710 "insert into borrowers set cardnumber=" . $dbh->quote( $data{'cardnumber'} )
711 . ",surname=" . $dbh->quote( $data{'surname'} )
712 . ",firstname=" . $dbh->quote( $data{'firstname'} )
713 . ",title=" . $dbh->quote( $data{'title'} )
714 . ",othernames=" . $dbh->quote( $data{'othernames'} )
715 . ",initials=" . $dbh->quote( $data{'initials'} )
716 . ",streetnumber=". $dbh->quote( $data{'streetnumber'} )
717 . ",streettype=" . $dbh->quote( $data{'streettype'} )
718 . ",address=" . $dbh->quote( $data{'address'} )
719 . ",address2=" . $dbh->quote( $data{'address2'} )
720 . ",zipcode=" . $dbh->quote( $data{'zipcode'} )
721 . ",city=" . $dbh->quote( $data{'city'} )
722 . ",phone=" . $dbh->quote( $data{'phone'} )
723 . ",email=" . $dbh->quote( $data{'email'} )
724 . ",mobile=" . $dbh->quote( $data{'mobile'} )
725 . ",phonepro=" . $dbh->quote( $data{'phonepro'} )
726 . ",opacnote=" . $dbh->quote( $data{'opacnote'} )
727 . ",guarantorid=" . $dbh->quote( $data{'guarantorid'} )
728 . ",dateofbirth=" . $dbh->quote( $data{'dateofbirth'} )
729 . ",branchcode=" . $dbh->quote( $data{'branchcode'} )
730 . ",categorycode=" . $dbh->quote( $data{'categorycode'} )
731 . ",dateenrolled=" . $dbh->quote( $data{'dateenrolled'} )
732 . ",contactname=" . $dbh->quote( $data{'contactname'} )
733 . ",borrowernotes=" . $dbh->quote( $data{'borrowernotes'} )
734 . ",dateexpiry=" . $dbh->quote( $data{'dateexpiry'} )
735 . ",contactnote=" . $dbh->quote( $data{'contactnote'} )
736 . ",B_address=" . $dbh->quote( $data{'B_address'} )
737 . ",B_zipcode=" . $dbh->quote( $data{'B_zipcode'} )
738 . ",B_city=" . $dbh->quote( $data{'B_city'} )
739 . ",B_phone=" . $dbh->quote( $data{'B_phone'} )
740 . ",B_email=" . $dbh->quote( $data{'B_email'} )
741 . ",password=" . $dbh->quote( $data{'password'} )
742 . ",userid=" . $dbh->quote( $data{'userid'} )
743 . ",sort1=" . $dbh->quote( $data{'sort1'} )
744 . ",sort2=" . $dbh->quote( $data{'sort2'} )
745 . ",contacttitle=" . $dbh->quote( $data{'contacttitle'} )
746 . ",emailpro=" . $dbh->quote( $data{'emailpro'} )
747 . ",contactfirstname=" . $dbh->quote( $data{'contactfirstname'} )
748 . ",sex=" . $dbh->quote( $data{'sex'} )
749 . ",fax=" . $dbh->quote( $data{'fax'} )
750 . ",relationship=" . $dbh->quote( $data{'relationship'} )
751 . ",B_streetnumber=" . $dbh->quote( $data{'B_streetnumber'} )
752 . ",B_streettype=" . $dbh->quote( $data{'B_streettype'} )
753 . ",gonenoaddress=" . $dbh->quote( $data{'gonenoaddress'} )
754 . ",lost=" . $dbh->quote( $data{'lost'} )
755 . ",debarred=" . $dbh->quote( $data{'debarred'} )
756 . ",ethnicity=" . $dbh->quote( $data{'ethnicity'} )
757 . ",ethnotes=" . $dbh->quote( $data{'ethnotes'} )
758 . ",altcontactsurname=" . $dbh->quote( $data{'altcontactsurname'} )
759 . ",altcontactfirstname=" . $dbh->quote( $data{'altcontactfirstname'} )
760 . ",altcontactaddress1=" . $dbh->quote( $data{'altcontactaddress1'} )
761 . ",altcontactaddress2=" . $dbh->quote( $data{'altcontactaddress2'} )
762 . ",altcontactaddress3=" . $dbh->quote( $data{'altcontactaddress3'} )
763 . ",altcontactzipcode=" . $dbh->quote( $data{'altcontactzipcode'} )
764 . ",altcontactphone=" . $dbh->quote( $data{'altcontactphone'} ) ;
765 $debug and print STDERR "AddMember SQL: ($query)\n";
766 my $sth = $dbh->prepare($query);
767 # print "Executing SQL: $query\n";
770 $data{'borrowernumber'} = $dbh->{'mysql_insertid'}; # unneeded w/ autoincrement ?
771 # mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
773 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
775 # check for enrollment fee & add it if needed
776 $sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
777 $sth->execute($data{'categorycode'});
778 my ($enrolmentfee) = $sth->fetchrow;
779 if ($enrolmentfee && $enrolmentfee > 0) {
780 # insert fee in patron debts
781 manualinvoice($data{'borrowernumber'}, '', '', 'A', $enrolmentfee);
783 return $data{'borrowernumber'};
787 my ($uid,$member) = @_;
788 my $dbh = C4::Context->dbh;
789 # Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
790 # Then we need to tell the user and have them create a new one.
793 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
794 $sth->execute( $uid, $member );
795 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
803 sub Generate_Userid {
804 my ($borrowernumber, $firstname, $surname) = @_;
808 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
809 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
810 $newuid = lc("$firstname.$surname");
811 $newuid .= $offset unless $offset == 0;
814 } while (!Check_Userid($newuid,$borrowernumber));
820 my ( $uid, $member, $digest ) = @_;
821 my $dbh = C4::Context->dbh;
823 #Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
824 #Then we need to tell the user and have them create a new one.
828 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
829 $sth->execute( $uid, $member );
830 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
834 #Everything is good so we can update the information.
837 "update borrowers set userid=?, password=? where borrowernumber=?");
838 $sth->execute( $uid, $digest, $member );
842 logaction("MEMBERS", "CHANGE PASS", $member, "") if C4::Context->preference("BorrowersLog");
848 =head2 fixup_cardnumber
850 Warning: The caller is responsible for locking the members table in write
851 mode, to avoid database corruption.
855 use vars qw( @weightings );
856 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
858 sub fixup_cardnumber ($) {
859 my ($cardnumber) = @_;
860 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum');
861 $autonumber_members = 0 unless defined $autonumber_members;
863 # Find out whether member numbers should be generated
864 # automatically. Should be either "1" or something else.
865 # Defaults to "0", which is interpreted as "no".
867 # if ($cardnumber !~ /\S/ && $autonumber_members) {
868 if ($autonumber_members) {
869 my $dbh = C4::Context->dbh;
870 if ( C4::Context->preference('checkdigit') eq 'katipo' ) {
872 # if checkdigit is selected, calculate katipo-style cardnumber.
873 # otherwise, just use the max()
874 # purpose: generate checksum'd member numbers.
875 # We'll assume we just got the max value of digits 2-8 of member #'s
876 # from the database and our job is to increment that by one,
877 # determine the 1st and 9th digits and return the full string.
880 "select max(substring(borrowers.cardnumber,2,7)) from borrowers"
884 my $data = $sth->fetchrow_hashref;
885 $cardnumber = $data->{'max(substring(borrowers.cardnumber,2,7))'};
887 if ( !$cardnumber ) { # If DB has no values,
888 $cardnumber = 1000000; # start at 1000000
895 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
897 # read weightings, left to right, 1 char at a time
898 my $temp1 = $weightings[$i];
900 # sequence left to right, 1 char at a time
901 my $temp2 = substr( $cardnumber, $i, 1 );
903 # mult each char 1-7 by its corresponding weighting
904 $sum += $temp1 * $temp2;
907 my $rem = ( $sum % 11 );
908 $rem = 'X' if $rem == 10;
910 $cardnumber = "V$cardnumber$rem";
914 # MODIFIED BY JF: mysql4.1 allows casting as an integer, which is probably
915 # better. I'll leave the original in in case it needs to be changed for you
918 "select max(cast(cardnumber as signed)) from borrowers");
920 #my $sth=$dbh->prepare("select max(borrowers.cardnumber) from borrowers");
924 my ($result) = $sth->fetchrow;
926 $cardnumber = $result + 1;
934 ($num_children, $children_arrayref) = &GetGuarantees($parent_borrno);
935 $child0_cardno = $children_arrayref->[0]{"cardnumber"};
936 $child0_borrno = $children_arrayref->[0]{"borrowernumber"};
938 C<&GetGuarantees> takes a borrower number (e.g., that of a patron
939 with children) and looks up the borrowers who are guaranteed by that
940 borrower (i.e., the patron's children).
942 C<&GetGuarantees> returns two values: an integer giving the number of
943 borrowers guaranteed by C<$parent_borrno>, and a reference to an array
944 of references to hash, which gives the actual results.
950 my ($borrowernumber) = @_;
951 my $dbh = C4::Context->dbh;
954 "select cardnumber,borrowernumber, firstname, surname from borrowers where guarantorid=?"
956 $sth->execute($borrowernumber);
959 my $data = $sth->fetchall_arrayref({});
961 return ( scalar(@$data), $data );
964 =head2 UpdateGuarantees
966 &UpdateGuarantees($parent_borrno);
969 C<&UpdateGuarantees> borrower data for an adulte and updates all the guarantees
970 with the modified information
975 sub UpdateGuarantees {
977 my $dbh = C4::Context->dbh;
978 my ( $count, $guarantees ) = GetGuarantees( $data{'borrowernumber'} );
979 for ( my $i = 0 ; $i < $count ; $i++ ) {
982 # It looks like the $i is only being returned to handle walking through
983 # the array, which is probably better done as a foreach loop.
985 my $guaquery = qq|UPDATE borrowers
986 SET address='$data{'address'}',fax='$data{'fax'}',
987 B_city='$data{'B_city'}',mobile='$data{'mobile'}',city='$data{'city'}',phone='$data{'phone'}'
988 WHERE borrowernumber='$guarantees->[$i]->{'borrowernumber'}'
990 my $sth3 = $dbh->prepare($guaquery);
995 =head2 GetPendingIssues
997 ($count, $issues) = &GetPendingIssues($borrowernumber);
999 Looks up what the patron with the given borrowernumber has borrowed.
1001 C<&GetPendingIssues> returns a two-element array. C<$issues> is a
1002 reference-to-array, where each element is a reference-to-hash; the
1003 keys are the fields from the C<issues>, C<biblio>, and C<items> tables
1004 in the Koha database. C<$count> is the number of elements in
1010 sub GetPendingIssues {
1011 my ($borrowernumber) = @_;
1012 my $dbh = C4::Context->dbh;
1014 my $sth = $dbh->prepare(
1015 "SELECT *,issues.timestamp as timestamp FROM issues
1016 LEFT JOIN items ON issues.itemnumber=items.itemnumber
1017 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1018 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1021 ORDER BY issues.issuedate"
1023 $sth->execute($borrowernumber);
1024 my $data = $sth->fetchall_arrayref({});
1025 my $today = POSIX::strftime("%Y%m%d", localtime);
1027 my $datedue = $_->{'date_due'};
1029 if ( $datedue < $today ) {
1030 $_->{'overdue'} = 1;
1034 return ( scalar(@$data), $data );
1039 ($count, $issues) = &GetAllIssues($borrowernumber, $sortkey, $limit);
1041 Looks up what the patron with the given borrowernumber has borrowed,
1042 and sorts the results.
1044 C<$sortkey> is the name of a field on which to sort the results. This
1045 should be the name of a field in the C<issues>, C<biblio>,
1046 C<biblioitems>, or C<items> table in the Koha database.
1048 C<$limit> is the maximum number of results to return.
1050 C<&GetAllIssues> returns a two-element array. C<$issues> is a
1051 reference-to-array, where each element is a reference-to-hash; the
1052 keys are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
1053 C<items> tables of the Koha database. C<$count> is the number of
1054 elements in C<$issues>
1060 my ( $borrowernumber, $order, $limit ) = @_;
1062 #FIXME: sanity-check order and limit
1063 my $dbh = C4::Context->dbh;
1066 "SELECT *,issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1068 LEFT JOIN items on items.itemnumber=issues.itemnumber
1069 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1070 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1071 WHERE borrowernumber=?
1073 SELECT *,old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1075 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
1076 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1077 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1078 WHERE borrowernumber=?
1080 if ( $limit != 0 ) {
1081 $query .= " limit $limit";
1085 my $sth = $dbh->prepare($query);
1086 $sth->execute($borrowernumber, $borrowernumber);
1089 while ( my $data = $sth->fetchrow_hashref ) {
1090 $result[$i] = $data;
1095 # get all issued items for borrowernumber from oldissues table
1096 # large chunk of older issues data put into table oldissues
1097 # to speed up db calls for issuing items
1098 if ( C4::Context->preference("ReadingHistory") ) {
1099 # FIXME oldissues (not to be confused with old_issues) is
1100 # apparently specific to HLT. Not sure if the ReadingHistory
1101 # syspref is still required, as old_issues by design
1102 # is no longer checked with each loan.
1103 my $query2 = "SELECT * FROM oldissues
1104 LEFT JOIN items ON items.itemnumber=oldissues.itemnumber
1105 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1106 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1107 WHERE borrowernumber=?
1109 if ( $limit != 0 ) {
1110 $limit = $limit - $count;
1111 $query2 .= " limit $limit";
1114 my $sth2 = $dbh->prepare($query2);
1115 $sth2->execute($borrowernumber);
1117 while ( my $data2 = $sth2->fetchrow_hashref ) {
1118 $result[$i] = $data2;
1125 return ( $i, \@result );
1129 =head2 GetMemberAccountRecords
1131 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
1133 Looks up accounting data for the patron with the given borrowernumber.
1135 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
1136 reference-to-array, where each element is a reference-to-hash; the
1137 keys are the fields of the C<accountlines> table in the Koha database.
1138 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1139 total amount outstanding for all of the account lines.
1144 sub GetMemberAccountRecords {
1145 my ($borrowernumber,$date) = @_;
1146 my $dbh = C4::Context->dbh;
1152 WHERE borrowernumber=?);
1153 my @bind = ($borrowernumber);
1154 if ($date && $date ne ''){
1155 $strsth.=" AND date < ? ";
1158 $strsth.=" ORDER BY date desc,timestamp DESC";
1159 my $sth= $dbh->prepare( $strsth );
1160 $sth->execute( @bind );
1162 while ( my $data = $sth->fetchrow_hashref ) {
1163 my $biblio = GetBiblioFromItemNumber($data->{itemnumber}) if $data->{itemnumber};
1164 $data->{biblionumber} = $biblio->{biblionumber};
1165 $acctlines[$numlines] = $data;
1167 $total += $data->{'amountoutstanding'};
1170 return ( $total, \@acctlines,$numlines);
1173 =head2 GetBorNotifyAcctRecord
1175 ($count, $acctlines, $total) = &GetBorNotifyAcctRecord($params,$notifyid);
1177 Looks up accounting data for the patron with the given borrowernumber per file number.
1179 (FIXME - I'm not at all sure what this is about.)
1181 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1182 reference-to-array, where each element is a reference-to-hash; the
1183 keys are the fields of the C<accountlines> table in the Koha database.
1184 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1185 total amount outstanding for all of the account lines.
1189 sub GetBorNotifyAcctRecord {
1190 my ( $borrowernumber, $notifyid ) = @_;
1191 my $dbh = C4::Context->dbh;
1194 my $sth = $dbh->prepare(
1197 WHERE borrowernumber=?
1199 AND amountoutstanding != '0'
1200 ORDER BY notify_id,accounttype
1202 # AND (accounttype='FU' OR accounttype='N' OR accounttype='M'OR accounttype='A'OR accounttype='F'OR accounttype='L' OR accounttype='IP' OR accounttype='CH' OR accounttype='RE' OR accounttype='RL')
1204 $sth->execute( $borrowernumber, $notifyid );
1206 while ( my $data = $sth->fetchrow_hashref ) {
1207 $acctlines[$numlines] = $data;
1209 $total += $data->{'amountoutstanding'};
1212 return ( $total, \@acctlines, $numlines );
1215 =head2 checkuniquemember (OUEST-PROVENCE)
1217 ($result,$categorycode) = &checkuniquemember($collectivity,$surname,$firstname,$dateofbirth);
1219 Checks that a member exists or not in the database.
1221 C<&result> is nonzero (=exist) or 0 (=does not exist)
1222 C<&categorycode> is from categorycode table
1223 C<&collectivity> is 1 (= we add a collectivity) or 0 (= we add a physical member)
1224 C<&surname> is the surname
1225 C<&firstname> is the firstname (only if collectivity=0)
1226 C<&dateofbirth> is the date of birth in ISO format (only if collectivity=0)
1230 # FIXME: This function is not legitimate. Multiple patrons might have the same first/last name and birthdate.
1231 # This is especially true since first name is not even a required field.
1233 sub checkuniquemember {
1234 my ( $collectivity, $surname, $firstname, $dateofbirth ) = @_;
1235 my $dbh = C4::Context->dbh;
1236 my $request = ($collectivity) ?
1237 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? " :
1239 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=? and dateofbirth=?" :
1240 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?";
1241 my $sth = $dbh->prepare($request);
1243 if ($collectivity) {
1244 $sth->execute( uc($surname) );
1245 } elsif($dateofbirth){
1246 $sth->execute( uc($surname), ucfirst($firstname), $dateofbirth );
1248 $sth->execute( uc($surname), ucfirst($firstname));
1250 my @data = $sth->fetchrow;
1252 ( $data[0] ) and return $data[0], $data[1];
1256 sub checkcardnumber {
1257 my ($cardnumber,$borrowernumber) = @_;
1258 my $dbh = C4::Context->dbh;
1259 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1260 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1261 my $sth = $dbh->prepare($query);
1262 if ($borrowernumber) {
1263 $sth->execute($cardnumber,$borrowernumber);
1265 $sth->execute($cardnumber);
1267 if (my $data= $sth->fetchrow_hashref()){
1277 =head2 getzipnamecity (OUEST-PROVENCE)
1279 take all info from table city for the fields city and zip
1280 check for the name and the zip code of the city selected
1284 sub getzipnamecity {
1286 my $dbh = C4::Context->dbh;
1289 "select city_name,city_zipcode from cities where cityid=? ");
1290 $sth->execute($cityid);
1291 my @data = $sth->fetchrow;
1292 return $data[0], $data[1];
1296 =head2 getdcity (OUEST-PROVENCE)
1298 recover cityid with city_name condition
1303 my ($city_name) = @_;
1304 my $dbh = C4::Context->dbh;
1305 my $sth = $dbh->prepare("select cityid from cities where city_name=? ");
1306 $sth->execute($city_name);
1307 my $data = $sth->fetchrow;
1312 =head2 GetExpiryDate
1314 $expirydate = GetExpiryDate($categorycode, $dateenrolled);
1316 Calculate expiry date given a categorycode and starting date. Date argument must be in ISO format.
1317 Return date is also in ISO format.
1322 my ( $categorycode, $dateenrolled ) = @_;
1323 my $enrolmentperiod = 12; # reasonable default
1324 if ($categorycode) {
1325 my $dbh = C4::Context->dbh;
1326 my $sth = $dbh->prepare("select enrolmentperiod from categories where categorycode=?");
1327 $sth->execute($categorycode);
1328 $enrolmentperiod = $sth->fetchrow;
1330 # die "GetExpiryDate: for enrollmentperiod $enrolmentperiod (category '$categorycode') starting $dateenrolled.\n";
1331 my @date = split /-/,$dateenrolled;
1332 return sprintf("%04d-%02d-%02d", Add_Delta_YM(@date,0,$enrolmentperiod));
1335 =head2 checkuserpassword (OUEST-PROVENCE)
1337 check for the password and login are not used
1338 return the number of record
1339 0=> NOT USED 1=> USED
1343 sub checkuserpassword {
1344 my ( $borrowernumber, $userid, $password ) = @_;
1345 $password = md5_base64($password);
1346 my $dbh = C4::Context->dbh;
1349 "Select count(*) from borrowers where borrowernumber !=? and userid =? and password=? "
1351 $sth->execute( $borrowernumber, $userid, $password );
1352 my $number_rows = $sth->fetchrow;
1353 return $number_rows;
1357 =head2 GetborCatFromCatType
1359 ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
1361 Looks up the different types of borrowers in the database. Returns two
1362 elements: a reference-to-array, which lists the borrower category
1363 codes, and a reference-to-hash, which maps the borrower category codes
1364 to category descriptions.
1369 sub GetborCatFromCatType {
1370 my ( $category_type, $action ) = @_;
1371 # FIXME - This API seems both limited and dangerous.
1372 my $dbh = C4::Context->dbh;
1373 my $request = qq| SELECT categorycode,description
1376 ORDER BY categorycode|;
1377 my $sth = $dbh->prepare($request);
1379 $sth->execute($category_type);
1388 while ( my $data = $sth->fetchrow_hashref ) {
1389 push @codes, $data->{'categorycode'};
1390 $labels{ $data->{'categorycode'} } = $data->{'description'};
1393 return ( \@codes, \%labels );
1396 =head2 GetBorrowercategory
1398 $hashref = &GetBorrowercategory($categorycode);
1400 Given the borrower's category code, the function returns the corresponding
1401 data hashref for a comprehensive information display.
1403 $arrayref_hashref = &GetBorrowercategory;
1404 If no category code provided, the function returns all the categories.
1408 sub GetBorrowercategory {
1410 my $dbh = C4::Context->dbh;
1414 "SELECT description,dateofbirthrequired,upperagelimit,category_type
1416 WHERE categorycode = ?"
1418 $sth->execute($catcode);
1420 $sth->fetchrow_hashref;
1425 } # sub getborrowercategory
1427 =head2 GetBorrowercategoryList
1429 $arrayref_hashref = &GetBorrowercategoryList;
1430 If no category code provided, the function returns all the categories.
1434 sub GetBorrowercategoryList {
1435 my $dbh = C4::Context->dbh;
1440 ORDER BY description"
1444 $sth->fetchall_arrayref({});
1447 } # sub getborrowercategory
1449 =head2 ethnicitycategories
1451 ($codes_arrayref, $labels_hashref) = ðnicitycategories();
1453 Looks up the different ethnic types in the database. Returns two
1454 elements: a reference-to-array, which lists the ethnicity codes, and a
1455 reference-to-hash, which maps the ethnicity codes to ethnicity
1462 sub ethnicitycategories {
1463 my $dbh = C4::Context->dbh;
1464 my $sth = $dbh->prepare("Select code,name from ethnicity order by name");
1468 while ( my $data = $sth->fetchrow_hashref ) {
1469 push @codes, $data->{'code'};
1470 $labels{ $data->{'code'} } = $data->{'name'};
1473 return ( \@codes, \%labels );
1478 $ethn_name = &fixEthnicity($ethn_code);
1480 Takes an ethnicity code (e.g., "european" or "pi") and returns the
1481 corresponding descriptive name from the C<ethnicity> table in the
1482 Koha database ("European" or "Pacific Islander").
1489 my $ethnicity = shift;
1490 return unless $ethnicity;
1491 my $dbh = C4::Context->dbh;
1492 my $sth = $dbh->prepare("Select name from ethnicity where code = ?");
1493 $sth->execute($ethnicity);
1494 my $data = $sth->fetchrow_hashref;
1496 return $data->{'name'};
1497 } # sub fixEthnicity
1501 $dateofbirth,$date = &GetAge($date);
1503 this function return the borrowers age with the value of dateofbirth
1509 my ( $date, $date_ref ) = @_;
1511 if ( not defined $date_ref ) {
1512 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1515 my ( $year1, $month1, $day1 ) = split /-/, $date;
1516 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1518 my $age = $year2 - $year1;
1519 if ( $month1 . $day1 > $month2 . $day2 ) {
1526 =head2 get_institutions
1527 $insitutions = get_institutions();
1529 Just returns a list of all the borrowers of type I, borrownumber and name
1534 sub get_institutions {
1535 my $dbh = C4::Context->dbh();
1538 "SELECT borrowernumber,surname FROM borrowers WHERE categorycode=? ORDER BY surname"
1542 while ( my $data = $sth->fetchrow_hashref() ) {
1543 $orgs{ $data->{'borrowernumber'} } = $data;
1548 } # sub get_institutions
1550 =head2 add_member_orgs
1552 add_member_orgs($borrowernumber,$borrowernumbers);
1554 Takes a borrowernumber and a list of other borrowernumbers and inserts them into the borrowers_to_borrowers table
1559 sub add_member_orgs {
1560 my ( $borrowernumber, $otherborrowers ) = @_;
1561 my $dbh = C4::Context->dbh();
1563 "INSERT INTO borrowers_to_borrowers (borrower1,borrower2) VALUES (?,?)";
1564 my $sth = $dbh->prepare($query);
1565 foreach my $otherborrowernumber (@$otherborrowers) {
1566 $sth->execute( $borrowernumber, $otherborrowernumber );
1570 } # sub add_member_orgs
1572 =head2 GetCities (OUEST-PROVENCE)
1574 ($id_cityarrayref, $city_hashref) = &GetCities();
1576 Looks up the different city and zip in the database. Returns two
1577 elements: a reference-to-array, which lists the zip city
1578 codes, and a reference-to-hash, which maps the name of the city.
1579 WHERE =>OUEST PROVENCE OR EXTERIEUR
1585 #my ($type_city) = @_;
1586 my $dbh = C4::Context->dbh;
1587 my $query = qq|SELECT cityid,city_zipcode,city_name
1589 ORDER BY city_name|;
1590 my $sth = $dbh->prepare($query);
1592 #$sth->execute($type_city);
1596 # insert empty value to create a empty choice in cgi popup
1599 while ( my $data = $sth->fetchrow_hashref ) {
1600 push @id, $data->{'city_zipcode'}."|".$data->{'city_name'};
1601 $city{ $data->{'city_zipcode'}."|".$data->{'city_name'} } = $data->{'city_name'};
1604 #test to know if the table contain some records if no the function return nothing
1608 # all we have is the one blank row
1613 return ( \@id, \%city );
1617 =head2 GetSortDetails (OUEST-PROVENCE)
1619 ($lib) = &GetSortDetails($category,$sortvalue);
1621 Returns the authorized value details
1622 C<&$lib>return value of authorized value details
1623 C<&$sortvalue>this is the value of authorized value
1624 C<&$category>this is the value of authorized value category
1628 sub GetSortDetails {
1629 my ( $category, $sortvalue ) = @_;
1630 my $dbh = C4::Context->dbh;
1631 my $query = qq|SELECT lib
1632 FROM authorised_values
1634 AND authorised_value=? |;
1635 my $sth = $dbh->prepare($query);
1636 $sth->execute( $category, $sortvalue );
1637 my $lib = $sth->fetchrow;
1638 return ($lib) if ($lib);
1639 return ($sortvalue) unless ($lib);
1642 =head2 DeleteBorrower
1644 () = &DeleteBorrower($member);
1646 delete all data fo borrowers and add record to deletedborrowers table
1647 C<&$member>this is the borrowernumber
1651 sub MoveMemberToDeleted {
1653 my $dbh = C4::Context->dbh;
1655 $query = qq|SELECT *
1657 WHERE borrowernumber=?|;
1658 my $sth = $dbh->prepare($query);
1659 $sth->execute($member);
1660 my @data = $sth->fetchrow_array;
1663 $dbh->prepare( "INSERT INTO deletedborrowers VALUES ("
1664 . ( "?," x ( scalar(@data) - 1 ) )
1666 $sth->execute(@data);
1672 DelMember($borrowernumber);
1674 This function remove directly a borrower whitout writing it on deleteborrower.
1675 + Deletes reserves for the borrower
1680 my $dbh = C4::Context->dbh;
1681 my $borrowernumber = shift;
1682 #warn "in delmember with $borrowernumber";
1683 return unless $borrowernumber; # borrowernumber is mandatory.
1685 my $query = qq|DELETE
1687 WHERE borrowernumber=?|;
1688 my $sth = $dbh->prepare($query);
1689 $sth->execute($borrowernumber);
1694 WHERE borrowernumber = ?
1696 $sth = $dbh->prepare($query);
1697 $sth->execute($borrowernumber);
1699 logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
1703 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1705 $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1707 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1712 sub ExtendMemberSubscriptionTo {
1713 my ( $borrowerid,$date) = @_;
1714 my $dbh = C4::Context->dbh;
1715 my $borrower = GetMember($borrowerid,'borrowernumber');
1717 $date=POSIX::strftime("%Y-%m-%d",localtime());
1718 my $borrower = GetMember($borrowerid,'borrowernumber');
1719 $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
1721 my $sth = $dbh->do(<<EOF);
1723 SET dateexpiry='$date'
1724 WHERE borrowernumber='$borrowerid'
1726 # add enrolmentfee if needed
1727 $sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
1728 $sth->execute($borrower->{'categorycode'});
1729 my ($enrolmentfee) = $sth->fetchrow;
1730 if ($enrolmentfee) {
1731 # insert fee in patron debts
1732 manualinvoice($borrower->{'borrowernumber'}, '', '', 'A', $enrolmentfee);
1734 return $date if ($sth);
1738 =head2 GetRoadTypes (OUEST-PROVENCE)
1740 ($idroadtypearrayref, $roadttype_hashref) = &GetRoadTypes();
1742 Looks up the different road type . Returns two
1743 elements: a reference-to-array, which lists the id_roadtype
1744 codes, and a reference-to-hash, which maps the road type of the road .
1749 my $dbh = C4::Context->dbh;
1751 SELECT roadtypeid,road_type
1753 ORDER BY road_type|;
1754 my $sth = $dbh->prepare($query);
1759 # insert empty value to create a empty choice in cgi popup
1761 while ( my $data = $sth->fetchrow_hashref ) {
1763 push @id, $data->{'roadtypeid'};
1764 $roadtype{ $data->{'roadtypeid'} } = $data->{'road_type'};
1767 #test to know if the table contain some records if no the function return nothing
1775 return ( \@id, \%roadtype );
1781 =head2 GetTitles (OUEST-PROVENCE)
1783 ($borrowertitle)= &GetTitles();
1785 Looks up the different title . Returns array with all borrowers title
1790 my @borrowerTitle = split /,|\|/,C4::Context->preference('BorrowersTitles');
1791 unshift( @borrowerTitle, "" );
1792 my $count=@borrowerTitle;
1797 return ( \@borrowerTitle);
1801 =head2 GetPatronImage
1803 my ($imagedata, $dberror) = GetPatronImage($cardnumber);
1805 Returns the mimetype and binary image data of the image for the patron with the supplied cardnumber.
1809 sub GetPatronImage {
1810 my ($cardnumber) = @_;
1811 warn "Cardnumber passed to GetPatronImage is $cardnumber" if $debug;
1812 my $dbh = C4::Context->dbh;
1813 my $query = 'SELECT mimetype, imagefile FROM patronimage WHERE cardnumber = ?';
1814 my $sth = $dbh->prepare($query);
1815 $sth->execute($cardnumber);
1816 my $imagedata = $sth->fetchrow_hashref;
1817 my $dberror = $sth->errstr;
1818 warn "Database error!" if $sth->errstr;
1820 return $imagedata, $dberror;
1823 =head2 PutPatronImage
1825 PutPatronImage($cardnumber, $mimetype, $imgfile);
1827 Stores patron binary image data and mimetype in database.
1828 NOTE: This function is good for updating images as well as inserting new images in the database.
1832 sub PutPatronImage {
1833 my ($cardnumber, $mimetype, $imgfile) = @_;
1834 warn "Parameters passed in: Cardnumber=$cardnumber, Mimetype=$mimetype, " . ($imgfile ? "Imagefile" : "No Imagefile") if $debug;
1835 my $dbh = C4::Context->dbh;
1836 my $query = "INSERT INTO patronimage (cardnumber, mimetype, imagefile) VALUES (?,?,?) ON DUPLICATE KEY UPDATE imagefile = ?;";
1837 my $sth = $dbh->prepare($query);
1838 $sth->execute($cardnumber,$mimetype,$imgfile,$imgfile);
1839 warn "Error returned inserting $cardnumber.$mimetype." if $sth->errstr;
1840 my $dberror = $sth->errstr;
1845 =head2 RmPatronImage
1847 my ($dberror) = RmPatronImage($cardnumber);
1849 Removes the image for the patron with the supplied cardnumber.
1854 my ($cardnumber) = @_;
1855 warn "Cardnumber passed to GetPatronImage is $cardnumber" if $debug;
1856 my $dbh = C4::Context->dbh;
1857 my $query = "DELETE FROM patronimage WHERE cardnumber = ?;";
1858 my $sth = $dbh->prepare($query);
1859 $sth->execute($cardnumber);
1860 my $dberror = $sth->errstr;
1861 warn "Database error!" if $sth->errstr;
1866 =head2 GetRoadTypeDetails (OUEST-PROVENCE)
1868 ($roadtype) = &GetRoadTypeDetails($roadtypeid);
1870 Returns the description of roadtype
1871 C<&$roadtype>return description of road type
1872 C<&$roadtypeid>this is the value of roadtype s
1876 sub GetRoadTypeDetails {
1877 my ($roadtypeid) = @_;
1878 my $dbh = C4::Context->dbh;
1882 WHERE roadtypeid=?|;
1883 my $sth = $dbh->prepare($query);
1884 $sth->execute($roadtypeid);
1885 my $roadtype = $sth->fetchrow;
1889 =head2 GetBorrowersWhoHaveNotBorrowedSince
1891 &GetBorrowersWhoHaveNotBorrowedSince($date)
1893 this function get all borrowers who haven't borrowed since the date given on input arg.
1897 sub GetBorrowersWhoHaveNotBorrowedSince {
1898 ### TODO : It could be dangerous to delete Borrowers who have just been entered and who have not yet borrowed any book. May be good to add a dateexpiry or dateenrolled filter.
1900 my $filterdate = shift||POSIX::strftime("%Y-%m-%d",localtime());
1901 my $filterbranch = shift ||
1902 ((C4::Context->preference('IndependantBranches')
1903 && C4::Context->userenv
1904 && C4::Context->userenv->{flags}!=1
1905 && C4::Context->userenv->{branch})
1906 ? C4::Context->userenv->{branch}
1908 my $dbh = C4::Context->dbh;
1910 SELECT borrowers.borrowernumber,max(issues.timestamp) as latestissue
1912 JOIN categories USING (categorycode)
1913 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
1914 WHERE category_type <> 'S'
1917 if ($filterbranch && $filterbranch ne ""){
1918 $query.=" AND borrowers.branchcode= ?";
1919 push @query_params,$filterbranch;
1921 $query.=" GROUP BY borrowers.borrowernumber";
1923 $query.=" HAVING latestissue <? OR latestissue IS NULL";
1924 push @query_params,$filterdate;
1926 warn $query if $debug;
1927 my $sth = $dbh->prepare($query);
1928 if (scalar(@query_params)>0){
1929 $sth->execute(@query_params);
1936 while ( my $data = $sth->fetchrow_hashref ) {
1937 push @results, $data;
1942 =head2 GetBorrowersWhoHaveNeverBorrowed
1944 $results = &GetBorrowersWhoHaveNeverBorrowed
1946 this function get all borrowers who have never borrowed.
1948 I<$result> is a ref to an array which all elements are a hasref.
1952 sub GetBorrowersWhoHaveNeverBorrowed {
1953 my $filterbranch = shift ||
1954 ((C4::Context->preference('IndependantBranches')
1955 && C4::Context->userenv
1956 && C4::Context->userenv->{flags}!=1
1957 && C4::Context->userenv->{branch})
1958 ? C4::Context->userenv->{branch}
1960 my $dbh = C4::Context->dbh;
1962 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
1964 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
1965 WHERE issues.borrowernumber IS NULL
1968 if ($filterbranch && $filterbranch ne ""){
1969 $query.=" AND borrowers.branchcode= ?";
1970 push @query_params,$filterbranch;
1972 warn $query if $debug;
1974 my $sth = $dbh->prepare($query);
1975 if (scalar(@query_params)>0){
1976 $sth->execute(@query_params);
1983 while ( my $data = $sth->fetchrow_hashref ) {
1984 push @results, $data;
1989 =head2 GetBorrowersWithIssuesHistoryOlderThan
1991 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
1993 this function get all borrowers who has an issue history older than I<$date> given on input arg.
1995 I<$result> is a ref to an array which all elements are a hashref.
1996 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2000 sub GetBorrowersWithIssuesHistoryOlderThan {
2001 my $dbh = C4::Context->dbh;
2002 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
2003 my $filterbranch = shift ||
2004 ((C4::Context->preference('IndependantBranches')
2005 && C4::Context->userenv
2006 && C4::Context->userenv->{flags}!=1
2007 && C4::Context->userenv->{branch})
2008 ? C4::Context->userenv->{branch}
2011 SELECT count(borrowernumber) as n,borrowernumber
2013 WHERE returndate < ?
2014 AND borrowernumber IS NOT NULL
2017 push @query_params, $date;
2019 $query.=" AND branchcode = ?";
2020 push @query_params, $filterbranch;
2022 $query.=" GROUP BY borrowernumber ";
2023 warn $query if $debug;
2024 my $sth = $dbh->prepare($query);
2025 $sth->execute(@query_params);
2028 while ( my $data = $sth->fetchrow_hashref ) {
2029 push @results, $data;
2034 =head2 GetBorrowersNamesAndLatestIssue
2036 $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
2038 this function get borrowers Names and surnames and Issue information.
2040 I<@borrowernumbers> is an array which all elements are borrowernumbers.
2041 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2045 sub GetBorrowersNamesAndLatestIssue {
2046 my $dbh = C4::Context->dbh;
2047 my @borrowernumbers=@_;
2049 SELECT surname,lastname, phone, email,max(timestamp)
2051 LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
2052 GROUP BY borrowernumber
2054 my $sth = $dbh->prepare($query);
2056 my $results = $sth->fetchall_arrayref({});
2064 my $success = DebarMember( $borrowernumber );
2066 marks a Member as debarred, and therefore unable to checkout any more
2070 true on success, false on failure
2077 my $borrowernumber = shift;
2079 return unless defined $borrowernumber;
2080 return unless $borrowernumber =~ /^\d+$/;
2082 return ModMember( borrowernumber => $borrowernumber,
2087 END { } # module clean-up code here (global destructor)