3 # Copyright 2000-2003 Katipo Communications
4 # Copyright 2010 BibLibre
5 # Parts Copyright 2010 Catalyst IT
7 # This file is part of Koha.
9 # Koha is free software; you can redistribute it and/or modify it
10 # under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
14 # Koha is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
24 #use warnings; FIXME - Bug 2505
26 use String::Random qw( random_string );
27 use Scalar::Util qw( looks_like_number );
28 use Date::Calc qw/Today check_date Date_to_Days/;
29 use C4::Log; # logaction
35 use C4::Members::Attributes qw(SearchIdMatchingAttribute UpdateBorrowerAttribute);
36 use C4::NewsChannels; #get slip news
40 use Text::Unaccent qw( unac_string );
41 use Koha::AuthUtils qw(hash_password);
44 use Koha::List::Patron;
46 use Koha::Patron::Categories;
49 our (@ISA,@EXPORT,@EXPORT_OK,$debug);
51 use Module::Load::Conditional qw( can_load );
52 if ( ! can_load( modules => { 'Koha::NorwegianPatronDB' => undef } ) ) {
53 $debug && warn "Unable to load Koha::NorwegianPatronDB";
58 $debug = $ENV{DEBUG} || 0;
66 &GetMemberIssuesAndFines
70 &GetFirstValidEmailAddress
71 &GetNoticeEmailAddress
75 &GetHideLostItemsPreference
77 &GetMemberAccountRecords
78 &GetBorNotifyAcctRecord
80 &GetBorrowersToExpunge
81 &GetBorrowersWhoHaveNeverBorrowed
82 &GetBorrowersWithIssuesHistoryOlderThan
84 &GetUpcomingMembershipExpires
117 C4::Members - Perl Module containing convenience functions for member handling
125 This module contains routines for adding, modifying and deleting members/patrons/borrowers
129 =head2 GetMemberDetails
131 ($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
133 Looks up a patron and returns information about him or her. If
134 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
135 up the borrower by number; otherwise, it looks up the borrower by card
138 C<$borrower> is a reference-to-hash whose keys are the fields of the
139 borrowers table in the Koha database. In addition,
140 C<$borrower-E<gt>{flags}> is a hash giving more detailed information
141 about the patron. Its keys act as flags :
143 if $borrower->{flags}->{LOST} {
144 # Patron's card was reported lost
147 If the state of a flag means that the patron should not be
148 allowed to borrow any more books, then it will have a C<noissues> key
151 See patronflags for more details.
153 C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
154 about the top-level permissions flags set for the borrower. For example,
155 if a user has the "editcatalogue" permission,
156 C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
161 sub GetMemberDetails {
162 my ( $borrowernumber, $cardnumber ) = @_;
163 my $dbh = C4::Context->dbh;
166 if ($borrowernumber) {
167 $sth = $dbh->prepare("
170 categories.description,
171 categories.BlockExpiredPatronOpacActions,
175 LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
176 WHERE borrowernumber = ?
178 $sth->execute($borrowernumber);
180 elsif ($cardnumber) {
181 $sth = $dbh->prepare("
184 categories.description,
185 categories.BlockExpiredPatronOpacActions,
189 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
192 $sth->execute($cardnumber);
197 my $borrower = $sth->fetchrow_hashref;
198 return unless $borrower;
199 my ($amount) = GetMemberAccountRecords($borrower->{borrowernumber});
200 $borrower->{'amountoutstanding'} = $amount;
201 # FIXME - patronflags calls GetMemberAccountRecords... just have patronflags return $amount
202 my $flags = patronflags( $borrower);
205 $sth = $dbh->prepare("select bit,flag from userflags");
207 while ( my ( $bit, $flag ) = $sth->fetchrow ) {
208 if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
209 $accessflagshash->{$flag} = 1;
212 $borrower->{'flags'} = $flags;
213 $borrower->{'authflags'} = $accessflagshash;
215 # Handle setting the true behavior for BlockExpiredPatronOpacActions
216 $borrower->{'BlockExpiredPatronOpacActions'} =
217 C4::Context->preference('BlockExpiredPatronOpacActions')
218 if ( $borrower->{'BlockExpiredPatronOpacActions'} == -1 );
220 $borrower->{'is_expired'} = 0;
221 $borrower->{'is_expired'} = 1 if
222 defined($borrower->{dateexpiry}) &&
223 $borrower->{'dateexpiry'} ne '0000-00-00' &&
224 Date_to_Days( Today() ) >
225 Date_to_Days( split /-/, $borrower->{'dateexpiry'} );
227 return ($borrower); #, $flags, $accessflagshash);
232 $flags = &patronflags($patron);
234 This function is not exported.
236 The following will be set where applicable:
237 $flags->{CHARGES}->{amount} Amount of debt
238 $flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge)
239 $flags->{CHARGES}->{message} Message -- deprecated
241 $flags->{CREDITS}->{amount} Amount of credit
242 $flags->{CREDITS}->{message} Message -- deprecated
244 $flags->{ GNA } Patron has no valid address
245 $flags->{ GNA }->{noissues} Set for each GNA
246 $flags->{ GNA }->{message} "Borrower has no valid address" -- deprecated
248 $flags->{ LOST } Patron's card reported lost
249 $flags->{ LOST }->{noissues} Set for each LOST
250 $flags->{ LOST }->{message} Message -- deprecated
252 $flags->{DBARRED} Set if patron debarred, no access
253 $flags->{DBARRED}->{noissues} Set for each DBARRED
254 $flags->{DBARRED}->{message} Message -- deprecated
257 $flags->{ NOTES }->{message} The note itself. NOT deprecated
259 $flags->{ ODUES } Set if patron has overdue books.
260 $flags->{ ODUES }->{message} "Yes" -- deprecated
261 $flags->{ ODUES }->{itemlist} ref-to-array: list of overdue books
262 $flags->{ ODUES }->{itemlisttext} Text list of overdue items -- deprecated
264 $flags->{WAITING} Set if any of patron's reserves are available
265 $flags->{WAITING}->{message} Message -- deprecated
266 $flags->{WAITING}->{itemlist} ref-to-array: list of available items
270 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
271 overdue items. Its elements are references-to-hash, each describing an
272 overdue item. The keys are selected fields from the issues, biblio,
273 biblioitems, and items tables of the Koha database.
275 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
276 the overdue items, one per line. Deprecated.
278 =item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
279 available items. Each element is a reference-to-hash whose keys are
280 fields from the reserves table of the Koha database.
284 All the "message" fields that include language generated in this function are deprecated,
285 because such strings belong properly in the display layer.
287 The "message" field that comes from the DB is OK.
291 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
292 # FIXME rename this function.
295 my ( $patroninformation) = @_;
296 my $dbh=C4::Context->dbh;
297 my ($balance, $owing) = GetMemberAccountBalance( $patroninformation->{'borrowernumber'});
300 my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
301 $flaginfo{'message'} = sprintf 'Patron owes %.02f', $owing;
302 $flaginfo{'amount'} = sprintf "%.02f", $owing;
303 if ( $owing > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
304 $flaginfo{'noissues'} = 1;
306 $flags{'CHARGES'} = \%flaginfo;
308 elsif ( $balance < 0 ) {
310 $flaginfo{'message'} = sprintf 'Patron has credit of %.02f', -$balance;
311 $flaginfo{'amount'} = sprintf "%.02f", $balance;
312 $flags{'CREDITS'} = \%flaginfo;
315 # Check the debt of the guarntees of this patron
316 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
317 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
318 if ( defined $no_issues_charge_guarantees ) {
319 my $p = Koha::Patrons->find( $patroninformation->{borrowernumber} );
320 my @guarantees = $p->guarantees();
321 my $guarantees_non_issues_charges;
322 foreach my $g ( @guarantees ) {
323 my ( $b, $n, $o ) = C4::Members::GetMemberAccountBalance( $g->id );
324 $guarantees_non_issues_charges += $n;
327 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
329 $flaginfo{'message'} = sprintf 'patron guarantees owe %.02f', $guarantees_non_issues_charges;
330 $flaginfo{'amount'} = $guarantees_non_issues_charges;
331 $flaginfo{'noissues'} = 1 unless C4::Context->preference("allowfineoverride");
332 $flags{'CHARGES_GUARANTEES'} = \%flaginfo;
336 if ( $patroninformation->{'gonenoaddress'}
337 && $patroninformation->{'gonenoaddress'} == 1 )
340 $flaginfo{'message'} = 'Borrower has no valid address.';
341 $flaginfo{'noissues'} = 1;
342 $flags{'GNA'} = \%flaginfo;
344 if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
346 $flaginfo{'message'} = 'Borrower\'s card reported lost.';
347 $flaginfo{'noissues'} = 1;
348 $flags{'LOST'} = \%flaginfo;
350 if ( $patroninformation->{'debarred'} && check_date( split( /-/, $patroninformation->{'debarred'} ) ) ) {
351 if ( Date_to_Days(Date::Calc::Today) < Date_to_Days( split( /-/, $patroninformation->{'debarred'} ) ) ) {
353 $flaginfo{'debarredcomment'} = $patroninformation->{'debarredcomment'};
354 $flaginfo{'message'} = $patroninformation->{'debarredcomment'};
355 $flaginfo{'noissues'} = 1;
356 $flaginfo{'dateend'} = $patroninformation->{'debarred'};
357 $flags{'DBARRED'} = \%flaginfo;
360 if ( $patroninformation->{'borrowernotes'}
361 && $patroninformation->{'borrowernotes'} )
364 $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
365 $flags{'NOTES'} = \%flaginfo;
367 my ( $odues, $itemsoverdue ) = C4::Overdues::checkoverdues($patroninformation->{'borrowernumber'});
368 if ( $odues && $odues > 0 ) {
370 $flaginfo{'message'} = "Yes";
371 $flaginfo{'itemlist'} = $itemsoverdue;
372 foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
375 $flaginfo{'itemlisttext'} .=
376 "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n"; # newline is display layer
378 $flags{'ODUES'} = \%flaginfo;
380 my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
381 my $nowaiting = scalar @itemswaiting;
382 if ( $nowaiting > 0 ) {
384 $flaginfo{'message'} = "Reserved items available";
385 $flaginfo{'itemlist'} = \@itemswaiting;
386 $flags{'WAITING'} = \%flaginfo;
394 $borrower = &GetMember(%information);
396 Retrieve the first patron record meeting on criteria listed in the
397 C<%information> hash, which should contain one or more
398 pairs of borrowers column names and values, e.g.,
400 $borrower = GetMember(borrowernumber => id);
402 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
403 the C<borrowers> table in the Koha database.
405 FIXME: GetMember() is used throughout the code as a lookup
406 on a unique key such as the borrowernumber, but this meaning is not
407 enforced in the routine itself.
413 my ( %information ) = @_;
414 if (exists $information{borrowernumber} && !defined $information{borrowernumber}) {
415 #passing mysql's kohaadmin?? Makes no sense as a query
418 my $dbh = C4::Context->dbh;
420 q{SELECT borrowers.*, categories.category_type, categories.description
422 LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
425 for (keys %information ) {
433 if (defined $information{$_}) {
435 push @values, $information{$_};
438 $select .= "$_ IS NULL";
441 $debug && warn $select, " ",values %information;
442 my $sth = $dbh->prepare("$select");
443 $sth->execute(@values);
444 my $data = $sth->fetchall_arrayref({});
445 #FIXME interface to this routine now allows generation of a result set
446 #so whole array should be returned but bowhere in the current code expects this
454 =head2 GetMemberIssuesAndFines
456 ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
458 Returns aggregate data about items borrowed by the patron with the
459 given borrowernumber.
461 C<&GetMemberIssuesAndFines> returns a three-element array. C<$overdue_count> is the
462 number of overdue items the patron currently has borrowed. C<$issue_count> is the
463 number of books the patron currently has borrowed. C<$total_fines> is
464 the total fine currently due by the borrower.
469 sub GetMemberIssuesAndFines {
470 my ( $borrowernumber ) = @_;
471 my $dbh = C4::Context->dbh;
472 my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
474 $debug and warn $query."\n";
475 my $sth = $dbh->prepare($query);
476 $sth->execute($borrowernumber);
477 my $issue_count = $sth->fetchrow_arrayref->[0];
479 $sth = $dbh->prepare(
480 "SELECT COUNT(*) FROM issues
481 WHERE borrowernumber = ?
482 AND date_due < now()"
484 $sth->execute($borrowernumber);
485 my $overdue_count = $sth->fetchrow_arrayref->[0];
487 $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
488 $sth->execute($borrowernumber);
489 my $total_fines = $sth->fetchrow_arrayref->[0];
491 return ($overdue_count, $issue_count, $total_fines);
497 my $success = ModMember(borrowernumber => $borrowernumber,
498 [ field => value ]... );
500 Modify borrower's data. All date fields should ALREADY be in ISO format.
503 true on success, or false on failure
510 # trim whitespace from data which has some non-whitespace in it.
511 foreach my $field_name (keys(%data)) {
512 if ( defined $data{$field_name} && $data{$field_name} =~ /\S/ ) {
513 $data{$field_name} =~ s/^\s*|\s*$//g;
517 # test to know if you must update or not the borrower password
518 if (exists $data{password}) {
519 if ($data{password} eq '****' or $data{password} eq '') {
520 delete $data{password};
522 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
523 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
524 Koha::NorwegianPatronDB::NLUpdateHashedPIN( $data{'borrowernumber'}, $data{password} );
526 $data{password} = hash_password($data{password});
530 my $old_categorycode = Koha::Patrons->find( $data{borrowernumber} )->categorycode;
532 # get only the columns of a borrower
533 my $schema = Koha::Database->new()->schema;
534 my @columns = $schema->source('Borrower')->columns;
535 my $new_borrower = { map { join(' ', @columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) };
536 delete $new_borrower->{flags};
538 $new_borrower->{dateofbirth} ||= undef if exists $new_borrower->{dateofbirth};
539 $new_borrower->{dateenrolled} ||= undef if exists $new_borrower->{dateenrolled};
540 $new_borrower->{dateexpiry} ||= undef if exists $new_borrower->{dateexpiry};
541 $new_borrower->{debarred} ||= undef if exists $new_borrower->{debarred};
542 $new_borrower->{sms_provider_id} ||= undef if exists $new_borrower->{sms_provider_id};
543 $new_borrower->{guarantorid} ||= undef if exists $new_borrower->{guarantorid};
545 my $patron = Koha::Patrons->find( $new_borrower->{borrowernumber} );
547 delete $new_borrower->{userid} if exists $new_borrower->{userid} and not $new_borrower->{userid};
549 my $execute_success = $patron->store if $patron->set($new_borrower);
551 if ($execute_success) { # only proceed if the update was a success
552 # If the patron changes to a category with enrollment fee, we add a fee
553 if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
554 if ( C4::Context->preference('FeeOnChangePatronCategory') ) {
555 $patron->add_enrolment_fee_if_needed;
559 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
560 # cronjob will use for syncing with NL
561 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
562 my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
563 'synctype' => 'norwegianpatrondb',
564 'borrowernumber' => $data{'borrowernumber'}
566 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
567 # we can sync as changed. And the "new sync" will pick up all changes since
568 # the patron was created anyway.
569 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
570 $borrowersync->update( { 'syncstatus' => 'edited' } );
572 # Set the value of 'sync'
573 $borrowersync->update( { 'sync' => $data{'sync'} } );
574 # Try to do the live sync
575 Koha::NorwegianPatronDB::NLSync({ 'borrowernumber' => $data{'borrowernumber'} });
578 logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
580 return $execute_success;
585 $borrowernumber = &AddMember(%borrower);
587 insert new borrower into table
589 (%borrower keys are database columns. Database columns could be
590 different in different versions. Please look into database for correct
593 Returns the borrowernumber upon success
595 Returns as undef upon any db error without further processing
602 my $dbh = C4::Context->dbh;
603 my $schema = Koha::Database->new()->schema;
605 # trim whitespace from data which has some non-whitespace in it.
606 foreach my $field_name (keys(%data)) {
607 if ( defined $data{$field_name} && $data{$field_name} =~ /\S/ ) {
608 $data{$field_name} =~ s/^\s*|\s*$//g;
612 # generate a proper login if none provided
613 $data{'userid'} = Generate_Userid( $data{'borrowernumber'}, $data{'firstname'}, $data{'surname'} )
614 if ( $data{'userid'} eq '' || !Check_Userid( $data{'userid'} ) );
616 # add expiration date if it isn't already there
617 $data{dateexpiry} ||= Koha::Patron::Categories->find( $data{categorycode} )->get_expiry_date;
619 # add enrollment date if it isn't already there
620 unless ( $data{'dateenrolled'} ) {
621 $data{'dateenrolled'} = output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
624 my $patron_category = $schema->resultset('Category')->find( $data{'categorycode'} );
626 $patron_category->default_privacy() eq 'default' ? 1
627 : $patron_category->default_privacy() eq 'never' ? 2
628 : $patron_category->default_privacy() eq 'forever' ? 0
631 $data{'privacy_guarantor_checkouts'} = 0 unless defined( $data{'privacy_guarantor_checkouts'} );
633 # Make a copy of the plain text password for later use
634 my $plain_text_password = $data{'password'};
636 # create a disabled account if no password provided
637 $data{'password'} = ($data{'password'})? hash_password($data{'password'}) : '!';
639 # we don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00
640 $data{'dateofbirth'} = undef if ( not $data{'dateofbirth'} );
641 $data{'debarred'} = undef if ( not $data{'debarred'} );
642 $data{'sms_provider_id'} = undef if ( not $data{'sms_provider_id'} );
643 $data{'guarantorid'} = undef if ( not $data{'guarantorid'} );
645 # get only the columns of Borrower
646 # FIXME Do we really need this check?
647 my @columns = $schema->source('Borrower')->columns;
648 my $new_member = { map { join(' ',@columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) } ;
650 delete $new_member->{borrowernumber};
652 my $patron = Koha::Patron->new( $new_member )->store;
653 $data{borrowernumber} = $patron->borrowernumber;
655 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
656 # cronjob will use for syncing with NL
657 if ( exists $data{'borrowernumber'} && C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
658 Koha::Database->new->schema->resultset('BorrowerSync')->create({
659 'borrowernumber' => $data{'borrowernumber'},
660 'synctype' => 'norwegianpatrondb',
662 'syncstatus' => 'new',
663 'hashed_pin' => Koha::NorwegianPatronDB::NLEncryptPIN( $plain_text_password ),
667 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
669 $patron->add_enrolment_fee_if_needed;
671 return $data{borrowernumber};
676 my $uniqueness = Check_Userid($userid,$borrowernumber);
678 $borrowernumber is optional (i.e. it can contain a blank value). If $userid is passed with a blank $borrowernumber variable, the database will be checked for all instances of that userid (i.e. userid=? AND borrowernumber != '').
680 If $borrowernumber is provided, the database will be checked for every instance of that userid coupled with a different borrower(number) than the one provided.
683 0 for not unique (i.e. this $userid already exists)
684 1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
689 my ( $uid, $borrowernumber ) = @_;
691 return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
693 return 0 if ( $uid eq C4::Context->config('user') );
695 my $rs = Koha::Database->new()->schema()->resultset('Borrower');
698 $params->{userid} = $uid;
699 $params->{borrowernumber} = { '!=' => $borrowernumber } if ($borrowernumber);
701 my $count = $rs->count( $params );
703 return $count ? 0 : 1;
706 =head2 Generate_Userid
708 my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
710 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
712 $borrowernumber is optional (i.e. it can contain a blank value). A value is passed when generating a new userid for an existing borrower. When a new userid is created for a new borrower, a blank value is passed to this sub.
715 new userid ($firstname.$surname if there is a $firstname, or $surname if there is no value in $firstname) plus offset (0 if the $newuid is unique, or a higher numeric value if Check_Userid finds an existing match for the $newuid in the database).
719 sub Generate_Userid {
720 my ($borrowernumber, $firstname, $surname) = @_;
723 #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
725 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
726 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
727 $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
728 $newuid = unac_string('utf-8',$newuid);
729 $newuid .= $offset unless $offset == 0;
732 } while (!Check_Userid($newuid,$borrowernumber));
737 =head2 fixup_cardnumber
739 Warning: The caller is responsible for locking the members table in write
740 mode, to avoid database corruption.
744 use vars qw( @weightings );
745 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
747 sub fixup_cardnumber {
748 my ($cardnumber) = @_;
749 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
751 # Find out whether member numbers should be generated
752 # automatically. Should be either "1" or something else.
753 # Defaults to "0", which is interpreted as "no".
755 # if ($cardnumber !~ /\S/ && $autonumber_members) {
756 ($autonumber_members) or return $cardnumber;
757 my $checkdigit = C4::Context->preference('checkdigit');
758 my $dbh = C4::Context->dbh;
759 if ( $checkdigit and $checkdigit eq 'katipo' ) {
761 # if checkdigit is selected, calculate katipo-style cardnumber.
762 # otherwise, just use the max()
763 # purpose: generate checksum'd member numbers.
764 # We'll assume we just got the max value of digits 2-8 of member #'s
765 # from the database and our job is to increment that by one,
766 # determine the 1st and 9th digits and return the full string.
767 my $sth = $dbh->prepare(
768 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
771 my $data = $sth->fetchrow_hashref;
772 $cardnumber = $data->{new_num};
773 if ( !$cardnumber ) { # If DB has no values,
774 $cardnumber = 1000000; # start at 1000000
780 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
781 # read weightings, left to right, 1 char at a time
782 my $temp1 = $weightings[$i];
784 # sequence left to right, 1 char at a time
785 my $temp2 = substr( $cardnumber, $i, 1 );
787 # mult each char 1-7 by its corresponding weighting
788 $sum += $temp1 * $temp2;
791 my $rem = ( $sum % 11 );
792 $rem = 'X' if $rem == 10;
794 return "V$cardnumber$rem";
797 my $sth = $dbh->prepare(
798 'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
801 my ($result) = $sth->fetchrow;
804 return $cardnumber; # just here as a fallback/reminder
807 =head2 GetPendingIssues
809 my $issues = &GetPendingIssues(@borrowernumber);
811 Looks up what the patron with the given borrowernumber has borrowed.
813 C<&GetPendingIssues> returns a
814 reference-to-array where each element is a reference-to-hash; the
815 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
816 The keys include C<biblioitems> fields except marc and marcxml.
820 sub GetPendingIssues {
821 my @borrowernumbers = @_;
823 unless (@borrowernumbers ) { # return a ref_to_array
824 return \@borrowernumbers; # to not cause surprise to caller
827 # Borrowers part of the query
829 for (my $i = 0; $i < @borrowernumbers; $i++) {
830 $bquery .= ' issues.borrowernumber = ?';
831 if ($i < $#borrowernumbers ) {
836 # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
837 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
838 # FIXME: circ/ciculation.pl tries to sort by timestamp!
839 # FIXME: namespace collision: other collisions possible.
840 # FIXME: most of this data isn't really being used by callers.
847 biblioitems.itemtype,
850 biblioitems.publicationyear,
851 biblioitems.publishercode,
852 biblioitems.volumedate,
853 biblioitems.volumedesc,
858 borrowers.cardnumber,
859 issues.timestamp AS timestamp,
860 issues.renewals AS renewals,
861 issues.borrowernumber AS borrowernumber,
862 items.renewals AS totalrenewals
864 LEFT JOIN items ON items.itemnumber = issues.itemnumber
865 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
866 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
867 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
870 ORDER BY issues.issuedate"
873 my $sth = C4::Context->dbh->prepare($query);
874 $sth->execute(@borrowernumbers);
875 my $data = $sth->fetchall_arrayref({});
876 my $today = dt_from_string;
878 if ($_->{issuedate}) {
879 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
881 $_->{date_due_sql} = $_->{date_due};
882 # FIXME no need to have this value
883 $_->{date_due} or next;
884 $_->{date_due_sql} = $_->{date_due};
885 # FIXME no need to have this value
886 $_->{date_due} = dt_from_string($_->{date_due}, 'sql');
887 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
896 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
898 Looks up what the patron with the given borrowernumber has borrowed,
899 and sorts the results.
901 C<$sortkey> is the name of a field on which to sort the results. This
902 should be the name of a field in the C<issues>, C<biblio>,
903 C<biblioitems>, or C<items> table in the Koha database.
905 C<$limit> is the maximum number of results to return.
907 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
908 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
909 C<items> tables of the Koha database.
915 my ( $borrowernumber, $order, $limit ) = @_;
917 return unless $borrowernumber;
918 $order = 'date_due desc' unless $order;
920 my $dbh = C4::Context->dbh;
922 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
924 LEFT JOIN items on items.itemnumber=issues.itemnumber
925 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
926 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
927 WHERE borrowernumber=?
929 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
931 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
932 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
933 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
934 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
937 $query .= " limit $limit";
940 my $sth = $dbh->prepare($query);
941 $sth->execute( $borrowernumber, $borrowernumber );
942 return $sth->fetchall_arrayref( {} );
946 =head2 GetMemberAccountRecords
948 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
950 Looks up accounting data for the patron with the given borrowernumber.
952 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
953 reference-to-array, where each element is a reference-to-hash; the
954 keys are the fields of the C<accountlines> table in the Koha database.
955 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
956 total amount outstanding for all of the account lines.
960 sub GetMemberAccountRecords {
961 my ($borrowernumber) = @_;
962 my $dbh = C4::Context->dbh;
968 WHERE borrowernumber=?);
969 $strsth.=" ORDER BY accountlines_id desc";
970 my $sth= $dbh->prepare( $strsth );
971 $sth->execute( $borrowernumber );
974 while ( my $data = $sth->fetchrow_hashref ) {
975 if ( $data->{itemnumber} ) {
976 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
977 $data->{biblionumber} = $biblio->{biblionumber};
978 $data->{title} = $biblio->{title};
980 $acctlines[$numlines] = $data;
982 $total += sprintf "%.0f", 1000*$data->{amountoutstanding}; # convert float to integer to avoid round-off errors
985 return ( $total, \@acctlines,$numlines);
988 =head2 GetMemberAccountBalance
990 ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
992 Calculates amount immediately owing by the patron - non-issue charges.
993 Based on GetMemberAccountRecords.
994 Charges exempt from non-issue are:
996 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
997 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
1001 sub GetMemberAccountBalance {
1002 my ($borrowernumber) = @_;
1004 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
1007 push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
1008 push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
1009 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
1010 my $dbh = C4::Context->dbh;
1011 my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
1012 push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
1014 my %not_fine = map {$_ => 1} @not_fines;
1016 my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
1017 my $other_charges = 0;
1018 foreach (@$acctlines) {
1019 $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
1022 return ( $total, $total - $other_charges, $other_charges);
1025 =head2 GetBorNotifyAcctRecord
1027 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1029 Looks up accounting data for the patron with the given borrowernumber per file number.
1031 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1032 reference-to-array, where each element is a reference-to-hash; the
1033 keys are the fields of the C<accountlines> table in the Koha database.
1034 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1035 total amount outstanding for all of the account lines.
1039 sub GetBorNotifyAcctRecord {
1040 my ( $borrowernumber, $notifyid ) = @_;
1041 my $dbh = C4::Context->dbh;
1044 my $sth = $dbh->prepare(
1047 WHERE borrowernumber=?
1049 AND amountoutstanding != '0'
1050 ORDER BY notify_id,accounttype
1053 $sth->execute( $borrowernumber, $notifyid );
1055 while ( my $data = $sth->fetchrow_hashref ) {
1056 if ( $data->{itemnumber} ) {
1057 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1058 $data->{biblionumber} = $biblio->{biblionumber};
1059 $data->{title} = $biblio->{title};
1061 $acctlines[$numlines] = $data;
1063 $total += int(100 * $data->{'amountoutstanding'});
1066 return ( $total, \@acctlines, $numlines );
1069 sub checkcardnumber {
1070 my ( $cardnumber, $borrowernumber ) = @_;
1072 # If cardnumber is null, we assume they're allowed.
1073 return 0 unless defined $cardnumber;
1075 my $dbh = C4::Context->dbh;
1076 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1077 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1078 my $sth = $dbh->prepare($query);
1081 ( $borrowernumber ? $borrowernumber : () )
1084 return 1 if $sth->fetchrow_hashref;
1086 my ( $min_length, $max_length ) = get_cardnumber_length();
1088 if length $cardnumber > $max_length
1089 or length $cardnumber < $min_length;
1094 =head2 get_cardnumber_length
1096 my ($min, $max) = C4::Members::get_cardnumber_length()
1098 Returns the minimum and maximum length for patron cardnumbers as
1099 determined by the CardnumberLength system preference, the
1100 BorrowerMandatoryField system preference, and the width of the
1105 sub get_cardnumber_length {
1106 my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
1107 $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
1108 if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
1109 # Is integer and length match
1110 if ( $cardnumber_length =~ m|^\d+$| ) {
1111 $min = $max = $cardnumber_length
1112 if $cardnumber_length >= $min
1113 and $cardnumber_length <= $max;
1115 # Else assuming it is a range
1116 elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
1117 $min = $1 if $1 and $min < $1;
1118 $max = $2 if $2 and $max > $2;
1122 my $borrower = Koha::Schema->resultset('Borrower');
1123 my $field_size = $borrower->result_source->column_info('cardnumber')->{size};
1124 $min = $field_size if $min > $field_size;
1125 return ( $min, $max );
1128 =head2 GetFirstValidEmailAddress
1130 $email = GetFirstValidEmailAddress($borrowernumber);
1132 Return the first valid email address for a borrower, given the borrowernumber. For now, the order
1133 is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
1138 sub GetFirstValidEmailAddress {
1139 my $borrowernumber = shift;
1140 my $dbh = C4::Context->dbh;
1141 my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1142 $sth->execute( $borrowernumber );
1143 my $data = $sth->fetchrow_hashref;
1145 if ($data->{'email'}) {
1146 return $data->{'email'};
1147 } elsif ($data->{'emailpro'}) {
1148 return $data->{'emailpro'};
1149 } elsif ($data->{'B_email'}) {
1150 return $data->{'B_email'};
1156 =head2 GetNoticeEmailAddress
1158 $email = GetNoticeEmailAddress($borrowernumber);
1160 Return the email address of borrower used for notices, given the borrowernumber.
1161 Returns the empty string if no email address.
1165 sub GetNoticeEmailAddress {
1166 my $borrowernumber = shift;
1168 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1169 # if syspref is set to 'first valid' (value == OFF), look up email address
1170 if ( $which_address eq 'OFF' ) {
1171 return GetFirstValidEmailAddress($borrowernumber);
1173 # specified email address field
1174 my $dbh = C4::Context->dbh;
1175 my $sth = $dbh->prepare( qq{
1176 SELECT $which_address AS primaryemail
1178 WHERE borrowernumber=?
1180 $sth->execute($borrowernumber);
1181 my $data = $sth->fetchrow_hashref;
1182 return $data->{'primaryemail'} || '';
1185 =head2 GetUpcomingMembershipExpires
1187 my $expires = GetUpcomingMembershipExpires({
1188 branch => $branch, before => $before, after => $after,
1191 $branch is an optional branch code.
1192 $before/$after is an optional number of days before/after the date that
1193 is set by the preference MembershipExpiryDaysNotice.
1194 If the pref would be 14, before 2 and after 3, you will get all expires
1199 sub GetUpcomingMembershipExpires {
1200 my ( $params ) = @_;
1201 my $before = $params->{before} || 0;
1202 my $after = $params->{after} || 0;
1203 my $branch = $params->{branch};
1205 my $dbh = C4::Context->dbh;
1206 my $days = C4::Context->preference("MembershipExpiryDaysNotice") || 0;
1207 my $date1 = dt_from_string->add( days => $days - $before );
1208 my $date2 = dt_from_string->add( days => $days + $after );
1209 $date1= output_pref({ dt => $date1, dateformat => 'iso', dateonly => 1 });
1210 $date2= output_pref({ dt => $date2, dateformat => 'iso', dateonly => 1 });
1213 SELECT borrowers.*, categories.description,
1214 branches.branchname, branches.branchemail FROM borrowers
1215 LEFT JOIN branches USING (branchcode)
1216 LEFT JOIN categories USING (categorycode)
1219 $query.= 'WHERE branchcode=? AND dateexpiry BETWEEN ? AND ?';
1221 $query.= 'WHERE dateexpiry BETWEEN ? AND ?';
1224 my $sth = $dbh->prepare( $query );
1225 my @pars = $branch? ( $branch ): ();
1226 push @pars, $date1, $date2;
1227 $sth->execute( @pars );
1228 my $results = $sth->fetchall_arrayref( {} );
1234 $dateofbirth,$date = &GetAge($date);
1236 this function return the borrowers age with the value of dateofbirth
1242 my ( $date, $date_ref ) = @_;
1244 if ( not defined $date_ref ) {
1245 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1248 my ( $year1, $month1, $day1 ) = split /-/, $date;
1249 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1251 my $age = $year2 - $year1;
1252 if ( $month1 . $day1 > $month2 . $day2 ) {
1261 $borrower = C4::Members::SetAge($borrower, $datetimeduration);
1262 $borrower = C4::Members::SetAge($borrower, '0015-12-10');
1263 $borrower = C4::Members::SetAge($borrower, $datetimeduration, $datetime_reference);
1265 eval { $borrower = C4::Members::SetAge($borrower, '015-1-10'); };
1266 if ($@) {print $@;} #Catch a bad ISO Date or kill your script!
1268 This function sets the borrower's dateofbirth to match the given age.
1269 Optionally relative to the given $datetime_reference.
1271 @PARAM1 koha.borrowers-object
1272 @PARAM2 DateTime::Duration-object as the desired age
1273 OR a ISO 8601 Date. (To make the API more pleasant)
1274 @PARAM3 DateTime-object as the relative date, defaults to now().
1275 RETURNS The given borrower reference @PARAM1.
1276 DIES If there was an error with the ISO Date handling.
1282 my ( $borrower, $datetimeduration, $datetime_ref ) = @_;
1283 $datetime_ref = DateTime->now() unless $datetime_ref;
1285 if ($datetimeduration && ref $datetimeduration ne 'DateTime::Duration') {
1286 if ($datetimeduration =~ /^(\d{4})-(\d{2})-(\d{2})/) {
1287 $datetimeduration = DateTime::Duration->new(years => $1, months => $2, days => $3);
1290 die "C4::Members::SetAge($borrower, $datetimeduration), datetimeduration not a valid ISO 8601 Date!\n";
1294 my $new_datetime_ref = $datetime_ref->clone();
1295 $new_datetime_ref->subtract_duration( $datetimeduration );
1297 $borrower->{dateofbirth} = $new_datetime_ref->ymd();
1302 =head2 GetHideLostItemsPreference
1304 $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1306 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1307 C<&$hidelostitemspref>return value of function, 0 or 1
1311 sub GetHideLostItemsPreference {
1312 my ($borrowernumber) = @_;
1313 my $dbh = C4::Context->dbh;
1314 my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1315 my $sth = $dbh->prepare($query);
1316 $sth->execute($borrowernumber);
1317 my $hidelostitems = $sth->fetchrow;
1318 return $hidelostitems;
1321 =head2 GetBorrowersToExpunge
1323 $borrowers = &GetBorrowersToExpunge(
1324 not_borrowed_since => $not_borrowed_since,
1325 expired_before => $expired_before,
1326 category_code => $category_code,
1327 patron_list_id => $patron_list_id,
1328 branchcode => $branchcode
1331 This function get all borrowers based on the given criteria.
1335 sub GetBorrowersToExpunge {
1338 my $filterdate = $params->{'not_borrowed_since'};
1339 my $filterexpiry = $params->{'expired_before'};
1340 my $filterlastseen = $params->{'last_seen'};
1341 my $filtercategory = $params->{'category_code'};
1342 my $filterbranch = $params->{'branchcode'} ||
1343 ((C4::Context->preference('IndependentBranches')
1344 && C4::Context->userenv
1345 && !C4::Context->IsSuperLibrarian()
1346 && C4::Context->userenv->{branch})
1347 ? C4::Context->userenv->{branch}
1349 my $filterpatronlist = $params->{'patron_list_id'};
1351 my $dbh = C4::Context->dbh;
1353 SELECT borrowers.borrowernumber,
1354 MAX(old_issues.timestamp) AS latestissue,
1355 MAX(issues.timestamp) AS currentissue
1357 JOIN categories USING (categorycode)
1361 WHERE guarantorid IS NOT NULL
1362 AND guarantorid <> 0
1363 ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
1364 LEFT JOIN old_issues USING (borrowernumber)
1365 LEFT JOIN issues USING (borrowernumber)|;
1366 if ( $filterpatronlist ){
1367 $query .= q| LEFT JOIN patron_list_patrons USING (borrowernumber)|;
1369 $query .= q| WHERE category_type <> 'S'
1370 AND tmp.guarantorid IS NULL
1373 if ( $filterbranch && $filterbranch ne "" ) {
1374 $query.= " AND borrowers.branchcode = ? ";
1375 push( @query_params, $filterbranch );
1377 if ( $filterexpiry ) {
1378 $query .= " AND dateexpiry < ? ";
1379 push( @query_params, $filterexpiry );
1381 if ( $filterlastseen ) {
1382 $query .= ' AND lastseen < ? ';
1383 push @query_params, $filterlastseen;
1385 if ( $filtercategory ) {
1386 $query .= " AND categorycode = ? ";
1387 push( @query_params, $filtercategory );
1389 if ( $filterpatronlist ){
1390 $query.=" AND patron_list_id = ? ";
1391 push( @query_params, $filterpatronlist );
1393 $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
1394 if ( $filterdate ) {
1395 $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
1396 push @query_params,$filterdate;
1398 warn $query if $debug;
1400 my $sth = $dbh->prepare($query);
1401 if (scalar(@query_params)>0){
1402 $sth->execute(@query_params);
1409 while ( my $data = $sth->fetchrow_hashref ) {
1410 push @results, $data;
1415 =head2 GetBorrowersWhoHaveNeverBorrowed
1417 $results = &GetBorrowersWhoHaveNeverBorrowed
1419 This function get all borrowers who have never borrowed.
1421 I<$result> is a ref to an array which all elements are a hasref.
1425 sub GetBorrowersWhoHaveNeverBorrowed {
1426 my $filterbranch = shift ||
1427 ((C4::Context->preference('IndependentBranches')
1428 && C4::Context->userenv
1429 && !C4::Context->IsSuperLibrarian()
1430 && C4::Context->userenv->{branch})
1431 ? C4::Context->userenv->{branch}
1433 my $dbh = C4::Context->dbh;
1435 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
1437 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
1438 WHERE issues.borrowernumber IS NULL
1441 if ($filterbranch && $filterbranch ne ""){
1442 $query.=" AND borrowers.branchcode= ?";
1443 push @query_params,$filterbranch;
1445 warn $query if $debug;
1447 my $sth = $dbh->prepare($query);
1448 if (scalar(@query_params)>0){
1449 $sth->execute(@query_params);
1456 while ( my $data = $sth->fetchrow_hashref ) {
1457 push @results, $data;
1462 =head2 GetBorrowersWithIssuesHistoryOlderThan
1464 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
1466 this function get all borrowers who has an issue history older than I<$date> given on input arg.
1468 I<$result> is a ref to an array which all elements are a hashref.
1469 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1473 sub GetBorrowersWithIssuesHistoryOlderThan {
1474 my $dbh = C4::Context->dbh;
1475 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
1476 my $filterbranch = shift ||
1477 ((C4::Context->preference('IndependentBranches')
1478 && C4::Context->userenv
1479 && !C4::Context->IsSuperLibrarian()
1480 && C4::Context->userenv->{branch})
1481 ? C4::Context->userenv->{branch}
1484 SELECT count(borrowernumber) as n,borrowernumber
1486 WHERE returndate < ?
1487 AND borrowernumber IS NOT NULL
1490 push @query_params, $date;
1492 $query.=" AND branchcode = ?";
1493 push @query_params, $filterbranch;
1495 $query.=" GROUP BY borrowernumber ";
1496 warn $query if $debug;
1497 my $sth = $dbh->prepare($query);
1498 $sth->execute(@query_params);
1501 while ( my $data = $sth->fetchrow_hashref ) {
1502 push @results, $data;
1509 IssueSlip($branchcode, $borrowernumber, $quickslip)
1511 Returns letter hash ( see C4::Letters::GetPreparedLetter )
1513 $quickslip is boolean, to indicate whether we want a quick slip
1515 IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
1551 NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
1556 my ($branch, $borrowernumber, $quickslip) = @_;
1558 # FIXME Check callers before removing this statement
1559 #return unless $borrowernumber;
1561 my @issues = @{ GetPendingIssues($borrowernumber) };
1563 for my $issue (@issues) {
1564 $issue->{date_due} = $issue->{date_due_sql};
1566 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
1567 if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
1568 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
1574 # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
1576 my $s = $b->{timestamp} <=> $a->{timestamp};
1578 $b->{issuedate} <=> $a->{issuedate} : $s;
1581 my ($letter_code, %repeat);
1583 $letter_code = 'ISSUEQSLIP';
1585 'checkedout' => [ map {
1588 'biblioitems' => $_,
1590 }, grep { $_->{'now'} } @issues ],
1594 $letter_code = 'ISSUESLIP';
1596 'checkedout' => [ map {
1599 'biblioitems' => $_,
1601 }, grep { !$_->{'overdue'} } @issues ],
1603 'overdue' => [ map {
1606 'biblioitems' => $_,
1608 }, grep { $_->{'overdue'} } @issues ],
1611 $_->{'timestamp'} = $_->{'newdate'};
1613 } @{ GetNewsToDisplay("slip",$branch) } ],
1617 return C4::Letters::GetPreparedLetter (
1618 module => 'circulation',
1619 letter_code => $letter_code,
1620 branchcode => $branch,
1622 'branches' => $branch,
1623 'borrowers' => $borrowernumber,
1629 =head2 GetBorrowersWithEmail
1631 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
1633 This gets a list of users and their basic details from their email address.
1634 As it's possible for multiple user to have the same email address, it provides
1635 you with all of them. If there is no userid for the user, there will be an
1636 C<undef> there. An empty list will be returned if there are no matches.
1640 sub GetBorrowersWithEmail {
1643 my $dbh = C4::Context->dbh;
1645 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
1646 my $sth=$dbh->prepare($query);
1647 $sth->execute($email);
1649 while (my $ref = $sth->fetch) {
1652 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
1656 =head2 AddMember_Opac
1660 sub AddMember_Opac {
1661 my ( %borrower ) = @_;
1663 $borrower{'categorycode'} //= C4::Context->preference('PatronSelfRegistrationDefaultCategory');
1664 if (not defined $borrower{'password'}){
1665 my $sr = new String::Random;
1666 $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
1667 my $password = $sr->randpattern("AAAAAAAAAA");
1668 $borrower{'password'} = $password;
1671 $borrower{'cardnumber'} = fixup_cardnumber( $borrower{'cardnumber'} );
1673 my $borrowernumber = AddMember(%borrower);
1675 return ( $borrowernumber, $borrower{'password'} );
1678 =head2 DeleteExpiredOpacRegistrations
1680 Delete accounts that haven't been upgraded from the 'temporary' category
1681 Returns the number of removed patrons
1685 sub DeleteExpiredOpacRegistrations {
1687 my $delay = C4::Context->preference('PatronSelfRegistrationExpireTemporaryAccountsDelay');
1688 my $category_code = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
1690 return 0 if not $category_code or not defined $delay or $delay eq q||;
1693 SELECT borrowernumber
1695 WHERE categorycode = ? AND DATEDIFF( NOW(), dateenrolled ) > ? |;
1697 my $dbh = C4::Context->dbh;
1698 my $sth = $dbh->prepare($query);
1699 $sth->execute( $category_code, $delay );
1701 while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
1702 Koha::Patrons->find($borrowernumber)->delete;
1708 =head2 DeleteUnverifiedOpacRegistrations
1710 Delete all unverified self registrations in borrower_modifications,
1711 older than the specified number of days.
1715 sub DeleteUnverifiedOpacRegistrations {
1717 my $dbh = C4::Context->dbh;
1719 DELETE FROM borrower_modifications
1720 WHERE borrowernumber = 0 AND DATEDIFF( NOW(), timestamp ) > ?|;
1721 my $cnt=$dbh->do($sql, undef, ($days) );
1722 return $cnt eq '0E0'? 0: $cnt;
1725 sub GetOverduesForPatron {
1726 my ( $borrowernumber ) = @_;
1730 FROM issues, items, biblio, biblioitems
1731 WHERE items.itemnumber=issues.itemnumber
1732 AND biblio.biblionumber = items.biblionumber
1733 AND biblio.biblionumber = biblioitems.biblionumber
1734 AND issues.borrowernumber = ?
1735 AND date_due < NOW()
1738 my $sth = C4::Context->dbh->prepare( $sql );
1739 $sth->execute( $borrowernumber );
1741 return $sth->fetchall_arrayref({});
1744 END { } # module clean-up code here (global destructor)