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;
65 &GetMemberIssuesAndFines
69 &GetFirstValidEmailAddress
70 &GetNoticeEmailAddress
72 &GetMemberAccountRecords
73 &GetBorNotifyAcctRecord
75 &GetBorrowersToExpunge
76 &GetBorrowersWhoHaveNeverBorrowed
77 &GetBorrowersWithIssuesHistoryOlderThan
79 &GetUpcomingMembershipExpires
112 C4::Members - Perl Module containing convenience functions for member handling
120 This module contains routines for adding, modifying and deleting members/patrons/borrowers
126 $flags = &patronflags($patron);
128 This function is not exported.
130 The following will be set where applicable:
131 $flags->{CHARGES}->{amount} Amount of debt
132 $flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge)
133 $flags->{CHARGES}->{message} Message -- deprecated
135 $flags->{CREDITS}->{amount} Amount of credit
136 $flags->{CREDITS}->{message} Message -- deprecated
138 $flags->{ GNA } Patron has no valid address
139 $flags->{ GNA }->{noissues} Set for each GNA
140 $flags->{ GNA }->{message} "Borrower has no valid address" -- deprecated
142 $flags->{ LOST } Patron's card reported lost
143 $flags->{ LOST }->{noissues} Set for each LOST
144 $flags->{ LOST }->{message} Message -- deprecated
146 $flags->{DBARRED} Set if patron debarred, no access
147 $flags->{DBARRED}->{noissues} Set for each DBARRED
148 $flags->{DBARRED}->{message} Message -- deprecated
151 $flags->{ NOTES }->{message} The note itself. NOT deprecated
153 $flags->{ ODUES } Set if patron has overdue books.
154 $flags->{ ODUES }->{message} "Yes" -- deprecated
155 $flags->{ ODUES }->{itemlist} ref-to-array: list of overdue books
156 $flags->{ ODUES }->{itemlisttext} Text list of overdue items -- deprecated
158 $flags->{WAITING} Set if any of patron's reserves are available
159 $flags->{WAITING}->{message} Message -- deprecated
160 $flags->{WAITING}->{itemlist} ref-to-array: list of available items
164 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
165 overdue items. Its elements are references-to-hash, each describing an
166 overdue item. The keys are selected fields from the issues, biblio,
167 biblioitems, and items tables of the Koha database.
169 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
170 the overdue items, one per line. Deprecated.
172 =item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
173 available items. Each element is a reference-to-hash whose keys are
174 fields from the reserves table of the Koha database.
178 All the "message" fields that include language generated in this function are deprecated,
179 because such strings belong properly in the display layer.
181 The "message" field that comes from the DB is OK.
185 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
186 # FIXME rename this function.
189 my ( $patroninformation) = @_;
190 my $dbh=C4::Context->dbh;
191 my ($balance, $owing) = GetMemberAccountBalance( $patroninformation->{'borrowernumber'});
194 my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
195 $flaginfo{'message'} = sprintf 'Patron owes %.02f', $owing;
196 $flaginfo{'amount'} = sprintf "%.02f", $owing;
197 if ( $owing > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
198 $flaginfo{'noissues'} = 1;
200 $flags{'CHARGES'} = \%flaginfo;
202 elsif ( $balance < 0 ) {
204 $flaginfo{'message'} = sprintf 'Patron has credit of %.02f', -$balance;
205 $flaginfo{'amount'} = sprintf "%.02f", $balance;
206 $flags{'CREDITS'} = \%flaginfo;
209 # Check the debt of the guarntees of this patron
210 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
211 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
212 if ( defined $no_issues_charge_guarantees ) {
213 my $p = Koha::Patrons->find( $patroninformation->{borrowernumber} );
214 my @guarantees = $p->guarantees();
215 my $guarantees_non_issues_charges;
216 foreach my $g ( @guarantees ) {
217 my ( $b, $n, $o ) = C4::Members::GetMemberAccountBalance( $g->id );
218 $guarantees_non_issues_charges += $n;
221 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
223 $flaginfo{'message'} = sprintf 'patron guarantees owe %.02f', $guarantees_non_issues_charges;
224 $flaginfo{'amount'} = $guarantees_non_issues_charges;
225 $flaginfo{'noissues'} = 1 unless C4::Context->preference("allowfineoverride");
226 $flags{'CHARGES_GUARANTEES'} = \%flaginfo;
230 if ( $patroninformation->{'gonenoaddress'}
231 && $patroninformation->{'gonenoaddress'} == 1 )
234 $flaginfo{'message'} = 'Borrower has no valid address.';
235 $flaginfo{'noissues'} = 1;
236 $flags{'GNA'} = \%flaginfo;
238 if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
240 $flaginfo{'message'} = 'Borrower\'s card reported lost.';
241 $flaginfo{'noissues'} = 1;
242 $flags{'LOST'} = \%flaginfo;
244 if ( $patroninformation->{'debarred'} && check_date( split( /-/, $patroninformation->{'debarred'} ) ) ) {
245 if ( Date_to_Days(Date::Calc::Today) < Date_to_Days( split( /-/, $patroninformation->{'debarred'} ) ) ) {
247 $flaginfo{'debarredcomment'} = $patroninformation->{'debarredcomment'};
248 $flaginfo{'message'} = $patroninformation->{'debarredcomment'};
249 $flaginfo{'noissues'} = 1;
250 $flaginfo{'dateend'} = $patroninformation->{'debarred'};
251 $flags{'DBARRED'} = \%flaginfo;
254 if ( $patroninformation->{'borrowernotes'}
255 && $patroninformation->{'borrowernotes'} )
258 $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
259 $flags{'NOTES'} = \%flaginfo;
261 my ( $odues, $itemsoverdue ) = C4::Overdues::checkoverdues($patroninformation->{'borrowernumber'});
262 if ( $odues && $odues > 0 ) {
264 $flaginfo{'message'} = "Yes";
265 $flaginfo{'itemlist'} = $itemsoverdue;
266 foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
269 $flaginfo{'itemlisttext'} .=
270 "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n"; # newline is display layer
272 $flags{'ODUES'} = \%flaginfo;
274 my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
275 my $nowaiting = scalar @itemswaiting;
276 if ( $nowaiting > 0 ) {
278 $flaginfo{'message'} = "Reserved items available";
279 $flaginfo{'itemlist'} = \@itemswaiting;
280 $flags{'WAITING'} = \%flaginfo;
288 $borrower = &GetMember(%information);
290 Retrieve the first patron record meeting on criteria listed in the
291 C<%information> hash, which should contain one or more
292 pairs of borrowers column names and values, e.g.,
294 $borrower = GetMember(borrowernumber => id);
296 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
297 the C<borrowers> table in the Koha database.
299 FIXME: GetMember() is used throughout the code as a lookup
300 on a unique key such as the borrowernumber, but this meaning is not
301 enforced in the routine itself.
307 my ( %information ) = @_;
308 if (exists $information{borrowernumber} && !defined $information{borrowernumber}) {
309 #passing mysql's kohaadmin?? Makes no sense as a query
312 my $dbh = C4::Context->dbh;
314 q{SELECT borrowers.*, categories.category_type, categories.description
316 LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
319 for (keys %information ) {
327 if (defined $information{$_}) {
329 push @values, $information{$_};
332 $select .= "$_ IS NULL";
335 $debug && warn $select, " ",values %information;
336 my $sth = $dbh->prepare("$select");
337 $sth->execute(@values);
338 my $data = $sth->fetchall_arrayref({});
339 #FIXME interface to this routine now allows generation of a result set
340 #so whole array should be returned but bowhere in the current code expects this
348 =head2 GetMemberIssuesAndFines
350 ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
352 Returns aggregate data about items borrowed by the patron with the
353 given borrowernumber.
355 C<&GetMemberIssuesAndFines> returns a three-element array. C<$overdue_count> is the
356 number of overdue items the patron currently has borrowed. C<$issue_count> is the
357 number of books the patron currently has borrowed. C<$total_fines> is
358 the total fine currently due by the borrower.
363 sub GetMemberIssuesAndFines {
364 my ( $borrowernumber ) = @_;
365 my $dbh = C4::Context->dbh;
366 my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
368 $debug and warn $query."\n";
369 my $sth = $dbh->prepare($query);
370 $sth->execute($borrowernumber);
371 my $issue_count = $sth->fetchrow_arrayref->[0];
373 $sth = $dbh->prepare(
374 "SELECT COUNT(*) FROM issues
375 WHERE borrowernumber = ?
376 AND date_due < now()"
378 $sth->execute($borrowernumber);
379 my $overdue_count = $sth->fetchrow_arrayref->[0];
381 $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
382 $sth->execute($borrowernumber);
383 my $total_fines = $sth->fetchrow_arrayref->[0];
385 return ($overdue_count, $issue_count, $total_fines);
391 my $success = ModMember(borrowernumber => $borrowernumber,
392 [ field => value ]... );
394 Modify borrower's data. All date fields should ALREADY be in ISO format.
397 true on success, or false on failure
403 # test to know if you must update or not the borrower password
404 if (exists $data{password}) {
405 if ($data{password} eq '****' or $data{password} eq '') {
406 delete $data{password};
408 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
409 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
410 Koha::NorwegianPatronDB::NLUpdateHashedPIN( $data{'borrowernumber'}, $data{password} );
412 $data{password} = hash_password($data{password});
416 my $old_categorycode = Koha::Patrons->find( $data{borrowernumber} )->categorycode;
418 # get only the columns of a borrower
419 my $schema = Koha::Database->new()->schema;
420 my @columns = $schema->source('Borrower')->columns;
421 my $new_borrower = { map { join(' ', @columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) };
423 $new_borrower->{dateofbirth} ||= undef if exists $new_borrower->{dateofbirth};
424 $new_borrower->{dateenrolled} ||= undef if exists $new_borrower->{dateenrolled};
425 $new_borrower->{dateexpiry} ||= undef if exists $new_borrower->{dateexpiry};
426 $new_borrower->{debarred} ||= undef if exists $new_borrower->{debarred};
427 $new_borrower->{sms_provider_id} ||= undef if exists $new_borrower->{sms_provider_id};
428 $new_borrower->{guarantorid} ||= undef if exists $new_borrower->{guarantorid};
430 my $patron = Koha::Patrons->find( $new_borrower->{borrowernumber} );
432 delete $new_borrower->{userid} if exists $new_borrower->{userid} and not $new_borrower->{userid};
434 my $execute_success = $patron->store if $patron->set($new_borrower);
436 if ($execute_success) { # only proceed if the update was a success
437 # If the patron changes to a category with enrollment fee, we add a fee
438 if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
439 if ( C4::Context->preference('FeeOnChangePatronCategory') ) {
440 $patron->add_enrolment_fee_if_needed;
444 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
445 # cronjob will use for syncing with NL
446 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
447 my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
448 'synctype' => 'norwegianpatrondb',
449 'borrowernumber' => $data{'borrowernumber'}
451 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
452 # we can sync as changed. And the "new sync" will pick up all changes since
453 # the patron was created anyway.
454 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
455 $borrowersync->update( { 'syncstatus' => 'edited' } );
457 # Set the value of 'sync'
458 $borrowersync->update( { 'sync' => $data{'sync'} } );
459 # Try to do the live sync
460 Koha::NorwegianPatronDB::NLSync({ 'borrowernumber' => $data{'borrowernumber'} });
463 logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
465 return $execute_success;
470 $borrowernumber = &AddMember(%borrower);
472 insert new borrower into table
474 (%borrower keys are database columns. Database columns could be
475 different in different versions. Please look into database for correct
478 Returns the borrowernumber upon success
480 Returns as undef upon any db error without further processing
487 my $dbh = C4::Context->dbh;
488 my $schema = Koha::Database->new()->schema;
490 # generate a proper login if none provided
491 $data{'userid'} = Generate_Userid( $data{'borrowernumber'}, $data{'firstname'}, $data{'surname'} )
492 if ( $data{'userid'} eq '' || !Check_Userid( $data{'userid'} ) );
494 # add expiration date if it isn't already there
495 $data{dateexpiry} ||= Koha::Patron::Categories->find( $data{categorycode} )->get_expiry_date;
497 # add enrollment date if it isn't already there
498 unless ( $data{'dateenrolled'} ) {
499 $data{'dateenrolled'} = output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
502 my $patron_category = $schema->resultset('Category')->find( $data{'categorycode'} );
504 $patron_category->default_privacy() eq 'default' ? 1
505 : $patron_category->default_privacy() eq 'never' ? 2
506 : $patron_category->default_privacy() eq 'forever' ? 0
509 $data{'privacy_guarantor_checkouts'} = 0 unless defined( $data{'privacy_guarantor_checkouts'} );
511 # Make a copy of the plain text password for later use
512 my $plain_text_password = $data{'password'};
514 # create a disabled account if no password provided
515 $data{'password'} = ($data{'password'})? hash_password($data{'password'}) : '!';
517 # we don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00
518 $data{'dateofbirth'} = undef if ( not $data{'dateofbirth'} );
519 $data{'debarred'} = undef if ( not $data{'debarred'} );
520 $data{'sms_provider_id'} = undef if ( not $data{'sms_provider_id'} );
522 # get only the columns of Borrower
523 # FIXME Do we really need this check?
524 my @columns = $schema->source('Borrower')->columns;
525 my $new_member = { map { join(' ',@columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) } ;
527 delete $new_member->{borrowernumber};
529 my $patron = Koha::Patron->new( $new_member )->store;
530 $data{borrowernumber} = $patron->borrowernumber;
532 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
533 # cronjob will use for syncing with NL
534 if ( exists $data{'borrowernumber'} && C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
535 Koha::Database->new->schema->resultset('BorrowerSync')->create({
536 'borrowernumber' => $data{'borrowernumber'},
537 'synctype' => 'norwegianpatrondb',
539 'syncstatus' => 'new',
540 'hashed_pin' => Koha::NorwegianPatronDB::NLEncryptPIN( $plain_text_password ),
544 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
546 $patron->add_enrolment_fee_if_needed;
548 return $data{borrowernumber};
553 my $uniqueness = Check_Userid($userid,$borrowernumber);
555 $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 != '').
557 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.
560 0 for not unique (i.e. this $userid already exists)
561 1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
566 my ( $uid, $borrowernumber ) = @_;
568 return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
570 return 0 if ( $uid eq C4::Context->config('user') );
572 my $rs = Koha::Database->new()->schema()->resultset('Borrower');
575 $params->{userid} = $uid;
576 $params->{borrowernumber} = { '!=' => $borrowernumber } if ($borrowernumber);
578 my $count = $rs->count( $params );
580 return $count ? 0 : 1;
583 =head2 Generate_Userid
585 my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
587 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
589 $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.
592 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).
596 sub Generate_Userid {
597 my ($borrowernumber, $firstname, $surname) = @_;
600 #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
602 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
603 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
604 $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
605 $newuid = unac_string('utf-8',$newuid);
606 $newuid .= $offset unless $offset == 0;
609 } while (!Check_Userid($newuid,$borrowernumber));
614 =head2 fixup_cardnumber
616 Warning: The caller is responsible for locking the members table in write
617 mode, to avoid database corruption.
621 use vars qw( @weightings );
622 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
624 sub fixup_cardnumber {
625 my ($cardnumber) = @_;
626 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
628 # Find out whether member numbers should be generated
629 # automatically. Should be either "1" or something else.
630 # Defaults to "0", which is interpreted as "no".
632 # if ($cardnumber !~ /\S/ && $autonumber_members) {
633 ($autonumber_members) or return $cardnumber;
634 my $checkdigit = C4::Context->preference('checkdigit');
635 my $dbh = C4::Context->dbh;
636 if ( $checkdigit and $checkdigit eq 'katipo' ) {
638 # if checkdigit is selected, calculate katipo-style cardnumber.
639 # otherwise, just use the max()
640 # purpose: generate checksum'd member numbers.
641 # We'll assume we just got the max value of digits 2-8 of member #'s
642 # from the database and our job is to increment that by one,
643 # determine the 1st and 9th digits and return the full string.
644 my $sth = $dbh->prepare(
645 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
648 my $data = $sth->fetchrow_hashref;
649 $cardnumber = $data->{new_num};
650 if ( !$cardnumber ) { # If DB has no values,
651 $cardnumber = 1000000; # start at 1000000
657 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
658 # read weightings, left to right, 1 char at a time
659 my $temp1 = $weightings[$i];
661 # sequence left to right, 1 char at a time
662 my $temp2 = substr( $cardnumber, $i, 1 );
664 # mult each char 1-7 by its corresponding weighting
665 $sum += $temp1 * $temp2;
668 my $rem = ( $sum % 11 );
669 $rem = 'X' if $rem == 10;
671 return "V$cardnumber$rem";
674 my $sth = $dbh->prepare(
675 'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
678 my ($result) = $sth->fetchrow;
681 return $cardnumber; # just here as a fallback/reminder
684 =head2 GetPendingIssues
686 my $issues = &GetPendingIssues(@borrowernumber);
688 Looks up what the patron with the given borrowernumber has borrowed.
690 C<&GetPendingIssues> returns a
691 reference-to-array where each element is a reference-to-hash; the
692 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
693 The keys include C<biblioitems> fields except marc and marcxml.
697 sub GetPendingIssues {
698 my @borrowernumbers = @_;
700 unless (@borrowernumbers ) { # return a ref_to_array
701 return \@borrowernumbers; # to not cause surprise to caller
704 # Borrowers part of the query
706 for (my $i = 0; $i < @borrowernumbers; $i++) {
707 $bquery .= ' issues.borrowernumber = ?';
708 if ($i < $#borrowernumbers ) {
713 # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
714 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
715 # FIXME: circ/ciculation.pl tries to sort by timestamp!
716 # FIXME: namespace collision: other collisions possible.
717 # FIXME: most of this data isn't really being used by callers.
724 biblioitems.itemtype,
727 biblioitems.publicationyear,
728 biblioitems.publishercode,
729 biblioitems.volumedate,
730 biblioitems.volumedesc,
735 borrowers.cardnumber,
736 issues.timestamp AS timestamp,
737 issues.renewals AS renewals,
738 issues.borrowernumber AS borrowernumber,
739 items.renewals AS totalrenewals
741 LEFT JOIN items ON items.itemnumber = issues.itemnumber
742 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
743 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
744 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
747 ORDER BY issues.issuedate"
750 my $sth = C4::Context->dbh->prepare($query);
751 $sth->execute(@borrowernumbers);
752 my $data = $sth->fetchall_arrayref({});
753 my $today = dt_from_string;
755 if ($_->{issuedate}) {
756 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
758 $_->{date_due_sql} = $_->{date_due};
759 # FIXME no need to have this value
760 $_->{date_due} or next;
761 $_->{date_due_sql} = $_->{date_due};
762 # FIXME no need to have this value
763 $_->{date_due} = dt_from_string($_->{date_due}, 'sql');
764 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
773 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
775 Looks up what the patron with the given borrowernumber has borrowed,
776 and sorts the results.
778 C<$sortkey> is the name of a field on which to sort the results. This
779 should be the name of a field in the C<issues>, C<biblio>,
780 C<biblioitems>, or C<items> table in the Koha database.
782 C<$limit> is the maximum number of results to return.
784 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
785 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
786 C<items> tables of the Koha database.
792 my ( $borrowernumber, $order, $limit ) = @_;
794 return unless $borrowernumber;
795 $order = 'date_due desc' unless $order;
797 my $dbh = C4::Context->dbh;
799 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
801 LEFT JOIN items on items.itemnumber=issues.itemnumber
802 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
803 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
804 WHERE borrowernumber=?
806 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
808 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
809 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
810 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
811 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
814 $query .= " limit $limit";
817 my $sth = $dbh->prepare($query);
818 $sth->execute( $borrowernumber, $borrowernumber );
819 return $sth->fetchall_arrayref( {} );
823 =head2 GetMemberAccountRecords
825 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
827 Looks up accounting data for the patron with the given borrowernumber.
829 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
830 reference-to-array, where each element is a reference-to-hash; the
831 keys are the fields of the C<accountlines> table in the Koha database.
832 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
833 total amount outstanding for all of the account lines.
837 sub GetMemberAccountRecords {
838 my ($borrowernumber) = @_;
839 my $dbh = C4::Context->dbh;
845 WHERE borrowernumber=?);
846 $strsth.=" ORDER BY accountlines_id desc";
847 my $sth= $dbh->prepare( $strsth );
848 $sth->execute( $borrowernumber );
851 while ( my $data = $sth->fetchrow_hashref ) {
852 if ( $data->{itemnumber} ) {
853 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
854 $data->{biblionumber} = $biblio->{biblionumber};
855 $data->{title} = $biblio->{title};
857 $acctlines[$numlines] = $data;
859 $total += sprintf "%.0f", 1000*$data->{amountoutstanding}; # convert float to integer to avoid round-off errors
862 return ( $total, \@acctlines,$numlines);
865 =head2 GetMemberAccountBalance
867 ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
869 Calculates amount immediately owing by the patron - non-issue charges.
870 Based on GetMemberAccountRecords.
871 Charges exempt from non-issue are:
873 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
874 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
878 sub GetMemberAccountBalance {
879 my ($borrowernumber) = @_;
881 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
884 push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
885 push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
886 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
887 my $dbh = C4::Context->dbh;
888 my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
889 push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
891 my %not_fine = map {$_ => 1} @not_fines;
893 my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
894 my $other_charges = 0;
895 foreach (@$acctlines) {
896 $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
899 return ( $total, $total - $other_charges, $other_charges);
902 =head2 GetBorNotifyAcctRecord
904 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
906 Looks up accounting data for the patron with the given borrowernumber per file number.
908 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
909 reference-to-array, where each element is a reference-to-hash; the
910 keys are the fields of the C<accountlines> table in the Koha database.
911 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
912 total amount outstanding for all of the account lines.
916 sub GetBorNotifyAcctRecord {
917 my ( $borrowernumber, $notifyid ) = @_;
918 my $dbh = C4::Context->dbh;
921 my $sth = $dbh->prepare(
924 WHERE borrowernumber=?
926 AND amountoutstanding != '0'
927 ORDER BY notify_id,accounttype
930 $sth->execute( $borrowernumber, $notifyid );
932 while ( my $data = $sth->fetchrow_hashref ) {
933 if ( $data->{itemnumber} ) {
934 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
935 $data->{biblionumber} = $biblio->{biblionumber};
936 $data->{title} = $biblio->{title};
938 $acctlines[$numlines] = $data;
940 $total += int(100 * $data->{'amountoutstanding'});
943 return ( $total, \@acctlines, $numlines );
946 sub checkcardnumber {
947 my ( $cardnumber, $borrowernumber ) = @_;
949 # If cardnumber is null, we assume they're allowed.
950 return 0 unless defined $cardnumber;
952 my $dbh = C4::Context->dbh;
953 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
954 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
955 my $sth = $dbh->prepare($query);
958 ( $borrowernumber ? $borrowernumber : () )
961 return 1 if $sth->fetchrow_hashref;
963 my ( $min_length, $max_length ) = get_cardnumber_length();
965 if length $cardnumber > $max_length
966 or length $cardnumber < $min_length;
971 =head2 get_cardnumber_length
973 my ($min, $max) = C4::Members::get_cardnumber_length()
975 Returns the minimum and maximum length for patron cardnumbers as
976 determined by the CardnumberLength system preference, the
977 BorrowerMandatoryField system preference, and the width of the
982 sub get_cardnumber_length {
983 my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
984 $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
985 if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
986 # Is integer and length match
987 if ( $cardnumber_length =~ m|^\d+$| ) {
988 $min = $max = $cardnumber_length
989 if $cardnumber_length >= $min
990 and $cardnumber_length <= $max;
992 # Else assuming it is a range
993 elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
994 $min = $1 if $1 and $min < $1;
995 $max = $2 if $2 and $max > $2;
999 my $borrower = Koha::Schema->resultset('Borrower');
1000 my $field_size = $borrower->result_source->column_info('cardnumber')->{size};
1001 $min = $field_size if $min > $field_size;
1002 return ( $min, $max );
1005 =head2 GetFirstValidEmailAddress
1007 $email = GetFirstValidEmailAddress($borrowernumber);
1009 Return the first valid email address for a borrower, given the borrowernumber. For now, the order
1010 is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
1015 sub GetFirstValidEmailAddress {
1016 my $borrowernumber = shift;
1017 my $dbh = C4::Context->dbh;
1018 my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1019 $sth->execute( $borrowernumber );
1020 my $data = $sth->fetchrow_hashref;
1022 if ($data->{'email'}) {
1023 return $data->{'email'};
1024 } elsif ($data->{'emailpro'}) {
1025 return $data->{'emailpro'};
1026 } elsif ($data->{'B_email'}) {
1027 return $data->{'B_email'};
1033 =head2 GetNoticeEmailAddress
1035 $email = GetNoticeEmailAddress($borrowernumber);
1037 Return the email address of borrower used for notices, given the borrowernumber.
1038 Returns the empty string if no email address.
1042 sub GetNoticeEmailAddress {
1043 my $borrowernumber = shift;
1045 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1046 # if syspref is set to 'first valid' (value == OFF), look up email address
1047 if ( $which_address eq 'OFF' ) {
1048 return GetFirstValidEmailAddress($borrowernumber);
1050 # specified email address field
1051 my $dbh = C4::Context->dbh;
1052 my $sth = $dbh->prepare( qq{
1053 SELECT $which_address AS primaryemail
1055 WHERE borrowernumber=?
1057 $sth->execute($borrowernumber);
1058 my $data = $sth->fetchrow_hashref;
1059 return $data->{'primaryemail'} || '';
1062 =head2 GetUpcomingMembershipExpires
1064 my $expires = GetUpcomingMembershipExpires({
1065 branch => $branch, before => $before, after => $after,
1068 $branch is an optional branch code.
1069 $before/$after is an optional number of days before/after the date that
1070 is set by the preference MembershipExpiryDaysNotice.
1071 If the pref would be 14, before 2 and after 3, you will get all expires
1076 sub GetUpcomingMembershipExpires {
1077 my ( $params ) = @_;
1078 my $before = $params->{before} || 0;
1079 my $after = $params->{after} || 0;
1080 my $branch = $params->{branch};
1082 my $dbh = C4::Context->dbh;
1083 my $days = C4::Context->preference("MembershipExpiryDaysNotice") || 0;
1084 my $date1 = dt_from_string->add( days => $days - $before );
1085 my $date2 = dt_from_string->add( days => $days + $after );
1086 $date1= output_pref({ dt => $date1, dateformat => 'iso', dateonly => 1 });
1087 $date2= output_pref({ dt => $date2, dateformat => 'iso', dateonly => 1 });
1090 SELECT borrowers.*, categories.description,
1091 branches.branchname, branches.branchemail FROM borrowers
1092 LEFT JOIN branches USING (branchcode)
1093 LEFT JOIN categories USING (categorycode)
1096 $query.= 'WHERE branchcode=? AND dateexpiry BETWEEN ? AND ?';
1098 $query.= 'WHERE dateexpiry BETWEEN ? AND ?';
1101 my $sth = $dbh->prepare( $query );
1102 my @pars = $branch? ( $branch ): ();
1103 push @pars, $date1, $date2;
1104 $sth->execute( @pars );
1105 my $results = $sth->fetchall_arrayref( {} );
1109 =head2 GetBorrowersToExpunge
1111 $borrowers = &GetBorrowersToExpunge(
1112 not_borrowed_since => $not_borrowed_since,
1113 expired_before => $expired_before,
1114 category_code => $category_code,
1115 patron_list_id => $patron_list_id,
1116 branchcode => $branchcode
1119 This function get all borrowers based on the given criteria.
1123 sub GetBorrowersToExpunge {
1126 my $filterdate = $params->{'not_borrowed_since'};
1127 my $filterexpiry = $params->{'expired_before'};
1128 my $filterlastseen = $params->{'last_seen'};
1129 my $filtercategory = $params->{'category_code'};
1130 my $filterbranch = $params->{'branchcode'} ||
1131 ((C4::Context->preference('IndependentBranches')
1132 && C4::Context->userenv
1133 && !C4::Context->IsSuperLibrarian()
1134 && C4::Context->userenv->{branch})
1135 ? C4::Context->userenv->{branch}
1137 my $filterpatronlist = $params->{'patron_list_id'};
1139 my $dbh = C4::Context->dbh;
1141 SELECT borrowers.borrowernumber,
1142 MAX(old_issues.timestamp) AS latestissue,
1143 MAX(issues.timestamp) AS currentissue
1145 JOIN categories USING (categorycode)
1149 WHERE guarantorid IS NOT NULL
1150 AND guarantorid <> 0
1151 ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
1152 LEFT JOIN old_issues USING (borrowernumber)
1153 LEFT JOIN issues USING (borrowernumber)|;
1154 if ( $filterpatronlist ){
1155 $query .= q| LEFT JOIN patron_list_patrons USING (borrowernumber)|;
1157 $query .= q| WHERE category_type <> 'S'
1158 AND tmp.guarantorid IS NULL
1161 if ( $filterbranch && $filterbranch ne "" ) {
1162 $query.= " AND borrowers.branchcode = ? ";
1163 push( @query_params, $filterbranch );
1165 if ( $filterexpiry ) {
1166 $query .= " AND dateexpiry < ? ";
1167 push( @query_params, $filterexpiry );
1169 if ( $filterlastseen ) {
1170 $query .= ' AND lastseen < ? ';
1171 push @query_params, $filterlastseen;
1173 if ( $filtercategory ) {
1174 $query .= " AND categorycode = ? ";
1175 push( @query_params, $filtercategory );
1177 if ( $filterpatronlist ){
1178 $query.=" AND patron_list_id = ? ";
1179 push( @query_params, $filterpatronlist );
1181 $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
1182 if ( $filterdate ) {
1183 $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
1184 push @query_params,$filterdate;
1186 warn $query if $debug;
1188 my $sth = $dbh->prepare($query);
1189 if (scalar(@query_params)>0){
1190 $sth->execute(@query_params);
1197 while ( my $data = $sth->fetchrow_hashref ) {
1198 push @results, $data;
1203 =head2 GetBorrowersWhoHaveNeverBorrowed
1205 $results = &GetBorrowersWhoHaveNeverBorrowed
1207 This function get all borrowers who have never borrowed.
1209 I<$result> is a ref to an array which all elements are a hasref.
1213 sub GetBorrowersWhoHaveNeverBorrowed {
1214 my $filterbranch = shift ||
1215 ((C4::Context->preference('IndependentBranches')
1216 && C4::Context->userenv
1217 && !C4::Context->IsSuperLibrarian()
1218 && C4::Context->userenv->{branch})
1219 ? C4::Context->userenv->{branch}
1221 my $dbh = C4::Context->dbh;
1223 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
1225 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
1226 WHERE issues.borrowernumber IS NULL
1229 if ($filterbranch && $filterbranch ne ""){
1230 $query.=" AND borrowers.branchcode= ?";
1231 push @query_params,$filterbranch;
1233 warn $query if $debug;
1235 my $sth = $dbh->prepare($query);
1236 if (scalar(@query_params)>0){
1237 $sth->execute(@query_params);
1244 while ( my $data = $sth->fetchrow_hashref ) {
1245 push @results, $data;
1250 =head2 GetBorrowersWithIssuesHistoryOlderThan
1252 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
1254 this function get all borrowers who has an issue history older than I<$date> given on input arg.
1256 I<$result> is a ref to an array which all elements are a hashref.
1257 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1261 sub GetBorrowersWithIssuesHistoryOlderThan {
1262 my $dbh = C4::Context->dbh;
1263 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
1264 my $filterbranch = shift ||
1265 ((C4::Context->preference('IndependentBranches')
1266 && C4::Context->userenv
1267 && !C4::Context->IsSuperLibrarian()
1268 && C4::Context->userenv->{branch})
1269 ? C4::Context->userenv->{branch}
1272 SELECT count(borrowernumber) as n,borrowernumber
1274 WHERE returndate < ?
1275 AND borrowernumber IS NOT NULL
1278 push @query_params, $date;
1280 $query.=" AND branchcode = ?";
1281 push @query_params, $filterbranch;
1283 $query.=" GROUP BY borrowernumber ";
1284 warn $query if $debug;
1285 my $sth = $dbh->prepare($query);
1286 $sth->execute(@query_params);
1289 while ( my $data = $sth->fetchrow_hashref ) {
1290 push @results, $data;
1297 IssueSlip($branchcode, $borrowernumber, $quickslip)
1299 Returns letter hash ( see C4::Letters::GetPreparedLetter )
1301 $quickslip is boolean, to indicate whether we want a quick slip
1303 IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
1339 NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
1344 my ($branch, $borrowernumber, $quickslip) = @_;
1346 # FIXME Check callers before removing this statement
1347 #return unless $borrowernumber;
1349 my @issues = @{ GetPendingIssues($borrowernumber) };
1351 for my $issue (@issues) {
1352 $issue->{date_due} = $issue->{date_due_sql};
1354 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
1355 if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
1356 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
1362 # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
1364 my $s = $b->{timestamp} <=> $a->{timestamp};
1366 $b->{issuedate} <=> $a->{issuedate} : $s;
1369 my ($letter_code, %repeat);
1371 $letter_code = 'ISSUEQSLIP';
1373 'checkedout' => [ map {
1376 'biblioitems' => $_,
1378 }, grep { $_->{'now'} } @issues ],
1382 $letter_code = 'ISSUESLIP';
1384 'checkedout' => [ map {
1387 'biblioitems' => $_,
1389 }, grep { !$_->{'overdue'} } @issues ],
1391 'overdue' => [ map {
1394 'biblioitems' => $_,
1396 }, grep { $_->{'overdue'} } @issues ],
1399 $_->{'timestamp'} = $_->{'newdate'};
1401 } @{ GetNewsToDisplay("slip",$branch) } ],
1405 return C4::Letters::GetPreparedLetter (
1406 module => 'circulation',
1407 letter_code => $letter_code,
1408 branchcode => $branch,
1410 'branches' => $branch,
1411 'borrowers' => $borrowernumber,
1417 =head2 GetBorrowersWithEmail
1419 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
1421 This gets a list of users and their basic details from their email address.
1422 As it's possible for multiple user to have the same email address, it provides
1423 you with all of them. If there is no userid for the user, there will be an
1424 C<undef> there. An empty list will be returned if there are no matches.
1428 sub GetBorrowersWithEmail {
1431 my $dbh = C4::Context->dbh;
1433 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
1434 my $sth=$dbh->prepare($query);
1435 $sth->execute($email);
1437 while (my $ref = $sth->fetch) {
1440 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
1444 =head2 AddMember_Opac
1448 sub AddMember_Opac {
1449 my ( %borrower ) = @_;
1451 $borrower{'categorycode'} //= C4::Context->preference('PatronSelfRegistrationDefaultCategory');
1452 if (not defined $borrower{'password'}){
1453 my $sr = new String::Random;
1454 $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
1455 my $password = $sr->randpattern("AAAAAAAAAA");
1456 $borrower{'password'} = $password;
1459 $borrower{'cardnumber'} = fixup_cardnumber( $borrower{'cardnumber'} );
1461 my $borrowernumber = AddMember(%borrower);
1463 return ( $borrowernumber, $borrower{'password'} );
1466 =head2 DeleteExpiredOpacRegistrations
1468 Delete accounts that haven't been upgraded from the 'temporary' category
1469 Returns the number of removed patrons
1473 sub DeleteExpiredOpacRegistrations {
1475 my $delay = C4::Context->preference('PatronSelfRegistrationExpireTemporaryAccountsDelay');
1476 my $category_code = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
1478 return 0 if not $category_code or not defined $delay or $delay eq q||;
1481 SELECT borrowernumber
1483 WHERE categorycode = ? AND DATEDIFF( NOW(), dateenrolled ) > ? |;
1485 my $dbh = C4::Context->dbh;
1486 my $sth = $dbh->prepare($query);
1487 $sth->execute( $category_code, $delay );
1489 while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
1490 Koha::Patrons->find($borrowernumber)->delete;
1496 =head2 DeleteUnverifiedOpacRegistrations
1498 Delete all unverified self registrations in borrower_modifications,
1499 older than the specified number of days.
1503 sub DeleteUnverifiedOpacRegistrations {
1505 my $dbh = C4::Context->dbh;
1507 DELETE FROM borrower_modifications
1508 WHERE borrowernumber = 0 AND DATEDIFF( NOW(), timestamp ) > ?|;
1509 my $cnt=$dbh->do($sql, undef, ($days) );
1510 return $cnt eq '0E0'? 0: $cnt;
1513 sub GetOverduesForPatron {
1514 my ( $borrowernumber ) = @_;
1518 FROM issues, items, biblio, biblioitems
1519 WHERE items.itemnumber=issues.itemnumber
1520 AND biblio.biblionumber = items.biblionumber
1521 AND biblio.biblionumber = biblioitems.biblionumber
1522 AND issues.borrowernumber = ?
1523 AND date_due < NOW()
1526 my $sth = C4::Context->dbh->prepare( $sql );
1527 $sth->execute( $borrowernumber );
1529 return $sth->fetchall_arrayref({});
1532 END { } # module clean-up code here (global destructor)