package C4::Members;
# Copyright 2000-2003 Katipo Communications
+# Copyright 2010 BibLibre
#
# This file is part of Koha.
#
use strict;
+#use warnings; FIXME - Bug 2505
use C4::Context;
use C4::Dates qw(format_date_in_iso);
use Digest::MD5 qw(md5_base64);
&getzipnamecity
&getidcity
+ &GetFirstValidEmailAddress
+
&GetAge
&GetCities
&GetRoadTypes
push @EXPORT, qw(
&ModMember
&changepassword
+ &ModPrivacy
);
#Delete data
=head1 FUNCTIONS
-=over 2
-
-=item SearchMember
+=head2 SearchMember
- ($count, $borrowers) = &SearchMember($searchstring, $type,$category_type,$filter,$showallbranches);
-
-=back
+ ($count, $borrowers) = &SearchMember($searchstring, $type,
+ $category_type, $filter, $showallbranches);
Looks up patrons (borrowers) by name.
return ( scalar(@$data), $data );
}
-=over 2
+=head2 Search
-=item Search
-
- $borrowers_result_array_ref = &Search($filter,$orderby, $limit, $columns_out, $search_on_fields,$searchtype);
-
-=back
+ $borrowers_result_array_ref = &Search($filter,$orderby, $limit,
+ $columns_out, $search_on_fields,$searchtype);
Looks up patrons (borrowers) on filter.
=cut
sub Search {
- my ($filter,$orderby, $limit, $columns_out, $search_on_fields,$searchtype) = @_;
- my @filters;
- if (ref($filter) eq "ARRAY"){
- push @filters,@$filter;
- }
- else {
- push @filters,$filter;
- }
- if (C4::Context->preference('ExtendedPatronAttributes')) {
- my $matching_records = C4::Members::Attributes::SearchIdMatchingAttribute($filter);
- push @filters,@$matching_records;
- }
- $searchtype||="start_with";
- my $data=SearchInTable("borrowers",\@filters,$orderby,$limit,$columns_out,$search_on_fields,$searchtype);
-
- return ( $data );
+ my ( $filter, $orderby, $limit, $columns_out, $search_on_fields, $searchtype ) = @_;
+ my @filters;
+ my %filtersmatching_record;
+ my @finalfilter;
+ if ( ref($filter) eq "ARRAY" ) {
+ push @filters, @$filter;
+ } else {
+ push @filters, $filter;
+ }
+ if ( C4::Context->preference('ExtendedPatronAttributes') ) {
+ my $matching_records = C4::Members::Attributes::SearchIdMatchingAttribute($filter);
+ if(scalar(@$matching_records)>0) {
+ foreach my $matching_record (@$matching_records) {
+ $filtersmatching_record{$$matching_record[0]}=1;
+ }
+ foreach my $k (keys(%filtersmatching_record)) {
+ push @filters, {"borrowernumber"=>$k};
+ }
+ }
+ }
+ $searchtype ||= "start_with";
+ push @finalfilter, \@filters;
+ my $data = SearchInTable( "borrowers", \@finalfilter, $orderby, $limit, $columns_out, $search_on_fields, $searchtype );
+ return ($data);
}
=head2 GetMemberDetails
$flags = &patronflags($patron);
- This function is not exported.
+This function is not exported.
- The following will be set where applicable:
+The following will be set where applicable:
$flags->{CHARGES}->{amount} Amount of debt
$flags->{CHARGES}->{noissues} Set if debt amount >$5.00 (or syspref noissuescharge)
$flags->{CHARGES}->{message} Message -- deprecated
$flags->{WAITING}->{message} Message -- deprecated
$flags->{WAITING}->{itemlist} ref-to-array: list of available items
-=over 4
+=over
-C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
+=item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
overdue items. Its elements are references-to-hash, each describing an
overdue item. The keys are selected fields from the issues, biblio,
biblioitems, and items tables of the Koha database.
-C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
+=item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
the overdue items, one per line. Deprecated.
-C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
+=item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
available items. Each element is a reference-to-hash whose keys are
fields from the reserves table of the Koha database.
my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
$flaginfo{'message'} = sprintf "Patron owes \$%.02f", $amount;
$flaginfo{'amount'} = sprintf "%.02f", $amount;
- if ( $amount > $noissuescharge ) {
+ if ( $amount > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
$flaginfo{'noissues'} = 1;
}
$flags{'CHARGES'} = \%flaginfo;
$flags{'NOTES'} = \%flaginfo;
}
my ( $odues, $itemsoverdue ) = checkoverdues($patroninformation->{'borrowernumber'});
- if ( $odues > 0 ) {
+ if ( $odues && $odues > 0 ) {
my %flaginfo;
$flaginfo{'message'} = "Yes";
$flaginfo{'itemlist'} = $itemsoverdue;
=head2 IsMemberBlocked
-=over 4
+ my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
-my $blocked = IsMemberBlocked( $borrowernumber );
+Returns whether a patron has overdue items that may result
+in a block or whether the patron has active fine days
+that would block circulation privileges.
-return the status, and the number of day or documents, depends his punishment
+C<$block_status> can have the following values:
-return :
--1 if the user have overdue returns
-1 if the user is punished X days
-0 if the user is authorised to loan
+1 if the patron has outstanding fine days, in which case C<$count> is the number of them
-=back
+-1 if the patron has overdue items, in which case C<$count> is the number of them
+
+0 if the patron has no overdue items or outstanding fine days, in which case C<$count> is 0
+
+Outstanding fine days are checked before current overdue items
+are.
+
+FIXME: this needs to be split into two functions; a potential block
+based on the number of current overdue items could be orthogonal
+to a block based on whether the patron has any fine days accrued.
=cut
sub IsMemberBlocked {
my $borrowernumber = shift;
my $dbh = C4::Context->dbh;
- # if he have late issues
- my $sth = $dbh->prepare(
- "SELECT COUNT(*) as latedocs
- FROM issues
- WHERE borrowernumber = ?
- AND date_due < now()"
- );
- $sth->execute($borrowernumber);
- my $latedocs = $sth->fetchrow_hashref->{'latedocs'};
-
- return (-1, $latedocs) if $latedocs > 0;
+ # does patron have current fine days?
my $strsth=qq{
SELECT
ADDDATE(returndate, finedays * DATEDIFF(returndate,date_due) ) AS blockingdate,
DATEDIFF(ADDDATE(returndate, finedays * DATEDIFF(returndate,date_due)),NOW()) AS blockedcount
FROM old_issues
};
- # or if he must wait to loan
if(C4::Context->preference("item-level_itypes")){
$strsth.=
qq{ LEFT JOIN items ON (items.itemnumber=old_issues.itemnumber)
AND borrowernumber = ?
ORDER BY blockingdate DESC, blockedcount DESC
LIMIT 1};
- $sth=$dbh->prepare($strsth);
+ my $sth=$dbh->prepare($strsth);
$sth->execute($borrowernumber);
my $row = $sth->fetchrow_hashref;
my $blockeddate = $row->{'blockeddate'};
return (1, $blockedcount) if $blockedcount > 0;
- return 0
+ # if he have late issues
+ $sth = $dbh->prepare(
+ "SELECT COUNT(*) as latedocs
+ FROM issues
+ WHERE borrowernumber = ?
+ AND date_due < curdate()"
+ );
+ $sth->execute($borrowernumber);
+ my $latedocs = $sth->fetchrow_hashref->{'latedocs'};
+
+ return (-1, $latedocs) if $latedocs > 0;
+
+ return (0, 0);
}
=head2 GetMemberIssuesAndFines
$sth = $dbh->prepare(
"SELECT COUNT(*) FROM issues
WHERE borrowernumber = ?
- AND date_due < now()"
+ AND date_due < curdate()"
);
$sth->execute($borrowernumber);
my $overdue_count = $sth->fetchrow_arrayref->[0];
return @{C4::Context->dbh->selectcol_arrayref("SHOW columns from borrowers")};
}
-=head2
-
=head2 ModMember
-=over 4
-
-my $success = ModMember(borrowernumber => $borrowernumber, [ field => value ]... );
+ my $success = ModMember(borrowernumber => $borrowernumber,
+ [ field => value ]... );
Modify borrower's data. All date fields should ALREADY be in ISO format.
return :
true on success, or false on failure
-=back
-
=cut
+
sub ModMember {
my (%data) = @_;
# test to know if you must update or not the borrower password
}
-=head2
-
=head2 AddMember
$borrowernumber = &AddMember(%borrower);
#'
sub UpdateGuarantees {
- my (%data) = @_;
+ my %data = shift;
my $dbh = C4::Context->dbh;
my ( $count, $guarantees ) = GetGuarantees( $data{'borrowernumber'} );
- for ( my $i = 0 ; $i < $count ; $i++ ) {
-
- # FIXME
- # It looks like the $i is only being returned to handle walking through
- # the array, which is probably better done as a foreach loop.
- #
+ foreach my $guarantee (@$guarantees){
my $guaquery = qq|UPDATE borrowers
- SET address='$data{'address'}',fax='$data{'fax'}',
- B_city='$data{'B_city'}',mobile='$data{'mobile'}',city='$data{'city'}',phone='$data{'phone'}'
- WHERE borrowernumber='$guarantees->[$i]->{'borrowernumber'}'
+ SET address=?,fax=?,B_city=?,mobile=?,city=?,phone=?
+ WHERE borrowernumber=?
|;
- my $sth3 = $dbh->prepare($guaquery);
- $sth3->execute;
+ my $sth = $dbh->prepare($guaquery);
+ $sth->execute($data{'address'},$data{'fax'},$data{'B_city'},$data{'mobile'},$data{'city'},$data{'phone'},$guarantee->{'borrowernumber'});
}
}
=head2 GetPendingIssues
=head2 GetAllIssues
- ($count, $issues) = &GetAllIssues($borrowernumber, $sortkey, $limit);
+ $issues = &GetAllIssues($borrowernumber, $sortkey, $limit);
Looks up what the patron with the given borrowernumber has borrowed,
and sorts the results.
C<$limit> is the maximum number of results to return.
-C<&GetAllIssues> returns a two-element array. C<$issues> is a
-reference-to-array, where each element is a reference-to-hash; the
-keys are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
-C<items> tables of the Koha database. C<$count> is the number of
-elements in C<$issues>
+C<&GetAllIssues> an arrayref, C<$issues>, of hashrefs, the keys of which
+are the fields from the C<issues>, C<biblio>, C<biblioitems>, and
+C<items> tables of the Koha database.
=cut
return $data;
}
+=head2 GetFirstValidEmailAddress
+
+ $email = GetFirstValidEmailAddress($borrowernumber);
+
+Return the first valid email address for a borrower, given the borrowernumber. For now, the order
+is defined as email, emailpro, B_email. Returns the empty string if the borrower has no email
+addresses.
+
+=cut
+
+sub GetFirstValidEmailAddress {
+ my $borrowernumber = shift;
+ my $dbh = C4::Context->dbh;
+ my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
+ $sth->execute( $borrowernumber );
+ my $data = $sth->fetchrow_hashref;
+
+ if ($data->{'email'}) {
+ return $data->{'email'};
+ } elsif ($data->{'emailpro'}) {
+ return $data->{'emailpro'};
+ } elsif ($data->{'B_email'}) {
+ return $data->{'B_email'};
+ } else {
+ return '';
+ }
+}
=head2 GetExpiryDate
Given the borrower's category code, the function returns the corresponding
data hashref for a comprehensive information display.
-
+
$arrayref_hashref = &GetBorrowercategory;
+
If no category code provided, the function returns all the categories.
=cut
} # sub getborrowercategory
=head2 GetBorrowercategoryList
-
+
$arrayref_hashref = &GetBorrowercategoryList;
If no category code provided, the function returns all the categories.
} # sub get_age
=head2 get_institutions
+
$insitutions = get_institutions();
Just returns a list of all the borrowers of type I, borrownumber and name
} # sub add_member_orgs
-=head2 GetCities (OUEST-PROVENCE)
+=head2 GetCities
- ($id_cityarrayref, $city_hashref) = &GetCities();
+ $cityarrayref = GetCities();
-Looks up the different city and zip in the database. Returns two
-elements: a reference-to-array, which lists the zip city
-codes, and a reference-to-hash, which maps the name of the city.
-WHERE =>OUEST PROVENCE OR EXTERIEUR
+ Returns an array_ref of the entries in the cities table
+ If there are entries in the table an empty row is returned
+ This is currently only used to populate a popup in memberentry
=cut
sub GetCities {
- #my ($type_city) = @_;
my $dbh = C4::Context->dbh;
- my $query = qq|SELECT cityid,city_zipcode,city_name
- FROM cities
- ORDER BY city_name|;
- my $sth = $dbh->prepare($query);
-
- #$sth->execute($type_city);
- $sth->execute();
- my %city;
- my @id;
- # insert empty value to create a empty choice in cgi popup
- push @id, " ";
- $city{""} = "";
- while ( my $data = $sth->fetchrow_hashref ) {
- push @id, $data->{'city_zipcode'}."|".$data->{'city_name'};
- $city{ $data->{'city_zipcode'}."|".$data->{'city_name'} } = $data->{'city_name'};
- }
-
-#test to know if the table contain some records if no the function return nothing
- my $id = @id;
- if ( $id == 1 ) {
- # all we have is the one blank row
- return ();
- }
- else {
- unshift( @id, "" );
- return ( \@id, \%city );
- }
+ my $city_arr = $dbh->selectall_arrayref(
+ q|SELECT cityid,city_zipcode,city_name FROM cities ORDER BY city_name|,
+ { Slice => {} });
+ if ( @{$city_arr} ) {
+ unshift @{$city_arr}, {
+ city_zipcode => q{},
+ city_name => q{},
+ cityid => q{},
+ };
+ }
+
+ return $city_arr;
}
=head2 GetSortDetails (OUEST-PROVENCE)
=head2 DelMember
-DelMember($borrowernumber);
+ DelMember($borrowernumber);
This function remove directly a borrower whitout writing it on deleteborrower.
+ Deletes reserves for the borrower
=head2 GetBorrowersWhoHaveNotBorrowedSince
-&GetBorrowersWhoHaveNotBorrowedSince($date)
+ &GetBorrowersWhoHaveNotBorrowedSince($date)
this function get all borrowers who haven't borrowed since the date given on input arg.
-
+
=cut
sub GetBorrowersWhoHaveNotBorrowedSince {
=head2 GetBorrowersWhoHaveNeverBorrowed
-$results = &GetBorrowersWhoHaveNeverBorrowed
+ $results = &GetBorrowersWhoHaveNeverBorrowed
-this function get all borrowers who have never borrowed.
+This function get all borrowers who have never borrowed.
I<$result> is a ref to an array which all elements are a hasref.
=head2 GetBorrowersWithIssuesHistoryOlderThan
-$results = &GetBorrowersWithIssuesHistoryOlderThan($date)
+ $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
this function get all borrowers who has an issue history older than I<$date> given on input arg.
=head2 GetBorrowersNamesAndLatestIssue
-$results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
+ $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
this function get borrowers Names and surnames and Issue information.
=head2 DebarMember
-=over 4
-
-my $success = DebarMember( $borrowernumber );
+ my $success = DebarMember( $borrowernumber );
marks a Member as debarred, and therefore unable to checkout any more
items.
return :
true on success, false on failure
-=back
-
=cut
sub DebarMember {
}
-=head2 AddMessage
+=head2 ModPrivacy
=over 4
-AddMessage( $borrowernumber, $message_type, $message, $branchcode );
+my $success = ModPrivacy( $borrowernumber, $privacy );
+
+Update the privacy of a patron.
+
+return :
+true on success, false on failure
+
+=back
+
+=cut
+
+sub ModPrivacy {
+ my $borrowernumber = shift;
+ my $privacy = shift;
+ return unless defined $borrowernumber;
+ return unless $borrowernumber =~ /^\d+$/;
+
+ return ModMember( borrowernumber => $borrowernumber,
+ privacy => $privacy );
+}
+
+=head2 AddMessage
+
+ AddMessage( $borrowernumber, $message_type, $message, $branchcode );
Adds a message to the messages table for the given borrower.
True on success
False on failure
-=back
-
=cut
sub AddMessage {
=head2 GetMessages
-=over 4
-
-GetMessages( $borrowernumber, $type );
+ GetMessages( $borrowernumber, $type );
$type is message type, B for borrower, or L for Librarian.
Empty type returns all messages of any type.
Returns all messages for the given borrowernumber
-=back
-
=cut
sub GetMessages {
my $query = "SELECT
branches.branchname,
messages.*,
- DATE_FORMAT( message_date, '%m/%d/%Y' ) AS message_date_formatted,
+ message_date,
messages.branchcode LIKE '$branchcode' AS can_delete
FROM messages, branches
WHERE borrowernumber = ?
my @results;
while ( my $data = $sth->fetchrow_hashref ) {
+ my $d = C4::Dates->new( $data->{message_date}, 'iso' );
+ $data->{message_date_formatted} = $d->output;
push @results, $data;
}
return \@results;
=head2 GetMessages
-=over 4
-
-GetMessagesCount( $borrowernumber, $type );
+ GetMessagesCount( $borrowernumber, $type );
$type is message type, B for borrower, or L for Librarian.
Empty type returns all messages of any type.
Returns the number of messages for the given borrowernumber
-=back
-
=cut
sub GetMessagesCount {
=head2 DeleteMessage
-=over 4
-
-DeleteMessage( $message_id );
-
-=back
+ DeleteMessage( $message_id );
=cut