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
509 # test to know if you must update or not the borrower password
510 if (exists $data{password}) {
511 if ($data{password} eq '****' or $data{password} eq '') {
512 delete $data{password};
514 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
515 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
516 Koha::NorwegianPatronDB::NLUpdateHashedPIN( $data{'borrowernumber'}, $data{password} );
518 $data{password} = hash_password($data{password});
522 my $old_categorycode = Koha::Patrons->find( $data{borrowernumber} )->categorycode;
524 # get only the columns of a borrower
525 my $schema = Koha::Database->new()->schema;
526 my @columns = $schema->source('Borrower')->columns;
527 my $new_borrower = { map { join(' ', @columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) };
528 delete $new_borrower->{flags};
530 $new_borrower->{dateofbirth} ||= undef if exists $new_borrower->{dateofbirth};
531 $new_borrower->{dateenrolled} ||= undef if exists $new_borrower->{dateenrolled};
532 $new_borrower->{dateexpiry} ||= undef if exists $new_borrower->{dateexpiry};
533 $new_borrower->{debarred} ||= undef if exists $new_borrower->{debarred};
534 $new_borrower->{sms_provider_id} ||= undef if exists $new_borrower->{sms_provider_id};
535 $new_borrower->{guarantorid} ||= undef if exists $new_borrower->{guarantorid};
537 my $patron = Koha::Patrons->find( $new_borrower->{borrowernumber} );
539 delete $new_borrower->{userid} if exists $new_borrower->{userid} and not $new_borrower->{userid};
541 my $execute_success = $patron->store if $patron->set($new_borrower);
543 if ($execute_success) { # only proceed if the update was a success
544 # If the patron changes to a category with enrollment fee, we add a fee
545 if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
546 if ( C4::Context->preference('FeeOnChangePatronCategory') ) {
547 $patron->add_enrolment_fee_if_needed;
551 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
552 # cronjob will use for syncing with NL
553 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
554 my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
555 'synctype' => 'norwegianpatrondb',
556 'borrowernumber' => $data{'borrowernumber'}
558 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
559 # we can sync as changed. And the "new sync" will pick up all changes since
560 # the patron was created anyway.
561 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
562 $borrowersync->update( { 'syncstatus' => 'edited' } );
564 # Set the value of 'sync'
565 $borrowersync->update( { 'sync' => $data{'sync'} } );
566 # Try to do the live sync
567 Koha::NorwegianPatronDB::NLSync({ 'borrowernumber' => $data{'borrowernumber'} });
570 logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
572 return $execute_success;
577 $borrowernumber = &AddMember(%borrower);
579 insert new borrower into table
581 (%borrower keys are database columns. Database columns could be
582 different in different versions. Please look into database for correct
585 Returns the borrowernumber upon success
587 Returns as undef upon any db error without further processing
594 my $dbh = C4::Context->dbh;
595 my $schema = Koha::Database->new()->schema;
597 # generate a proper login if none provided
598 $data{'userid'} = Generate_Userid( $data{'borrowernumber'}, $data{'firstname'}, $data{'surname'} )
599 if ( $data{'userid'} eq '' || !Check_Userid( $data{'userid'} ) );
601 # add expiration date if it isn't already there
602 $data{dateexpiry} ||= Koha::Patron::Categories->find( $data{categorycode} )->get_expiry_date;
604 # add enrollment date if it isn't already there
605 unless ( $data{'dateenrolled'} ) {
606 $data{'dateenrolled'} = output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
609 my $patron_category = $schema->resultset('Category')->find( $data{'categorycode'} );
611 $patron_category->default_privacy() eq 'default' ? 1
612 : $patron_category->default_privacy() eq 'never' ? 2
613 : $patron_category->default_privacy() eq 'forever' ? 0
616 $data{'privacy_guarantor_checkouts'} = 0 unless defined( $data{'privacy_guarantor_checkouts'} );
618 # Make a copy of the plain text password for later use
619 my $plain_text_password = $data{'password'};
621 # create a disabled account if no password provided
622 $data{'password'} = ($data{'password'})? hash_password($data{'password'}) : '!';
624 # we don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00
625 $data{'dateofbirth'} = undef if ( not $data{'dateofbirth'} );
626 $data{'debarred'} = undef if ( not $data{'debarred'} );
627 $data{'sms_provider_id'} = undef if ( not $data{'sms_provider_id'} );
629 # get only the columns of Borrower
630 # FIXME Do we really need this check?
631 my @columns = $schema->source('Borrower')->columns;
632 my $new_member = { map { join(' ',@columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) } ;
634 delete $new_member->{borrowernumber};
636 my $patron = Koha::Patron->new( $new_member )->store;
637 $data{borrowernumber} = $patron->borrowernumber;
639 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
640 # cronjob will use for syncing with NL
641 if ( exists $data{'borrowernumber'} && C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
642 Koha::Database->new->schema->resultset('BorrowerSync')->create({
643 'borrowernumber' => $data{'borrowernumber'},
644 'synctype' => 'norwegianpatrondb',
646 'syncstatus' => 'new',
647 'hashed_pin' => Koha::NorwegianPatronDB::NLEncryptPIN( $plain_text_password ),
651 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
653 $patron->add_enrolment_fee_if_needed;
655 return $data{borrowernumber};
660 my $uniqueness = Check_Userid($userid,$borrowernumber);
662 $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 != '').
664 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.
667 0 for not unique (i.e. this $userid already exists)
668 1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
673 my ( $uid, $borrowernumber ) = @_;
675 return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
677 return 0 if ( $uid eq C4::Context->config('user') );
679 my $rs = Koha::Database->new()->schema()->resultset('Borrower');
682 $params->{userid} = $uid;
683 $params->{borrowernumber} = { '!=' => $borrowernumber } if ($borrowernumber);
685 my $count = $rs->count( $params );
687 return $count ? 0 : 1;
690 =head2 Generate_Userid
692 my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
694 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
696 $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.
699 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).
703 sub Generate_Userid {
704 my ($borrowernumber, $firstname, $surname) = @_;
707 #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
709 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
710 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
711 $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
712 $newuid = unac_string('utf-8',$newuid);
713 $newuid .= $offset unless $offset == 0;
716 } while (!Check_Userid($newuid,$borrowernumber));
721 =head2 fixup_cardnumber
723 Warning: The caller is responsible for locking the members table in write
724 mode, to avoid database corruption.
728 use vars qw( @weightings );
729 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
731 sub fixup_cardnumber {
732 my ($cardnumber) = @_;
733 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
735 # Find out whether member numbers should be generated
736 # automatically. Should be either "1" or something else.
737 # Defaults to "0", which is interpreted as "no".
739 # if ($cardnumber !~ /\S/ && $autonumber_members) {
740 ($autonumber_members) or return $cardnumber;
741 my $checkdigit = C4::Context->preference('checkdigit');
742 my $dbh = C4::Context->dbh;
743 if ( $checkdigit and $checkdigit eq 'katipo' ) {
745 # if checkdigit is selected, calculate katipo-style cardnumber.
746 # otherwise, just use the max()
747 # purpose: generate checksum'd member numbers.
748 # We'll assume we just got the max value of digits 2-8 of member #'s
749 # from the database and our job is to increment that by one,
750 # determine the 1st and 9th digits and return the full string.
751 my $sth = $dbh->prepare(
752 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
755 my $data = $sth->fetchrow_hashref;
756 $cardnumber = $data->{new_num};
757 if ( !$cardnumber ) { # If DB has no values,
758 $cardnumber = 1000000; # start at 1000000
764 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
765 # read weightings, left to right, 1 char at a time
766 my $temp1 = $weightings[$i];
768 # sequence left to right, 1 char at a time
769 my $temp2 = substr( $cardnumber, $i, 1 );
771 # mult each char 1-7 by its corresponding weighting
772 $sum += $temp1 * $temp2;
775 my $rem = ( $sum % 11 );
776 $rem = 'X' if $rem == 10;
778 return "V$cardnumber$rem";
781 my $sth = $dbh->prepare(
782 'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
785 my ($result) = $sth->fetchrow;
788 return $cardnumber; # just here as a fallback/reminder
791 =head2 GetPendingIssues
793 my $issues = &GetPendingIssues(@borrowernumber);
795 Looks up what the patron with the given borrowernumber has borrowed.
797 C<&GetPendingIssues> returns a
798 reference-to-array where each element is a reference-to-hash; the
799 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
800 The keys include C<biblioitems> fields except marc and marcxml.
804 sub GetPendingIssues {
805 my @borrowernumbers = @_;
807 unless (@borrowernumbers ) { # return a ref_to_array
808 return \@borrowernumbers; # to not cause surprise to caller
811 # Borrowers part of the query
813 for (my $i = 0; $i < @borrowernumbers; $i++) {
814 $bquery .= ' issues.borrowernumber = ?';
815 if ($i < $#borrowernumbers ) {
820 # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
821 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
822 # FIXME: circ/ciculation.pl tries to sort by timestamp!
823 # FIXME: namespace collision: other collisions possible.
824 # FIXME: most of this data isn't really being used by callers.
831 biblioitems.itemtype,
834 biblioitems.publicationyear,
835 biblioitems.publishercode,
836 biblioitems.volumedate,
837 biblioitems.volumedesc,
842 borrowers.cardnumber,
843 issues.timestamp AS timestamp,
844 issues.renewals AS renewals,
845 issues.borrowernumber AS borrowernumber,
846 items.renewals AS totalrenewals
848 LEFT JOIN items ON items.itemnumber = issues.itemnumber
849 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
850 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
851 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
854 ORDER BY issues.issuedate"
857 my $sth = C4::Context->dbh->prepare($query);
858 $sth->execute(@borrowernumbers);
859 my $data = $sth->fetchall_arrayref({});
860 my $today = dt_from_string;
862 if ($_->{issuedate}) {
863 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
865 $_->{date_due_sql} = $_->{date_due};
866 # FIXME no need to have this value
867 $_->{date_due} or next;
868 $_->{date_due_sql} = $_->{date_due};
869 # FIXME no need to have this value
870 $_->{date_due} = dt_from_string($_->{date_due}, 'sql');
871 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
880 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
882 Looks up what the patron with the given borrowernumber has borrowed,
883 and sorts the results.
885 C<$sortkey> is the name of a field on which to sort the results. This
886 should be the name of a field in the C<issues>, C<biblio>,
887 C<biblioitems>, or C<items> table in the Koha database.
889 C<$limit> is the maximum number of results to return.
891 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
892 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
893 C<items> tables of the Koha database.
899 my ( $borrowernumber, $order, $limit ) = @_;
901 return unless $borrowernumber;
902 $order = 'date_due desc' unless $order;
904 my $dbh = C4::Context->dbh;
906 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
908 LEFT JOIN items on items.itemnumber=issues.itemnumber
909 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
910 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
911 WHERE borrowernumber=?
913 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
915 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
916 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
917 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
918 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
921 $query .= " limit $limit";
924 my $sth = $dbh->prepare($query);
925 $sth->execute( $borrowernumber, $borrowernumber );
926 return $sth->fetchall_arrayref( {} );
930 =head2 GetMemberAccountRecords
932 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
934 Looks up accounting data for the patron with the given borrowernumber.
936 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
937 reference-to-array, where each element is a reference-to-hash; the
938 keys are the fields of the C<accountlines> table in the Koha database.
939 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
940 total amount outstanding for all of the account lines.
944 sub GetMemberAccountRecords {
945 my ($borrowernumber) = @_;
946 my $dbh = C4::Context->dbh;
952 WHERE borrowernumber=?);
953 $strsth.=" ORDER BY accountlines_id desc";
954 my $sth= $dbh->prepare( $strsth );
955 $sth->execute( $borrowernumber );
958 while ( my $data = $sth->fetchrow_hashref ) {
959 if ( $data->{itemnumber} ) {
960 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
961 $data->{biblionumber} = $biblio->{biblionumber};
962 $data->{title} = $biblio->{title};
964 $acctlines[$numlines] = $data;
966 $total += sprintf "%.0f", 1000*$data->{amountoutstanding}; # convert float to integer to avoid round-off errors
969 return ( $total, \@acctlines,$numlines);
972 =head2 GetMemberAccountBalance
974 ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
976 Calculates amount immediately owing by the patron - non-issue charges.
977 Based on GetMemberAccountRecords.
978 Charges exempt from non-issue are:
980 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
981 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
985 sub GetMemberAccountBalance {
986 my ($borrowernumber) = @_;
988 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
991 push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
992 push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
993 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
994 my $dbh = C4::Context->dbh;
995 my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
996 push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
998 my %not_fine = map {$_ => 1} @not_fines;
1000 my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
1001 my $other_charges = 0;
1002 foreach (@$acctlines) {
1003 $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
1006 return ( $total, $total - $other_charges, $other_charges);
1009 =head2 GetBorNotifyAcctRecord
1011 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1013 Looks up accounting data for the patron with the given borrowernumber per file number.
1015 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1016 reference-to-array, where each element is a reference-to-hash; the
1017 keys are the fields of the C<accountlines> table in the Koha database.
1018 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1019 total amount outstanding for all of the account lines.
1023 sub GetBorNotifyAcctRecord {
1024 my ( $borrowernumber, $notifyid ) = @_;
1025 my $dbh = C4::Context->dbh;
1028 my $sth = $dbh->prepare(
1031 WHERE borrowernumber=?
1033 AND amountoutstanding != '0'
1034 ORDER BY notify_id,accounttype
1037 $sth->execute( $borrowernumber, $notifyid );
1039 while ( my $data = $sth->fetchrow_hashref ) {
1040 if ( $data->{itemnumber} ) {
1041 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1042 $data->{biblionumber} = $biblio->{biblionumber};
1043 $data->{title} = $biblio->{title};
1045 $acctlines[$numlines] = $data;
1047 $total += int(100 * $data->{'amountoutstanding'});
1050 return ( $total, \@acctlines, $numlines );
1053 sub checkcardnumber {
1054 my ( $cardnumber, $borrowernumber ) = @_;
1056 # If cardnumber is null, we assume they're allowed.
1057 return 0 unless defined $cardnumber;
1059 my $dbh = C4::Context->dbh;
1060 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1061 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1062 my $sth = $dbh->prepare($query);
1065 ( $borrowernumber ? $borrowernumber : () )
1068 return 1 if $sth->fetchrow_hashref;
1070 my ( $min_length, $max_length ) = get_cardnumber_length();
1072 if length $cardnumber > $max_length
1073 or length $cardnumber < $min_length;
1078 =head2 get_cardnumber_length
1080 my ($min, $max) = C4::Members::get_cardnumber_length()
1082 Returns the minimum and maximum length for patron cardnumbers as
1083 determined by the CardnumberLength system preference, the
1084 BorrowerMandatoryField system preference, and the width of the
1089 sub get_cardnumber_length {
1090 my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
1091 $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
1092 if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
1093 # Is integer and length match
1094 if ( $cardnumber_length =~ m|^\d+$| ) {
1095 $min = $max = $cardnumber_length
1096 if $cardnumber_length >= $min
1097 and $cardnumber_length <= $max;
1099 # Else assuming it is a range
1100 elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
1101 $min = $1 if $1 and $min < $1;
1102 $max = $2 if $2 and $max > $2;
1106 my $borrower = Koha::Schema->resultset('Borrower');
1107 my $field_size = $borrower->result_source->column_info('cardnumber')->{size};
1108 $min = $field_size if $min > $field_size;
1109 return ( $min, $max );
1112 =head2 GetFirstValidEmailAddress
1114 $email = GetFirstValidEmailAddress($borrowernumber);
1116 Return the first valid email address for a borrower, given the borrowernumber. For now, the order
1117 is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
1122 sub GetFirstValidEmailAddress {
1123 my $borrowernumber = shift;
1124 my $dbh = C4::Context->dbh;
1125 my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1126 $sth->execute( $borrowernumber );
1127 my $data = $sth->fetchrow_hashref;
1129 if ($data->{'email'}) {
1130 return $data->{'email'};
1131 } elsif ($data->{'emailpro'}) {
1132 return $data->{'emailpro'};
1133 } elsif ($data->{'B_email'}) {
1134 return $data->{'B_email'};
1140 =head2 GetNoticeEmailAddress
1142 $email = GetNoticeEmailAddress($borrowernumber);
1144 Return the email address of borrower used for notices, given the borrowernumber.
1145 Returns the empty string if no email address.
1149 sub GetNoticeEmailAddress {
1150 my $borrowernumber = shift;
1152 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1153 # if syspref is set to 'first valid' (value == OFF), look up email address
1154 if ( $which_address eq 'OFF' ) {
1155 return GetFirstValidEmailAddress($borrowernumber);
1157 # specified email address field
1158 my $dbh = C4::Context->dbh;
1159 my $sth = $dbh->prepare( qq{
1160 SELECT $which_address AS primaryemail
1162 WHERE borrowernumber=?
1164 $sth->execute($borrowernumber);
1165 my $data = $sth->fetchrow_hashref;
1166 return $data->{'primaryemail'} || '';
1169 =head2 GetUpcomingMembershipExpires
1171 my $expires = GetUpcomingMembershipExpires({
1172 branch => $branch, before => $before, after => $after,
1175 $branch is an optional branch code.
1176 $before/$after is an optional number of days before/after the date that
1177 is set by the preference MembershipExpiryDaysNotice.
1178 If the pref would be 14, before 2 and after 3, you will get all expires
1183 sub GetUpcomingMembershipExpires {
1184 my ( $params ) = @_;
1185 my $before = $params->{before} || 0;
1186 my $after = $params->{after} || 0;
1187 my $branch = $params->{branch};
1189 my $dbh = C4::Context->dbh;
1190 my $days = C4::Context->preference("MembershipExpiryDaysNotice") || 0;
1191 my $date1 = dt_from_string->add( days => $days - $before );
1192 my $date2 = dt_from_string->add( days => $days + $after );
1193 $date1= output_pref({ dt => $date1, dateformat => 'iso', dateonly => 1 });
1194 $date2= output_pref({ dt => $date2, dateformat => 'iso', dateonly => 1 });
1197 SELECT borrowers.*, categories.description,
1198 branches.branchname, branches.branchemail FROM borrowers
1199 LEFT JOIN branches USING (branchcode)
1200 LEFT JOIN categories USING (categorycode)
1203 $query.= 'WHERE branchcode=? AND dateexpiry BETWEEN ? AND ?';
1205 $query.= 'WHERE dateexpiry BETWEEN ? AND ?';
1208 my $sth = $dbh->prepare( $query );
1209 my @pars = $branch? ( $branch ): ();
1210 push @pars, $date1, $date2;
1211 $sth->execute( @pars );
1212 my $results = $sth->fetchall_arrayref( {} );
1218 $dateofbirth,$date = &GetAge($date);
1220 this function return the borrowers age with the value of dateofbirth
1226 my ( $date, $date_ref ) = @_;
1228 if ( not defined $date_ref ) {
1229 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1232 my ( $year1, $month1, $day1 ) = split /-/, $date;
1233 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1235 my $age = $year2 - $year1;
1236 if ( $month1 . $day1 > $month2 . $day2 ) {
1245 $borrower = C4::Members::SetAge($borrower, $datetimeduration);
1246 $borrower = C4::Members::SetAge($borrower, '0015-12-10');
1247 $borrower = C4::Members::SetAge($borrower, $datetimeduration, $datetime_reference);
1249 eval { $borrower = C4::Members::SetAge($borrower, '015-1-10'); };
1250 if ($@) {print $@;} #Catch a bad ISO Date or kill your script!
1252 This function sets the borrower's dateofbirth to match the given age.
1253 Optionally relative to the given $datetime_reference.
1255 @PARAM1 koha.borrowers-object
1256 @PARAM2 DateTime::Duration-object as the desired age
1257 OR a ISO 8601 Date. (To make the API more pleasant)
1258 @PARAM3 DateTime-object as the relative date, defaults to now().
1259 RETURNS The given borrower reference @PARAM1.
1260 DIES If there was an error with the ISO Date handling.
1266 my ( $borrower, $datetimeduration, $datetime_ref ) = @_;
1267 $datetime_ref = DateTime->now() unless $datetime_ref;
1269 if ($datetimeduration && ref $datetimeduration ne 'DateTime::Duration') {
1270 if ($datetimeduration =~ /^(\d{4})-(\d{2})-(\d{2})/) {
1271 $datetimeduration = DateTime::Duration->new(years => $1, months => $2, days => $3);
1274 die "C4::Members::SetAge($borrower, $datetimeduration), datetimeduration not a valid ISO 8601 Date!\n";
1278 my $new_datetime_ref = $datetime_ref->clone();
1279 $new_datetime_ref->subtract_duration( $datetimeduration );
1281 $borrower->{dateofbirth} = $new_datetime_ref->ymd();
1286 =head2 GetHideLostItemsPreference
1288 $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1290 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1291 C<&$hidelostitemspref>return value of function, 0 or 1
1295 sub GetHideLostItemsPreference {
1296 my ($borrowernumber) = @_;
1297 my $dbh = C4::Context->dbh;
1298 my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1299 my $sth = $dbh->prepare($query);
1300 $sth->execute($borrowernumber);
1301 my $hidelostitems = $sth->fetchrow;
1302 return $hidelostitems;
1305 =head2 GetBorrowersToExpunge
1307 $borrowers = &GetBorrowersToExpunge(
1308 not_borrowed_since => $not_borrowed_since,
1309 expired_before => $expired_before,
1310 category_code => $category_code,
1311 patron_list_id => $patron_list_id,
1312 branchcode => $branchcode
1315 This function get all borrowers based on the given criteria.
1319 sub GetBorrowersToExpunge {
1322 my $filterdate = $params->{'not_borrowed_since'};
1323 my $filterexpiry = $params->{'expired_before'};
1324 my $filterlastseen = $params->{'last_seen'};
1325 my $filtercategory = $params->{'category_code'};
1326 my $filterbranch = $params->{'branchcode'} ||
1327 ((C4::Context->preference('IndependentBranches')
1328 && C4::Context->userenv
1329 && !C4::Context->IsSuperLibrarian()
1330 && C4::Context->userenv->{branch})
1331 ? C4::Context->userenv->{branch}
1333 my $filterpatronlist = $params->{'patron_list_id'};
1335 my $dbh = C4::Context->dbh;
1337 SELECT borrowers.borrowernumber,
1338 MAX(old_issues.timestamp) AS latestissue,
1339 MAX(issues.timestamp) AS currentissue
1341 JOIN categories USING (categorycode)
1345 WHERE guarantorid IS NOT NULL
1346 AND guarantorid <> 0
1347 ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
1348 LEFT JOIN old_issues USING (borrowernumber)
1349 LEFT JOIN issues USING (borrowernumber)|;
1350 if ( $filterpatronlist ){
1351 $query .= q| LEFT JOIN patron_list_patrons USING (borrowernumber)|;
1353 $query .= q| WHERE category_type <> 'S'
1354 AND tmp.guarantorid IS NULL
1357 if ( $filterbranch && $filterbranch ne "" ) {
1358 $query.= " AND borrowers.branchcode = ? ";
1359 push( @query_params, $filterbranch );
1361 if ( $filterexpiry ) {
1362 $query .= " AND dateexpiry < ? ";
1363 push( @query_params, $filterexpiry );
1365 if ( $filterlastseen ) {
1366 $query .= ' AND lastseen < ? ';
1367 push @query_params, $filterlastseen;
1369 if ( $filtercategory ) {
1370 $query .= " AND categorycode = ? ";
1371 push( @query_params, $filtercategory );
1373 if ( $filterpatronlist ){
1374 $query.=" AND patron_list_id = ? ";
1375 push( @query_params, $filterpatronlist );
1377 $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
1378 if ( $filterdate ) {
1379 $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
1380 push @query_params,$filterdate;
1382 warn $query if $debug;
1384 my $sth = $dbh->prepare($query);
1385 if (scalar(@query_params)>0){
1386 $sth->execute(@query_params);
1393 while ( my $data = $sth->fetchrow_hashref ) {
1394 push @results, $data;
1399 =head2 GetBorrowersWhoHaveNeverBorrowed
1401 $results = &GetBorrowersWhoHaveNeverBorrowed
1403 This function get all borrowers who have never borrowed.
1405 I<$result> is a ref to an array which all elements are a hasref.
1409 sub GetBorrowersWhoHaveNeverBorrowed {
1410 my $filterbranch = shift ||
1411 ((C4::Context->preference('IndependentBranches')
1412 && C4::Context->userenv
1413 && !C4::Context->IsSuperLibrarian()
1414 && C4::Context->userenv->{branch})
1415 ? C4::Context->userenv->{branch}
1417 my $dbh = C4::Context->dbh;
1419 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
1421 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
1422 WHERE issues.borrowernumber IS NULL
1425 if ($filterbranch && $filterbranch ne ""){
1426 $query.=" AND borrowers.branchcode= ?";
1427 push @query_params,$filterbranch;
1429 warn $query if $debug;
1431 my $sth = $dbh->prepare($query);
1432 if (scalar(@query_params)>0){
1433 $sth->execute(@query_params);
1440 while ( my $data = $sth->fetchrow_hashref ) {
1441 push @results, $data;
1446 =head2 GetBorrowersWithIssuesHistoryOlderThan
1448 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
1450 this function get all borrowers who has an issue history older than I<$date> given on input arg.
1452 I<$result> is a ref to an array which all elements are a hashref.
1453 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1457 sub GetBorrowersWithIssuesHistoryOlderThan {
1458 my $dbh = C4::Context->dbh;
1459 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
1460 my $filterbranch = shift ||
1461 ((C4::Context->preference('IndependentBranches')
1462 && C4::Context->userenv
1463 && !C4::Context->IsSuperLibrarian()
1464 && C4::Context->userenv->{branch})
1465 ? C4::Context->userenv->{branch}
1468 SELECT count(borrowernumber) as n,borrowernumber
1470 WHERE returndate < ?
1471 AND borrowernumber IS NOT NULL
1474 push @query_params, $date;
1476 $query.=" AND branchcode = ?";
1477 push @query_params, $filterbranch;
1479 $query.=" GROUP BY borrowernumber ";
1480 warn $query if $debug;
1481 my $sth = $dbh->prepare($query);
1482 $sth->execute(@query_params);
1485 while ( my $data = $sth->fetchrow_hashref ) {
1486 push @results, $data;
1493 IssueSlip($branchcode, $borrowernumber, $quickslip)
1495 Returns letter hash ( see C4::Letters::GetPreparedLetter )
1497 $quickslip is boolean, to indicate whether we want a quick slip
1499 IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
1535 NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
1540 my ($branch, $borrowernumber, $quickslip) = @_;
1542 # FIXME Check callers before removing this statement
1543 #return unless $borrowernumber;
1545 my @issues = @{ GetPendingIssues($borrowernumber) };
1547 for my $issue (@issues) {
1548 $issue->{date_due} = $issue->{date_due_sql};
1550 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
1551 if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
1552 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
1558 # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
1560 my $s = $b->{timestamp} <=> $a->{timestamp};
1562 $b->{issuedate} <=> $a->{issuedate} : $s;
1565 my ($letter_code, %repeat);
1567 $letter_code = 'ISSUEQSLIP';
1569 'checkedout' => [ map {
1572 'biblioitems' => $_,
1574 }, grep { $_->{'now'} } @issues ],
1578 $letter_code = 'ISSUESLIP';
1580 'checkedout' => [ map {
1583 'biblioitems' => $_,
1585 }, grep { !$_->{'overdue'} } @issues ],
1587 'overdue' => [ map {
1590 'biblioitems' => $_,
1592 }, grep { $_->{'overdue'} } @issues ],
1595 $_->{'timestamp'} = $_->{'newdate'};
1597 } @{ GetNewsToDisplay("slip",$branch) } ],
1601 return C4::Letters::GetPreparedLetter (
1602 module => 'circulation',
1603 letter_code => $letter_code,
1604 branchcode => $branch,
1606 'branches' => $branch,
1607 'borrowers' => $borrowernumber,
1613 =head2 GetBorrowersWithEmail
1615 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
1617 This gets a list of users and their basic details from their email address.
1618 As it's possible for multiple user to have the same email address, it provides
1619 you with all of them. If there is no userid for the user, there will be an
1620 C<undef> there. An empty list will be returned if there are no matches.
1624 sub GetBorrowersWithEmail {
1627 my $dbh = C4::Context->dbh;
1629 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
1630 my $sth=$dbh->prepare($query);
1631 $sth->execute($email);
1633 while (my $ref = $sth->fetch) {
1636 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
1640 =head2 AddMember_Opac
1644 sub AddMember_Opac {
1645 my ( %borrower ) = @_;
1647 $borrower{'categorycode'} //= C4::Context->preference('PatronSelfRegistrationDefaultCategory');
1648 if (not defined $borrower{'password'}){
1649 my $sr = new String::Random;
1650 $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
1651 my $password = $sr->randpattern("AAAAAAAAAA");
1652 $borrower{'password'} = $password;
1655 $borrower{'cardnumber'} = fixup_cardnumber( $borrower{'cardnumber'} );
1657 my $borrowernumber = AddMember(%borrower);
1659 return ( $borrowernumber, $borrower{'password'} );
1662 =head2 DeleteExpiredOpacRegistrations
1664 Delete accounts that haven't been upgraded from the 'temporary' category
1665 Returns the number of removed patrons
1669 sub DeleteExpiredOpacRegistrations {
1671 my $delay = C4::Context->preference('PatronSelfRegistrationExpireTemporaryAccountsDelay');
1672 my $category_code = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
1674 return 0 if not $category_code or not defined $delay or $delay eq q||;
1677 SELECT borrowernumber
1679 WHERE categorycode = ? AND DATEDIFF( NOW(), dateenrolled ) > ? |;
1681 my $dbh = C4::Context->dbh;
1682 my $sth = $dbh->prepare($query);
1683 $sth->execute( $category_code, $delay );
1685 while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
1686 Koha::Patrons->find($borrowernumber)->delete;
1692 =head2 DeleteUnverifiedOpacRegistrations
1694 Delete all unverified self registrations in borrower_modifications,
1695 older than the specified number of days.
1699 sub DeleteUnverifiedOpacRegistrations {
1701 my $dbh = C4::Context->dbh;
1703 DELETE FROM borrower_modifications
1704 WHERE borrowernumber = 0 AND DATEDIFF( NOW(), timestamp ) > ?|;
1705 my $cnt=$dbh->do($sql, undef, ($days) );
1706 return $cnt eq '0E0'? 0: $cnt;
1709 sub GetOverduesForPatron {
1710 my ( $borrowernumber ) = @_;
1714 FROM issues, items, biblio, biblioitems
1715 WHERE items.itemnumber=issues.itemnumber
1716 AND biblio.biblionumber = items.biblionumber
1717 AND biblio.biblionumber = biblioitems.biblionumber
1718 AND issues.borrowernumber = ?
1719 AND date_due < NOW()
1722 my $sth = C4::Context->dbh->prepare( $sql );
1723 $sth->execute( $borrowernumber );
1725 return $sth->fetchall_arrayref({});
1728 END { } # module clean-up code here (global destructor)