(MT #3651) Fix problems on search filters.
[koha.git] / C4 / Members.pm
index 19cc9fa..cddbf41 100644 (file)
@@ -56,6 +56,8 @@ BEGIN {
                &getzipnamecity 
                &getidcity
 
+                &GetFirstValidEmailAddress
+
                &GetAge 
                &GetCities 
                &GetRoadTypes 
@@ -133,13 +135,10 @@ This module contains routines for adding, modifying and deleting members/patrons
 
 =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.
 
@@ -245,13 +244,10 @@ sub SearchMember {
     return ( scalar(@$data), $data );
 }
 
-=over 2
-
-=item Search
+=head2 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.
 
@@ -378,9 +374,9 @@ sub 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
@@ -412,17 +408,17 @@ sub GetMemberDetails {
  $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.
 
@@ -577,11 +573,7 @@ sub GetMember {
 
 =head2 IsMemberBlocked
 
-=over 4
-
-my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
-
-=back
+  my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
 
 Returns whether a patron has overdue items that may result
 in a block or whether the patron has active fine days
@@ -589,12 +581,15 @@ that would block circulation privileges.
 
 C<$block_status> can have the following values:
 
--1 if the patron has overdue items, in which case C<$count> is the number of them
-
 1 if the patron has outstanding fine days, in which case C<$count> is the number of them
 
+-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.
@@ -604,25 +599,14 @@ to a block based on whether the patron has any fine days accrued.
 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 < curdate()"
-    );
-    $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)
@@ -639,7 +623,7 @@ sub IsMemberBlocked {
             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'};
@@ -647,6 +631,18 @@ sub IsMemberBlocked {
 
     return (1, $blockedcount) if $blockedcount > 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);
 }
 
@@ -694,22 +690,18 @@ sub columns(;$) {
     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
@@ -736,8 +728,6 @@ sub ModMember {
 }
 
 
-=head2
-
 =head2 AddMember
 
   $borrowernumber = &AddMember(%borrower);
@@ -1259,6 +1249,33 @@ sub getidcity {
     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 
 
@@ -1353,8 +1370,9 @@ sub GetborCatFromCatType {
 
 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
@@ -1378,7 +1396,7 @@ sub GetBorrowercategory {
 }    # sub getborrowercategory
 
 =head2 GetBorrowercategoryList
+
   $arrayref_hashref = &GetBorrowercategoryList;
 If no category code provided, the function returns all the categories.
 
@@ -1474,6 +1492,7 @@ sub GetAge{
 }    # sub get_age
 
 =head2 get_institutions
+
   $insitutions = get_institutions();
 
 Just returns a list of all the borrowers of type I, borrownumber and name
@@ -1599,7 +1618,7 @@ sub MoveMemberToDeleted {
 
 =head2 DelMember
 
-DelMember($borrowernumber);
+    DelMember($borrowernumber);
 
 This function remove directly a borrower whitout writing it on deleteborrower.
 + Deletes reserves for the borrower
@@ -1809,10 +1828,10 @@ WHERE roadtypeid=?|;
 
 =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 {
@@ -1870,9 +1889,9 @@ 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.
 
@@ -1917,7 +1936,7 @@ sub GetBorrowersWhoHaveNeverBorrowed {
 
 =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.
 
@@ -1962,7 +1981,7 @@ sub GetBorrowersWithIssuesHistoryOlderThan {
 
 =head2 GetBorrowersNamesAndLatestIssue
 
-$results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
+  $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
 
 this function get borrowers Names and surnames and Issue information.
 
@@ -1988,9 +2007,7 @@ sub GetBorrowersNamesAndLatestIssue {
 
 =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.
@@ -1998,8 +2015,6 @@ items.
 return :
 true on success, false on failure
 
-=back
-
 =cut
 
 sub DebarMember {
@@ -2015,9 +2030,7 @@ sub DebarMember {
 
 =head2 AddMessage
 
-=over 4
-
-AddMessage( $borrowernumber, $message_type, $message, $branchcode );
+  AddMessage( $borrowernumber, $message_type, $message, $branchcode );
 
 Adds a message to the messages table for the given borrower.
 
@@ -2025,8 +2038,6 @@ Returns:
   True on success
   False on failure
 
-=back
-
 =cut
 
 sub AddMessage {
@@ -2047,17 +2058,13 @@ 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 {
@@ -2092,17 +2099,13 @@ sub GetMessages {
 
 =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 {
@@ -2129,11 +2132,7 @@ sub GetMessagesCount {
 
 =head2 DeleteMessage
 
-=over 4
-
-DeleteMessage( $message_id );
-
-=back
+  DeleteMessage( $message_id );
 
 =cut