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 $new_borrower->{debarred} ||= undef if exists $new_borrower->{debarred};
671 my $rs = $schema->resultset('Borrower')->search({
672 borrowernumber => $new_borrower->{borrowernumber},
674 my $execute_success = $rs->update($new_borrower);
675 if ($execute_success ne '0E0') { # only proceed if the update was a success
676 # ok if its an adult (type) it may have borrowers that depend on it as a guarantor
677 # so when we update information for an adult we should check for guarantees and update the relevant part
678 # of their records, ie addresses and phone numbers
679 my $borrowercategory= GetBorrowercategory( $data{'category_type'} );
680 if ( exists $borrowercategory->{'category_type'} && $borrowercategory->{'category_type'} eq ('A' || 'S') ) {
681 # is adult check guarantees;
682 UpdateGuarantees(%data);
685 # If the patron changes to a category with enrollment fee, we add a fee
686 if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
687 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
1615 =head2 ethnicitycategories
1617 ($codes_arrayref, $labels_hashref) = ðnicitycategories();
1619 Looks up the different ethnic types in the database. Returns two
1620 elements: a reference-to-array, which lists the ethnicity codes, and a
1621 reference-to-hash, which maps the ethnicity codes to ethnicity
1628 sub ethnicitycategories {
1629 my $dbh = C4::Context->dbh;
1630 my $sth = $dbh->prepare("Select code,name from ethnicity order by name");
1634 while ( my $data = $sth->fetchrow_hashref ) {
1635 push @codes, $data->{'code'};
1636 $labels{ $data->{'code'} } = $data->{'name'};
1638 return ( \@codes, \%labels );
1643 $ethn_name = &fixEthnicity($ethn_code);
1645 Takes an ethnicity code (e.g., "european" or "pi") and returns the
1646 corresponding descriptive name from the C<ethnicity> table in the
1647 Koha database ("European" or "Pacific Islander").
1654 my $ethnicity = shift;
1655 return unless $ethnicity;
1656 my $dbh = C4::Context->dbh;
1657 my $sth = $dbh->prepare("Select name from ethnicity where code = ?");
1658 $sth->execute($ethnicity);
1659 my $data = $sth->fetchrow_hashref;
1660 return $data->{'name'};
1661 } # sub fixEthnicity
1665 $dateofbirth,$date = &GetAge($date);
1667 this function return the borrowers age with the value of dateofbirth
1673 my ( $date, $date_ref ) = @_;
1675 if ( not defined $date_ref ) {
1676 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1679 my ( $year1, $month1, $day1 ) = split /-/, $date;
1680 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1682 my $age = $year2 - $year1;
1683 if ( $month1 . $day1 > $month2 . $day2 ) {
1692 $borrower = C4::Members::SetAge($borrower, $datetimeduration);
1693 $borrower = C4::Members::SetAge($borrower, '0015-12-10');
1694 $borrower = C4::Members::SetAge($borrower, $datetimeduration, $datetime_reference);
1696 eval { $borrower = C4::Members::SetAge($borrower, '015-1-10'); };
1697 if ($@) {print $@;} #Catch a bad ISO Date or kill your script!
1699 This function sets the borrower's dateofbirth to match the given age.
1700 Optionally relative to the given $datetime_reference.
1702 @PARAM1 koha.borrowers-object
1703 @PARAM2 DateTime::Duration-object as the desired age
1704 OR a ISO 8601 Date. (To make the API more pleasant)
1705 @PARAM3 DateTime-object as the relative date, defaults to now().
1706 RETURNS The given borrower reference @PARAM1.
1707 DIES If there was an error with the ISO Date handling.
1713 my ( $borrower, $datetimeduration, $datetime_ref ) = @_;
1714 $datetime_ref = DateTime->now() unless $datetime_ref;
1716 if ($datetimeduration && ref $datetimeduration ne 'DateTime::Duration') {
1717 if ($datetimeduration =~ /^(\d{4})-(\d{2})-(\d{2})/) {
1718 $datetimeduration = DateTime::Duration->new(years => $1, months => $2, days => $3);
1721 die "C4::Members::SetAge($borrower, $datetimeduration), datetimeduration not a valid ISO 8601 Date!\n";
1725 my $new_datetime_ref = $datetime_ref->clone();
1726 $new_datetime_ref->subtract_duration( $datetimeduration );
1728 $borrower->{dateofbirth} = $new_datetime_ref->ymd();
1735 $cityarrayref = GetCities();
1737 Returns an array_ref of the entries in the cities table
1738 If there are entries in the table an empty row is returned
1739 This is currently only used to populate a popup in memberentry
1745 my $dbh = C4::Context->dbh;
1746 my $city_arr = $dbh->selectall_arrayref(
1747 q|SELECT cityid,city_zipcode,city_name,city_state,city_country FROM cities ORDER BY city_name|,
1749 if ( @{$city_arr} ) {
1750 unshift @{$city_arr}, {
1751 city_zipcode => q{},
1755 city_country => q{},
1762 =head2 GetSortDetails (OUEST-PROVENCE)
1764 ($lib) = &GetSortDetails($category,$sortvalue);
1766 Returns the authorized value details
1767 C<&$lib>return value of authorized value details
1768 C<&$sortvalue>this is the value of authorized value
1769 C<&$category>this is the value of authorized value category
1773 sub GetSortDetails {
1774 my ( $category, $sortvalue ) = @_;
1775 my $dbh = C4::Context->dbh;
1776 my $query = qq|SELECT lib
1777 FROM authorised_values
1779 AND authorised_value=? |;
1780 my $sth = $dbh->prepare($query);
1781 $sth->execute( $category, $sortvalue );
1782 my $lib = $sth->fetchrow;
1783 return ($lib) if ($lib);
1784 return ($sortvalue) unless ($lib);
1787 =head2 MoveMemberToDeleted
1789 $result = &MoveMemberToDeleted($borrowernumber);
1791 Copy the record from borrowers to deletedborrowers table.
1792 The routine returns 1 for success, undef for failure.
1796 sub MoveMemberToDeleted {
1797 my ($member) = shift or return;
1799 my $schema = Koha::Database->new()->schema();
1800 my $borrowers_rs = $schema->resultset('Borrower');
1801 $borrowers_rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
1802 my $borrower = $borrowers_rs->find($member);
1803 return unless $borrower;
1805 my $deleted = $schema->resultset('Deletedborrower')->create($borrower);
1807 return $deleted ? 1 : undef;
1812 DelMember($borrowernumber);
1814 This function remove directly a borrower whitout writing it on deleteborrower.
1815 + Deletes reserves for the borrower
1820 my $dbh = C4::Context->dbh;
1821 my $borrowernumber = shift;
1822 #warn "in delmember with $borrowernumber";
1823 return unless $borrowernumber; # borrowernumber is mandatory.
1825 my $query = qq|DELETE
1827 WHERE borrowernumber=?|;
1828 my $sth = $dbh->prepare($query);
1829 $sth->execute($borrowernumber);
1833 WHERE borrowernumber = ?
1835 $sth = $dbh->prepare($query);
1836 $sth->execute($borrowernumber);
1837 logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
1841 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1843 $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1845 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1850 sub ExtendMemberSubscriptionTo {
1851 my ( $borrowerid,$date) = @_;
1852 my $dbh = C4::Context->dbh;
1853 my $borrower = GetMember('borrowernumber'=>$borrowerid);
1855 $date = (C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry') ?
1856 C4::Dates->new($borrower->{'dateexpiry'}, 'iso')->output("iso") :
1857 C4::Dates->new()->output("iso");
1858 $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
1860 my $sth = $dbh->do(<<EOF);
1862 SET dateexpiry='$date'
1863 WHERE borrowernumber='$borrowerid'
1866 AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
1868 logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
1869 return $date if ($sth);
1873 =head2 GetTitles (OUEST-PROVENCE)
1875 ($borrowertitle)= &GetTitles();
1877 Looks up the different title . Returns array with all borrowers title
1882 my @borrowerTitle = split (/,|\|/,C4::Context->preference('BorrowersTitles'));
1883 unshift( @borrowerTitle, "" );
1884 my $count=@borrowerTitle;
1889 return ( \@borrowerTitle);
1893 =head2 GetPatronImage
1895 my ($imagedata, $dberror) = GetPatronImage($borrowernumber);
1897 Returns the mimetype and binary image data of the image for the patron with the supplied borrowernumber.
1901 sub GetPatronImage {
1902 my ($borrowernumber) = @_;
1903 warn "Borrowernumber passed to GetPatronImage is $borrowernumber" if $debug;
1904 my $dbh = C4::Context->dbh;
1905 my $query = 'SELECT mimetype, imagefile FROM patronimage WHERE borrowernumber = ?';
1906 my $sth = $dbh->prepare($query);
1907 $sth->execute($borrowernumber);
1908 my $imagedata = $sth->fetchrow_hashref;
1909 warn "Database error!" if $sth->errstr;
1910 return $imagedata, $sth->errstr;
1913 =head2 PutPatronImage
1915 PutPatronImage($cardnumber, $mimetype, $imgfile);
1917 Stores patron binary image data and mimetype in database.
1918 NOTE: This function is good for updating images as well as inserting new images in the database.
1922 sub PutPatronImage {
1923 my ($cardnumber, $mimetype, $imgfile) = @_;
1924 warn "Parameters passed in: Cardnumber=$cardnumber, Mimetype=$mimetype, " . ($imgfile ? "Imagefile" : "No Imagefile") if $debug;
1925 my $dbh = C4::Context->dbh;
1926 my $query = "INSERT INTO patronimage (borrowernumber, mimetype, imagefile) VALUES ( ( SELECT borrowernumber from borrowers WHERE cardnumber = ? ),?,?) ON DUPLICATE KEY UPDATE imagefile = ?;";
1927 my $sth = $dbh->prepare($query);
1928 $sth->execute($cardnumber,$mimetype,$imgfile,$imgfile);
1929 warn "Error returned inserting $cardnumber.$mimetype." if $sth->errstr;
1930 return $sth->errstr;
1933 =head2 RmPatronImage
1935 my ($dberror) = RmPatronImage($borrowernumber);
1937 Removes the image for the patron with the supplied borrowernumber.
1942 my ($borrowernumber) = @_;
1943 warn "Borrowernumber passed to GetPatronImage is $borrowernumber" if $debug;
1944 my $dbh = C4::Context->dbh;
1945 my $query = "DELETE FROM patronimage WHERE borrowernumber = ?;";
1946 my $sth = $dbh->prepare($query);
1947 $sth->execute($borrowernumber);
1948 my $dberror = $sth->errstr;
1949 warn "Database error!" if $sth->errstr;
1953 =head2 GetHideLostItemsPreference
1955 $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1957 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1958 C<&$hidelostitemspref>return value of function, 0 or 1
1962 sub GetHideLostItemsPreference {
1963 my ($borrowernumber) = @_;
1964 my $dbh = C4::Context->dbh;
1965 my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1966 my $sth = $dbh->prepare($query);
1967 $sth->execute($borrowernumber);
1968 my $hidelostitems = $sth->fetchrow;
1969 return $hidelostitems;
1972 =head2 GetBorrowersToExpunge
1974 $borrowers = &GetBorrowersToExpunge(
1975 not_borrowered_since => $not_borrowered_since,
1976 expired_before => $expired_before,
1977 category_code => $category_code,
1978 branchcode => $branchcode
1981 This function get all borrowers based on the given criteria.
1985 sub GetBorrowersToExpunge {
1988 my $filterdate = $params->{'not_borrowered_since'};
1989 my $filterexpiry = $params->{'expired_before'};
1990 my $filtercategory = $params->{'category_code'};
1991 my $filterbranch = $params->{'branchcode'} ||
1992 ((C4::Context->preference('IndependentBranches')
1993 && C4::Context->userenv
1994 && !C4::Context->IsSuperLibrarian()
1995 && C4::Context->userenv->{branch})
1996 ? C4::Context->userenv->{branch}
1999 my $dbh = C4::Context->dbh;
2001 SELECT borrowers.borrowernumber,
2002 MAX(old_issues.timestamp) AS latestissue,
2003 MAX(issues.timestamp) AS currentissue
2005 JOIN categories USING (categorycode)
2009 WHERE guarantorid IS NOT NULL
2010 AND guarantorid <> 0
2011 ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
2012 LEFT JOIN old_issues USING (borrowernumber)
2013 LEFT JOIN issues USING (borrowernumber)
2014 WHERE category_type <> 'S'
2015 AND tmp.guarantorid IS NULL
2019 if ( $filterbranch && $filterbranch ne "" ) {
2020 $query.= " AND borrowers.branchcode = ? ";
2021 push( @query_params, $filterbranch );
2023 if ( $filterexpiry ) {
2024 $query .= " AND dateexpiry < ? ";
2025 push( @query_params, $filterexpiry );
2027 if ( $filtercategory ) {
2028 $query .= " AND categorycode = ? ";
2029 push( @query_params, $filtercategory );
2031 $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
2032 if ( $filterdate ) {
2033 $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
2034 push @query_params,$filterdate;
2036 warn $query if $debug;
2038 my $sth = $dbh->prepare($query);
2039 if (scalar(@query_params)>0){
2040 $sth->execute(@query_params);
2047 while ( my $data = $sth->fetchrow_hashref ) {
2048 push @results, $data;
2053 =head2 GetBorrowersWhoHaveNeverBorrowed
2055 $results = &GetBorrowersWhoHaveNeverBorrowed
2057 This function get all borrowers who have never borrowed.
2059 I<$result> is a ref to an array which all elements are a hasref.
2063 sub GetBorrowersWhoHaveNeverBorrowed {
2064 my $filterbranch = shift ||
2065 ((C4::Context->preference('IndependentBranches')
2066 && C4::Context->userenv
2067 && !C4::Context->IsSuperLibrarian()
2068 && C4::Context->userenv->{branch})
2069 ? C4::Context->userenv->{branch}
2071 my $dbh = C4::Context->dbh;
2073 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
2075 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
2076 WHERE issues.borrowernumber IS NULL
2079 if ($filterbranch && $filterbranch ne ""){
2080 $query.=" AND borrowers.branchcode= ?";
2081 push @query_params,$filterbranch;
2083 warn $query if $debug;
2085 my $sth = $dbh->prepare($query);
2086 if (scalar(@query_params)>0){
2087 $sth->execute(@query_params);
2094 while ( my $data = $sth->fetchrow_hashref ) {
2095 push @results, $data;
2100 =head2 GetBorrowersWithIssuesHistoryOlderThan
2102 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
2104 this function get all borrowers who has an issue history older than I<$date> given on input arg.
2106 I<$result> is a ref to an array which all elements are a hashref.
2107 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2111 sub GetBorrowersWithIssuesHistoryOlderThan {
2112 my $dbh = C4::Context->dbh;
2113 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
2114 my $filterbranch = shift ||
2115 ((C4::Context->preference('IndependentBranches')
2116 && C4::Context->userenv
2117 && !C4::Context->IsSuperLibrarian()
2118 && C4::Context->userenv->{branch})
2119 ? C4::Context->userenv->{branch}
2122 SELECT count(borrowernumber) as n,borrowernumber
2124 WHERE returndate < ?
2125 AND borrowernumber IS NOT NULL
2128 push @query_params, $date;
2130 $query.=" AND branchcode = ?";
2131 push @query_params, $filterbranch;
2133 $query.=" GROUP BY borrowernumber ";
2134 warn $query if $debug;
2135 my $sth = $dbh->prepare($query);
2136 $sth->execute(@query_params);
2139 while ( my $data = $sth->fetchrow_hashref ) {
2140 push @results, $data;
2145 =head2 GetBorrowersNamesAndLatestIssue
2147 $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
2149 this function get borrowers Names and surnames and Issue information.
2151 I<@borrowernumbers> is an array which all elements are borrowernumbers.
2152 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2156 sub GetBorrowersNamesAndLatestIssue {
2157 my $dbh = C4::Context->dbh;
2158 my @borrowernumbers=@_;
2160 SELECT surname,lastname, phone, email,max(timestamp)
2162 LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
2163 GROUP BY borrowernumber
2165 my $sth = $dbh->prepare($query);
2167 my $results = $sth->fetchall_arrayref({});
2173 my $success = ModPrivacy( $borrowernumber, $privacy );
2175 Update the privacy of a patron.
2178 true on success, false on failure
2183 my $borrowernumber = shift;
2184 my $privacy = shift;
2185 return unless defined $borrowernumber;
2186 return unless $borrowernumber =~ /^\d+$/;
2188 return ModMember( borrowernumber => $borrowernumber,
2189 privacy => $privacy );
2194 AddMessage( $borrowernumber, $message_type, $message, $branchcode );
2196 Adds a message to the messages table for the given borrower.
2205 my ( $borrowernumber, $message_type, $message, $branchcode ) = @_;
2207 my $dbh = C4::Context->dbh;
2209 if ( ! ( $borrowernumber && $message_type && $message && $branchcode ) ) {
2213 my $query = "INSERT INTO messages ( borrowernumber, branchcode, message_type, message ) VALUES ( ?, ?, ?, ? )";
2214 my $sth = $dbh->prepare($query);
2215 $sth->execute( $borrowernumber, $branchcode, $message_type, $message );
2216 logaction("MEMBERS", "ADDCIRCMESSAGE", $borrowernumber, $message) if C4::Context->preference("BorrowersLog");
2222 GetMessages( $borrowernumber, $type );
2224 $type is message type, B for borrower, or L for Librarian.
2225 Empty type returns all messages of any type.
2227 Returns all messages for the given borrowernumber
2232 my ( $borrowernumber, $type, $branchcode ) = @_;
2238 my $dbh = C4::Context->dbh;
2241 branches.branchname,
2244 messages.branchcode LIKE '$branchcode' AS can_delete
2245 FROM messages, branches
2246 WHERE borrowernumber = ?
2247 AND message_type LIKE ?
2248 AND messages.branchcode = branches.branchcode
2249 ORDER BY message_date DESC";
2250 my $sth = $dbh->prepare($query);
2251 $sth->execute( $borrowernumber, $type ) ;
2254 while ( my $data = $sth->fetchrow_hashref ) {
2255 my $d = C4::Dates->new( $data->{message_date}, 'iso' );
2256 $data->{message_date_formatted} = $d->output;
2257 push @results, $data;
2265 GetMessagesCount( $borrowernumber, $type );
2267 $type is message type, B for borrower, or L for Librarian.
2268 Empty type returns all messages of any type.
2270 Returns the number of messages for the given borrowernumber
2274 sub GetMessagesCount {
2275 my ( $borrowernumber, $type, $branchcode ) = @_;
2281 my $dbh = C4::Context->dbh;
2283 my $query = "SELECT COUNT(*) as MsgCount FROM messages WHERE borrowernumber = ? AND message_type LIKE ?";
2284 my $sth = $dbh->prepare($query);
2285 $sth->execute( $borrowernumber, $type ) ;
2288 my $data = $sth->fetchrow_hashref;
2289 my $count = $data->{'MsgCount'};
2296 =head2 DeleteMessage
2298 DeleteMessage( $message_id );
2303 my ( $message_id ) = @_;
2305 my $dbh = C4::Context->dbh;
2306 my $query = "SELECT * FROM messages WHERE message_id = ?";
2307 my $sth = $dbh->prepare($query);
2308 $sth->execute( $message_id );
2309 my $message = $sth->fetchrow_hashref();
2311 $query = "DELETE FROM messages WHERE message_id = ?";
2312 $sth = $dbh->prepare($query);
2313 $sth->execute( $message_id );
2314 logaction("MEMBERS", "DELCIRCMESSAGE", $message->{'borrowernumber'}, $message->{'message'}) if C4::Context->preference("BorrowersLog");
2319 IssueSlip($branchcode, $borrowernumber, $quickslip)
2321 Returns letter hash ( see C4::Letters::GetPreparedLetter )
2323 $quickslip is boolean, to indicate whether we want a quick slip
2325 IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
2361 NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
2366 my ($branch, $borrowernumber, $quickslip) = @_;
2368 # FIXME Check callers before removing this statement
2369 #return unless $borrowernumber;
2371 my @issues = @{ GetPendingIssues($borrowernumber) };
2373 for my $issue (@issues) {
2374 $issue->{date_due} = $issue->{date_due_sql};
2376 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
2377 if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
2378 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
2384 # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
2386 my $s = $b->{timestamp} <=> $a->{timestamp};
2388 $b->{issuedate} <=> $a->{issuedate} : $s;
2391 my ($letter_code, %repeat);
2393 $letter_code = 'ISSUEQSLIP';
2395 'checkedout' => [ map {
2398 'biblioitems' => $_,
2400 }, grep { $_->{'now'} } @issues ],
2404 $letter_code = 'ISSUESLIP';
2406 'checkedout' => [ map {
2409 'biblioitems' => $_,
2411 }, grep { !$_->{'overdue'} } @issues ],
2413 'overdue' => [ map {
2416 'biblioitems' => $_,
2418 }, grep { $_->{'overdue'} } @issues ],
2421 $_->{'timestamp'} = $_->{'newdate'};
2423 } @{ GetNewsToDisplay("slip",$branch) } ],
2427 return C4::Letters::GetPreparedLetter (
2428 module => 'circulation',
2429 letter_code => $letter_code,
2430 branchcode => $branch,
2432 'branches' => $branch,
2433 'borrowers' => $borrowernumber,
2439 =head2 GetBorrowersWithEmail
2441 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
2443 This gets a list of users and their basic details from their email address.
2444 As it's possible for multiple user to have the same email address, it provides
2445 you with all of them. If there is no userid for the user, there will be an
2446 C<undef> there. An empty list will be returned if there are no matches.
2450 sub GetBorrowersWithEmail {
2453 my $dbh = C4::Context->dbh;
2455 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
2456 my $sth=$dbh->prepare($query);
2457 $sth->execute($email);
2459 while (my $ref = $sth->fetch) {
2462 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
2466 sub AddMember_Opac {
2467 my ( %borrower ) = @_;
2469 $borrower{'categorycode'} = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2471 my $sr = new String::Random;
2472 $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
2473 my $password = $sr->randpattern("AAAAAAAAAA");
2474 $borrower{'password'} = $password;
2476 $borrower{'cardnumber'} = fixup_cardnumber();
2478 my $borrowernumber = AddMember(%borrower);
2480 return ( $borrowernumber, $password );
2483 =head2 AddEnrolmentFeeIfNeeded
2485 AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
2487 Add enrolment fee for a patron if needed.
2491 sub AddEnrolmentFeeIfNeeded {
2492 my ( $categorycode, $borrowernumber ) = @_;
2493 # check for enrollment fee & add it if needed
2494 my $dbh = C4::Context->dbh;
2495 my $sth = $dbh->prepare(q{
2498 WHERE categorycode=?
2500 $sth->execute( $categorycode );
2502 warn sprintf('Database returned the following error: %s', $sth->errstr);
2505 my ($enrolmentfee) = $sth->fetchrow;
2506 if ($enrolmentfee && $enrolmentfee > 0) {
2507 # insert fee in patron debts
2508 C4::Accounts::manualinvoice( $borrowernumber, '', '', 'A', $enrolmentfee );
2513 my ( $borrowernumber ) = @_;
2515 my $sql = "SELECT COUNT(*) FROM issues WHERE date_due < NOW() AND borrowernumber = ?";
2516 my $sth = C4::Context->dbh->prepare( $sql );
2517 $sth->execute( $borrowernumber );
2518 my ( $count ) = $sth->fetchrow_array();
2523 END { } # module clean-up code here (global destructor)