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;
68 &GetFirstValidEmailAddress
69 &GetNoticeEmailAddress
71 &GetMemberAccountRecords
72 &GetBorNotifyAcctRecord
74 &GetBorrowersToExpunge
75 &GetBorrowersWithIssuesHistoryOlderThan
108 C4::Members - Perl Module containing convenience functions for member handling
116 This module contains routines for adding, modifying and deleting members/patrons/borrowers
122 $flags = &patronflags($patron);
124 This function is not exported.
126 The following will be set where applicable:
127 $flags->{CHARGES}->{amount} Amount of debt
128 $flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge)
129 $flags->{CHARGES}->{message} Message -- deprecated
131 $flags->{CREDITS}->{amount} Amount of credit
132 $flags->{CREDITS}->{message} Message -- deprecated
134 $flags->{ GNA } Patron has no valid address
135 $flags->{ GNA }->{noissues} Set for each GNA
136 $flags->{ GNA }->{message} "Borrower has no valid address" -- deprecated
138 $flags->{ LOST } Patron's card reported lost
139 $flags->{ LOST }->{noissues} Set for each LOST
140 $flags->{ LOST }->{message} Message -- deprecated
142 $flags->{DBARRED} Set if patron debarred, no access
143 $flags->{DBARRED}->{noissues} Set for each DBARRED
144 $flags->{DBARRED}->{message} Message -- deprecated
147 $flags->{ NOTES }->{message} The note itself. NOT deprecated
149 $flags->{ ODUES } Set if patron has overdue books.
150 $flags->{ ODUES }->{message} "Yes" -- deprecated
151 $flags->{ ODUES }->{itemlist} ref-to-array: list of overdue books
152 $flags->{ ODUES }->{itemlisttext} Text list of overdue items -- deprecated
154 $flags->{WAITING} Set if any of patron's reserves are available
155 $flags->{WAITING}->{message} Message -- deprecated
156 $flags->{WAITING}->{itemlist} ref-to-array: list of available items
160 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
161 overdue items. Its elements are references-to-hash, each describing an
162 overdue item. The keys are selected fields from the issues, biblio,
163 biblioitems, and items tables of the Koha database.
165 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
166 the overdue items, one per line. Deprecated.
168 =item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
169 available items. Each element is a reference-to-hash whose keys are
170 fields from the reserves table of the Koha database.
174 All the "message" fields that include language generated in this function are deprecated,
175 because such strings belong properly in the display layer.
177 The "message" field that comes from the DB is OK.
181 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
182 # FIXME rename this function.
185 my ( $patroninformation) = @_;
186 my $dbh=C4::Context->dbh;
187 my ($balance, $owing) = GetMemberAccountBalance( $patroninformation->{'borrowernumber'});
190 my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
191 $flaginfo{'message'} = sprintf 'Patron owes %.02f', $owing;
192 $flaginfo{'amount'} = sprintf "%.02f", $owing;
193 if ( $owing > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
194 $flaginfo{'noissues'} = 1;
196 $flags{'CHARGES'} = \%flaginfo;
198 elsif ( $balance < 0 ) {
200 $flaginfo{'message'} = sprintf 'Patron has credit of %.02f', -$balance;
201 $flaginfo{'amount'} = sprintf "%.02f", $balance;
202 $flags{'CREDITS'} = \%flaginfo;
205 # Check the debt of the guarntees of this patron
206 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
207 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
208 if ( defined $no_issues_charge_guarantees ) {
209 my $p = Koha::Patrons->find( $patroninformation->{borrowernumber} );
210 my @guarantees = $p->guarantees();
211 my $guarantees_non_issues_charges;
212 foreach my $g ( @guarantees ) {
213 my ( $b, $n, $o ) = C4::Members::GetMemberAccountBalance( $g->id );
214 $guarantees_non_issues_charges += $n;
217 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
219 $flaginfo{'message'} = sprintf 'patron guarantees owe %.02f', $guarantees_non_issues_charges;
220 $flaginfo{'amount'} = $guarantees_non_issues_charges;
221 $flaginfo{'noissues'} = 1 unless C4::Context->preference("allowfineoverride");
222 $flags{'CHARGES_GUARANTEES'} = \%flaginfo;
226 if ( $patroninformation->{'gonenoaddress'}
227 && $patroninformation->{'gonenoaddress'} == 1 )
230 $flaginfo{'message'} = 'Borrower has no valid address.';
231 $flaginfo{'noissues'} = 1;
232 $flags{'GNA'} = \%flaginfo;
234 if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
236 $flaginfo{'message'} = 'Borrower\'s card reported lost.';
237 $flaginfo{'noissues'} = 1;
238 $flags{'LOST'} = \%flaginfo;
240 if ( $patroninformation->{'debarred'} && check_date( split( /-/, $patroninformation->{'debarred'} ) ) ) {
241 if ( Date_to_Days(Date::Calc::Today) < Date_to_Days( split( /-/, $patroninformation->{'debarred'} ) ) ) {
243 $flaginfo{'debarredcomment'} = $patroninformation->{'debarredcomment'};
244 $flaginfo{'message'} = $patroninformation->{'debarredcomment'};
245 $flaginfo{'noissues'} = 1;
246 $flaginfo{'dateend'} = $patroninformation->{'debarred'};
247 $flags{'DBARRED'} = \%flaginfo;
250 if ( $patroninformation->{'borrowernotes'}
251 && $patroninformation->{'borrowernotes'} )
254 $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
255 $flags{'NOTES'} = \%flaginfo;
257 my ( $odues, $itemsoverdue ) = C4::Overdues::checkoverdues($patroninformation->{'borrowernumber'});
258 if ( $odues && $odues > 0 ) {
260 $flaginfo{'message'} = "Yes";
261 $flaginfo{'itemlist'} = $itemsoverdue;
262 foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
265 $flaginfo{'itemlisttext'} .=
266 "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n"; # newline is display layer
268 $flags{'ODUES'} = \%flaginfo;
270 my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
271 my $nowaiting = scalar @itemswaiting;
272 if ( $nowaiting > 0 ) {
274 $flaginfo{'message'} = "Reserved items available";
275 $flaginfo{'itemlist'} = \@itemswaiting;
276 $flags{'WAITING'} = \%flaginfo;
284 $borrower = &GetMember(%information);
286 Retrieve the first patron record meeting on criteria listed in the
287 C<%information> hash, which should contain one or more
288 pairs of borrowers column names and values, e.g.,
290 $borrower = GetMember(borrowernumber => id);
292 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
293 the C<borrowers> table in the Koha database.
295 FIXME: GetMember() is used throughout the code as a lookup
296 on a unique key such as the borrowernumber, but this meaning is not
297 enforced in the routine itself.
303 my ( %information ) = @_;
304 if (exists $information{borrowernumber} && !defined $information{borrowernumber}) {
305 #passing mysql's kohaadmin?? Makes no sense as a query
308 my $dbh = C4::Context->dbh;
310 q{SELECT borrowers.*, categories.category_type, categories.description
312 LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
315 for (keys %information ) {
323 if (defined $information{$_}) {
325 push @values, $information{$_};
328 $select .= "$_ IS NULL";
331 $debug && warn $select, " ",values %information;
332 my $sth = $dbh->prepare("$select");
333 $sth->execute(@values);
334 my $data = $sth->fetchall_arrayref({});
335 #FIXME interface to this routine now allows generation of a result set
336 #so whole array should be returned but bowhere in the current code expects this
346 my $success = ModMember(borrowernumber => $borrowernumber,
347 [ field => value ]... );
349 Modify borrower's data. All date fields should ALREADY be in ISO format.
352 true on success, or false on failure
358 # test to know if you must update or not the borrower password
359 if (exists $data{password}) {
360 if ($data{password} eq '****' or $data{password} eq '') {
361 delete $data{password};
363 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
364 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
365 Koha::NorwegianPatronDB::NLUpdateHashedPIN( $data{'borrowernumber'}, $data{password} );
367 $data{password} = hash_password($data{password});
371 my $old_categorycode = Koha::Patrons->find( $data{borrowernumber} )->categorycode;
373 # get only the columns of a borrower
374 my $schema = Koha::Database->new()->schema;
375 my @columns = $schema->source('Borrower')->columns;
376 my $new_borrower = { map { join(' ', @columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) };
378 $new_borrower->{dateofbirth} ||= undef if exists $new_borrower->{dateofbirth};
379 $new_borrower->{dateenrolled} ||= undef if exists $new_borrower->{dateenrolled};
380 $new_borrower->{dateexpiry} ||= undef if exists $new_borrower->{dateexpiry};
381 $new_borrower->{debarred} ||= undef if exists $new_borrower->{debarred};
382 $new_borrower->{sms_provider_id} ||= undef if exists $new_borrower->{sms_provider_id};
383 $new_borrower->{guarantorid} ||= undef if exists $new_borrower->{guarantorid};
385 my $patron = Koha::Patrons->find( $new_borrower->{borrowernumber} );
387 delete $new_borrower->{userid} if exists $new_borrower->{userid} and not $new_borrower->{userid};
389 my $execute_success = $patron->store if $patron->set($new_borrower);
391 if ($execute_success) { # only proceed if the update was a success
392 # If the patron changes to a category with enrollment fee, we add a fee
393 if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
394 if ( C4::Context->preference('FeeOnChangePatronCategory') ) {
395 $patron->add_enrolment_fee_if_needed;
399 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
400 # cronjob will use for syncing with NL
401 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
402 my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
403 'synctype' => 'norwegianpatrondb',
404 'borrowernumber' => $data{'borrowernumber'}
406 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
407 # we can sync as changed. And the "new sync" will pick up all changes since
408 # the patron was created anyway.
409 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
410 $borrowersync->update( { 'syncstatus' => 'edited' } );
412 # Set the value of 'sync'
413 $borrowersync->update( { 'sync' => $data{'sync'} } );
414 # Try to do the live sync
415 Koha::NorwegianPatronDB::NLSync({ 'borrowernumber' => $data{'borrowernumber'} });
418 logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
420 return $execute_success;
425 $borrowernumber = &AddMember(%borrower);
427 insert new borrower into table
429 (%borrower keys are database columns. Database columns could be
430 different in different versions. Please look into database for correct
433 Returns the borrowernumber upon success
435 Returns as undef upon any db error without further processing
442 my $dbh = C4::Context->dbh;
443 my $schema = Koha::Database->new()->schema;
445 # generate a proper login if none provided
446 $data{'userid'} = Generate_Userid( $data{'borrowernumber'}, $data{'firstname'}, $data{'surname'} )
447 if ( $data{'userid'} eq '' || !Check_Userid( $data{'userid'} ) );
449 # add expiration date if it isn't already there
450 $data{dateexpiry} ||= Koha::Patron::Categories->find( $data{categorycode} )->get_expiry_date;
452 # add enrollment date if it isn't already there
453 unless ( $data{'dateenrolled'} ) {
454 $data{'dateenrolled'} = output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
457 if ( C4::Context->preference("autoMemberNum") ) {
458 if ( not exists $data{cardnumber} or not defined $data{cardnumber} or $data{cardnumber} eq '' ) {
459 $data{cardnumber} = fixup_cardnumber( $data{cardnumber} );
463 my $patron_category = $schema->resultset('Category')->find( $data{'categorycode'} );
465 $patron_category->default_privacy() eq 'default' ? 1
466 : $patron_category->default_privacy() eq 'never' ? 2
467 : $patron_category->default_privacy() eq 'forever' ? 0
470 $data{'privacy_guarantor_checkouts'} = 0 unless defined( $data{'privacy_guarantor_checkouts'} );
472 # Make a copy of the plain text password for later use
473 my $plain_text_password = $data{'password'};
475 # create a disabled account if no password provided
476 $data{'password'} = ($data{'password'})? hash_password($data{'password'}) : '!';
478 # we don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00
479 $data{'dateofbirth'} = undef if ( not $data{'dateofbirth'} );
480 $data{'debarred'} = undef if ( not $data{'debarred'} );
481 $data{'sms_provider_id'} = undef if ( not $data{'sms_provider_id'} );
483 # get only the columns of Borrower
484 # FIXME Do we really need this check?
485 my @columns = $schema->source('Borrower')->columns;
486 my $new_member = { map { join(' ',@columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) } ;
488 delete $new_member->{borrowernumber};
490 my $patron = Koha::Patron->new( $new_member )->store;
491 $data{borrowernumber} = $patron->borrowernumber;
493 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
494 # cronjob will use for syncing with NL
495 if ( exists $data{'borrowernumber'} && C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
496 Koha::Database->new->schema->resultset('BorrowerSync')->create({
497 'borrowernumber' => $data{'borrowernumber'},
498 'synctype' => 'norwegianpatrondb',
500 'syncstatus' => 'new',
501 'hashed_pin' => Koha::NorwegianPatronDB::NLEncryptPIN( $plain_text_password ),
505 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
507 $patron->add_enrolment_fee_if_needed;
509 return $data{borrowernumber};
514 my $uniqueness = Check_Userid($userid,$borrowernumber);
516 $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 != '').
518 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.
521 0 for not unique (i.e. this $userid already exists)
522 1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
527 my ( $uid, $borrowernumber ) = @_;
529 return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
531 return 0 if ( $uid eq C4::Context->config('user') );
533 my $rs = Koha::Database->new()->schema()->resultset('Borrower');
536 $params->{userid} = $uid;
537 $params->{borrowernumber} = { '!=' => $borrowernumber } if ($borrowernumber);
539 my $count = $rs->count( $params );
541 return $count ? 0 : 1;
544 =head2 Generate_Userid
546 my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
548 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
550 $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.
553 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).
557 sub Generate_Userid {
558 my ($borrowernumber, $firstname, $surname) = @_;
561 #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
563 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
564 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
565 $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
566 $newuid = unac_string('utf-8',$newuid);
567 $newuid .= $offset unless $offset == 0;
570 } while (!Check_Userid($newuid,$borrowernumber));
575 =head2 fixup_cardnumber
577 Warning: The caller is responsible for locking the members table in write
578 mode, to avoid database corruption.
582 use vars qw( @weightings );
583 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
585 sub fixup_cardnumber {
586 my ($cardnumber) = @_;
587 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
589 # Find out whether member numbers should be generated
590 # automatically. Should be either "1" or something else.
591 # Defaults to "0", which is interpreted as "no".
593 # if ($cardnumber !~ /\S/ && $autonumber_members) {
594 ($autonumber_members) or return $cardnumber;
595 my $checkdigit = C4::Context->preference('checkdigit');
596 my $dbh = C4::Context->dbh;
597 if ( $checkdigit and $checkdigit eq 'katipo' ) {
599 # if checkdigit is selected, calculate katipo-style cardnumber.
600 # otherwise, just use the max()
601 # purpose: generate checksum'd member numbers.
602 # We'll assume we just got the max value of digits 2-8 of member #'s
603 # from the database and our job is to increment that by one,
604 # determine the 1st and 9th digits and return the full string.
605 my $sth = $dbh->prepare(
606 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
609 my $data = $sth->fetchrow_hashref;
610 $cardnumber = $data->{new_num};
611 if ( !$cardnumber ) { # If DB has no values,
612 $cardnumber = 1000000; # start at 1000000
618 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
619 # read weightings, left to right, 1 char at a time
620 my $temp1 = $weightings[$i];
622 # sequence left to right, 1 char at a time
623 my $temp2 = substr( $cardnumber, $i, 1 );
625 # mult each char 1-7 by its corresponding weighting
626 $sum += $temp1 * $temp2;
629 my $rem = ( $sum % 11 );
630 $rem = 'X' if $rem == 10;
632 return "V$cardnumber$rem";
635 my $sth = $dbh->prepare(
636 'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
639 my ($result) = $sth->fetchrow;
642 return $cardnumber; # just here as a fallback/reminder
645 =head2 GetPendingIssues
647 my $issues = &GetPendingIssues(@borrowernumber);
649 Looks up what the patron with the given borrowernumber has borrowed.
651 C<&GetPendingIssues> returns a
652 reference-to-array where each element is a reference-to-hash; the
653 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
654 The keys include C<biblioitems> fields.
658 sub GetPendingIssues {
659 my @borrowernumbers = @_;
661 unless (@borrowernumbers ) { # return a ref_to_array
662 return \@borrowernumbers; # to not cause surprise to caller
665 # Borrowers part of the query
667 for (my $i = 0; $i < @borrowernumbers; $i++) {
668 $bquery .= ' issues.borrowernumber = ?';
669 if ($i < $#borrowernumbers ) {
674 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
675 # FIXME: circ/ciculation.pl tries to sort by timestamp!
676 # FIXME: namespace collision: other collisions possible.
677 # FIXME: most of this data isn't really being used by callers.
684 biblioitems.itemtype,
687 biblioitems.publicationyear,
688 biblioitems.publishercode,
689 biblioitems.volumedate,
690 biblioitems.volumedesc,
695 borrowers.cardnumber,
696 issues.timestamp AS timestamp,
697 issues.renewals AS renewals,
698 issues.borrowernumber AS borrowernumber,
699 items.renewals AS totalrenewals
701 LEFT JOIN items ON items.itemnumber = issues.itemnumber
702 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
703 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
704 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
707 ORDER BY issues.issuedate"
710 my $sth = C4::Context->dbh->prepare($query);
711 $sth->execute(@borrowernumbers);
712 my $data = $sth->fetchall_arrayref({});
713 my $today = dt_from_string;
715 if ($_->{issuedate}) {
716 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
718 $_->{date_due_sql} = $_->{date_due};
719 # FIXME no need to have this value
720 $_->{date_due} or next;
721 $_->{date_due_sql} = $_->{date_due};
722 # FIXME no need to have this value
723 $_->{date_due} = dt_from_string($_->{date_due}, 'sql');
724 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
733 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
735 Looks up what the patron with the given borrowernumber has borrowed,
736 and sorts the results.
738 C<$sortkey> is the name of a field on which to sort the results. This
739 should be the name of a field in the C<issues>, C<biblio>,
740 C<biblioitems>, or C<items> table in the Koha database.
742 C<$limit> is the maximum number of results to return.
744 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
745 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
746 C<items> tables of the Koha database.
752 my ( $borrowernumber, $order, $limit ) = @_;
754 return unless $borrowernumber;
755 $order = 'date_due desc' unless $order;
757 my $dbh = C4::Context->dbh;
759 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
761 LEFT JOIN items on items.itemnumber=issues.itemnumber
762 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
763 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
764 WHERE borrowernumber=?
766 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
768 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
769 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
770 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
771 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
774 $query .= " limit $limit";
777 my $sth = $dbh->prepare($query);
778 $sth->execute( $borrowernumber, $borrowernumber );
779 return $sth->fetchall_arrayref( {} );
783 =head2 GetMemberAccountRecords
785 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
787 Looks up accounting data for the patron with the given borrowernumber.
789 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
790 reference-to-array, where each element is a reference-to-hash; the
791 keys are the fields of the C<accountlines> table in the Koha database.
792 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
793 total amount outstanding for all of the account lines.
797 sub GetMemberAccountRecords {
798 my ($borrowernumber) = @_;
799 my $dbh = C4::Context->dbh;
805 WHERE borrowernumber=?);
806 $strsth.=" ORDER BY accountlines_id desc";
807 my $sth= $dbh->prepare( $strsth );
808 $sth->execute( $borrowernumber );
811 while ( my $data = $sth->fetchrow_hashref ) {
812 if ( $data->{itemnumber} ) {
813 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
814 $data->{biblionumber} = $biblio->{biblionumber};
815 $data->{title} = $biblio->{title};
817 $acctlines[$numlines] = $data;
819 $total += sprintf "%.0f", 1000*$data->{amountoutstanding}; # convert float to integer to avoid round-off errors
822 return ( $total, \@acctlines,$numlines);
825 =head2 GetMemberAccountBalance
827 ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
829 Calculates amount immediately owing by the patron - non-issue charges.
830 Based on GetMemberAccountRecords.
831 Charges exempt from non-issue are:
833 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
834 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
838 sub GetMemberAccountBalance {
839 my ($borrowernumber) = @_;
841 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
844 push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
845 push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
846 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
847 my $dbh = C4::Context->dbh;
848 my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
849 push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
851 my %not_fine = map {$_ => 1} @not_fines;
853 my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
854 my $other_charges = 0;
855 foreach (@$acctlines) {
856 $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
859 return ( $total, $total - $other_charges, $other_charges);
862 =head2 GetBorNotifyAcctRecord
864 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
866 Looks up accounting data for the patron with the given borrowernumber per file number.
868 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
869 reference-to-array, where each element is a reference-to-hash; the
870 keys are the fields of the C<accountlines> table in the Koha database.
871 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
872 total amount outstanding for all of the account lines.
876 sub GetBorNotifyAcctRecord {
877 my ( $borrowernumber, $notifyid ) = @_;
878 my $dbh = C4::Context->dbh;
881 my $sth = $dbh->prepare(
884 WHERE borrowernumber=?
886 AND amountoutstanding != '0'
887 ORDER BY notify_id,accounttype
890 $sth->execute( $borrowernumber, $notifyid );
892 while ( my $data = $sth->fetchrow_hashref ) {
893 if ( $data->{itemnumber} ) {
894 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
895 $data->{biblionumber} = $biblio->{biblionumber};
896 $data->{title} = $biblio->{title};
898 $acctlines[$numlines] = $data;
900 $total += int(100 * $data->{'amountoutstanding'});
903 return ( $total, \@acctlines, $numlines );
906 sub checkcardnumber {
907 my ( $cardnumber, $borrowernumber ) = @_;
909 # If cardnumber is null, we assume they're allowed.
910 return 0 unless defined $cardnumber;
912 my $dbh = C4::Context->dbh;
913 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
914 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
915 my $sth = $dbh->prepare($query);
918 ( $borrowernumber ? $borrowernumber : () )
921 return 1 if $sth->fetchrow_hashref;
923 my ( $min_length, $max_length ) = get_cardnumber_length();
925 if length $cardnumber > $max_length
926 or length $cardnumber < $min_length;
931 =head2 get_cardnumber_length
933 my ($min, $max) = C4::Members::get_cardnumber_length()
935 Returns the minimum and maximum length for patron cardnumbers as
936 determined by the CardnumberLength system preference, the
937 BorrowerMandatoryField system preference, and the width of the
942 sub get_cardnumber_length {
943 my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
944 $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
945 if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
946 # Is integer and length match
947 if ( $cardnumber_length =~ m|^\d+$| ) {
948 $min = $max = $cardnumber_length
949 if $cardnumber_length >= $min
950 and $cardnumber_length <= $max;
952 # Else assuming it is a range
953 elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
954 $min = $1 if $1 and $min < $1;
955 $max = $2 if $2 and $max > $2;
959 my $borrower = Koha::Schema->resultset('Borrower');
960 my $field_size = $borrower->result_source->column_info('cardnumber')->{size};
961 $min = $field_size if $min > $field_size;
962 return ( $min, $max );
965 =head2 GetFirstValidEmailAddress
967 $email = GetFirstValidEmailAddress($borrowernumber);
969 Return the first valid email address for a borrower, given the borrowernumber. For now, the order
970 is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
975 sub GetFirstValidEmailAddress {
976 my $borrowernumber = shift;
978 my $borrower = Koha::Patrons->find( $borrowernumber );
980 return $borrower->first_valid_email_address();
983 =head2 GetNoticeEmailAddress
985 $email = GetNoticeEmailAddress($borrowernumber);
987 Return the email address of borrower used for notices, given the borrowernumber.
988 Returns the empty string if no email address.
992 sub GetNoticeEmailAddress {
993 my $borrowernumber = shift;
995 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
996 # if syspref is set to 'first valid' (value == OFF), look up email address
997 if ( $which_address eq 'OFF' ) {
998 return GetFirstValidEmailAddress($borrowernumber);
1000 # specified email address field
1001 my $dbh = C4::Context->dbh;
1002 my $sth = $dbh->prepare( qq{
1003 SELECT $which_address AS primaryemail
1005 WHERE borrowernumber=?
1007 $sth->execute($borrowernumber);
1008 my $data = $sth->fetchrow_hashref;
1009 return $data->{'primaryemail'} || '';
1012 =head2 GetBorrowersToExpunge
1014 $borrowers = &GetBorrowersToExpunge(
1015 not_borrowed_since => $not_borrowed_since,
1016 expired_before => $expired_before,
1017 category_code => $category_code,
1018 patron_list_id => $patron_list_id,
1019 branchcode => $branchcode
1022 This function get all borrowers based on the given criteria.
1026 sub GetBorrowersToExpunge {
1029 my $filterdate = $params->{'not_borrowed_since'};
1030 my $filterexpiry = $params->{'expired_before'};
1031 my $filterlastseen = $params->{'last_seen'};
1032 my $filtercategory = $params->{'category_code'};
1033 my $filterbranch = $params->{'branchcode'} ||
1034 ((C4::Context->preference('IndependentBranches')
1035 && C4::Context->userenv
1036 && !C4::Context->IsSuperLibrarian()
1037 && C4::Context->userenv->{branch})
1038 ? C4::Context->userenv->{branch}
1040 my $filterpatronlist = $params->{'patron_list_id'};
1042 my $dbh = C4::Context->dbh;
1044 SELECT borrowers.borrowernumber,
1045 MAX(old_issues.timestamp) AS latestissue,
1046 MAX(issues.timestamp) AS currentissue
1048 JOIN categories USING (categorycode)
1052 WHERE guarantorid IS NOT NULL
1053 AND guarantorid <> 0
1054 ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
1055 LEFT JOIN old_issues USING (borrowernumber)
1056 LEFT JOIN issues USING (borrowernumber)|;
1057 if ( $filterpatronlist ){
1058 $query .= q| LEFT JOIN patron_list_patrons USING (borrowernumber)|;
1060 $query .= q| WHERE category_type <> 'S'
1061 AND tmp.guarantorid IS NULL
1064 if ( $filterbranch && $filterbranch ne "" ) {
1065 $query.= " AND borrowers.branchcode = ? ";
1066 push( @query_params, $filterbranch );
1068 if ( $filterexpiry ) {
1069 $query .= " AND dateexpiry < ? ";
1070 push( @query_params, $filterexpiry );
1072 if ( $filterlastseen ) {
1073 $query .= ' AND lastseen < ? ';
1074 push @query_params, $filterlastseen;
1076 if ( $filtercategory ) {
1077 $query .= " AND categorycode = ? ";
1078 push( @query_params, $filtercategory );
1080 if ( $filterpatronlist ){
1081 $query.=" AND patron_list_id = ? ";
1082 push( @query_params, $filterpatronlist );
1084 $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
1085 if ( $filterdate ) {
1086 $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
1087 push @query_params,$filterdate;
1089 warn $query if $debug;
1091 my $sth = $dbh->prepare($query);
1092 if (scalar(@query_params)>0){
1093 $sth->execute(@query_params);
1100 while ( my $data = $sth->fetchrow_hashref ) {
1101 push @results, $data;
1106 =head2 GetBorrowersWithIssuesHistoryOlderThan
1108 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
1110 this function get all borrowers who has an issue history older than I<$date> given on input arg.
1112 I<$result> is a ref to an array which all elements are a hashref.
1113 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1117 sub GetBorrowersWithIssuesHistoryOlderThan {
1118 my $dbh = C4::Context->dbh;
1119 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
1120 my $filterbranch = shift ||
1121 ((C4::Context->preference('IndependentBranches')
1122 && C4::Context->userenv
1123 && !C4::Context->IsSuperLibrarian()
1124 && C4::Context->userenv->{branch})
1125 ? C4::Context->userenv->{branch}
1128 SELECT count(borrowernumber) as n,borrowernumber
1130 WHERE returndate < ?
1131 AND borrowernumber IS NOT NULL
1134 push @query_params, $date;
1136 $query.=" AND branchcode = ?";
1137 push @query_params, $filterbranch;
1139 $query.=" GROUP BY borrowernumber ";
1140 warn $query if $debug;
1141 my $sth = $dbh->prepare($query);
1142 $sth->execute(@query_params);
1145 while ( my $data = $sth->fetchrow_hashref ) {
1146 push @results, $data;
1153 IssueSlip($branchcode, $borrowernumber, $quickslip)
1155 Returns letter hash ( see C4::Letters::GetPreparedLetter )
1157 $quickslip is boolean, to indicate whether we want a quick slip
1159 IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
1195 NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
1200 my ($branch, $borrowernumber, $quickslip) = @_;
1202 # FIXME Check callers before removing this statement
1203 #return unless $borrowernumber;
1205 my @issues = @{ GetPendingIssues($borrowernumber) };
1207 for my $issue (@issues) {
1208 $issue->{date_due} = $issue->{date_due_sql};
1210 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
1211 if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
1212 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
1218 # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
1220 my $s = $b->{timestamp} <=> $a->{timestamp};
1222 $b->{issuedate} <=> $a->{issuedate} : $s;
1225 my ($letter_code, %repeat);
1227 $letter_code = 'ISSUEQSLIP';
1229 'checkedout' => [ map {
1232 'biblioitems' => $_,
1234 }, grep { $_->{'now'} } @issues ],
1238 $letter_code = 'ISSUESLIP';
1240 'checkedout' => [ map {
1243 'biblioitems' => $_,
1245 }, grep { !$_->{'overdue'} } @issues ],
1247 'overdue' => [ map {
1250 'biblioitems' => $_,
1252 }, grep { $_->{'overdue'} } @issues ],
1255 $_->{'timestamp'} = $_->{'newdate'};
1257 } @{ GetNewsToDisplay("slip",$branch) } ],
1261 return C4::Letters::GetPreparedLetter (
1262 module => 'circulation',
1263 letter_code => $letter_code,
1264 branchcode => $branch,
1266 'branches' => $branch,
1267 'borrowers' => $borrowernumber,
1273 =head2 GetBorrowersWithEmail
1275 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
1277 This gets a list of users and their basic details from their email address.
1278 As it's possible for multiple user to have the same email address, it provides
1279 you with all of them. If there is no userid for the user, there will be an
1280 C<undef> there. An empty list will be returned if there are no matches.
1284 sub GetBorrowersWithEmail {
1287 my $dbh = C4::Context->dbh;
1289 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
1290 my $sth=$dbh->prepare($query);
1291 $sth->execute($email);
1293 while (my $ref = $sth->fetch) {
1296 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
1300 =head2 AddMember_Opac
1304 sub AddMember_Opac {
1305 my ( %borrower ) = @_;
1307 $borrower{'categorycode'} //= C4::Context->preference('PatronSelfRegistrationDefaultCategory');
1308 if (not defined $borrower{'password'}){
1309 my $sr = new String::Random;
1310 $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
1311 my $password = $sr->randpattern("AAAAAAAAAA");
1312 $borrower{'password'} = $password;
1315 $borrower{'cardnumber'} = fixup_cardnumber( $borrower{'cardnumber'} );
1317 my $borrowernumber = AddMember(%borrower);
1319 return ( $borrowernumber, $borrower{'password'} );
1322 =head2 DeleteExpiredOpacRegistrations
1324 Delete accounts that haven't been upgraded from the 'temporary' category
1325 Returns the number of removed patrons
1329 sub DeleteExpiredOpacRegistrations {
1331 my $delay = C4::Context->preference('PatronSelfRegistrationExpireTemporaryAccountsDelay');
1332 my $category_code = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
1334 return 0 if not $category_code or not defined $delay or $delay eq q||;
1337 SELECT borrowernumber
1339 WHERE categorycode = ? AND DATEDIFF( NOW(), dateenrolled ) > ? |;
1341 my $dbh = C4::Context->dbh;
1342 my $sth = $dbh->prepare($query);
1343 $sth->execute( $category_code, $delay );
1345 while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
1346 Koha::Patrons->find($borrowernumber)->delete;
1352 =head2 DeleteUnverifiedOpacRegistrations
1354 Delete all unverified self registrations in borrower_modifications,
1355 older than the specified number of days.
1359 sub DeleteUnverifiedOpacRegistrations {
1361 my $dbh = C4::Context->dbh;
1363 DELETE FROM borrower_modifications
1364 WHERE borrowernumber = 0 AND DATEDIFF( NOW(), timestamp ) > ?|;
1365 my $cnt=$dbh->do($sql, undef, ($days) );
1366 return $cnt eq '0E0'? 0: $cnt;
1369 sub GetOverduesForPatron {
1370 my ( $borrowernumber ) = @_;
1374 FROM issues, items, biblio, biblioitems
1375 WHERE items.itemnumber=issues.itemnumber
1376 AND biblio.biblionumber = items.biblionumber
1377 AND biblio.biblionumber = biblioitems.biblionumber
1378 AND issues.borrowernumber = ?
1379 AND date_due < NOW()
1382 my $sth = C4::Context->dbh->prepare( $sql );
1383 $sth->execute( $borrowernumber );
1385 return $sth->fetchall_arrayref({});
1388 END { } # module clean-up code here (global destructor)