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
145 C4::Members - Perl Module containing convenience functions for member handling
153 This module contains routines for adding, modifying and deleting members/patrons/borrowers
157 =head2 GetMemberDetails
159 ($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
161 Looks up a patron and returns information about him or her. If
162 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
163 up the borrower by number; otherwise, it looks up the borrower by card
166 C<$borrower> is a reference-to-hash whose keys are the fields of the
167 borrowers table in the Koha database. In addition,
168 C<$borrower-E<gt>{flags}> is a hash giving more detailed information
169 about the patron. Its keys act as flags :
171 if $borrower->{flags}->{LOST} {
172 # Patron's card was reported lost
175 If the state of a flag means that the patron should not be
176 allowed to borrow any more books, then it will have a C<noissues> key
179 See patronflags for more details.
181 C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
182 about the top-level permissions flags set for the borrower. For example,
183 if a user has the "editcatalogue" permission,
184 C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
189 sub GetMemberDetails {
190 my ( $borrowernumber, $cardnumber ) = @_;
191 my $dbh = C4::Context->dbh;
194 if ($borrowernumber) {
195 $sth = $dbh->prepare("
198 categories.description,
199 categories.BlockExpiredPatronOpacActions,
203 LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
204 WHERE borrowernumber = ?
206 $sth->execute($borrowernumber);
208 elsif ($cardnumber) {
209 $sth = $dbh->prepare("
212 categories.description,
213 categories.BlockExpiredPatronOpacActions,
217 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
220 $sth->execute($cardnumber);
225 my $borrower = $sth->fetchrow_hashref;
226 return unless $borrower;
227 my ($amount) = GetMemberAccountRecords($borrower->{borrowernumber});
228 $borrower->{'amountoutstanding'} = $amount;
229 # FIXME - patronflags calls GetMemberAccountRecords... just have patronflags return $amount
230 my $flags = patronflags( $borrower);
233 $sth = $dbh->prepare("select bit,flag from userflags");
235 while ( my ( $bit, $flag ) = $sth->fetchrow ) {
236 if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
237 $accessflagshash->{$flag} = 1;
240 $borrower->{'flags'} = $flags;
241 $borrower->{'authflags'} = $accessflagshash;
243 # For the purposes of making templates easier, we'll define a
244 # 'showname' which is the alternate form the user's first name if
245 # 'other name' is defined.
246 if ($borrower->{category_type} eq 'I') {
247 $borrower->{'showname'} = $borrower->{'othernames'};
248 $borrower->{'showname'} .= " $borrower->{'firstname'}" if $borrower->{'firstname'};
250 $borrower->{'showname'} = $borrower->{'firstname'};
253 # Handle setting the true behavior for BlockExpiredPatronOpacActions
254 $borrower->{'BlockExpiredPatronOpacActions'} =
255 C4::Context->preference('BlockExpiredPatronOpacActions')
256 if ( $borrower->{'BlockExpiredPatronOpacActions'} == -1 );
258 $borrower->{'is_expired'} = 0;
259 $borrower->{'is_expired'} = 1 if
260 defined($borrower->{dateexpiry}) &&
261 $borrower->{'dateexpiry'} ne '0000-00-00' &&
262 Date_to_Days( Today() ) >
263 Date_to_Days( split /-/, $borrower->{'dateexpiry'} );
265 return ($borrower); #, $flags, $accessflagshash);
270 $flags = &patronflags($patron);
272 This function is not exported.
274 The following will be set where applicable:
275 $flags->{CHARGES}->{amount} Amount of debt
276 $flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge)
277 $flags->{CHARGES}->{message} Message -- deprecated
279 $flags->{CREDITS}->{amount} Amount of credit
280 $flags->{CREDITS}->{message} Message -- deprecated
282 $flags->{ GNA } Patron has no valid address
283 $flags->{ GNA }->{noissues} Set for each GNA
284 $flags->{ GNA }->{message} "Borrower has no valid address" -- deprecated
286 $flags->{ LOST } Patron's card reported lost
287 $flags->{ LOST }->{noissues} Set for each LOST
288 $flags->{ LOST }->{message} Message -- deprecated
290 $flags->{DBARRED} Set if patron debarred, no access
291 $flags->{DBARRED}->{noissues} Set for each DBARRED
292 $flags->{DBARRED}->{message} Message -- deprecated
295 $flags->{ NOTES }->{message} The note itself. NOT deprecated
297 $flags->{ ODUES } Set if patron has overdue books.
298 $flags->{ ODUES }->{message} "Yes" -- deprecated
299 $flags->{ ODUES }->{itemlist} ref-to-array: list of overdue books
300 $flags->{ ODUES }->{itemlisttext} Text list of overdue items -- deprecated
302 $flags->{WAITING} Set if any of patron's reserves are available
303 $flags->{WAITING}->{message} Message -- deprecated
304 $flags->{WAITING}->{itemlist} ref-to-array: list of available items
308 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
309 overdue items. Its elements are references-to-hash, each describing an
310 overdue item. The keys are selected fields from the issues, biblio,
311 biblioitems, and items tables of the Koha database.
313 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
314 the overdue items, one per line. Deprecated.
316 =item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
317 available items. Each element is a reference-to-hash whose keys are
318 fields from the reserves table of the Koha database.
322 All the "message" fields that include language generated in this function are deprecated,
323 because such strings belong properly in the display layer.
325 The "message" field that comes from the DB is OK.
329 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
330 # FIXME rename this function.
333 my ( $patroninformation) = @_;
334 my $dbh=C4::Context->dbh;
335 my ($balance, $owing) = GetMemberAccountBalance( $patroninformation->{'borrowernumber'});
338 my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
339 $flaginfo{'message'} = sprintf 'Patron owes %.02f', $owing;
340 $flaginfo{'amount'} = sprintf "%.02f", $owing;
341 if ( $owing > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
342 $flaginfo{'noissues'} = 1;
344 $flags{'CHARGES'} = \%flaginfo;
346 elsif ( $balance < 0 ) {
348 $flaginfo{'message'} = sprintf 'Patron has credit of %.02f', -$balance;
349 $flaginfo{'amount'} = sprintf "%.02f", $balance;
350 $flags{'CREDITS'} = \%flaginfo;
352 if ( $patroninformation->{'gonenoaddress'}
353 && $patroninformation->{'gonenoaddress'} == 1 )
356 $flaginfo{'message'} = 'Borrower has no valid address.';
357 $flaginfo{'noissues'} = 1;
358 $flags{'GNA'} = \%flaginfo;
360 if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
362 $flaginfo{'message'} = 'Borrower\'s card reported lost.';
363 $flaginfo{'noissues'} = 1;
364 $flags{'LOST'} = \%flaginfo;
366 if ( $patroninformation->{'debarred'} && check_date( split( /-/, $patroninformation->{'debarred'} ) ) ) {
367 if ( Date_to_Days(Date::Calc::Today) < Date_to_Days( split( /-/, $patroninformation->{'debarred'} ) ) ) {
369 $flaginfo{'debarredcomment'} = $patroninformation->{'debarredcomment'};
370 $flaginfo{'message'} = $patroninformation->{'debarredcomment'};
371 $flaginfo{'noissues'} = 1;
372 $flaginfo{'dateend'} = $patroninformation->{'debarred'};
373 $flags{'DBARRED'} = \%flaginfo;
376 if ( $patroninformation->{'borrowernotes'}
377 && $patroninformation->{'borrowernotes'} )
380 $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
381 $flags{'NOTES'} = \%flaginfo;
383 my ( $odues, $itemsoverdue ) = C4::Overdues::checkoverdues($patroninformation->{'borrowernumber'});
384 if ( $odues && $odues > 0 ) {
386 $flaginfo{'message'} = "Yes";
387 $flaginfo{'itemlist'} = $itemsoverdue;
388 foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
391 $flaginfo{'itemlisttext'} .=
392 "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n"; # newline is display layer
394 $flags{'ODUES'} = \%flaginfo;
396 my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
397 my $nowaiting = scalar @itemswaiting;
398 if ( $nowaiting > 0 ) {
400 $flaginfo{'message'} = "Reserved items available";
401 $flaginfo{'itemlist'} = \@itemswaiting;
402 $flags{'WAITING'} = \%flaginfo;
410 $borrower = &GetMember(%information);
412 Retrieve the first patron record meeting on criteria listed in the
413 C<%information> hash, which should contain one or more
414 pairs of borrowers column names and values, e.g.,
416 $borrower = GetMember(borrowernumber => id);
418 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
419 the C<borrowers> table in the Koha database.
421 FIXME: GetMember() is used throughout the code as a lookup
422 on a unique key such as the borrowernumber, but this meaning is not
423 enforced in the routine itself.
429 my ( %information ) = @_;
430 if (exists $information{borrowernumber} && !defined $information{borrowernumber}) {
431 #passing mysql's kohaadmin?? Makes no sense as a query
434 my $dbh = C4::Context->dbh;
436 q{SELECT borrowers.*, categories.category_type, categories.description
438 LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
441 for (keys %information ) {
449 if (defined $information{$_}) {
451 push @values, $information{$_};
454 $select .= "$_ IS NULL";
457 $debug && warn $select, " ",values %information;
458 my $sth = $dbh->prepare("$select");
459 $sth->execute(map{$information{$_}} keys %information);
460 my $data = $sth->fetchall_arrayref({});
461 #FIXME interface to this routine now allows generation of a result set
462 #so whole array should be returned but bowhere in the current code expects this
470 =head2 GetMemberRelatives
472 @borrowernumbers = GetMemberRelatives($borrowernumber);
474 C<GetMemberRelatives> returns a borrowersnumber's list of guarantor/guarantees of the member given in parameter
478 sub GetMemberRelatives {
479 my $borrowernumber = shift;
480 my $dbh = C4::Context->dbh;
484 my $query = "SELECT guarantorid FROM borrowers WHERE borrowernumber=?";
485 my $sth = $dbh->prepare($query);
486 $sth->execute($borrowernumber);
487 my $data = $sth->fetchrow_arrayref();
488 push @glist, $data->[0] if $data->[0];
489 my $guarantor = $data->[0] ? $data->[0] : undef;
492 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
493 $sth = $dbh->prepare($query);
494 $sth->execute($borrowernumber);
495 while ($data = $sth->fetchrow_arrayref()) {
496 push @glist, $data->[0];
499 # Getting sibling guarantees
501 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
502 $sth = $dbh->prepare($query);
503 $sth->execute($guarantor);
504 while ($data = $sth->fetchrow_arrayref()) {
505 push @glist, $data->[0] if ($data->[0] != $borrowernumber);
512 =head2 IsMemberBlocked
514 my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
516 Returns whether a patron is restricted or has overdue items that may result
517 in a block of circulation privileges.
519 C<$block_status> can have the following values:
521 1 if the patron is currently restricted, in which case
522 C<$count> is the expiration date (9999-12-31 for indefinite)
524 -1 if the patron has overdue items, in which case C<$count> is the number of them
526 0 if the patron has no overdue items or outstanding fine days, in which case C<$count> is 0
528 Existing active restrictions are checked before current overdue items.
532 sub IsMemberBlocked {
533 my $borrowernumber = shift;
534 my $dbh = C4::Context->dbh;
536 my $blockeddate = Koha::Borrower::Debarments::IsDebarred($borrowernumber);
538 return ( 1, $blockeddate ) if $blockeddate;
540 # if he have late issues
541 my $sth = $dbh->prepare(
542 "SELECT COUNT(*) as latedocs
544 WHERE borrowernumber = ?
545 AND date_due < now()"
547 $sth->execute($borrowernumber);
548 my $latedocs = $sth->fetchrow_hashref->{'latedocs'};
550 return ( -1, $latedocs ) if $latedocs > 0;
555 =head2 GetMemberIssuesAndFines
557 ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
559 Returns aggregate data about items borrowed by the patron with the
560 given borrowernumber.
562 C<&GetMemberIssuesAndFines> returns a three-element array. C<$overdue_count> is the
563 number of overdue items the patron currently has borrowed. C<$issue_count> is the
564 number of books the patron currently has borrowed. C<$total_fines> is
565 the total fine currently due by the borrower.
570 sub GetMemberIssuesAndFines {
571 my ( $borrowernumber ) = @_;
572 my $dbh = C4::Context->dbh;
573 my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
575 $debug and warn $query."\n";
576 my $sth = $dbh->prepare($query);
577 $sth->execute($borrowernumber);
578 my $issue_count = $sth->fetchrow_arrayref->[0];
580 $sth = $dbh->prepare(
581 "SELECT COUNT(*) FROM issues
582 WHERE borrowernumber = ?
583 AND date_due < now()"
585 $sth->execute($borrowernumber);
586 my $overdue_count = $sth->fetchrow_arrayref->[0];
588 $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
589 $sth->execute($borrowernumber);
590 my $total_fines = $sth->fetchrow_arrayref->[0];
592 return ($overdue_count, $issue_count, $total_fines);
598 my @columns = C4::Member::columns();
600 Returns an array of borrowers' table columns on success,
601 and an empty array on failure.
607 # Pure ANSI SQL goodness.
608 my $sql = 'SELECT * FROM borrowers WHERE 1=0;';
610 # Get the database handle.
611 my $dbh = C4::Context->dbh;
613 # Run the SQL statement to load STH's readonly properties.
614 my $sth = $dbh->prepare($sql);
615 my $rv = $sth->execute();
617 # This only fails if the table doesn't exist.
618 # This will always be called AFTER an install or upgrade,
619 # so borrowers will exist!
621 if ($sth->{NUM_OF_FIELDS}>0) {
622 @data = @{$sth->{NAME}};
633 my $success = ModMember(borrowernumber => $borrowernumber,
634 [ field => value ]... );
636 Modify borrower's data. All date fields should ALREADY be in ISO format.
639 true on success, or false on failure
645 # test to know if you must update or not the borrower password
646 if (exists $data{password}) {
647 if ($data{password} eq '****' or $data{password} eq '') {
648 delete $data{password};
650 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
651 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
652 NLUpdateHashedPIN( $data{'borrowernumber'}, $data{password} );
654 $data{password} = hash_password($data{password});
657 my $old_categorycode = GetBorrowerCategorycode( $data{borrowernumber} );
659 # get only the columns of a borrower
660 my $schema = Koha::Database->new()->schema;
661 my @columns = $schema->source('Borrower')->columns;
662 my $new_borrower = { map { join(' ', @columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) };
663 delete $new_borrower->{flags};
665 $new_borrower->{dateofbirth} ||= undef if exists $new_borrower->{dateofbirth};
666 $new_borrower->{dateenrolled} ||= undef if exists $new_borrower->{dateenrolled};
667 $new_borrower->{dateexpiry} ||= undef if exists $new_borrower->{dateexpiry};
668 $new_borrower->{debarred} ||= undef if exists $new_borrower->{debarred};
669 my $rs = $schema->resultset('Borrower')->search({
670 borrowernumber => $new_borrower->{borrowernumber},
672 my $execute_success = $rs->update($new_borrower);
673 if ($execute_success ne '0E0') { # only proceed if the update was a success
674 # ok if its an adult (type) it may have borrowers that depend on it as a guarantor
675 # so when we update information for an adult we should check for guarantees and update the relevant part
676 # of their records, ie addresses and phone numbers
677 my $borrowercategory= GetBorrowercategory( $data{'category_type'} );
678 if ( exists $borrowercategory->{'category_type'} && $borrowercategory->{'category_type'} eq ('A' || 'S') ) {
679 # is adult check guarantees;
680 UpdateGuarantees(%data);
683 # If the patron changes to a category with enrollment fee, we add a fee
684 if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
685 if ( C4::Context->preference('FeeOnChangePatronCategory') ) {
686 AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
690 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
691 # cronjob will use for syncing with NL
692 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
693 my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
694 'synctype' => 'norwegianpatrondb',
695 'borrowernumber' => $data{'borrowernumber'}
697 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
698 # we can sync as changed. And the "new sync" will pick up all changes since
699 # the patron was created anyway.
700 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
701 $borrowersync->update( { 'syncstatus' => 'edited' } );
703 # Set the value of 'sync'
704 $borrowersync->update( { 'sync' => $data{'sync'} } );
705 # Try to do the live sync
706 NLSync({ 'borrowernumber' => $data{'borrowernumber'} });
709 logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
711 return $execute_success;
716 $borrowernumber = &AddMember(%borrower);
718 insert new borrower into table
720 (%borrower keys are database columns. Database columns could be
721 different in different versions. Please look into database for correct
724 Returns the borrowernumber upon success
726 Returns as undef upon any db error without further processing
733 my $dbh = C4::Context->dbh;
734 my $schema = Koha::Database->new()->schema;
736 # generate a proper login if none provided
737 $data{'userid'} = Generate_Userid( $data{'borrowernumber'}, $data{'firstname'}, $data{'surname'} )
738 if ( $data{'userid'} eq '' || !Check_Userid( $data{'userid'} ) );
740 # add expiration date if it isn't already there
741 unless ( $data{'dateexpiry'} ) {
742 $data{'dateexpiry'} = GetExpiryDate( $data{'categorycode'}, C4::Dates->new()->output("iso") );
745 # add enrollment date if it isn't already there
746 unless ( $data{'dateenrolled'} ) {
747 $data{'dateenrolled'} = C4::Dates->new()->output("iso");
750 my $patron_category = $schema->resultset('Category')->find( $data{'categorycode'} );
752 $patron_category->default_privacy() eq 'default' ? 1
753 : $patron_category->default_privacy() eq 'never' ? 2
754 : $patron_category->default_privacy() eq 'forever' ? 0
756 # Make a copy of the plain text password for later use
757 my $plain_text_password = $data{'password'};
759 # create a disabled account if no password provided
760 $data{'password'} = ($data{'password'})? hash_password($data{'password'}) : '!';
762 # we don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00
763 $data{'dateofbirth'} = undef if( not $data{'dateofbirth'} );
764 $data{'debarred'} = undef if ( not $data{'debarred'} );
766 # get only the columns of Borrower
767 my @columns = $schema->source('Borrower')->columns;
768 my $new_member = { map { join(' ',@columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) } ;
769 delete $new_member->{borrowernumber};
771 my $rs = $schema->resultset('Borrower');
772 $data{borrowernumber} = $rs->create($new_member)->id;
774 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
775 # cronjob will use for syncing with NL
776 if ( exists $data{'borrowernumber'} && C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
777 Koha::Database->new->schema->resultset('BorrowerSync')->create({
778 'borrowernumber' => $data{'borrowernumber'},
779 'synctype' => 'norwegianpatrondb',
781 'syncstatus' => 'new',
782 'hashed_pin' => NLEncryptPIN( $plain_text_password ),
786 # mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
787 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
789 AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
791 return $data{borrowernumber};
796 my $uniqueness = Check_Userid($userid,$borrowernumber);
798 $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 != '').
800 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.
803 0 for not unique (i.e. this $userid already exists)
804 1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
809 my ( $uid, $borrowernumber ) = @_;
811 return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
813 return 0 if ( $uid eq C4::Context->config('user') );
815 my $rs = Koha::Database->new()->schema()->resultset('Borrower');
818 $params->{userid} = $uid;
819 $params->{borrowernumber} = { '!=' => $borrowernumber } if ($borrowernumber);
821 my $count = $rs->count( $params );
823 return $count ? 0 : 1;
826 =head2 Generate_Userid
828 my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
830 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
832 $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.
835 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).
839 sub Generate_Userid {
840 my ($borrowernumber, $firstname, $surname) = @_;
843 #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
845 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
846 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
847 $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
848 $newuid = unac_string('utf-8',$newuid);
849 $newuid .= $offset unless $offset == 0;
852 } while (!Check_Userid($newuid,$borrowernumber));
858 my ( $uid, $member, $digest ) = @_;
859 my $dbh = C4::Context->dbh;
861 #Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
862 #Then we need to tell the user and have them create a new one.
866 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
867 $sth->execute( $uid, $member );
868 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
872 #Everything is good so we can update the information.
875 "update borrowers set userid=?, password=? where borrowernumber=?");
876 $sth->execute( $uid, $digest, $member );
880 logaction("MEMBERS", "CHANGE PASS", $member, "") if C4::Context->preference("BorrowersLog");
886 =head2 fixup_cardnumber
888 Warning: The caller is responsible for locking the members table in write
889 mode, to avoid database corruption.
893 use vars qw( @weightings );
894 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
896 sub fixup_cardnumber {
897 my ($cardnumber) = @_;
898 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
900 # Find out whether member numbers should be generated
901 # automatically. Should be either "1" or something else.
902 # Defaults to "0", which is interpreted as "no".
904 # if ($cardnumber !~ /\S/ && $autonumber_members) {
905 ($autonumber_members) or return $cardnumber;
906 my $checkdigit = C4::Context->preference('checkdigit');
907 my $dbh = C4::Context->dbh;
908 if ( $checkdigit and $checkdigit eq 'katipo' ) {
910 # if checkdigit is selected, calculate katipo-style cardnumber.
911 # otherwise, just use the max()
912 # purpose: generate checksum'd member numbers.
913 # We'll assume we just got the max value of digits 2-8 of member #'s
914 # from the database and our job is to increment that by one,
915 # determine the 1st and 9th digits and return the full string.
916 my $sth = $dbh->prepare(
917 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
920 my $data = $sth->fetchrow_hashref;
921 $cardnumber = $data->{new_num};
922 if ( !$cardnumber ) { # If DB has no values,
923 $cardnumber = 1000000; # start at 1000000
929 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
930 # read weightings, left to right, 1 char at a time
931 my $temp1 = $weightings[$i];
933 # sequence left to right, 1 char at a time
934 my $temp2 = substr( $cardnumber, $i, 1 );
936 # mult each char 1-7 by its corresponding weighting
937 $sum += $temp1 * $temp2;
940 my $rem = ( $sum % 11 );
941 $rem = 'X' if $rem == 10;
943 return "V$cardnumber$rem";
946 my $sth = $dbh->prepare(
947 'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
950 my ($result) = $sth->fetchrow;
953 return $cardnumber; # just here as a fallback/reminder
958 ($num_children, $children_arrayref) = &GetGuarantees($parent_borrno);
959 $child0_cardno = $children_arrayref->[0]{"cardnumber"};
960 $child0_borrno = $children_arrayref->[0]{"borrowernumber"};
962 C<&GetGuarantees> takes a borrower number (e.g., that of a patron
963 with children) and looks up the borrowers who are guaranteed by that
964 borrower (i.e., the patron's children).
966 C<&GetGuarantees> returns two values: an integer giving the number of
967 borrowers guaranteed by C<$parent_borrno>, and a reference to an array
968 of references to hash, which gives the actual results.
974 my ($borrowernumber) = @_;
975 my $dbh = C4::Context->dbh;
978 "select cardnumber,borrowernumber, firstname, surname from borrowers where guarantorid=?"
980 $sth->execute($borrowernumber);
983 my $data = $sth->fetchall_arrayref({});
984 return ( scalar(@$data), $data );
987 =head2 UpdateGuarantees
989 &UpdateGuarantees($parent_borrno);
992 C<&UpdateGuarantees> borrower data for an adult and updates all the guarantees
993 with the modified information
998 sub UpdateGuarantees {
1000 my $dbh = C4::Context->dbh;
1001 my ( $count, $guarantees ) = GetGuarantees( $data{'borrowernumber'} );
1002 foreach my $guarantee (@$guarantees){
1003 my $guaquery = qq|UPDATE borrowers
1004 SET address=?,fax=?,B_city=?,mobile=?,city=?,phone=?
1005 WHERE borrowernumber=?
1007 my $sth = $dbh->prepare($guaquery);
1008 $sth->execute($data{'address'},$data{'fax'},$data{'B_city'},$data{'mobile'},$data{'city'},$data{'phone'},$guarantee->{'borrowernumber'});
1011 =head2 GetPendingIssues
1013 my $issues = &GetPendingIssues(@borrowernumber);
1015 Looks up what the patron with the given borrowernumber has borrowed.
1017 C<&GetPendingIssues> returns a
1018 reference-to-array where each element is a reference-to-hash; the
1019 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
1020 The keys include C<biblioitems> fields except marc and marcxml.
1025 sub GetPendingIssues {
1026 my @borrowernumbers = @_;
1028 unless (@borrowernumbers ) { # return a ref_to_array
1029 return \@borrowernumbers; # to not cause surprise to caller
1032 # Borrowers part of the query
1034 for (my $i = 0; $i < @borrowernumbers; $i++) {
1035 $bquery .= ' issues.borrowernumber = ?';
1036 if ($i < $#borrowernumbers ) {
1041 # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
1042 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
1043 # FIXME: circ/ciculation.pl tries to sort by timestamp!
1044 # FIXME: namespace collision: other collisions possible.
1045 # FIXME: most of this data isn't really being used by callers.
1052 biblioitems.itemtype,
1055 biblioitems.publicationyear,
1056 biblioitems.publishercode,
1057 biblioitems.volumedate,
1058 biblioitems.volumedesc,
1061 borrowers.firstname,
1063 borrowers.cardnumber,
1064 issues.timestamp AS timestamp,
1065 issues.renewals AS renewals,
1066 issues.borrowernumber AS borrowernumber,
1067 items.renewals AS totalrenewals
1069 LEFT JOIN items ON items.itemnumber = issues.itemnumber
1070 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1071 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
1072 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
1075 ORDER BY issues.issuedate"
1078 my $sth = C4::Context->dbh->prepare($query);
1079 $sth->execute(@borrowernumbers);
1080 my $data = $sth->fetchall_arrayref({});
1081 my $today = dt_from_string;
1082 foreach (@{$data}) {
1083 if ($_->{issuedate}) {
1084 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
1086 $_->{date_due_sql} = $_->{date_due};
1087 # FIXME no need to have this value
1088 $_->{date_due} or next;
1089 $_->{date_due_sql} = $_->{date_due};
1090 # FIXME no need to have this value
1091 $_->{date_due} = dt_from_string($_->{date_due}, 'sql');
1092 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
1101 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
1103 Looks up what the patron with the given borrowernumber has borrowed,
1104 and sorts the results.
1106 C<$sortkey> is the name of a field on which to sort the results. This
1107 should be the name of a field in the C<issues>, C<biblio>,
1108 C<biblioitems>, or C<items> table in the Koha database.
1110 C<$limit> is the maximum number of results to return.
1112 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
1113 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
1114 C<items> tables of the Koha database.
1120 my ( $borrowernumber, $order, $limit ) = @_;
1122 return unless $borrowernumber;
1123 $order = 'date_due desc' unless $order;
1125 my $dbh = C4::Context->dbh;
1127 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1129 LEFT JOIN items on items.itemnumber=issues.itemnumber
1130 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1131 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1132 WHERE borrowernumber=?
1134 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1136 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
1137 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1138 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1139 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
1140 order by ' . $order;
1142 $query .= " limit $limit";
1145 my $sth = $dbh->prepare($query);
1146 $sth->execute( $borrowernumber, $borrowernumber );
1147 return $sth->fetchall_arrayref( {} );
1151 =head2 GetMemberAccountRecords
1153 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
1155 Looks up accounting data for the patron with the given borrowernumber.
1157 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
1158 reference-to-array, where each element is a reference-to-hash; the
1159 keys are the fields of the C<accountlines> table in the Koha database.
1160 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1161 total amount outstanding for all of the account lines.
1165 sub GetMemberAccountRecords {
1166 my ($borrowernumber) = @_;
1167 my $dbh = C4::Context->dbh;
1173 WHERE borrowernumber=?);
1174 $strsth.=" ORDER BY date desc,timestamp DESC";
1175 my $sth= $dbh->prepare( $strsth );
1176 $sth->execute( $borrowernumber );
1179 while ( my $data = $sth->fetchrow_hashref ) {
1180 if ( $data->{itemnumber} ) {
1181 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1182 $data->{biblionumber} = $biblio->{biblionumber};
1183 $data->{title} = $biblio->{title};
1185 $acctlines[$numlines] = $data;
1187 $total += int(1000 * $data->{'amountoutstanding'}); # convert float to integer to avoid round-off errors
1190 return ( $total, \@acctlines,$numlines);
1193 =head2 GetMemberAccountBalance
1195 ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
1197 Calculates amount immediately owing by the patron - non-issue charges.
1198 Based on GetMemberAccountRecords.
1199 Charges exempt from non-issue are:
1201 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
1202 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
1206 sub GetMemberAccountBalance {
1207 my ($borrowernumber) = @_;
1209 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
1212 push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
1213 push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
1214 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
1215 my $dbh = C4::Context->dbh;
1216 my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
1217 push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
1219 my %not_fine = map {$_ => 1} @not_fines;
1221 my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
1222 my $other_charges = 0;
1223 foreach (@$acctlines) {
1224 $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
1227 return ( $total, $total - $other_charges, $other_charges);
1230 =head2 GetBorNotifyAcctRecord
1232 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1234 Looks up accounting data for the patron with the given borrowernumber per file number.
1236 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1237 reference-to-array, where each element is a reference-to-hash; the
1238 keys are the fields of the C<accountlines> table in the Koha database.
1239 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1240 total amount outstanding for all of the account lines.
1244 sub GetBorNotifyAcctRecord {
1245 my ( $borrowernumber, $notifyid ) = @_;
1246 my $dbh = C4::Context->dbh;
1249 my $sth = $dbh->prepare(
1252 WHERE borrowernumber=?
1254 AND amountoutstanding != '0'
1255 ORDER BY notify_id,accounttype
1258 $sth->execute( $borrowernumber, $notifyid );
1260 while ( my $data = $sth->fetchrow_hashref ) {
1261 if ( $data->{itemnumber} ) {
1262 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1263 $data->{biblionumber} = $biblio->{biblionumber};
1264 $data->{title} = $biblio->{title};
1266 $acctlines[$numlines] = $data;
1268 $total += int(100 * $data->{'amountoutstanding'});
1271 return ( $total, \@acctlines, $numlines );
1274 =head2 checkuniquemember (OUEST-PROVENCE)
1276 ($result,$categorycode) = &checkuniquemember($collectivity,$surname,$firstname,$dateofbirth);
1278 Checks that a member exists or not in the database.
1280 C<&result> is nonzero (=exist) or 0 (=does not exist)
1281 C<&categorycode> is from categorycode table
1282 C<&collectivity> is 1 (= we add a collectivity) or 0 (= we add a physical member)
1283 C<&surname> is the surname
1284 C<&firstname> is the firstname (only if collectivity=0)
1285 C<&dateofbirth> is the date of birth in ISO format (only if collectivity=0)
1289 # FIXME: This function is not legitimate. Multiple patrons might have the same first/last name and birthdate.
1290 # This is especially true since first name is not even a required field.
1292 sub checkuniquemember {
1293 my ( $collectivity, $surname, $firstname, $dateofbirth ) = @_;
1294 my $dbh = C4::Context->dbh;
1295 my $request = ($collectivity) ?
1296 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? " :
1298 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=? and dateofbirth=?" :
1299 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?";
1300 my $sth = $dbh->prepare($request);
1301 if ($collectivity) {
1302 $sth->execute( uc($surname) );
1303 } elsif($dateofbirth){
1304 $sth->execute( uc($surname), ucfirst($firstname), $dateofbirth );
1306 $sth->execute( uc($surname), ucfirst($firstname));
1308 my @data = $sth->fetchrow;
1309 ( $data[0] ) and return $data[0], $data[1];
1313 sub checkcardnumber {
1314 my ( $cardnumber, $borrowernumber ) = @_;
1316 # If cardnumber is null, we assume they're allowed.
1317 return 0 unless defined $cardnumber;
1319 my $dbh = C4::Context->dbh;
1320 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1321 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1322 my $sth = $dbh->prepare($query);
1325 ( $borrowernumber ? $borrowernumber : () )
1328 return 1 if $sth->fetchrow_hashref;
1330 my ( $min_length, $max_length ) = get_cardnumber_length();
1332 if length $cardnumber > $max_length
1333 or length $cardnumber < $min_length;
1338 =head2 get_cardnumber_length
1340 my ($min, $max) = C4::Members::get_cardnumber_length()
1342 Returns the minimum and maximum length for patron cardnumbers as
1343 determined by the CardnumberLength system preference, the
1344 BorrowerMandatoryField system preference, and the width of the
1349 sub get_cardnumber_length {
1350 my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
1351 $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
1352 if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
1353 # Is integer and length match
1354 if ( $cardnumber_length =~ m|^\d+$| ) {
1355 $min = $max = $cardnumber_length
1356 if $cardnumber_length >= $min
1357 and $cardnumber_length <= $max;
1359 # Else assuming it is a range
1360 elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
1361 $min = $1 if $1 and $min < $1;
1362 $max = $2 if $2 and $max > $2;
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 GetborCatFromCatType
1489 ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
1491 Looks up the different types of borrowers in the database. Returns two
1492 elements: a reference-to-array, which lists the borrower category
1493 codes, and a reference-to-hash, which maps the borrower category codes
1494 to category descriptions.
1499 sub GetborCatFromCatType {
1500 my ( $category_type, $action, $no_branch_limit ) = @_;
1502 my $branch_limit = $no_branch_limit
1504 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1506 # FIXME - This API seems both limited and dangerous.
1507 my $dbh = C4::Context->dbh;
1510 SELECT categories.categorycode, categories.description
1514 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1517 $request .= " $action ";
1518 $request .= " AND (branchcode = ? OR branchcode IS NULL) GROUP BY description" if $branch_limit;
1520 $request .= " WHERE branchcode = ? OR branchcode IS NULL GROUP BY description" if $branch_limit;
1522 $request .= " ORDER BY categorycode";
1524 my $sth = $dbh->prepare($request);
1526 $action ? $category_type : (),
1527 $branch_limit ? $branch_limit : ()
1533 while ( my $data = $sth->fetchrow_hashref ) {
1534 push @codes, $data->{'categorycode'};
1535 $labels{ $data->{'categorycode'} } = $data->{'description'};
1538 return ( \@codes, \%labels );
1541 =head2 GetBorrowercategory
1543 $hashref = &GetBorrowercategory($categorycode);
1545 Given the borrower's category code, the function returns the corresponding
1546 data hashref for a comprehensive information display.
1550 sub GetBorrowercategory {
1552 my $dbh = C4::Context->dbh;
1556 "SELECT description,dateofbirthrequired,upperagelimit,category_type
1558 WHERE categorycode = ?"
1560 $sth->execute($catcode);
1562 $sth->fetchrow_hashref;
1566 } # sub getborrowercategory
1569 =head2 GetBorrowerCategorycode
1571 $categorycode = &GetBorrowerCategoryCode( $borrowernumber );
1573 Given the borrowernumber, the function returns the corresponding categorycode
1577 sub GetBorrowerCategorycode {
1578 my ( $borrowernumber ) = @_;
1579 my $dbh = C4::Context->dbh;
1580 my $sth = $dbh->prepare( qq{
1583 WHERE borrowernumber = ?
1585 $sth->execute( $borrowernumber );
1586 return $sth->fetchrow;
1589 =head2 GetBorrowercategoryList
1591 $arrayref_hashref = &GetBorrowercategoryList;
1592 If no category code provided, the function returns all the categories.
1596 sub GetBorrowercategoryList {
1597 my $no_branch_limit = @_ ? shift : 0;
1598 my $branch_limit = $no_branch_limit
1600 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1601 my $dbh = C4::Context->dbh;
1602 my $query = "SELECT categories.* FROM categories";
1604 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1605 WHERE branchcode = ? OR branchcode IS NULL GROUP BY description
1607 $query .= " ORDER BY description";
1608 my $sth = $dbh->prepare( $query );
1609 $sth->execute( $branch_limit ? $branch_limit : () );
1610 my $data = $sth->fetchall_arrayref( {} );
1613 } # sub getborrowercategory
1617 $dateofbirth,$date = &GetAge($date);
1619 this function return the borrowers age with the value of dateofbirth
1625 my ( $date, $date_ref ) = @_;
1627 if ( not defined $date_ref ) {
1628 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1631 my ( $year1, $month1, $day1 ) = split /-/, $date;
1632 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1634 my $age = $year2 - $year1;
1635 if ( $month1 . $day1 > $month2 . $day2 ) {
1644 $borrower = C4::Members::SetAge($borrower, $datetimeduration);
1645 $borrower = C4::Members::SetAge($borrower, '0015-12-10');
1646 $borrower = C4::Members::SetAge($borrower, $datetimeduration, $datetime_reference);
1648 eval { $borrower = C4::Members::SetAge($borrower, '015-1-10'); };
1649 if ($@) {print $@;} #Catch a bad ISO Date or kill your script!
1651 This function sets the borrower's dateofbirth to match the given age.
1652 Optionally relative to the given $datetime_reference.
1654 @PARAM1 koha.borrowers-object
1655 @PARAM2 DateTime::Duration-object as the desired age
1656 OR a ISO 8601 Date. (To make the API more pleasant)
1657 @PARAM3 DateTime-object as the relative date, defaults to now().
1658 RETURNS The given borrower reference @PARAM1.
1659 DIES If there was an error with the ISO Date handling.
1665 my ( $borrower, $datetimeduration, $datetime_ref ) = @_;
1666 $datetime_ref = DateTime->now() unless $datetime_ref;
1668 if ($datetimeduration && ref $datetimeduration ne 'DateTime::Duration') {
1669 if ($datetimeduration =~ /^(\d{4})-(\d{2})-(\d{2})/) {
1670 $datetimeduration = DateTime::Duration->new(years => $1, months => $2, days => $3);
1673 die "C4::Members::SetAge($borrower, $datetimeduration), datetimeduration not a valid ISO 8601 Date!\n";
1677 my $new_datetime_ref = $datetime_ref->clone();
1678 $new_datetime_ref->subtract_duration( $datetimeduration );
1680 $borrower->{dateofbirth} = $new_datetime_ref->ymd();
1687 $cityarrayref = GetCities();
1689 Returns an array_ref of the entries in the cities table
1690 If there are entries in the table an empty row is returned
1691 This is currently only used to populate a popup in memberentry
1697 my $dbh = C4::Context->dbh;
1698 my $city_arr = $dbh->selectall_arrayref(
1699 q|SELECT cityid,city_zipcode,city_name,city_state,city_country FROM cities ORDER BY city_name|,
1701 if ( @{$city_arr} ) {
1702 unshift @{$city_arr}, {
1703 city_zipcode => q{},
1707 city_country => q{},
1714 =head2 GetSortDetails (OUEST-PROVENCE)
1716 ($lib) = &GetSortDetails($category,$sortvalue);
1718 Returns the authorized value details
1719 C<&$lib>return value of authorized value details
1720 C<&$sortvalue>this is the value of authorized value
1721 C<&$category>this is the value of authorized value category
1725 sub GetSortDetails {
1726 my ( $category, $sortvalue ) = @_;
1727 my $dbh = C4::Context->dbh;
1728 my $query = qq|SELECT lib
1729 FROM authorised_values
1731 AND authorised_value=? |;
1732 my $sth = $dbh->prepare($query);
1733 $sth->execute( $category, $sortvalue );
1734 my $lib = $sth->fetchrow;
1735 return ($lib) if ($lib);
1736 return ($sortvalue) unless ($lib);
1739 =head2 MoveMemberToDeleted
1741 $result = &MoveMemberToDeleted($borrowernumber);
1743 Copy the record from borrowers to deletedborrowers table.
1744 The routine returns 1 for success, undef for failure.
1748 sub MoveMemberToDeleted {
1749 my ($member) = shift or return;
1751 my $schema = Koha::Database->new()->schema();
1752 my $borrowers_rs = $schema->resultset('Borrower');
1753 $borrowers_rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
1754 my $borrower = $borrowers_rs->find($member);
1755 return unless $borrower;
1757 my $deleted = $schema->resultset('Deletedborrower')->create($borrower);
1759 return $deleted ? 1 : undef;
1764 DelMember($borrowernumber);
1766 This function remove directly a borrower whitout writing it on deleteborrower.
1767 + Deletes reserves for the borrower
1772 my $dbh = C4::Context->dbh;
1773 my $borrowernumber = shift;
1774 #warn "in delmember with $borrowernumber";
1775 return unless $borrowernumber; # borrowernumber is mandatory.
1777 my $query = qq|DELETE
1779 WHERE borrowernumber=?|;
1780 my $sth = $dbh->prepare($query);
1781 $sth->execute($borrowernumber);
1785 WHERE borrowernumber = ?
1787 $sth = $dbh->prepare($query);
1788 $sth->execute($borrowernumber);
1789 logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
1793 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1795 $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1797 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1802 sub ExtendMemberSubscriptionTo {
1803 my ( $borrowerid,$date) = @_;
1804 my $dbh = C4::Context->dbh;
1805 my $borrower = GetMember('borrowernumber'=>$borrowerid);
1807 $date = (C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry') ?
1808 C4::Dates->new($borrower->{'dateexpiry'}, 'iso')->output("iso") :
1809 C4::Dates->new()->output("iso");
1810 $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
1812 my $sth = $dbh->do(<<EOF);
1814 SET dateexpiry='$date'
1815 WHERE borrowernumber='$borrowerid'
1818 AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
1820 logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
1821 return $date if ($sth);
1825 =head2 GetTitles (OUEST-PROVENCE)
1827 ($borrowertitle)= &GetTitles();
1829 Looks up the different title . Returns array with all borrowers title
1834 my @borrowerTitle = split (/,|\|/,C4::Context->preference('BorrowersTitles'));
1835 unshift( @borrowerTitle, "" );
1836 my $count=@borrowerTitle;
1841 return ( \@borrowerTitle);
1845 =head2 GetPatronImage
1847 my ($imagedata, $dberror) = GetPatronImage($borrowernumber);
1849 Returns the mimetype and binary image data of the image for the patron with the supplied borrowernumber.
1853 sub GetPatronImage {
1854 my ($borrowernumber) = @_;
1855 warn "Borrowernumber passed to GetPatronImage is $borrowernumber" if $debug;
1856 my $dbh = C4::Context->dbh;
1857 my $query = 'SELECT mimetype, imagefile FROM patronimage WHERE borrowernumber = ?';
1858 my $sth = $dbh->prepare($query);
1859 $sth->execute($borrowernumber);
1860 my $imagedata = $sth->fetchrow_hashref;
1861 warn "Database error!" if $sth->errstr;
1862 return $imagedata, $sth->errstr;
1865 =head2 PutPatronImage
1867 PutPatronImage($cardnumber, $mimetype, $imgfile);
1869 Stores patron binary image data and mimetype in database.
1870 NOTE: This function is good for updating images as well as inserting new images in the database.
1874 sub PutPatronImage {
1875 my ($cardnumber, $mimetype, $imgfile) = @_;
1876 warn "Parameters passed in: Cardnumber=$cardnumber, Mimetype=$mimetype, " . ($imgfile ? "Imagefile" : "No Imagefile") if $debug;
1877 my $dbh = C4::Context->dbh;
1878 my $query = "INSERT INTO patronimage (borrowernumber, mimetype, imagefile) VALUES ( ( SELECT borrowernumber from borrowers WHERE cardnumber = ? ),?,?) ON DUPLICATE KEY UPDATE imagefile = ?;";
1879 my $sth = $dbh->prepare($query);
1880 $sth->execute($cardnumber,$mimetype,$imgfile,$imgfile);
1881 warn "Error returned inserting $cardnumber.$mimetype." if $sth->errstr;
1882 return $sth->errstr;
1885 =head2 RmPatronImage
1887 my ($dberror) = RmPatronImage($borrowernumber);
1889 Removes the image for the patron with the supplied borrowernumber.
1894 my ($borrowernumber) = @_;
1895 warn "Borrowernumber passed to GetPatronImage is $borrowernumber" if $debug;
1896 my $dbh = C4::Context->dbh;
1897 my $query = "DELETE FROM patronimage WHERE borrowernumber = ?;";
1898 my $sth = $dbh->prepare($query);
1899 $sth->execute($borrowernumber);
1900 my $dberror = $sth->errstr;
1901 warn "Database error!" if $sth->errstr;
1905 =head2 GetHideLostItemsPreference
1907 $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1909 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1910 C<&$hidelostitemspref>return value of function, 0 or 1
1914 sub GetHideLostItemsPreference {
1915 my ($borrowernumber) = @_;
1916 my $dbh = C4::Context->dbh;
1917 my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1918 my $sth = $dbh->prepare($query);
1919 $sth->execute($borrowernumber);
1920 my $hidelostitems = $sth->fetchrow;
1921 return $hidelostitems;
1924 =head2 GetBorrowersToExpunge
1926 $borrowers = &GetBorrowersToExpunge(
1927 not_borrowered_since => $not_borrowered_since,
1928 expired_before => $expired_before,
1929 category_code => $category_code,
1930 branchcode => $branchcode
1933 This function get all borrowers based on the given criteria.
1937 sub GetBorrowersToExpunge {
1940 my $filterdate = $params->{'not_borrowered_since'};
1941 my $filterexpiry = $params->{'expired_before'};
1942 my $filtercategory = $params->{'category_code'};
1943 my $filterbranch = $params->{'branchcode'} ||
1944 ((C4::Context->preference('IndependentBranches')
1945 && C4::Context->userenv
1946 && !C4::Context->IsSuperLibrarian()
1947 && C4::Context->userenv->{branch})
1948 ? C4::Context->userenv->{branch}
1951 my $dbh = C4::Context->dbh;
1953 SELECT borrowers.borrowernumber,
1954 MAX(old_issues.timestamp) AS latestissue,
1955 MAX(issues.timestamp) AS currentissue
1957 JOIN categories USING (categorycode)
1961 WHERE guarantorid IS NOT NULL
1962 AND guarantorid <> 0
1963 ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
1964 LEFT JOIN old_issues USING (borrowernumber)
1965 LEFT JOIN issues USING (borrowernumber)
1966 WHERE category_type <> 'S'
1967 AND tmp.guarantorid IS NULL
1971 if ( $filterbranch && $filterbranch ne "" ) {
1972 $query.= " AND borrowers.branchcode = ? ";
1973 push( @query_params, $filterbranch );
1975 if ( $filterexpiry ) {
1976 $query .= " AND dateexpiry < ? ";
1977 push( @query_params, $filterexpiry );
1979 if ( $filtercategory ) {
1980 $query .= " AND categorycode = ? ";
1981 push( @query_params, $filtercategory );
1983 $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
1984 if ( $filterdate ) {
1985 $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
1986 push @query_params,$filterdate;
1988 warn $query if $debug;
1990 my $sth = $dbh->prepare($query);
1991 if (scalar(@query_params)>0){
1992 $sth->execute(@query_params);
1999 while ( my $data = $sth->fetchrow_hashref ) {
2000 push @results, $data;
2005 =head2 GetBorrowersWhoHaveNeverBorrowed
2007 $results = &GetBorrowersWhoHaveNeverBorrowed
2009 This function get all borrowers who have never borrowed.
2011 I<$result> is a ref to an array which all elements are a hasref.
2015 sub GetBorrowersWhoHaveNeverBorrowed {
2016 my $filterbranch = shift ||
2017 ((C4::Context->preference('IndependentBranches')
2018 && C4::Context->userenv
2019 && !C4::Context->IsSuperLibrarian()
2020 && C4::Context->userenv->{branch})
2021 ? C4::Context->userenv->{branch}
2023 my $dbh = C4::Context->dbh;
2025 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
2027 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
2028 WHERE issues.borrowernumber IS NULL
2031 if ($filterbranch && $filterbranch ne ""){
2032 $query.=" AND borrowers.branchcode= ?";
2033 push @query_params,$filterbranch;
2035 warn $query if $debug;
2037 my $sth = $dbh->prepare($query);
2038 if (scalar(@query_params)>0){
2039 $sth->execute(@query_params);
2046 while ( my $data = $sth->fetchrow_hashref ) {
2047 push @results, $data;
2052 =head2 GetBorrowersWithIssuesHistoryOlderThan
2054 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
2056 this function get all borrowers who has an issue history older than I<$date> given on input arg.
2058 I<$result> is a ref to an array which all elements are a hashref.
2059 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2063 sub GetBorrowersWithIssuesHistoryOlderThan {
2064 my $dbh = C4::Context->dbh;
2065 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
2066 my $filterbranch = shift ||
2067 ((C4::Context->preference('IndependentBranches')
2068 && C4::Context->userenv
2069 && !C4::Context->IsSuperLibrarian()
2070 && C4::Context->userenv->{branch})
2071 ? C4::Context->userenv->{branch}
2074 SELECT count(borrowernumber) as n,borrowernumber
2076 WHERE returndate < ?
2077 AND borrowernumber IS NOT NULL
2080 push @query_params, $date;
2082 $query.=" AND branchcode = ?";
2083 push @query_params, $filterbranch;
2085 $query.=" GROUP BY borrowernumber ";
2086 warn $query if $debug;
2087 my $sth = $dbh->prepare($query);
2088 $sth->execute(@query_params);
2091 while ( my $data = $sth->fetchrow_hashref ) {
2092 push @results, $data;
2097 =head2 GetBorrowersNamesAndLatestIssue
2099 $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
2101 this function get borrowers Names and surnames and Issue information.
2103 I<@borrowernumbers> is an array which all elements are borrowernumbers.
2104 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2108 sub GetBorrowersNamesAndLatestIssue {
2109 my $dbh = C4::Context->dbh;
2110 my @borrowernumbers=@_;
2112 SELECT surname,lastname, phone, email,max(timestamp)
2114 LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
2115 GROUP BY borrowernumber
2117 my $sth = $dbh->prepare($query);
2119 my $results = $sth->fetchall_arrayref({});
2125 my $success = ModPrivacy( $borrowernumber, $privacy );
2127 Update the privacy of a patron.
2130 true on success, false on failure
2135 my $borrowernumber = shift;
2136 my $privacy = shift;
2137 return unless defined $borrowernumber;
2138 return unless $borrowernumber =~ /^\d+$/;
2140 return ModMember( borrowernumber => $borrowernumber,
2141 privacy => $privacy );
2146 AddMessage( $borrowernumber, $message_type, $message, $branchcode );
2148 Adds a message to the messages table for the given borrower.
2157 my ( $borrowernumber, $message_type, $message, $branchcode ) = @_;
2159 my $dbh = C4::Context->dbh;
2161 if ( ! ( $borrowernumber && $message_type && $message && $branchcode ) ) {
2165 my $query = "INSERT INTO messages ( borrowernumber, branchcode, message_type, message ) VALUES ( ?, ?, ?, ? )";
2166 my $sth = $dbh->prepare($query);
2167 $sth->execute( $borrowernumber, $branchcode, $message_type, $message );
2168 logaction("MEMBERS", "ADDCIRCMESSAGE", $borrowernumber, $message) if C4::Context->preference("BorrowersLog");
2174 GetMessages( $borrowernumber, $type );
2176 $type is message type, B for borrower, or L for Librarian.
2177 Empty type returns all messages of any type.
2179 Returns all messages for the given borrowernumber
2184 my ( $borrowernumber, $type, $branchcode ) = @_;
2190 my $dbh = C4::Context->dbh;
2193 branches.branchname,
2196 messages.branchcode LIKE '$branchcode' AS can_delete
2197 FROM messages, branches
2198 WHERE borrowernumber = ?
2199 AND message_type LIKE ?
2200 AND messages.branchcode = branches.branchcode
2201 ORDER BY message_date DESC";
2202 my $sth = $dbh->prepare($query);
2203 $sth->execute( $borrowernumber, $type ) ;
2206 while ( my $data = $sth->fetchrow_hashref ) {
2207 my $d = C4::Dates->new( $data->{message_date}, 'iso' );
2208 $data->{message_date_formatted} = $d->output;
2209 push @results, $data;
2217 GetMessagesCount( $borrowernumber, $type );
2219 $type is message type, B for borrower, or L for Librarian.
2220 Empty type returns all messages of any type.
2222 Returns the number of messages for the given borrowernumber
2226 sub GetMessagesCount {
2227 my ( $borrowernumber, $type, $branchcode ) = @_;
2233 my $dbh = C4::Context->dbh;
2235 my $query = "SELECT COUNT(*) as MsgCount FROM messages WHERE borrowernumber = ? AND message_type LIKE ?";
2236 my $sth = $dbh->prepare($query);
2237 $sth->execute( $borrowernumber, $type ) ;
2240 my $data = $sth->fetchrow_hashref;
2241 my $count = $data->{'MsgCount'};
2248 =head2 DeleteMessage
2250 DeleteMessage( $message_id );
2255 my ( $message_id ) = @_;
2257 my $dbh = C4::Context->dbh;
2258 my $query = "SELECT * FROM messages WHERE message_id = ?";
2259 my $sth = $dbh->prepare($query);
2260 $sth->execute( $message_id );
2261 my $message = $sth->fetchrow_hashref();
2263 $query = "DELETE FROM messages WHERE message_id = ?";
2264 $sth = $dbh->prepare($query);
2265 $sth->execute( $message_id );
2266 logaction("MEMBERS", "DELCIRCMESSAGE", $message->{'borrowernumber'}, $message->{'message'}) if C4::Context->preference("BorrowersLog");
2271 IssueSlip($branchcode, $borrowernumber, $quickslip)
2273 Returns letter hash ( see C4::Letters::GetPreparedLetter )
2275 $quickslip is boolean, to indicate whether we want a quick slip
2277 IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
2313 NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
2318 my ($branch, $borrowernumber, $quickslip) = @_;
2320 # FIXME Check callers before removing this statement
2321 #return unless $borrowernumber;
2323 my @issues = @{ GetPendingIssues($borrowernumber) };
2325 for my $issue (@issues) {
2326 $issue->{date_due} = $issue->{date_due_sql};
2328 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
2329 if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
2330 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
2336 # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
2338 my $s = $b->{timestamp} <=> $a->{timestamp};
2340 $b->{issuedate} <=> $a->{issuedate} : $s;
2343 my ($letter_code, %repeat);
2345 $letter_code = 'ISSUEQSLIP';
2347 'checkedout' => [ map {
2350 'biblioitems' => $_,
2352 }, grep { $_->{'now'} } @issues ],
2356 $letter_code = 'ISSUESLIP';
2358 'checkedout' => [ map {
2361 'biblioitems' => $_,
2363 }, grep { !$_->{'overdue'} } @issues ],
2365 'overdue' => [ map {
2368 'biblioitems' => $_,
2370 }, grep { $_->{'overdue'} } @issues ],
2373 $_->{'timestamp'} = $_->{'newdate'};
2375 } @{ GetNewsToDisplay("slip",$branch) } ],
2379 return C4::Letters::GetPreparedLetter (
2380 module => 'circulation',
2381 letter_code => $letter_code,
2382 branchcode => $branch,
2384 'branches' => $branch,
2385 'borrowers' => $borrowernumber,
2391 =head2 GetBorrowersWithEmail
2393 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
2395 This gets a list of users and their basic details from their email address.
2396 As it's possible for multiple user to have the same email address, it provides
2397 you with all of them. If there is no userid for the user, there will be an
2398 C<undef> there. An empty list will be returned if there are no matches.
2402 sub GetBorrowersWithEmail {
2405 my $dbh = C4::Context->dbh;
2407 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
2408 my $sth=$dbh->prepare($query);
2409 $sth->execute($email);
2411 while (my $ref = $sth->fetch) {
2414 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
2418 =head2 AddMember_Opac
2422 sub AddMember_Opac {
2423 my ( %borrower ) = @_;
2425 $borrower{'categorycode'} = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2427 my $sr = new String::Random;
2428 $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
2429 my $password = $sr->randpattern("AAAAAAAAAA");
2430 $borrower{'password'} = $password;
2432 $borrower{'cardnumber'} = fixup_cardnumber();
2434 my $borrowernumber = AddMember(%borrower);
2436 return ( $borrowernumber, $password );
2439 =head2 AddEnrolmentFeeIfNeeded
2441 AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
2443 Add enrolment fee for a patron if needed.
2447 sub AddEnrolmentFeeIfNeeded {
2448 my ( $categorycode, $borrowernumber ) = @_;
2449 # check for enrollment fee & add it if needed
2450 my $dbh = C4::Context->dbh;
2451 my $sth = $dbh->prepare(q{
2454 WHERE categorycode=?
2456 $sth->execute( $categorycode );
2458 warn sprintf('Database returned the following error: %s', $sth->errstr);
2461 my ($enrolmentfee) = $sth->fetchrow;
2462 if ($enrolmentfee && $enrolmentfee > 0) {
2463 # insert fee in patron debts
2464 C4::Accounts::manualinvoice( $borrowernumber, '', '', 'A', $enrolmentfee );
2473 my ( $borrowernumber ) = @_;
2475 my $sql = "SELECT COUNT(*) FROM issues WHERE date_due < NOW() AND borrowernumber = ?";
2476 my $sth = C4::Context->dbh->prepare( $sql );
2477 $sth->execute( $borrowernumber );
2478 my ( $count ) = $sth->fetchrow_array();
2483 =head2 DeleteExpiredOpacRegistrations
2485 Delete accounts that haven't been upgraded from the 'temporary' category
2486 Returns the number of removed patrons
2490 sub DeleteExpiredOpacRegistrations {
2492 my $delay = C4::Context->preference('PatronSelfRegistrationExpireTemporaryAccountsDelay');
2493 my $category_code = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2495 return 0 if not $category_code or not defined $delay or $delay eq q||;
2498 SELECT borrowernumber
2500 WHERE categorycode = ? AND DATEDIFF( NOW(), dateenrolled ) > ? |;
2502 my $dbh = C4::Context->dbh;
2503 my $sth = $dbh->prepare($query);
2504 $sth->execute( $category_code, $delay );
2506 while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
2507 DelMember($borrowernumber);
2513 =head2 DeleteUnverifiedOpacRegistrations
2515 Delete all unverified self registrations in borrower_modifications,
2516 older than the specified number of days.
2520 sub DeleteUnverifiedOpacRegistrations {
2522 my $dbh = C4::Context->dbh;
2524 DELETE FROM borrower_modifications
2525 WHERE borrowernumber = 0 AND DATEDIFF( NOW(), timestamp ) > ?|;
2526 my $cnt=$dbh->do($sql, undef, ($days) );
2527 return $cnt eq '0E0'? 0: $cnt;
2530 END { } # module clean-up code here (global destructor)