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 under the
10 # terms of the GNU General Public License as published by the Free Software
11 # Foundation; either version 2 of the License, or (at your option) any later
14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
16 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License along
19 # with Koha; if not, write to the Free Software Foundation, Inc.,
20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
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
::SQLHelper
qw(InsertInTable UpdateInTable SearchInTable);
36 use C4
::Members
::Attributes
qw(SearchIdMatchingAttribute UpdateBorrowerAttribute);
37 use C4
::NewsChannels
; #get slip news
39 use DateTime
::Format
::DateParse
;
42 use Koha
::Borrower
::Debarments
qw(IsDebarred);
43 use Text
::Unaccent
qw( unac_string );
44 use Koha
::AuthUtils
qw(hash_password);
47 if ( C4
::Context
->preference('NorwegianPatronDBEnable') && C4
::Context
->preference('NorwegianPatronDBEnable') == 1 ) {
48 load Koha
::NorwegianPatronDB
, qw( NLUpdateHashedPIN NLEncryptPIN NLSync );
51 our ($VERSION,@ISA,@EXPORT,@EXPORT_OK,$debug);
54 $VERSION = 3.07.00.049;
55 $debug = $ENV{DEBUG
} || 0;
67 &GetMemberIssuesAndFines
74 &GetFirstValidEmailAddress
75 &GetNoticeEmailAddress
86 &GetHideLostItemsPreference
89 &GetMemberAccountRecords
90 &GetBorNotifyAcctRecord
94 GetBorrowerCategorycode
95 &GetBorrowercategoryList
97 &GetBorrowersToExpunge
98 &GetBorrowersWhoHaveNeverBorrowed
99 &GetBorrowersWithIssuesHistoryOlderThan
109 GetBorrowersWithEmail
131 &ExtendMemberSubscriptionTo
149 C4::Members - Perl Module containing convenience functions for member handling
157 This module contains routines for adding, modifying and deleting members/patrons/borrowers
163 $borrowers_result_array_ref = &Search($filter,$orderby, $limit,
164 $columns_out, $search_on_fields,$searchtype);
166 Looks up patrons (borrowers) on filter. A wrapper for SearchInTable('borrowers').
168 For C<$filter>, C<$orderby>, C<$limit>, C<&columns_out>, C<&search_on_fields> and C<&searchtype>
169 refer to C4::SQLHelper:SearchInTable().
171 Special C<$filter> key '' is effectively expanded to search on surname firstname othernamescw
172 and cardnumber unless C<&search_on_fields> is defined
176 $borrowers = Search('abcd', 'cardnumber');
178 $borrowers = Search({''=>'abcd', category_type=>'I'}, 'surname');
182 sub _express_member_find
{
185 # this is used by circulation everytime a new borrowers cardnumber is scanned
186 # so we can check an exact match first, if that works return, otherwise do the rest
187 my $dbh = C4
::Context
->dbh;
188 my $query = "SELECT borrowernumber FROM borrowers WHERE cardnumber = ?";
189 if ( my $borrowernumber = $dbh->selectrow_array($query, undef, $filter) ) {
190 return( {"borrowernumber"=>$borrowernumber} );
193 my ($search_on_fields, $searchtype);
194 if ( length($filter) == 1 ) {
195 $search_on_fields = [ qw(surname) ];
196 $searchtype = 'start_with';
198 $search_on_fields = [ qw(surname firstname othernames cardnumber) ];
199 $searchtype = 'contain';
202 return (undef, $search_on_fields, $searchtype);
206 my ( $filter, $orderby, $limit, $columns_out, $search_on_fields, $searchtype ) = @_;
211 if ( my $fr = ref $filter ) {
212 if ( $fr eq "HASH" ) {
213 if ( my $search_string = $filter->{''} ) {
214 my ($member_filter, $member_search_on_fields, $member_searchtype) = _express_member_find
($search_string);
215 if ($member_filter) {
216 $filter = $member_filter;
219 $search_on_fields ||= $member_search_on_fields;
220 $searchtype ||= $member_searchtype;
225 $search_string = $filter;
229 $search_string = $filter;
230 my ($member_filter, $member_search_on_fields, $member_searchtype) = _express_member_find
($search_string);
231 if ($member_filter) {
232 $filter = $member_filter;
235 $search_on_fields ||= $member_search_on_fields;
236 $searchtype ||= $member_searchtype;
240 if ( !$found_borrower && C4
::Context
->preference('ExtendedPatronAttributes') && $search_string ) {
241 my $matching_records = C4
::Members
::Attributes
::SearchIdMatchingAttribute
($search_string);
242 if(scalar(@
$matching_records)>0) {
243 if ( my $fr = ref $filter ) {
244 if ( $fr eq "HASH" ) {
246 $filter = [ $filter ];
248 push @
$filter, { %f, "borrowernumber"=>$$matching_records };
251 push @
$filter, {"borrowernumber"=>$matching_records};
255 $filter = [ $filter ];
256 push @
$filter, {"borrowernumber"=>$matching_records};
261 # $showallbranches was not used at the time SearchMember() was mainstreamed into Search().
262 # Mentioning for the reference
264 if ( C4
::Context
->preference("IndependentBranches") ) { # && !$showallbranches){
265 if ( my $userenv = C4
::Context
->userenv ) {
266 my $branch = $userenv->{'branch'};
267 if ( !C4
::Context
->IsSuperLibrarian() && $branch ){
268 if (my $fr = ref $filter) {
269 if ( $fr eq "HASH" ) {
270 $filter->{branchcode
} = $branch;
274 $_ = { '' => $_ } unless ref $_;
275 $_->{branchcode
} = $branch;
280 $filter = { '' => $filter, branchcode
=> $branch };
286 if ($found_borrower) {
287 $searchtype = "exact";
289 $searchtype ||= "start_with";
291 return SearchInTable
( "borrowers", $filter, $orderby, $limit, $columns_out, $search_on_fields, $searchtype );
294 =head2 GetMemberDetails
296 ($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
298 Looks up a patron and returns information about him or her. If
299 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
300 up the borrower by number; otherwise, it looks up the borrower by card
303 C<$borrower> is a reference-to-hash whose keys are the fields of the
304 borrowers table in the Koha database. In addition,
305 C<$borrower-E<gt>{flags}> is a hash giving more detailed information
306 about the patron. Its keys act as flags :
308 if $borrower->{flags}->{LOST} {
309 # Patron's card was reported lost
312 If the state of a flag means that the patron should not be
313 allowed to borrow any more books, then it will have a C<noissues> key
316 See patronflags for more details.
318 C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
319 about the top-level permissions flags set for the borrower. For example,
320 if a user has the "editcatalogue" permission,
321 C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
326 sub GetMemberDetails
{
327 my ( $borrowernumber, $cardnumber ) = @_;
328 my $dbh = C4
::Context
->dbh;
331 if ($borrowernumber) {
332 $sth = $dbh->prepare("
335 categories.description,
336 categories.BlockExpiredPatronOpacActions,
340 LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
341 WHERE borrowernumber = ?
343 $sth->execute($borrowernumber);
345 elsif ($cardnumber) {
346 $sth = $dbh->prepare("
349 categories.description,
350 categories.BlockExpiredPatronOpacActions,
354 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
357 $sth->execute($cardnumber);
362 my $borrower = $sth->fetchrow_hashref;
363 return unless $borrower;
364 my ($amount) = GetMemberAccountRecords
($borrower->{borrowernumber
});
365 $borrower->{'amountoutstanding'} = $amount;
366 # FIXME - patronflags calls GetMemberAccountRecords... just have patronflags return $amount
367 my $flags = patronflags
( $borrower);
370 $sth = $dbh->prepare("select bit,flag from userflags");
372 while ( my ( $bit, $flag ) = $sth->fetchrow ) {
373 if ( $borrower->{'flags'} && $borrower->{'flags'} & 2**$bit ) {
374 $accessflagshash->{$flag} = 1;
377 $borrower->{'flags'} = $flags;
378 $borrower->{'authflags'} = $accessflagshash;
380 # For the purposes of making templates easier, we'll define a
381 # 'showname' which is the alternate form the user's first name if
382 # 'other name' is defined.
383 if ($borrower->{category_type
} eq 'I') {
384 $borrower->{'showname'} = $borrower->{'othernames'};
385 $borrower->{'showname'} .= " $borrower->{'firstname'}" if $borrower->{'firstname'};
387 $borrower->{'showname'} = $borrower->{'firstname'};
390 # Handle setting the true behavior for BlockExpiredPatronOpacActions
391 $borrower->{'BlockExpiredPatronOpacActions'} =
392 C4
::Context
->preference('BlockExpiredPatronOpacActions')
393 if ( $borrower->{'BlockExpiredPatronOpacActions'} == -1 );
395 $borrower->{'is_expired'} = 0;
396 $borrower->{'is_expired'} = 1 if
397 defined($borrower->{dateexpiry
}) &&
398 $borrower->{'dateexpiry'} ne '0000-00-00' &&
399 Date_to_Days
( Today
() ) >
400 Date_to_Days
( split /-/, $borrower->{'dateexpiry'} );
402 return ($borrower); #, $flags, $accessflagshash);
407 $flags = &patronflags($patron);
409 This function is not exported.
411 The following will be set where applicable:
412 $flags->{CHARGES}->{amount} Amount of debt
413 $flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge)
414 $flags->{CHARGES}->{message} Message -- deprecated
416 $flags->{CREDITS}->{amount} Amount of credit
417 $flags->{CREDITS}->{message} Message -- deprecated
419 $flags->{ GNA } Patron has no valid address
420 $flags->{ GNA }->{noissues} Set for each GNA
421 $flags->{ GNA }->{message} "Borrower has no valid address" -- deprecated
423 $flags->{ LOST } Patron's card reported lost
424 $flags->{ LOST }->{noissues} Set for each LOST
425 $flags->{ LOST }->{message} Message -- deprecated
427 $flags->{DBARRED} Set if patron debarred, no access
428 $flags->{DBARRED}->{noissues} Set for each DBARRED
429 $flags->{DBARRED}->{message} Message -- deprecated
432 $flags->{ NOTES }->{message} The note itself. NOT deprecated
434 $flags->{ ODUES } Set if patron has overdue books.
435 $flags->{ ODUES }->{message} "Yes" -- deprecated
436 $flags->{ ODUES }->{itemlist} ref-to-array: list of overdue books
437 $flags->{ ODUES }->{itemlisttext} Text list of overdue items -- deprecated
439 $flags->{WAITING} Set if any of patron's reserves are available
440 $flags->{WAITING}->{message} Message -- deprecated
441 $flags->{WAITING}->{itemlist} ref-to-array: list of available items
445 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
446 overdue items. Its elements are references-to-hash, each describing an
447 overdue item. The keys are selected fields from the issues, biblio,
448 biblioitems, and items tables of the Koha database.
450 =item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
451 the overdue items, one per line. Deprecated.
453 =item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
454 available items. Each element is a reference-to-hash whose keys are
455 fields from the reserves table of the Koha database.
459 All the "message" fields that include language generated in this function are deprecated,
460 because such strings belong properly in the display layer.
462 The "message" field that comes from the DB is OK.
466 # TODO: use {anonymous => hashes} instead of a dozen %flaginfo
467 # FIXME rename this function.
470 my ( $patroninformation) = @_;
471 my $dbh=C4
::Context
->dbh;
472 my ($balance, $owing) = GetMemberAccountBalance
( $patroninformation->{'borrowernumber'});
475 my $noissuescharge = C4
::Context
->preference("noissuescharge") || 5;
476 $flaginfo{'message'} = sprintf 'Patron owes %.02f', $owing;
477 $flaginfo{'amount'} = sprintf "%.02f", $owing;
478 if ( $owing > $noissuescharge && !C4
::Context
->preference("AllowFineOverride") ) {
479 $flaginfo{'noissues'} = 1;
481 $flags{'CHARGES'} = \
%flaginfo;
483 elsif ( $balance < 0 ) {
485 $flaginfo{'message'} = sprintf 'Patron has credit of %.02f', -$balance;
486 $flaginfo{'amount'} = sprintf "%.02f", $balance;
487 $flags{'CREDITS'} = \
%flaginfo;
489 if ( $patroninformation->{'gonenoaddress'}
490 && $patroninformation->{'gonenoaddress'} == 1 )
493 $flaginfo{'message'} = 'Borrower has no valid address.';
494 $flaginfo{'noissues'} = 1;
495 $flags{'GNA'} = \
%flaginfo;
497 if ( $patroninformation->{'lost'} && $patroninformation->{'lost'} == 1 ) {
499 $flaginfo{'message'} = 'Borrower\'s card reported lost.';
500 $flaginfo{'noissues'} = 1;
501 $flags{'LOST'} = \
%flaginfo;
503 if ( $patroninformation->{'debarred'} && check_date
( split( /-/, $patroninformation->{'debarred'} ) ) ) {
504 if ( Date_to_Days
(Date
::Calc
::Today
) < Date_to_Days
( split( /-/, $patroninformation->{'debarred'} ) ) ) {
506 $flaginfo{'debarredcomment'} = $patroninformation->{'debarredcomment'};
507 $flaginfo{'message'} = $patroninformation->{'debarredcomment'};
508 $flaginfo{'noissues'} = 1;
509 $flaginfo{'dateend'} = $patroninformation->{'debarred'};
510 $flags{'DBARRED'} = \
%flaginfo;
513 if ( $patroninformation->{'borrowernotes'}
514 && $patroninformation->{'borrowernotes'} )
517 $flaginfo{'message'} = $patroninformation->{'borrowernotes'};
518 $flags{'NOTES'} = \
%flaginfo;
520 my ( $odues, $itemsoverdue ) = C4
::Overdues
::checkoverdues
($patroninformation->{'borrowernumber'});
521 if ( $odues && $odues > 0 ) {
523 $flaginfo{'message'} = "Yes";
524 $flaginfo{'itemlist'} = $itemsoverdue;
525 foreach ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
528 $flaginfo{'itemlisttext'} .=
529 "$_->{'date_due'} $_->{'barcode'} $_->{'title'} \n"; # newline is display layer
531 $flags{'ODUES'} = \
%flaginfo;
533 my @itemswaiting = C4
::Reserves
::GetReservesFromBorrowernumber
( $patroninformation->{'borrowernumber'},'W' );
534 my $nowaiting = scalar @itemswaiting;
535 if ( $nowaiting > 0 ) {
537 $flaginfo{'message'} = "Reserved items available";
538 $flaginfo{'itemlist'} = \
@itemswaiting;
539 $flags{'WAITING'} = \
%flaginfo;
547 $borrower = &GetMember(%information);
549 Retrieve the first patron record meeting on criteria listed in the
550 C<%information> hash, which should contain one or more
551 pairs of borrowers column names and values, e.g.,
553 $borrower = GetMember(borrowernumber => id);
555 C<&GetBorrower> returns a reference-to-hash whose keys are the fields of
556 the C<borrowers> table in the Koha database.
558 FIXME: GetMember() is used throughout the code as a lookup
559 on a unique key such as the borrowernumber, but this meaning is not
560 enforced in the routine itself.
566 my ( %information ) = @_;
567 if (exists $information{borrowernumber
} && !defined $information{borrowernumber
}) {
568 #passing mysql's kohaadmin?? Makes no sense as a query
571 my $dbh = C4
::Context
->dbh;
573 q{SELECT borrowers.*, categories.category_type, categories.description
575 LEFT JOIN categories on borrowers.categorycode=categories.categorycode WHERE };
578 for (keys %information ) {
586 if (defined $information{$_}) {
588 push @values, $information{$_};
591 $select .= "$_ IS NULL";
594 $debug && warn $select, " ",values %information;
595 my $sth = $dbh->prepare("$select");
596 $sth->execute(map{$information{$_}} keys %information);
597 my $data = $sth->fetchall_arrayref({});
598 #FIXME interface to this routine now allows generation of a result set
599 #so whole array should be returned but bowhere in the current code expects this
607 =head2 GetMemberRelatives
609 @borrowernumbers = GetMemberRelatives($borrowernumber);
611 C<GetMemberRelatives> returns a borrowersnumber's list of guarantor/guarantees of the member given in parameter
615 sub GetMemberRelatives
{
616 my $borrowernumber = shift;
617 my $dbh = C4
::Context
->dbh;
621 my $query = "SELECT guarantorid FROM borrowers WHERE borrowernumber=?";
622 my $sth = $dbh->prepare($query);
623 $sth->execute($borrowernumber);
624 my $data = $sth->fetchrow_arrayref();
625 push @glist, $data->[0] if $data->[0];
626 my $guarantor = $data->[0] ?
$data->[0] : undef;
629 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
630 $sth = $dbh->prepare($query);
631 $sth->execute($borrowernumber);
632 while ($data = $sth->fetchrow_arrayref()) {
633 push @glist, $data->[0];
636 # Getting sibling guarantees
638 $query = "SELECT borrowernumber FROM borrowers WHERE guarantorid=?";
639 $sth = $dbh->prepare($query);
640 $sth->execute($guarantor);
641 while ($data = $sth->fetchrow_arrayref()) {
642 push @glist, $data->[0] if ($data->[0] != $borrowernumber);
649 =head2 IsMemberBlocked
651 my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
653 Returns whether a patron has overdue items that may result
654 in a block or whether the patron has active fine days
655 that would block circulation privileges.
657 C<$block_status> can have the following values:
659 1 if the patron has outstanding fine days or a manual debarment, in which case
660 C<$count> is the expiration date (9999-12-31 for indefinite)
662 -1 if the patron has overdue items, in which case C<$count> is the number of them
664 0 if the patron has no overdue items or outstanding fine days, in which case C<$count> is 0
666 Outstanding fine days are checked before current overdue items
669 FIXME: this needs to be split into two functions; a potential block
670 based on the number of current overdue items could be orthogonal
671 to a block based on whether the patron has any fine days accrued.
675 sub IsMemberBlocked
{
676 my $borrowernumber = shift;
677 my $dbh = C4
::Context
->dbh;
679 my $blockeddate = Koha
::Borrower
::Debarments
::IsDebarred
($borrowernumber);
681 return ( 1, $blockeddate ) if $blockeddate;
683 # if he have late issues
684 my $sth = $dbh->prepare(
685 "SELECT COUNT(*) as latedocs
687 WHERE borrowernumber = ?
688 AND date_due < now()"
690 $sth->execute($borrowernumber);
691 my $latedocs = $sth->fetchrow_hashref->{'latedocs'};
693 return ( -1, $latedocs ) if $latedocs > 0;
698 =head2 GetMemberIssuesAndFines
700 ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
702 Returns aggregate data about items borrowed by the patron with the
703 given borrowernumber.
705 C<&GetMemberIssuesAndFines> returns a three-element array. C<$overdue_count> is the
706 number of overdue items the patron currently has borrowed. C<$issue_count> is the
707 number of books the patron currently has borrowed. C<$total_fines> is
708 the total fine currently due by the borrower.
713 sub GetMemberIssuesAndFines
{
714 my ( $borrowernumber ) = @_;
715 my $dbh = C4
::Context
->dbh;
716 my $query = "SELECT COUNT(*) FROM issues WHERE borrowernumber = ?";
718 $debug and warn $query."\n";
719 my $sth = $dbh->prepare($query);
720 $sth->execute($borrowernumber);
721 my $issue_count = $sth->fetchrow_arrayref->[0];
723 $sth = $dbh->prepare(
724 "SELECT COUNT(*) FROM issues
725 WHERE borrowernumber = ?
726 AND date_due < now()"
728 $sth->execute($borrowernumber);
729 my $overdue_count = $sth->fetchrow_arrayref->[0];
731 $sth = $dbh->prepare("SELECT SUM(amountoutstanding) FROM accountlines WHERE borrowernumber = ?");
732 $sth->execute($borrowernumber);
733 my $total_fines = $sth->fetchrow_arrayref->[0];
735 return ($overdue_count, $issue_count, $total_fines);
741 my @columns = C4::Member::columns();
743 Returns an array of borrowers' table columns on success,
744 and an empty array on failure.
750 # Pure ANSI SQL goodness.
751 my $sql = 'SELECT * FROM borrowers WHERE 1=0;';
753 # Get the database handle.
754 my $dbh = C4
::Context
->dbh;
756 # Run the SQL statement to load STH's readonly properties.
757 my $sth = $dbh->prepare($sql);
758 my $rv = $sth->execute();
760 # This only fails if the table doesn't exist.
761 # This will always be called AFTER an install or upgrade,
762 # so borrowers will exist!
764 if ($sth->{NUM_OF_FIELDS
}>0) {
765 @data = @
{$sth->{NAME
}};
776 my $success = ModMember(borrowernumber => $borrowernumber,
777 [ field => value ]... );
779 Modify borrower's data. All date fields should ALREADY be in ISO format.
782 true on success, or false on failure
788 # test to know if you must update or not the borrower password
789 if (exists $data{password
}) {
790 if ($data{password
} eq '****' or $data{password
} eq '') {
791 delete $data{password
};
793 if ( C4
::Context
->preference('NorwegianPatronDBEnable') && C4
::Context
->preference('NorwegianPatronDBEnable') == 1 ) {
794 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
795 NLUpdateHashedPIN
( $data{'borrowernumber'}, $data{password
} );
797 $data{password
} = hash_password
($data{password
});
800 my $old_categorycode = GetBorrowerCategorycode
( $data{borrowernumber
} );
801 my $execute_success=UpdateInTable
("borrowers",\
%data);
802 if ($execute_success) { # only proceed if the update was a success
803 # ok if its an adult (type) it may have borrowers that depend on it as a guarantor
804 # so when we update information for an adult we should check for guarantees and update the relevant part
805 # of their records, ie addresses and phone numbers
806 my $borrowercategory= GetBorrowercategory
( $data{'category_type'} );
807 if ( exists $borrowercategory->{'category_type'} && $borrowercategory->{'category_type'} eq ('A' || 'S') ) {
808 # is adult check guarantees;
809 UpdateGuarantees
(%data);
812 # If the patron changes to a category with enrollment fee, we add a fee
813 if ( $data{categorycode
} and $data{categorycode
} ne $old_categorycode ) {
814 AddEnrolmentFeeIfNeeded
( $data{categorycode
}, $data{borrowernumber
} );
817 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
818 # cronjob will use for syncing with NL
819 if ( C4
::Context
->preference('NorwegianPatronDBEnable') && C4
::Context
->preference('NorwegianPatronDBEnable') == 1 ) {
820 my $borrowersync = Koha
::Database
->new->schema->resultset('BorrowerSync')->find({
821 'synctype' => 'norwegianpatrondb',
822 'borrowernumber' => $data{'borrowernumber'}
824 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
825 # we can sync as changed. And the "new sync" will pick up all changes since
826 # the patron was created anyway.
827 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
828 $borrowersync->update( { 'syncstatus' => 'edited' } );
830 # Set the value of 'sync'
831 $borrowersync->update( { 'sync' => $data{'sync'} } );
832 # Try to do the live sync
833 NLSync
({ 'borrowernumber' => $data{'borrowernumber'} });
836 logaction
("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4
::Context
->preference("BorrowersLog");
838 return $execute_success;
843 $borrowernumber = &AddMember(%borrower);
845 insert new borrower into table
847 (%borrower keys are database columns. Database columns could be
848 different in different versions. Please look into database for correct
851 Returns the borrowernumber upon success
853 Returns as undef upon any db error without further processing
860 my $dbh = C4
::Context
->dbh;
862 # generate a proper login if none provided
863 $data{'userid'} = Generate_Userid
( $data{'borrowernumber'}, $data{'firstname'}, $data{'surname'} )
864 if ( $data{'userid'} eq '' || !Check_Userid
( $data{'userid'} ) );
866 # add expiration date if it isn't already there
867 unless ( $data{'dateexpiry'} ) {
868 $data{'dateexpiry'} = GetExpiryDate
( $data{'categorycode'}, C4
::Dates
->new()->output("iso") );
871 # add enrollment date if it isn't already there
872 unless ( $data{'dateenrolled'} ) {
873 $data{'dateenrolled'} = C4
::Dates
->new()->output("iso");
876 my $patron_category =
877 Koha
::Database
->new()->schema()->resultset('Category')
878 ->find( $data{'categorycode'} );
880 $patron_category->default_privacy() eq 'default' ?
1
881 : $patron_category->default_privacy() eq 'never' ?
2
882 : $patron_category->default_privacy() eq 'forever' ?
0
884 # Make a copy of the plain text password for later use
885 my $plain_text_password = $data{'password'};
887 # create a disabled account if no password provided
888 $data{'password'} = ($data{'password'})? hash_password
($data{'password'}) : '!';
889 $data{'borrowernumber'}=InsertInTable
("borrowers",\
%data);
891 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
892 # cronjob will use for syncing with NL
893 if ( exists $data{'borrowernumber'} && C4
::Context
->preference('NorwegianPatronDBEnable') && C4
::Context
->preference('NorwegianPatronDBEnable') == 1 ) {
894 Koha
::Database
->new->schema->resultset('BorrowerSync')->create({
895 'borrowernumber' => $data{'borrowernumber'},
896 'synctype' => 'norwegianpatrondb',
898 'syncstatus' => 'new',
899 'hashed_pin' => NLEncryptPIN
( $plain_text_password ),
903 # mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
904 logaction
("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4
::Context
->preference("BorrowersLog");
906 AddEnrolmentFeeIfNeeded
( $data{categorycode
}, $data{borrowernumber
} );
908 return $data{'borrowernumber'};
913 my $uniqueness = Check_Userid($userid,$borrowernumber);
915 $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 != '').
917 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.
920 0 for not unique (i.e. this $userid already exists)
921 1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
926 my ( $uid, $borrowernumber ) = @_;
928 return 0 unless ($uid); # userid is a unique column, we should assume NULL is not unique
930 return 0 if ( $uid eq C4
::Context
->config('user') );
932 my $rs = Koha
::Database
->new()->schema()->resultset('Borrower');
935 $params->{userid
} = $uid;
936 $params->{borrowernumber
} = { '!=' => $borrowernumber } if ($borrowernumber);
938 my $count = $rs->count( $params );
940 return $count ?
0 : 1;
943 =head2 Generate_Userid
945 my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
947 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
949 $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.
952 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).
956 sub Generate_Userid
{
957 my ($borrowernumber, $firstname, $surname) = @_;
960 #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
962 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
963 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
964 $newuid = lc(($firstname)?
"$firstname.$surname" : $surname);
965 $newuid = unac_string
('utf-8',$newuid);
966 $newuid .= $offset unless $offset == 0;
969 } while (!Check_Userid
($newuid,$borrowernumber));
975 my ( $uid, $member, $digest ) = @_;
976 my $dbh = C4
::Context
->dbh;
978 #Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
979 #Then we need to tell the user and have them create a new one.
983 "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
984 $sth->execute( $uid, $member );
985 if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
989 #Everything is good so we can update the information.
992 "update borrowers set userid=?, password=? where borrowernumber=?");
993 $sth->execute( $uid, $digest, $member );
997 logaction
("MEMBERS", "CHANGE PASS", $member, "") if C4
::Context
->preference("BorrowersLog");
1003 =head2 fixup_cardnumber
1005 Warning: The caller is responsible for locking the members table in write
1006 mode, to avoid database corruption.
1010 use vars
qw( @weightings );
1011 my @weightings = ( 8, 4, 6, 3, 5, 2, 1 );
1013 sub fixup_cardnumber {
1014 my ($cardnumber) = @_;
1015 my $autonumber_members = C4::Context->boolean_preference('autoMemberNum') || 0;
1017 # Find out whether member numbers should be generated
1018 # automatically. Should be either "1" or something else.
1019 # Defaults to "0", which is interpreted as "no".
1021 # if ($cardnumber !~ /\S/ && $autonumber_members) {
1022 ($autonumber_members) or return $cardnumber;
1023 my $checkdigit = C4::Context->preference('checkdigit');
1024 my $dbh = C4::Context->dbh;
1025 if ( $checkdigit and $checkdigit eq 'katipo' ) {
1027 # if checkdigit is selected, calculate katipo-style cardnumber.
1028 # otherwise, just use the max()
1029 # purpose: generate checksum'd member numbers.
1030 # We'll assume we just got the max value of digits 2-8 of member #'s
1031 # from the database and our job is to increment that by one,
1032 # determine the 1st and 9th digits and return the full string.
1033 my $sth = $dbh->prepare(
1034 "select max(substring(borrowers.cardnumber,2,7)) as new_num from borrowers"
1037 my $data = $sth->fetchrow_hashref;
1038 $cardnumber = $data->{new_num};
1039 if ( !$cardnumber ) { # If DB has no values,
1040 $cardnumber = 1000000; # start at 1000000
1046 for ( my $i = 0 ; $i < 8 ; $i += 1 ) {
1047 # read weightings, left to right, 1 char at a time
1048 my $temp1 = $weightings[$i];
1050 # sequence left to right, 1 char at a time
1051 my $temp2 = substr( $cardnumber, $i, 1 );
1053 # mult each char 1-7 by its corresponding weighting
1054 $sum += $temp1 * $temp2;
1057 my $rem = ( $sum % 11 );
1058 $rem = 'X' if $rem == 10;
1060 return "V$cardnumber$rem";
1063 my $sth = $dbh->prepare(
1064 'SELECT MAX( CAST( cardnumber AS SIGNED ) ) FROM borrowers WHERE cardnumber REGEXP "^-?[0-9]+$"'
1067 my ($result) = $sth->fetchrow;
1070 return $cardnumber; # just here as a fallback/reminder
1073 =head2 GetGuarantees
1075 ($num_children, $children_arrayref) = &GetGuarantees($parent_borrno);
1076 $child0_cardno = $children_arrayref->[0]{"cardnumber"};
1077 $child0_borrno = $children_arrayref->[0]{"borrowernumber"};
1079 C<&GetGuarantees> takes a borrower number (e.g., that of a patron
1080 with children) and looks up the borrowers who are guaranteed by that
1081 borrower (i.e., the patron's children).
1083 C<&GetGuarantees> returns two values: an integer giving the number of
1084 borrowers guaranteed by C<$parent_borrno>, and a reference to an array
1085 of references to hash, which gives the actual results.
1091 my ($borrowernumber) = @_;
1092 my $dbh = C4::Context->dbh;
1095 "select cardnumber,borrowernumber, firstname, surname from borrowers where guarantorid=?"
1097 $sth->execute($borrowernumber);
1100 my $data = $sth->fetchall_arrayref({});
1101 return ( scalar(@$data), $data );
1104 =head2 UpdateGuarantees
1106 &UpdateGuarantees($parent_borrno);
1109 C<&UpdateGuarantees> borrower data for an adult and updates all the guarantees
1110 with the modified information
1115 sub UpdateGuarantees {
1117 my $dbh = C4::Context->dbh;
1118 my ( $count, $guarantees ) = GetGuarantees( $data{'borrowernumber'} );
1119 foreach my $guarantee (@$guarantees){
1120 my $guaquery = qq|UPDATE borrowers
1121 SET address=?,fax=?,B_city=?,mobile=?,city=?,phone=?
1122 WHERE borrowernumber=?
1124 my $sth = $dbh->prepare($guaquery);
1125 $sth->execute($data{'address'},$data{'fax'},$data{'B_city'},$data{'mobile'},$data{'city'},$data{'phone'},$guarantee->{'borrowernumber'});
1128 =head2 GetPendingIssues
1130 my $issues = &GetPendingIssues(@borrowernumber);
1132 Looks up what the patron with the given borrowernumber has borrowed.
1134 C<&GetPendingIssues> returns a
1135 reference-to-array where each element is a reference-to-hash; the
1136 keys are the fields from the C<issues>, C<biblio>, and C<items> tables.
1137 The keys include C<biblioitems> fields except marc and marcxml.
1142 sub GetPendingIssues {
1143 my @borrowernumbers = @_;
1145 unless (@borrowernumbers ) { # return a ref_to_array
1146 return \@borrowernumbers; # to not cause surprise to caller
1149 # Borrowers part of the query
1151 for (my $i = 0; $i < @borrowernumbers; $i++) {
1152 $bquery .= ' issues.borrowernumber = ?';
1153 if ($i < $#borrowernumbers ) {
1158 # must avoid biblioitems.* to prevent large marc and marcxml fields from killing performance
1159 # FIXME: namespace collision: each table has "timestamp" fields. Which one is "timestamp" ?
1160 # FIXME: circ/ciculation.pl tries to sort by timestamp!
1161 # FIXME: namespace collision: other collisions possible.
1162 # FIXME: most of this data isn't really being used by callers.
1169 biblioitems.itemtype,
1172 biblioitems.publicationyear,
1173 biblioitems.publishercode,
1174 biblioitems.volumedate,
1175 biblioitems.volumedesc,
1178 borrowers.firstname,
1180 borrowers.cardnumber,
1181 issues.timestamp AS timestamp,
1182 issues.renewals AS renewals,
1183 issues.borrowernumber AS borrowernumber,
1184 items.renewals AS totalrenewals
1186 LEFT JOIN items ON items.itemnumber = issues.itemnumber
1187 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1188 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
1189 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
1192 ORDER BY issues.issuedate"
1195 my $sth = C4::Context->dbh->prepare($query);
1196 $sth->execute(@borrowernumbers);
1197 my $data = $sth->fetchall_arrayref({});
1198 my $tz = C4::Context->tz();
1199 my $today = DateTime->now( time_zone => $tz);
1200 foreach (@{$data}) {
1201 if ($_->{issuedate}) {
1202 $_->{issuedate} = dt_from_string($_->{issuedate}, 'sql');
1204 $_->{date_due} or next;
1205 $_->{date_due} = DateTime::Format::DateParse->parse_datetime($_->{date_due}, $tz->name());
1206 if ( DateTime->compare($_->{date_due}, $today) == -1 ) {
1215 $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
1217 Looks up what the patron with the given borrowernumber has borrowed,
1218 and sorts the results.
1220 C<$sortkey> is the name of a field on which to sort the results. This
1221 should be the name of a field in the C<issues>, C<biblio>,
1222 C<biblioitems>, or C<items> table in the Koha database.
1224 C<$limit> is the maximum number of results to return.
1226 C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
1227 are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
1228 C<items> tables of the Koha database.
1234 my ( $borrowernumber, $order, $limit ) = @_;
1236 return unless $borrowernumber;
1237 $order = 'date_due desc' unless $order;
1239 my $dbh = C4::Context->dbh;
1241 'SELECT *, issues.timestamp as issuestimestamp, issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1243 LEFT JOIN items on items.itemnumber=issues.itemnumber
1244 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1245 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1246 WHERE borrowernumber=?
1248 SELECT *, old_issues.timestamp as issuestimestamp, old_issues.renewals AS renewals,items.renewals AS totalrenewals,items.timestamp AS itemstimestamp
1250 LEFT JOIN items on items.itemnumber=old_issues.itemnumber
1251 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1252 LEFT JOIN biblioitems ON items.biblioitemnumber=biblioitems.biblioitemnumber
1253 WHERE borrowernumber=? AND old_issues.itemnumber IS NOT NULL
1254 order by ' . $order;
1256 $query .= " limit $limit";
1259 my $sth = $dbh->prepare($query);
1260 $sth->execute( $borrowernumber, $borrowernumber );
1261 return $sth->fetchall_arrayref( {} );
1265 =head2 GetMemberAccountRecords
1267 ($total, $acctlines, $count) = &GetMemberAccountRecords($borrowernumber);
1269 Looks up accounting data for the patron with the given borrowernumber.
1271 C<&GetMemberAccountRecords> returns a three-element array. C<$acctlines> is a
1272 reference-to-array, where each element is a reference-to-hash; the
1273 keys are the fields of the C<accountlines> table in the Koha database.
1274 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1275 total amount outstanding for all of the account lines.
1279 sub GetMemberAccountRecords {
1280 my ($borrowernumber) = @_;
1281 my $dbh = C4::Context->dbh;
1287 WHERE borrowernumber=?);
1288 $strsth.=" ORDER BY date desc,timestamp DESC";
1289 my $sth= $dbh->prepare( $strsth );
1290 $sth->execute( $borrowernumber );
1293 while ( my $data = $sth->fetchrow_hashref ) {
1294 if ( $data->{itemnumber} ) {
1295 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1296 $data->{biblionumber} = $biblio->{biblionumber};
1297 $data->{title} = $biblio->{title};
1299 $acctlines[$numlines] = $data;
1301 $total += int(1000 * $data->{'amountoutstanding'}); # convert float to integer to avoid round-off errors
1304 return ( $total, \@acctlines,$numlines);
1307 =head2 GetMemberAccountBalance
1309 ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
1311 Calculates amount immediately owing by the patron - non-issue charges.
1312 Based on GetMemberAccountRecords.
1313 Charges exempt from non-issue are:
1315 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
1316 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
1320 sub GetMemberAccountBalance {
1321 my ($borrowernumber) = @_;
1323 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
1326 push @not_fines, 'Res' unless C4::Context->preference('HoldsInNoissuesCharge');
1327 push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
1328 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
1329 my $dbh = C4::Context->dbh;
1330 my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
1331 push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
1333 my %not_fine = map {$_ => 1} @not_fines;
1335 my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
1336 my $other_charges = 0;
1337 foreach (@$acctlines) {
1338 $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
1341 return ( $total, $total - $other_charges, $other_charges);
1344 =head2 GetBorNotifyAcctRecord
1346 ($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
1348 Looks up accounting data for the patron with the given borrowernumber per file number.
1350 C<&GetBorNotifyAcctRecord> returns a three-element array. C<$acctlines> is a
1351 reference-to-array, where each element is a reference-to-hash; the
1352 keys are the fields of the C<accountlines> table in the Koha database.
1353 C<$count> is the number of elements in C<$acctlines>. C<$total> is the
1354 total amount outstanding for all of the account lines.
1358 sub GetBorNotifyAcctRecord {
1359 my ( $borrowernumber, $notifyid ) = @_;
1360 my $dbh = C4::Context->dbh;
1363 my $sth = $dbh->prepare(
1366 WHERE borrowernumber=?
1368 AND amountoutstanding != '0'
1369 ORDER BY notify_id,accounttype
1372 $sth->execute( $borrowernumber, $notifyid );
1374 while ( my $data = $sth->fetchrow_hashref ) {
1375 if ( $data->{itemnumber} ) {
1376 my $biblio = GetBiblioFromItemNumber( $data->{itemnumber} );
1377 $data->{biblionumber} = $biblio->{biblionumber};
1378 $data->{title} = $biblio->{title};
1380 $acctlines[$numlines] = $data;
1382 $total += int(100 * $data->{'amountoutstanding'});
1385 return ( $total, \@acctlines, $numlines );
1388 =head2 checkuniquemember (OUEST-PROVENCE)
1390 ($result,$categorycode) = &checkuniquemember($collectivity,$surname,$firstname,$dateofbirth);
1392 Checks that a member exists or not in the database.
1394 C<&result> is nonzero (=exist) or 0 (=does not exist)
1395 C<&categorycode> is from categorycode table
1396 C<&collectivity> is 1 (= we add a collectivity) or 0 (= we add a physical member)
1397 C<&surname> is the surname
1398 C<&firstname> is the firstname (only if collectivity=0)
1399 C<&dateofbirth> is the date of birth in ISO format (only if collectivity=0)
1403 # FIXME: This function is not legitimate. Multiple patrons might have the same first/last name and birthdate.
1404 # This is especially true since first name is not even a required field.
1406 sub checkuniquemember {
1407 my ( $collectivity, $surname, $firstname, $dateofbirth ) = @_;
1408 my $dbh = C4::Context->dbh;
1409 my $request = ($collectivity) ?
1410 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? " :
1412 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=? and dateofbirth=?" :
1413 "SELECT borrowernumber,categorycode FROM borrowers WHERE surname=? and firstname=?";
1414 my $sth = $dbh->prepare($request);
1415 if ($collectivity) {
1416 $sth->execute( uc($surname) );
1417 } elsif($dateofbirth){
1418 $sth->execute( uc($surname), ucfirst($firstname), $dateofbirth );
1420 $sth->execute( uc($surname), ucfirst($firstname));
1422 my @data = $sth->fetchrow;
1423 ( $data[0] ) and return $data[0], $data[1];
1427 sub checkcardnumber {
1428 my ( $cardnumber, $borrowernumber ) = @_;
1430 # If cardnumber is null, we assume they're allowed.
1431 return 0 unless defined $cardnumber;
1433 my $dbh = C4::Context->dbh;
1434 my $query = "SELECT * FROM borrowers WHERE cardnumber=?";
1435 $query .= " AND borrowernumber <> ?" if ($borrowernumber);
1436 my $sth = $dbh->prepare($query);
1439 ( $borrowernumber ? $borrowernumber : () )
1442 return 1 if $sth->fetchrow_hashref;
1444 my ( $min_length, $max_length ) = get_cardnumber_length();
1446 if length $cardnumber > $max_length
1447 or length $cardnumber < $min_length;
1452 =head2 get_cardnumber_length
1454 my ($min, $max) = C4::Members::get_cardnumber_length()
1456 Returns the minimum and maximum length for patron cardnumbers as
1457 determined by the CardnumberLength system preference, the
1458 BorrowerMandatoryField system preference, and the width of the
1463 sub get_cardnumber_length {
1464 my ( $min, $max ) = ( 0, 16 ); # borrowers.cardnumber is a nullable varchar(16)
1465 $min = 1 if C4::Context->preference('BorrowerMandatoryField') =~ /cardnumber/;
1466 if ( my $cardnumber_length = C4::Context->preference('CardnumberLength') ) {
1467 # Is integer and length match
1468 if ( $cardnumber_length =~ m|^\d+$| ) {
1469 $min = $max = $cardnumber_length
1470 if $cardnumber_length >= $min
1471 and $cardnumber_length <= $max;
1473 # Else assuming it is a range
1474 elsif ( $cardnumber_length =~ m|(\d*),(\d*)| ) {
1475 $min = $1 if $1 and $min < $1;
1476 $max = $2 if $2 and $max > $2;
1480 return ( $min, $max );
1483 =head2 getzipnamecity (OUEST-PROVENCE)
1485 take all info from table city for the fields city and zip
1486 check for the name and the zip code of the city selected
1490 sub getzipnamecity {
1492 my $dbh = C4::Context->dbh;
1495 "select city_name,city_state,city_zipcode,city_country from cities where cityid=? ");
1496 $sth->execute($cityid);
1497 my @data = $sth->fetchrow;
1498 return $data[0], $data[1], $data[2], $data[3];
1502 =head2 getdcity (OUEST-PROVENCE)
1504 recover cityid with city_name condition
1509 my ($city_name) = @_;
1510 my $dbh = C4::Context->dbh;
1511 my $sth = $dbh->prepare("select cityid from cities where city_name=? ");
1512 $sth->execute($city_name);
1513 my $data = $sth->fetchrow;
1517 =head2 GetFirstValidEmailAddress
1519 $email = GetFirstValidEmailAddress($borrowernumber);
1521 Return the first valid email address for a borrower, given the borrowernumber. For now, the order
1522 is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
1527 sub GetFirstValidEmailAddress {
1528 my $borrowernumber = shift;
1529 my $dbh = C4::Context->dbh;
1530 my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
1531 $sth->execute( $borrowernumber );
1532 my $data = $sth->fetchrow_hashref;
1534 if ($data->{'email'}) {
1535 return $data->{'email'};
1536 } elsif ($data->{'emailpro'}) {
1537 return $data->{'emailpro'};
1538 } elsif ($data->{'B_email'}) {
1539 return $data->{'B_email'};
1545 =head2 GetNoticeEmailAddress
1547 $email = GetNoticeEmailAddress($borrowernumber);
1549 Return the email address of borrower used for notices, given the borrowernumber.
1550 Returns the empty string if no email address.
1554 sub GetNoticeEmailAddress {
1555 my $borrowernumber = shift;
1557 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1558 # if syspref is set to 'first valid' (value == OFF), look up email address
1559 if ( $which_address eq 'OFF' ) {
1560 return GetFirstValidEmailAddress($borrowernumber);
1562 # specified email address field
1563 my $dbh = C4::Context->dbh;
1564 my $sth = $dbh->prepare( qq{
1565 SELECT $which_address AS primaryemail
1567 WHERE borrowernumber=?
1569 $sth->execute($borrowernumber);
1570 my $data = $sth->fetchrow_hashref;
1571 return $data->{'primaryemail'} || '';
1574 =head2 GetExpiryDate
1576 $expirydate = GetExpiryDate($categorycode, $dateenrolled);
1578 Calculate expiry date given a categorycode and starting date. Date argument must be in ISO format.
1579 Return date is also in ISO format.
1584 my ( $categorycode, $dateenrolled ) = @_;
1586 if ($categorycode) {
1587 my $dbh = C4::Context->dbh;
1588 my $sth = $dbh->prepare("SELECT enrolmentperiod,enrolmentperioddate FROM categories WHERE categorycode=?");
1589 $sth->execute($categorycode);
1590 $enrolments = $sth->fetchrow_hashref;
1592 # die "GetExpiryDate: for enrollmentperiod $enrolmentperiod (category '$categorycode') starting $dateenrolled.\n";
1593 my @date = split (/-/,$dateenrolled);
1594 if($enrolments->{enrolmentperiod}){
1595 return sprintf("%04d-%02d-%02d", Add_Delta_YM(@date,0,$enrolments->{enrolmentperiod}));
1597 return $enrolments->{enrolmentperioddate};
1601 =head2 GetborCatFromCatType
1603 ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
1605 Looks up the different types of borrowers in the database. Returns two
1606 elements: a reference-to-array, which lists the borrower category
1607 codes, and a reference-to-hash, which maps the borrower category codes
1608 to category descriptions.
1613 sub GetborCatFromCatType {
1614 my ( $category_type, $action, $no_branch_limit ) = @_;
1616 my $branch_limit = $no_branch_limit
1618 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1620 # FIXME - This API seems both limited and dangerous.
1621 my $dbh = C4::Context->dbh;
1624 SELECT categories.categorycode, categories.description
1628 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1631 $request .= " $action ";
1632 $request .= " AND (branchcode = ? OR branchcode IS NULL) GROUP BY description" if $branch_limit;
1634 $request .= " WHERE branchcode = ? OR branchcode IS NULL GROUP BY description" if $branch_limit;
1636 $request .= " ORDER BY categorycode";
1638 my $sth = $dbh->prepare($request);
1640 $action ? $category_type : (),
1641 $branch_limit ? $branch_limit : ()
1647 while ( my $data = $sth->fetchrow_hashref ) {
1648 push @codes, $data->{'categorycode'};
1649 $labels{ $data->{'categorycode'} } = $data->{'description'};
1652 return ( \@codes, \%labels );
1655 =head2 GetBorrowercategory
1657 $hashref = &GetBorrowercategory($categorycode);
1659 Given the borrower's category code, the function returns the corresponding
1660 data hashref for a comprehensive information display.
1664 sub GetBorrowercategory {
1666 my $dbh = C4::Context->dbh;
1670 "SELECT description,dateofbirthrequired,upperagelimit,category_type
1672 WHERE categorycode = ?"
1674 $sth->execute($catcode);
1676 $sth->fetchrow_hashref;
1680 } # sub getborrowercategory
1683 =head2 GetBorrowerCategorycode
1685 $categorycode = &GetBorrowerCategoryCode( $borrowernumber );
1687 Given the borrowernumber, the function returns the corresponding categorycode
1691 sub GetBorrowerCategorycode {
1692 my ( $borrowernumber ) = @_;
1693 my $dbh = C4::Context->dbh;
1694 my $sth = $dbh->prepare( qq{
1697 WHERE borrowernumber = ?
1699 $sth->execute( $borrowernumber );
1700 return $sth->fetchrow;
1703 =head2 GetBorrowercategoryList
1705 $arrayref_hashref = &GetBorrowercategoryList;
1706 If no category code provided, the function returns all the categories.
1710 sub GetBorrowercategoryList {
1711 my $no_branch_limit = @_ ? shift : 0;
1712 my $branch_limit = $no_branch_limit
1714 : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
1715 my $dbh = C4::Context->dbh;
1716 my $query = "SELECT categories.* FROM categories";
1718 LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
1719 WHERE branchcode = ? OR branchcode IS NULL GROUP BY description
1721 $query .= " ORDER BY description";
1722 my $sth = $dbh->prepare( $query );
1723 $sth->execute( $branch_limit ? $branch_limit : () );
1724 my $data = $sth->fetchall_arrayref( {} );
1727 } # sub getborrowercategory
1729 =head2 ethnicitycategories
1731 ($codes_arrayref, $labels_hashref) = ðnicitycategories();
1733 Looks up the different ethnic types in the database. Returns two
1734 elements: a reference-to-array, which lists the ethnicity codes, and a
1735 reference-to-hash, which maps the ethnicity codes to ethnicity
1742 sub ethnicitycategories {
1743 my $dbh = C4::Context->dbh;
1744 my $sth = $dbh->prepare("Select code,name from ethnicity order by name");
1748 while ( my $data = $sth->fetchrow_hashref ) {
1749 push @codes, $data->{'code'};
1750 $labels{ $data->{'code'} } = $data->{'name'};
1752 return ( \@codes, \%labels );
1757 $ethn_name = &fixEthnicity($ethn_code);
1759 Takes an ethnicity code (e.g., "european" or "pi") and returns the
1760 corresponding descriptive name from the C<ethnicity> table in the
1761 Koha database ("European" or "Pacific Islander").
1768 my $ethnicity = shift;
1769 return unless $ethnicity;
1770 my $dbh = C4::Context->dbh;
1771 my $sth = $dbh->prepare("Select name from ethnicity where code = ?");
1772 $sth->execute($ethnicity);
1773 my $data = $sth->fetchrow_hashref;
1774 return $data->{'name'};
1775 } # sub fixEthnicity
1779 $dateofbirth,$date = &GetAge($date);
1781 this function return the borrowers age with the value of dateofbirth
1787 my ( $date, $date_ref ) = @_;
1789 if ( not defined $date_ref ) {
1790 $date_ref = sprintf( '%04d-%02d-%02d', Today() );
1793 my ( $year1, $month1, $day1 ) = split /-/, $date;
1794 my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
1796 my $age = $year2 - $year1;
1797 if ( $month1 . $day1 > $month2 . $day2 ) {
1806 $borrower = C4::Members::SetAge($borrower, $datetimeduration);
1807 $borrower = C4::Members::SetAge($borrower, '0015-12-10');
1808 $borrower = C4::Members::SetAge($borrower, $datetimeduration, $datetime_reference);
1810 eval { $borrower = C4::Members::SetAge($borrower, '015-1-10'); };
1811 if ($@) {print $@;} #Catch a bad ISO Date or kill your script!
1813 This function sets the borrower's dateofbirth to match the given age.
1814 Optionally relative to the given $datetime_reference.
1816 @PARAM1 koha.borrowers-object
1817 @PARAM2 DateTime::Duration-object as the desired age
1818 OR a ISO 8601 Date. (To make the API more pleasant)
1819 @PARAM3 DateTime-object as the relative date, defaults to now().
1820 RETURNS The given borrower reference @PARAM1.
1821 DIES If there was an error with the ISO Date handling.
1827 my ( $borrower, $datetimeduration, $datetime_ref ) = @_;
1828 $datetime_ref = DateTime->now() unless $datetime_ref;
1830 if ($datetimeduration && ref $datetimeduration ne 'DateTime::Duration') {
1831 if ($datetimeduration =~ /^(\d{4})-(\d{2})-(\d{2})/) {
1832 $datetimeduration = DateTime::Duration->new(years => $1, months => $2, days => $3);
1835 die "C4::Members::SetAge($borrower, $datetimeduration), datetimeduration not a valid ISO 8601 Date!\n";
1839 my $new_datetime_ref = $datetime_ref->clone();
1840 $new_datetime_ref->subtract_duration( $datetimeduration );
1842 $borrower->{dateofbirth} = $new_datetime_ref->ymd();
1849 $cityarrayref = GetCities();
1851 Returns an array_ref of the entries in the cities table
1852 If there are entries in the table an empty row is returned
1853 This is currently only used to populate a popup in memberentry
1859 my $dbh = C4::Context->dbh;
1860 my $city_arr = $dbh->selectall_arrayref(
1861 q|SELECT cityid,city_zipcode,city_name,city_state,city_country FROM cities ORDER BY city_name|,
1863 if ( @{$city_arr} ) {
1864 unshift @{$city_arr}, {
1865 city_zipcode => q{},
1869 city_country
=> q{},
1876 =head2 GetSortDetails (OUEST-PROVENCE)
1878 ($lib) = &GetSortDetails($category,$sortvalue);
1880 Returns the authorized value details
1881 C<&$lib>return value of authorized value details
1882 C<&$sortvalue>this is the value of authorized value
1883 C<&$category>this is the value of authorized value category
1887 sub GetSortDetails
{
1888 my ( $category, $sortvalue ) = @_;
1889 my $dbh = C4
::Context
->dbh;
1890 my $query = qq|SELECT lib
1891 FROM authorised_values
1893 AND authorised_value
=?
|;
1894 my $sth = $dbh->prepare($query);
1895 $sth->execute( $category, $sortvalue );
1896 my $lib = $sth->fetchrow;
1897 return ($lib) if ($lib);
1898 return ($sortvalue) unless ($lib);
1901 =head2 MoveMemberToDeleted
1903 $result = &MoveMemberToDeleted($borrowernumber);
1905 Copy the record from borrowers to deletedborrowers table.
1906 The routine returns 1 for success, undef for failure.
1910 sub MoveMemberToDeleted
{
1911 my ($member) = shift or return;
1913 my $schema = Koha
::Database
->new()->schema();
1914 my $borrowers_rs = $schema->resultset('Borrower');
1915 $borrowers_rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
1916 my $borrower = $borrowers_rs->find($member);
1917 return unless $borrower;
1919 my $deleted = $schema->resultset('Deletedborrower')->create($borrower);
1921 return $deleted ?
1 : undef;
1926 DelMember($borrowernumber);
1928 This function remove directly a borrower whitout writing it on deleteborrower.
1929 + Deletes reserves for the borrower
1934 my $dbh = C4
::Context
->dbh;
1935 my $borrowernumber = shift;
1936 #warn "in delmember with $borrowernumber";
1937 return unless $borrowernumber; # borrowernumber is mandatory.
1939 my $query = qq|DELETE
1941 WHERE borrowernumber
=?
|;
1942 my $sth = $dbh->prepare($query);
1943 $sth->execute($borrowernumber);
1947 WHERE borrowernumber = ?
1949 $sth = $dbh->prepare($query);
1950 $sth->execute($borrowernumber);
1951 logaction
("MEMBERS", "DELETE", $borrowernumber, "") if C4
::Context
->preference("BorrowersLog");
1955 =head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
1957 $date = ExtendMemberSubscriptionTo($borrowerid, $date);
1959 Extending the subscription to a given date or to the expiry date calculated on ISO date.
1964 sub ExtendMemberSubscriptionTo
{
1965 my ( $borrowerid,$date) = @_;
1966 my $dbh = C4
::Context
->dbh;
1967 my $borrower = GetMember
('borrowernumber'=>$borrowerid);
1969 $date = (C4
::Context
->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry') ?
1970 C4
::Dates
->new($borrower->{'dateexpiry'}, 'iso')->output("iso") :
1971 C4
::Dates
->new()->output("iso");
1972 $date = GetExpiryDate
( $borrower->{'categorycode'}, $date );
1974 my $sth = $dbh->do(<<EOF);
1976 SET dateexpiry='$date'
1977 WHERE borrowernumber='$borrowerid'
1980 AddEnrolmentFeeIfNeeded
( $borrower->{categorycode
}, $borrower->{borrowernumber
} );
1982 logaction
("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4
::Context
->preference("BorrowersLog");
1983 return $date if ($sth);
1987 =head2 GetTitles (OUEST-PROVENCE)
1989 ($borrowertitle)= &GetTitles();
1991 Looks up the different title . Returns array with all borrowers title
1996 my @borrowerTitle = split (/,|\|/,C4
::Context
->preference('BorrowersTitles'));
1997 unshift( @borrowerTitle, "" );
1998 my $count=@borrowerTitle;
2003 return ( \
@borrowerTitle);
2007 =head2 GetPatronImage
2009 my ($imagedata, $dberror) = GetPatronImage($borrowernumber);
2011 Returns the mimetype and binary image data of the image for the patron with the supplied borrowernumber.
2015 sub GetPatronImage
{
2016 my ($borrowernumber) = @_;
2017 warn "Borrowernumber passed to GetPatronImage is $borrowernumber" if $debug;
2018 my $dbh = C4
::Context
->dbh;
2019 my $query = 'SELECT mimetype, imagefile FROM patronimage WHERE borrowernumber = ?';
2020 my $sth = $dbh->prepare($query);
2021 $sth->execute($borrowernumber);
2022 my $imagedata = $sth->fetchrow_hashref;
2023 warn "Database error!" if $sth->errstr;
2024 return $imagedata, $sth->errstr;
2027 =head2 PutPatronImage
2029 PutPatronImage($cardnumber, $mimetype, $imgfile);
2031 Stores patron binary image data and mimetype in database.
2032 NOTE: This function is good for updating images as well as inserting new images in the database.
2036 sub PutPatronImage
{
2037 my ($cardnumber, $mimetype, $imgfile) = @_;
2038 warn "Parameters passed in: Cardnumber=$cardnumber, Mimetype=$mimetype, " . ($imgfile ?
"Imagefile" : "No Imagefile") if $debug;
2039 my $dbh = C4
::Context
->dbh;
2040 my $query = "INSERT INTO patronimage (borrowernumber, mimetype, imagefile) VALUES ( ( SELECT borrowernumber from borrowers WHERE cardnumber = ? ),?,?) ON DUPLICATE KEY UPDATE imagefile = ?;";
2041 my $sth = $dbh->prepare($query);
2042 $sth->execute($cardnumber,$mimetype,$imgfile,$imgfile);
2043 warn "Error returned inserting $cardnumber.$mimetype." if $sth->errstr;
2044 return $sth->errstr;
2047 =head2 RmPatronImage
2049 my ($dberror) = RmPatronImage($borrowernumber);
2051 Removes the image for the patron with the supplied borrowernumber.
2056 my ($borrowernumber) = @_;
2057 warn "Borrowernumber passed to GetPatronImage is $borrowernumber" if $debug;
2058 my $dbh = C4
::Context
->dbh;
2059 my $query = "DELETE FROM patronimage WHERE borrowernumber = ?;";
2060 my $sth = $dbh->prepare($query);
2061 $sth->execute($borrowernumber);
2062 my $dberror = $sth->errstr;
2063 warn "Database error!" if $sth->errstr;
2067 =head2 GetHideLostItemsPreference
2069 $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
2071 Returns the HideLostItems preference for the patron category of the supplied borrowernumber
2072 C<&$hidelostitemspref>return value of function, 0 or 1
2076 sub GetHideLostItemsPreference
{
2077 my ($borrowernumber) = @_;
2078 my $dbh = C4
::Context
->dbh;
2079 my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
2080 my $sth = $dbh->prepare($query);
2081 $sth->execute($borrowernumber);
2082 my $hidelostitems = $sth->fetchrow;
2083 return $hidelostitems;
2086 =head2 GetBorrowersToExpunge
2088 $borrowers = &GetBorrowersToExpunge(
2089 not_borrowered_since => $not_borrowered_since,
2090 expired_before => $expired_before,
2091 category_code => $category_code,
2092 branchcode => $branchcode
2095 This function get all borrowers based on the given criteria.
2099 sub GetBorrowersToExpunge
{
2102 my $filterdate = $params->{'not_borrowered_since'};
2103 my $filterexpiry = $params->{'expired_before'};
2104 my $filtercategory = $params->{'category_code'};
2105 my $filterbranch = $params->{'branchcode'} ||
2106 ((C4
::Context
->preference('IndependentBranches')
2107 && C4
::Context
->userenv
2108 && !C4
::Context
->IsSuperLibrarian()
2109 && C4
::Context
->userenv->{branch
})
2110 ? C4
::Context
->userenv->{branch
}
2113 my $dbh = C4
::Context
->dbh;
2115 SELECT borrowers.borrowernumber,
2116 MAX(old_issues.timestamp) AS latestissue,
2117 MAX(issues.timestamp) AS currentissue
2119 JOIN categories USING (categorycode)
2120 LEFT JOIN old_issues USING (borrowernumber)
2121 LEFT JOIN issues USING (borrowernumber)
2122 WHERE category_type <> 'S'
2123 AND borrowernumber NOT IN (SELECT guarantorid FROM borrowers WHERE guarantorid IS NOT NULL AND guarantorid <> 0)
2126 if ( $filterbranch && $filterbranch ne "" ) {
2127 $query.= " AND borrowers.branchcode = ? ";
2128 push( @query_params, $filterbranch );
2130 if ( $filterexpiry ) {
2131 $query .= " AND dateexpiry < ? ";
2132 push( @query_params, $filterexpiry );
2134 if ( $filtercategory ) {
2135 $query .= " AND categorycode = ? ";
2136 push( @query_params, $filtercategory );
2138 $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
2139 if ( $filterdate ) {
2140 $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
2141 push @query_params,$filterdate;
2143 warn $query if $debug;
2145 my $sth = $dbh->prepare($query);
2146 if (scalar(@query_params)>0){
2147 $sth->execute(@query_params);
2154 while ( my $data = $sth->fetchrow_hashref ) {
2155 push @results, $data;
2160 =head2 GetBorrowersWhoHaveNeverBorrowed
2162 $results = &GetBorrowersWhoHaveNeverBorrowed
2164 This function get all borrowers who have never borrowed.
2166 I<$result> is a ref to an array which all elements are a hasref.
2170 sub GetBorrowersWhoHaveNeverBorrowed
{
2171 my $filterbranch = shift ||
2172 ((C4
::Context
->preference('IndependentBranches')
2173 && C4
::Context
->userenv
2174 && !C4
::Context
->IsSuperLibrarian()
2175 && C4
::Context
->userenv->{branch
})
2176 ? C4
::Context
->userenv->{branch
}
2178 my $dbh = C4
::Context
->dbh;
2180 SELECT borrowers.borrowernumber,max(timestamp) as latestissue
2182 LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
2183 WHERE issues.borrowernumber IS NULL
2186 if ($filterbranch && $filterbranch ne ""){
2187 $query.=" AND borrowers.branchcode= ?";
2188 push @query_params,$filterbranch;
2190 warn $query if $debug;
2192 my $sth = $dbh->prepare($query);
2193 if (scalar(@query_params)>0){
2194 $sth->execute(@query_params);
2201 while ( my $data = $sth->fetchrow_hashref ) {
2202 push @results, $data;
2207 =head2 GetBorrowersWithIssuesHistoryOlderThan
2209 $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
2211 this function get all borrowers who has an issue history older than I<$date> given on input arg.
2213 I<$result> is a ref to an array which all elements are a hashref.
2214 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2218 sub GetBorrowersWithIssuesHistoryOlderThan
{
2219 my $dbh = C4
::Context
->dbh;
2220 my $date = shift ||POSIX
::strftime
("%Y-%m-%d",localtime());
2221 my $filterbranch = shift ||
2222 ((C4
::Context
->preference('IndependentBranches')
2223 && C4
::Context
->userenv
2224 && !C4
::Context
->IsSuperLibrarian()
2225 && C4
::Context
->userenv->{branch
})
2226 ? C4
::Context
->userenv->{branch
}
2229 SELECT count(borrowernumber) as n,borrowernumber
2231 WHERE returndate < ?
2232 AND borrowernumber IS NOT NULL
2235 push @query_params, $date;
2237 $query.=" AND branchcode = ?";
2238 push @query_params, $filterbranch;
2240 $query.=" GROUP BY borrowernumber ";
2241 warn $query if $debug;
2242 my $sth = $dbh->prepare($query);
2243 $sth->execute(@query_params);
2246 while ( my $data = $sth->fetchrow_hashref ) {
2247 push @results, $data;
2252 =head2 GetBorrowersNamesAndLatestIssue
2254 $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
2256 this function get borrowers Names and surnames and Issue information.
2258 I<@borrowernumbers> is an array which all elements are borrowernumbers.
2259 This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
2263 sub GetBorrowersNamesAndLatestIssue
{
2264 my $dbh = C4
::Context
->dbh;
2265 my @borrowernumbers=@_;
2267 SELECT surname,lastname, phone, email,max(timestamp)
2269 LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
2270 GROUP BY borrowernumber
2272 my $sth = $dbh->prepare($query);
2274 my $results = $sth->fetchall_arrayref({});
2280 my $success = ModPrivacy( $borrowernumber, $privacy );
2282 Update the privacy of a patron.
2285 true on success, false on failure
2290 my $borrowernumber = shift;
2291 my $privacy = shift;
2292 return unless defined $borrowernumber;
2293 return unless $borrowernumber =~ /^\d+$/;
2295 return ModMember
( borrowernumber
=> $borrowernumber,
2296 privacy
=> $privacy );
2301 AddMessage( $borrowernumber, $message_type, $message, $branchcode );
2303 Adds a message to the messages table for the given borrower.
2312 my ( $borrowernumber, $message_type, $message, $branchcode ) = @_;
2314 my $dbh = C4
::Context
->dbh;
2316 if ( ! ( $borrowernumber && $message_type && $message && $branchcode ) ) {
2320 my $query = "INSERT INTO messages ( borrowernumber, branchcode, message_type, message ) VALUES ( ?, ?, ?, ? )";
2321 my $sth = $dbh->prepare($query);
2322 $sth->execute( $borrowernumber, $branchcode, $message_type, $message );
2323 logaction
("MEMBERS", "ADDCIRCMESSAGE", $borrowernumber, $message) if C4
::Context
->preference("BorrowersLog");
2329 GetMessages( $borrowernumber, $type );
2331 $type is message type, B for borrower, or L for Librarian.
2332 Empty type returns all messages of any type.
2334 Returns all messages for the given borrowernumber
2339 my ( $borrowernumber, $type, $branchcode ) = @_;
2345 my $dbh = C4
::Context
->dbh;
2348 branches.branchname,
2351 messages.branchcode LIKE '$branchcode' AS can_delete
2352 FROM messages, branches
2353 WHERE borrowernumber = ?
2354 AND message_type LIKE ?
2355 AND messages.branchcode = branches.branchcode
2356 ORDER BY message_date DESC";
2357 my $sth = $dbh->prepare($query);
2358 $sth->execute( $borrowernumber, $type ) ;
2361 while ( my $data = $sth->fetchrow_hashref ) {
2362 my $d = C4
::Dates
->new( $data->{message_date
}, 'iso' );
2363 $data->{message_date_formatted
} = $d->output;
2364 push @results, $data;
2372 GetMessagesCount( $borrowernumber, $type );
2374 $type is message type, B for borrower, or L for Librarian.
2375 Empty type returns all messages of any type.
2377 Returns the number of messages for the given borrowernumber
2381 sub GetMessagesCount
{
2382 my ( $borrowernumber, $type, $branchcode ) = @_;
2388 my $dbh = C4
::Context
->dbh;
2390 my $query = "SELECT COUNT(*) as MsgCount FROM messages WHERE borrowernumber = ? AND message_type LIKE ?";
2391 my $sth = $dbh->prepare($query);
2392 $sth->execute( $borrowernumber, $type ) ;
2395 my $data = $sth->fetchrow_hashref;
2396 my $count = $data->{'MsgCount'};
2403 =head2 DeleteMessage
2405 DeleteMessage( $message_id );
2410 my ( $message_id ) = @_;
2412 my $dbh = C4
::Context
->dbh;
2413 my $query = "SELECT * FROM messages WHERE message_id = ?";
2414 my $sth = $dbh->prepare($query);
2415 $sth->execute( $message_id );
2416 my $message = $sth->fetchrow_hashref();
2418 $query = "DELETE FROM messages WHERE message_id = ?";
2419 $sth = $dbh->prepare($query);
2420 $sth->execute( $message_id );
2421 logaction
("MEMBERS", "DELCIRCMESSAGE", $message->{'borrowernumber'}, $message->{'message'}) if C4
::Context
->preference("BorrowersLog");
2426 IssueSlip($branchcode, $borrowernumber, $quickslip)
2428 Returns letter hash ( see C4::Letters::GetPreparedLetter )
2430 $quickslip is boolean, to indicate whether we want a quick slip
2435 my ($branch, $borrowernumber, $quickslip) = @_;
2437 # return unless ( C4::Context->boolean_preference('printcirculationslips') );
2439 my $now = POSIX
::strftime
("%Y-%m-%d", localtime);
2441 my $issueslist = GetPendingIssues
($borrowernumber);
2442 foreach my $it (@
$issueslist){
2443 if ((substr $it->{'issuedate'}, 0, 10) eq $now || (substr $it->{'lastreneweddate'}, 0, 10) eq $now) {
2446 elsif ((substr $it->{'date_due'}, 0, 10) le $now) {
2447 $it->{'overdue'} = 1;
2449 my $dt = dt_from_string
( $it->{'date_due'} );
2450 $it->{'date_due'} = output_pref
( $dt );;
2452 my @issues = sort { $b->{'timestamp'} <=> $a->{'timestamp'} } @
$issueslist;
2454 my ($letter_code, %repeat);
2456 $letter_code = 'ISSUEQSLIP';
2458 'checkedout' => [ map {
2462 }, grep { $_->{'now'} } @issues ],
2466 $letter_code = 'ISSUESLIP';
2468 'checkedout' => [ map {
2472 }, grep { !$_->{'overdue'} } @issues ],
2474 'overdue' => [ map {
2478 }, grep { $_->{'overdue'} } @issues ],
2481 $_->{'timestamp'} = $_->{'newdate'};
2483 } @
{ GetNewsToDisplay
("slip",$branch) } ],
2487 return C4
::Letters
::GetPreparedLetter
(
2488 module
=> 'circulation',
2489 letter_code
=> $letter_code,
2490 branchcode
=> $branch,
2492 'branches' => $branch,
2493 'borrowers' => $borrowernumber,
2499 =head2 GetBorrowersWithEmail
2501 ([$borrnum,$userid], ...) = GetBorrowersWithEmail('me@example.com');
2503 This gets a list of users and their basic details from their email address.
2504 As it's possible for multiple user to have the same email address, it provides
2505 you with all of them. If there is no userid for the user, there will be an
2506 C<undef> there. An empty list will be returned if there are no matches.
2510 sub GetBorrowersWithEmail
{
2513 my $dbh = C4
::Context
->dbh;
2515 my $query = "SELECT borrowernumber, userid FROM borrowers WHERE email=?";
2516 my $sth=$dbh->prepare($query);
2517 $sth->execute($email);
2519 while (my $ref = $sth->fetch) {
2522 die "Failure searching for borrowers by email address: $sth->errstr" if $sth->err;
2526 sub AddMember_Opac
{
2527 my ( %borrower ) = @_;
2529 $borrower{'categorycode'} = C4
::Context
->preference('PatronSelfRegistrationDefaultCategory');
2531 my $sr = new String
::Random
;
2532 $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
2533 my $password = $sr->randpattern("AAAAAAAAAA");
2534 $borrower{'password'} = $password;
2536 $borrower{'cardnumber'} = fixup_cardnumber
();
2538 my $borrowernumber = AddMember
(%borrower);
2540 return ( $borrowernumber, $password );
2543 =head2 AddEnrolmentFeeIfNeeded
2545 AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
2547 Add enrolment fee for a patron if needed.
2551 sub AddEnrolmentFeeIfNeeded
{
2552 my ( $categorycode, $borrowernumber ) = @_;
2553 # check for enrollment fee & add it if needed
2554 my $dbh = C4
::Context
->dbh;
2555 my $sth = $dbh->prepare(q{
2558 WHERE categorycode=?
2560 $sth->execute( $categorycode );
2562 warn sprintf('Database returned the following error: %s', $sth->errstr);
2565 my ($enrolmentfee) = $sth->fetchrow;
2566 if ($enrolmentfee && $enrolmentfee > 0) {
2567 # insert fee in patron debts
2568 C4
::Accounts
::manualinvoice
( $borrowernumber, '', '', 'A', $enrolmentfee );
2573 my ( $borrowernumber ) = @_;
2575 my $sql = "SELECT COUNT(*) FROM issues WHERE date_due < NOW() AND borrowernumber = ?";
2576 my $sth = C4
::Context
->dbh->prepare( $sql );
2577 $sth->execute( $borrowernumber );
2578 my ( $count ) = $sth->fetchrow_array();
2583 END { } # module clean-up code here (global destructor)