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 C4::Dates qw(format_date_in_iso format_date);
27 use String::Random qw( random_string );
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::Borrower::Debarments qw(IsDebarred);
41 use Text::Unaccent qw( unac_string );
42 use Koha::AuthUtils qw(hash_password);
45 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
46 load Koha::NorwegianPatronDB, qw( NLUpdateHashedPIN NLEncryptPIN NLSync );
49 our ($VERSION,@ISA,@EXPORT,@EXPORT_OK,$debug);
52 $VERSION = 3.07.00.049;
53 $debug = $ENV{DEBUG} || 0;
65 &GetMemberIssuesAndFines
72 &GetFirstValidEmailAddress
73 &GetNoticeEmailAddress
84 &GetHideLostItemsPreference
87 &GetMemberAccountRecords
88 &GetBorNotifyAcctRecord
92 GetBorrowerCategorycode
93 &GetBorrowercategoryList
95 &GetBorrowersToExpunge
96 &GetBorrowersWhoHaveNeverBorrowed
97 &GetBorrowersWithIssuesHistoryOlderThan
107 GetBorrowersWithEmail
129 &ExtendMemberSubscriptionTo
147 C4::Members - Perl Module containing convenience functions for member handling
155 This module contains routines for adding, modifying and deleting members/patrons/borrowers
159 =head2 GetMemberDetails
161 ($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
163 Looks up a patron and returns information about him or her. If
164 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
165 up the borrower by number; otherwise, it looks up the borrower by card
168 C<$borrower> is a reference-to-hash whose keys are the fields of the
169 borrowers table in the Koha database. In addition,
170 C<$borrower-E<gt>{flags}> is a hash giving more detailed information
171 about the patron. Its keys act as flags :
173 if $borrower->{flags}->{LOST} {
174 # Patron's card was reported lost
177 If the state of a flag means that the patron should not be
178 allowed to borrow any more books, then it will have a C<noissues> key
181 See patronflags for more details.
183 C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
184 about the top-level permissions flags set for the borrower. For example,
185 if a user has the "editcatalogue" permission,
186 C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
191 sub GetMemberDetails {
192 my ( $borrowernumber, $cardnumber ) = @_;
193 my $dbh = C4::Context->dbh;
196 if ($borrowernumber) {
197 $sth = $dbh->prepare("
200 categories.description,
201 categories.BlockExpiredPatronOpacActions,
205 LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
206 WHERE borrowernumber = ?
208 $sth->execute($borrowernumber);
210 elsif ($cardnumber) {
211 $sth = $dbh->prepare("
214 categories.description,
215 categories.BlockExpiredPatronOpacActions,
219 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
222 $sth->execute($cardnumber);
227 my $borrower = $sth->fetchrow_hashref;
228 return unless $borrower;
229 my ($amount) = GetMemberAccountRecords($borrower->{borrowernumber});
230 $borrower->{'amountoutstanding'} = $amount;
231 # FIXME - patronflags calls GetMemberAccountRecords... just have patronflags return $amount
232 my $flags = patronflags( $borrower);
235 $sth = $dbh->prepare("select bit,flag from userflags");
237 while ( my ( $bit, $flag ) = $sth->fetchrow ) {
238 if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
239 $accessflagshash->{$flag} = 1;
242 $borrower->{'flags'} = $flags;
243 $borrower->{'authflags'} = $accessflagshash;
245 # For the purposes of making templates easier, we'll define a
246 # 'showname' which is the alternate form the user's first name if
247 # 'other name' is defined.
248 if ($borrower->{category_type} eq 'I') {
249 $borrower->{'showname'} = $borrower->{'othernames'};
250 $borrower->{'showname'} .= " $borrower->{'firstname'}" if $borrower->{'firstname'};
252 $borrower->{'showname'} = $borrower->{'firstname'};
255 # Handle setting the true behavior for BlockExpiredPatronOpacActions
256 $borrower->{'BlockExpiredPatronOpacActions'} =
257 C4::Context->preference('BlockExpiredPatronOpacActions')
258 if ( $borrower->{'BlockExpiredPatronOpacActions'} == -1 );
260 $borrower->{'is_expired'} = 0;
261 $borrower->{'is_expired'} = 1 if
262 defined($borrower->{dateexpiry}) &&
263 $borrower->{'dateexpiry'} ne '0000-00-00' &&
264 Date_to_Days( Today() ) >
265 Date_to_Days( split /-/, $borrower->{'dateexpiry'} );
267 return ($borrower); #, $flags, $accessflagshash);
272 $flags = &patronflags($patron);
274 This function is not exported.
276 The following will be set where applicable:
277 $flags->{CHARGES}->{amount} Amount of debt
278 $flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge)
279 $flags->{CHARGES}->{message} Message -- deprecated
281 $flags->{CREDITS}->{amount} Amount of credit
282 $flags->{CREDITS}->{message} Message -- deprecated
284 $flags->{ GNA } Patron has no valid address
285 $flags->{ GNA }->{noissues} Set for each GNA
286 $flags->{ GNA }->{message} "Borrower has no valid address" -- deprecated
288 $flags->{ LOST } Patron's card reported lost
289 $flags->{ LOST }->{noissues} Set for each LOST
290 $flags->{ LOST }->{message} Message -- deprecated
292 $flags->{DBARRED} Set if patron debarred, no access
293 $flags->{DBARRED}->{noissues} Set for each DBARRED
294 $flags->{DBARRED}->{message} Message -- deprecated
297 $flags->{ NOTES }->{message} The note itself. NOT deprecated
299 $flags->{ ODUES } Set if patron has overdue books.
300 $flags->{ ODUES }->{message} "Yes" -- deprecated
301 $flags->{ ODUES }->{itemlist} ref-to-array: list of overdue books
302 $flags->{ ODUES }->{itemlisttext} Text list of overdue items -- deprecated
304 $flags->{WAITING} Set if any of patron's reserves are available
305 $flags->{WAITING}->{message} Message -- deprecated
306 $flags->{WAITING}->{itemlist} ref-to-array: list of available items
310 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
311 overdue items. Its elements are references-to-hash, each describing an
312 overdue item. The keys are selected fields from the issues, biblio,
313 biblioitems, and items tables of the Koha database.
315 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
316 the overdue items, one per line. Deprecated.
318 =item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
319 available items. Each element is a reference-to-hash whose keys are
320 fields from the reserves table of the Koha database.
324 All the "message" fields that include language generated in this function are deprecated,
325 because such strings belong properly in the display layer.
327 The "message" field that comes from the DB is OK.
331 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
332 # FIXME rename this function.
335 my ( $patroninformation) = @_;
336 my $dbh=C4::Context->dbh;
337 my ($balance, $owing) = GetMemberAccountBalance( $patroninformation->{'borrowernumber'});
340 my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
341 $flaginfo{'message'} = sprintf 'Patron owes %.02f', $owing;
342 $flaginfo{'amount'} = sprintf "%.02f", $owing;
343 if ( $owing > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
344 $flaginfo{'noissues'} = 1;
346 $flags{'CHARGES'} = \%flaginfo;
348 elsif ( $balance < 0 ) {
350 $flaginfo{'message'} = sprintf 'Patron has credit of %.02f', -$balance;
351 $flaginfo{'amount'} = sprintf "%.02f", $balance;
352 $flags{'CREDITS'} = \%flaginfo;
354 if ( $patroninformation->{'gonenoaddress'}
355 && $patroninformation->{'gonenoaddress'} == 1 )
358 $flaginfo{'message'} = 'Borrower has no valid address.';
359 $flaginfo{'noissues'} = 1;
360 $flags{'GNA'} = \%flaginfo;
362 if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
364 $flaginfo{'message'} = 'Borrower\'s card reported lost.';
365 $flaginfo{'noissues'} = 1;
366 $flags{'LOST'} = \%flaginfo;
368 if ( $patroninformation->{'debarred'} && check_date( split( /-/, $patroninformation->{'debarred'} ) ) ) {
369 if ( Date_to_Days(Date::Calc::Today) < Date_to_Days( split( /-/, $patroninformation->{'debarred'} ) ) ) {
371 $flaginfo{'debarredcomment'} = $patroninformation->{'debarredcomment'};
372 $flaginfo{'message'} = $patroninformation->{'debarredcomment'};
373 $flaginfo{'noissues'} = 1;
374 $flaginfo{'dateend'} = $patroninformation->{'debarred'};
375 $flags{'DBARRED'} = \%flaginfo;
378 if ( $patroninformation->{'borrowernotes'}
379 && $patroninformation->{'borrowernotes'} )
382 $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
383 $flags{'NOTES'} = \%flaginfo;
385 my ( $odues, $itemsoverdue ) = C4::Overdues::checkoverdues($patroninformation->{'borrowernumber'});
386 if ( $odues && $odues > 0 ) {
388 $flaginfo{'message'} = "Yes";
389 $flaginfo{'itemlist'} = $itemsoverdue;
390 foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
393 $flaginfo{'itemlisttext'} .=
394 "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n"; # newline is display layer
396 $flags{'ODUES'} = \%flaginfo;
398 my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
399 my $nowaiting = scalar @itemswaiting;
400 if ( $nowaiting > 0 ) {
402 $flaginfo{'message'} = "Reserved items available";
403 $flaginfo{'itemlist'} = \@itemswaiting;
404 $flags{'WAITING'} = \%flaginfo;
412 $borrower = &GetMember(%information);
414 Retrieve the first patron record meeting on criteria listed in the
415 C<%information> hash, which should contain one or more
416 pairs of borrowers column names and values, e.g.,
418 $borrower = GetMember(borrowernumber => id);
420 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
421 the C<borrowers> table in the Koha database.
423 FIXME: GetMember() is used throughout the code as a lookup
424 on a unique key such as the borrowernumber, but this meaning is not
425 enforced in the routine itself.
431 my ( %information ) = @_;
432 if (exists $information{borrowernumber} && !defined $information{borrowernumber}) {
433 #passing mysql's kohaadmin?? Makes no sense as a query
436 my $dbh = C4::Context->dbh;
438 q{SELECT borrowers.*, categories.category_type, categories.description
440 LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
443 for (keys %information ) {
451 if (defined $information{$_}) {
453 push @values, $information{$_};
456 $select .= "$_ IS NULL";
459 $debug && warn $select, " ",values %information;
460 my $sth = $dbh->prepare("$select");
461 $sth->execute(map{$information{$_}} keys %information);
462 my $data = $sth->fetchall_arrayref({});
463 #FIXME interface to this routine now allows generation of a result set
464 #so whole array should be returned but bowhere in the current code expects this
472 =head2 GetMemberRelatives
474 @borrowernumbers = GetMemberRelatives($borrowernumber);
476 C<GetMemberRelatives> returns a borrowersnumber's list of guarantor/guarantees of the member given in parameter
480 sub GetMemberRelatives {
481 my $borrowernumber = shift;
482 my $dbh = C4::Context->dbh;
486 my $query = "SELECT guarantorid FROM borrowers WHERE borrowernumber=?";
487 my $sth = $dbh->prepare($query);
488 $sth->execute($borrowernumber);
489 my $data = $sth->fetchrow_arrayref();
490 push @glist, $data->[0] if $data->[0];
491 my $guarantor = $data->[0] ? $data->[0] : undef;
494 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
495 $sth = $dbh->prepare($query);
496 $sth->execute($borrowernumber);
497 while ($data = $sth->fetchrow_arrayref()) {
498 push @glist, $data->[0];
501 # Getting sibling guarantees
503 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
504 $sth = $dbh->prepare($query);
505 $sth->execute($guarantor);
506 while ($data = $sth->fetchrow_arrayref()) {
507 push @glist, $data->[0] if ($data->[0] != $borrowernumber);
514 =head2 IsMemberBlocked
516 my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
518 Returns whether a patron is restricted or has overdue items that may result
519 in a block of circulation privileges.
521 C<$block_status> can have the following values:
523 1 if the patron is currently restricted, in which case
524 C<$count> is the expiration date (9999-12-31 for indefinite)
526 -1 if the patron has overdue items, in which case C<$count> is the number of them
528 0 if the patron has no overdue items or outstanding fine days, in which case C<$count> is 0
530 Existing active restrictions are checked before current overdue items.
534 sub IsMemberBlocked {
535 my $borrowernumber = shift;
536 my $dbh = C4::Context->dbh;
538 my $blockeddate = Koha::Borrower::Debarments::IsDebarred($borrowernumber);
540 return ( 1, $blockeddate ) if $blockeddate;
542 # if he have late issues
543 my $sth = $dbh->prepare(
544 "SELECT COUNT(*) as latedocs
546 WHERE borrowernumber = ?
547 AND date_due < now()"
549 $sth->execute($borrowernumber);
550 my $latedocs = $sth->fetchrow_hashref->{'latedocs'};
552 return ( -1, $latedocs ) if $latedocs > 0;
557 =head2 GetMemberIssuesAndFines
559 ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
561 Returns aggregate data about items borrowed by the patron with the
562 given borrowernumber.
564 C<&GetMemberIssuesAndFines> returns a three-element array. C<$overdue_count> is the
565 number of overdue items the patron currently has borrowed. C<$issue_count> is the
566 number of books the patron currently has borrowed. C<$total_fines> is
567 the total fine currently due by the borrower.
572 sub GetMemberIssuesAndFines {
573 my ( $borrowernumber ) = @_;
574 my $dbh = C4::Context->dbh;
575 my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
577 $debug and warn $query."\n";
578 my $sth = $dbh->prepare($query);
579 $sth->execute($borrowernumber);
580 my $issue_count = $sth->fetchrow_arrayref->[0];
582 $sth = $dbh->prepare(
583 "SELECT COUNT(*) FROM issues
584 WHERE borrowernumber = ?
585 AND date_due < now()"
587 $sth->execute($borrowernumber);
588 my $overdue_count = $sth->fetchrow_arrayref->[0];
590 $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
591 $sth->execute($borrowernumber);
592 my $total_fines = $sth->fetchrow_arrayref->[0];
594 return ($overdue_count, $issue_count, $total_fines);
600 my @columns = C4::Member::columns();
602 Returns an array of borrowers' table columns on success,
603 and an empty array on failure.
609 # Pure ANSI SQL goodness.
610 my $sql = 'SELECT * FROM borrowers WHERE 1=0;';
612 # Get the database handle.
613 my $dbh = C4::Context->dbh;
615 # Run the SQL statement to load STH's readonly properties.
616 my $sth = $dbh->prepare($sql);
617 my $rv = $sth->execute();
619 # This only fails if the table doesn't exist.
620 # This will always be called AFTER an install or upgrade,
621 # so borrowers will exist!
623 if ($sth->{NUM_OF_FIELDS}>0) {
624 @data = @{$sth->{NAME}};
635 my $success = ModMember(borrowernumber => $borrowernumber,
636 [ field => value ]... );
638 Modify borrower's data. All date fields should ALREADY be in ISO format.
641 true on success, or false on failure
647 # test to know if you must update or not the borrower password
648 if (exists $data{password}) {
649 if ($data{password} eq '****' or $data{password} eq '') {
650 delete $data{password};
652 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
653 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
654 NLUpdateHashedPIN( $data{'borrowernumber'}, $data{password} );
656 $data{password} = hash_password($data{password});
659 my $old_categorycode = GetBorrowerCategorycode( $data{borrowernumber} );
661 # get only the columns of a borrower
662 my $schema = Koha::Database->new()->schema;
663 my @columns = $schema->source('Borrower')->columns;
664 my $new_borrower = { map { join(' ', @columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) };
665 delete $new_borrower->{flags};
667 $new_borrower->{dateofbirth} ||= undef if exists $new_borrower->{dateofbirth};
668 $new_borrower->{dateenrolled} ||= undef if exists $new_borrower->{dateenrolled};
669 $new_borrower->{dateexpiry} ||= undef if exists $new_borrower->{dateexpiry};
670 my $rs = $schema->resultset('Borrower')->search({
671 borrowernumber => $new_borrower->{borrowernumber},
673 my $execute_success = $rs->update($new_borrower);
674 if ($execute_success ne '0E0') { # only proceed if the update was a success
675 # ok if its an adult (type) it may have borrowers that depend on it as a guarantor
676 # so when we update information for an adult we should check for guarantees and update the relevant part
677 # of their records, ie addresses and phone numbers
678 my $borrowercategory= GetBorrowercategory( $data{'category_type'} );
679 if ( exists $borrowercategory->{'category_type'} && $borrowercategory->{'category_type'} eq ('A' || 'S') ) {
680 # is adult check guarantees;
681 UpdateGuarantees(%data);
684 # If the patron changes to a category with enrollment fee, we add a fee
685 if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
686 if ( C4::Context->preference('FeeOnChangePatronCategory') ) {
687 AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
691 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
692 # cronjob will use for syncing with NL
693 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
694 my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
695 'synctype' => 'norwegianpatrondb',
696 'borrowernumber' => $data{'borrowernumber'}
698 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
699 # we can sync as changed. And the "new sync" will pick up all changes since
700 # the patron was created anyway.
701 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
702 $borrowersync->update( { 'syncstatus' => 'edited' } );
704 # Set the value of 'sync'
705 $borrowersync->update( { 'sync' => $data{'sync'} } );
706 # Try to do the live sync
707 NLSync({ 'borrowernumber' => $data{'borrowernumber'} });
710 logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
712 return $execute_success;
717 $borrowernumber = &AddMember(%borrower);
719 insert new borrower into table
721 (%borrower keys are database columns. Database columns could be
722 different in different versions. Please look into database for correct
725 Returns the borrowernumber upon success
727 Returns as undef upon any db error without further processing
734 my $dbh = C4::Context->dbh;
735 my $schema = Koha::Database->new()->schema;
737 # generate a proper login if none provided
738 $data{'userid'} = Generate_Userid( $data{'borrowernumber'}, $data{'firstname'}, $data{'surname'} )
739 if ( $data{'userid'} eq '' || !Check_Userid( $data{'userid'} ) );
741 # add expiration date if it isn't already there
742 unless ( $data{'dateexpiry'} ) {
743 $data{'dateexpiry'} = GetExpiryDate( $data{'categorycode'}, C4::Dates->new()->output("iso") );
746 # add enrollment date if it isn't already there
747 unless ( $data{'dateenrolled'} ) {
748 $data{'dateenrolled'} = C4::Dates->new()->output("iso");
751 my $patron_category = $schema->resultset('Category')->find( $data{'categorycode'} );
753 $patron_category->default_privacy() eq 'default' ? 1
754 : $patron_category->default_privacy() eq 'never' ? 2
755 : $patron_category->default_privacy() eq 'forever' ? 0
757 # Make a copy of the plain text password for later use
758 my $plain_text_password = $data{'password'};
760 # create a disabled account if no password provided
761 $data{'password'} = ($data{'password'})? hash_password($data{'password'}) : '!';
763 # we don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00
764 $data{'dateofbirth'} = undef if( not $data{'dateofbirth'} );
765 $data{'debarred'} = undef if ( not $data{'debarred'} );
767 # get only the columns of Borrower
768 my @columns = $schema->source('Borrower')->columns;
769 my $new_member = { map { join(' ',@columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) } ;
770 delete $new_member->{borrowernumber};
772 my $rs = $schema->resultset('Borrower');
773 $data{borrowernumber} = $rs->create($new_member)->id;
775 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
776 # cronjob will use for syncing with NL
777 if ( exists $data{'borrowernumber'} && C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
778 Koha::Database->new->schema->resultset('BorrowerSync')->create({
779 'borrowernumber' => $data{'borrowernumber'},
780 'synctype' => 'norwegianpatrondb',
782 'syncstatus' => 'new',
783 'hashed_pin' => NLEncryptPIN( $plain_text_password ),
787 # mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
788 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
790 AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
792 return $data{borrowernumber};
797 my $uniqueness = Check_Userid($userid,$borrowernumber);
799 $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 != '').
801 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.
804 0 for not unique (i.e. this $userid already exists)
805 1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
810 my ( $uid, $borrowernumber ) = @_;
812 return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
814 return 0 if ( $uid eq C4::Context->config('user') );
816 my $rs = Koha::Database->new()->schema()->resultset('Borrower');
819 $params->{userid} = $uid;
820 $params->{borrowernumber} = { '!=' => $borrowernumber } if ($borrowernumber);
822 my $count = $rs->count( $params );
824 return $count ? 0 : 1;
827 =head2 Generate_Userid
829 my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
831 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
833 $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.
836 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).
840 sub Generate_Userid {
841 my ($borrowernumber, $firstname, $surname) = @_;
844 #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
846 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
847 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
848 $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
849 $newuid = unac_string('utf-8',$newuid);
850 $newuid .= $offset unless $offset == 0;
853 } while (!Check_Userid($newuid,$borrowernumber));
859 my ( $uid, $member, $digest ) = @_;
860 my $dbh = C4::Context->dbh;
862 #Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
863 #Then we need to tell the user and have them create a new one.
867 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
868 $sth->execute( $uid, $member );
869 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
873 #Everything is good so we can update the information.
876 "update borrowers set userid=?, password=? where borrowernumber=?");
877 $sth->execute( $uid, $digest, $member );
881 logaction("MEMBERS", "CHANGE PASS", $member, "") if C4::Context->preference("BorrowersLog");
887 =head2 fixup_cardnumber
889 Warning: The caller is responsible for locking the members table in write
890 mode, to avoid database corruption.
894 use vars qw( @weightings );
895 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
897 sub fixup_cardnumber {
898 my ($cardnumber) = @_;
899 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
901 # Find out whether member numbers should be generated
902 # automatically. Should be either "1" or something else.
903 # Defaults to "0", which is interpreted as "no".
905 # if ($cardnumber !~ /\S/ && $autonumber_members) {
906 ($autonumber_members) or return $cardnumber;
907 my $checkdigit = C4::Context->preference('checkdigit');
908 my $dbh = C4::Context->dbh;
909 if ( $checkdigit and $checkdigit eq 'katipo' ) {
911 # if checkdigit is selected, calculate katipo-style cardnumber.
912 # otherwise, just use the max()
913 # purpose: generate checksum'd member numbers.
914 # We'll assume we just got the max value of digits 2-8 of member #'s
915 # from the database and our job is to increment that by one,
916 # determine the 1st and 9th digits and return the full string.
917 my $sth = $dbh->prepare(
918 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
921 my $data = $sth->fetchrow_hashref;
922 $cardnumber = $data->{new_num};
923 if ( !$cardnumber ) { # If DB has no values,
924 $cardnumber = 1000000; # start at 1000000
930 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
931 # read weightings, left to right, 1 char at a time
932 my $temp1 = $weightings[$i];
934 # sequence left to right, 1 char at a time
935 my $temp2 = substr( $cardnumber, $i, 1 );
937 # mult each char 1-7 by its corresponding weighting
938 $sum += $temp1 * $temp2;
941 my $rem = ( $sum % 11 );
942 $rem = 'X' if $rem == 10;
944 return "V$cardnumber$rem";
947 my $sth = $dbh->prepare(
948 'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
951 my ($result) = $sth->fetchrow;
954 return $cardnumber; # just here as a fallback/reminder
959 ($num_children, $children_arrayref) = &GetGuarantees($parent_borrno);
960 $child0_cardno = $children_arrayref->[0]{"cardnumber"};
961 $child0_borrno = $children_arrayref->[0]{"borrowernumber"};
963 C<&GetGuarantees> takes a borrower number (e.g., that of a patron
964 with children) and looks up the borrowers who are guaranteed by that
965 borrower (i.e., the patron's children).
967 C<&GetGuarantees> returns two values: an integer giving the number of
968 borrowers guaranteed by C<$parent_borrno>, and a reference to an array
969 of references to hash, which gives the actual results.
975 my ($borrowernumber) = @_;
976 my $dbh = C4::Context->dbh;
979 "select cardnumber,borrowernumber, firstname, surname from borrowers where guarantorid=?"
981 $sth->execute($borrowernumber);
984 my $data = $sth->fetchall_arrayref({});
985 return ( scalar(@$data), $data );
988 =head2 UpdateGuarantees
990 &UpdateGuarantees($parent_borrno);
993 C<&UpdateGuarantees> borrower data for an adult and updates all the guarantees
994 with the modified information
999 sub UpdateGuarantees {
1001 my $dbh = C4::Context->dbh;
1002 my ( $count, $guarantees ) = GetGuarantees( $data{'borrowernumber'} );
1003 foreach my $guarantee (@$guarantees){
1004 my $guaquery = qq|UPDATE borrowers
1005 SET address=?,fax=?,B_city=?,mobile=?,city=?,phone=?
1006 WHERE borrowernumber=?
1008 my $sth = $dbh->prepare($guaquery);
1009 $sth->execute($data{'address'},$data{'fax'},$data{'B_city'},$data{'mobile'},$data{'city'},$data{'phone'},$guarantee->{'borrowernumber'});
1012 =head2 GetPendingIssues
1014 my $issues = &GetPendingIssues(@borrowernumber);
1016 Looks up what the patron with the given borrowernumber has borrowed.
1018 C<&GetPendingIssues> returns a
1019 reference-to-array where each element is a reference-to-hash; the
1020 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
1021 The keys include C<biblioitems> fields except marc and marcxml.
1026 sub GetPendingIssues {
1027 my @borrowernumbers = @_;
1029 unless (@borrowernumbers ) { # return a ref_to_array
1030 return \@borrowernumbers; # to not cause surprise to caller
1033 # Borrowers part of the query
1035 for (my $i = 0; $i < @borrowernumbers; $i++) {
1036 $bquery .= ' issues.borrowernumber = ?';
1037 if ($i < $#borrowernumbers ) {
1042 # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
1043 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
1044 # FIXME: circ/ciculation.pl tries to sort by timestamp!
1045 # FIXME: namespace collision: other collisions possible.
1046 # FIXME: most of this data isn't really being used by callers.
1053 biblioitems.itemtype,
1056 biblioitems.publicationyear,
1057 biblioitems.publishercode,
1058 biblioitems.volumedate,
1059 biblioitems.volumedesc,
1062 borrowers.firstname,
1064 borrowers.cardnumber,
1065 issues.timestamp AS timestamp,
1066 issues.renewals AS renewals,
1067 issues.borrowernumber AS borrowernumber,
1068 items.renewals AS totalrenewals
1070 LEFT JOIN items ON items.itemnumber = issues.itemnumber
1071 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1072 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
1073 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
1076 ORDER BY issues.issuedate"
1079 my $sth = C4::Context->dbh->prepare($query);
1080 $sth->execute(@borrowernumbers);
1081 my $data = $sth->fetchall_arrayref({});
1082 my $today = dt_from_string;
1083 foreach (@{$data}) {
1084 if ($_->{issuedate}) {
1085 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
1087 $_->{date_due_sql} = $_->{date_due};
1088 # FIXME no need to have this value
1089 $_->{date_due} or next;
1090 $_->{date_due_sql} = $_->{date_due};
1091 # FIXME no need to have this value
1092 $_->{date_due} = dt_from_string($_->{date_due}, 'sql');
1093 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
1102 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
1104 Looks up what the patron with the given borrowernumber has borrowed,
1105 and sorts the results.
1107 C<$sortkey> is the name of a field on which to sort the results. This
1108 should be the name of a field in the C<issues>, C<biblio>,
1109 C<biblioitems>, or C<items> table in the Koha database.
1111 C<$limit> is the maximum number of results to return.
1113 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
1114 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
1115 C<items> tables of the Koha database.
1121 my ( $borrowernumber, $order, $limit ) = @_;
1123 return unless $borrowernumber;
1124 $order = 'date_due desc' unless $order;
1126 my $dbh = C4::Context->dbh;
1128 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1130 LEFT JOIN items on items.itemnumber=issues.itemnumber
1131 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1132 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1133 WHERE borrowernumber=?
1135 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1137 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
1138 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1139 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1140 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
1141 order by ' . $order;
1143 $query .= " limit $limit";
1146 my $sth = $dbh->prepare($query);
1147 $sth->execute( $borrowernumber, $borrowernumber );
1148 return $sth->fetchall_arrayref( {} );
1152 =head2 GetMemberAccountRecords
1154 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
1156 Looks up accounting data for the patron with the given borrowernumber.
1158 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
1159 reference-to-array, where each element is a reference-to-hash; the
1160 keys are the fields of the C<accountlines> table in the Koha database.
1161 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1162 total amount outstanding for all of the account lines.
1166 sub GetMemberAccountRecords {
1167 my ($borrowernumber) = @_;
1168 my $dbh = C4::Context->dbh;
1174 WHERE borrowernumber=?);
1175 $strsth.=" ORDER BY date desc,timestamp DESC";
1176 my $sth= $dbh->prepare( $strsth );
1177 $sth->execute( $borrowernumber );
1180 while ( my $data = $sth->fetchrow_hashref ) {
1181 if ( $data->{itemnumber} ) {
1182 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1183 $data->{biblionumber} = $biblio->{biblionumber};
1184 $data->{title} = $biblio->{title};
1186 $acctlines[$numlines] = $data;
1188 $total += int(1000 * $data->{'amountoutstanding'}); # convert float to integer to avoid round-off errors
1191 return ( $total, \@acctlines,$numlines);
1194 =head2 GetMemberAccountBalance
1196 ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
1198 Calculates amount immediately owing by the patron - non-issue charges.
1199 Based on GetMemberAccountRecords.
1200 Charges exempt from non-issue are:
1202 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
1203 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
1207 sub GetMemberAccountBalance {
1208 my ($borrowernumber) = @_;
1210 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
1213 push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
1214 push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
1215 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
1216 my $dbh = C4::Context->dbh;
1217 my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
1218 push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
1220 my %not_fine = map {$_ => 1} @not_fines;
1222 my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
1223 my $other_charges = 0;
1224 foreach (@$acctlines) {
1225 $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
1228 return ( $total, $total - $other_charges, $other_charges);
1231 =head2 GetBorNotifyAcctRecord
1233 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1235 Looks up accounting data for the patron with the given borrowernumber per file number.
1237 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1238 reference-to-array, where each element is a reference-to-hash; the
1239 keys are the fields of the C<accountlines> table in the Koha database.
1240 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1241 total amount outstanding for all of the account lines.
1245 sub GetBorNotifyAcctRecord {
1246 my ( $borrowernumber, $notifyid ) = @_;
1247 my $dbh = C4::Context->dbh;
1250 my $sth = $dbh->prepare(
1253 WHERE borrowernumber=?
1255 AND amountoutstanding != '0'
1256 ORDER BY notify_id,accounttype
1259 $sth->execute( $borrowernumber, $notifyid );
1261 while ( my $data = $sth->fetchrow_hashref ) {
1262 if ( $data->{itemnumber} ) {
1263 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1264 $data->{biblionumber} = $biblio->{biblionumber};
1265 $data->{title} = $biblio->{title};
1267 $acctlines[$numlines] = $data;
1269 $total += int(100 * $data->{'amountoutstanding'});
1272 return ( $total, \@acctlines, $numlines );
1275 =head2 checkuniquemember (OUEST-PROVENCE)
1277 ($result,$categorycode) = &checkuniquemember($collectivity,$surname,$firstname,$dateofbirth);
1279 Checks that a member exists or not in the database.
1281 C<&result> is nonzero (=exist) or 0 (=does not exist)
1282 C<&categorycode> is from categorycode table
1283 C<&collectivity> is 1 (= we add a collectivity) or 0 (= we add a physical member)
1284 C<&surname> is the surname
1285 C<&firstname> is the firstname (only if collectivity=0)
1286 C<&dateofbirth> is the date of birth in ISO format (only if collectivity=0)
1290 # FIXME: This function is not legitimate. Multiple patrons might have the same first/last name and birthdate.
1291 # This is especially true since first name is not even a required field.
1293 sub checkuniquemember {
1294 my ( $collectivity, $surname, $firstname, $dateofbirth ) = @_;
1295 my $dbh = C4::Context->dbh;
1296 my $request = ($collectivity) ?
1297 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? " :
1299 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=? and dateofbirth=?" :
1300 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?";
1301 my $sth = $dbh->prepare($request);
1302 if ($collectivity) {
1303 $sth->execute( uc($surname) );
1304 } elsif($dateofbirth){
1305 $sth->execute( uc($surname), ucfirst($firstname), $dateofbirth );
1307 $sth->execute( uc($surname), ucfirst($firstname));
1309 my @data = $sth->fetchrow;
1310 ( $data[0] ) and return $data[0], $data[1];
1314 sub checkcardnumber {
1315 my ( $cardnumber, $borrowernumber ) = @_;
1317 # If cardnumber is null, we assume they're allowed.
1318 return 0 unless defined $cardnumber;
1320 my $dbh = C4::Context->dbh;
1321 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1322 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1323 my $sth = $dbh->prepare($query);
1326 ( $borrowernumber ? $borrowernumber : () )
1329 return 1 if $sth->fetchrow_hashref;
1331 my ( $min_length, $max_length ) = get_cardnumber_length();
1333 if length $cardnumber > $max_length
1334 or length $cardnumber < $min_length;
1339 =head2 get_cardnumber_length
1341 my ($min, $max) = C4::Members::get_cardnumber_length()
1343 Returns the minimum and maximum length for patron cardnumbers as
1344 determined by the CardnumberLength system preference, the
1345 BorrowerMandatoryField system preference, and the width of the
1350 sub get_cardnumber_length {
1351 my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
1352 $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
1353 if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
1354 # Is integer and length match
1355 if ( $cardnumber_length =~ m|^\d+$| ) {
1356 $min = $max = $cardnumber_length
1357 if $cardnumber_length >= $min
1358 and $cardnumber_length <= $max;
1360 # Else assuming it is a range
1361 elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
1362 $min = $1 if $1 and $min < $1;
1363 $max = $2 if $2 and $max > $2;
1367 return ( $min, $max );
1370 =head2 getzipnamecity (OUEST-PROVENCE)
1372 take all info from table city for the fields city and zip
1373 check for the name and the zip code of the city selected
1377 sub getzipnamecity {
1379 my $dbh = C4::Context->dbh;
1382 "select city_name,city_state,city_zipcode,city_country from cities where cityid=? ");
1383 $sth->execute($cityid);
1384 my @data = $sth->fetchrow;
1385 return $data[0], $data[1], $data[2], $data[3];
1389 =head2 getdcity (OUEST-PROVENCE)
1391 recover cityid with city_name condition
1396 my ($city_name) = @_;
1397 my $dbh = C4::Context->dbh;
1398 my $sth = $dbh->prepare("select cityid from cities where city_name=? ");
1399 $sth->execute($city_name);
1400 my $data = $sth->fetchrow;
1404 =head2 GetFirstValidEmailAddress
1406 $email = GetFirstValidEmailAddress($borrowernumber);
1408 Return the first valid email address for a borrower, given the borrowernumber. For now, the order
1409 is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
1414 sub GetFirstValidEmailAddress {
1415 my $borrowernumber = shift;
1416 my $dbh = C4::Context->dbh;
1417 my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1418 $sth->execute( $borrowernumber );
1419 my $data = $sth->fetchrow_hashref;
1421 if ($data->{'email'}) {
1422 return $data->{'email'};
1423 } elsif ($data->{'emailpro'}) {
1424 return $data->{'emailpro'};
1425 } elsif ($data->{'B_email'}) {
1426 return $data->{'B_email'};
1432 =head2 GetNoticeEmailAddress
1434 $email = GetNoticeEmailAddress($borrowernumber);
1436 Return the email address of borrower used for notices, given the borrowernumber.
1437 Returns the empty string if no email address.
1441 sub GetNoticeEmailAddress {
1442 my $borrowernumber = shift;
1444 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1445 # if syspref is set to 'first valid' (value == OFF), look up email address
1446 if ( $which_address eq 'OFF' ) {
1447 return GetFirstValidEmailAddress($borrowernumber);
1449 # specified email address field
1450 my $dbh = C4::Context->dbh;
1451 my $sth = $dbh->prepare( qq{
1452 SELECT $which_address AS primaryemail
1454 WHERE borrowernumber=?
1456 $sth->execute($borrowernumber);
1457 my $data = $sth->fetchrow_hashref;
1458 return $data->{'primaryemail'} || '';
1461 =head2 GetExpiryDate
1463 $expirydate = GetExpiryDate($categorycode, $dateenrolled);
1465 Calculate expiry date given a categorycode and starting date. Date argument must be in ISO format.
1466 Return date is also in ISO format.
1471 my ( $categorycode, $dateenrolled ) = @_;
1473 if ($categorycode) {
1474 my $dbh = C4::Context->dbh;
1475 my $sth = $dbh->prepare("SELECT enrolmentperiod,enrolmentperioddate FROM categories WHERE categorycode=?");
1476 $sth->execute($categorycode);
1477 $enrolments = $sth->fetchrow_hashref;
1479 # die "GetExpiryDate: for enrollmentperiod $enrolmentperiod (category '$categorycode') starting $dateenrolled.\n";
1480 my @date = split (/-/,$dateenrolled);
1481 if($enrolments->{enrolmentperiod}){
1482 return sprintf("%04d-%02d-%02d", Add_Delta_YM(@date,0,$enrolments->{enrolmentperiod}));
1484 return $enrolments->{enrolmentperioddate};
1488 =head2 GetborCatFromCatType
1490 ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
1492 Looks up the different types of borrowers in the database. Returns two
1493 elements: a reference-to-array, which lists the borrower category
1494 codes, and a reference-to-hash, which maps the borrower category codes
1495 to category descriptions.
1500 sub GetborCatFromCatType {
1501 my ( $category_type, $action, $no_branch_limit ) = @_;
1503 my $branch_limit = $no_branch_limit
1505 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1507 # FIXME - This API seems both limited and dangerous.
1508 my $dbh = C4::Context->dbh;
1511 SELECT categories.categorycode, categories.description
1515 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1518 $request .= " $action ";
1519 $request .= " AND (branchcode = ? OR branchcode IS NULL) GROUP BY description" if $branch_limit;
1521 $request .= " WHERE branchcode = ? OR branchcode IS NULL GROUP BY description" if $branch_limit;
1523 $request .= " ORDER BY categorycode";
1525 my $sth = $dbh->prepare($request);
1527 $action ? $category_type : (),
1528 $branch_limit ? $branch_limit : ()
1534 while ( my $data = $sth->fetchrow_hashref ) {
1535 push @codes, $data->{'categorycode'};
1536 $labels{ $data->{'categorycode'} } = $data->{'description'};
1539 return ( \@codes, \%labels );
1542 =head2 GetBorrowercategory
1544 $hashref = &GetBorrowercategory($categorycode);
1546 Given the borrower's category code, the function returns the corresponding
1547 data hashref for a comprehensive information display.
1551 sub GetBorrowercategory {
1553 my $dbh = C4::Context->dbh;
1557 "SELECT description,dateofbirthrequired,upperagelimit,category_type
1559 WHERE categorycode = ?"
1561 $sth->execute($catcode);
1563 $sth->fetchrow_hashref;
1567 } # sub getborrowercategory
1570 =head2 GetBorrowerCategorycode
1572 $categorycode = &GetBorrowerCategoryCode( $borrowernumber );
1574 Given the borrowernumber, the function returns the corresponding categorycode
1578 sub GetBorrowerCategorycode {
1579 my ( $borrowernumber ) = @_;
1580 my $dbh = C4::Context->dbh;
1581 my $sth = $dbh->prepare( qq{
1584 WHERE borrowernumber = ?
1586 $sth->execute( $borrowernumber );
1587 return $sth->fetchrow;
1590 =head2 GetBorrowercategoryList
1592 $arrayref_hashref = &GetBorrowercategoryList;
1593 If no category code provided, the function returns all the categories.
1597 sub GetBorrowercategoryList {
1598 my $no_branch_limit = @_ ? shift : 0;
1599 my $branch_limit = $no_branch_limit
1601 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1602 my $dbh = C4::Context->dbh;
1603 my $query = "SELECT categories.* FROM categories";
1605 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1606 WHERE branchcode = ? OR branchcode IS NULL GROUP BY description
1608 $query .= " ORDER BY description";
1609 my $sth = $dbh->prepare( $query );
1610 $sth->execute( $branch_limit ? $branch_limit : () );
1611 my $data = $sth->fetchall_arrayref( {} );
1614 } # sub getborrowercategory
1616 =head2 ethnicitycategories
1618 ($codes_arrayref, $labels_hashref) = ðnicitycategories();
1620 Looks up the different ethnic types in the database. Returns two
1621 elements: a reference-to-array, which lists the ethnicity codes, and a
1622 reference-to-hash, which maps the ethnicity codes to ethnicity
1629 sub ethnicitycategories {
1630 my $dbh = C4::Context->dbh;
1631 my $sth = $dbh->prepare("Select code,name from ethnicity order by name");
1635 while ( my $data = $sth->fetchrow_hashref ) {
1636 push @codes, $data->{'code'};
1637 $labels{ $data->{'code'} } = $data->{'name'};
1639 return ( \@codes, \%labels );
1644 $ethn_name = &fixEthnicity($ethn_code);
1646 Takes an ethnicity code (e.g., "european" or "pi") and returns the
1647 corresponding descriptive name from the C<ethnicity> table in the
1648 Koha database ("European" or "Pacific Islander").
1655 my $ethnicity = shift;
1656 return unless $ethnicity;
1657 my $dbh = C4::Context->dbh;
1658 my $sth = $dbh->prepare("Select name from ethnicity where code = ?");
1659 $sth->execute($ethnicity);
1660 my $data = $sth->fetchrow_hashref;
1661 return $data->{'name'};
1662 } # sub fixEthnicity
1666 $dateofbirth,$date = &GetAge($date);
1668 this function return the borrowers age with the value of dateofbirth
1674 my ( $date, $date_ref ) = @_;
1676 if ( not defined $date_ref ) {
1677 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1680 my ( $year1, $month1, $day1 ) = split /-/, $date;
1681 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1683 my $age = $year2 - $year1;
1684 if ( $month1 . $day1 > $month2 . $day2 ) {
1693 $borrower = C4::Members::SetAge($borrower, $datetimeduration);
1694 $borrower = C4::Members::SetAge($borrower, '0015-12-10');
1695 $borrower = C4::Members::SetAge($borrower, $datetimeduration, $datetime_reference);
1697 eval { $borrower = C4::Members::SetAge($borrower, '015-1-10'); };
1698 if ($@) {print $@;} #Catch a bad ISO Date or kill your script!
1700 This function sets the borrower's dateofbirth to match the given age.
1701 Optionally relative to the given $datetime_reference.
1703 @PARAM1 koha.borrowers-object
1704 @PARAM2 DateTime::Duration-object as the desired age
1705 OR a ISO 8601 Date. (To make the API more pleasant)
1706 @PARAM3 DateTime-object as the relative date, defaults to now().
1707 RETURNS The given borrower reference @PARAM1.
1708 DIES If there was an error with the ISO Date handling.
1714 my ( $borrower, $datetimeduration, $datetime_ref ) = @_;
1715 $datetime_ref = DateTime->now() unless $datetime_ref;
1717 if ($datetimeduration && ref $datetimeduration ne 'DateTime::Duration') {
1718 if ($datetimeduration =~ /^(\d{4})-(\d{2})-(\d{2})/) {
1719 $datetimeduration = DateTime::Duration->new(years => $1, months => $2, days => $3);
1722 die "C4::Members::SetAge($borrower, $datetimeduration), datetimeduration not a valid ISO 8601 Date!\n";
1726 my $new_datetime_ref = $datetime_ref->clone();
1727 $new_datetime_ref->subtract_duration( $datetimeduration );
1729 $borrower->{dateofbirth} = $new_datetime_ref->ymd();
1736 $cityarrayref = GetCities();
1738 Returns an array_ref of the entries in the cities table
1739 If there are entries in the table an empty row is returned
1740 This is currently only used to populate a popup in memberentry
1746 my $dbh = C4::Context->dbh;
1747 my $city_arr = $dbh->selectall_arrayref(
1748 q|SELECT cityid,city_zipcode,city_name,city_state,city_country FROM cities ORDER BY city_name|,
1750 if ( @{$city_arr} ) {
1751 unshift @{$city_arr}, {
1752 city_zipcode => q{},
1756 city_country => q{},
1763 =head2 GetSortDetails (OUEST-PROVENCE)
1765 ($lib) = &GetSortDetails($category,$sortvalue);
1767 Returns the authorized value details
1768 C<&$lib>return value of authorized value details
1769 C<&$sortvalue>this is the value of authorized value
1770 C<&$category>this is the value of authorized value category
1774 sub GetSortDetails {
1775 my ( $category, $sortvalue ) = @_;
1776 my $dbh = C4::Context->dbh;
1777 my $query = qq|SELECT lib
1778 FROM authorised_values
1780 AND authorised_value=? |;
1781 my $sth = $dbh->prepare($query);
1782 $sth->execute( $category, $sortvalue );
1783 my $lib = $sth->fetchrow;
1784 return ($lib) if ($lib);
1785 return ($sortvalue) unless ($lib);
1788 =head2 MoveMemberToDeleted
1790 $result = &MoveMemberToDeleted($borrowernumber);
1792 Copy the record from borrowers to deletedborrowers table.
1793 The routine returns 1 for success, undef for failure.
1797 sub MoveMemberToDeleted {
1798 my ($member) = shift or return;
1800 my $schema = Koha::Database->new()->schema();
1801 my $borrowers_rs = $schema->resultset('Borrower');
1802 $borrowers_rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
1803 my $borrower = $borrowers_rs->find($member);
1804 return unless $borrower;
1806 my $deleted = $schema->resultset('Deletedborrower')->create($borrower);
1808 return $deleted ? 1 : undef;
1813 DelMember($borrowernumber);
1815 This function remove directly a borrower whitout writing it on deleteborrower.
1816 + Deletes reserves for the borrower
1821 my $dbh = C4::Context->dbh;
1822 my $borrowernumber = shift;
1823 #warn "in delmember with $borrowernumber";
1824 return unless $borrowernumber; # borrowernumber is mandatory.
1826 my $query = qq|DELETE
1828 WHERE borrowernumber=?|;
1829 my $sth = $dbh->prepare($query);
1830 $sth->execute($borrowernumber);
1834 WHERE borrowernumber = ?
1836 $sth = $dbh->prepare($query);
1837 $sth->execute($borrowernumber);
1838 logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
1842 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1844 $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1846 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1851 sub ExtendMemberSubscriptionTo {
1852 my ( $borrowerid,$date) = @_;
1853 my $dbh = C4::Context->dbh;
1854 my $borrower = GetMember('borrowernumber'=>$borrowerid);
1856 $date = (C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry') ?
1857 C4::Dates->new($borrower->{'dateexpiry'}, 'iso')->output("iso") :
1858 C4::Dates->new()->output("iso");
1859 $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
1861 my $sth = $dbh->do(<<EOF);
1863 SET dateexpiry='$date'
1864 WHERE borrowernumber='$borrowerid'
1867 AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
1869 logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
1870 return $date if ($sth);
1874 =head2 GetTitles (OUEST-PROVENCE)
1876 ($borrowertitle)= &GetTitles();
1878 Looks up the different title . Returns array with all borrowers title
1883 my @borrowerTitle = split (/,|\|/,C4::Context->preference('BorrowersTitles'));
1884 unshift( @borrowerTitle, "" );
1885 my $count=@borrowerTitle;
1890 return ( \@borrowerTitle);
1894 =head2 GetPatronImage
1896 my ($imagedata, $dberror) = GetPatronImage($borrowernumber);
1898 Returns the mimetype and binary image data of the image for the patron with the supplied borrowernumber.
1902 sub GetPatronImage {
1903 my ($borrowernumber) = @_;
1904 warn "Borrowernumber passed to GetPatronImage is $borrowernumber" if $debug;
1905 my $dbh = C4::Context->dbh;
1906 my $query = 'SELECT mimetype, imagefile FROM patronimage WHERE borrowernumber = ?';
1907 my $sth = $dbh->prepare($query);
1908 $sth->execute($borrowernumber);
1909 my $imagedata = $sth->fetchrow_hashref;
1910 warn "Database error!" if $sth->errstr;
1911 return $imagedata, $sth->errstr;
1914 =head2 PutPatronImage
1916 PutPatronImage($cardnumber, $mimetype, $imgfile);
1918 Stores patron binary image data and mimetype in database.
1919 NOTE: This function is good for updating images as well as inserting new images in the database.
1923 sub PutPatronImage {
1924 my ($cardnumber, $mimetype, $imgfile) = @_;
1925 warn "Parameters passed in: Cardnumber=$cardnumber, Mimetype=$mimetype, " . ($imgfile ? "Imagefile" : "No Imagefile") if $debug;
1926 my $dbh = C4::Context->dbh;
1927 my $query = "INSERT INTO patronimage (borrowernumber, mimetype, imagefile) VALUES ( ( SELECT borrowernumber from borrowers WHERE cardnumber = ? ),?,?) ON DUPLICATE KEY UPDATE imagefile = ?;";
1928 my $sth = $dbh->prepare($query);
1929 $sth->execute($cardnumber,$mimetype,$imgfile,$imgfile);
1930 warn "Error returned inserting $cardnumber.$mimetype." if $sth->errstr;
1931 return $sth->errstr;
1934 =head2 RmPatronImage
1936 my ($dberror) = RmPatronImage($borrowernumber);
1938 Removes the image for the patron with the supplied borrowernumber.
1943 my ($borrowernumber) = @_;
1944 warn "Borrowernumber passed to GetPatronImage is $borrowernumber" if $debug;
1945 my $dbh = C4::Context->dbh;
1946 my $query = "DELETE FROM patronimage WHERE borrowernumber = ?;";
1947 my $sth = $dbh->prepare($query);
1948 $sth->execute($borrowernumber);
1949 my $dberror = $sth->errstr;
1950 warn "Database error!" if $sth->errstr;
1954 =head2 GetHideLostItemsPreference
1956 $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1958 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1959 C<&$hidelostitemspref>return value of function, 0 or 1
1963 sub GetHideLostItemsPreference {
1964 my ($borrowernumber) = @_;
1965 my $dbh = C4::Context->dbh;
1966 my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1967 my $sth = $dbh->prepare($query);
1968 $sth->execute($borrowernumber);
1969 my $hidelostitems = $sth->fetchrow;
1970 return $hidelostitems;
1973 =head2 GetBorrowersToExpunge
1975 $borrowers = &GetBorrowersToExpunge(
1976 not_borrowered_since => $not_borrowered_since,
1977 expired_before => $expired_before,
1978 category_code => $category_code,
1979 branchcode => $branchcode
1982 This function get all borrowers based on the given criteria.
1986 sub GetBorrowersToExpunge {
1989 my $filterdate = $params->{'not_borrowered_since'};
1990 my $filterexpiry = $params->{'expired_before'};
1991 my $filtercategory = $params->{'category_code'};
1992 my $filterbranch = $params->{'branchcode'} ||
1993 ((C4::Context->preference('IndependentBranches')
1994 && C4::Context->userenv
1995 && !C4::Context->IsSuperLibrarian()
1996 && C4::Context->userenv->{branch})
1997 ? C4::Context->userenv->{branch}
2000 my $dbh = C4::Context->dbh;
2002 SELECT borrowers.borrowernumber,
2003 MAX(old_issues.timestamp) AS latestissue,
2004 MAX(issues.timestamp) AS currentissue
2006 JOIN categories USING (categorycode)
2010 WHERE guarantorid IS NOT NULL
2011 AND guarantorid <> 0
2012 ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
2013 LEFT JOIN old_issues USING (borrowernumber)
2014 LEFT JOIN issues USING (borrowernumber)
2015 WHERE category_type <> 'S'
2016 AND tmp.guarantorid IS NULL
2020 if ( $filterbranch && $filterbranch ne "" ) {
2021 $query.= " AND borrowers.branchcode = ? ";
2022 push( @query_params, $filterbranch );
2024 if ( $filterexpiry ) {
2025 $query .= " AND dateexpiry < ? ";
2026 push( @query_params, $filterexpiry );
2028 if ( $filtercategory ) {
2029 $query .= " AND categorycode = ? ";
2030 push( @query_params, $filtercategory );
2032 $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
2033 if ( $filterdate ) {
2034 $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
2035 push @query_params,$filterdate;
2037 warn $query if $debug;
2039 my $sth = $dbh->prepare($query);
2040 if (scalar(@query_params)>0){
2041 $sth->execute(@query_params);
2048 while ( my $data = $sth->fetchrow_hashref ) {
2049 push @results, $data;
2054 =head2 GetBorrowersWhoHaveNeverBorrowed
2056 $results = &GetBorrowersWhoHaveNeverBorrowed
2058 This function get all borrowers who have never borrowed.
2060 I<$result> is a ref to an array which all elements are a hasref.
2064 sub GetBorrowersWhoHaveNeverBorrowed {
2065 my $filterbranch = shift ||
2066 ((C4::Context->preference('IndependentBranches')
2067 && C4::Context->userenv
2068 && !C4::Context->IsSuperLibrarian()
2069 && C4::Context->userenv->{branch})
2070 ? C4::Context->userenv->{branch}
2072 my $dbh = C4::Context->dbh;
2074 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
2076 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
2077 WHERE issues.borrowernumber IS NULL
2080 if ($filterbranch && $filterbranch ne ""){
2081 $query.=" AND borrowers.branchcode= ?";
2082 push @query_params,$filterbranch;
2084 warn $query if $debug;
2086 my $sth = $dbh->prepare($query);
2087 if (scalar(@query_params)>0){
2088 $sth->execute(@query_params);
2095 while ( my $data = $sth->fetchrow_hashref ) {
2096 push @results, $data;
2101 =head2 GetBorrowersWithIssuesHistoryOlderThan
2103 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
2105 this function get all borrowers who has an issue history older than I<$date> given on input arg.
2107 I<$result> is a ref to an array which all elements are a hashref.
2108 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2112 sub GetBorrowersWithIssuesHistoryOlderThan {
2113 my $dbh = C4::Context->dbh;
2114 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
2115 my $filterbranch = shift ||
2116 ((C4::Context->preference('IndependentBranches')
2117 && C4::Context->userenv
2118 && !C4::Context->IsSuperLibrarian()
2119 && C4::Context->userenv->{branch})
2120 ? C4::Context->userenv->{branch}
2123 SELECT count(borrowernumber) as n,borrowernumber
2125 WHERE returndate < ?
2126 AND borrowernumber IS NOT NULL
2129 push @query_params, $date;
2131 $query.=" AND branchcode = ?";
2132 push @query_params, $filterbranch;
2134 $query.=" GROUP BY borrowernumber ";
2135 warn $query if $debug;
2136 my $sth = $dbh->prepare($query);
2137 $sth->execute(@query_params);
2140 while ( my $data = $sth->fetchrow_hashref ) {
2141 push @results, $data;
2146 =head2 GetBorrowersNamesAndLatestIssue
2148 $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
2150 this function get borrowers Names and surnames and Issue information.
2152 I<@borrowernumbers> is an array which all elements are borrowernumbers.
2153 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2157 sub GetBorrowersNamesAndLatestIssue {
2158 my $dbh = C4::Context->dbh;
2159 my @borrowernumbers=@_;
2161 SELECT surname,lastname, phone, email,max(timestamp)
2163 LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
2164 GROUP BY borrowernumber
2166 my $sth = $dbh->prepare($query);
2168 my $results = $sth->fetchall_arrayref({});
2174 my $success = ModPrivacy( $borrowernumber, $privacy );
2176 Update the privacy of a patron.
2179 true on success, false on failure
2184 my $borrowernumber = shift;
2185 my $privacy = shift;
2186 return unless defined $borrowernumber;
2187 return unless $borrowernumber =~ /^\d+$/;
2189 return ModMember( borrowernumber => $borrowernumber,
2190 privacy => $privacy );
2195 AddMessage( $borrowernumber, $message_type, $message, $branchcode );
2197 Adds a message to the messages table for the given borrower.
2206 my ( $borrowernumber, $message_type, $message, $branchcode ) = @_;
2208 my $dbh = C4::Context->dbh;
2210 if ( ! ( $borrowernumber && $message_type && $message && $branchcode ) ) {
2214 my $query = "INSERT INTO messages ( borrowernumber, branchcode, message_type, message ) VALUES ( ?, ?, ?, ? )";
2215 my $sth = $dbh->prepare($query);
2216 $sth->execute( $borrowernumber, $branchcode, $message_type, $message );
2217 logaction("MEMBERS", "ADDCIRCMESSAGE", $borrowernumber, $message) if C4::Context->preference("BorrowersLog");
2223 GetMessages( $borrowernumber, $type );
2225 $type is message type, B for borrower, or L for Librarian.
2226 Empty type returns all messages of any type.
2228 Returns all messages for the given borrowernumber
2233 my ( $borrowernumber, $type, $branchcode ) = @_;
2239 my $dbh = C4::Context->dbh;
2242 branches.branchname,
2245 messages.branchcode LIKE '$branchcode' AS can_delete
2246 FROM messages, branches
2247 WHERE borrowernumber = ?
2248 AND message_type LIKE ?
2249 AND messages.branchcode = branches.branchcode
2250 ORDER BY message_date DESC";
2251 my $sth = $dbh->prepare($query);
2252 $sth->execute( $borrowernumber, $type ) ;
2255 while ( my $data = $sth->fetchrow_hashref ) {
2256 my $d = C4::Dates->new( $data->{message_date}, 'iso' );
2257 $data->{message_date_formatted} = $d->output;
2258 push @results, $data;
2266 GetMessagesCount( $borrowernumber, $type );
2268 $type is message type, B for borrower, or L for Librarian.
2269 Empty type returns all messages of any type.
2271 Returns the number of messages for the given borrowernumber
2275 sub GetMessagesCount {
2276 my ( $borrowernumber, $type, $branchcode ) = @_;
2282 my $dbh = C4::Context->dbh;
2284 my $query = "SELECT COUNT(*) as MsgCount FROM messages WHERE borrowernumber = ? AND message_type LIKE ?";
2285 my $sth = $dbh->prepare($query);
2286 $sth->execute( $borrowernumber, $type ) ;
2289 my $data = $sth->fetchrow_hashref;
2290 my $count = $data->{'MsgCount'};
2297 =head2 DeleteMessage
2299 DeleteMessage( $message_id );
2304 my ( $message_id ) = @_;
2306 my $dbh = C4::Context->dbh;
2307 my $query = "SELECT * FROM messages WHERE message_id = ?";
2308 my $sth = $dbh->prepare($query);
2309 $sth->execute( $message_id );
2310 my $message = $sth->fetchrow_hashref();
2312 $query = "DELETE FROM messages WHERE message_id = ?";
2313 $sth = $dbh->prepare($query);
2314 $sth->execute( $message_id );
2315 logaction("MEMBERS", "DELCIRCMESSAGE", $message->{'borrowernumber'}, $message->{'message'}) if C4::Context->preference("BorrowersLog");
2320 IssueSlip($branchcode, $borrowernumber, $quickslip)
2322 Returns letter hash ( see C4::Letters::GetPreparedLetter )
2324 $quickslip is boolean, to indicate whether we want a quick slip
2326 IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
2362 NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
2367 my ($branch, $borrowernumber, $quickslip) = @_;
2369 # FIXME Check callers before removing this statement
2370 #return unless $borrowernumber;
2372 my @issues = @{ GetPendingIssues($borrowernumber) };
2374 for my $issue (@issues) {
2375 $issue->{date_due} = $issue->{date_due_sql};
2377 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
2378 if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
2379 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
2385 # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
2387 my $s = $b->{timestamp} <=> $a->{timestamp};
2389 $b->{issuedate} <=> $a->{issuedate} : $s;
2392 my ($letter_code, %repeat);
2394 $letter_code = 'ISSUEQSLIP';
2396 'checkedout' => [ map {
2399 'biblioitems' => $_,
2401 }, grep { $_->{'now'} } @issues ],
2405 $letter_code = 'ISSUESLIP';
2407 'checkedout' => [ map {
2410 'biblioitems' => $_,
2412 }, grep { !$_->{'overdue'} } @issues ],
2414 'overdue' => [ map {
2417 'biblioitems' => $_,
2419 }, grep { $_->{'overdue'} } @issues ],
2422 $_->{'timestamp'} = $_->{'newdate'};
2424 } @{ GetNewsToDisplay("slip",$branch) } ],
2428 return C4::Letters::GetPreparedLetter (
2429 module => 'circulation',
2430 letter_code => $letter_code,
2431 branchcode => $branch,
2433 'branches' => $branch,
2434 'borrowers' => $borrowernumber,
2440 =head2 GetBorrowersWithEmail
2442 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
2444 This gets a list of users and their basic details from their email address.
2445 As it's possible for multiple user to have the same email address, it provides
2446 you with all of them. If there is no userid for the user, there will be an
2447 C<undef> there. An empty list will be returned if there are no matches.
2451 sub GetBorrowersWithEmail {
2454 my $dbh = C4::Context->dbh;
2456 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
2457 my $sth=$dbh->prepare($query);
2458 $sth->execute($email);
2460 while (my $ref = $sth->fetch) {
2463 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
2467 =head2 AddMember_Opac
2471 sub AddMember_Opac {
2472 my ( %borrower ) = @_;
2474 $borrower{'categorycode'} = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2476 my $sr = new String::Random;
2477 $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
2478 my $password = $sr->randpattern("AAAAAAAAAA");
2479 $borrower{'password'} = $password;
2481 $borrower{'cardnumber'} = fixup_cardnumber();
2483 my $borrowernumber = AddMember(%borrower);
2485 return ( $borrowernumber, $password );
2488 =head2 AddEnrolmentFeeIfNeeded
2490 AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
2492 Add enrolment fee for a patron if needed.
2496 sub AddEnrolmentFeeIfNeeded {
2497 my ( $categorycode, $borrowernumber ) = @_;
2498 # check for enrollment fee & add it if needed
2499 my $dbh = C4::Context->dbh;
2500 my $sth = $dbh->prepare(q{
2503 WHERE categorycode=?
2505 $sth->execute( $categorycode );
2507 warn sprintf('Database returned the following error: %s', $sth->errstr);
2510 my ($enrolmentfee) = $sth->fetchrow;
2511 if ($enrolmentfee && $enrolmentfee > 0) {
2512 # insert fee in patron debts
2513 C4::Accounts::manualinvoice( $borrowernumber, '', '', 'A', $enrolmentfee );
2522 my ( $borrowernumber ) = @_;
2524 my $sql = "SELECT COUNT(*) FROM issues WHERE date_due < NOW() AND borrowernumber = ?";
2525 my $sth = C4::Context->dbh->prepare( $sql );
2526 $sth->execute( $borrowernumber );
2527 my ( $count ) = $sth->fetchrow_array();
2532 =head2 DeleteExpiredOpacRegistrations
2534 Delete accounts that haven't been upgraded from the 'temporary' category
2535 Returns the number of removed patrons
2539 sub DeleteExpiredOpacRegistrations {
2541 my $delay = C4::Context->preference('PatronSelfRegistrationExpireTemporaryAccountsDelay');
2542 my $category_code = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2544 return 0 if not $category_code or not defined $delay or $delay eq q||;
2547 SELECT borrowernumber
2549 WHERE categorycode = ? AND DATEDIFF( NOW(), dateenrolled ) > ? |;
2551 my $dbh = C4::Context->dbh;
2552 my $sth = $dbh->prepare($query);
2553 $sth->execute( $category_code, $delay );
2555 while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
2556 DelMember($borrowernumber);
2562 =head2 DeleteUnverifiedOpacRegistrations
2564 Delete all unverified self registrations in borrower_modifications,
2565 older than the specified number of days.
2569 sub DeleteUnverifiedOpacRegistrations {
2571 my $dbh = C4::Context->dbh;
2573 DELETE FROM borrower_modifications
2574 WHERE borrowernumber = 0 AND DATEDIFF( NOW(), timestamp ) > ?|;
2575 my $cnt=$dbh->do($sql, undef, ($days) );
2576 return $cnt eq '0E0'? 0: $cnt;
2579 END { } # module clean-up code here (global destructor)