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 Date::Calc qw/Today Add_Delta_YM check_date Date_to_Days/;
28 use C4::Log; # logaction
34 use C4::Members::Attributes qw(SearchIdMatchingAttribute UpdateBorrowerAttribute);
35 use C4::NewsChannels; #get slip news
39 use Koha::Borrower::Debarments qw(IsDebarred);
40 use Text::Unaccent qw( unac_string );
41 use Koha::AuthUtils qw(hash_password);
45 our ($VERSION,@ISA,@EXPORT,@EXPORT_OK,$debug);
47 use Module::Load::Conditional qw( can_load );
48 if ( ! can_load( modules => { 'Koha::NorwegianPatronDB' => undef } ) ) {
49 $debug && warn "Unable to load Koha::NorwegianPatronDB";
54 $VERSION = 3.07.00.049;
55 $debug = $ENV{DEBUG} || 0;
67 &GetMemberIssuesAndFines
74 &GetFirstValidEmailAddress
75 &GetNoticeEmailAddress
86 &GetHideLostItemsPreference
89 &GetMemberAccountRecords
90 &GetBorNotifyAcctRecord
94 GetBorrowerCategorycode
95 &GetBorrowercategoryList
97 &GetBorrowersToExpunge
98 &GetBorrowersWhoHaveNeverBorrowed
99 &GetBorrowersWithIssuesHistoryOlderThan
102 &GetUpcomingMembershipExpires
110 GetBorrowersWithEmail
133 &ExtendMemberSubscriptionTo
149 C4::Members - Perl Module containing convenience functions for member handling
157 This module contains routines for adding, modifying and deleting members/patrons/borrowers
161 =head2 GetMemberDetails
163 ($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
165 Looks up a patron and returns information about him or her. If
166 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
167 up the borrower by number; otherwise, it looks up the borrower by card
170 C<$borrower> is a reference-to-hash whose keys are the fields of the
171 borrowers table in the Koha database. In addition,
172 C<$borrower-E<gt>{flags}> is a hash giving more detailed information
173 about the patron. Its keys act as flags :
175 if $borrower->{flags}->{LOST} {
176 # Patron's card was reported lost
179 If the state of a flag means that the patron should not be
180 allowed to borrow any more books, then it will have a C<noissues> key
183 See patronflags for more details.
185 C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
186 about the top-level permissions flags set for the borrower. For example,
187 if a user has the "editcatalogue" permission,
188 C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
193 sub GetMemberDetails {
194 my ( $borrowernumber, $cardnumber ) = @_;
195 my $dbh = C4::Context->dbh;
198 if ($borrowernumber) {
199 $sth = $dbh->prepare("
202 categories.description,
203 categories.BlockExpiredPatronOpacActions,
207 LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
208 WHERE borrowernumber = ?
210 $sth->execute($borrowernumber);
212 elsif ($cardnumber) {
213 $sth = $dbh->prepare("
216 categories.description,
217 categories.BlockExpiredPatronOpacActions,
221 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
224 $sth->execute($cardnumber);
229 my $borrower = $sth->fetchrow_hashref;
230 return unless $borrower;
231 my ($amount) = GetMemberAccountRecords($borrower->{borrowernumber});
232 $borrower->{'amountoutstanding'} = $amount;
233 # FIXME - patronflags calls GetMemberAccountRecords... just have patronflags return $amount
234 my $flags = patronflags( $borrower);
237 $sth = $dbh->prepare("select bit,flag from userflags");
239 while ( my ( $bit, $flag ) = $sth->fetchrow ) {
240 if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
241 $accessflagshash->{$flag} = 1;
244 $borrower->{'flags'} = $flags;
245 $borrower->{'authflags'} = $accessflagshash;
247 # Handle setting the true behavior for BlockExpiredPatronOpacActions
248 $borrower->{'BlockExpiredPatronOpacActions'} =
249 C4::Context->preference('BlockExpiredPatronOpacActions')
250 if ( $borrower->{'BlockExpiredPatronOpacActions'} == -1 );
252 $borrower->{'is_expired'} = 0;
253 $borrower->{'is_expired'} = 1 if
254 defined($borrower->{dateexpiry}) &&
255 $borrower->{'dateexpiry'} ne '0000-00-00' &&
256 Date_to_Days( Today() ) >
257 Date_to_Days( split /-/, $borrower->{'dateexpiry'} );
259 return ($borrower); #, $flags, $accessflagshash);
264 $flags = &patronflags($patron);
266 This function is not exported.
268 The following will be set where applicable:
269 $flags->{CHARGES}->{amount} Amount of debt
270 $flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge)
271 $flags->{CHARGES}->{message} Message -- deprecated
273 $flags->{CREDITS}->{amount} Amount of credit
274 $flags->{CREDITS}->{message} Message -- deprecated
276 $flags->{ GNA } Patron has no valid address
277 $flags->{ GNA }->{noissues} Set for each GNA
278 $flags->{ GNA }->{message} "Borrower has no valid address" -- deprecated
280 $flags->{ LOST } Patron's card reported lost
281 $flags->{ LOST }->{noissues} Set for each LOST
282 $flags->{ LOST }->{message} Message -- deprecated
284 $flags->{DBARRED} Set if patron debarred, no access
285 $flags->{DBARRED}->{noissues} Set for each DBARRED
286 $flags->{DBARRED}->{message} Message -- deprecated
289 $flags->{ NOTES }->{message} The note itself. NOT deprecated
291 $flags->{ ODUES } Set if patron has overdue books.
292 $flags->{ ODUES }->{message} "Yes" -- deprecated
293 $flags->{ ODUES }->{itemlist} ref-to-array: list of overdue books
294 $flags->{ ODUES }->{itemlisttext} Text list of overdue items -- deprecated
296 $flags->{WAITING} Set if any of patron's reserves are available
297 $flags->{WAITING}->{message} Message -- deprecated
298 $flags->{WAITING}->{itemlist} ref-to-array: list of available items
302 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
303 overdue items. Its elements are references-to-hash, each describing an
304 overdue item. The keys are selected fields from the issues, biblio,
305 biblioitems, and items tables of the Koha database.
307 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
308 the overdue items, one per line. Deprecated.
310 =item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
311 available items. Each element is a reference-to-hash whose keys are
312 fields from the reserves table of the Koha database.
316 All the "message" fields that include language generated in this function are deprecated,
317 because such strings belong properly in the display layer.
319 The "message" field that comes from the DB is OK.
323 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
324 # FIXME rename this function.
327 my ( $patroninformation) = @_;
328 my $dbh=C4::Context->dbh;
329 my ($balance, $owing) = GetMemberAccountBalance( $patroninformation->{'borrowernumber'});
332 my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
333 $flaginfo{'message'} = sprintf 'Patron owes %.02f', $owing;
334 $flaginfo{'amount'} = sprintf "%.02f", $owing;
335 if ( $owing > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
336 $flaginfo{'noissues'} = 1;
338 $flags{'CHARGES'} = \%flaginfo;
340 elsif ( $balance < 0 ) {
342 $flaginfo{'message'} = sprintf 'Patron has credit of %.02f', -$balance;
343 $flaginfo{'amount'} = sprintf "%.02f", $balance;
344 $flags{'CREDITS'} = \%flaginfo;
346 if ( $patroninformation->{'gonenoaddress'}
347 && $patroninformation->{'gonenoaddress'} == 1 )
350 $flaginfo{'message'} = 'Borrower has no valid address.';
351 $flaginfo{'noissues'} = 1;
352 $flags{'GNA'} = \%flaginfo;
354 if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
356 $flaginfo{'message'} = 'Borrower\'s card reported lost.';
357 $flaginfo{'noissues'} = 1;
358 $flags{'LOST'} = \%flaginfo;
360 if ( $patroninformation->{'debarred'} && check_date( split( /-/, $patroninformation->{'debarred'} ) ) ) {
361 if ( Date_to_Days(Date::Calc::Today) < Date_to_Days( split( /-/, $patroninformation->{'debarred'} ) ) ) {
363 $flaginfo{'debarredcomment'} = $patroninformation->{'debarredcomment'};
364 $flaginfo{'message'} = $patroninformation->{'debarredcomment'};
365 $flaginfo{'noissues'} = 1;
366 $flaginfo{'dateend'} = $patroninformation->{'debarred'};
367 $flags{'DBARRED'} = \%flaginfo;
370 if ( $patroninformation->{'borrowernotes'}
371 && $patroninformation->{'borrowernotes'} )
374 $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
375 $flags{'NOTES'} = \%flaginfo;
377 my ( $odues, $itemsoverdue ) = C4::Overdues::checkoverdues($patroninformation->{'borrowernumber'});
378 if ( $odues && $odues > 0 ) {
380 $flaginfo{'message'} = "Yes";
381 $flaginfo{'itemlist'} = $itemsoverdue;
382 foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
385 $flaginfo{'itemlisttext'} .=
386 "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n"; # newline is display layer
388 $flags{'ODUES'} = \%flaginfo;
390 my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
391 my $nowaiting = scalar @itemswaiting;
392 if ( $nowaiting > 0 ) {
394 $flaginfo{'message'} = "Reserved items available";
395 $flaginfo{'itemlist'} = \@itemswaiting;
396 $flags{'WAITING'} = \%flaginfo;
404 $borrower = &GetMember(%information);
406 Retrieve the first patron record meeting on criteria listed in the
407 C<%information> hash, which should contain one or more
408 pairs of borrowers column names and values, e.g.,
410 $borrower = GetMember(borrowernumber => id);
412 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
413 the C<borrowers> table in the Koha database.
415 FIXME: GetMember() is used throughout the code as a lookup
416 on a unique key such as the borrowernumber, but this meaning is not
417 enforced in the routine itself.
423 my ( %information ) = @_;
424 if (exists $information{borrowernumber} && !defined $information{borrowernumber}) {
425 #passing mysql's kohaadmin?? Makes no sense as a query
428 my $dbh = C4::Context->dbh;
430 q{SELECT borrowers.*, categories.category_type, categories.description
432 LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
435 for (keys %information ) {
443 if (defined $information{$_}) {
445 push @values, $information{$_};
448 $select .= "$_ IS NULL";
451 $debug && warn $select, " ",values %information;
452 my $sth = $dbh->prepare("$select");
453 $sth->execute(@values);
454 my $data = $sth->fetchall_arrayref({});
455 #FIXME interface to this routine now allows generation of a result set
456 #so whole array should be returned but bowhere in the current code expects this
464 =head2 GetMemberRelatives
466 @borrowernumbers = GetMemberRelatives($borrowernumber);
468 C<GetMemberRelatives> returns a borrowersnumber's list of guarantor/guarantees of the member given in parameter
472 sub GetMemberRelatives {
473 my $borrowernumber = shift;
474 my $dbh = C4::Context->dbh;
478 my $query = "SELECT guarantorid FROM borrowers WHERE borrowernumber=?";
479 my $sth = $dbh->prepare($query);
480 $sth->execute($borrowernumber);
481 my $data = $sth->fetchrow_arrayref();
482 push @glist, $data->[0] if $data->[0];
483 my $guarantor = $data->[0] ? $data->[0] : undef;
486 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
487 $sth = $dbh->prepare($query);
488 $sth->execute($borrowernumber);
489 while ($data = $sth->fetchrow_arrayref()) {
490 push @glist, $data->[0];
493 # Getting sibling guarantees
495 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
496 $sth = $dbh->prepare($query);
497 $sth->execute($guarantor);
498 while ($data = $sth->fetchrow_arrayref()) {
499 push @glist, $data->[0] if ($data->[0] != $borrowernumber);
506 =head2 IsMemberBlocked
508 my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
510 Returns whether a patron is restricted or has overdue items that may result
511 in a block of circulation privileges.
513 C<$block_status> can have the following values:
515 1 if the patron is currently restricted, in which case
516 C<$count> is the expiration date (9999-12-31 for indefinite)
518 -1 if the patron has overdue items, in which case C<$count> is the number of them
520 0 if the patron has no overdue items or outstanding fine days, in which case C<$count> is 0
522 Existing active restrictions are checked before current overdue items.
526 sub IsMemberBlocked {
527 my $borrowernumber = shift;
528 my $dbh = C4::Context->dbh;
530 my $blockeddate = Koha::Borrower::Debarments::IsDebarred($borrowernumber);
532 return ( 1, $blockeddate ) if $blockeddate;
534 # if he have late issues
535 my $sth = $dbh->prepare(
536 "SELECT COUNT(*) as latedocs
538 WHERE borrowernumber = ?
539 AND date_due < now()"
541 $sth->execute($borrowernumber);
542 my $latedocs = $sth->fetchrow_hashref->{'latedocs'};
544 return ( -1, $latedocs ) if $latedocs > 0;
549 =head2 GetMemberIssuesAndFines
551 ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
553 Returns aggregate data about items borrowed by the patron with the
554 given borrowernumber.
556 C<&GetMemberIssuesAndFines> returns a three-element array. C<$overdue_count> is the
557 number of overdue items the patron currently has borrowed. C<$issue_count> is the
558 number of books the patron currently has borrowed. C<$total_fines> is
559 the total fine currently due by the borrower.
564 sub GetMemberIssuesAndFines {
565 my ( $borrowernumber ) = @_;
566 my $dbh = C4::Context->dbh;
567 my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
569 $debug and warn $query."\n";
570 my $sth = $dbh->prepare($query);
571 $sth->execute($borrowernumber);
572 my $issue_count = $sth->fetchrow_arrayref->[0];
574 $sth = $dbh->prepare(
575 "SELECT COUNT(*) FROM issues
576 WHERE borrowernumber = ?
577 AND date_due < now()"
579 $sth->execute($borrowernumber);
580 my $overdue_count = $sth->fetchrow_arrayref->[0];
582 $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
583 $sth->execute($borrowernumber);
584 my $total_fines = $sth->fetchrow_arrayref->[0];
586 return ($overdue_count, $issue_count, $total_fines);
592 my @columns = C4::Member::columns();
594 Returns an array of borrowers' table columns on success,
595 and an empty array on failure.
601 # Pure ANSI SQL goodness.
602 my $sql = 'SELECT * FROM borrowers WHERE 1=0;';
604 # Get the database handle.
605 my $dbh = C4::Context->dbh;
607 # Run the SQL statement to load STH's readonly properties.
608 my $sth = $dbh->prepare($sql);
609 my $rv = $sth->execute();
611 # This only fails if the table doesn't exist.
612 # This will always be called AFTER an install or upgrade,
613 # so borrowers will exist!
615 if ($sth->{NUM_OF_FIELDS}>0) {
616 @data = @{$sth->{NAME}};
627 my $success = ModMember(borrowernumber => $borrowernumber,
628 [ field => value ]... );
630 Modify borrower's data. All date fields should ALREADY be in ISO format.
633 true on success, or false on failure
639 # test to know if you must update or not the borrower password
640 if (exists $data{password}) {
641 if ($data{password} eq '****' or $data{password} eq '') {
642 delete $data{password};
644 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
645 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
646 Koha::NorwegianPatronDB::NLUpdateHashedPIN( $data{'borrowernumber'}, $data{password} );
648 $data{password} = hash_password($data{password});
651 my $old_categorycode = GetBorrowerCategorycode( $data{borrowernumber} );
653 # get only the columns of a borrower
654 my $schema = Koha::Database->new()->schema;
655 my @columns = $schema->source('Borrower')->columns;
656 my $new_borrower = { map { join(' ', @columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) };
657 delete $new_borrower->{flags};
659 $new_borrower->{dateofbirth} ||= undef if exists $new_borrower->{dateofbirth};
660 $new_borrower->{dateenrolled} ||= undef if exists $new_borrower->{dateenrolled};
661 $new_borrower->{dateexpiry} ||= undef if exists $new_borrower->{dateexpiry};
662 $new_borrower->{debarred} ||= undef if exists $new_borrower->{debarred};
663 my $rs = $schema->resultset('Borrower')->search({
664 borrowernumber => $new_borrower->{borrowernumber},
667 delete $new_borrower->{userid} if exists $new_borrower->{userid} and not $new_borrower->{userid};
669 my $execute_success = $rs->update($new_borrower);
670 if ($execute_success ne '0E0') { # only proceed if the update was a success
671 # ok if its an adult (type) it may have borrowers that depend on it as a guarantor
672 # so when we update information for an adult we should check for guarantees and update the relevant part
673 # of their records, ie addresses and phone numbers
674 my $borrowercategory= GetBorrowercategory( $data{'category_type'} );
675 if ( exists $borrowercategory->{'category_type'} && $borrowercategory->{'category_type'} eq ('A' || 'S') ) {
676 # is adult check guarantees;
677 UpdateGuarantees(%data);
680 # If the patron changes to a category with enrollment fee, we add a fee
681 if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
682 if ( C4::Context->preference('FeeOnChangePatronCategory') ) {
683 AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
687 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
688 # cronjob will use for syncing with NL
689 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
690 my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
691 'synctype' => 'norwegianpatrondb',
692 'borrowernumber' => $data{'borrowernumber'}
694 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
695 # we can sync as changed. And the "new sync" will pick up all changes since
696 # the patron was created anyway.
697 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
698 $borrowersync->update( { 'syncstatus' => 'edited' } );
700 # Set the value of 'sync'
701 $borrowersync->update( { 'sync' => $data{'sync'} } );
702 # Try to do the live sync
703 Koha::NorwegianPatronDB::NLSync({ 'borrowernumber' => $data{'borrowernumber'} });
706 logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
708 return $execute_success;
713 $borrowernumber = &AddMember(%borrower);
715 insert new borrower into table
717 (%borrower keys are database columns. Database columns could be
718 different in different versions. Please look into database for correct
721 Returns the borrowernumber upon success
723 Returns as undef upon any db error without further processing
730 my $dbh = C4::Context->dbh;
731 my $schema = Koha::Database->new()->schema;
733 # generate a proper login if none provided
734 $data{'userid'} = Generate_Userid( $data{'borrowernumber'}, $data{'firstname'}, $data{'surname'} )
735 if ( $data{'userid'} eq '' || !Check_Userid( $data{'userid'} ) );
737 # add expiration date if it isn't already there
738 unless ( $data{'dateexpiry'} ) {
739 $data{'dateexpiry'} = GetExpiryDate( $data{'categorycode'}, output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } ) );
742 # add enrollment date if it isn't already there
743 unless ( $data{'dateenrolled'} ) {
744 $data{'dateenrolled'} = output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
747 my $patron_category = $schema->resultset('Category')->find( $data{'categorycode'} );
749 $patron_category->default_privacy() eq 'default' ? 1
750 : $patron_category->default_privacy() eq 'never' ? 2
751 : $patron_category->default_privacy() eq 'forever' ? 0
753 # Make a copy of the plain text password for later use
754 my $plain_text_password = $data{'password'};
756 # create a disabled account if no password provided
757 $data{'password'} = ($data{'password'})? hash_password($data{'password'}) : '!';
759 # we don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00
760 $data{'dateofbirth'} = undef if( not $data{'dateofbirth'} );
761 $data{'debarred'} = undef if ( not $data{'debarred'} );
763 # get only the columns of Borrower
764 my @columns = $schema->source('Borrower')->columns;
765 my $new_member = { map { join(' ',@columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) } ;
766 delete $new_member->{borrowernumber};
768 my $rs = $schema->resultset('Borrower');
769 $data{borrowernumber} = $rs->create($new_member)->id;
771 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
772 # cronjob will use for syncing with NL
773 if ( exists $data{'borrowernumber'} && C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
774 Koha::Database->new->schema->resultset('BorrowerSync')->create({
775 'borrowernumber' => $data{'borrowernumber'},
776 'synctype' => 'norwegianpatrondb',
778 'syncstatus' => 'new',
779 'hashed_pin' => Koha::NorwegianPatronDB::NLEncryptPIN( $plain_text_password ),
783 # mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
784 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
786 AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
788 return $data{borrowernumber};
793 my $uniqueness = Check_Userid($userid,$borrowernumber);
795 $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 != '').
797 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.
800 0 for not unique (i.e. this $userid already exists)
801 1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
806 my ( $uid, $borrowernumber ) = @_;
808 return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
810 return 0 if ( $uid eq C4::Context->config('user') );
812 my $rs = Koha::Database->new()->schema()->resultset('Borrower');
815 $params->{userid} = $uid;
816 $params->{borrowernumber} = { '!=' => $borrowernumber } if ($borrowernumber);
818 my $count = $rs->count( $params );
820 return $count ? 0 : 1;
823 =head2 Generate_Userid
825 my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
827 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
829 $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.
832 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).
836 sub Generate_Userid {
837 my ($borrowernumber, $firstname, $surname) = @_;
840 #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
842 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
843 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
844 $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
845 $newuid = unac_string('utf-8',$newuid);
846 $newuid .= $offset unless $offset == 0;
849 } while (!Check_Userid($newuid,$borrowernumber));
855 my ( $uid, $member, $digest ) = @_;
856 my $dbh = C4::Context->dbh;
858 #Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
859 #Then we need to tell the user and have them create a new one.
863 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
864 $sth->execute( $uid, $member );
865 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
869 #Everything is good so we can update the information.
872 "update borrowers set userid=?, password=? where borrowernumber=?");
873 $sth->execute( $uid, $digest, $member );
877 logaction("MEMBERS", "CHANGE PASS", $member, "") if C4::Context->preference("BorrowersLog");
883 =head2 fixup_cardnumber
885 Warning: The caller is responsible for locking the members table in write
886 mode, to avoid database corruption.
890 use vars qw( @weightings );
891 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
893 sub fixup_cardnumber {
894 my ($cardnumber) = @_;
895 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
897 # Find out whether member numbers should be generated
898 # automatically. Should be either "1" or something else.
899 # Defaults to "0", which is interpreted as "no".
901 # if ($cardnumber !~ /\S/ && $autonumber_members) {
902 ($autonumber_members) or return $cardnumber;
903 my $checkdigit = C4::Context->preference('checkdigit');
904 my $dbh = C4::Context->dbh;
905 if ( $checkdigit and $checkdigit eq 'katipo' ) {
907 # if checkdigit is selected, calculate katipo-style cardnumber.
908 # otherwise, just use the max()
909 # purpose: generate checksum'd member numbers.
910 # We'll assume we just got the max value of digits 2-8 of member #'s
911 # from the database and our job is to increment that by one,
912 # determine the 1st and 9th digits and return the full string.
913 my $sth = $dbh->prepare(
914 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
917 my $data = $sth->fetchrow_hashref;
918 $cardnumber = $data->{new_num};
919 if ( !$cardnumber ) { # If DB has no values,
920 $cardnumber = 1000000; # start at 1000000
926 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
927 # read weightings, left to right, 1 char at a time
928 my $temp1 = $weightings[$i];
930 # sequence left to right, 1 char at a time
931 my $temp2 = substr( $cardnumber, $i, 1 );
933 # mult each char 1-7 by its corresponding weighting
934 $sum += $temp1 * $temp2;
937 my $rem = ( $sum % 11 );
938 $rem = 'X' if $rem == 10;
940 return "V$cardnumber$rem";
943 my $sth = $dbh->prepare(
944 'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
947 my ($result) = $sth->fetchrow;
950 return $cardnumber; # just here as a fallback/reminder
955 ($num_children, $children_arrayref) = &GetGuarantees($parent_borrno);
956 $child0_cardno = $children_arrayref->[0]{"cardnumber"};
957 $child0_borrno = $children_arrayref->[0]{"borrowernumber"};
959 C<&GetGuarantees> takes a borrower number (e.g., that of a patron
960 with children) and looks up the borrowers who are guaranteed by that
961 borrower (i.e., the patron's children).
963 C<&GetGuarantees> returns two values: an integer giving the number of
964 borrowers guaranteed by C<$parent_borrno>, and a reference to an array
965 of references to hash, which gives the actual results.
971 my ($borrowernumber) = @_;
972 my $dbh = C4::Context->dbh;
975 "select cardnumber,borrowernumber, firstname, surname from borrowers where guarantorid=?"
977 $sth->execute($borrowernumber);
980 my $data = $sth->fetchall_arrayref({});
981 return ( scalar(@$data), $data );
984 =head2 UpdateGuarantees
986 &UpdateGuarantees($parent_borrno);
989 C<&UpdateGuarantees> borrower data for an adult and updates all the guarantees
990 with the modified information
995 sub UpdateGuarantees {
997 my $dbh = C4::Context->dbh;
998 my ( $count, $guarantees ) = GetGuarantees( $data{'borrowernumber'} );
999 foreach my $guarantee (@$guarantees){
1000 my $guaquery = qq|UPDATE borrowers
1001 SET address=?,fax=?,B_city=?,mobile=?,city=?,phone=?
1002 WHERE borrowernumber=?
1004 my $sth = $dbh->prepare($guaquery);
1005 $sth->execute($data{'address'},$data{'fax'},$data{'B_city'},$data{'mobile'},$data{'city'},$data{'phone'},$guarantee->{'borrowernumber'});
1008 =head2 GetPendingIssues
1010 my $issues = &GetPendingIssues(@borrowernumber);
1012 Looks up what the patron with the given borrowernumber has borrowed.
1014 C<&GetPendingIssues> returns a
1015 reference-to-array where each element is a reference-to-hash; the
1016 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
1017 The keys include C<biblioitems> fields except marc and marcxml.
1022 sub GetPendingIssues {
1023 my @borrowernumbers = @_;
1025 unless (@borrowernumbers ) { # return a ref_to_array
1026 return \@borrowernumbers; # to not cause surprise to caller
1029 # Borrowers part of the query
1031 for (my $i = 0; $i < @borrowernumbers; $i++) {
1032 $bquery .= ' issues.borrowernumber = ?';
1033 if ($i < $#borrowernumbers ) {
1038 # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
1039 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
1040 # FIXME: circ/ciculation.pl tries to sort by timestamp!
1041 # FIXME: namespace collision: other collisions possible.
1042 # FIXME: most of this data isn't really being used by callers.
1049 biblioitems.itemtype,
1052 biblioitems.publicationyear,
1053 biblioitems.publishercode,
1054 biblioitems.volumedate,
1055 biblioitems.volumedesc,
1058 borrowers.firstname,
1060 borrowers.cardnumber,
1061 issues.timestamp AS timestamp,
1062 issues.renewals AS renewals,
1063 issues.borrowernumber AS borrowernumber,
1064 items.renewals AS totalrenewals
1066 LEFT JOIN items ON items.itemnumber = issues.itemnumber
1067 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1068 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
1069 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
1072 ORDER BY issues.issuedate"
1075 my $sth = C4::Context->dbh->prepare($query);
1076 $sth->execute(@borrowernumbers);
1077 my $data = $sth->fetchall_arrayref({});
1078 my $today = dt_from_string;
1079 foreach (@{$data}) {
1080 if ($_->{issuedate}) {
1081 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
1083 $_->{date_due_sql} = $_->{date_due};
1084 # FIXME no need to have this value
1085 $_->{date_due} or next;
1086 $_->{date_due_sql} = $_->{date_due};
1087 # FIXME no need to have this value
1088 $_->{date_due} = dt_from_string($_->{date_due}, 'sql');
1089 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
1098 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
1100 Looks up what the patron with the given borrowernumber has borrowed,
1101 and sorts the results.
1103 C<$sortkey> is the name of a field on which to sort the results. This
1104 should be the name of a field in the C<issues>, C<biblio>,
1105 C<biblioitems>, or C<items> table in the Koha database.
1107 C<$limit> is the maximum number of results to return.
1109 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
1110 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
1111 C<items> tables of the Koha database.
1117 my ( $borrowernumber, $order, $limit ) = @_;
1119 return unless $borrowernumber;
1120 $order = 'date_due desc' unless $order;
1122 my $dbh = C4::Context->dbh;
1124 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1126 LEFT JOIN items on items.itemnumber=issues.itemnumber
1127 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1128 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1129 WHERE borrowernumber=?
1131 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1133 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
1134 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1135 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1136 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
1137 order by ' . $order;
1139 $query .= " limit $limit";
1142 my $sth = $dbh->prepare($query);
1143 $sth->execute( $borrowernumber, $borrowernumber );
1144 return $sth->fetchall_arrayref( {} );
1148 =head2 GetMemberAccountRecords
1150 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
1152 Looks up accounting data for the patron with the given borrowernumber.
1154 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
1155 reference-to-array, where each element is a reference-to-hash; the
1156 keys are the fields of the C<accountlines> table in the Koha database.
1157 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1158 total amount outstanding for all of the account lines.
1162 sub GetMemberAccountRecords {
1163 my ($borrowernumber) = @_;
1164 my $dbh = C4::Context->dbh;
1170 WHERE borrowernumber=?);
1171 $strsth.=" ORDER BY accountlines_id desc";
1172 my $sth= $dbh->prepare( $strsth );
1173 $sth->execute( $borrowernumber );
1176 while ( my $data = $sth->fetchrow_hashref ) {
1177 if ( $data->{itemnumber} ) {
1178 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1179 $data->{biblionumber} = $biblio->{biblionumber};
1180 $data->{title} = $biblio->{title};
1182 $acctlines[$numlines] = $data;
1184 $total += sprintf "%.0f", 1000*$data->{amountoutstanding}; # convert float to integer to avoid round-off errors
1187 return ( $total, \@acctlines,$numlines);
1190 =head2 GetMemberAccountBalance
1192 ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
1194 Calculates amount immediately owing by the patron - non-issue charges.
1195 Based on GetMemberAccountRecords.
1196 Charges exempt from non-issue are:
1198 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
1199 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
1203 sub GetMemberAccountBalance {
1204 my ($borrowernumber) = @_;
1206 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
1209 push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
1210 push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
1211 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
1212 my $dbh = C4::Context->dbh;
1213 my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
1214 push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
1216 my %not_fine = map {$_ => 1} @not_fines;
1218 my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
1219 my $other_charges = 0;
1220 foreach (@$acctlines) {
1221 $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
1224 return ( $total, $total - $other_charges, $other_charges);
1227 =head2 GetBorNotifyAcctRecord
1229 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1231 Looks up accounting data for the patron with the given borrowernumber per file number.
1233 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1234 reference-to-array, where each element is a reference-to-hash; the
1235 keys are the fields of the C<accountlines> table in the Koha database.
1236 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1237 total amount outstanding for all of the account lines.
1241 sub GetBorNotifyAcctRecord {
1242 my ( $borrowernumber, $notifyid ) = @_;
1243 my $dbh = C4::Context->dbh;
1246 my $sth = $dbh->prepare(
1249 WHERE borrowernumber=?
1251 AND amountoutstanding != '0'
1252 ORDER BY notify_id,accounttype
1255 $sth->execute( $borrowernumber, $notifyid );
1257 while ( my $data = $sth->fetchrow_hashref ) {
1258 if ( $data->{itemnumber} ) {
1259 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1260 $data->{biblionumber} = $biblio->{biblionumber};
1261 $data->{title} = $biblio->{title};
1263 $acctlines[$numlines] = $data;
1265 $total += int(100 * $data->{'amountoutstanding'});
1268 return ( $total, \@acctlines, $numlines );
1271 =head2 checkuniquemember (OUEST-PROVENCE)
1273 ($result,$categorycode) = &checkuniquemember($collectivity,$surname,$firstname,$dateofbirth);
1275 Checks that a member exists or not in the database.
1277 C<&result> is nonzero (=exist) or 0 (=does not exist)
1278 C<&categorycode> is from categorycode table
1279 C<&collectivity> is 1 (= we add a collectivity) or 0 (= we add a physical member)
1280 C<&surname> is the surname
1281 C<&firstname> is the firstname (only if collectivity=0)
1282 C<&dateofbirth> is the date of birth in ISO format (only if collectivity=0)
1286 # FIXME: This function is not legitimate. Multiple patrons might have the same first/last name and birthdate.
1287 # This is especially true since first name is not even a required field.
1289 sub checkuniquemember {
1290 my ( $collectivity, $surname, $firstname, $dateofbirth ) = @_;
1291 my $dbh = C4::Context->dbh;
1292 my $request = ($collectivity) ?
1293 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? " :
1295 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=? and dateofbirth=?" :
1296 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?";
1297 my $sth = $dbh->prepare($request);
1298 if ($collectivity) {
1299 $sth->execute( uc($surname) );
1300 } elsif($dateofbirth){
1301 $sth->execute( uc($surname), ucfirst($firstname), $dateofbirth );
1303 $sth->execute( uc($surname), ucfirst($firstname));
1305 my @data = $sth->fetchrow;
1306 ( $data[0] ) and return $data[0], $data[1];
1310 sub checkcardnumber {
1311 my ( $cardnumber, $borrowernumber ) = @_;
1313 # If cardnumber is null, we assume they're allowed.
1314 return 0 unless defined $cardnumber;
1316 my $dbh = C4::Context->dbh;
1317 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1318 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1319 my $sth = $dbh->prepare($query);
1322 ( $borrowernumber ? $borrowernumber : () )
1325 return 1 if $sth->fetchrow_hashref;
1327 my ( $min_length, $max_length ) = get_cardnumber_length();
1329 if length $cardnumber > $max_length
1330 or length $cardnumber < $min_length;
1335 =head2 get_cardnumber_length
1337 my ($min, $max) = C4::Members::get_cardnumber_length()
1339 Returns the minimum and maximum length for patron cardnumbers as
1340 determined by the CardnumberLength system preference, the
1341 BorrowerMandatoryField system preference, and the width of the
1346 sub get_cardnumber_length {
1347 my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
1348 $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
1349 if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
1350 # Is integer and length match
1351 if ( $cardnumber_length =~ m|^\d+$| ) {
1352 $min = $max = $cardnumber_length
1353 if $cardnumber_length >= $min
1354 and $cardnumber_length <= $max;
1356 # Else assuming it is a range
1357 elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
1358 $min = $1 if $1 and $min < $1;
1359 $max = $2 if $2 and $max > $2;
1363 my $borrower = Koha::Schema->resultset('Borrower');
1364 my $field_size = $borrower->result_source->column_info('cardnumber')->{size};
1365 $min = $field_size if $min > $field_size;
1366 return ( $min, $max );
1369 =head2 getzipnamecity (OUEST-PROVENCE)
1371 take all info from table city for the fields city and zip
1372 check for the name and the zip code of the city selected
1376 sub getzipnamecity {
1378 my $dbh = C4::Context->dbh;
1381 "select city_name,city_state,city_zipcode,city_country from cities where cityid=? ");
1382 $sth->execute($cityid);
1383 my @data = $sth->fetchrow;
1384 return $data[0], $data[1], $data[2], $data[3];
1388 =head2 getdcity (OUEST-PROVENCE)
1390 recover cityid with city_name condition
1395 my ($city_name) = @_;
1396 my $dbh = C4::Context->dbh;
1397 my $sth = $dbh->prepare("select cityid from cities where city_name=? ");
1398 $sth->execute($city_name);
1399 my $data = $sth->fetchrow;
1403 =head2 GetFirstValidEmailAddress
1405 $email = GetFirstValidEmailAddress($borrowernumber);
1407 Return the first valid email address for a borrower, given the borrowernumber. For now, the order
1408 is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
1413 sub GetFirstValidEmailAddress {
1414 my $borrowernumber = shift;
1415 my $dbh = C4::Context->dbh;
1416 my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1417 $sth->execute( $borrowernumber );
1418 my $data = $sth->fetchrow_hashref;
1420 if ($data->{'email'}) {
1421 return $data->{'email'};
1422 } elsif ($data->{'emailpro'}) {
1423 return $data->{'emailpro'};
1424 } elsif ($data->{'B_email'}) {
1425 return $data->{'B_email'};
1431 =head2 GetNoticeEmailAddress
1433 $email = GetNoticeEmailAddress($borrowernumber);
1435 Return the email address of borrower used for notices, given the borrowernumber.
1436 Returns the empty string if no email address.
1440 sub GetNoticeEmailAddress {
1441 my $borrowernumber = shift;
1443 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1444 # if syspref is set to 'first valid' (value == OFF), look up email address
1445 if ( $which_address eq 'OFF' ) {
1446 return GetFirstValidEmailAddress($borrowernumber);
1448 # specified email address field
1449 my $dbh = C4::Context->dbh;
1450 my $sth = $dbh->prepare( qq{
1451 SELECT $which_address AS primaryemail
1453 WHERE borrowernumber=?
1455 $sth->execute($borrowernumber);
1456 my $data = $sth->fetchrow_hashref;
1457 return $data->{'primaryemail'} || '';
1460 =head2 GetExpiryDate
1462 $expirydate = GetExpiryDate($categorycode, $dateenrolled);
1464 Calculate expiry date given a categorycode and starting date. Date argument must be in ISO format.
1465 Return date is also in ISO format.
1470 my ( $categorycode, $dateenrolled ) = @_;
1472 if ($categorycode) {
1473 my $dbh = C4::Context->dbh;
1474 my $sth = $dbh->prepare("SELECT enrolmentperiod,enrolmentperioddate FROM categories WHERE categorycode=?");
1475 $sth->execute($categorycode);
1476 $enrolments = $sth->fetchrow_hashref;
1478 # die "GetExpiryDate: for enrollmentperiod $enrolmentperiod (category '$categorycode') starting $dateenrolled.\n";
1479 my @date = split (/-/,$dateenrolled);
1480 if($enrolments->{enrolmentperiod}){
1481 return sprintf("%04d-%02d-%02d", Add_Delta_YM(@date,0,$enrolments->{enrolmentperiod}));
1483 return $enrolments->{enrolmentperioddate};
1487 =head2 GetUpcomingMembershipExpires
1489 my $upcoming_mem_expires = GetUpcomingMembershipExpires();
1493 sub GetUpcomingMembershipExpires {
1494 my $dbh = C4::Context->dbh;
1495 my $days = C4::Context->preference("MembershipExpiryDaysNotice") || 0;
1496 my $dateexpiry = output_pref({ dt => (dt_from_string()->add( days => $days)), dateformat => 'iso', dateonly => 1 });
1499 SELECT borrowers.*, categories.description,
1500 branches.branchname, branches.branchemail FROM borrowers
1501 LEFT JOIN branches on borrowers.branchcode = branches.branchcode
1502 LEFT JOIN categories on borrowers.categorycode = categories.categorycode
1503 WHERE dateexpiry = ?;
1505 my $sth = $dbh->prepare($query);
1506 $sth->execute($dateexpiry);
1507 my $results = $sth->fetchall_arrayref({});
1511 =head2 GetborCatFromCatType
1513 ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
1515 Looks up the different types of borrowers in the database. Returns two
1516 elements: a reference-to-array, which lists the borrower category
1517 codes, and a reference-to-hash, which maps the borrower category codes
1518 to category descriptions.
1523 sub GetborCatFromCatType {
1524 my ( $category_type, $action, $no_branch_limit ) = @_;
1526 my $branch_limit = $no_branch_limit
1528 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1530 # FIXME - This API seems both limited and dangerous.
1531 my $dbh = C4::Context->dbh;
1534 SELECT DISTINCT categories.categorycode, categories.description
1538 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1541 $request .= " $action ";
1542 $request .= " AND (branchcode = ? OR branchcode IS NULL)" if $branch_limit;
1544 $request .= " WHERE branchcode = ? OR branchcode IS NULL" if $branch_limit;
1546 $request .= " ORDER BY categorycode";
1548 my $sth = $dbh->prepare($request);
1550 $action ? $category_type : (),
1551 $branch_limit ? $branch_limit : ()
1557 while ( my $data = $sth->fetchrow_hashref ) {
1558 push @codes, $data->{'categorycode'};
1559 $labels{ $data->{'categorycode'} } = $data->{'description'};
1562 return ( \@codes, \%labels );
1565 =head2 GetBorrowercategory
1567 $hashref = &GetBorrowercategory($categorycode);
1569 Given the borrower's category code, the function returns the corresponding
1570 data hashref for a comprehensive information display.
1574 sub GetBorrowercategory {
1576 my $dbh = C4::Context->dbh;
1580 "SELECT description,dateofbirthrequired,upperagelimit,category_type
1582 WHERE categorycode = ?"
1584 $sth->execute($catcode);
1586 $sth->fetchrow_hashref;
1590 } # sub getborrowercategory
1593 =head2 GetBorrowerCategorycode
1595 $categorycode = &GetBorrowerCategoryCode( $borrowernumber );
1597 Given the borrowernumber, the function returns the corresponding categorycode
1601 sub GetBorrowerCategorycode {
1602 my ( $borrowernumber ) = @_;
1603 my $dbh = C4::Context->dbh;
1604 my $sth = $dbh->prepare( qq{
1607 WHERE borrowernumber = ?
1609 $sth->execute( $borrowernumber );
1610 return $sth->fetchrow;
1613 =head2 GetBorrowercategoryList
1615 $arrayref_hashref = &GetBorrowercategoryList;
1616 If no category code provided, the function returns all the categories.
1620 sub GetBorrowercategoryList {
1621 my $no_branch_limit = @_ ? shift : 0;
1622 my $branch_limit = $no_branch_limit
1624 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1625 my $dbh = C4::Context->dbh;
1626 my $query = "SELECT categories.* FROM categories";
1628 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1629 WHERE branchcode = ? OR branchcode IS NULL GROUP BY description
1631 $query .= " ORDER BY description";
1632 my $sth = $dbh->prepare( $query );
1633 $sth->execute( $branch_limit ? $branch_limit : () );
1634 my $data = $sth->fetchall_arrayref( {} );
1637 } # sub getborrowercategory
1641 $dateofbirth,$date = &GetAge($date);
1643 this function return the borrowers age with the value of dateofbirth
1649 my ( $date, $date_ref ) = @_;
1651 if ( not defined $date_ref ) {
1652 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1655 my ( $year1, $month1, $day1 ) = split /-/, $date;
1656 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1658 my $age = $year2 - $year1;
1659 if ( $month1 . $day1 > $month2 . $day2 ) {
1668 $borrower = C4::Members::SetAge($borrower, $datetimeduration);
1669 $borrower = C4::Members::SetAge($borrower, '0015-12-10');
1670 $borrower = C4::Members::SetAge($borrower, $datetimeduration, $datetime_reference);
1672 eval { $borrower = C4::Members::SetAge($borrower, '015-1-10'); };
1673 if ($@) {print $@;} #Catch a bad ISO Date or kill your script!
1675 This function sets the borrower's dateofbirth to match the given age.
1676 Optionally relative to the given $datetime_reference.
1678 @PARAM1 koha.borrowers-object
1679 @PARAM2 DateTime::Duration-object as the desired age
1680 OR a ISO 8601 Date. (To make the API more pleasant)
1681 @PARAM3 DateTime-object as the relative date, defaults to now().
1682 RETURNS The given borrower reference @PARAM1.
1683 DIES If there was an error with the ISO Date handling.
1689 my ( $borrower, $datetimeduration, $datetime_ref ) = @_;
1690 $datetime_ref = DateTime->now() unless $datetime_ref;
1692 if ($datetimeduration && ref $datetimeduration ne 'DateTime::Duration') {
1693 if ($datetimeduration =~ /^(\d{4})-(\d{2})-(\d{2})/) {
1694 $datetimeduration = DateTime::Duration->new(years => $1, months => $2, days => $3);
1697 die "C4::Members::SetAge($borrower, $datetimeduration), datetimeduration not a valid ISO 8601 Date!\n";
1701 my $new_datetime_ref = $datetime_ref->clone();
1702 $new_datetime_ref->subtract_duration( $datetimeduration );
1704 $borrower->{dateofbirth} = $new_datetime_ref->ymd();
1711 $cityarrayref = GetCities();
1713 Returns an array_ref of the entries in the cities table
1714 If there are entries in the table an empty row is returned
1715 This is currently only used to populate a popup in memberentry
1721 my $dbh = C4::Context->dbh;
1722 my $city_arr = $dbh->selectall_arrayref(
1723 q|SELECT cityid,city_zipcode,city_name,city_state,city_country FROM cities ORDER BY city_name|,
1725 if ( @{$city_arr} ) {
1726 unshift @{$city_arr}, {
1727 city_zipcode => q{},
1731 city_country => q{},
1738 =head2 GetSortDetails (OUEST-PROVENCE)
1740 ($lib) = &GetSortDetails($category,$sortvalue);
1742 Returns the authorized value details
1743 C<&$lib>return value of authorized value details
1744 C<&$sortvalue>this is the value of authorized value
1745 C<&$category>this is the value of authorized value category
1749 sub GetSortDetails {
1750 my ( $category, $sortvalue ) = @_;
1751 my $dbh = C4::Context->dbh;
1752 my $query = qq|SELECT lib
1753 FROM authorised_values
1755 AND authorised_value=? |;
1756 my $sth = $dbh->prepare($query);
1757 $sth->execute( $category, $sortvalue );
1758 my $lib = $sth->fetchrow;
1759 return ($lib) if ($lib);
1760 return ($sortvalue) unless ($lib);
1763 =head2 MoveMemberToDeleted
1765 $result = &MoveMemberToDeleted($borrowernumber);
1767 Copy the record from borrowers to deletedborrowers table.
1768 The routine returns 1 for success, undef for failure.
1772 sub MoveMemberToDeleted {
1773 my ($member) = shift or return;
1775 my $schema = Koha::Database->new()->schema();
1776 my $borrowers_rs = $schema->resultset('Borrower');
1777 $borrowers_rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
1778 my $borrower = $borrowers_rs->find($member);
1779 return unless $borrower;
1781 my $deleted = $schema->resultset('Deletedborrower')->create($borrower);
1783 return $deleted ? 1 : undef;
1788 DelMember($borrowernumber);
1790 This function remove directly a borrower whitout writing it on deleteborrower.
1791 + Deletes reserves for the borrower
1796 my $dbh = C4::Context->dbh;
1797 my $borrowernumber = shift;
1798 #warn "in delmember with $borrowernumber";
1799 return unless $borrowernumber; # borrowernumber is mandatory.
1801 my $query = qq|DELETE
1803 WHERE borrowernumber=?|;
1804 my $sth = $dbh->prepare($query);
1805 $sth->execute($borrowernumber);
1809 WHERE borrowernumber = ?
1811 $sth = $dbh->prepare($query);
1812 $sth->execute($borrowernumber);
1813 logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
1817 =head2 HandleDelBorrower
1819 HandleDelBorrower($borrower);
1821 When a member is deleted (DelMember in Members.pm), you should call me first.
1822 This routine deletes/moves lists and entries for the deleted member/borrower.
1823 Lists owned by the borrower are deleted, but entries from the borrower to
1824 other lists are kept.
1828 sub HandleDelBorrower {
1831 my $dbh = C4::Context->dbh;
1833 #Delete all lists and all shares of this borrower
1834 #Consistent with the approach Koha uses on deleting individual lists
1835 #Note that entries in virtualshelfcontents added by this borrower to
1836 #lists of others will be handled by a table constraint: the borrower
1837 #is set to NULL in those entries.
1838 $query="DELETE FROM virtualshelves WHERE owner=?";
1839 $dbh->do($query,undef,($borrower));
1842 #We could handle the above deletes via a constraint too.
1843 #But a new BZ report 11889 has been opened to discuss another approach.
1844 #Instead of deleting we could also disown lists (based on a pref).
1845 #In that way we could save shared and public lists.
1846 #The current table constraints support that idea now.
1847 #This pref should then govern the results of other routines/methods such as
1848 #Koha::Virtualshelf->new->delete too.
1851 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1853 $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1855 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1860 sub ExtendMemberSubscriptionTo {
1861 my ( $borrowerid,$date) = @_;
1862 my $dbh = C4::Context->dbh;
1863 my $borrower = GetMember('borrowernumber'=>$borrowerid);
1865 $date = (C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry') ?
1866 eval { output_pref( { dt => dt_from_string( $borrower->{'dateexpiry'} ), dateonly => 1, dateformat => 'iso' } ); }
1868 output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
1869 $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
1871 my $sth = $dbh->do(<<EOF);
1873 SET dateexpiry='$date'
1874 WHERE borrowernumber='$borrowerid'
1877 AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
1879 logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
1880 return $date if ($sth);
1884 =head2 GetTitles (OUEST-PROVENCE)
1886 ($borrowertitle)= &GetTitles();
1888 Looks up the different title . Returns array with all borrowers title
1893 my @borrowerTitle = split (/,|\|/,C4::Context->preference('BorrowersTitles'));
1894 unshift( @borrowerTitle, "" );
1895 my $count=@borrowerTitle;
1900 return ( \@borrowerTitle);
1904 =head2 GetPatronImage
1906 my ($imagedata, $dberror) = GetPatronImage($borrowernumber);
1908 Returns the mimetype and binary image data of the image for the patron with the supplied borrowernumber.
1912 sub GetPatronImage {
1913 my ($borrowernumber) = @_;
1914 warn "Borrowernumber passed to GetPatronImage is $borrowernumber" if $debug;
1915 my $dbh = C4::Context->dbh;
1916 my $query = 'SELECT mimetype, imagefile FROM patronimage WHERE borrowernumber = ?';
1917 my $sth = $dbh->prepare($query);
1918 $sth->execute($borrowernumber);
1919 my $imagedata = $sth->fetchrow_hashref;
1920 warn "Database error!" if $sth->errstr;
1921 return $imagedata, $sth->errstr;
1924 =head2 PutPatronImage
1926 PutPatronImage($cardnumber, $mimetype, $imgfile);
1928 Stores patron binary image data and mimetype in database.
1929 NOTE: This function is good for updating images as well as inserting new images in the database.
1933 sub PutPatronImage {
1934 my ($cardnumber, $mimetype, $imgfile) = @_;
1935 warn "Parameters passed in: Cardnumber=$cardnumber, Mimetype=$mimetype, " . ($imgfile ? "Imagefile" : "No Imagefile") if $debug;
1936 my $dbh = C4::Context->dbh;
1937 my $query = "INSERT INTO patronimage (borrowernumber, mimetype, imagefile) VALUES ( ( SELECT borrowernumber from borrowers WHERE cardnumber = ? ),?,?) ON DUPLICATE KEY UPDATE imagefile = ?;";
1938 my $sth = $dbh->prepare($query);
1939 $sth->execute($cardnumber,$mimetype,$imgfile,$imgfile);
1940 warn "Error returned inserting $cardnumber.$mimetype." if $sth->errstr;
1941 return $sth->errstr;
1944 =head2 RmPatronImage
1946 my ($dberror) = RmPatronImage($borrowernumber);
1948 Removes the image for the patron with the supplied borrowernumber.
1953 my ($borrowernumber) = @_;
1954 warn "Borrowernumber passed to GetPatronImage is $borrowernumber" if $debug;
1955 my $dbh = C4::Context->dbh;
1956 my $query = "DELETE FROM patronimage WHERE borrowernumber = ?;";
1957 my $sth = $dbh->prepare($query);
1958 $sth->execute($borrowernumber);
1959 my $dberror = $sth->errstr;
1960 warn "Database error!" if $sth->errstr;
1964 =head2 GetHideLostItemsPreference
1966 $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1968 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1969 C<&$hidelostitemspref>return value of function, 0 or 1
1973 sub GetHideLostItemsPreference {
1974 my ($borrowernumber) = @_;
1975 my $dbh = C4::Context->dbh;
1976 my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1977 my $sth = $dbh->prepare($query);
1978 $sth->execute($borrowernumber);
1979 my $hidelostitems = $sth->fetchrow;
1980 return $hidelostitems;
1983 =head2 GetBorrowersToExpunge
1985 $borrowers = &GetBorrowersToExpunge(
1986 not_borrowered_since => $not_borrowered_since,
1987 expired_before => $expired_before,
1988 category_code => $category_code,
1989 branchcode => $branchcode
1992 This function get all borrowers based on the given criteria.
1996 sub GetBorrowersToExpunge {
1999 my $filterdate = $params->{'not_borrowered_since'};
2000 my $filterexpiry = $params->{'expired_before'};
2001 my $filtercategory = $params->{'category_code'};
2002 my $filterbranch = $params->{'branchcode'} ||
2003 ((C4::Context->preference('IndependentBranches')
2004 && C4::Context->userenv
2005 && !C4::Context->IsSuperLibrarian()
2006 && C4::Context->userenv->{branch})
2007 ? C4::Context->userenv->{branch}
2010 my $dbh = C4::Context->dbh;
2012 SELECT borrowers.borrowernumber,
2013 MAX(old_issues.timestamp) AS latestissue,
2014 MAX(issues.timestamp) AS currentissue
2016 JOIN categories USING (categorycode)
2020 WHERE guarantorid IS NOT NULL
2021 AND guarantorid <> 0
2022 ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
2023 LEFT JOIN old_issues USING (borrowernumber)
2024 LEFT JOIN issues USING (borrowernumber)
2025 WHERE category_type <> 'S'
2026 AND tmp.guarantorid IS NULL
2030 if ( $filterbranch && $filterbranch ne "" ) {
2031 $query.= " AND borrowers.branchcode = ? ";
2032 push( @query_params, $filterbranch );
2034 if ( $filterexpiry ) {
2035 $query .= " AND dateexpiry < ? ";
2036 push( @query_params, $filterexpiry );
2038 if ( $filtercategory ) {
2039 $query .= " AND categorycode = ? ";
2040 push( @query_params, $filtercategory );
2042 $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
2043 if ( $filterdate ) {
2044 $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
2045 push @query_params,$filterdate;
2047 warn $query if $debug;
2049 my $sth = $dbh->prepare($query);
2050 if (scalar(@query_params)>0){
2051 $sth->execute(@query_params);
2058 while ( my $data = $sth->fetchrow_hashref ) {
2059 push @results, $data;
2064 =head2 GetBorrowersWhoHaveNeverBorrowed
2066 $results = &GetBorrowersWhoHaveNeverBorrowed
2068 This function get all borrowers who have never borrowed.
2070 I<$result> is a ref to an array which all elements are a hasref.
2074 sub GetBorrowersWhoHaveNeverBorrowed {
2075 my $filterbranch = shift ||
2076 ((C4::Context->preference('IndependentBranches')
2077 && C4::Context->userenv
2078 && !C4::Context->IsSuperLibrarian()
2079 && C4::Context->userenv->{branch})
2080 ? C4::Context->userenv->{branch}
2082 my $dbh = C4::Context->dbh;
2084 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
2086 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
2087 WHERE issues.borrowernumber IS NULL
2090 if ($filterbranch && $filterbranch ne ""){
2091 $query.=" AND borrowers.branchcode= ?";
2092 push @query_params,$filterbranch;
2094 warn $query if $debug;
2096 my $sth = $dbh->prepare($query);
2097 if (scalar(@query_params)>0){
2098 $sth->execute(@query_params);
2105 while ( my $data = $sth->fetchrow_hashref ) {
2106 push @results, $data;
2111 =head2 GetBorrowersWithIssuesHistoryOlderThan
2113 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
2115 this function get all borrowers who has an issue history older than I<$date> given on input arg.
2117 I<$result> is a ref to an array which all elements are a hashref.
2118 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2122 sub GetBorrowersWithIssuesHistoryOlderThan {
2123 my $dbh = C4::Context->dbh;
2124 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
2125 my $filterbranch = shift ||
2126 ((C4::Context->preference('IndependentBranches')
2127 && C4::Context->userenv
2128 && !C4::Context->IsSuperLibrarian()
2129 && C4::Context->userenv->{branch})
2130 ? C4::Context->userenv->{branch}
2133 SELECT count(borrowernumber) as n,borrowernumber
2135 WHERE returndate < ?
2136 AND borrowernumber IS NOT NULL
2139 push @query_params, $date;
2141 $query.=" AND branchcode = ?";
2142 push @query_params, $filterbranch;
2144 $query.=" GROUP BY borrowernumber ";
2145 warn $query if $debug;
2146 my $sth = $dbh->prepare($query);
2147 $sth->execute(@query_params);
2150 while ( my $data = $sth->fetchrow_hashref ) {
2151 push @results, $data;
2156 =head2 GetBorrowersNamesAndLatestIssue
2158 $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
2160 this function get borrowers Names and surnames and Issue information.
2162 I<@borrowernumbers> is an array which all elements are borrowernumbers.
2163 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2167 sub GetBorrowersNamesAndLatestIssue {
2168 my $dbh = C4::Context->dbh;
2169 my @borrowernumbers=@_;
2171 SELECT surname,lastname, phone, email,max(timestamp)
2173 LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
2174 GROUP BY borrowernumber
2176 my $sth = $dbh->prepare($query);
2178 my $results = $sth->fetchall_arrayref({});
2184 my $success = ModPrivacy( $borrowernumber, $privacy );
2186 Update the privacy of a patron.
2189 true on success, false on failure
2194 my $borrowernumber = shift;
2195 my $privacy = shift;
2196 return unless defined $borrowernumber;
2197 return unless $borrowernumber =~ /^\d+$/;
2199 return ModMember( borrowernumber => $borrowernumber,
2200 privacy => $privacy );
2205 AddMessage( $borrowernumber, $message_type, $message, $branchcode );
2207 Adds a message to the messages table for the given borrower.
2216 my ( $borrowernumber, $message_type, $message, $branchcode ) = @_;
2218 my $dbh = C4::Context->dbh;
2220 if ( ! ( $borrowernumber && $message_type && $message && $branchcode ) ) {
2224 my $query = "INSERT INTO messages ( borrowernumber, branchcode, message_type, message ) VALUES ( ?, ?, ?, ? )";
2225 my $sth = $dbh->prepare($query);
2226 $sth->execute( $borrowernumber, $branchcode, $message_type, $message );
2227 logaction("MEMBERS", "ADDCIRCMESSAGE", $borrowernumber, $message) if C4::Context->preference("BorrowersLog");
2233 GetMessages( $borrowernumber, $type );
2235 $type is message type, B for borrower, or L for Librarian.
2236 Empty type returns all messages of any type.
2238 Returns all messages for the given borrowernumber
2243 my ( $borrowernumber, $type, $branchcode ) = @_;
2249 my $dbh = C4::Context->dbh;
2252 branches.branchname,
2255 messages.branchcode LIKE '$branchcode' AS can_delete
2256 FROM messages, branches
2257 WHERE borrowernumber = ?
2258 AND message_type LIKE ?
2259 AND messages.branchcode = branches.branchcode
2260 ORDER BY message_date DESC";
2261 my $sth = $dbh->prepare($query);
2262 $sth->execute( $borrowernumber, $type ) ;
2265 while ( my $data = $sth->fetchrow_hashref ) {
2266 $data->{message_date_formatted} = output_pref( { dt => dt_from_string( $data->{message_date} ), dateonly => 1, dateformat => 'iso' } );
2267 push @results, $data;
2275 GetMessagesCount( $borrowernumber, $type );
2277 $type is message type, B for borrower, or L for Librarian.
2278 Empty type returns all messages of any type.
2280 Returns the number of messages for the given borrowernumber
2284 sub GetMessagesCount {
2285 my ( $borrowernumber, $type, $branchcode ) = @_;
2291 my $dbh = C4::Context->dbh;
2293 my $query = "SELECT COUNT(*) as MsgCount FROM messages WHERE borrowernumber = ? AND message_type LIKE ?";
2294 my $sth = $dbh->prepare($query);
2295 $sth->execute( $borrowernumber, $type ) ;
2298 my $data = $sth->fetchrow_hashref;
2299 my $count = $data->{'MsgCount'};
2306 =head2 DeleteMessage
2308 DeleteMessage( $message_id );
2313 my ( $message_id ) = @_;
2315 my $dbh = C4::Context->dbh;
2316 my $query = "SELECT * FROM messages WHERE message_id = ?";
2317 my $sth = $dbh->prepare($query);
2318 $sth->execute( $message_id );
2319 my $message = $sth->fetchrow_hashref();
2321 $query = "DELETE FROM messages WHERE message_id = ?";
2322 $sth = $dbh->prepare($query);
2323 $sth->execute( $message_id );
2324 logaction("MEMBERS", "DELCIRCMESSAGE", $message->{'borrowernumber'}, $message->{'message'}) if C4::Context->preference("BorrowersLog");
2329 IssueSlip($branchcode, $borrowernumber, $quickslip)
2331 Returns letter hash ( see C4::Letters::GetPreparedLetter )
2333 $quickslip is boolean, to indicate whether we want a quick slip
2335 IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
2371 NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
2376 my ($branch, $borrowernumber, $quickslip) = @_;
2378 # FIXME Check callers before removing this statement
2379 #return unless $borrowernumber;
2381 my @issues = @{ GetPendingIssues($borrowernumber) };
2383 for my $issue (@issues) {
2384 $issue->{date_due} = $issue->{date_due_sql};
2386 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
2387 if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
2388 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
2394 # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
2396 my $s = $b->{timestamp} <=> $a->{timestamp};
2398 $b->{issuedate} <=> $a->{issuedate} : $s;
2401 my ($letter_code, %repeat);
2403 $letter_code = 'ISSUEQSLIP';
2405 'checkedout' => [ map {
2408 'biblioitems' => $_,
2410 }, grep { $_->{'now'} } @issues ],
2414 $letter_code = 'ISSUESLIP';
2416 'checkedout' => [ map {
2419 'biblioitems' => $_,
2421 }, grep { !$_->{'overdue'} } @issues ],
2423 'overdue' => [ map {
2426 'biblioitems' => $_,
2428 }, grep { $_->{'overdue'} } @issues ],
2431 $_->{'timestamp'} = $_->{'newdate'};
2433 } @{ GetNewsToDisplay("slip",$branch) } ],
2437 return C4::Letters::GetPreparedLetter (
2438 module => 'circulation',
2439 letter_code => $letter_code,
2440 branchcode => $branch,
2442 'branches' => $branch,
2443 'borrowers' => $borrowernumber,
2449 =head2 GetBorrowersWithEmail
2451 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
2453 This gets a list of users and their basic details from their email address.
2454 As it's possible for multiple user to have the same email address, it provides
2455 you with all of them. If there is no userid for the user, there will be an
2456 C<undef> there. An empty list will be returned if there are no matches.
2460 sub GetBorrowersWithEmail {
2463 my $dbh = C4::Context->dbh;
2465 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
2466 my $sth=$dbh->prepare($query);
2467 $sth->execute($email);
2469 while (my $ref = $sth->fetch) {
2472 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
2476 =head2 AddMember_Opac
2480 sub AddMember_Opac {
2481 my ( %borrower ) = @_;
2483 $borrower{'categorycode'} = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2485 my $sr = new String::Random;
2486 $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
2487 my $password = $sr->randpattern("AAAAAAAAAA");
2488 $borrower{'password'} = $password;
2490 $borrower{'cardnumber'} = fixup_cardnumber();
2492 my $borrowernumber = AddMember(%borrower);
2494 return ( $borrowernumber, $password );
2497 =head2 AddEnrolmentFeeIfNeeded
2499 AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
2501 Add enrolment fee for a patron if needed.
2505 sub AddEnrolmentFeeIfNeeded {
2506 my ( $categorycode, $borrowernumber ) = @_;
2507 # check for enrollment fee & add it if needed
2508 my $dbh = C4::Context->dbh;
2509 my $sth = $dbh->prepare(q{
2512 WHERE categorycode=?
2514 $sth->execute( $categorycode );
2516 warn sprintf('Database returned the following error: %s', $sth->errstr);
2519 my ($enrolmentfee) = $sth->fetchrow;
2520 if ($enrolmentfee && $enrolmentfee > 0) {
2521 # insert fee in patron debts
2522 C4::Accounts::manualinvoice( $borrowernumber, '', '', 'A', $enrolmentfee );
2531 my ( $borrowernumber ) = @_;
2533 my $sql = "SELECT COUNT(*) FROM issues WHERE date_due < NOW() AND borrowernumber = ?";
2534 my $sth = C4::Context->dbh->prepare( $sql );
2535 $sth->execute( $borrowernumber );
2536 my ( $count ) = $sth->fetchrow_array();
2541 =head2 DeleteExpiredOpacRegistrations
2543 Delete accounts that haven't been upgraded from the 'temporary' category
2544 Returns the number of removed patrons
2548 sub DeleteExpiredOpacRegistrations {
2550 my $delay = C4::Context->preference('PatronSelfRegistrationExpireTemporaryAccountsDelay');
2551 my $category_code = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2553 return 0 if not $category_code or not defined $delay or $delay eq q||;
2556 SELECT borrowernumber
2558 WHERE categorycode = ? AND DATEDIFF( NOW(), dateenrolled ) > ? |;
2560 my $dbh = C4::Context->dbh;
2561 my $sth = $dbh->prepare($query);
2562 $sth->execute( $category_code, $delay );
2564 while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
2565 DelMember($borrowernumber);
2571 =head2 DeleteUnverifiedOpacRegistrations
2573 Delete all unverified self registrations in borrower_modifications,
2574 older than the specified number of days.
2578 sub DeleteUnverifiedOpacRegistrations {
2580 my $dbh = C4::Context->dbh;
2582 DELETE FROM borrower_modifications
2583 WHERE borrowernumber = 0 AND DATEDIFF( NOW(), timestamp ) > ?|;
2584 my $cnt=$dbh->do($sql, undef, ($days) );
2585 return $cnt eq '0E0'? 0: $cnt;
2588 sub GetOverduesForPatron {
2589 my ( $borrowernumber ) = @_;
2593 FROM issues, items, biblio, biblioitems
2594 WHERE items.itemnumber=issues.itemnumber
2595 AND biblio.biblionumber = items.biblionumber
2596 AND biblio.biblionumber = biblioitems.biblionumber
2597 AND issues.borrowernumber = ?
2598 AND date_due < NOW()
2601 my $sth = C4::Context->dbh->prepare( $sql );
2602 $sth->execute( $borrowernumber );
2604 return $sth->fetchall_arrayref({});
2607 END { } # module clean-up code here (global destructor)