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
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
31 use C4::SQLHelper qw(InsertInTable UpdateInTable SearchInTable);
32 use C4::Members::Attributes qw(SearchIdMatchingAttribute);
34 our ($VERSION,@ISA,@EXPORT,@EXPORT_OK,$debug);
38 $debug = $ENV{DEBUG} || 0;
50 &GetMemberIssuesAndFines
70 &GetMemberAccountRecords
71 &GetBorNotifyAcctRecord
75 &GetBorrowercategoryList
77 &GetBorrowersWhoHaveNotBorrowedSince
78 &GetBorrowersWhoHaveNeverBorrowed
79 &GetBorrowersWithIssuesHistoryOlderThan
105 &ExtendMemberSubscriptionTo
123 C4::Members - Perl Module containing convenience functions for member handling
131 This module contains routines for adding, modifying and deleting members/patrons/borrowers
139 ($count, $borrowers) = &SearchMember($searchstring, $type,$category_type,$filter,$showallbranches);
143 Looks up patrons (borrowers) by name.
145 BUGFIX 499: C<$type> is now used to determine type of search.
146 if $type is "simple", search is performed on the first letter of the
149 $category_type is used to get a specified type of user.
150 (mainly adults when creating a child.)
152 C<$searchstring> is a space-separated list of search terms. Each term
153 must match the beginning a borrower's surname, first name, or other
156 C<$filter> is assumed to be a list of elements to filter results on
158 C<$showallbranches> is used in IndependantBranches Context to display all branches results.
160 C<&SearchMember> returns a two-element list. C<$borrowers> is a
161 reference-to-array; each element is a reference-to-hash, whose keys
162 are the fields of the C<borrowers> table in the Koha database.
163 C<$count> is the number of elements in C<$borrowers>.
168 #used by member enquiries from the intranet
170 my ($searchstring, $orderby, $type,$category_type,$filter,$showallbranches ) = @_;
171 my $dbh = C4::Context->dbh;
177 # this is used by circulation everytime a new borrowers cardnumber is scanned
178 # so we can check an exact match first, if that works return, otherwise do the rest
179 $query = "SELECT * FROM borrowers
180 LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
182 my $sth = $dbh->prepare("$query WHERE cardnumber = ?");
183 $sth->execute($searchstring);
184 my $data = $sth->fetchall_arrayref({});
186 return ( scalar(@$data), $data );
189 if ( $type eq "simple" ) # simple search for one letter only
191 $query .= ($category_type ? " AND category_type = ".$dbh->quote($category_type) : "");
192 $query .= " WHERE (surname LIKE ? OR cardnumber like ?) ";
193 if (C4::Context->preference("IndependantBranches") && !$showallbranches){
194 if (C4::Context->userenv && C4::Context->userenv->{flags} % 2 !=1 && C4::Context->userenv->{'branch'}){
195 $query.=" AND borrowers.branchcode =".$dbh->quote(C4::Context->userenv->{'branch'}) unless (C4::Context->userenv->{'branch'} eq "insecure");
198 $query.=" ORDER BY $orderby";
199 @bind = ("$searchstring%","$searchstring");
201 else # advanced search looking in surname, firstname and othernames
203 @data = split( ' ', $searchstring );
206 if (C4::Context->preference("IndependantBranches") && !$showallbranches){
207 if (C4::Context->userenv && C4::Context->userenv->{flags} % 2 !=1 && C4::Context->userenv->{'branch'}){
208 $query.=" borrowers.branchcode =".$dbh->quote(C4::Context->userenv->{'branch'})." AND " unless (C4::Context->userenv->{'branch'} eq "insecure");
211 $query.="((surname LIKE ? OR surname LIKE ?
212 OR firstname LIKE ? OR firstname LIKE ?
213 OR othernames LIKE ? OR othernames LIKE ?)
215 ($category_type?" AND category_type = ".$dbh->quote($category_type):"");
217 "$data[0]%", "% $data[0]%", "$data[0]%", "% $data[0]%",
218 "$data[0]%", "% $data[0]%"
220 for ( my $i = 1 ; $i < $count ; $i++ ) {
221 $query = $query . " AND (" . " surname LIKE ? OR surname LIKE ?
222 OR firstname LIKE ? OR firstname LIKE ?
223 OR othernames LIKE ? OR othernames LIKE ?)";
225 "$data[$i]%", "% $data[$i]%", "$data[$i]%",
226 "% $data[$i]%", "$data[$i]%", "% $data[$i]%" );
230 $query = $query . ") OR cardnumber LIKE ? ";
231 push( @bind, $searchstring );
232 $query .= "order by $orderby";
237 $sth = $dbh->prepare($query);
239 $debug and print STDERR "Q $orderby : $query\n";
240 $sth->execute(@bind);
242 $data = $sth->fetchall_arrayref({});
244 return ( scalar(@$data), $data );
251 $borrowers_result_array_ref = &Search($filter,$orderby, $limit, $columns_out, $search_on_fields,$searchtype);
255 Looks up patrons (borrowers) on filter.
257 BUGFIX 499: C<$type> is now used to determine type of search.
258 if $type is "simple", search is performed on the first letter of the
261 $category_type is used to get a specified type of user.
262 (mainly adults when creating a child.)
265 - a space-separated list of search terms. Implicit AND is done on them
266 - a hash ref containing fieldnames associated with queried value
267 - an array ref combining the two previous elements Implicit OR is done between each array element
270 C<$orderby> is an arrayref of hashref. Contains the name of the field and 0 or 1 depending if order is ascending or descending
272 C<$limit> is there to allow limiting number of results returned
274 C<&columns_out> is an array ref to the fieldnames you want to see in the result list
276 C<&search_on_fields> is an array ref to the fieldnames you want to limit search on when you are using string search
278 C<&searchtype> is a string telling the type of search you want todo : start_with, exact or contains are allowed
283 my ($filter,$orderby, $limit, $columns_out, $search_on_fields,$searchtype) = @_;
285 if (ref($filter) eq "ARRAY"){
286 push @filters,@$filter;
289 push @filters,$filter;
291 if (C4::Context->preference('ExtendedPatronAttributes')) {
292 my $matching_records = C4::Members::Attributes::SearchIdMatchingAttribute($filter);
293 push @filters,@$matching_records;
295 $searchtype||="start_with";
296 my $data=SearchInTable("borrowers",\@filters,$orderby,$limit,$columns_out,$search_on_fields,$searchtype);
301 =head2 GetMemberDetails
303 ($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
305 Looks up a patron and returns information about him or her. If
306 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
307 up the borrower by number; otherwise, it looks up the borrower by card
310 C<$borrower> is a reference-to-hash whose keys are the fields of the
311 borrowers table in the Koha database. In addition,
312 C<$borrower-E<gt>{flags}> is a hash giving more detailed information
313 about the patron. Its keys act as flags :
315 if $borrower->{flags}->{LOST} {
316 # Patron's card was reported lost
319 If the state of a flag means that the patron should not be
320 allowed to borrow any more books, then it will have a C<noissues> key
323 See patronflags for more details.
325 C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
326 about the top-level permissions flags set for the borrower. For example,
327 if a user has the "editcatalogue" permission,
328 C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
333 sub GetMemberDetails {
334 my ( $borrowernumber, $cardnumber ) = @_;
335 my $dbh = C4::Context->dbh;
338 if ($borrowernumber) {
339 $sth = $dbh->prepare("select borrowers.*,category_type,categories.description from borrowers left join categories on borrowers.categorycode=categories.categorycode where borrowernumber=?");
340 $sth->execute($borrowernumber);
342 elsif ($cardnumber) {
343 $sth = $dbh->prepare("select borrowers.*,category_type,categories.description from borrowers left join categories on borrowers.categorycode=categories.categorycode where cardnumber=?");
344 $sth->execute($cardnumber);
349 my $borrower = $sth->fetchrow_hashref;
350 my ($amount) = GetMemberAccountRecords( $borrowernumber);
351 $borrower->{'amountoutstanding'} = $amount;
352 # FIXME - patronflags calls GetMemberAccountRecords... just have patronflags return $amount
353 my $flags = patronflags( $borrower);
356 $sth = $dbh->prepare("select bit,flag from userflags");
358 while ( my ( $bit, $flag ) = $sth->fetchrow ) {
359 if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
360 $accessflagshash->{$flag} = 1;
363 $borrower->{'flags'} = $flags;
364 $borrower->{'authflags'} = $accessflagshash;
366 # find out how long the membership lasts
369 "select enrolmentperiod from categories where categorycode = ?");
370 $sth->execute( $borrower->{'categorycode'} );
371 my $enrolment = $sth->fetchrow;
372 $borrower->{'enrolmentperiod'} = $enrolment;
373 return ($borrower); #, $flags, $accessflagshash);
378 $flags = &patronflags($patron);
380 This function is not exported.
382 The following will be set where applicable:
383 $flags->{CHARGES}->{amount} Amount of debt
384 $flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge)
385 $flags->{CHARGES}->{message} Message -- deprecated
387 $flags->{CREDITS}->{amount} Amount of credit
388 $flags->{CREDITS}->{message} Message -- deprecated
390 $flags->{ GNA } Patron has no valid address
391 $flags->{ GNA }->{noissues} Set for each GNA
392 $flags->{ GNA }->{message} "Borrower has no valid address" -- deprecated
394 $flags->{ LOST } Patron's card reported lost
395 $flags->{ LOST }->{noissues} Set for each LOST
396 $flags->{ LOST }->{message} Message -- deprecated
398 $flags->{DBARRED} Set if patron debarred, no access
399 $flags->{DBARRED}->{noissues} Set for each DBARRED
400 $flags->{DBARRED}->{message} Message -- deprecated
403 $flags->{ NOTES }->{message} The note itself. NOT deprecated
405 $flags->{ ODUES } Set if patron has overdue books.
406 $flags->{ ODUES }->{message} "Yes" -- deprecated
407 $flags->{ ODUES }->{itemlist} ref-to-array: list of overdue books
408 $flags->{ ODUES }->{itemlisttext} Text list of overdue items -- deprecated
410 $flags->{WAITING} Set if any of patron's reserves are available
411 $flags->{WAITING}->{message} Message -- deprecated
412 $flags->{WAITING}->{itemlist} ref-to-array: list of available items
416 C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
417 overdue items. Its elements are references-to-hash, each describing an
418 overdue item. The keys are selected fields from the issues, biblio,
419 biblioitems, and items tables of the Koha database.
421 C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
422 the overdue items, one per line. Deprecated.
424 C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
425 available items. Each element is a reference-to-hash whose keys are
426 fields from the reserves table of the Koha database.
430 All the "message" fields that include language generated in this function are deprecated,
431 because such strings belong properly in the display layer.
433 The "message" field that comes from the DB is OK.
437 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
438 # FIXME rename this function.
441 my ( $patroninformation) = @_;
442 my $dbh=C4::Context->dbh;
443 my ($amount) = GetMemberAccountRecords( $patroninformation->{'borrowernumber'});
446 my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
447 $flaginfo{'message'} = sprintf "Patron owes \$%.02f", $amount;
448 $flaginfo{'amount'} = sprintf "%.02f", $amount;
449 if ( $amount > $noissuescharge ) {
450 $flaginfo{'noissues'} = 1;
452 $flags{'CHARGES'} = \%flaginfo;
454 elsif ( $amount < 0 ) {
456 $flaginfo{'message'} = sprintf "Patron has credit of \$%.02f", -$amount;
457 $flaginfo{'amount'} = sprintf "%.02f", $amount;
458 $flags{'CREDITS'} = \%flaginfo;
460 if ( $patroninformation->{'gonenoaddress'}
461 && $patroninformation->{'gonenoaddress'} == 1 )
464 $flaginfo{'message'} = 'Borrower has no valid address.';
465 $flaginfo{'noissues'} = 1;
466 $flags{'GNA'} = \%flaginfo;
468 if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
470 $flaginfo{'message'} = 'Borrower\'s card reported lost.';
471 $flaginfo{'noissues'} = 1;
472 $flags{'LOST'} = \%flaginfo;
474 if ( $patroninformation->{'debarred'}
475 && $patroninformation->{'debarred'} == 1 )
478 $flaginfo{'message'} = 'Borrower is Debarred.';
479 $flaginfo{'noissues'} = 1;
480 $flags{'DBARRED'} = \%flaginfo;
482 if ( $patroninformation->{'borrowernotes'}
483 && $patroninformation->{'borrowernotes'} )
486 $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
487 $flags{'NOTES'} = \%flaginfo;
489 my ( $odues, $itemsoverdue ) = checkoverdues($patroninformation->{'borrowernumber'});
492 $flaginfo{'message'} = "Yes";
493 $flaginfo{'itemlist'} = $itemsoverdue;
494 foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
497 $flaginfo{'itemlisttext'} .=
498 "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n"; # newline is display layer
500 $flags{'ODUES'} = \%flaginfo;
502 my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
503 my $nowaiting = scalar @itemswaiting;
504 if ( $nowaiting > 0 ) {
506 $flaginfo{'message'} = "Reserved items available";
507 $flaginfo{'itemlist'} = \@itemswaiting;
508 $flags{'WAITING'} = \%flaginfo;
516 $borrower = &GetMember(%information);
518 Retrieve the first patron record meeting on criteria listed in the
519 C<%information> hash, which should contain one or more
520 pairs of borrowers column names and values, e.g.,
522 $borrower = GetMember(borrowernumber => id);
524 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
525 the C<borrowers> table in the Koha database.
527 FIXME: GetMember() is used throughout the code as a lookup
528 on a unique key such as the borrowernumber, but this meaning is not
529 enforced in the routine itself.
535 my ( %information ) = @_;
536 if (exists $information{borrowernumber} && !defined $information{borrowernumber}) {
537 #passing mysql's kohaadmin?? Makes no sense as a query
540 my $dbh = C4::Context->dbh;
542 q{SELECT borrowers.*, categories.category_type, categories.description
544 LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
547 for (keys %information ) {
555 if (defined $information{$_}) {
557 push @values, $information{$_};
560 $select .= "$_ IS NULL";
563 $debug && warn $select, " ",values %information;
564 my $sth = $dbh->prepare("$select");
565 $sth->execute(map{$information{$_}} keys %information);
566 my $data = $sth->fetchall_arrayref({});
567 #FIXME interface to this routine now allows generation of a result set
568 #so whole array should be returned but bowhere in the current code expects this
577 =head2 IsMemberBlocked
581 my $blocked = IsMemberBlocked( $borrowernumber );
583 return the status, and the number of day or documents, depends his punishment
586 -1 if the user have overdue returns
587 1 if the user is punished X days
588 0 if the user is authorised to loan
594 sub IsMemberBlocked {
595 my $borrowernumber = shift;
596 my $dbh = C4::Context->dbh;
597 # if he have late issues
598 my $sth = $dbh->prepare(
599 "SELECT COUNT(*) as latedocs
601 WHERE borrowernumber = ?
602 AND date_due < now()"
604 $sth->execute($borrowernumber);
605 my $latedocs = $sth->fetchrow_hashref->{'latedocs'};
607 return (-1, $latedocs) if $latedocs > 0;
611 ADDDATE(returndate, finedays * DATEDIFF(returndate,date_due) ) AS blockingdate,
612 DATEDIFF(ADDDATE(returndate, finedays * DATEDIFF(returndate,date_due)),NOW()) AS blockedcount
615 # or if he must wait to loan
616 if(C4::Context->preference("item-level_itypes")){
618 qq{ LEFT JOIN items ON (items.itemnumber=old_issues.itemnumber)
619 LEFT JOIN issuingrules ON (issuingrules.itemtype=items.itype)}
622 qq{ LEFT JOIN items ON (items.itemnumber=old_issues.itemnumber)
623 LEFT JOIN biblioitems ON (biblioitems.biblioitemnumber=items.biblioitemnumber)
624 LEFT JOIN issuingrules ON (issuingrules.itemtype=biblioitems.itemtype) };
627 qq{ WHERE finedays IS NOT NULL
628 AND date_due < returndate
629 AND borrowernumber = ?
630 ORDER BY blockingdate DESC, blockedcount DESC
632 $sth=$dbh->prepare($strsth);
633 $sth->execute($borrowernumber);
634 my $row = $sth->fetchrow_hashref;
635 my $blockeddate = $row->{'blockeddate'};
636 my $blockedcount = $row->{'blockedcount'};
638 return (1, $blockedcount) if $blockedcount > 0;
643 =head2 GetMemberIssuesAndFines
645 ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
647 Returns aggregate data about items borrowed by the patron with the
648 given borrowernumber.
650 C<&GetMemberIssuesAndFines> returns a three-element array. C<$overdue_count> is the
651 number of overdue items the patron currently has borrowed. C<$issue_count> is the
652 number of books the patron currently has borrowed. C<$total_fines> is
653 the total fine currently due by the borrower.
658 sub GetMemberIssuesAndFines {
659 my ( $borrowernumber ) = @_;
660 my $dbh = C4::Context->dbh;
661 my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
663 $debug and warn $query."\n";
664 my $sth = $dbh->prepare($query);
665 $sth->execute($borrowernumber);
666 my $issue_count = $sth->fetchrow_arrayref->[0];
668 $sth = $dbh->prepare(
669 "SELECT COUNT(*) FROM issues
670 WHERE borrowernumber = ?
671 AND date_due < now()"
673 $sth->execute($borrowernumber);
674 my $overdue_count = $sth->fetchrow_arrayref->[0];
676 $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
677 $sth->execute($borrowernumber);
678 my $total_fines = $sth->fetchrow_arrayref->[0];
680 return ($overdue_count, $issue_count, $total_fines);
684 return @{C4::Context->dbh->selectcol_arrayref("SHOW columns from borrowers")};
693 my $success = ModMember(borrowernumber => $borrowernumber, [ field => value ]... );
695 Modify borrower's data. All date fields should ALREADY be in ISO format.
698 true on success, or false on failure
705 # test to know if you must update or not the borrower password
706 if (exists $data{password}) {
707 if ($data{password} eq '****' or $data{password} eq '') {
708 delete $data{password};
710 $data{password} = md5_base64($data{password});
713 my $execute_success=UpdateInTable("borrowers",\%data);
714 # ok if its an adult (type) it may have borrowers that depend on it as a guarantor
715 # so when we update information for an adult we should check for guarantees and update the relevant part
716 # of their records, ie addresses and phone numbers
717 my $borrowercategory= GetBorrowercategory( $data{'category_type'} );
718 if ( exists $borrowercategory->{'category_type'} && $borrowercategory->{'category_type'} eq ('A' || 'S') ) {
719 # is adult check guarantees;
720 UpdateGuarantees(%data);
722 logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})")
723 if C4::Context->preference("BorrowersLog");
725 return $execute_success;
733 $borrowernumber = &AddMember(%borrower);
735 insert new borrower into table
736 Returns the borrowernumber
743 my $dbh = C4::Context->dbh;
744 $data{'password'} = '!' if (not $data{'password'} and $data{'userid'});
745 $data{'password'} = md5_base64( $data{'password'} ) if $data{'password'};
746 $data{'borrowernumber'}=InsertInTable("borrowers",\%data);
747 # mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
748 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
750 # check for enrollment fee & add it if needed
751 my $sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
752 $sth->execute($data{'categorycode'});
753 my ($enrolmentfee) = $sth->fetchrow;
754 if ($enrolmentfee && $enrolmentfee > 0) {
755 # insert fee in patron debts
756 manualinvoice($data{'borrowernumber'}, '', '', 'A', $enrolmentfee);
758 return $data{'borrowernumber'};
763 my ($uid,$member) = @_;
764 my $dbh = C4::Context->dbh;
765 # Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
766 # Then we need to tell the user and have them create a new one.
769 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
770 $sth->execute( $uid, $member );
771 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
779 sub Generate_Userid {
780 my ($borrowernumber, $firstname, $surname) = @_;
784 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
785 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
786 $newuid = lc("$firstname.$surname");
787 $newuid .= $offset unless $offset == 0;
790 } while (!Check_Userid($newuid,$borrowernumber));
796 my ( $uid, $member, $digest ) = @_;
797 my $dbh = C4::Context->dbh;
799 #Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
800 #Then we need to tell the user and have them create a new one.
804 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
805 $sth->execute( $uid, $member );
806 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
810 #Everything is good so we can update the information.
813 "update borrowers set userid=?, password=? where borrowernumber=?");
814 $sth->execute( $uid, $digest, $member );
818 logaction("MEMBERS", "CHANGE PASS", $member, "") if C4::Context->preference("BorrowersLog");
824 =head2 fixup_cardnumber
826 Warning: The caller is responsible for locking the members table in write
827 mode, to avoid database corruption.
831 use vars qw( @weightings );
832 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
834 sub fixup_cardnumber ($) {
835 my ($cardnumber) = @_;
836 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
838 # Find out whether member numbers should be generated
839 # automatically. Should be either "1" or something else.
840 # Defaults to "0", which is interpreted as "no".
842 # if ($cardnumber !~ /\S/ && $autonumber_members) {
843 ($autonumber_members) or return $cardnumber;
844 my $checkdigit = C4::Context->preference('checkdigit');
845 my $dbh = C4::Context->dbh;
846 if ( $checkdigit and $checkdigit eq 'katipo' ) {
848 # if checkdigit is selected, calculate katipo-style cardnumber.
849 # otherwise, just use the max()
850 # purpose: generate checksum'd member numbers.
851 # We'll assume we just got the max value of digits 2-8 of member #'s
852 # from the database and our job is to increment that by one,
853 # determine the 1st and 9th digits and return the full string.
854 my $sth = $dbh->prepare(
855 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
858 my $data = $sth->fetchrow_hashref;
859 $cardnumber = $data->{new_num};
860 if ( !$cardnumber ) { # If DB has no values,
861 $cardnumber = 1000000; # start at 1000000
867 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
868 # read weightings, left to right, 1 char at a time
869 my $temp1 = $weightings[$i];
871 # sequence left to right, 1 char at a time
872 my $temp2 = substr( $cardnumber, $i, 1 );
874 # mult each char 1-7 by its corresponding weighting
875 $sum += $temp1 * $temp2;
878 my $rem = ( $sum % 11 );
879 $rem = 'X' if $rem == 10;
881 return "V$cardnumber$rem";
884 # MODIFIED BY JF: mysql4.1 allows casting as an integer, which is probably
885 # better. I'll leave the original in in case it needs to be changed for you
886 # my $sth=$dbh->prepare("select max(borrowers.cardnumber) from borrowers");
887 my $sth = $dbh->prepare(
888 "select max(cast(cardnumber as signed)) from borrowers"
891 my ($result) = $sth->fetchrow;
894 return $cardnumber; # just here as a fallback/reminder
899 ($num_children, $children_arrayref) = &GetGuarantees($parent_borrno);
900 $child0_cardno = $children_arrayref->[0]{"cardnumber"};
901 $child0_borrno = $children_arrayref->[0]{"borrowernumber"};
903 C<&GetGuarantees> takes a borrower number (e.g., that of a patron
904 with children) and looks up the borrowers who are guaranteed by that
905 borrower (i.e., the patron's children).
907 C<&GetGuarantees> returns two values: an integer giving the number of
908 borrowers guaranteed by C<$parent_borrno>, and a reference to an array
909 of references to hash, which gives the actual results.
915 my ($borrowernumber) = @_;
916 my $dbh = C4::Context->dbh;
919 "select cardnumber,borrowernumber, firstname, surname from borrowers where guarantorid=?"
921 $sth->execute($borrowernumber);
924 my $data = $sth->fetchall_arrayref({});
925 return ( scalar(@$data), $data );
928 =head2 UpdateGuarantees
930 &UpdateGuarantees($parent_borrno);
933 C<&UpdateGuarantees> borrower data for an adult and updates all the guarantees
934 with the modified information
939 sub UpdateGuarantees {
941 my $dbh = C4::Context->dbh;
942 my ( $count, $guarantees ) = GetGuarantees( $data{'borrowernumber'} );
943 for ( my $i = 0 ; $i < $count ; $i++ ) {
946 # It looks like the $i is only being returned to handle walking through
947 # the array, which is probably better done as a foreach loop.
949 my $guaquery = qq|UPDATE borrowers
950 SET address='$data{'address'}',fax='$data{'fax'}',
951 B_city='$data{'B_city'}',mobile='$data{'mobile'}',city='$data{'city'}',phone='$data{'phone'}'
952 WHERE borrowernumber='$guarantees->[$i]->{'borrowernumber'}'
954 my $sth3 = $dbh->prepare($guaquery);
958 =head2 GetPendingIssues
960 my $issues = &GetPendingIssues($borrowernumber);
962 Looks up what the patron with the given borrowernumber has borrowed.
964 C<&GetPendingIssues> returns a
965 reference-to-array where each element is a reference-to-hash; the
966 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
967 The keys include C<biblioitems> fields except marc and marcxml.
972 sub GetPendingIssues {
973 my ($borrowernumber) = @_;
974 # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
975 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
976 # FIXME: circ/ciculation.pl tries to sort by timestamp!
977 # FIXME: C4::Print::printslip tries to sort by timestamp!
978 # FIXME: namespace collision: other collisions possible.
979 # FIXME: most of this data isn't really being used by callers.
980 my $sth = C4::Context->dbh->prepare(
986 biblioitems.itemtype,
989 biblioitems.publicationyear,
990 biblioitems.publishercode,
991 biblioitems.volumedate,
992 biblioitems.volumedesc,
995 issues.timestamp AS timestamp,
996 issues.renewals AS renewals,
997 items.renewals AS totalrenewals
999 LEFT JOIN items ON items.itemnumber = issues.itemnumber
1000 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1001 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
1004 ORDER BY issues.issuedate"
1006 $sth->execute($borrowernumber);
1007 my $data = $sth->fetchall_arrayref({});
1008 my $today = C4::Dates->new->output('iso');
1010 $_->{date_due} or next;
1011 ($_->{date_due} lt $today) and $_->{overdue} = 1;
1018 ($count, $issues) = &GetAllIssues($borrowernumber, $sortkey, $limit);
1020 Looks up what the patron with the given borrowernumber has borrowed,
1021 and sorts the results.
1023 C<$sortkey> is the name of a field on which to sort the results. This
1024 should be the name of a field in the C<issues>, C<biblio>,
1025 C<biblioitems>, or C<items> table in the Koha database.
1027 C<$limit> is the maximum number of results to return.
1029 C<&GetAllIssues> returns a two-element array. C<$issues> is a
1030 reference-to-array, where each element is a reference-to-hash; the
1031 keys are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
1032 C<items> tables of the Koha database. C<$count> is the number of
1033 elements in C<$issues>
1039 my ( $borrowernumber, $order, $limit ) = @_;
1041 #FIXME: sanity-check order and limit
1042 my $dbh = C4::Context->dbh;
1044 "SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1046 LEFT JOIN items on items.itemnumber=issues.itemnumber
1047 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1048 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1049 WHERE borrowernumber=?
1051 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1053 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
1054 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1055 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1056 WHERE borrowernumber=?
1058 if ( $limit != 0 ) {
1059 $query .= " limit $limit";
1062 my $sth = $dbh->prepare($query);
1063 $sth->execute($borrowernumber, $borrowernumber);
1066 while ( my $data = $sth->fetchrow_hashref ) {
1067 push @result, $data;
1074 =head2 GetMemberAccountRecords
1076 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
1078 Looks up accounting data for the patron with the given borrowernumber.
1080 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
1081 reference-to-array, where each element is a reference-to-hash; the
1082 keys are the fields of the C<accountlines> table in the Koha database.
1083 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1084 total amount outstanding for all of the account lines.
1089 sub GetMemberAccountRecords {
1090 my ($borrowernumber,$date) = @_;
1091 my $dbh = C4::Context->dbh;
1097 WHERE borrowernumber=?);
1098 my @bind = ($borrowernumber);
1099 if ($date && $date ne ''){
1100 $strsth.=" AND date < ? ";
1103 $strsth.=" ORDER BY date desc,timestamp DESC";
1104 my $sth= $dbh->prepare( $strsth );
1105 $sth->execute( @bind );
1107 while ( my $data = $sth->fetchrow_hashref ) {
1108 my $biblio = GetBiblioFromItemNumber($data->{itemnumber}) if $data->{itemnumber};
1109 $data->{biblionumber} = $biblio->{biblionumber};
1110 $data->{title} = $biblio->{title};
1111 $acctlines[$numlines] = $data;
1113 $total += int(1000 * $data->{'amountoutstanding'}); # convert float to integer to avoid round-off errors
1116 return ( $total, \@acctlines,$numlines);
1119 =head2 GetBorNotifyAcctRecord
1121 ($count, $acctlines, $total) = &GetBorNotifyAcctRecord($params,$notifyid);
1123 Looks up accounting data for the patron with the given borrowernumber per file number.
1125 (FIXME - I'm not at all sure what this is about.)
1127 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1128 reference-to-array, where each element is a reference-to-hash; the
1129 keys are the fields of the C<accountlines> table in the Koha database.
1130 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1131 total amount outstanding for all of the account lines.
1135 sub GetBorNotifyAcctRecord {
1136 my ( $borrowernumber, $notifyid ) = @_;
1137 my $dbh = C4::Context->dbh;
1140 my $sth = $dbh->prepare(
1143 WHERE borrowernumber=?
1145 AND amountoutstanding != '0'
1146 ORDER BY notify_id,accounttype
1148 # 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')
1150 $sth->execute( $borrowernumber, $notifyid );
1152 while ( my $data = $sth->fetchrow_hashref ) {
1153 $acctlines[$numlines] = $data;
1155 $total += int(100 * $data->{'amountoutstanding'});
1158 return ( $total, \@acctlines, $numlines );
1161 =head2 checkuniquemember (OUEST-PROVENCE)
1163 ($result,$categorycode) = &checkuniquemember($collectivity,$surname,$firstname,$dateofbirth);
1165 Checks that a member exists or not in the database.
1167 C<&result> is nonzero (=exist) or 0 (=does not exist)
1168 C<&categorycode> is from categorycode table
1169 C<&collectivity> is 1 (= we add a collectivity) or 0 (= we add a physical member)
1170 C<&surname> is the surname
1171 C<&firstname> is the firstname (only if collectivity=0)
1172 C<&dateofbirth> is the date of birth in ISO format (only if collectivity=0)
1176 # FIXME: This function is not legitimate. Multiple patrons might have the same first/last name and birthdate.
1177 # This is especially true since first name is not even a required field.
1179 sub checkuniquemember {
1180 my ( $collectivity, $surname, $firstname, $dateofbirth ) = @_;
1181 my $dbh = C4::Context->dbh;
1182 my $request = ($collectivity) ?
1183 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? " :
1185 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=? and dateofbirth=?" :
1186 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?";
1187 my $sth = $dbh->prepare($request);
1188 if ($collectivity) {
1189 $sth->execute( uc($surname) );
1190 } elsif($dateofbirth){
1191 $sth->execute( uc($surname), ucfirst($firstname), $dateofbirth );
1193 $sth->execute( uc($surname), ucfirst($firstname));
1195 my @data = $sth->fetchrow;
1196 ( $data[0] ) and return $data[0], $data[1];
1200 sub checkcardnumber {
1201 my ($cardnumber,$borrowernumber) = @_;
1202 my $dbh = C4::Context->dbh;
1203 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1204 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1205 my $sth = $dbh->prepare($query);
1206 if ($borrowernumber) {
1207 $sth->execute($cardnumber,$borrowernumber);
1209 $sth->execute($cardnumber);
1211 if (my $data= $sth->fetchrow_hashref()){
1220 =head2 getzipnamecity (OUEST-PROVENCE)
1222 take all info from table city for the fields city and zip
1223 check for the name and the zip code of the city selected
1227 sub getzipnamecity {
1229 my $dbh = C4::Context->dbh;
1232 "select city_name,city_zipcode from cities where cityid=? ");
1233 $sth->execute($cityid);
1234 my @data = $sth->fetchrow;
1235 return $data[0], $data[1];
1239 =head2 getdcity (OUEST-PROVENCE)
1241 recover cityid with city_name condition
1246 my ($city_name) = @_;
1247 my $dbh = C4::Context->dbh;
1248 my $sth = $dbh->prepare("select cityid from cities where city_name=? ");
1249 $sth->execute($city_name);
1250 my $data = $sth->fetchrow;
1255 =head2 GetExpiryDate
1257 $expirydate = GetExpiryDate($categorycode, $dateenrolled);
1259 Calculate expiry date given a categorycode and starting date. Date argument must be in ISO format.
1260 Return date is also in ISO format.
1265 my ( $categorycode, $dateenrolled ) = @_;
1267 if ($categorycode) {
1268 my $dbh = C4::Context->dbh;
1269 my $sth = $dbh->prepare("SELECT enrolmentperiod,enrolmentperioddate FROM categories WHERE categorycode=?");
1270 $sth->execute($categorycode);
1271 $enrolments = $sth->fetchrow_hashref;
1273 # die "GetExpiryDate: for enrollmentperiod $enrolmentperiod (category '$categorycode') starting $dateenrolled.\n";
1274 my @date = split (/-/,$dateenrolled);
1275 if($enrolments->{enrolmentperiod}){
1276 return sprintf("%04d-%02d-%02d", Add_Delta_YM(@date,0,$enrolments->{enrolmentperiod}));
1278 return $enrolments->{enrolmentperioddate};
1282 =head2 checkuserpassword (OUEST-PROVENCE)
1284 check for the password and login are not used
1285 return the number of record
1286 0=> NOT USED 1=> USED
1290 sub checkuserpassword {
1291 my ( $borrowernumber, $userid, $password ) = @_;
1292 $password = md5_base64($password);
1293 my $dbh = C4::Context->dbh;
1296 "Select count(*) from borrowers where borrowernumber !=? and userid =? and password=? "
1298 $sth->execute( $borrowernumber, $userid, $password );
1299 my $number_rows = $sth->fetchrow;
1300 return $number_rows;
1304 =head2 GetborCatFromCatType
1306 ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
1308 Looks up the different types of borrowers in the database. Returns two
1309 elements: a reference-to-array, which lists the borrower category
1310 codes, and a reference-to-hash, which maps the borrower category codes
1311 to category descriptions.
1316 sub GetborCatFromCatType {
1317 my ( $category_type, $action ) = @_;
1318 # FIXME - This API seems both limited and dangerous.
1319 my $dbh = C4::Context->dbh;
1320 my $request = qq| SELECT categorycode,description
1323 ORDER BY categorycode|;
1324 my $sth = $dbh->prepare($request);
1326 $sth->execute($category_type);
1335 while ( my $data = $sth->fetchrow_hashref ) {
1336 push @codes, $data->{'categorycode'};
1337 $labels{ $data->{'categorycode'} } = $data->{'description'};
1339 return ( \@codes, \%labels );
1342 =head2 GetBorrowercategory
1344 $hashref = &GetBorrowercategory($categorycode);
1346 Given the borrower's category code, the function returns the corresponding
1347 data hashref for a comprehensive information display.
1349 $arrayref_hashref = &GetBorrowercategory;
1350 If no category code provided, the function returns all the categories.
1354 sub GetBorrowercategory {
1356 my $dbh = C4::Context->dbh;
1360 "SELECT description,dateofbirthrequired,upperagelimit,category_type
1362 WHERE categorycode = ?"
1364 $sth->execute($catcode);
1366 $sth->fetchrow_hashref;
1370 } # sub getborrowercategory
1372 =head2 GetBorrowercategoryList
1374 $arrayref_hashref = &GetBorrowercategoryList;
1375 If no category code provided, the function returns all the categories.
1379 sub GetBorrowercategoryList {
1380 my $dbh = C4::Context->dbh;
1385 ORDER BY description"
1389 $sth->fetchall_arrayref({});
1391 } # sub getborrowercategory
1393 =head2 ethnicitycategories
1395 ($codes_arrayref, $labels_hashref) = ðnicitycategories();
1397 Looks up the different ethnic types in the database. Returns two
1398 elements: a reference-to-array, which lists the ethnicity codes, and a
1399 reference-to-hash, which maps the ethnicity codes to ethnicity
1406 sub ethnicitycategories {
1407 my $dbh = C4::Context->dbh;
1408 my $sth = $dbh->prepare("Select code,name from ethnicity order by name");
1412 while ( my $data = $sth->fetchrow_hashref ) {
1413 push @codes, $data->{'code'};
1414 $labels{ $data->{'code'} } = $data->{'name'};
1416 return ( \@codes, \%labels );
1421 $ethn_name = &fixEthnicity($ethn_code);
1423 Takes an ethnicity code (e.g., "european" or "pi") and returns the
1424 corresponding descriptive name from the C<ethnicity> table in the
1425 Koha database ("European" or "Pacific Islander").
1432 my $ethnicity = shift;
1433 return unless $ethnicity;
1434 my $dbh = C4::Context->dbh;
1435 my $sth = $dbh->prepare("Select name from ethnicity where code = ?");
1436 $sth->execute($ethnicity);
1437 my $data = $sth->fetchrow_hashref;
1438 return $data->{'name'};
1439 } # sub fixEthnicity
1443 $dateofbirth,$date = &GetAge($date);
1445 this function return the borrowers age with the value of dateofbirth
1451 my ( $date, $date_ref ) = @_;
1453 if ( not defined $date_ref ) {
1454 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1457 my ( $year1, $month1, $day1 ) = split /-/, $date;
1458 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1460 my $age = $year2 - $year1;
1461 if ( $month1 . $day1 > $month2 . $day2 ) {
1468 =head2 get_institutions
1469 $insitutions = get_institutions();
1471 Just returns a list of all the borrowers of type I, borrownumber and name
1476 sub get_institutions {
1477 my $dbh = C4::Context->dbh();
1480 "SELECT borrowernumber,surname FROM borrowers WHERE categorycode=? ORDER BY surname"
1484 while ( my $data = $sth->fetchrow_hashref() ) {
1485 $orgs{ $data->{'borrowernumber'} } = $data;
1489 } # sub get_institutions
1491 =head2 add_member_orgs
1493 add_member_orgs($borrowernumber,$borrowernumbers);
1495 Takes a borrowernumber and a list of other borrowernumbers and inserts them into the borrowers_to_borrowers table
1500 sub add_member_orgs {
1501 my ( $borrowernumber, $otherborrowers ) = @_;
1502 my $dbh = C4::Context->dbh();
1504 "INSERT INTO borrowers_to_borrowers (borrower1,borrower2) VALUES (?,?)";
1505 my $sth = $dbh->prepare($query);
1506 foreach my $otherborrowernumber (@$otherborrowers) {
1507 $sth->execute( $borrowernumber, $otherborrowernumber );
1510 } # sub add_member_orgs
1512 =head2 GetCities (OUEST-PROVENCE)
1514 ($id_cityarrayref, $city_hashref) = &GetCities();
1516 Looks up the different city and zip in the database. Returns two
1517 elements: a reference-to-array, which lists the zip city
1518 codes, and a reference-to-hash, which maps the name of the city.
1519 WHERE =>OUEST PROVENCE OR EXTERIEUR
1525 #my ($type_city) = @_;
1526 my $dbh = C4::Context->dbh;
1527 my $query = qq|SELECT cityid,city_zipcode,city_name
1529 ORDER BY city_name|;
1530 my $sth = $dbh->prepare($query);
1532 #$sth->execute($type_city);
1536 # insert empty value to create a empty choice in cgi popup
1539 while ( my $data = $sth->fetchrow_hashref ) {
1540 push @id, $data->{'city_zipcode'}."|".$data->{'city_name'};
1541 $city{ $data->{'city_zipcode'}."|".$data->{'city_name'} } = $data->{'city_name'};
1544 #test to know if the table contain some records if no the function return nothing
1547 # all we have is the one blank row
1552 return ( \@id, \%city );
1556 =head2 GetSortDetails (OUEST-PROVENCE)
1558 ($lib) = &GetSortDetails($category,$sortvalue);
1560 Returns the authorized value details
1561 C<&$lib>return value of authorized value details
1562 C<&$sortvalue>this is the value of authorized value
1563 C<&$category>this is the value of authorized value category
1567 sub GetSortDetails {
1568 my ( $category, $sortvalue ) = @_;
1569 my $dbh = C4::Context->dbh;
1570 my $query = qq|SELECT lib
1571 FROM authorised_values
1573 AND authorised_value=? |;
1574 my $sth = $dbh->prepare($query);
1575 $sth->execute( $category, $sortvalue );
1576 my $lib = $sth->fetchrow;
1577 return ($lib) if ($lib);
1578 return ($sortvalue) unless ($lib);
1581 =head2 MoveMemberToDeleted
1583 $result = &MoveMemberToDeleted($borrowernumber);
1585 Copy the record from borrowers to deletedborrowers table.
1589 # FIXME: should do it in one SQL statement w/ subquery
1590 # Otherwise, we should return the @data on success
1592 sub MoveMemberToDeleted {
1593 my ($member) = shift or return;
1594 my $dbh = C4::Context->dbh;
1595 my $query = qq|SELECT *
1597 WHERE borrowernumber=?|;
1598 my $sth = $dbh->prepare($query);
1599 $sth->execute($member);
1600 my @data = $sth->fetchrow_array;
1601 (@data) or return; # if we got a bad borrowernumber, there's nothing to insert
1603 $dbh->prepare( "INSERT INTO deletedborrowers VALUES ("
1604 . ( "?," x ( scalar(@data) - 1 ) )
1606 $sth->execute(@data);
1611 DelMember($borrowernumber);
1613 This function remove directly a borrower whitout writing it on deleteborrower.
1614 + Deletes reserves for the borrower
1619 my $dbh = C4::Context->dbh;
1620 my $borrowernumber = shift;
1621 #warn "in delmember with $borrowernumber";
1622 return unless $borrowernumber; # borrowernumber is mandatory.
1624 my $query = qq|DELETE
1626 WHERE borrowernumber=?|;
1627 my $sth = $dbh->prepare($query);
1628 $sth->execute($borrowernumber);
1632 WHERE borrowernumber = ?
1634 $sth = $dbh->prepare($query);
1635 $sth->execute($borrowernumber);
1636 logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
1640 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1642 $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1644 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1649 sub ExtendMemberSubscriptionTo {
1650 my ( $borrowerid,$date) = @_;
1651 my $dbh = C4::Context->dbh;
1652 my $borrower = GetMember('borrowernumber'=>$borrowerid);
1654 $date=POSIX::strftime("%Y-%m-%d",localtime());
1655 $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
1657 my $sth = $dbh->do(<<EOF);
1659 SET dateexpiry='$date'
1660 WHERE borrowernumber='$borrowerid'
1662 # add enrolmentfee if needed
1663 $sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
1664 $sth->execute($borrower->{'categorycode'});
1665 my ($enrolmentfee) = $sth->fetchrow;
1666 if ($enrolmentfee && $enrolmentfee > 0) {
1667 # insert fee in patron debts
1668 manualinvoice($borrower->{'borrowernumber'}, '', '', 'A', $enrolmentfee);
1670 return $date if ($sth);
1674 =head2 GetRoadTypes (OUEST-PROVENCE)
1676 ($idroadtypearrayref, $roadttype_hashref) = &GetRoadTypes();
1678 Looks up the different road type . Returns two
1679 elements: a reference-to-array, which lists the id_roadtype
1680 codes, and a reference-to-hash, which maps the road type of the road .
1685 my $dbh = C4::Context->dbh;
1687 SELECT roadtypeid,road_type
1689 ORDER BY road_type|;
1690 my $sth = $dbh->prepare($query);
1695 # insert empty value to create a empty choice in cgi popup
1697 while ( my $data = $sth->fetchrow_hashref ) {
1699 push @id, $data->{'roadtypeid'};
1700 $roadtype{ $data->{'roadtypeid'} } = $data->{'road_type'};
1703 #test to know if the table contain some records if no the function return nothing
1710 return ( \@id, \%roadtype );
1716 =head2 GetTitles (OUEST-PROVENCE)
1718 ($borrowertitle)= &GetTitles();
1720 Looks up the different title . Returns array with all borrowers title
1725 my @borrowerTitle = split (/,|\|/,C4::Context->preference('BorrowersTitles'));
1726 unshift( @borrowerTitle, "" );
1727 my $count=@borrowerTitle;
1732 return ( \@borrowerTitle);
1736 =head2 GetPatronImage
1738 my ($imagedata, $dberror) = GetPatronImage($cardnumber);
1740 Returns the mimetype and binary image data of the image for the patron with the supplied cardnumber.
1744 sub GetPatronImage {
1745 my ($cardnumber) = @_;
1746 warn "Cardnumber passed to GetPatronImage is $cardnumber" if $debug;
1747 my $dbh = C4::Context->dbh;
1748 my $query = 'SELECT mimetype, imagefile FROM patronimage WHERE cardnumber = ?';
1749 my $sth = $dbh->prepare($query);
1750 $sth->execute($cardnumber);
1751 my $imagedata = $sth->fetchrow_hashref;
1752 warn "Database error!" if $sth->errstr;
1753 return $imagedata, $sth->errstr;
1756 =head2 PutPatronImage
1758 PutPatronImage($cardnumber, $mimetype, $imgfile);
1760 Stores patron binary image data and mimetype in database.
1761 NOTE: This function is good for updating images as well as inserting new images in the database.
1765 sub PutPatronImage {
1766 my ($cardnumber, $mimetype, $imgfile) = @_;
1767 warn "Parameters passed in: Cardnumber=$cardnumber, Mimetype=$mimetype, " . ($imgfile ? "Imagefile" : "No Imagefile") if $debug;
1768 my $dbh = C4::Context->dbh;
1769 my $query = "INSERT INTO patronimage (cardnumber, mimetype, imagefile) VALUES (?,?,?) ON DUPLICATE KEY UPDATE imagefile = ?;";
1770 my $sth = $dbh->prepare($query);
1771 $sth->execute($cardnumber,$mimetype,$imgfile,$imgfile);
1772 warn "Error returned inserting $cardnumber.$mimetype." if $sth->errstr;
1773 return $sth->errstr;
1776 =head2 RmPatronImage
1778 my ($dberror) = RmPatronImage($cardnumber);
1780 Removes the image for the patron with the supplied cardnumber.
1785 my ($cardnumber) = @_;
1786 warn "Cardnumber passed to GetPatronImage is $cardnumber" if $debug;
1787 my $dbh = C4::Context->dbh;
1788 my $query = "DELETE FROM patronimage WHERE cardnumber = ?;";
1789 my $sth = $dbh->prepare($query);
1790 $sth->execute($cardnumber);
1791 my $dberror = $sth->errstr;
1792 warn "Database error!" if $sth->errstr;
1796 =head2 GetRoadTypeDetails (OUEST-PROVENCE)
1798 ($roadtype) = &GetRoadTypeDetails($roadtypeid);
1800 Returns the description of roadtype
1801 C<&$roadtype>return description of road type
1802 C<&$roadtypeid>this is the value of roadtype s
1806 sub GetRoadTypeDetails {
1807 my ($roadtypeid) = @_;
1808 my $dbh = C4::Context->dbh;
1812 WHERE roadtypeid=?|;
1813 my $sth = $dbh->prepare($query);
1814 $sth->execute($roadtypeid);
1815 my $roadtype = $sth->fetchrow;
1819 =head2 GetBorrowersWhoHaveNotBorrowedSince
1821 &GetBorrowersWhoHaveNotBorrowedSince($date)
1823 this function get all borrowers who haven't borrowed since the date given on input arg.
1827 sub GetBorrowersWhoHaveNotBorrowedSince {
1828 my $filterdate = shift||POSIX::strftime("%Y-%m-%d",localtime());
1829 my $filterexpiry = shift;
1830 my $filterbranch = shift ||
1831 ((C4::Context->preference('IndependantBranches')
1832 && C4::Context->userenv
1833 && C4::Context->userenv->{flags} % 2 !=1
1834 && C4::Context->userenv->{branch})
1835 ? C4::Context->userenv->{branch}
1837 my $dbh = C4::Context->dbh;
1839 SELECT borrowers.borrowernumber,
1840 max(old_issues.timestamp) as latestissue,
1841 max(issues.timestamp) as currentissue
1843 JOIN categories USING (categorycode)
1844 LEFT JOIN old_issues USING (borrowernumber)
1845 LEFT JOIN issues USING (borrowernumber)
1846 WHERE category_type <> 'S'
1847 AND borrowernumber NOT IN (SELECT guarantorid FROM borrowers WHERE guarantorid IS NOT NULL AND guarantorid <> 0)
1850 if ($filterbranch && $filterbranch ne ""){
1851 $query.=" AND borrowers.branchcode= ?";
1852 push @query_params,$filterbranch;
1855 $query .= " AND dateexpiry < ? ";
1856 push @query_params,$filterdate;
1858 $query.=" GROUP BY borrowers.borrowernumber";
1860 $query.=" HAVING (latestissue < ? OR latestissue IS NULL)
1861 AND currentissue IS NULL";
1862 push @query_params,$filterdate;
1864 warn $query if $debug;
1865 my $sth = $dbh->prepare($query);
1866 if (scalar(@query_params)>0){
1867 $sth->execute(@query_params);
1874 while ( my $data = $sth->fetchrow_hashref ) {
1875 push @results, $data;
1880 =head2 GetBorrowersWhoHaveNeverBorrowed
1882 $results = &GetBorrowersWhoHaveNeverBorrowed
1884 this function get all borrowers who have never borrowed.
1886 I<$result> is a ref to an array which all elements are a hasref.
1890 sub GetBorrowersWhoHaveNeverBorrowed {
1891 my $filterbranch = shift ||
1892 ((C4::Context->preference('IndependantBranches')
1893 && C4::Context->userenv
1894 && C4::Context->userenv->{flags} % 2 !=1
1895 && C4::Context->userenv->{branch})
1896 ? C4::Context->userenv->{branch}
1898 my $dbh = C4::Context->dbh;
1900 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
1902 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
1903 WHERE issues.borrowernumber IS NULL
1906 if ($filterbranch && $filterbranch ne ""){
1907 $query.=" AND borrowers.branchcode= ?";
1908 push @query_params,$filterbranch;
1910 warn $query if $debug;
1912 my $sth = $dbh->prepare($query);
1913 if (scalar(@query_params)>0){
1914 $sth->execute(@query_params);
1921 while ( my $data = $sth->fetchrow_hashref ) {
1922 push @results, $data;
1927 =head2 GetBorrowersWithIssuesHistoryOlderThan
1929 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
1931 this function get all borrowers who has an issue history older than I<$date> given on input arg.
1933 I<$result> is a ref to an array which all elements are a hashref.
1934 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1938 sub GetBorrowersWithIssuesHistoryOlderThan {
1939 my $dbh = C4::Context->dbh;
1940 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
1941 my $filterbranch = shift ||
1942 ((C4::Context->preference('IndependantBranches')
1943 && C4::Context->userenv
1944 && C4::Context->userenv->{flags} % 2 !=1
1945 && C4::Context->userenv->{branch})
1946 ? C4::Context->userenv->{branch}
1949 SELECT count(borrowernumber) as n,borrowernumber
1951 WHERE returndate < ?
1952 AND borrowernumber IS NOT NULL
1955 push @query_params, $date;
1957 $query.=" AND branchcode = ?";
1958 push @query_params, $filterbranch;
1960 $query.=" GROUP BY borrowernumber ";
1961 warn $query if $debug;
1962 my $sth = $dbh->prepare($query);
1963 $sth->execute(@query_params);
1966 while ( my $data = $sth->fetchrow_hashref ) {
1967 push @results, $data;
1972 =head2 GetBorrowersNamesAndLatestIssue
1974 $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
1976 this function get borrowers Names and surnames and Issue information.
1978 I<@borrowernumbers> is an array which all elements are borrowernumbers.
1979 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1983 sub GetBorrowersNamesAndLatestIssue {
1984 my $dbh = C4::Context->dbh;
1985 my @borrowernumbers=@_;
1987 SELECT surname,lastname, phone, email,max(timestamp)
1989 LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
1990 GROUP BY borrowernumber
1992 my $sth = $dbh->prepare($query);
1994 my $results = $sth->fetchall_arrayref({});
2002 my $success = DebarMember( $borrowernumber );
2004 marks a Member as debarred, and therefore unable to checkout any more
2008 true on success, false on failure
2015 my $borrowernumber = shift;
2017 return unless defined $borrowernumber;
2018 return unless $borrowernumber =~ /^\d+$/;
2020 return ModMember( borrowernumber => $borrowernumber,
2029 AddMessage( $borrowernumber, $message_type, $message, $branchcode );
2031 Adds a message to the messages table for the given borrower.
2042 my ( $borrowernumber, $message_type, $message, $branchcode ) = @_;
2044 my $dbh = C4::Context->dbh;
2046 if ( ! ( $borrowernumber && $message_type && $message && $branchcode ) ) {
2050 my $query = "INSERT INTO messages ( borrowernumber, branchcode, message_type, message ) VALUES ( ?, ?, ?, ? )";
2051 my $sth = $dbh->prepare($query);
2052 $sth->execute( $borrowernumber, $branchcode, $message_type, $message );
2061 GetMessages( $borrowernumber, $type );
2063 $type is message type, B for borrower, or L for Librarian.
2064 Empty type returns all messages of any type.
2066 Returns all messages for the given borrowernumber
2073 my ( $borrowernumber, $type, $branchcode ) = @_;
2079 my $dbh = C4::Context->dbh;
2082 branches.branchname,
2084 DATE_FORMAT( message_date, '%m/%d/%Y' ) AS message_date_formatted,
2085 messages.branchcode LIKE '$branchcode' AS can_delete
2086 FROM messages, branches
2087 WHERE borrowernumber = ?
2088 AND message_type LIKE ?
2089 AND messages.branchcode = branches.branchcode
2090 ORDER BY message_date DESC";
2091 my $sth = $dbh->prepare($query);
2092 $sth->execute( $borrowernumber, $type ) ;
2095 while ( my $data = $sth->fetchrow_hashref ) {
2096 push @results, $data;
2106 GetMessagesCount( $borrowernumber, $type );
2108 $type is message type, B for borrower, or L for Librarian.
2109 Empty type returns all messages of any type.
2111 Returns the number of messages for the given borrowernumber
2117 sub GetMessagesCount {
2118 my ( $borrowernumber, $type, $branchcode ) = @_;
2124 my $dbh = C4::Context->dbh;
2126 my $query = "SELECT COUNT(*) as MsgCount FROM messages WHERE borrowernumber = ? AND message_type LIKE ?";
2127 my $sth = $dbh->prepare($query);
2128 $sth->execute( $borrowernumber, $type ) ;
2131 my $data = $sth->fetchrow_hashref;
2132 my $count = $data->{'MsgCount'};
2139 =head2 DeleteMessage
2143 DeleteMessage( $message_id );
2150 my ( $message_id ) = @_;
2152 my $dbh = C4::Context->dbh;
2154 my $query = "DELETE FROM messages WHERE message_id = ?";
2155 my $sth = $dbh->prepare($query);
2156 $sth->execute( $message_id );
2160 END { } # module clean-up code here (global destructor)