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 Add_Delta_YM 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 Koha::Patron::Debarments qw(IsDebarred);
41 use Text::Unaccent qw( unac_string );
42 use Koha::AuthUtils qw(hash_password);
44 use Koha::List::Patron;
46 our (@ISA,@EXPORT,@EXPORT_OK,$debug);
48 use Module::Load::Conditional qw( can_load );
49 if ( ! can_load( modules => { 'Koha::NorwegianPatronDB' => undef } ) ) {
50 $debug && warn "Unable to load Koha::NorwegianPatronDB";
55 $debug = $ENV{DEBUG} || 0;
65 &GetMemberIssuesAndFines
69 &GetFirstValidEmailAddress
70 &GetNoticeEmailAddress
76 &GetHideLostItemsPreference
79 &GetMemberAccountRecords
80 &GetBorNotifyAcctRecord
84 GetBorrowerCategorycode
85 &GetBorrowercategoryList
87 &GetBorrowersToExpunge
88 &GetBorrowersWhoHaveNeverBorrowed
89 &GetBorrowersWithIssuesHistoryOlderThan
92 &GetUpcomingMembershipExpires
117 &ExtendMemberSubscriptionTo
133 C4::Members - Perl Module containing convenience functions for member handling
141 This module contains routines for adding, modifying and deleting members/patrons/borrowers
145 =head2 GetMemberDetails
147 ($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
149 Looks up a patron and returns information about him or her. If
150 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
151 up the borrower by number; otherwise, it looks up the borrower by card
154 C<$borrower> is a reference-to-hash whose keys are the fields of the
155 borrowers table in the Koha database. In addition,
156 C<$borrower-E<gt>{flags}> is a hash giving more detailed information
157 about the patron. Its keys act as flags :
159 if $borrower->{flags}->{LOST} {
160 # Patron's card was reported lost
163 If the state of a flag means that the patron should not be
164 allowed to borrow any more books, then it will have a C<noissues> key
167 See patronflags for more details.
169 C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
170 about the top-level permissions flags set for the borrower. For example,
171 if a user has the "editcatalogue" permission,
172 C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
177 sub GetMemberDetails {
178 my ( $borrowernumber, $cardnumber ) = @_;
179 my $dbh = C4::Context->dbh;
182 if ($borrowernumber) {
183 $sth = $dbh->prepare("
186 categories.description,
187 categories.BlockExpiredPatronOpacActions,
191 LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
192 WHERE borrowernumber = ?
194 $sth->execute($borrowernumber);
196 elsif ($cardnumber) {
197 $sth = $dbh->prepare("
200 categories.description,
201 categories.BlockExpiredPatronOpacActions,
205 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
208 $sth->execute($cardnumber);
213 my $borrower = $sth->fetchrow_hashref;
214 return unless $borrower;
215 my ($amount) = GetMemberAccountRecords($borrower->{borrowernumber});
216 $borrower->{'amountoutstanding'} = $amount;
217 # FIXME - patronflags calls GetMemberAccountRecords... just have patronflags return $amount
218 my $flags = patronflags( $borrower);
221 $sth = $dbh->prepare("select bit,flag from userflags");
223 while ( my ( $bit, $flag ) = $sth->fetchrow ) {
224 if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
225 $accessflagshash->{$flag} = 1;
228 $borrower->{'flags'} = $flags;
229 $borrower->{'authflags'} = $accessflagshash;
231 # Handle setting the true behavior for BlockExpiredPatronOpacActions
232 $borrower->{'BlockExpiredPatronOpacActions'} =
233 C4::Context->preference('BlockExpiredPatronOpacActions')
234 if ( $borrower->{'BlockExpiredPatronOpacActions'} == -1 );
236 $borrower->{'is_expired'} = 0;
237 $borrower->{'is_expired'} = 1 if
238 defined($borrower->{dateexpiry}) &&
239 $borrower->{'dateexpiry'} ne '0000-00-00' &&
240 Date_to_Days( Today() ) >
241 Date_to_Days( split /-/, $borrower->{'dateexpiry'} );
243 return ($borrower); #, $flags, $accessflagshash);
248 $flags = &patronflags($patron);
250 This function is not exported.
252 The following will be set where applicable:
253 $flags->{CHARGES}->{amount} Amount of debt
254 $flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge)
255 $flags->{CHARGES}->{message} Message -- deprecated
257 $flags->{CREDITS}->{amount} Amount of credit
258 $flags->{CREDITS}->{message} Message -- deprecated
260 $flags->{ GNA } Patron has no valid address
261 $flags->{ GNA }->{noissues} Set for each GNA
262 $flags->{ GNA }->{message} "Borrower has no valid address" -- deprecated
264 $flags->{ LOST } Patron's card reported lost
265 $flags->{ LOST }->{noissues} Set for each LOST
266 $flags->{ LOST }->{message} Message -- deprecated
268 $flags->{DBARRED} Set if patron debarred, no access
269 $flags->{DBARRED}->{noissues} Set for each DBARRED
270 $flags->{DBARRED}->{message} Message -- deprecated
273 $flags->{ NOTES }->{message} The note itself. NOT deprecated
275 $flags->{ ODUES } Set if patron has overdue books.
276 $flags->{ ODUES }->{message} "Yes" -- deprecated
277 $flags->{ ODUES }->{itemlist} ref-to-array: list of overdue books
278 $flags->{ ODUES }->{itemlisttext} Text list of overdue items -- deprecated
280 $flags->{WAITING} Set if any of patron's reserves are available
281 $flags->{WAITING}->{message} Message -- deprecated
282 $flags->{WAITING}->{itemlist} ref-to-array: list of available items
286 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
287 overdue items. Its elements are references-to-hash, each describing an
288 overdue item. The keys are selected fields from the issues, biblio,
289 biblioitems, and items tables of the Koha database.
291 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
292 the overdue items, one per line. Deprecated.
294 =item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
295 available items. Each element is a reference-to-hash whose keys are
296 fields from the reserves table of the Koha database.
300 All the "message" fields that include language generated in this function are deprecated,
301 because such strings belong properly in the display layer.
303 The "message" field that comes from the DB is OK.
307 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
308 # FIXME rename this function.
311 my ( $patroninformation) = @_;
312 my $dbh=C4::Context->dbh;
313 my ($balance, $owing) = GetMemberAccountBalance( $patroninformation->{'borrowernumber'});
316 my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
317 $flaginfo{'message'} = sprintf 'Patron owes %.02f', $owing;
318 $flaginfo{'amount'} = sprintf "%.02f", $owing;
319 if ( $owing > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
320 $flaginfo{'noissues'} = 1;
322 $flags{'CHARGES'} = \%flaginfo;
324 elsif ( $balance < 0 ) {
326 $flaginfo{'message'} = sprintf 'Patron has credit of %.02f', -$balance;
327 $flaginfo{'amount'} = sprintf "%.02f", $balance;
328 $flags{'CREDITS'} = \%flaginfo;
331 # Check the debt of the guarntees of this patron
332 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
333 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
334 if ( defined $no_issues_charge_guarantees ) {
335 my $p = Koha::Patrons->find( $patroninformation->{borrowernumber} );
336 my @guarantees = $p->guarantees();
337 my $guarantees_non_issues_charges;
338 foreach my $g ( @guarantees ) {
339 my ( $b, $n, $o ) = C4::Members::GetMemberAccountBalance( $g->id );
340 $guarantees_non_issues_charges += $n;
343 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
345 $flaginfo{'message'} = sprintf 'patron guarantees owe %.02f', $guarantees_non_issues_charges;
346 $flaginfo{'amount'} = $guarantees_non_issues_charges;
347 $flaginfo{'noissues'} = 1 unless C4::Context->preference("allowfineoverride");
348 $flags{'CHARGES_GUARANTEES'} = \%flaginfo;
352 if ( $patroninformation->{'gonenoaddress'}
353 && $patroninformation->{'gonenoaddress'} == 1 )
356 $flaginfo{'message'} = 'Borrower has no valid address.';
357 $flaginfo{'noissues'} = 1;
358 $flags{'GNA'} = \%flaginfo;
360 if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
362 $flaginfo{'message'} = 'Borrower\'s card reported lost.';
363 $flaginfo{'noissues'} = 1;
364 $flags{'LOST'} = \%flaginfo;
366 if ( $patroninformation->{'debarred'} && check_date( split( /-/, $patroninformation->{'debarred'} ) ) ) {
367 if ( Date_to_Days(Date::Calc::Today) < Date_to_Days( split( /-/, $patroninformation->{'debarred'} ) ) ) {
369 $flaginfo{'debarredcomment'} = $patroninformation->{'debarredcomment'};
370 $flaginfo{'message'} = $patroninformation->{'debarredcomment'};
371 $flaginfo{'noissues'} = 1;
372 $flaginfo{'dateend'} = $patroninformation->{'debarred'};
373 $flags{'DBARRED'} = \%flaginfo;
376 if ( $patroninformation->{'borrowernotes'}
377 && $patroninformation->{'borrowernotes'} )
380 $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
381 $flags{'NOTES'} = \%flaginfo;
383 my ( $odues, $itemsoverdue ) = C4::Overdues::checkoverdues($patroninformation->{'borrowernumber'});
384 if ( $odues && $odues > 0 ) {
386 $flaginfo{'message'} = "Yes";
387 $flaginfo{'itemlist'} = $itemsoverdue;
388 foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
391 $flaginfo{'itemlisttext'} .=
392 "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n"; # newline is display layer
394 $flags{'ODUES'} = \%flaginfo;
396 my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
397 my $nowaiting = scalar @itemswaiting;
398 if ( $nowaiting > 0 ) {
400 $flaginfo{'message'} = "Reserved items available";
401 $flaginfo{'itemlist'} = \@itemswaiting;
402 $flags{'WAITING'} = \%flaginfo;
410 $borrower = &GetMember(%information);
412 Retrieve the first patron record meeting on criteria listed in the
413 C<%information> hash, which should contain one or more
414 pairs of borrowers column names and values, e.g.,
416 $borrower = GetMember(borrowernumber => id);
418 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
419 the C<borrowers> table in the Koha database.
421 FIXME: GetMember() is used throughout the code as a lookup
422 on a unique key such as the borrowernumber, but this meaning is not
423 enforced in the routine itself.
429 my ( %information ) = @_;
430 if (exists $information{borrowernumber} && !defined $information{borrowernumber}) {
431 #passing mysql's kohaadmin?? Makes no sense as a query
434 my $dbh = C4::Context->dbh;
436 q{SELECT borrowers.*, categories.category_type, categories.description
438 LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
441 for (keys %information ) {
449 if (defined $information{$_}) {
451 push @values, $information{$_};
454 $select .= "$_ IS NULL";
457 $debug && warn $select, " ",values %information;
458 my $sth = $dbh->prepare("$select");
459 $sth->execute(@values);
460 my $data = $sth->fetchall_arrayref({});
461 #FIXME interface to this routine now allows generation of a result set
462 #so whole array should be returned but bowhere in the current code expects this
470 =head2 IsMemberBlocked
472 my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
474 Returns whether a patron is restricted or has overdue items that may result
475 in a block of circulation privileges.
477 C<$block_status> can have the following values:
479 1 if the patron is currently restricted, in which case
480 C<$count> is the expiration date (9999-12-31 for indefinite)
482 -1 if the patron has overdue items, in which case C<$count> is the number of them
484 0 if the patron has no overdue items or outstanding fine days, in which case C<$count> is 0
486 Existing active restrictions are checked before current overdue items.
490 sub IsMemberBlocked {
491 my $borrowernumber = shift;
492 my $dbh = C4::Context->dbh;
494 my $blockeddate = Koha::Patron::Debarments::IsDebarred($borrowernumber);
496 return ( 1, $blockeddate ) if $blockeddate;
498 # if he have late issues
499 my $sth = $dbh->prepare(
500 "SELECT COUNT(*) as latedocs
502 WHERE borrowernumber = ?
503 AND date_due < now()"
505 $sth->execute($borrowernumber);
506 my $latedocs = $sth->fetchrow_hashref->{'latedocs'};
508 return ( -1, $latedocs ) if $latedocs > 0;
513 =head2 GetMemberIssuesAndFines
515 ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
517 Returns aggregate data about items borrowed by the patron with the
518 given borrowernumber.
520 C<&GetMemberIssuesAndFines> returns a three-element array. C<$overdue_count> is the
521 number of overdue items the patron currently has borrowed. C<$issue_count> is the
522 number of books the patron currently has borrowed. C<$total_fines> is
523 the total fine currently due by the borrower.
528 sub GetMemberIssuesAndFines {
529 my ( $borrowernumber ) = @_;
530 my $dbh = C4::Context->dbh;
531 my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
533 $debug and warn $query."\n";
534 my $sth = $dbh->prepare($query);
535 $sth->execute($borrowernumber);
536 my $issue_count = $sth->fetchrow_arrayref->[0];
538 $sth = $dbh->prepare(
539 "SELECT COUNT(*) FROM issues
540 WHERE borrowernumber = ?
541 AND date_due < now()"
543 $sth->execute($borrowernumber);
544 my $overdue_count = $sth->fetchrow_arrayref->[0];
546 $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
547 $sth->execute($borrowernumber);
548 my $total_fines = $sth->fetchrow_arrayref->[0];
550 return ($overdue_count, $issue_count, $total_fines);
556 my @columns = C4::Member::columns();
558 Returns an array of borrowers' table columns on success,
559 and an empty array on failure.
565 # Pure ANSI SQL goodness.
566 my $sql = 'SELECT * FROM borrowers WHERE 1=0;';
568 # Get the database handle.
569 my $dbh = C4::Context->dbh;
571 # Run the SQL statement to load STH's readonly properties.
572 my $sth = $dbh->prepare($sql);
573 my $rv = $sth->execute();
575 # This only fails if the table doesn't exist.
576 # This will always be called AFTER an install or upgrade,
577 # so borrowers will exist!
579 if ($sth->{NUM_OF_FIELDS}>0) {
580 @data = @{$sth->{NAME}};
591 my $success = ModMember(borrowernumber => $borrowernumber,
592 [ field => value ]... );
594 Modify borrower's data. All date fields should ALREADY be in ISO format.
597 true on success, or false on failure
603 # test to know if you must update or not the borrower password
604 if (exists $data{password}) {
605 if ($data{password} eq '****' or $data{password} eq '') {
606 delete $data{password};
608 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
609 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
610 Koha::NorwegianPatronDB::NLUpdateHashedPIN( $data{'borrowernumber'}, $data{password} );
612 $data{password} = hash_password($data{password});
616 my $old_categorycode = GetBorrowerCategorycode( $data{borrowernumber} );
618 # get only the columns of a borrower
619 my $schema = Koha::Database->new()->schema;
620 my @columns = $schema->source('Borrower')->columns;
621 my $new_borrower = { map { join(' ', @columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) };
622 delete $new_borrower->{flags};
624 $new_borrower->{dateofbirth} ||= undef if exists $new_borrower->{dateofbirth};
625 $new_borrower->{dateenrolled} ||= undef if exists $new_borrower->{dateenrolled};
626 $new_borrower->{dateexpiry} ||= undef if exists $new_borrower->{dateexpiry};
627 $new_borrower->{debarred} ||= undef if exists $new_borrower->{debarred};
628 $new_borrower->{sms_provider_id} ||= undef if exists $new_borrower->{sms_provider_id};
630 my $rs = $schema->resultset('Borrower')->search({
631 borrowernumber => $new_borrower->{borrowernumber},
634 my $execute_success = $rs->update($new_borrower);
635 if ($execute_success ne '0E0') { # only proceed if the update was a success
636 # If the patron changes to a category with enrollment fee, we add a fee
637 if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
638 if ( C4::Context->preference('FeeOnChangePatronCategory') ) {
639 AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
643 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
644 # cronjob will use for syncing with NL
645 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
646 my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
647 'synctype' => 'norwegianpatrondb',
648 'borrowernumber' => $data{'borrowernumber'}
650 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
651 # we can sync as changed. And the "new sync" will pick up all changes since
652 # the patron was created anyway.
653 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
654 $borrowersync->update( { 'syncstatus' => 'edited' } );
656 # Set the value of 'sync'
657 $borrowersync->update( { 'sync' => $data{'sync'} } );
658 # Try to do the live sync
659 Koha::NorwegianPatronDB::NLSync({ 'borrowernumber' => $data{'borrowernumber'} });
662 logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
664 return $execute_success;
669 $borrowernumber = &AddMember(%borrower);
671 insert new borrower into table
673 (%borrower keys are database columns. Database columns could be
674 different in different versions. Please look into database for correct
677 Returns the borrowernumber upon success
679 Returns as undef upon any db error without further processing
686 my $dbh = C4::Context->dbh;
687 my $schema = Koha::Database->new()->schema;
689 # generate a proper login if none provided
690 $data{'userid'} = Generate_Userid( $data{'borrowernumber'}, $data{'firstname'}, $data{'surname'} )
691 if ( $data{'userid'} eq '' || !Check_Userid( $data{'userid'} ) );
693 # add expiration date if it isn't already there
694 unless ( $data{'dateexpiry'} ) {
695 $data{'dateexpiry'} = GetExpiryDate( $data{'categorycode'}, output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } ) );
698 # add enrollment date if it isn't already there
699 unless ( $data{'dateenrolled'} ) {
700 $data{'dateenrolled'} = output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
703 my $patron_category = $schema->resultset('Category')->find( $data{'categorycode'} );
705 $patron_category->default_privacy() eq 'default' ? 1
706 : $patron_category->default_privacy() eq 'never' ? 2
707 : $patron_category->default_privacy() eq 'forever' ? 0
710 $data{'privacy_guarantor_checkouts'} = 0 unless defined( $data{'privacy_guarantor_checkouts'} );
712 # Make a copy of the plain text password for later use
713 my $plain_text_password = $data{'password'};
715 # create a disabled account if no password provided
716 $data{'password'} = ($data{'password'})? hash_password($data{'password'}) : '!';
718 # we don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00
719 $data{'dateofbirth'} = undef if ( not $data{'dateofbirth'} );
720 $data{'debarred'} = undef if ( not $data{'debarred'} );
721 $data{'sms_provider_id'} = undef if ( not $data{'sms_provider_id'} );
723 # get only the columns of Borrower
724 my @columns = $schema->source('Borrower')->columns;
725 my $new_member = { map { join(' ',@columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) } ;
726 delete $new_member->{borrowernumber};
728 my $rs = $schema->resultset('Borrower');
729 $data{borrowernumber} = $rs->create($new_member)->id;
731 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
732 # cronjob will use for syncing with NL
733 if ( exists $data{'borrowernumber'} && C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
734 Koha::Database->new->schema->resultset('BorrowerSync')->create({
735 'borrowernumber' => $data{'borrowernumber'},
736 'synctype' => 'norwegianpatrondb',
738 'syncstatus' => 'new',
739 'hashed_pin' => Koha::NorwegianPatronDB::NLEncryptPIN( $plain_text_password ),
743 # mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
744 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
746 AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
748 return $data{borrowernumber};
753 my $uniqueness = Check_Userid($userid,$borrowernumber);
755 $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 != '').
757 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.
760 0 for not unique (i.e. this $userid already exists)
761 1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
766 my ( $uid, $borrowernumber ) = @_;
768 return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
770 return 0 if ( $uid eq C4::Context->config('user') );
772 my $rs = Koha::Database->new()->schema()->resultset('Borrower');
775 $params->{userid} = $uid;
776 $params->{borrowernumber} = { '!=' => $borrowernumber } if ($borrowernumber);
778 my $count = $rs->count( $params );
780 return $count ? 0 : 1;
783 =head2 Generate_Userid
785 my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
787 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
789 $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.
792 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).
796 sub Generate_Userid {
797 my ($borrowernumber, $firstname, $surname) = @_;
800 #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
802 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
803 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
804 $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
805 $newuid = unac_string('utf-8',$newuid);
806 $newuid .= $offset unless $offset == 0;
809 } while (!Check_Userid($newuid,$borrowernumber));
815 my ( $uid, $member, $digest ) = @_;
816 my $dbh = C4::Context->dbh;
818 #Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
819 #Then we need to tell the user and have them create a new one.
823 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
824 $sth->execute( $uid, $member );
825 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
829 #Everything is good so we can update the information.
832 "update borrowers set userid=?, password=? where borrowernumber=?");
833 $sth->execute( $uid, $digest, $member );
837 logaction("MEMBERS", "CHANGE PASS", $member, "") if C4::Context->preference("BorrowersLog");
843 =head2 fixup_cardnumber
845 Warning: The caller is responsible for locking the members table in write
846 mode, to avoid database corruption.
850 use vars qw( @weightings );
851 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
853 sub fixup_cardnumber {
854 my ($cardnumber) = @_;
855 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
857 # Find out whether member numbers should be generated
858 # automatically. Should be either "1" or something else.
859 # Defaults to "0", which is interpreted as "no".
861 # if ($cardnumber !~ /\S/ && $autonumber_members) {
862 ($autonumber_members) or return $cardnumber;
863 my $checkdigit = C4::Context->preference('checkdigit');
864 my $dbh = C4::Context->dbh;
865 if ( $checkdigit and $checkdigit eq 'katipo' ) {
867 # if checkdigit is selected, calculate katipo-style cardnumber.
868 # otherwise, just use the max()
869 # purpose: generate checksum'd member numbers.
870 # We'll assume we just got the max value of digits 2-8 of member #'s
871 # from the database and our job is to increment that by one,
872 # determine the 1st and 9th digits and return the full string.
873 my $sth = $dbh->prepare(
874 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
877 my $data = $sth->fetchrow_hashref;
878 $cardnumber = $data->{new_num};
879 if ( !$cardnumber ) { # If DB has no values,
880 $cardnumber = 1000000; # start at 1000000
886 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
887 # read weightings, left to right, 1 char at a time
888 my $temp1 = $weightings[$i];
890 # sequence left to right, 1 char at a time
891 my $temp2 = substr( $cardnumber, $i, 1 );
893 # mult each char 1-7 by its corresponding weighting
894 $sum += $temp1 * $temp2;
897 my $rem = ( $sum % 11 );
898 $rem = 'X' if $rem == 10;
900 return "V$cardnumber$rem";
903 my $sth = $dbh->prepare(
904 'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
907 my ($result) = $sth->fetchrow;
910 return $cardnumber; # just here as a fallback/reminder
913 =head2 GetPendingIssues
915 my $issues = &GetPendingIssues(@borrowernumber);
917 Looks up what the patron with the given borrowernumber has borrowed.
919 C<&GetPendingIssues> returns a
920 reference-to-array where each element is a reference-to-hash; the
921 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
922 The keys include C<biblioitems> fields except marc and marcxml.
926 sub GetPendingIssues {
927 my @borrowernumbers = @_;
929 unless (@borrowernumbers ) { # return a ref_to_array
930 return \@borrowernumbers; # to not cause surprise to caller
933 # Borrowers part of the query
935 for (my $i = 0; $i < @borrowernumbers; $i++) {
936 $bquery .= ' issues.borrowernumber = ?';
937 if ($i < $#borrowernumbers ) {
942 # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
943 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
944 # FIXME: circ/ciculation.pl tries to sort by timestamp!
945 # FIXME: namespace collision: other collisions possible.
946 # FIXME: most of this data isn't really being used by callers.
953 biblioitems.itemtype,
956 biblioitems.publicationyear,
957 biblioitems.publishercode,
958 biblioitems.volumedate,
959 biblioitems.volumedesc,
964 borrowers.cardnumber,
965 issues.timestamp AS timestamp,
966 issues.renewals AS renewals,
967 issues.borrowernumber AS borrowernumber,
968 items.renewals AS totalrenewals
970 LEFT JOIN items ON items.itemnumber = issues.itemnumber
971 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
972 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
973 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
976 ORDER BY issues.issuedate"
979 my $sth = C4::Context->dbh->prepare($query);
980 $sth->execute(@borrowernumbers);
981 my $data = $sth->fetchall_arrayref({});
982 my $today = dt_from_string;
984 if ($_->{issuedate}) {
985 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
987 $_->{date_due_sql} = $_->{date_due};
988 # FIXME no need to have this value
989 $_->{date_due} or next;
990 $_->{date_due_sql} = $_->{date_due};
991 # FIXME no need to have this value
992 $_->{date_due} = dt_from_string($_->{date_due}, 'sql');
993 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
1002 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
1004 Looks up what the patron with the given borrowernumber has borrowed,
1005 and sorts the results.
1007 C<$sortkey> is the name of a field on which to sort the results. This
1008 should be the name of a field in the C<issues>, C<biblio>,
1009 C<biblioitems>, or C<items> table in the Koha database.
1011 C<$limit> is the maximum number of results to return.
1013 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
1014 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
1015 C<items> tables of the Koha database.
1021 my ( $borrowernumber, $order, $limit ) = @_;
1023 return unless $borrowernumber;
1024 $order = 'date_due desc' unless $order;
1026 my $dbh = C4::Context->dbh;
1028 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1030 LEFT JOIN items on items.itemnumber=issues.itemnumber
1031 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1032 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1033 WHERE borrowernumber=?
1035 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1037 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
1038 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1039 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1040 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
1041 order by ' . $order;
1043 $query .= " limit $limit";
1046 my $sth = $dbh->prepare($query);
1047 $sth->execute( $borrowernumber, $borrowernumber );
1048 return $sth->fetchall_arrayref( {} );
1052 =head2 GetMemberAccountRecords
1054 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
1056 Looks up accounting data for the patron with the given borrowernumber.
1058 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
1059 reference-to-array, where each element is a reference-to-hash; the
1060 keys are the fields of the C<accountlines> table in the Koha database.
1061 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1062 total amount outstanding for all of the account lines.
1066 sub GetMemberAccountRecords {
1067 my ($borrowernumber) = @_;
1068 my $dbh = C4::Context->dbh;
1074 WHERE borrowernumber=?);
1075 $strsth.=" ORDER BY accountlines_id desc";
1076 my $sth= $dbh->prepare( $strsth );
1077 $sth->execute( $borrowernumber );
1080 while ( my $data = $sth->fetchrow_hashref ) {
1081 if ( $data->{itemnumber} ) {
1082 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1083 $data->{biblionumber} = $biblio->{biblionumber};
1084 $data->{title} = $biblio->{title};
1086 $acctlines[$numlines] = $data;
1088 $total += sprintf "%.0f", 1000*$data->{amountoutstanding}; # convert float to integer to avoid round-off errors
1091 return ( $total, \@acctlines,$numlines);
1094 =head2 GetMemberAccountBalance
1096 ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
1098 Calculates amount immediately owing by the patron - non-issue charges.
1099 Based on GetMemberAccountRecords.
1100 Charges exempt from non-issue are:
1102 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
1103 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
1107 sub GetMemberAccountBalance {
1108 my ($borrowernumber) = @_;
1110 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
1113 push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
1114 push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
1115 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
1116 my $dbh = C4::Context->dbh;
1117 my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
1118 push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
1120 my %not_fine = map {$_ => 1} @not_fines;
1122 my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
1123 my $other_charges = 0;
1124 foreach (@$acctlines) {
1125 $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
1128 return ( $total, $total - $other_charges, $other_charges);
1131 =head2 GetBorNotifyAcctRecord
1133 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1135 Looks up accounting data for the patron with the given borrowernumber per file number.
1137 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1138 reference-to-array, where each element is a reference-to-hash; the
1139 keys are the fields of the C<accountlines> table in the Koha database.
1140 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1141 total amount outstanding for all of the account lines.
1145 sub GetBorNotifyAcctRecord {
1146 my ( $borrowernumber, $notifyid ) = @_;
1147 my $dbh = C4::Context->dbh;
1150 my $sth = $dbh->prepare(
1153 WHERE borrowernumber=?
1155 AND amountoutstanding != '0'
1156 ORDER BY notify_id,accounttype
1159 $sth->execute( $borrowernumber, $notifyid );
1161 while ( my $data = $sth->fetchrow_hashref ) {
1162 if ( $data->{itemnumber} ) {
1163 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1164 $data->{biblionumber} = $biblio->{biblionumber};
1165 $data->{title} = $biblio->{title};
1167 $acctlines[$numlines] = $data;
1169 $total += int(100 * $data->{'amountoutstanding'});
1172 return ( $total, \@acctlines, $numlines );
1175 =head2 checkuniquemember (OUEST-PROVENCE)
1177 ($result,$categorycode) = &checkuniquemember($collectivity,$surname,$firstname,$dateofbirth);
1179 Checks that a member exists or not in the database.
1181 C<&result> is nonzero (=exist) or 0 (=does not exist)
1182 C<&categorycode> is from categorycode table
1183 C<&collectivity> is 1 (= we add a collectivity) or 0 (= we add a physical member)
1184 C<&surname> is the surname
1185 C<&firstname> is the firstname (only if collectivity=0)
1186 C<&dateofbirth> is the date of birth in ISO format (only if collectivity=0)
1190 # FIXME: This function is not legitimate. Multiple patrons might have the same first/last name and birthdate.
1191 # This is especially true since first name is not even a required field.
1193 sub checkuniquemember {
1194 my ( $collectivity, $surname, $firstname, $dateofbirth ) = @_;
1195 my $dbh = C4::Context->dbh;
1196 my $request = ($collectivity) ?
1197 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? " :
1199 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=? and dateofbirth=?" :
1200 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?";
1201 my $sth = $dbh->prepare($request);
1202 if ($collectivity) {
1203 $sth->execute( uc($surname) );
1204 } elsif($dateofbirth){
1205 $sth->execute( uc($surname), ucfirst($firstname), $dateofbirth );
1207 $sth->execute( uc($surname), ucfirst($firstname));
1209 my @data = $sth->fetchrow;
1210 ( $data[0] ) and return $data[0], $data[1];
1214 sub checkcardnumber {
1215 my ( $cardnumber, $borrowernumber ) = @_;
1217 # If cardnumber is null, we assume they're allowed.
1218 return 0 unless defined $cardnumber;
1220 my $dbh = C4::Context->dbh;
1221 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1222 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1223 my $sth = $dbh->prepare($query);
1226 ( $borrowernumber ? $borrowernumber : () )
1229 return 1 if $sth->fetchrow_hashref;
1231 my ( $min_length, $max_length ) = get_cardnumber_length();
1233 if length $cardnumber > $max_length
1234 or length $cardnumber < $min_length;
1239 =head2 get_cardnumber_length
1241 my ($min, $max) = C4::Members::get_cardnumber_length()
1243 Returns the minimum and maximum length for patron cardnumbers as
1244 determined by the CardnumberLength system preference, the
1245 BorrowerMandatoryField system preference, and the width of the
1250 sub get_cardnumber_length {
1251 my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
1252 $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
1253 if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
1254 # Is integer and length match
1255 if ( $cardnumber_length =~ m|^\d+$| ) {
1256 $min = $max = $cardnumber_length
1257 if $cardnumber_length >= $min
1258 and $cardnumber_length <= $max;
1260 # Else assuming it is a range
1261 elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
1262 $min = $1 if $1 and $min < $1;
1263 $max = $2 if $2 and $max > $2;
1267 return ( $min, $max );
1270 =head2 GetFirstValidEmailAddress
1272 $email = GetFirstValidEmailAddress($borrowernumber);
1274 Return the first valid email address for a borrower, given the borrowernumber. For now, the order
1275 is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
1280 sub GetFirstValidEmailAddress {
1281 my $borrowernumber = shift;
1282 my $dbh = C4::Context->dbh;
1283 my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1284 $sth->execute( $borrowernumber );
1285 my $data = $sth->fetchrow_hashref;
1287 if ($data->{'email'}) {
1288 return $data->{'email'};
1289 } elsif ($data->{'emailpro'}) {
1290 return $data->{'emailpro'};
1291 } elsif ($data->{'B_email'}) {
1292 return $data->{'B_email'};
1298 =head2 GetNoticeEmailAddress
1300 $email = GetNoticeEmailAddress($borrowernumber);
1302 Return the email address of borrower used for notices, given the borrowernumber.
1303 Returns the empty string if no email address.
1307 sub GetNoticeEmailAddress {
1308 my $borrowernumber = shift;
1310 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1311 # if syspref is set to 'first valid' (value == OFF), look up email address
1312 if ( $which_address eq 'OFF' ) {
1313 return GetFirstValidEmailAddress($borrowernumber);
1315 # specified email address field
1316 my $dbh = C4::Context->dbh;
1317 my $sth = $dbh->prepare( qq{
1318 SELECT $which_address AS primaryemail
1320 WHERE borrowernumber=?
1322 $sth->execute($borrowernumber);
1323 my $data = $sth->fetchrow_hashref;
1324 return $data->{'primaryemail'} || '';
1327 =head2 GetExpiryDate
1329 $expirydate = GetExpiryDate($categorycode, $dateenrolled);
1331 Calculate expiry date given a categorycode and starting date. Date argument must be in ISO format.
1332 Return date is also in ISO format.
1337 my ( $categorycode, $dateenrolled ) = @_;
1339 if ($categorycode) {
1340 my $dbh = C4::Context->dbh;
1341 my $sth = $dbh->prepare("SELECT enrolmentperiod,enrolmentperioddate FROM categories WHERE categorycode=?");
1342 $sth->execute($categorycode);
1343 $enrolments = $sth->fetchrow_hashref;
1345 # die "GetExpiryDate: for enrollmentperiod $enrolmentperiod (category '$categorycode') starting $dateenrolled.\n";
1346 my @date = split (/-/,$dateenrolled);
1347 if($enrolments->{enrolmentperiod}){
1348 return sprintf("%04d-%02d-%02d", Add_Delta_YM(@date,0,$enrolments->{enrolmentperiod}));
1350 return $enrolments->{enrolmentperioddate};
1354 =head2 GetUpcomingMembershipExpires
1356 my $upcoming_mem_expires = GetUpcomingMembershipExpires();
1360 sub GetUpcomingMembershipExpires {
1361 my $dbh = C4::Context->dbh;
1362 my $days = C4::Context->preference("MembershipExpiryDaysNotice") || 0;
1363 my $dateexpiry = output_pref({ dt => (dt_from_string()->add( days => $days)), dateformat => 'iso', dateonly => 1 });
1366 SELECT borrowers.*, categories.description,
1367 branches.branchname, branches.branchemail FROM borrowers
1368 LEFT JOIN branches on borrowers.branchcode = branches.branchcode
1369 LEFT JOIN categories on borrowers.categorycode = categories.categorycode
1370 WHERE dateexpiry = ?;
1372 my $sth = $dbh->prepare($query);
1373 $sth->execute($dateexpiry);
1374 my $results = $sth->fetchall_arrayref({});
1378 =head2 GetborCatFromCatType
1380 ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
1382 Looks up the different types of borrowers in the database. Returns two
1383 elements: a reference-to-array, which lists the borrower category
1384 codes, and a reference-to-hash, which maps the borrower category codes
1385 to category descriptions.
1390 sub GetborCatFromCatType {
1391 my ( $category_type, $action, $no_branch_limit ) = @_;
1393 my $branch_limit = $no_branch_limit
1395 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1397 # FIXME - This API seems both limited and dangerous.
1398 my $dbh = C4::Context->dbh;
1401 SELECT categories.categorycode, categories.description
1405 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1408 $request .= " $action ";
1409 $request .= " AND (branchcode = ? OR branchcode IS NULL) GROUP BY description" if $branch_limit;
1411 $request .= " WHERE branchcode = ? OR branchcode IS NULL GROUP BY description" if $branch_limit;
1413 $request .= " ORDER BY categorycode";
1415 my $sth = $dbh->prepare($request);
1417 $action ? $category_type : (),
1418 $branch_limit ? $branch_limit : ()
1424 while ( my $data = $sth->fetchrow_hashref ) {
1425 push @codes, $data->{'categorycode'};
1426 $labels{ $data->{'categorycode'} } = $data->{'description'};
1429 return ( \@codes, \%labels );
1432 =head2 GetBorrowercategory
1434 $hashref = &GetBorrowercategory($categorycode);
1436 Given the borrower's category code, the function returns the corresponding
1437 data hashref for a comprehensive information display.
1441 sub GetBorrowercategory {
1443 my $dbh = C4::Context->dbh;
1447 "SELECT description,dateofbirthrequired,upperagelimit,category_type
1449 WHERE categorycode = ?"
1451 $sth->execute($catcode);
1453 $sth->fetchrow_hashref;
1457 } # sub getborrowercategory
1460 =head2 GetBorrowerCategorycode
1462 $categorycode = &GetBorrowerCategoryCode( $borrowernumber );
1464 Given the borrowernumber, the function returns the corresponding categorycode
1468 sub GetBorrowerCategorycode {
1469 my ( $borrowernumber ) = @_;
1470 my $dbh = C4::Context->dbh;
1471 my $sth = $dbh->prepare( qq{
1474 WHERE borrowernumber = ?
1476 $sth->execute( $borrowernumber );
1477 return $sth->fetchrow;
1480 =head2 GetBorrowercategoryList
1482 $arrayref_hashref = &GetBorrowercategoryList;
1483 If no category code provided, the function returns all the categories.
1487 sub GetBorrowercategoryList {
1488 my $no_branch_limit = @_ ? shift : 0;
1489 my $branch_limit = $no_branch_limit
1491 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1492 my $dbh = C4::Context->dbh;
1493 my $query = "SELECT categories.* FROM categories";
1495 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1496 WHERE branchcode = ? OR branchcode IS NULL GROUP BY description
1498 $query .= " ORDER BY description";
1499 my $sth = $dbh->prepare( $query );
1500 $sth->execute( $branch_limit ? $branch_limit : () );
1501 my $data = $sth->fetchall_arrayref( {} );
1504 } # sub getborrowercategory
1508 $dateofbirth,$date = &GetAge($date);
1510 this function return the borrowers age with the value of dateofbirth
1516 my ( $date, $date_ref ) = @_;
1518 if ( not defined $date_ref ) {
1519 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1522 my ( $year1, $month1, $day1 ) = split /-/, $date;
1523 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1525 my $age = $year2 - $year1;
1526 if ( $month1 . $day1 > $month2 . $day2 ) {
1535 $borrower = C4::Members::SetAge($borrower, $datetimeduration);
1536 $borrower = C4::Members::SetAge($borrower, '0015-12-10');
1537 $borrower = C4::Members::SetAge($borrower, $datetimeduration, $datetime_reference);
1539 eval { $borrower = C4::Members::SetAge($borrower, '015-1-10'); };
1540 if ($@) {print $@;} #Catch a bad ISO Date or kill your script!
1542 This function sets the borrower's dateofbirth to match the given age.
1543 Optionally relative to the given $datetime_reference.
1545 @PARAM1 koha.borrowers-object
1546 @PARAM2 DateTime::Duration-object as the desired age
1547 OR a ISO 8601 Date. (To make the API more pleasant)
1548 @PARAM3 DateTime-object as the relative date, defaults to now().
1549 RETURNS The given borrower reference @PARAM1.
1550 DIES If there was an error with the ISO Date handling.
1556 my ( $borrower, $datetimeduration, $datetime_ref ) = @_;
1557 $datetime_ref = DateTime->now() unless $datetime_ref;
1559 if ($datetimeduration && ref $datetimeduration ne 'DateTime::Duration') {
1560 if ($datetimeduration =~ /^(\d{4})-(\d{2})-(\d{2})/) {
1561 $datetimeduration = DateTime::Duration->new(years => $1, months => $2, days => $3);
1564 die "C4::Members::SetAge($borrower, $datetimeduration), datetimeduration not a valid ISO 8601 Date!\n";
1568 my $new_datetime_ref = $datetime_ref->clone();
1569 $new_datetime_ref->subtract_duration( $datetimeduration );
1571 $borrower->{dateofbirth} = $new_datetime_ref->ymd();
1576 =head2 GetSortDetails (OUEST-PROVENCE)
1578 ($lib) = &GetSortDetails($category,$sortvalue);
1580 Returns the authorized value details
1581 C<&$lib>return value of authorized value details
1582 C<&$sortvalue>this is the value of authorized value
1583 C<&$category>this is the value of authorized value category
1587 sub GetSortDetails {
1588 my ( $category, $sortvalue ) = @_;
1589 my $dbh = C4::Context->dbh;
1590 my $query = qq|SELECT lib
1591 FROM authorised_values
1593 AND authorised_value=? |;
1594 my $sth = $dbh->prepare($query);
1595 $sth->execute( $category, $sortvalue );
1596 my $lib = $sth->fetchrow;
1597 return ($lib) if ($lib);
1598 return ($sortvalue) unless ($lib);
1601 =head2 MoveMemberToDeleted
1603 $result = &MoveMemberToDeleted($borrowernumber);
1605 Copy the record from borrowers to deletedborrowers table.
1606 The routine returns 1 for success, undef for failure.
1610 sub MoveMemberToDeleted {
1611 my ($member) = shift or return;
1613 my $schema = Koha::Database->new()->schema();
1614 my $borrowers_rs = $schema->resultset('Borrower');
1615 $borrowers_rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
1616 my $borrower = $borrowers_rs->find($member);
1617 return unless $borrower;
1619 my $deleted = $schema->resultset('Deletedborrower')->create($borrower);
1621 return $deleted ? 1 : undef;
1626 DelMember($borrowernumber);
1628 This function remove directly a borrower whitout writing it on deleteborrower.
1629 + Deletes reserves for the borrower
1634 my $dbh = C4::Context->dbh;
1635 my $borrowernumber = shift;
1636 #warn "in delmember with $borrowernumber";
1637 return unless $borrowernumber; # borrowernumber is mandatory.
1639 my $query = qq|DELETE
1641 WHERE borrowernumber=?|;
1642 my $sth = $dbh->prepare($query);
1643 $sth->execute($borrowernumber);
1647 WHERE borrowernumber = ?
1649 $sth = $dbh->prepare($query);
1650 $sth->execute($borrowernumber);
1651 logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
1655 =head2 HandleDelBorrower
1657 HandleDelBorrower($borrower);
1659 When a member is deleted (DelMember in Members.pm), you should call me first.
1660 This routine deletes/moves lists and entries for the deleted member/borrower.
1661 Lists owned by the borrower are deleted, but entries from the borrower to
1662 other lists are kept.
1666 sub HandleDelBorrower {
1669 my $dbh = C4::Context->dbh;
1671 #Delete all lists and all shares of this borrower
1672 #Consistent with the approach Koha uses on deleting individual lists
1673 #Note that entries in virtualshelfcontents added by this borrower to
1674 #lists of others will be handled by a table constraint: the borrower
1675 #is set to NULL in those entries.
1676 $query="DELETE FROM virtualshelves WHERE owner=?";
1677 $dbh->do($query,undef,($borrower));
1680 #We could handle the above deletes via a constraint too.
1681 #But a new BZ report 11889 has been opened to discuss another approach.
1682 #Instead of deleting we could also disown lists (based on a pref).
1683 #In that way we could save shared and public lists.
1684 #The current table constraints support that idea now.
1685 #This pref should then govern the results of other routines/methods such as
1686 #Koha::Virtualshelf->new->delete too.
1689 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1691 $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1693 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1698 sub ExtendMemberSubscriptionTo {
1699 my ( $borrowerid,$date) = @_;
1700 my $dbh = C4::Context->dbh;
1701 my $borrower = GetMember('borrowernumber'=>$borrowerid);
1703 $date = (C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry') ?
1704 eval { output_pref( { dt => dt_from_string( $borrower->{'dateexpiry'} ), dateonly => 1, dateformat => 'iso' } ); }
1706 output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
1707 $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
1709 my $sth = $dbh->do(<<EOF);
1711 SET dateexpiry='$date'
1712 WHERE borrowernumber='$borrowerid'
1715 AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
1717 logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
1718 return $date if ($sth);
1722 =head2 GetTitles (OUEST-PROVENCE)
1724 ($borrowertitle)= &GetTitles();
1726 Looks up the different title . Returns array with all borrowers title
1731 my @borrowerTitle = split (/,|\|/,C4::Context->preference('BorrowersTitles'));
1732 unshift( @borrowerTitle, "" );
1733 my $count=@borrowerTitle;
1738 return ( \@borrowerTitle);
1742 =head2 GetHideLostItemsPreference
1744 $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1746 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1747 C<&$hidelostitemspref>return value of function, 0 or 1
1751 sub GetHideLostItemsPreference {
1752 my ($borrowernumber) = @_;
1753 my $dbh = C4::Context->dbh;
1754 my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1755 my $sth = $dbh->prepare($query);
1756 $sth->execute($borrowernumber);
1757 my $hidelostitems = $sth->fetchrow;
1758 return $hidelostitems;
1761 =head2 GetBorrowersToExpunge
1763 $borrowers = &GetBorrowersToExpunge(
1764 not_borrowed_since => $not_borrowed_since,
1765 expired_before => $expired_before,
1766 category_code => $category_code,
1767 patron_list_id => $patron_list_id,
1768 branchcode => $branchcode
1771 This function get all borrowers based on the given criteria.
1775 sub GetBorrowersToExpunge {
1778 my $filterdate = $params->{'not_borrowed_since'};
1779 my $filterexpiry = $params->{'expired_before'};
1780 my $filtercategory = $params->{'category_code'};
1781 my $filterbranch = $params->{'branchcode'} ||
1782 ((C4::Context->preference('IndependentBranches')
1783 && C4::Context->userenv
1784 && !C4::Context->IsSuperLibrarian()
1785 && C4::Context->userenv->{branch})
1786 ? C4::Context->userenv->{branch}
1788 my $filterpatronlist = $params->{'patron_list_id'};
1790 my $dbh = C4::Context->dbh;
1792 SELECT borrowers.borrowernumber,
1793 MAX(old_issues.timestamp) AS latestissue,
1794 MAX(issues.timestamp) AS currentissue
1796 JOIN categories USING (categorycode)
1800 WHERE guarantorid IS NOT NULL
1801 AND guarantorid <> 0
1802 ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
1803 LEFT JOIN old_issues USING (borrowernumber)
1804 LEFT JOIN issues USING (borrowernumber)|;
1805 if ( $filterpatronlist ){
1806 $query .= q| LEFT JOIN patron_list_patrons USING (borrowernumber)|;
1808 $query .= q| WHERE category_type <> 'S'
1809 AND tmp.guarantorid IS NULL
1812 if ( $filterbranch && $filterbranch ne "" ) {
1813 $query.= " AND borrowers.branchcode = ? ";
1814 push( @query_params, $filterbranch );
1816 if ( $filterexpiry ) {
1817 $query .= " AND dateexpiry < ? ";
1818 push( @query_params, $filterexpiry );
1820 if ( $filtercategory ) {
1821 $query .= " AND categorycode = ? ";
1822 push( @query_params, $filtercategory );
1824 if ( $filterpatronlist ){
1825 $query.=" AND patron_list_id = ? ";
1826 push( @query_params, $filterpatronlist );
1828 $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
1829 if ( $filterdate ) {
1830 $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
1831 push @query_params,$filterdate;
1833 warn $query if $debug;
1835 my $sth = $dbh->prepare($query);
1836 if (scalar(@query_params)>0){
1837 $sth->execute(@query_params);
1844 while ( my $data = $sth->fetchrow_hashref ) {
1845 push @results, $data;
1850 =head2 GetBorrowersWhoHaveNeverBorrowed
1852 $results = &GetBorrowersWhoHaveNeverBorrowed
1854 This function get all borrowers who have never borrowed.
1856 I<$result> is a ref to an array which all elements are a hasref.
1860 sub GetBorrowersWhoHaveNeverBorrowed {
1861 my $filterbranch = shift ||
1862 ((C4::Context->preference('IndependentBranches')
1863 && C4::Context->userenv
1864 && !C4::Context->IsSuperLibrarian()
1865 && C4::Context->userenv->{branch})
1866 ? C4::Context->userenv->{branch}
1868 my $dbh = C4::Context->dbh;
1870 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
1872 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
1873 WHERE issues.borrowernumber IS NULL
1876 if ($filterbranch && $filterbranch ne ""){
1877 $query.=" AND borrowers.branchcode= ?";
1878 push @query_params,$filterbranch;
1880 warn $query if $debug;
1882 my $sth = $dbh->prepare($query);
1883 if (scalar(@query_params)>0){
1884 $sth->execute(@query_params);
1891 while ( my $data = $sth->fetchrow_hashref ) {
1892 push @results, $data;
1897 =head2 GetBorrowersWithIssuesHistoryOlderThan
1899 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
1901 this function get all borrowers who has an issue history older than I<$date> given on input arg.
1903 I<$result> is a ref to an array which all elements are a hashref.
1904 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1908 sub GetBorrowersWithIssuesHistoryOlderThan {
1909 my $dbh = C4::Context->dbh;
1910 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
1911 my $filterbranch = shift ||
1912 ((C4::Context->preference('IndependentBranches')
1913 && C4::Context->userenv
1914 && !C4::Context->IsSuperLibrarian()
1915 && C4::Context->userenv->{branch})
1916 ? C4::Context->userenv->{branch}
1919 SELECT count(borrowernumber) as n,borrowernumber
1921 WHERE returndate < ?
1922 AND borrowernumber IS NOT NULL
1925 push @query_params, $date;
1927 $query.=" AND branchcode = ?";
1928 push @query_params, $filterbranch;
1930 $query.=" GROUP BY borrowernumber ";
1931 warn $query if $debug;
1932 my $sth = $dbh->prepare($query);
1933 $sth->execute(@query_params);
1936 while ( my $data = $sth->fetchrow_hashref ) {
1937 push @results, $data;
1942 =head2 GetBorrowersNamesAndLatestIssue
1944 $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
1946 this function get borrowers Names and surnames and Issue information.
1948 I<@borrowernumbers> is an array which all elements are borrowernumbers.
1949 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
1953 sub GetBorrowersNamesAndLatestIssue {
1954 my $dbh = C4::Context->dbh;
1955 my @borrowernumbers=@_;
1957 SELECT surname,lastname, phone, email,max(timestamp)
1959 LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
1960 GROUP BY borrowernumber
1962 my $sth = $dbh->prepare($query);
1964 my $results = $sth->fetchall_arrayref({});
1970 my $success = ModPrivacy( $borrowernumber, $privacy );
1972 Update the privacy of a patron.
1975 true on success, false on failure
1980 my $borrowernumber = shift;
1981 my $privacy = shift;
1982 return unless defined $borrowernumber;
1983 return unless $borrowernumber =~ /^\d+$/;
1985 return ModMember( borrowernumber => $borrowernumber,
1986 privacy => $privacy );
1991 IssueSlip($branchcode, $borrowernumber, $quickslip)
1993 Returns letter hash ( see C4::Letters::GetPreparedLetter )
1995 $quickslip is boolean, to indicate whether we want a quick slip
1997 IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
2033 NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
2038 my ($branch, $borrowernumber, $quickslip) = @_;
2040 # FIXME Check callers before removing this statement
2041 #return unless $borrowernumber;
2043 my @issues = @{ GetPendingIssues($borrowernumber) };
2045 for my $issue (@issues) {
2046 $issue->{date_due} = $issue->{date_due_sql};
2048 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
2049 if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
2050 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
2056 # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
2058 my $s = $b->{timestamp} <=> $a->{timestamp};
2060 $b->{issuedate} <=> $a->{issuedate} : $s;
2063 my ($letter_code, %repeat);
2065 $letter_code = 'ISSUEQSLIP';
2067 'checkedout' => [ map {
2070 'biblioitems' => $_,
2072 }, grep { $_->{'now'} } @issues ],
2076 $letter_code = 'ISSUESLIP';
2078 'checkedout' => [ map {
2081 'biblioitems' => $_,
2083 }, grep { !$_->{'overdue'} } @issues ],
2085 'overdue' => [ map {
2088 'biblioitems' => $_,
2090 }, grep { $_->{'overdue'} } @issues ],
2093 $_->{'timestamp'} = $_->{'newdate'};
2095 } @{ GetNewsToDisplay("slip",$branch) } ],
2099 return C4::Letters::GetPreparedLetter (
2100 module => 'circulation',
2101 letter_code => $letter_code,
2102 branchcode => $branch,
2104 'branches' => $branch,
2105 'borrowers' => $borrowernumber,
2111 =head2 GetBorrowersWithEmail
2113 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
2115 This gets a list of users and their basic details from their email address.
2116 As it's possible for multiple user to have the same email address, it provides
2117 you with all of them. If there is no userid for the user, there will be an
2118 C<undef> there. An empty list will be returned if there are no matches.
2122 sub GetBorrowersWithEmail {
2125 my $dbh = C4::Context->dbh;
2127 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
2128 my $sth=$dbh->prepare($query);
2129 $sth->execute($email);
2131 while (my $ref = $sth->fetch) {
2134 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
2138 =head2 AddMember_Opac
2142 sub AddMember_Opac {
2143 my ( %borrower ) = @_;
2145 $borrower{'categorycode'} //= C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2146 if (not defined $borrower{'password'}){
2147 my $sr = new String::Random;
2148 $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
2149 my $password = $sr->randpattern("AAAAAAAAAA");
2150 $borrower{'password'} = $password;
2153 $borrower{'cardnumber'} = fixup_cardnumber( $borrower{'cardnumber'} );
2155 my $borrowernumber = AddMember(%borrower);
2157 return ( $borrowernumber, $borrower{'password'} );
2160 =head2 AddEnrolmentFeeIfNeeded
2162 AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
2164 Add enrolment fee for a patron if needed.
2168 sub AddEnrolmentFeeIfNeeded {
2169 my ( $categorycode, $borrowernumber ) = @_;
2170 # check for enrollment fee & add it if needed
2171 my $dbh = C4::Context->dbh;
2172 my $sth = $dbh->prepare(q{
2175 WHERE categorycode=?
2177 $sth->execute( $categorycode );
2179 warn sprintf('Database returned the following error: %s', $sth->errstr);
2182 my ($enrolmentfee) = $sth->fetchrow;
2183 if ($enrolmentfee && $enrolmentfee > 0) {
2184 # insert fee in patron debts
2185 C4::Accounts::manualinvoice( $borrowernumber, '', '', 'A', $enrolmentfee );
2194 my ( $borrowernumber ) = @_;
2196 my $sql = "SELECT COUNT(*) FROM issues WHERE date_due < NOW() AND borrowernumber = ?";
2197 my $sth = C4::Context->dbh->prepare( $sql );
2198 $sth->execute( $borrowernumber );
2199 my ( $count ) = $sth->fetchrow_array();
2204 =head2 DeleteExpiredOpacRegistrations
2206 Delete accounts that haven't been upgraded from the 'temporary' category
2207 Returns the number of removed patrons
2211 sub DeleteExpiredOpacRegistrations {
2213 my $delay = C4::Context->preference('PatronSelfRegistrationExpireTemporaryAccountsDelay');
2214 my $category_code = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2216 return 0 if not $category_code or not defined $delay or $delay eq q||;
2219 SELECT borrowernumber
2221 WHERE categorycode = ? AND DATEDIFF( NOW(), dateenrolled ) > ? |;
2223 my $dbh = C4::Context->dbh;
2224 my $sth = $dbh->prepare($query);
2225 $sth->execute( $category_code, $delay );
2227 while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
2228 DelMember($borrowernumber);
2234 =head2 DeleteUnverifiedOpacRegistrations
2236 Delete all unverified self registrations in borrower_modifications,
2237 older than the specified number of days.
2241 sub DeleteUnverifiedOpacRegistrations {
2243 my $dbh = C4::Context->dbh;
2245 DELETE FROM borrower_modifications
2246 WHERE borrowernumber = 0 AND DATEDIFF( NOW(), timestamp ) > ?|;
2247 my $cnt=$dbh->do($sql, undef, ($days) );
2248 return $cnt eq '0E0'? 0: $cnt;
2251 sub GetOverduesForPatron {
2252 my ( $borrowernumber ) = @_;
2256 FROM issues, items, biblio, biblioitems
2257 WHERE items.itemnumber=issues.itemnumber
2258 AND biblio.biblionumber = items.biblionumber
2259 AND biblio.biblionumber = biblioitems.biblionumber
2260 AND issues.borrowernumber = ?
2261 AND date_due < NOW()
2264 my $sth = C4::Context->dbh->prepare( $sql );
2265 $sth->execute( $borrowernumber );
2267 return $sth->fetchall_arrayref({});
2270 END { } # module clean-up code here (global destructor)