3 # Copyright 2000-2003 Katipo Communications
4 # Copyright 2010 BibLibre
5 # Parts Copyright 2010 Catalyst IT
7 # This file is part of Koha.
9 # Koha is free software; you can redistribute it and/or modify it
10 # under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
14 # Koha is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
24 #use warnings; FIXME - Bug 2505
26 use String::Random qw( random_string );
27 use Date::Calc qw/Today Add_Delta_YM check_date Date_to_Days/;
28 use C4::Log; # logaction
34 use C4::Members::Attributes qw(SearchIdMatchingAttribute UpdateBorrowerAttribute);
35 use C4::NewsChannels; #get slip news
39 use Koha::Borrower::Debarments qw(IsDebarred);
40 use Text::Unaccent qw( unac_string );
41 use Koha::AuthUtils qw(hash_password);
44 our ($VERSION,@ISA,@EXPORT,@EXPORT_OK,$debug);
46 use Module::Load::Conditional qw( can_load );
47 if ( ! can_load( modules => { 'Koha::NorwegianPatronDB' => undef } ) ) {
48 $debug && warn "Unable to load Koha::NorwegianPatronDB";
53 $VERSION = 3.07.00.049;
54 $debug = $ENV{DEBUG} || 0;
66 &GetMemberIssuesAndFines
73 &GetFirstValidEmailAddress
74 &GetNoticeEmailAddress
85 &GetHideLostItemsPreference
88 &GetMemberAccountRecords
89 &GetBorNotifyAcctRecord
93 GetBorrowerCategorycode
94 &GetBorrowercategoryList
96 &GetBorrowersToExpunge
97 &GetBorrowersWhoHaveNeverBorrowed
98 &GetBorrowersWithIssuesHistoryOlderThan
101 &GetUpcomingMembershipExpires
109 GetBorrowersWithEmail
132 &ExtendMemberSubscriptionTo
148 C4::Members - Perl Module containing convenience functions for member handling
156 This module contains routines for adding, modifying and deleting members/patrons/borrowers
160 =head2 GetMemberDetails
162 ($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
164 Looks up a patron and returns information about him or her. If
165 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
166 up the borrower by number; otherwise, it looks up the borrower by card
169 C<$borrower> is a reference-to-hash whose keys are the fields of the
170 borrowers table in the Koha database. In addition,
171 C<$borrower-E<gt>{flags}> is a hash giving more detailed information
172 about the patron. Its keys act as flags :
174 if $borrower->{flags}->{LOST} {
175 # Patron's card was reported lost
178 If the state of a flag means that the patron should not be
179 allowed to borrow any more books, then it will have a C<noissues> key
182 See patronflags for more details.
184 C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
185 about the top-level permissions flags set for the borrower. For example,
186 if a user has the "editcatalogue" permission,
187 C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
192 sub GetMemberDetails {
193 my ( $borrowernumber, $cardnumber ) = @_;
194 my $dbh = C4::Context->dbh;
197 if ($borrowernumber) {
198 $sth = $dbh->prepare("
201 categories.description,
202 categories.BlockExpiredPatronOpacActions,
206 LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
207 WHERE borrowernumber = ?
209 $sth->execute($borrowernumber);
211 elsif ($cardnumber) {
212 $sth = $dbh->prepare("
215 categories.description,
216 categories.BlockExpiredPatronOpacActions,
220 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
223 $sth->execute($cardnumber);
228 my $borrower = $sth->fetchrow_hashref;
229 return unless $borrower;
230 my ($amount) = GetMemberAccountRecords($borrower->{borrowernumber});
231 $borrower->{'amountoutstanding'} = $amount;
232 # FIXME - patronflags calls GetMemberAccountRecords... just have patronflags return $amount
233 my $flags = patronflags( $borrower);
236 $sth = $dbh->prepare("select bit,flag from userflags");
238 while ( my ( $bit, $flag ) = $sth->fetchrow ) {
239 if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
240 $accessflagshash->{$flag} = 1;
243 $borrower->{'flags'} = $flags;
244 $borrower->{'authflags'} = $accessflagshash;
246 # Handle setting the true behavior for BlockExpiredPatronOpacActions
247 $borrower->{'BlockExpiredPatronOpacActions'} =
248 C4::Context->preference('BlockExpiredPatronOpacActions')
249 if ( $borrower->{'BlockExpiredPatronOpacActions'} == -1 );
251 $borrower->{'is_expired'} = 0;
252 $borrower->{'is_expired'} = 1 if
253 defined($borrower->{dateexpiry}) &&
254 $borrower->{'dateexpiry'} ne '0000-00-00' &&
255 Date_to_Days( Today() ) >
256 Date_to_Days( split /-/, $borrower->{'dateexpiry'} );
258 return ($borrower); #, $flags, $accessflagshash);
263 $flags = &patronflags($patron);
265 This function is not exported.
267 The following will be set where applicable:
268 $flags->{CHARGES}->{amount} Amount of debt
269 $flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge)
270 $flags->{CHARGES}->{message} Message -- deprecated
272 $flags->{CREDITS}->{amount} Amount of credit
273 $flags->{CREDITS}->{message} Message -- deprecated
275 $flags->{ GNA } Patron has no valid address
276 $flags->{ GNA }->{noissues} Set for each GNA
277 $flags->{ GNA }->{message} "Borrower has no valid address" -- deprecated
279 $flags->{ LOST } Patron's card reported lost
280 $flags->{ LOST }->{noissues} Set for each LOST
281 $flags->{ LOST }->{message} Message -- deprecated
283 $flags->{DBARRED} Set if patron debarred, no access
284 $flags->{DBARRED}->{noissues} Set for each DBARRED
285 $flags->{DBARRED}->{message} Message -- deprecated
288 $flags->{ NOTES }->{message} The note itself. NOT deprecated
290 $flags->{ ODUES } Set if patron has overdue books.
291 $flags->{ ODUES }->{message} "Yes" -- deprecated
292 $flags->{ ODUES }->{itemlist} ref-to-array: list of overdue books
293 $flags->{ ODUES }->{itemlisttext} Text list of overdue items -- deprecated
295 $flags->{WAITING} Set if any of patron's reserves are available
296 $flags->{WAITING}->{message} Message -- deprecated
297 $flags->{WAITING}->{itemlist} ref-to-array: list of available items
301 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
302 overdue items. Its elements are references-to-hash, each describing an
303 overdue item. The keys are selected fields from the issues, biblio,
304 biblioitems, and items tables of the Koha database.
306 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
307 the overdue items, one per line. Deprecated.
309 =item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
310 available items. Each element is a reference-to-hash whose keys are
311 fields from the reserves table of the Koha database.
315 All the "message" fields that include language generated in this function are deprecated,
316 because such strings belong properly in the display layer.
318 The "message" field that comes from the DB is OK.
322 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
323 # FIXME rename this function.
326 my ( $patroninformation) = @_;
327 my $dbh=C4::Context->dbh;
328 my ($balance, $owing) = GetMemberAccountBalance( $patroninformation->{'borrowernumber'});
331 my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
332 $flaginfo{'message'} = sprintf 'Patron owes %.02f', $owing;
333 $flaginfo{'amount'} = sprintf "%.02f", $owing;
334 if ( $owing > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
335 $flaginfo{'noissues'} = 1;
337 $flags{'CHARGES'} = \%flaginfo;
339 elsif ( $balance < 0 ) {
341 $flaginfo{'message'} = sprintf 'Patron has credit of %.02f', -$balance;
342 $flaginfo{'amount'} = sprintf "%.02f", $balance;
343 $flags{'CREDITS'} = \%flaginfo;
345 if ( $patroninformation->{'gonenoaddress'}
346 && $patroninformation->{'gonenoaddress'} == 1 )
349 $flaginfo{'message'} = 'Borrower has no valid address.';
350 $flaginfo{'noissues'} = 1;
351 $flags{'GNA'} = \%flaginfo;
353 if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
355 $flaginfo{'message'} = 'Borrower\'s card reported lost.';
356 $flaginfo{'noissues'} = 1;
357 $flags{'LOST'} = \%flaginfo;
359 if ( $patroninformation->{'debarred'} && check_date( split( /-/, $patroninformation->{'debarred'} ) ) ) {
360 if ( Date_to_Days(Date::Calc::Today) < Date_to_Days( split( /-/, $patroninformation->{'debarred'} ) ) ) {
362 $flaginfo{'debarredcomment'} = $patroninformation->{'debarredcomment'};
363 $flaginfo{'message'} = $patroninformation->{'debarredcomment'};
364 $flaginfo{'noissues'} = 1;
365 $flaginfo{'dateend'} = $patroninformation->{'debarred'};
366 $flags{'DBARRED'} = \%flaginfo;
369 if ( $patroninformation->{'borrowernotes'}
370 && $patroninformation->{'borrowernotes'} )
373 $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
374 $flags{'NOTES'} = \%flaginfo;
376 my ( $odues, $itemsoverdue ) = C4::Overdues::checkoverdues($patroninformation->{'borrowernumber'});
377 if ( $odues && $odues > 0 ) {
379 $flaginfo{'message'} = "Yes";
380 $flaginfo{'itemlist'} = $itemsoverdue;
381 foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
384 $flaginfo{'itemlisttext'} .=
385 "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n"; # newline is display layer
387 $flags{'ODUES'} = \%flaginfo;
389 my @itemswaiting = C4::Reserves::GetReservesFromBorrowernumber( $patroninformation->{'borrowernumber'},'W' );
390 my $nowaiting = scalar @itemswaiting;
391 if ( $nowaiting > 0 ) {
393 $flaginfo{'message'} = "Reserved items available";
394 $flaginfo{'itemlist'} = \@itemswaiting;
395 $flags{'WAITING'} = \%flaginfo;
403 $borrower = &GetMember(%information);
405 Retrieve the first patron record meeting on criteria listed in the
406 C<%information> hash, which should contain one or more
407 pairs of borrowers column names and values, e.g.,
409 $borrower = GetMember(borrowernumber => id);
411 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
412 the C<borrowers> table in the Koha database.
414 FIXME: GetMember() is used throughout the code as a lookup
415 on a unique key such as the borrowernumber, but this meaning is not
416 enforced in the routine itself.
422 my ( %information ) = @_;
423 if (exists $information{borrowernumber} && !defined $information{borrowernumber}) {
424 #passing mysql's kohaadmin?? Makes no sense as a query
427 my $dbh = C4::Context->dbh;
429 q{SELECT borrowers.*, categories.category_type, categories.description
431 LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
434 for (keys %information ) {
442 if (defined $information{$_}) {
444 push @values, $information{$_};
447 $select .= "$_ IS NULL";
450 $debug && warn $select, " ",values %information;
451 my $sth = $dbh->prepare("$select");
452 $sth->execute(map{$information{$_}} keys %information);
453 my $data = $sth->fetchall_arrayref({});
454 #FIXME interface to this routine now allows generation of a result set
455 #so whole array should be returned but bowhere in the current code expects this
463 =head2 GetMemberRelatives
465 @borrowernumbers = GetMemberRelatives($borrowernumber);
467 C<GetMemberRelatives> returns a borrowersnumber's list of guarantor/guarantees of the member given in parameter
471 sub GetMemberRelatives {
472 my $borrowernumber = shift;
473 my $dbh = C4::Context->dbh;
477 my $query = "SELECT guarantorid FROM borrowers WHERE borrowernumber=?";
478 my $sth = $dbh->prepare($query);
479 $sth->execute($borrowernumber);
480 my $data = $sth->fetchrow_arrayref();
481 push @glist, $data->[0] if $data->[0];
482 my $guarantor = $data->[0] ? $data->[0] : undef;
485 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
486 $sth = $dbh->prepare($query);
487 $sth->execute($borrowernumber);
488 while ($data = $sth->fetchrow_arrayref()) {
489 push @glist, $data->[0];
492 # Getting sibling guarantees
494 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
495 $sth = $dbh->prepare($query);
496 $sth->execute($guarantor);
497 while ($data = $sth->fetchrow_arrayref()) {
498 push @glist, $data->[0] if ($data->[0] != $borrowernumber);
505 =head2 IsMemberBlocked
507 my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
509 Returns whether a patron is restricted or has overdue items that may result
510 in a block of circulation privileges.
512 C<$block_status> can have the following values:
514 1 if the patron is currently restricted, in which case
515 C<$count> is the expiration date (9999-12-31 for indefinite)
517 -1 if the patron has overdue items, in which case C<$count> is the number of them
519 0 if the patron has no overdue items or outstanding fine days, in which case C<$count> is 0
521 Existing active restrictions are checked before current overdue items.
525 sub IsMemberBlocked {
526 my $borrowernumber = shift;
527 my $dbh = C4::Context->dbh;
529 my $blockeddate = Koha::Borrower::Debarments::IsDebarred($borrowernumber);
531 return ( 1, $blockeddate ) if $blockeddate;
533 # if he have late issues
534 my $sth = $dbh->prepare(
535 "SELECT COUNT(*) as latedocs
537 WHERE borrowernumber = ?
538 AND date_due < now()"
540 $sth->execute($borrowernumber);
541 my $latedocs = $sth->fetchrow_hashref->{'latedocs'};
543 return ( -1, $latedocs ) if $latedocs > 0;
548 =head2 GetMemberIssuesAndFines
550 ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
552 Returns aggregate data about items borrowed by the patron with the
553 given borrowernumber.
555 C<&GetMemberIssuesAndFines> returns a three-element array. C<$overdue_count> is the
556 number of overdue items the patron currently has borrowed. C<$issue_count> is the
557 number of books the patron currently has borrowed. C<$total_fines> is
558 the total fine currently due by the borrower.
563 sub GetMemberIssuesAndFines {
564 my ( $borrowernumber ) = @_;
565 my $dbh = C4::Context->dbh;
566 my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
568 $debug and warn $query."\n";
569 my $sth = $dbh->prepare($query);
570 $sth->execute($borrowernumber);
571 my $issue_count = $sth->fetchrow_arrayref->[0];
573 $sth = $dbh->prepare(
574 "SELECT COUNT(*) FROM issues
575 WHERE borrowernumber = ?
576 AND date_due < now()"
578 $sth->execute($borrowernumber);
579 my $overdue_count = $sth->fetchrow_arrayref->[0];
581 $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
582 $sth->execute($borrowernumber);
583 my $total_fines = $sth->fetchrow_arrayref->[0];
585 return ($overdue_count, $issue_count, $total_fines);
591 my @columns = C4::Member::columns();
593 Returns an array of borrowers' table columns on success,
594 and an empty array on failure.
600 # Pure ANSI SQL goodness.
601 my $sql = 'SELECT * FROM borrowers WHERE 1=0;';
603 # Get the database handle.
604 my $dbh = C4::Context->dbh;
606 # Run the SQL statement to load STH's readonly properties.
607 my $sth = $dbh->prepare($sql);
608 my $rv = $sth->execute();
610 # This only fails if the table doesn't exist.
611 # This will always be called AFTER an install or upgrade,
612 # so borrowers will exist!
614 if ($sth->{NUM_OF_FIELDS}>0) {
615 @data = @{$sth->{NAME}};
626 my $success = ModMember(borrowernumber => $borrowernumber,
627 [ field => value ]... );
629 Modify borrower's data. All date fields should ALREADY be in ISO format.
632 true on success, or false on failure
638 # test to know if you must update or not the borrower password
639 if (exists $data{password}) {
640 if ($data{password} eq '****' or $data{password} eq '') {
641 delete $data{password};
643 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
644 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
645 Koha::NorwegianPatronDB::NLUpdateHashedPIN( $data{'borrowernumber'}, $data{password} );
647 $data{password} = hash_password($data{password});
650 my $old_categorycode = GetBorrowerCategorycode( $data{borrowernumber} );
652 # get only the columns of a borrower
653 my $schema = Koha::Database->new()->schema;
654 my @columns = $schema->source('Borrower')->columns;
655 my $new_borrower = { map { join(' ', @columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) };
656 delete $new_borrower->{flags};
658 $new_borrower->{dateofbirth} ||= undef if exists $new_borrower->{dateofbirth};
659 $new_borrower->{dateenrolled} ||= undef if exists $new_borrower->{dateenrolled};
660 $new_borrower->{dateexpiry} ||= undef if exists $new_borrower->{dateexpiry};
661 $new_borrower->{debarred} ||= undef if exists $new_borrower->{debarred};
662 my $rs = $schema->resultset('Borrower')->search({
663 borrowernumber => $new_borrower->{borrowernumber},
665 my $execute_success = $rs->update($new_borrower);
666 if ($execute_success ne '0E0') { # only proceed if the update was a success
667 # ok if its an adult (type) it may have borrowers that depend on it as a guarantor
668 # so when we update information for an adult we should check for guarantees and update the relevant part
669 # of their records, ie addresses and phone numbers
670 my $borrowercategory= GetBorrowercategory( $data{'category_type'} );
671 if ( exists $borrowercategory->{'category_type'} && $borrowercategory->{'category_type'} eq ('A' || 'S') ) {
672 # is adult check guarantees;
673 UpdateGuarantees(%data);
676 # If the patron changes to a category with enrollment fee, we add a fee
677 if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
678 if ( C4::Context->preference('FeeOnChangePatronCategory') ) {
679 AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
683 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
684 # cronjob will use for syncing with NL
685 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
686 my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
687 'synctype' => 'norwegianpatrondb',
688 'borrowernumber' => $data{'borrowernumber'}
690 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
691 # we can sync as changed. And the "new sync" will pick up all changes since
692 # the patron was created anyway.
693 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
694 $borrowersync->update( { 'syncstatus' => 'edited' } );
696 # Set the value of 'sync'
697 $borrowersync->update( { 'sync' => $data{'sync'} } );
698 # Try to do the live sync
699 Koha::NorwegianPatronDB::NLSync({ 'borrowernumber' => $data{'borrowernumber'} });
702 logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
704 return $execute_success;
709 $borrowernumber = &AddMember(%borrower);
711 insert new borrower into table
713 (%borrower keys are database columns. Database columns could be
714 different in different versions. Please look into database for correct
717 Returns the borrowernumber upon success
719 Returns as undef upon any db error without further processing
726 my $dbh = C4::Context->dbh;
727 my $schema = Koha::Database->new()->schema;
729 # generate a proper login if none provided
730 $data{'userid'} = Generate_Userid( $data{'borrowernumber'}, $data{'firstname'}, $data{'surname'} )
731 if ( $data{'userid'} eq '' || !Check_Userid( $data{'userid'} ) );
733 # add expiration date if it isn't already there
734 unless ( $data{'dateexpiry'} ) {
735 $data{'dateexpiry'} = GetExpiryDate( $data{'categorycode'}, output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } ) );
738 # add enrollment date if it isn't already there
739 unless ( $data{'dateenrolled'} ) {
740 $data{'dateenrolled'} = output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
743 my $patron_category = $schema->resultset('Category')->find( $data{'categorycode'} );
745 $patron_category->default_privacy() eq 'default' ? 1
746 : $patron_category->default_privacy() eq 'never' ? 2
747 : $patron_category->default_privacy() eq 'forever' ? 0
749 # Make a copy of the plain text password for later use
750 my $plain_text_password = $data{'password'};
752 # create a disabled account if no password provided
753 $data{'password'} = ($data{'password'})? hash_password($data{'password'}) : '!';
755 # we don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00
756 $data{'dateofbirth'} = undef if( not $data{'dateofbirth'} );
757 $data{'debarred'} = undef if ( not $data{'debarred'} );
759 # get only the columns of Borrower
760 my @columns = $schema->source('Borrower')->columns;
761 my $new_member = { map { join(' ',@columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) } ;
762 delete $new_member->{borrowernumber};
764 my $rs = $schema->resultset('Borrower');
765 $data{borrowernumber} = $rs->create($new_member)->id;
767 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
768 # cronjob will use for syncing with NL
769 if ( exists $data{'borrowernumber'} && C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
770 Koha::Database->new->schema->resultset('BorrowerSync')->create({
771 'borrowernumber' => $data{'borrowernumber'},
772 'synctype' => 'norwegianpatrondb',
774 'syncstatus' => 'new',
775 'hashed_pin' => Koha::NorwegianPatronDB::NLEncryptPIN( $plain_text_password ),
779 # mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
780 logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
782 AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
784 return $data{borrowernumber};
789 my $uniqueness = Check_Userid($userid,$borrowernumber);
791 $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 != '').
793 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.
796 0 for not unique (i.e. this $userid already exists)
797 1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
802 my ( $uid, $borrowernumber ) = @_;
804 return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
806 return 0 if ( $uid eq C4::Context->config('user') );
808 my $rs = Koha::Database->new()->schema()->resultset('Borrower');
811 $params->{userid} = $uid;
812 $params->{borrowernumber} = { '!=' => $borrowernumber } if ($borrowernumber);
814 my $count = $rs->count( $params );
816 return $count ? 0 : 1;
819 =head2 Generate_Userid
821 my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
823 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
825 $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.
828 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).
832 sub Generate_Userid {
833 my ($borrowernumber, $firstname, $surname) = @_;
836 #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
838 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
839 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
840 $newuid = lc(($firstname)? "$firstname.$surname" : $surname);
841 $newuid = unac_string('utf-8',$newuid);
842 $newuid .= $offset unless $offset == 0;
845 } while (!Check_Userid($newuid,$borrowernumber));
851 my ( $uid, $member, $digest ) = @_;
852 my $dbh = C4::Context->dbh;
854 #Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
855 #Then we need to tell the user and have them create a new one.
859 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
860 $sth->execute( $uid, $member );
861 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
865 #Everything is good so we can update the information.
868 "update borrowers set userid=?, password=? where borrowernumber=?");
869 $sth->execute( $uid, $digest, $member );
873 logaction("MEMBERS", "CHANGE PASS", $member, "") if C4::Context->preference("BorrowersLog");
879 =head2 fixup_cardnumber
881 Warning: The caller is responsible for locking the members table in write
882 mode, to avoid database corruption.
886 use vars qw( @weightings );
887 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
889 sub fixup_cardnumber {
890 my ($cardnumber) = @_;
891 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
893 # Find out whether member numbers should be generated
894 # automatically. Should be either "1" or something else.
895 # Defaults to "0", which is interpreted as "no".
897 # if ($cardnumber !~ /\S/ && $autonumber_members) {
898 ($autonumber_members) or return $cardnumber;
899 my $checkdigit = C4::Context->preference('checkdigit');
900 my $dbh = C4::Context->dbh;
901 if ( $checkdigit and $checkdigit eq 'katipo' ) {
903 # if checkdigit is selected, calculate katipo-style cardnumber.
904 # otherwise, just use the max()
905 # purpose: generate checksum'd member numbers.
906 # We'll assume we just got the max value of digits 2-8 of member #'s
907 # from the database and our job is to increment that by one,
908 # determine the 1st and 9th digits and return the full string.
909 my $sth = $dbh->prepare(
910 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
913 my $data = $sth->fetchrow_hashref;
914 $cardnumber = $data->{new_num};
915 if ( !$cardnumber ) { # If DB has no values,
916 $cardnumber = 1000000; # start at 1000000
922 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
923 # read weightings, left to right, 1 char at a time
924 my $temp1 = $weightings[$i];
926 # sequence left to right, 1 char at a time
927 my $temp2 = substr( $cardnumber, $i, 1 );
929 # mult each char 1-7 by its corresponding weighting
930 $sum += $temp1 * $temp2;
933 my $rem = ( $sum % 11 );
934 $rem = 'X' if $rem == 10;
936 return "V$cardnumber$rem";
939 my $sth = $dbh->prepare(
940 'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
943 my ($result) = $sth->fetchrow;
946 return $cardnumber; # just here as a fallback/reminder
951 ($num_children, $children_arrayref) = &GetGuarantees($parent_borrno);
952 $child0_cardno = $children_arrayref->[0]{"cardnumber"};
953 $child0_borrno = $children_arrayref->[0]{"borrowernumber"};
955 C<&GetGuarantees> takes a borrower number (e.g., that of a patron
956 with children) and looks up the borrowers who are guaranteed by that
957 borrower (i.e., the patron's children).
959 C<&GetGuarantees> returns two values: an integer giving the number of
960 borrowers guaranteed by C<$parent_borrno>, and a reference to an array
961 of references to hash, which gives the actual results.
967 my ($borrowernumber) = @_;
968 my $dbh = C4::Context->dbh;
971 "select cardnumber,borrowernumber, firstname, surname from borrowers where guarantorid=?"
973 $sth->execute($borrowernumber);
976 my $data = $sth->fetchall_arrayref({});
977 return ( scalar(@$data), $data );
980 =head2 UpdateGuarantees
982 &UpdateGuarantees($parent_borrno);
985 C<&UpdateGuarantees> borrower data for an adult and updates all the guarantees
986 with the modified information
991 sub UpdateGuarantees {
993 my $dbh = C4::Context->dbh;
994 my ( $count, $guarantees ) = GetGuarantees( $data{'borrowernumber'} );
995 foreach my $guarantee (@$guarantees){
996 my $guaquery = qq|UPDATE borrowers
997 SET address=?,fax=?,B_city=?,mobile=?,city=?,phone=?
998 WHERE borrowernumber=?
1000 my $sth = $dbh->prepare($guaquery);
1001 $sth->execute($data{'address'},$data{'fax'},$data{'B_city'},$data{'mobile'},$data{'city'},$data{'phone'},$guarantee->{'borrowernumber'});
1004 =head2 GetPendingIssues
1006 my $issues = &GetPendingIssues(@borrowernumber);
1008 Looks up what the patron with the given borrowernumber has borrowed.
1010 C<&GetPendingIssues> returns a
1011 reference-to-array where each element is a reference-to-hash; the
1012 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
1013 The keys include C<biblioitems> fields except marc and marcxml.
1018 sub GetPendingIssues {
1019 my @borrowernumbers = @_;
1021 unless (@borrowernumbers ) { # return a ref_to_array
1022 return \@borrowernumbers; # to not cause surprise to caller
1025 # Borrowers part of the query
1027 for (my $i = 0; $i < @borrowernumbers; $i++) {
1028 $bquery .= ' issues.borrowernumber = ?';
1029 if ($i < $#borrowernumbers ) {
1034 # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
1035 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
1036 # FIXME: circ/ciculation.pl tries to sort by timestamp!
1037 # FIXME: namespace collision: other collisions possible.
1038 # FIXME: most of this data isn't really being used by callers.
1045 biblioitems.itemtype,
1048 biblioitems.publicationyear,
1049 biblioitems.publishercode,
1050 biblioitems.volumedate,
1051 biblioitems.volumedesc,
1054 borrowers.firstname,
1056 borrowers.cardnumber,
1057 issues.timestamp AS timestamp,
1058 issues.renewals AS renewals,
1059 issues.borrowernumber AS borrowernumber,
1060 items.renewals AS totalrenewals
1062 LEFT JOIN items ON items.itemnumber = issues.itemnumber
1063 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1064 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
1065 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
1068 ORDER BY issues.issuedate"
1071 my $sth = C4::Context->dbh->prepare($query);
1072 $sth->execute(@borrowernumbers);
1073 my $data = $sth->fetchall_arrayref({});
1074 my $today = dt_from_string;
1075 foreach (@{$data}) {
1076 if ($_->{issuedate}) {
1077 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
1079 $_->{date_due_sql} = $_->{date_due};
1080 # FIXME no need to have this value
1081 $_->{date_due} or next;
1082 $_->{date_due_sql} = $_->{date_due};
1083 # FIXME no need to have this value
1084 $_->{date_due} = dt_from_string($_->{date_due}, 'sql');
1085 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
1094 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
1096 Looks up what the patron with the given borrowernumber has borrowed,
1097 and sorts the results.
1099 C<$sortkey> is the name of a field on which to sort the results. This
1100 should be the name of a field in the C<issues>, C<biblio>,
1101 C<biblioitems>, or C<items> table in the Koha database.
1103 C<$limit> is the maximum number of results to return.
1105 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
1106 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
1107 C<items> tables of the Koha database.
1113 my ( $borrowernumber, $order, $limit ) = @_;
1115 return unless $borrowernumber;
1116 $order = 'date_due desc' unless $order;
1118 my $dbh = C4::Context->dbh;
1120 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1122 LEFT JOIN items on items.itemnumber=issues.itemnumber
1123 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1124 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1125 WHERE borrowernumber=?
1127 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1129 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
1130 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1131 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1132 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
1133 order by ' . $order;
1135 $query .= " limit $limit";
1138 my $sth = $dbh->prepare($query);
1139 $sth->execute( $borrowernumber, $borrowernumber );
1140 return $sth->fetchall_arrayref( {} );
1144 =head2 GetMemberAccountRecords
1146 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
1148 Looks up accounting data for the patron with the given borrowernumber.
1150 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
1151 reference-to-array, where each element is a reference-to-hash; the
1152 keys are the fields of the C<accountlines> table in the Koha database.
1153 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1154 total amount outstanding for all of the account lines.
1158 sub GetMemberAccountRecords {
1159 my ($borrowernumber) = @_;
1160 my $dbh = C4::Context->dbh;
1166 WHERE borrowernumber=?);
1167 $strsth.=" ORDER BY accountlines_id desc";
1168 my $sth= $dbh->prepare( $strsth );
1169 $sth->execute( $borrowernumber );
1172 while ( my $data = $sth->fetchrow_hashref ) {
1173 if ( $data->{itemnumber} ) {
1174 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1175 $data->{biblionumber} = $biblio->{biblionumber};
1176 $data->{title} = $biblio->{title};
1178 $acctlines[$numlines] = $data;
1180 $total += int(1000 * $data->{'amountoutstanding'}); # convert float to integer to avoid round-off errors
1183 return ( $total, \@acctlines,$numlines);
1186 =head2 GetMemberAccountBalance
1188 ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
1190 Calculates amount immediately owing by the patron - non-issue charges.
1191 Based on GetMemberAccountRecords.
1192 Charges exempt from non-issue are:
1194 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
1195 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
1199 sub GetMemberAccountBalance {
1200 my ($borrowernumber) = @_;
1202 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
1205 push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
1206 push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
1207 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
1208 my $dbh = C4::Context->dbh;
1209 my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
1210 push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
1212 my %not_fine = map {$_ => 1} @not_fines;
1214 my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
1215 my $other_charges = 0;
1216 foreach (@$acctlines) {
1217 $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
1220 return ( $total, $total - $other_charges, $other_charges);
1223 =head2 GetBorNotifyAcctRecord
1225 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1227 Looks up accounting data for the patron with the given borrowernumber per file number.
1229 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1230 reference-to-array, where each element is a reference-to-hash; the
1231 keys are the fields of the C<accountlines> table in the Koha database.
1232 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1233 total amount outstanding for all of the account lines.
1237 sub GetBorNotifyAcctRecord {
1238 my ( $borrowernumber, $notifyid ) = @_;
1239 my $dbh = C4::Context->dbh;
1242 my $sth = $dbh->prepare(
1245 WHERE borrowernumber=?
1247 AND amountoutstanding != '0'
1248 ORDER BY notify_id,accounttype
1251 $sth->execute( $borrowernumber, $notifyid );
1253 while ( my $data = $sth->fetchrow_hashref ) {
1254 if ( $data->{itemnumber} ) {
1255 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1256 $data->{biblionumber} = $biblio->{biblionumber};
1257 $data->{title} = $biblio->{title};
1259 $acctlines[$numlines] = $data;
1261 $total += int(100 * $data->{'amountoutstanding'});
1264 return ( $total, \@acctlines, $numlines );
1267 =head2 checkuniquemember (OUEST-PROVENCE)
1269 ($result,$categorycode) = &checkuniquemember($collectivity,$surname,$firstname,$dateofbirth);
1271 Checks that a member exists or not in the database.
1273 C<&result> is nonzero (=exist) or 0 (=does not exist)
1274 C<&categorycode> is from categorycode table
1275 C<&collectivity> is 1 (= we add a collectivity) or 0 (= we add a physical member)
1276 C<&surname> is the surname
1277 C<&firstname> is the firstname (only if collectivity=0)
1278 C<&dateofbirth> is the date of birth in ISO format (only if collectivity=0)
1282 # FIXME: This function is not legitimate. Multiple patrons might have the same first/last name and birthdate.
1283 # This is especially true since first name is not even a required field.
1285 sub checkuniquemember {
1286 my ( $collectivity, $surname, $firstname, $dateofbirth ) = @_;
1287 my $dbh = C4::Context->dbh;
1288 my $request = ($collectivity) ?
1289 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? " :
1291 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=? and dateofbirth=?" :
1292 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?";
1293 my $sth = $dbh->prepare($request);
1294 if ($collectivity) {
1295 $sth->execute( uc($surname) );
1296 } elsif($dateofbirth){
1297 $sth->execute( uc($surname), ucfirst($firstname), $dateofbirth );
1299 $sth->execute( uc($surname), ucfirst($firstname));
1301 my @data = $sth->fetchrow;
1302 ( $data[0] ) and return $data[0], $data[1];
1306 sub checkcardnumber {
1307 my ( $cardnumber, $borrowernumber ) = @_;
1309 # If cardnumber is null, we assume they're allowed.
1310 return 0 unless defined $cardnumber;
1312 my $dbh = C4::Context->dbh;
1313 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1314 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1315 my $sth = $dbh->prepare($query);
1318 ( $borrowernumber ? $borrowernumber : () )
1321 return 1 if $sth->fetchrow_hashref;
1323 my ( $min_length, $max_length ) = get_cardnumber_length();
1325 if length $cardnumber > $max_length
1326 or length $cardnumber < $min_length;
1331 =head2 get_cardnumber_length
1333 my ($min, $max) = C4::Members::get_cardnumber_length()
1335 Returns the minimum and maximum length for patron cardnumbers as
1336 determined by the CardnumberLength system preference, the
1337 BorrowerMandatoryField system preference, and the width of the
1342 sub get_cardnumber_length {
1343 my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
1344 $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
1345 if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
1346 # Is integer and length match
1347 if ( $cardnumber_length =~ m|^\d+$| ) {
1348 $min = $max = $cardnumber_length
1349 if $cardnumber_length >= $min
1350 and $cardnumber_length <= $max;
1352 # Else assuming it is a range
1353 elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
1354 $min = $1 if $1 and $min < $1;
1355 $max = $2 if $2 and $max > $2;
1359 return ( $min, $max );
1362 =head2 getzipnamecity (OUEST-PROVENCE)
1364 take all info from table city for the fields city and zip
1365 check for the name and the zip code of the city selected
1369 sub getzipnamecity {
1371 my $dbh = C4::Context->dbh;
1374 "select city_name,city_state,city_zipcode,city_country from cities where cityid=? ");
1375 $sth->execute($cityid);
1376 my @data = $sth->fetchrow;
1377 return $data[0], $data[1], $data[2], $data[3];
1381 =head2 getdcity (OUEST-PROVENCE)
1383 recover cityid with city_name condition
1388 my ($city_name) = @_;
1389 my $dbh = C4::Context->dbh;
1390 my $sth = $dbh->prepare("select cityid from cities where city_name=? ");
1391 $sth->execute($city_name);
1392 my $data = $sth->fetchrow;
1396 =head2 GetFirstValidEmailAddress
1398 $email = GetFirstValidEmailAddress($borrowernumber);
1400 Return the first valid email address for a borrower, given the borrowernumber. For now, the order
1401 is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
1406 sub GetFirstValidEmailAddress {
1407 my $borrowernumber = shift;
1408 my $dbh = C4::Context->dbh;
1409 my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1410 $sth->execute( $borrowernumber );
1411 my $data = $sth->fetchrow_hashref;
1413 if ($data->{'email'}) {
1414 return $data->{'email'};
1415 } elsif ($data->{'emailpro'}) {
1416 return $data->{'emailpro'};
1417 } elsif ($data->{'B_email'}) {
1418 return $data->{'B_email'};
1424 =head2 GetNoticeEmailAddress
1426 $email = GetNoticeEmailAddress($borrowernumber);
1428 Return the email address of borrower used for notices, given the borrowernumber.
1429 Returns the empty string if no email address.
1433 sub GetNoticeEmailAddress {
1434 my $borrowernumber = shift;
1436 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1437 # if syspref is set to 'first valid' (value == OFF), look up email address
1438 if ( $which_address eq 'OFF' ) {
1439 return GetFirstValidEmailAddress($borrowernumber);
1441 # specified email address field
1442 my $dbh = C4::Context->dbh;
1443 my $sth = $dbh->prepare( qq{
1444 SELECT $which_address AS primaryemail
1446 WHERE borrowernumber=?
1448 $sth->execute($borrowernumber);
1449 my $data = $sth->fetchrow_hashref;
1450 return $data->{'primaryemail'} || '';
1453 =head2 GetExpiryDate
1455 $expirydate = GetExpiryDate($categorycode, $dateenrolled);
1457 Calculate expiry date given a categorycode and starting date. Date argument must be in ISO format.
1458 Return date is also in ISO format.
1463 my ( $categorycode, $dateenrolled ) = @_;
1465 if ($categorycode) {
1466 my $dbh = C4::Context->dbh;
1467 my $sth = $dbh->prepare("SELECT enrolmentperiod,enrolmentperioddate FROM categories WHERE categorycode=?");
1468 $sth->execute($categorycode);
1469 $enrolments = $sth->fetchrow_hashref;
1471 # die "GetExpiryDate: for enrollmentperiod $enrolmentperiod (category '$categorycode') starting $dateenrolled.\n";
1472 my @date = split (/-/,$dateenrolled);
1473 if($enrolments->{enrolmentperiod}){
1474 return sprintf("%04d-%02d-%02d", Add_Delta_YM(@date,0,$enrolments->{enrolmentperiod}));
1476 return $enrolments->{enrolmentperioddate};
1480 =head2 GetUpcomingMembershipExpires
1482 my $upcoming_mem_expires = GetUpcomingMembershipExpires();
1486 sub GetUpcomingMembershipExpires {
1487 my $dbh = C4::Context->dbh;
1488 my $days = C4::Context->preference("MembershipExpiryDaysNotice") || 0;
1489 my $dateexpiry = output_pref({ dt => (dt_from_string()->add( days => $days)), dateformat => 'iso', dateonly => 1 });
1492 SELECT borrowers.*, categories.description,
1493 branches.branchname, branches.branchemail FROM borrowers
1494 LEFT JOIN branches on borrowers.branchcode = branches.branchcode
1495 LEFT JOIN categories on borrowers.categorycode = categories.categorycode
1496 WHERE dateexpiry = ?;
1498 my $sth = $dbh->prepare($query);
1499 $sth->execute($dateexpiry);
1500 my $results = $sth->fetchall_arrayref({});
1504 =head2 GetborCatFromCatType
1506 ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
1508 Looks up the different types of borrowers in the database. Returns two
1509 elements: a reference-to-array, which lists the borrower category
1510 codes, and a reference-to-hash, which maps the borrower category codes
1511 to category descriptions.
1516 sub GetborCatFromCatType {
1517 my ( $category_type, $action, $no_branch_limit ) = @_;
1519 my $branch_limit = $no_branch_limit
1521 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1523 # FIXME - This API seems both limited and dangerous.
1524 my $dbh = C4::Context->dbh;
1527 SELECT categories.categorycode, categories.description
1531 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1534 $request .= " $action ";
1535 $request .= " AND (branchcode = ? OR branchcode IS NULL) GROUP BY description" if $branch_limit;
1537 $request .= " WHERE branchcode = ? OR branchcode IS NULL GROUP BY description" if $branch_limit;
1539 $request .= " ORDER BY categorycode";
1541 my $sth = $dbh->prepare($request);
1543 $action ? $category_type : (),
1544 $branch_limit ? $branch_limit : ()
1550 while ( my $data = $sth->fetchrow_hashref ) {
1551 push @codes, $data->{'categorycode'};
1552 $labels{ $data->{'categorycode'} } = $data->{'description'};
1555 return ( \@codes, \%labels );
1558 =head2 GetBorrowercategory
1560 $hashref = &GetBorrowercategory($categorycode);
1562 Given the borrower's category code, the function returns the corresponding
1563 data hashref for a comprehensive information display.
1567 sub GetBorrowercategory {
1569 my $dbh = C4::Context->dbh;
1573 "SELECT description,dateofbirthrequired,upperagelimit,category_type
1575 WHERE categorycode = ?"
1577 $sth->execute($catcode);
1579 $sth->fetchrow_hashref;
1583 } # sub getborrowercategory
1586 =head2 GetBorrowerCategorycode
1588 $categorycode = &GetBorrowerCategoryCode( $borrowernumber );
1590 Given the borrowernumber, the function returns the corresponding categorycode
1594 sub GetBorrowerCategorycode {
1595 my ( $borrowernumber ) = @_;
1596 my $dbh = C4::Context->dbh;
1597 my $sth = $dbh->prepare( qq{
1600 WHERE borrowernumber = ?
1602 $sth->execute( $borrowernumber );
1603 return $sth->fetchrow;
1606 =head2 GetBorrowercategoryList
1608 $arrayref_hashref = &GetBorrowercategoryList;
1609 If no category code provided, the function returns all the categories.
1613 sub GetBorrowercategoryList {
1614 my $no_branch_limit = @_ ? shift : 0;
1615 my $branch_limit = $no_branch_limit
1617 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1618 my $dbh = C4::Context->dbh;
1619 my $query = "SELECT categories.* FROM categories";
1621 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1622 WHERE branchcode = ? OR branchcode IS NULL GROUP BY description
1624 $query .= " ORDER BY description";
1625 my $sth = $dbh->prepare( $query );
1626 $sth->execute( $branch_limit ? $branch_limit : () );
1627 my $data = $sth->fetchall_arrayref( {} );
1630 } # sub getborrowercategory
1634 $dateofbirth,$date = &GetAge($date);
1636 this function return the borrowers age with the value of dateofbirth
1642 my ( $date, $date_ref ) = @_;
1644 if ( not defined $date_ref ) {
1645 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1648 my ( $year1, $month1, $day1 ) = split /-/, $date;
1649 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1651 my $age = $year2 - $year1;
1652 if ( $month1 . $day1 > $month2 . $day2 ) {
1661 $borrower = C4::Members::SetAge($borrower, $datetimeduration);
1662 $borrower = C4::Members::SetAge($borrower, '0015-12-10');
1663 $borrower = C4::Members::SetAge($borrower, $datetimeduration, $datetime_reference);
1665 eval { $borrower = C4::Members::SetAge($borrower, '015-1-10'); };
1666 if ($@) {print $@;} #Catch a bad ISO Date or kill your script!
1668 This function sets the borrower's dateofbirth to match the given age.
1669 Optionally relative to the given $datetime_reference.
1671 @PARAM1 koha.borrowers-object
1672 @PARAM2 DateTime::Duration-object as the desired age
1673 OR a ISO 8601 Date. (To make the API more pleasant)
1674 @PARAM3 DateTime-object as the relative date, defaults to now().
1675 RETURNS The given borrower reference @PARAM1.
1676 DIES If there was an error with the ISO Date handling.
1682 my ( $borrower, $datetimeduration, $datetime_ref ) = @_;
1683 $datetime_ref = DateTime->now() unless $datetime_ref;
1685 if ($datetimeduration && ref $datetimeduration ne 'DateTime::Duration') {
1686 if ($datetimeduration =~ /^(\d{4})-(\d{2})-(\d{2})/) {
1687 $datetimeduration = DateTime::Duration->new(years => $1, months => $2, days => $3);
1690 die "C4::Members::SetAge($borrower, $datetimeduration), datetimeduration not a valid ISO 8601 Date!\n";
1694 my $new_datetime_ref = $datetime_ref->clone();
1695 $new_datetime_ref->subtract_duration( $datetimeduration );
1697 $borrower->{dateofbirth} = $new_datetime_ref->ymd();
1704 $cityarrayref = GetCities();
1706 Returns an array_ref of the entries in the cities table
1707 If there are entries in the table an empty row is returned
1708 This is currently only used to populate a popup in memberentry
1714 my $dbh = C4::Context->dbh;
1715 my $city_arr = $dbh->selectall_arrayref(
1716 q|SELECT cityid,city_zipcode,city_name,city_state,city_country FROM cities ORDER BY city_name|,
1718 if ( @{$city_arr} ) {
1719 unshift @{$city_arr}, {
1720 city_zipcode => q{},
1724 city_country => q{},
1731 =head2 GetSortDetails (OUEST-PROVENCE)
1733 ($lib) = &GetSortDetails($category,$sortvalue);
1735 Returns the authorized value details
1736 C<&$lib>return value of authorized value details
1737 C<&$sortvalue>this is the value of authorized value
1738 C<&$category>this is the value of authorized value category
1742 sub GetSortDetails {
1743 my ( $category, $sortvalue ) = @_;
1744 my $dbh = C4::Context->dbh;
1745 my $query = qq|SELECT lib
1746 FROM authorised_values
1748 AND authorised_value=? |;
1749 my $sth = $dbh->prepare($query);
1750 $sth->execute( $category, $sortvalue );
1751 my $lib = $sth->fetchrow;
1752 return ($lib) if ($lib);
1753 return ($sortvalue) unless ($lib);
1756 =head2 MoveMemberToDeleted
1758 $result = &MoveMemberToDeleted($borrowernumber);
1760 Copy the record from borrowers to deletedborrowers table.
1761 The routine returns 1 for success, undef for failure.
1765 sub MoveMemberToDeleted {
1766 my ($member) = shift or return;
1768 my $schema = Koha::Database->new()->schema();
1769 my $borrowers_rs = $schema->resultset('Borrower');
1770 $borrowers_rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
1771 my $borrower = $borrowers_rs->find($member);
1772 return unless $borrower;
1774 my $deleted = $schema->resultset('Deletedborrower')->create($borrower);
1776 return $deleted ? 1 : undef;
1781 DelMember($borrowernumber);
1783 This function remove directly a borrower whitout writing it on deleteborrower.
1784 + Deletes reserves for the borrower
1789 my $dbh = C4::Context->dbh;
1790 my $borrowernumber = shift;
1791 #warn "in delmember with $borrowernumber";
1792 return unless $borrowernumber; # borrowernumber is mandatory.
1794 my $query = qq|DELETE
1796 WHERE borrowernumber=?|;
1797 my $sth = $dbh->prepare($query);
1798 $sth->execute($borrowernumber);
1802 WHERE borrowernumber = ?
1804 $sth = $dbh->prepare($query);
1805 $sth->execute($borrowernumber);
1806 logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
1810 =head2 HandleDelBorrower
1812 HandleDelBorrower($borrower);
1814 When a member is deleted (DelMember in Members.pm), you should call me first.
1815 This routine deletes/moves lists and entries for the deleted member/borrower.
1816 Lists owned by the borrower are deleted, but entries from the borrower to
1817 other lists are kept.
1821 sub HandleDelBorrower {
1824 my $dbh = C4::Context->dbh;
1826 #Delete all lists and all shares of this borrower
1827 #Consistent with the approach Koha uses on deleting individual lists
1828 #Note that entries in virtualshelfcontents added by this borrower to
1829 #lists of others will be handled by a table constraint: the borrower
1830 #is set to NULL in those entries.
1831 $query="DELETE FROM virtualshelves WHERE owner=?";
1832 $dbh->do($query,undef,($borrower));
1835 #We could handle the above deletes via a constraint too.
1836 #But a new BZ report 11889 has been opened to discuss another approach.
1837 #Instead of deleting we could also disown lists (based on a pref).
1838 #In that way we could save shared and public lists.
1839 #The current table constraints support that idea now.
1840 #This pref should then govern the results of other routines/methods such as
1841 #Koha::Virtualshelf->new->delete too.
1844 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1846 $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1848 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1853 sub ExtendMemberSubscriptionTo {
1854 my ( $borrowerid,$date) = @_;
1855 my $dbh = C4::Context->dbh;
1856 my $borrower = GetMember('borrowernumber'=>$borrowerid);
1858 $date = (C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry') ?
1859 eval { output_pref( { dt => dt_from_string( $borrower->{'dateexpiry'} ), dateonly => 1, dateformat => 'iso' } ); }
1861 output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
1862 $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
1864 my $sth = $dbh->do(<<EOF);
1866 SET dateexpiry='$date'
1867 WHERE borrowernumber='$borrowerid'
1870 AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
1872 logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
1873 return $date if ($sth);
1877 =head2 GetTitles (OUEST-PROVENCE)
1879 ($borrowertitle)= &GetTitles();
1881 Looks up the different title . Returns array with all borrowers title
1886 my @borrowerTitle = split (/,|\|/,C4::Context->preference('BorrowersTitles'));
1887 unshift( @borrowerTitle, "" );
1888 my $count=@borrowerTitle;
1893 return ( \@borrowerTitle);
1897 =head2 GetPatronImage
1899 my ($imagedata, $dberror) = GetPatronImage($borrowernumber);
1901 Returns the mimetype and binary image data of the image for the patron with the supplied borrowernumber.
1905 sub GetPatronImage {
1906 my ($borrowernumber) = @_;
1907 warn "Borrowernumber passed to GetPatronImage is $borrowernumber" if $debug;
1908 my $dbh = C4::Context->dbh;
1909 my $query = 'SELECT mimetype, imagefile FROM patronimage WHERE borrowernumber = ?';
1910 my $sth = $dbh->prepare($query);
1911 $sth->execute($borrowernumber);
1912 my $imagedata = $sth->fetchrow_hashref;
1913 warn "Database error!" if $sth->errstr;
1914 return $imagedata, $sth->errstr;
1917 =head2 PutPatronImage
1919 PutPatronImage($cardnumber, $mimetype, $imgfile);
1921 Stores patron binary image data and mimetype in database.
1922 NOTE: This function is good for updating images as well as inserting new images in the database.
1926 sub PutPatronImage {
1927 my ($cardnumber, $mimetype, $imgfile) = @_;
1928 warn "Parameters passed in: Cardnumber=$cardnumber, Mimetype=$mimetype, " . ($imgfile ? "Imagefile" : "No Imagefile") if $debug;
1929 my $dbh = C4::Context->dbh;
1930 my $query = "INSERT INTO patronimage (borrowernumber, mimetype, imagefile) VALUES ( ( SELECT borrowernumber from borrowers WHERE cardnumber = ? ),?,?) ON DUPLICATE KEY UPDATE imagefile = ?;";
1931 my $sth = $dbh->prepare($query);
1932 $sth->execute($cardnumber,$mimetype,$imgfile,$imgfile);
1933 warn "Error returned inserting $cardnumber.$mimetype." if $sth->errstr;
1934 return $sth->errstr;
1937 =head2 RmPatronImage
1939 my ($dberror) = RmPatronImage($borrowernumber);
1941 Removes the image for the patron with the supplied borrowernumber.
1946 my ($borrowernumber) = @_;
1947 warn "Borrowernumber passed to GetPatronImage is $borrowernumber" if $debug;
1948 my $dbh = C4::Context->dbh;
1949 my $query = "DELETE FROM patronimage WHERE borrowernumber = ?;";
1950 my $sth = $dbh->prepare($query);
1951 $sth->execute($borrowernumber);
1952 my $dberror = $sth->errstr;
1953 warn "Database error!" if $sth->errstr;
1957 =head2 GetHideLostItemsPreference
1959 $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
1961 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
1962 C<&$hidelostitemspref>return value of function, 0 or 1
1966 sub GetHideLostItemsPreference {
1967 my ($borrowernumber) = @_;
1968 my $dbh = C4::Context->dbh;
1969 my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
1970 my $sth = $dbh->prepare($query);
1971 $sth->execute($borrowernumber);
1972 my $hidelostitems = $sth->fetchrow;
1973 return $hidelostitems;
1976 =head2 GetBorrowersToExpunge
1978 $borrowers = &GetBorrowersToExpunge(
1979 not_borrowered_since => $not_borrowered_since,
1980 expired_before => $expired_before,
1981 category_code => $category_code,
1982 branchcode => $branchcode
1985 This function get all borrowers based on the given criteria.
1989 sub GetBorrowersToExpunge {
1992 my $filterdate = $params->{'not_borrowered_since'};
1993 my $filterexpiry = $params->{'expired_before'};
1994 my $filtercategory = $params->{'category_code'};
1995 my $filterbranch = $params->{'branchcode'} ||
1996 ((C4::Context->preference('IndependentBranches')
1997 && C4::Context->userenv
1998 && !C4::Context->IsSuperLibrarian()
1999 && C4::Context->userenv->{branch})
2000 ? C4::Context->userenv->{branch}
2003 my $dbh = C4::Context->dbh;
2005 SELECT borrowers.borrowernumber,
2006 MAX(old_issues.timestamp) AS latestissue,
2007 MAX(issues.timestamp) AS currentissue
2009 JOIN categories USING (categorycode)
2013 WHERE guarantorid IS NOT NULL
2014 AND guarantorid <> 0
2015 ) as tmp ON borrowers.borrowernumber=tmp.guarantorid
2016 LEFT JOIN old_issues USING (borrowernumber)
2017 LEFT JOIN issues USING (borrowernumber)
2018 WHERE category_type <> 'S'
2019 AND tmp.guarantorid IS NULL
2023 if ( $filterbranch && $filterbranch ne "" ) {
2024 $query.= " AND borrowers.branchcode = ? ";
2025 push( @query_params, $filterbranch );
2027 if ( $filterexpiry ) {
2028 $query .= " AND dateexpiry < ? ";
2029 push( @query_params, $filterexpiry );
2031 if ( $filtercategory ) {
2032 $query .= " AND categorycode = ? ";
2033 push( @query_params, $filtercategory );
2035 $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
2036 if ( $filterdate ) {
2037 $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
2038 push @query_params,$filterdate;
2040 warn $query if $debug;
2042 my $sth = $dbh->prepare($query);
2043 if (scalar(@query_params)>0){
2044 $sth->execute(@query_params);
2051 while ( my $data = $sth->fetchrow_hashref ) {
2052 push @results, $data;
2057 =head2 GetBorrowersWhoHaveNeverBorrowed
2059 $results = &GetBorrowersWhoHaveNeverBorrowed
2061 This function get all borrowers who have never borrowed.
2063 I<$result> is a ref to an array which all elements are a hasref.
2067 sub GetBorrowersWhoHaveNeverBorrowed {
2068 my $filterbranch = shift ||
2069 ((C4::Context->preference('IndependentBranches')
2070 && C4::Context->userenv
2071 && !C4::Context->IsSuperLibrarian()
2072 && C4::Context->userenv->{branch})
2073 ? C4::Context->userenv->{branch}
2075 my $dbh = C4::Context->dbh;
2077 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
2079 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
2080 WHERE issues.borrowernumber IS NULL
2083 if ($filterbranch && $filterbranch ne ""){
2084 $query.=" AND borrowers.branchcode= ?";
2085 push @query_params,$filterbranch;
2087 warn $query if $debug;
2089 my $sth = $dbh->prepare($query);
2090 if (scalar(@query_params)>0){
2091 $sth->execute(@query_params);
2098 while ( my $data = $sth->fetchrow_hashref ) {
2099 push @results, $data;
2104 =head2 GetBorrowersWithIssuesHistoryOlderThan
2106 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
2108 this function get all borrowers who has an issue history older than I<$date> given on input arg.
2110 I<$result> is a ref to an array which all elements are a hashref.
2111 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2115 sub GetBorrowersWithIssuesHistoryOlderThan {
2116 my $dbh = C4::Context->dbh;
2117 my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
2118 my $filterbranch = shift ||
2119 ((C4::Context->preference('IndependentBranches')
2120 && C4::Context->userenv
2121 && !C4::Context->IsSuperLibrarian()
2122 && C4::Context->userenv->{branch})
2123 ? C4::Context->userenv->{branch}
2126 SELECT count(borrowernumber) as n,borrowernumber
2128 WHERE returndate < ?
2129 AND borrowernumber IS NOT NULL
2132 push @query_params, $date;
2134 $query.=" AND branchcode = ?";
2135 push @query_params, $filterbranch;
2137 $query.=" GROUP BY borrowernumber ";
2138 warn $query if $debug;
2139 my $sth = $dbh->prepare($query);
2140 $sth->execute(@query_params);
2143 while ( my $data = $sth->fetchrow_hashref ) {
2144 push @results, $data;
2149 =head2 GetBorrowersNamesAndLatestIssue
2151 $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
2153 this function get borrowers Names and surnames and Issue information.
2155 I<@borrowernumbers> is an array which all elements are borrowernumbers.
2156 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2160 sub GetBorrowersNamesAndLatestIssue {
2161 my $dbh = C4::Context->dbh;
2162 my @borrowernumbers=@_;
2164 SELECT surname,lastname, phone, email,max(timestamp)
2166 LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
2167 GROUP BY borrowernumber
2169 my $sth = $dbh->prepare($query);
2171 my $results = $sth->fetchall_arrayref({});
2177 my $success = ModPrivacy( $borrowernumber, $privacy );
2179 Update the privacy of a patron.
2182 true on success, false on failure
2187 my $borrowernumber = shift;
2188 my $privacy = shift;
2189 return unless defined $borrowernumber;
2190 return unless $borrowernumber =~ /^\d+$/;
2192 return ModMember( borrowernumber => $borrowernumber,
2193 privacy => $privacy );
2198 AddMessage( $borrowernumber, $message_type, $message, $branchcode );
2200 Adds a message to the messages table for the given borrower.
2209 my ( $borrowernumber, $message_type, $message, $branchcode ) = @_;
2211 my $dbh = C4::Context->dbh;
2213 if ( ! ( $borrowernumber && $message_type && $message && $branchcode ) ) {
2217 my $query = "INSERT INTO messages ( borrowernumber, branchcode, message_type, message ) VALUES ( ?, ?, ?, ? )";
2218 my $sth = $dbh->prepare($query);
2219 $sth->execute( $borrowernumber, $branchcode, $message_type, $message );
2220 logaction("MEMBERS", "ADDCIRCMESSAGE", $borrowernumber, $message) if C4::Context->preference("BorrowersLog");
2226 GetMessages( $borrowernumber, $type );
2228 $type is message type, B for borrower, or L for Librarian.
2229 Empty type returns all messages of any type.
2231 Returns all messages for the given borrowernumber
2236 my ( $borrowernumber, $type, $branchcode ) = @_;
2242 my $dbh = C4::Context->dbh;
2245 branches.branchname,
2248 messages.branchcode LIKE '$branchcode' AS can_delete
2249 FROM messages, branches
2250 WHERE borrowernumber = ?
2251 AND message_type LIKE ?
2252 AND messages.branchcode = branches.branchcode
2253 ORDER BY message_date DESC";
2254 my $sth = $dbh->prepare($query);
2255 $sth->execute( $borrowernumber, $type ) ;
2258 while ( my $data = $sth->fetchrow_hashref ) {
2259 $data->{message_date_formatted} = output_pref( { dt => dt_from_string( $data->{message_date} ), dateonly => 1, dateformat => 'iso' } );
2260 push @results, $data;
2268 GetMessagesCount( $borrowernumber, $type );
2270 $type is message type, B for borrower, or L for Librarian.
2271 Empty type returns all messages of any type.
2273 Returns the number of messages for the given borrowernumber
2277 sub GetMessagesCount {
2278 my ( $borrowernumber, $type, $branchcode ) = @_;
2284 my $dbh = C4::Context->dbh;
2286 my $query = "SELECT COUNT(*) as MsgCount FROM messages WHERE borrowernumber = ? AND message_type LIKE ?";
2287 my $sth = $dbh->prepare($query);
2288 $sth->execute( $borrowernumber, $type ) ;
2291 my $data = $sth->fetchrow_hashref;
2292 my $count = $data->{'MsgCount'};
2299 =head2 DeleteMessage
2301 DeleteMessage( $message_id );
2306 my ( $message_id ) = @_;
2308 my $dbh = C4::Context->dbh;
2309 my $query = "SELECT * FROM messages WHERE message_id = ?";
2310 my $sth = $dbh->prepare($query);
2311 $sth->execute( $message_id );
2312 my $message = $sth->fetchrow_hashref();
2314 $query = "DELETE FROM messages WHERE message_id = ?";
2315 $sth = $dbh->prepare($query);
2316 $sth->execute( $message_id );
2317 logaction("MEMBERS", "DELCIRCMESSAGE", $message->{'borrowernumber'}, $message->{'message'}) if C4::Context->preference("BorrowersLog");
2322 IssueSlip($branchcode, $borrowernumber, $quickslip)
2324 Returns letter hash ( see C4::Letters::GetPreparedLetter )
2326 $quickslip is boolean, to indicate whether we want a quick slip
2328 IssueSlip populates ISSUESLIP and ISSUEQSLIP, and will make the following expansions:
2364 NOTE: Not all table fields are available, pleasee see GetPendingIssues for a list of available fields.
2369 my ($branch, $borrowernumber, $quickslip) = @_;
2371 # FIXME Check callers before removing this statement
2372 #return unless $borrowernumber;
2374 my @issues = @{ GetPendingIssues($borrowernumber) };
2376 for my $issue (@issues) {
2377 $issue->{date_due} = $issue->{date_due_sql};
2379 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
2380 if ( substr( $issue->{issuedate}, 0, 10 ) eq $today
2381 or substr( $issue->{lastreneweddate}, 0, 10 ) eq $today ) {
2387 # Sort on timestamp then on issuedate (useful for tests and could be if modified in a batch
2389 my $s = $b->{timestamp} <=> $a->{timestamp};
2391 $b->{issuedate} <=> $a->{issuedate} : $s;
2394 my ($letter_code, %repeat);
2396 $letter_code = 'ISSUEQSLIP';
2398 'checkedout' => [ map {
2401 'biblioitems' => $_,
2403 }, grep { $_->{'now'} } @issues ],
2407 $letter_code = 'ISSUESLIP';
2409 'checkedout' => [ map {
2412 'biblioitems' => $_,
2414 }, grep { !$_->{'overdue'} } @issues ],
2416 'overdue' => [ map {
2419 'biblioitems' => $_,
2421 }, grep { $_->{'overdue'} } @issues ],
2424 $_->{'timestamp'} = $_->{'newdate'};
2426 } @{ GetNewsToDisplay("slip",$branch) } ],
2430 return C4::Letters::GetPreparedLetter (
2431 module => 'circulation',
2432 letter_code => $letter_code,
2433 branchcode => $branch,
2435 'branches' => $branch,
2436 'borrowers' => $borrowernumber,
2442 =head2 GetBorrowersWithEmail
2444 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
2446 This gets a list of users and their basic details from their email address.
2447 As it's possible for multiple user to have the same email address, it provides
2448 you with all of them. If there is no userid for the user, there will be an
2449 C<undef> there. An empty list will be returned if there are no matches.
2453 sub GetBorrowersWithEmail {
2456 my $dbh = C4::Context->dbh;
2458 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
2459 my $sth=$dbh->prepare($query);
2460 $sth->execute($email);
2462 while (my $ref = $sth->fetch) {
2465 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
2469 =head2 AddMember_Opac
2473 sub AddMember_Opac {
2474 my ( %borrower ) = @_;
2476 $borrower{'categorycode'} = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2478 my $sr = new String::Random;
2479 $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
2480 my $password = $sr->randpattern("AAAAAAAAAA");
2481 $borrower{'password'} = $password;
2483 $borrower{'cardnumber'} = fixup_cardnumber();
2485 my $borrowernumber = AddMember(%borrower);
2487 return ( $borrowernumber, $password );
2490 =head2 AddEnrolmentFeeIfNeeded
2492 AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
2494 Add enrolment fee for a patron if needed.
2498 sub AddEnrolmentFeeIfNeeded {
2499 my ( $categorycode, $borrowernumber ) = @_;
2500 # check for enrollment fee & add it if needed
2501 my $dbh = C4::Context->dbh;
2502 my $sth = $dbh->prepare(q{
2505 WHERE categorycode=?
2507 $sth->execute( $categorycode );
2509 warn sprintf('Database returned the following error: %s', $sth->errstr);
2512 my ($enrolmentfee) = $sth->fetchrow;
2513 if ($enrolmentfee && $enrolmentfee > 0) {
2514 # insert fee in patron debts
2515 C4::Accounts::manualinvoice( $borrowernumber, '', '', 'A', $enrolmentfee );
2524 my ( $borrowernumber ) = @_;
2526 my $sql = "SELECT COUNT(*) FROM issues WHERE date_due < NOW() AND borrowernumber = ?";
2527 my $sth = C4::Context->dbh->prepare( $sql );
2528 $sth->execute( $borrowernumber );
2529 my ( $count ) = $sth->fetchrow_array();
2534 =head2 DeleteExpiredOpacRegistrations
2536 Delete accounts that haven't been upgraded from the 'temporary' category
2537 Returns the number of removed patrons
2541 sub DeleteExpiredOpacRegistrations {
2543 my $delay = C4::Context->preference('PatronSelfRegistrationExpireTemporaryAccountsDelay');
2544 my $category_code = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
2546 return 0 if not $category_code or not defined $delay or $delay eq q||;
2549 SELECT borrowernumber
2551 WHERE categorycode = ? AND DATEDIFF( NOW(), dateenrolled ) > ? |;
2553 my $dbh = C4::Context->dbh;
2554 my $sth = $dbh->prepare($query);
2555 $sth->execute( $category_code, $delay );
2557 while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
2558 DelMember($borrowernumber);
2564 =head2 DeleteUnverifiedOpacRegistrations
2566 Delete all unverified self registrations in borrower_modifications,
2567 older than the specified number of days.
2571 sub DeleteUnverifiedOpacRegistrations {
2573 my $dbh = C4::Context->dbh;
2575 DELETE FROM borrower_modifications
2576 WHERE borrowernumber = 0 AND DATEDIFF( NOW(), timestamp ) > ?|;
2577 my $cnt=$dbh->do($sql, undef, ($days) );
2578 return $cnt eq '0E0'? 0: $cnt;
2581 sub GetOverduesForPatron {
2582 my ( $borrowernumber ) = @_;
2586 FROM issues, items, biblio, biblioitems
2587 WHERE items.itemnumber=issues.itemnumber
2588 AND biblio.biblionumber = items.biblionumber
2589 AND biblio.biblionumber = biblioitems.biblionumber
2590 AND issues.borrowernumber = ?
2591 AND date_due < NOW()
2594 my $sth = C4::Context->dbh->prepare( $sql );
2595 $sth->execute( $borrowernumber );
2597 return $sth->fetchall_arrayref({});
2600 END { } # module clean-up code here (global destructor)