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
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
359 # trim whitespace from data which has some non-whitespace in it.
360 foreach my $field_name (keys(%data)) {
361 if ( defined $data{$field_name} && $data{$field_name} =~ /\S/ ) {
362 $data{$field_name} =~ s/^\s*|\s*$//g;
366 # test to know if you must update or not the borrower password
367 if (exists $data{password
}) {
368 if ($data{password
} eq '****' or $data{password
} eq '') {
369 delete $data{password
};
371 if ( C4
::Context
->preference('NorwegianPatronDBEnable') && C4
::Context
->preference('NorwegianPatronDBEnable') == 1 ) {
372 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
373 Koha
::NorwegianPatronDB
::NLUpdateHashedPIN
( $data{'borrowernumber'}, $data{password
} );
375 $data{password
} = hash_password
($data{password
});
379 my $old_categorycode = Koha
::Patrons
->find( $data{borrowernumber
} )->categorycode;
381 # get only the columns of a borrower
382 my $schema = Koha
::Database
->new()->schema;
383 my @columns = $schema->source('Borrower')->columns;
384 my $new_borrower = { map { join(' ', @columns) =~ /$_/ ?
( $_ => $data{$_} ) : () } keys(%data) };
386 $new_borrower->{dateofbirth
} ||= undef if exists $new_borrower->{dateofbirth
};
387 $new_borrower->{dateenrolled
} ||= undef if exists $new_borrower->{dateenrolled
};
388 $new_borrower->{dateexpiry
} ||= undef if exists $new_borrower->{dateexpiry
};
389 $new_borrower->{debarred
} ||= undef if exists $new_borrower->{debarred
};
390 $new_borrower->{sms_provider_id
} ||= undef if exists $new_borrower->{sms_provider_id
};
391 $new_borrower->{guarantorid
} ||= undef if exists $new_borrower->{guarantorid
};
393 my $patron = Koha
::Patrons
->find( $new_borrower->{borrowernumber
} );
395 delete $new_borrower->{userid
} if exists $new_borrower->{userid
} and not $new_borrower->{userid
};
397 my $execute_success = $patron->store if $patron->set($new_borrower);
399 if ($execute_success) { # only proceed if the update was a success
400 # If the patron changes to a category with enrollment fee, we add a fee
401 if ( $data{categorycode
} and $data{categorycode
} ne $old_categorycode ) {
402 if ( C4
::Context
->preference('FeeOnChangePatronCategory') ) {
403 $patron->add_enrolment_fee_if_needed;
407 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
408 # cronjob will use for syncing with NL
409 if ( C4
::Context
->preference('NorwegianPatronDBEnable') && C4
::Context
->preference('NorwegianPatronDBEnable') == 1 ) {
410 my $borrowersync = Koha
::Database
->new->schema->resultset('BorrowerSync')->find({
411 'synctype' => 'norwegianpatrondb',
412 'borrowernumber' => $data{'borrowernumber'}
414 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
415 # we can sync as changed. And the "new sync" will pick up all changes since
416 # the patron was created anyway.
417 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
418 $borrowersync->update( { 'syncstatus' => 'edited' } );
420 # Set the value of 'sync'
421 $borrowersync->update( { 'sync' => $data{'sync'} } );
422 # Try to do the live sync
423 Koha
::NorwegianPatronDB
::NLSync
({ 'borrowernumber' => $data{'borrowernumber'} });
426 logaction
("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4
::Context
->preference("BorrowersLog");
428 return $execute_success;
433 $borrowernumber = &AddMember(%borrower);
435 insert new borrower into table
437 (%borrower keys are database columns. Database columns could be
438 different in different versions. Please look into database for correct
441 Returns the borrowernumber upon success
443 Returns as undef upon any db error without further processing
450 my $dbh = C4
::Context
->dbh;
451 my $schema = Koha
::Database
->new()->schema;
453 # trim whitespace from data which has some non-whitespace in it.
454 foreach my $field_name (keys(%data)) {
455 if ( defined $data{$field_name} && $data{$field_name} =~ /\S/ ) {
456 $data{$field_name} =~ s/^\s*|\s*$//g;
460 # generate a proper login if none provided
461 $data{'userid'} = Generate_Userid
( $data{'borrowernumber'}, $data{'firstname'}, $data{'surname'} )
462 if ( $data{'userid'} eq '' || !Check_Userid
( $data{'userid'} ) );
464 # add expiration date if it isn't already there
465 $data{dateexpiry
} ||= Koha
::Patron
::Categories
->find( $data{categorycode
} )->get_expiry_date;
467 # add enrollment date if it isn't already there
468 unless ( $data{'dateenrolled'} ) {
469 $data{'dateenrolled'} = output_pref
( { dt
=> dt_from_string
, dateonly
=> 1, dateformat
=> 'iso' } );
472 if ( C4
::Context
->preference("autoMemberNum") ) {
473 if ( not exists $data{cardnumber
} or not defined $data{cardnumber
} or $data{cardnumber
} eq '' ) {
474 $data{cardnumber
} = fixup_cardnumber
( $data{cardnumber
} );
478 my $patron_category = $schema->resultset('Category')->find( $data{'categorycode'} );
480 $patron_category->default_privacy() eq 'default' ?
1
481 : $patron_category->default_privacy() eq 'never' ?
2
482 : $patron_category->default_privacy() eq 'forever' ?
0
485 $data{'privacy_guarantor_checkouts'} = 0 unless defined( $data{'privacy_guarantor_checkouts'} );
487 # Make a copy of the plain text password for later use
488 my $plain_text_password = $data{'password'};
490 # create a disabled account if no password provided
491 $data{'password'} = ($data{'password'})? hash_password
($data{'password'}) : '!';
493 # we don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00
494 $data{'dateofbirth'} = undef if ( not $data{'dateofbirth'} );
495 $data{'debarred'} = undef if ( not $data{'debarred'} );
496 $data{'sms_provider_id'} = undef if ( not $data{'sms_provider_id'} );
498 # get only the columns of Borrower
499 # FIXME Do we really need this check?
500 my @columns = $schema->source('Borrower')->columns;
501 my $new_member = { map { join(' ',@columns) =~ /$_/ ?
( $_ => $data{$_} ) : () } keys(%data) } ;
503 delete $new_member->{borrowernumber
};
505 my $patron = Koha
::Patron
->new( $new_member )->store;
506 $data{borrowernumber
} = $patron->borrowernumber;
508 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
509 # cronjob will use for syncing with NL
510 if ( exists $data{'borrowernumber'} && C4
::Context
->preference('NorwegianPatronDBEnable') && C4
::Context
->preference('NorwegianPatronDBEnable') == 1 ) {
511 Koha
::Database
->new->schema->resultset('BorrowerSync')->create({
512 'borrowernumber' => $data{'borrowernumber'},
513 'synctype' => 'norwegianpatrondb',
515 'syncstatus' => 'new',
516 'hashed_pin' => Koha
::NorwegianPatronDB
::NLEncryptPIN
( $plain_text_password ),
520 logaction
("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4
::Context
->preference("BorrowersLog");
522 $patron->add_enrolment_fee_if_needed;
524 return $data{borrowernumber
};
529 my $uniqueness = Check_Userid($userid,$borrowernumber);
531 $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 != '').
533 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.
536 0 for not unique (i.e. this $userid already exists)
537 1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
542 my ( $uid, $borrowernumber ) = @_;
544 return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
546 return 0 if ( $uid eq C4
::Context
->config('user') );
548 my $rs = Koha
::Database
->new()->schema()->resultset('Borrower');
551 $params->{userid
} = $uid;
552 $params->{borrowernumber
} = { '!=' => $borrowernumber } if ($borrowernumber);
554 my $count = $rs->count( $params );
556 return $count ?
0 : 1;
559 =head2 Generate_Userid
561 my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
563 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
565 $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.
568 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).
572 sub Generate_Userid
{
573 my ($borrowernumber, $firstname, $surname) = @_;
576 #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
578 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
579 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
580 $newuid = lc(($firstname)?
"$firstname.$surname" : $surname);
581 $newuid = unac_string
('utf-8',$newuid);
582 $newuid .= $offset unless $offset == 0;
585 } while (!Check_Userid
($newuid,$borrowernumber));
590 =head2 fixup_cardnumber
592 Warning: The caller is responsible for locking the members table in write
593 mode, to avoid database corruption.
597 use vars
qw( @weightings );
598 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
600 sub fixup_cardnumber {
601 my ($cardnumber) = @_;
602 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
604 # Find out whether member numbers should be generated
605 # automatically. Should be either "1" or something else.
606 # Defaults to "0", which is interpreted as "no".
608 # if ($cardnumber !~ /\S/ && $autonumber_members) {
609 ($autonumber_members) or return $cardnumber;
610 my $checkdigit = C4::Context->preference('checkdigit');
611 my $dbh = C4::Context->dbh;
612 if ( $checkdigit and $checkdigit eq 'katipo' ) {
614 # if checkdigit is selected, calculate katipo-style cardnumber.
615 # otherwise, just use the max()
616 # purpose: generate checksum'd member numbers.
617 # We'll assume we just got the max value of digits 2-8 of member #'s
618 # from the database and our job is to increment that by one,
619 # determine the 1st and 9th digits and return the full string.
620 my $sth = $dbh->prepare(
621 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
624 my $data = $sth->fetchrow_hashref;
625 $cardnumber = $data->{new_num};
626 if ( !$cardnumber ) { # If DB has no values,
627 $cardnumber = 1000000; # start at 1000000
633 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
634 # read weightings, left to right, 1 char at a time
635 my $temp1 = $weightings[$i];
637 # sequence left to right, 1 char at a time
638 my $temp2 = substr( $cardnumber, $i, 1 );
640 # mult each char 1-7 by its corresponding weighting
641 $sum += $temp1 * $temp2;
644 my $rem = ( $sum % 11 );
645 $rem = 'X' if $rem == 10;
647 return "V$cardnumber$rem";
650 my $sth = $dbh->prepare(
651 'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
654 my ($result) = $sth->fetchrow;
657 return $cardnumber; # just here as a fallback/reminder
660 =head2 GetPendingIssues
662 my $issues = &GetPendingIssues(@borrowernumber);
664 Looks up what the patron with the given borrowernumber has borrowed.
666 C<&GetPendingIssues> returns a
667 reference-to-array where each element is a reference-to-hash; the
668 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
669 The keys include C<biblioitems> fields.
673 sub GetPendingIssues {
674 my @borrowernumbers = @_;
676 unless (@borrowernumbers ) { # return a ref_to_array
677 return \@borrowernumbers; # to not cause surprise to caller
680 # Borrowers part of the query
682 for (my $i = 0; $i < @borrowernumbers; $i++) {
683 $bquery .= ' issues.borrowernumber = ?';
684 if ($i < $#borrowernumbers ) {
689 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
690 # FIXME: circ/ciculation.pl tries to sort by timestamp!
691 # FIXME: namespace collision: other collisions possible.
692 # FIXME: most of this data isn't really being used by callers.
699 biblioitems.itemtype,
702 biblioitems.publicationyear,
703 biblioitems.publishercode,
704 biblioitems.volumedate,
705 biblioitems.volumedesc,
710 borrowers.cardnumber,
711 issues.timestamp AS timestamp,
712 issues.renewals AS renewals,
713 issues.borrowernumber AS borrowernumber,
714 items.renewals AS totalrenewals
716 LEFT JOIN items ON items.itemnumber = issues.itemnumber
717 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
718 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
719 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
722 ORDER BY issues.issuedate"
725 my $sth = C4::Context->dbh->prepare($query);
726 $sth->execute(@borrowernumbers);
727 my $data = $sth->fetchall_arrayref({});
728 my $today = dt_from_string;
730 if ($_->{issuedate}) {
731 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
733 $_->{date_due_sql} = $_->{date_due};
734 # FIXME no need to have this value
735 $_->{date_due} or next;
736 $_->{date_due_sql} = $_->{date_due};
737 # FIXME no need to have this value
738 $_->{date_due} = dt_from_string($_->{date_due}, 'sql');
739 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
748 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
750 Looks up what the patron with the given borrowernumber has borrowed,
751 and sorts the results.
753 C<$sortkey> is the name of a field on which to sort the results. This
754 should be the name of a field in the C<issues>, C<biblio>,
755 C<biblioitems>, or C<items> table in the Koha database.
757 C<$limit> is the maximum number of results to return.
759 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
760 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
761 C<items> tables of the Koha database.
767 my ( $borrowernumber, $order, $limit ) = @_;
769 return unless $borrowernumber;
770 $order = 'date_due desc' unless $order;
772 my $dbh = C4::Context->dbh;
774 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
776 LEFT JOIN items on items.itemnumber=issues.itemnumber
777 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
778 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
779 WHERE borrowernumber=?
781 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
783 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
784 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
785 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
786 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
789 $query .= " limit $limit";
792 my $sth = $dbh->prepare($query);
793 $sth->execute( $borrowernumber, $borrowernumber );
794 return $sth->fetchall_arrayref( {} );
798 =head2 GetMemberAccountRecords
800 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
802 Looks up accounting data for the patron with the given borrowernumber.
804 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
805 reference-to-array, where each element is a reference-to-hash; the
806 keys are the fields of the C<accountlines> table in the Koha database.
807 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
808 total amount outstanding for all of the account lines.
812 sub GetMemberAccountRecords {
813 my ($borrowernumber) = @_;
814 my $dbh = C4::Context->dbh;
820 WHERE borrowernumber=?);
821 $strsth.=" ORDER BY accountlines_id desc";
822 my $sth= $dbh->prepare( $strsth );
823 $sth->execute( $borrowernumber );
826 while ( my $data = $sth->fetchrow_hashref ) {
827 if ( $data->{itemnumber} ) {
828 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
829 $data->{biblionumber} = $biblio->{biblionumber};
830 $data->{title} = $biblio->{title};
832 $acctlines[$numlines] = $data;
834 $total += sprintf "%.0f", 1000*$data->{amountoutstanding}; # convert float to integer to avoid round-off errors
837 return ( $total, \@acctlines,$numlines);
840 =head2 GetMemberAccountBalance
842 ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
844 Calculates amount immediately owing by the patron - non-issue charges.
845 Based on GetMemberAccountRecords.
846 Charges exempt from non-issue are:
848 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
849 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
853 sub GetMemberAccountBalance {
854 my ($borrowernumber) = @_;
856 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
859 push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
860 push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
861 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
862 my $dbh = C4::Context->dbh;
863 my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
864 push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
866 my %not_fine = map {$_ => 1} @not_fines;
868 my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
869 my $other_charges = 0;
870 foreach (@$acctlines) {
871 $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
874 return ( $total, $total - $other_charges, $other_charges);
877 =head2 GetBorNotifyAcctRecord
879 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
881 Looks up accounting data for the patron with the given borrowernumber per file number.
883 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
884 reference-to-array, where each element is a reference-to-hash; the
885 keys are the fields of the C<accountlines> table in the Koha database.
886 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
887 total amount outstanding for all of the account lines.
891 sub GetBorNotifyAcctRecord {
892 my ( $borrowernumber, $notifyid ) = @_;
893 my $dbh = C4::Context->dbh;
896 my $sth = $dbh->prepare(
899 WHERE borrowernumber=?
901 AND amountoutstanding != '0'
902 ORDER BY notify_id,accounttype
905 $sth->execute( $borrowernumber, $notifyid );
907 while ( my $data = $sth->fetchrow_hashref ) {
908 if ( $data->{itemnumber} ) {
909 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
910 $data->{biblionumber} = $biblio->{biblionumber};
911 $data->{title} = $biblio->{title};
913 $acctlines[$numlines] = $data;
915 $total += int(100 * $data->{'amountoutstanding'});
918 return ( $total, \@acctlines, $numlines );
921 sub checkcardnumber {
922 my ( $cardnumber, $borrowernumber ) = @_;
924 # If cardnumber is null, we assume they're allowed.
925 return 0 unless defined $cardnumber;
927 my $dbh = C4::Context->dbh;
928 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
929 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
930 my $sth = $dbh->prepare($query);
933 ( $borrowernumber ? $borrowernumber : () )
936 return 1 if $sth->fetchrow_hashref;
938 my ( $min_length, $max_length ) = get_cardnumber_length();
940 if length $cardnumber > $max_length
941 or length $cardnumber < $min_length;
946 =head2 get_cardnumber_length
948 my ($min, $max) = C4::Members::get_cardnumber_length()
950 Returns the minimum and maximum length for patron cardnumbers as
951 determined by the CardnumberLength system preference, the
952 BorrowerMandatoryField system preference, and the width of the
957 sub get_cardnumber_length {
958 my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
959 $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
960 if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
961 # Is integer and length match
962 if ( $cardnumber_length =~ m|^\d+$| ) {
963 $min = $max = $cardnumber_length
964 if $cardnumber_length >= $min
965 and $cardnumber_length <= $max;
967 # Else assuming it is a range
968 elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
969 $min = $1 if $1 and $min < $1;
970 $max = $2 if $2 and $max > $2;
974 my $borrower = Koha::Schema->resultset('Borrower');
975 my $field_size = $borrower->result_source->column_info('cardnumber')->{size};
976 $min = $field_size if $min > $field_size;
977 return ( $min, $max );
980 =head2 GetFirstValidEmailAddress
982 $email = GetFirstValidEmailAddress($borrowernumber);
984 Return the first valid email address for a borrower, given the borrowernumber. For now, the order
985 is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
990 sub GetFirstValidEmailAddress {
991 my $borrowernumber = shift;
993 my $borrower = Koha::Patrons->find( $borrowernumber );
995 return $borrower->first_valid_email_address();
998 =head2 GetNoticeEmailAddress
1000 $email = GetNoticeEmailAddress($borrowernumber);
1002 Return the email address of borrower used for notices, given the borrowernumber.
1003 Returns the empty string if no email address.
1007 sub GetNoticeEmailAddress {
1008 my $borrowernumber = shift;
1010 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1011 # if syspref is set to 'first valid' (value == OFF), look up email address
1012 if ( $which_address eq 'OFF' ) {
1013 return GetFirstValidEmailAddress($borrowernumber);
1015 # specified email address field
1016 my $dbh = C4::Context->dbh;
1017 my $sth = $dbh->prepare( qq{
1018 SELECT $which_address AS primaryemail
1020 WHERE borrowernumber=?
1022 $sth->execute($borrowernumber);
1023 my $data = $sth->fetchrow_hashref;
1024 return $data->{'primaryemail'} || '';
1027 =head2 GetBorrowersToExpunge
1029 $borrowers = &GetBorrowersToExpunge(
1030 not_borrowed_since => $not_borrowed_since,
1031 expired_before => $expired_before,
1032 category_code => $category_code,
1033 patron_list_id => $patron_list_id,
1034 branchcode => $branchcode
1037 This function get all borrowers based on the given criteria.
1041 sub GetBorrowersToExpunge {
1044 my $filterdate = $params->{'not_borrowed_since'};
1045 my $filterexpiry = $params->{'expired_before'};
1046 my $filterlastseen = $params->{'last_seen'};
1047 my $filtercategory = $params->{'category_code'};
1048 my $filterbranch = $params->{'branchcode'} ||
1049 ((C4::Context->preference('IndependentBranches')
1050 && C4::Context->userenv
1051 && !C4::Context->IsSuperLibrarian()
1052 && C4::Context->userenv->{branch})
1053 ? C4::Context->userenv->{branch}
1055 my $filterpatronlist = $params->{'patron_list_id'};
1057 my $dbh = C4::Context->dbh;
1059 SELECT borrowers.borrowernumber,
1060 MAX(old_issues.timestamp) AS latestissue,
1061 MAX(issues.timestamp) AS currentissue
1063 JOIN categories USING (categorycode)
1067 WHERE guarantorid IS NOT NULL
1068 AND guarantorid <> 0
1069 ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
1070 LEFT JOIN old_issues USING (borrowernumber)
1071 LEFT JOIN issues USING (borrowernumber)|;
1072 if ( $filterpatronlist ){
1073 $query .= q| LEFT JOIN patron_list_patrons USING (borrowernumber)|;
1075 $query .= q| WHERE category_type <> 'S'
1076 AND tmp.guarantorid IS NULL
1079 if ( $filterbranch && $filterbranch ne "" ) {
1080 $query.= " AND borrowers.branchcode = ? ";
1081 push( @query_params, $filterbranch );
1083 if ( $filterexpiry ) {
1084 $query .= " AND dateexpiry < ? ";
1085 push( @query_params, $filterexpiry );
1087 if ( $filterlastseen ) {
1088 $query .= ' AND lastseen < ? ';
1089 push @query_params, $filterlastseen;
1091 if ( $filtercategory ) {
1092 $query .= " AND categorycode = ? ";
1093 push( @query_params, $filtercategory );
1095 if ( $filterpatronlist ){
1096 $query.=" AND patron_list_id = ? ";
1097 push( @query_params, $filterpatronlist );
1099 $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
1100 if ( $filterdate ) {
1101 $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
1102 push @query_params,$filterdate;
1104 warn $query if $debug;
1106 my $sth = $dbh->prepare($query);
1107 if (scalar(@query_params)>0){
1108 $sth->execute(@query_params);
1115 while ( my $data = $sth->fetchrow_hashref ) {
1116 push @results, $data;
1123 IssueSlip($branchcode, $borrowernumber, $quickslip)
1125 Returns letter hash ( see C4::Letters::GetPreparedLetter )
1127 $quickslip is boolean, to indicate whether we want a quick slip
1129 IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
1165 NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
1170 my ($branch, $borrowernumber, $quickslip) = @_;
1172 # FIXME Check callers before removing this statement
1173 #return unless $borrowernumber;
1175 my @issues = @{ GetPendingIssues($borrowernumber) };
1177 for my $issue (@issues) {
1178 $issue->{date_due} = $issue->{date_due_sql};
1180 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
1181 if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
1182 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
1188 # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
1190 my $s = $b->{timestamp} <=> $a->{timestamp};
1192 $b->{issuedate} <=> $a->{issuedate} : $s;
1195 my ($letter_code, %repeat);
1197 $letter_code = 'ISSUEQSLIP';
1199 'checkedout' => [ map {
1202 'biblioitems' => $_,
1204 }, grep { $_->{'now
'} } @issues ],
1208 $letter_code = 'ISSUESLIP
';
1210 'checkedout
' => [ map {
1213 'biblioitems
' => $_,
1215 }, grep { !$_->{'overdue
'} } @issues ],
1217 'overdue
' => [ map {
1220 'biblioitems
' => $_,
1222 }, grep { $_->{'overdue
'} } @issues ],
1225 $_->{'timestamp
'} = $_->{'newdate
'};
1227 } @{ GetNewsToDisplay("slip",$branch) } ],
1231 return C4::Letters::GetPreparedLetter (
1232 module => 'circulation
',
1233 letter_code => $letter_code,
1234 branchcode => $branch,
1236 'branches
' => $branch,
1237 'borrowers
' => $borrowernumber,
1243 =head2 GetBorrowersWithEmail
1245 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me
@example.com
');
1247 This gets a list of users and their basic details from their email address.
1248 As it's possible
for multiple user to have the same email address
, it provides
1249 you with all of them
. If there is
no userid
for the user
, there will be an
1250 C
<undef> there
. An empty list will be returned
if there are
no matches
.
1254 sub GetBorrowersWithEmail
{
1257 my $dbh = C4
::Context
->dbh;
1259 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
1260 my $sth=$dbh->prepare($query);
1261 $sth->execute($email);
1263 while (my $ref = $sth->fetch) {
1266 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
1270 =head2 AddMember_Auto
1274 sub AddMember_Auto
{
1275 my ( %borrower ) = @_;
1277 $borrower{'cardnumber'} ||= fixup_cardnumber
();
1279 $borrower{'borrowernumber'} = AddMember
(%borrower);
1281 return ( %borrower );
1284 =head2 AddMember_Opac
1288 sub AddMember_Opac
{
1289 my ( %borrower ) = @_;
1291 $borrower{'categorycode'} //= C4
::Context
->preference('PatronSelfRegistrationDefaultCategory');
1292 if (not defined $borrower{'password'}){
1293 my $sr = new String
::Random
;
1294 $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
1295 my $password = $sr->randpattern("AAAAAAAAAA");
1296 $borrower{'password'} = $password;
1299 %borrower = AddMember_Auto
(%borrower);
1301 return ( $borrower{'borrowernumber'}, $borrower{'password'} );
1304 =head2 DeleteExpiredOpacRegistrations
1306 Delete accounts that haven't been upgraded from the 'temporary' category
1307 Returns the number of removed patrons
1311 sub DeleteExpiredOpacRegistrations
{
1313 my $delay = C4
::Context
->preference('PatronSelfRegistrationExpireTemporaryAccountsDelay');
1314 my $category_code = C4
::Context
->preference('PatronSelfRegistrationDefaultCategory');
1316 return 0 if not $category_code or not defined $delay or $delay eq q
||;
1319 SELECT borrowernumber
1321 WHERE categorycode
= ? AND DATEDIFF
( NOW
(), dateenrolled
) > ?
|;
1323 my $dbh = C4
::Context
->dbh;
1324 my $sth = $dbh->prepare($query);
1325 $sth->execute( $category_code, $delay );
1327 while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
1328 Koha
::Patrons
->find($borrowernumber)->delete;
1334 =head2 DeleteUnverifiedOpacRegistrations
1336 Delete all unverified self registrations in borrower_modifications,
1337 older than the specified number of days.
1341 sub DeleteUnverifiedOpacRegistrations
{
1343 my $dbh = C4
::Context
->dbh;
1345 DELETE FROM borrower_modifications
1346 WHERE borrowernumber
= 0 AND DATEDIFF
( NOW
(), timestamp
) > ?
|;
1347 my $cnt=$dbh->do($sql, undef, ($days) );
1348 return $cnt eq '0E0'?
0: $cnt;
1351 sub GetOverduesForPatron
{
1352 my ( $borrowernumber ) = @_;
1356 FROM issues, items, biblio, biblioitems
1357 WHERE items.itemnumber=issues.itemnumber
1358 AND biblio.biblionumber = items.biblionumber
1359 AND biblio.biblionumber = biblioitems.biblionumber
1360 AND issues.borrowernumber = ?
1361 AND date_due < NOW()
1364 my $sth = C4
::Context
->dbh->prepare( $sql );
1365 $sth->execute( $borrowernumber );
1367 return $sth->fetchall_arrayref({});
1370 END { } # module clean-up code here (global destructor)