Bug 2274 [3/5]: consolidating overdue notice cronjobs into one
[srvgit] / C4 / Members.pm
index 8d38619..8f27e8e 100644 (file)
@@ -58,15 +58,16 @@ BEGIN {
                &GetSortDetails
                &GetTitles
 
-                &GetPatronImage
-                &PutPatronImage
-                &RmPatronImage
+    &GetPatronImage
+    &PutPatronImage
+    &RmPatronImage
 
                &GetMemberAccountRecords
                &GetBorNotifyAcctRecord
 
                &GetborCatFromCatType 
                &GetBorrowercategory
+    &GetBorrowercategoryList
 
                &GetBorrowersWhoHaveNotBorrowedSince
                &GetBorrowersWhoHaveNeverBorrowed
@@ -126,6 +127,8 @@ This module contains routines for adding, modifying and deleting members/patrons
 
   ($count, $borrowers) = &SearchMember($searchstring, $type,$category_type,$filter,$showallbranches);
 
+=back
+
 Looks up patrons (borrowers) by name.
 
 BUGFIX 499: C<$type> is now used to determine type of search.
@@ -215,9 +218,19 @@ sub SearchMember {
 
             # FIXME - .= <<EOT;
         }
-        $query = $query . ") OR cardnumber LIKE ?
-        order by $orderby";
+        $query = $query . ") OR cardnumber LIKE ? ";
         push( @bind, $searchstring );
+        if (C4::Context->preference('ExtendedPatronAttributes')) {
+            $query .= "OR borrowernumber IN (
+SELECT borrowernumber
+FROM borrower_attributes
+JOIN borrower_attribute_types USING (code)
+WHERE staff_searchable = 1
+AND attribute like ?
+)";
+            push (@bind, $searchstring);
+        }
+        $query .= "order by $orderby";
 
         # FIXME - .= <<EOT;
     }
@@ -235,7 +248,7 @@ sub SearchMember {
 
 =head2 GetMemberDetails
 
-($borrower, $flags) = &GetMemberDetails($borrowernumber, $cardnumber);
+($borrower) = &GetMemberDetails($borrowernumber, $cardnumber);
 
 Looks up a patron and returns information about him or her. If
 C<$borrowernumber> is true (nonzero), C<&GetMemberDetails> looks
@@ -327,6 +340,12 @@ fields from the reserves table of the Koha database.
 
 =back
 
+C<$borrower-E<gt>{authflags}> is a hash giving more detailed information
+about the top-level permissions flags set for the borrower.  For example,
+if a user has the "editcatalogue" permission,
+C<$borrower-E<gt>{authflags}-E<gt>{editcatalogue}> will exist and have
+the value "1".
+
 =cut
 
 sub GetMemberDetails {
@@ -482,7 +501,7 @@ sub patronflags {
 }
 
 
-=item GetMember
+=head2 GetMember
 
   $borrower = &GetMember($information, $type);
 
@@ -507,7 +526,7 @@ SELECT borrowers.*, categories.category_type, categories.description
 FROM borrowers 
 LEFT JOIN categories on borrowers.categorycode=categories.categorycode 
 ";
-    if ($type eq 'cardnumber' || $type eq 'firstname'|| $type eq 'userid'|| $type eq 'borrowernumber'){
+    if ( defined $type && ( $type eq 'cardnumber' || $type eq 'firstname'|| $type eq 'userid'|| $type eq 'borrowernumber' ) ){
         $information = uc $information;
         $sth = $dbh->prepare("$select WHERE $type=?");
     } else {
@@ -528,7 +547,7 @@ LEFT JOIN categories on borrowers.categorycode=categories.categorycode
     return undef;        
 }
 
-=item GetMemberIssuesAndFines
+=head2 GetMemberIssuesAndFines
 
   ($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
 
@@ -573,12 +592,19 @@ sub GetMemberIssuesAndFines {
 
 =head2
 
-=item ModMember
+=head2 ModMember
+
+=over 4
 
-  &ModMember($borrowernumber);
+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
 
 #'
@@ -617,12 +643,18 @@ sub ModMember {
         $data{'password'} = md5_base64( $data{'password'} )  if ($data{'password'} ne "");
         delete $data{'password'} if ($data{password} eq "");
     }
-    foreach (keys %data)
-    { push @parameters,"$_ = ".$dbh->quote($data{$_}) if ($_ ne 'borrowernumber' and $_ ne 'flags' and $hashborrowerfields{$_}); }
-    $query .= join (',',@parameters) . "\n WHERE borrowernumber=? \n";
+    foreach (keys %data){  
+        if ($_ ne 'borrowernumber' and $_ ne 'flags' and $hashborrowerfields{$_}){
+          $query .= " $_=?, "; 
+          push @parameters,$data{$_};
+        }
+    }
+    $query =~ s/, $//;
+    $query .= " WHERE borrowernumber=?";
+    push @parameters, $data{'borrowernumber'};
     $debug and print STDERR "$query (executed w/ arg: $data{'borrowernumber'})";
     $sth = $dbh->prepare($query);
-    $sth->execute($data{'borrowernumber'});
+    my $execute_success = $sth->execute(@parameters);
     $sth->finish;
 
 # ok if its an adult (type) it may have borrowers that depend on it as a guarantor
@@ -633,14 +665,16 @@ sub ModMember {
         # is adult check guarantees;
         UpdateGuarantees(%data);
     }
-    &logaction(C4::Context->userenv->{'number'},"MEMBERS","MODIFY",$data{'borrowernumber'},"$query (executed w/ arg: $data{'borrowernumber'})") 
+    logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "$query (executed w/ arg: $data{'borrowernumber'})") 
         if C4::Context->preference("BorrowersLog");
+
+    return $execute_success;
 }
 
 
 =head2
 
-=item AddMember
+=head2 AddMember
 
   $borrowernumber = &AddMember(%borrower);
 
@@ -729,8 +763,7 @@ sub AddMember {
     $data{'borrowernumber'} = $dbh->{'mysql_insertid'};     # unneeded w/ autoincrement ?  
     # mysql_insertid is probably bad.  not necessarily accurate and mysql-specific at best.
     
-    &logaction(C4::Context->userenv->{'number'},"MEMBERS","CREATE",$data{'borrowernumber'},"") 
-        if C4::Context->preference("BorrowersLog");
+    logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
     
     # check for enrollment fee & add it if needed
     $sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
@@ -767,12 +800,13 @@ sub changepassword {
 
 #Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
 #Then we need to tell the user and have them create a new one.
+    my $resultcode;
     my $sth =
       $dbh->prepare(
         "SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
     $sth->execute( $uid, $member );
     if ( ( $uid ne '' ) && ( my $row = $sth->fetchrow_hashref ) ) {
-        return 0;
+        $resultcode=0;
     }
     else {
         #Everything is good so we can update the information.
@@ -780,16 +814,16 @@ sub changepassword {
           $dbh->prepare(
             "update borrowers set userid=?, password=? where borrowernumber=?");
         $sth->execute( $uid, $digest, $member );
-        return 1;
+        $resultcode=1;
     }
     
-    &logaction(C4::Context->userenv->{'number'},"MEMBERS","CHANGE PASS",$member,"") 
-        if C4::Context->preference("BorrowersLog");
+    logaction("MEMBERS", "CHANGE PASS", $member, "") if C4::Context->preference("BorrowersLog");
+    return $resultcode;    
 }
 
 
 
-=item fixup_cardnumber
+=head2 fixup_cardnumber
 
 Warning: The caller is responsible for locking the members table in write
 mode, to avoid database corruption.
@@ -1305,13 +1339,14 @@ to category descriptions.
 #'
 sub GetborCatFromCatType {
     my ( $category_type, $action ) = @_;
+       # FIXME - This API  seems both limited and dangerous. 
     my $dbh     = C4::Context->dbh;
     my $request = qq|   SELECT categorycode,description 
             FROM categories 
             $action
             ORDER BY categorycode|;
     my $sth = $dbh->prepare($request);
-    if ($action) {
+       if ($action) {
         $sth->execute($category_type);
     }
     else {
@@ -1335,21 +1370,49 @@ 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
 
 sub GetBorrowercategory {
     my ($catcode) = @_;
     my $dbh       = C4::Context->dbh;
+    if ($catcode){
+        my $sth       =
+        $dbh->prepare(
+    "SELECT description,dateofbirthrequired,upperagelimit,category_type 
+    FROM categories 
+    WHERE categorycode = ?"
+        );
+        $sth->execute($catcode);
+        my $data =
+        $sth->fetchrow_hashref;
+        $sth->finish();
+        return $data;
+    } 
+    return;  
+}    # sub getborrowercategory
+
+=head2 GetBorrowercategoryList
+  $arrayref_hashref = &GetBorrowercategoryList;
+If no category code provided, the function returns all the categories.
+
+=cut
+
+sub GetBorrowercategoryList {
+    my $dbh       = C4::Context->dbh;
     my $sth       =
-      $dbh->prepare(
-"SELECT description,dateofbirthrequired,upperagelimit,category_type 
- FROM categories 
WHERE categorycode = ?"
-      );
-    $sth->execute($catcode);
+    $dbh->prepare(
+    "SELECT * 
   FROM categories 
   ORDER BY description"
+        );
+    $sth->execute;
     my $data =
-      $sth->fetchrow_hashref;
+    $sth->fetchall_arrayref({});
     $sth->finish();
     return $data;
 }    # sub getborrowercategory
@@ -1604,8 +1667,7 @@ sub DelMember {
     $sth = $dbh->prepare($query);
     $sth->execute($borrowernumber);
     $sth->finish;
-    &logaction(C4::Context->userenv->{'number'},"MEMBERS","DELETE",$borrowernumber,"") 
-        if C4::Context->preference("BorrowersLog");
+    logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
     return $sth->rows;
 }
 
@@ -1800,24 +1862,48 @@ WHERE roadtypeid=?|;
 &GetBorrowersWhoHaveNotBorrowedSince($date)
 
 this function get all borrowers who haven't borrowed since the date given on input arg.
-
+      
 =cut
 
 sub GetBorrowersWhoHaveNotBorrowedSince {
-    my $date = shift;
-    return unless $date;    # date is mandatory.
+### TODO : It could be dangerous to delete Borrowers who have just been entered and who have not yet borrowed any book. May be good to add a dateexpiry or dateenrolled filter.      
+       
+                my $filterdate = shift||POSIX::strftime("%Y-%m-%d",localtime());
+    my $filterbranch = shift || 
+                        ((C4::Context->preference('IndependantBranches') 
+                             && C4::Context->userenv 
+                             && C4::Context->userenv->{flags}!=1 
+                             && C4::Context->userenv->{branch})
+                         ? C4::Context->userenv->{branch}
+                         : "");  
     my $dbh   = C4::Context->dbh;
     my $query = "
-        SELECT borrowers.borrowernumber,max(timestamp)
+        SELECT borrowers.borrowernumber,max(issues.timestamp) as latestissue
         FROM   borrowers
-          LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
-        WHERE issues.borrowernumber IS NOT NULL
-        GROUP BY borrowers.borrowernumber
+        JOIN   categories USING (categorycode)
+        LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
+        WHERE  category_type <> 'S'
    ";
+    my @query_params;
+    if ($filterbranch && $filterbranch ne ""){ 
+        $query.=" AND borrowers.branchcode= ?";
+        push @query_params,$filterbranch;
+    }    
+    $query.=" GROUP BY borrowers.borrowernumber";
+    if ($filterdate){ 
+        $query.=" HAVING latestissue <? OR latestissue IS NULL";
+        push @query_params,$filterdate;
+    }
+    warn $query if $debug;
     my $sth = $dbh->prepare($query);
-    $sth->execute;
+    if (scalar(@query_params)>0){  
+        $sth->execute(@query_params);
+    } 
+    else {
+        $sth->execute;
+    }      
+    
     my @results;
-
     while ( my $data = $sth->fetchrow_hashref ) {
         push @results, $data;
     }
@@ -1835,15 +1921,35 @@ I<$result> is a ref to an array which all elements are a hasref.
 =cut
 
 sub GetBorrowersWhoHaveNeverBorrowed {
+    my $filterbranch = shift || 
+                        ((C4::Context->preference('IndependantBranches') 
+                             && C4::Context->userenv 
+                             && C4::Context->userenv->{flags}!=1 
+                             && C4::Context->userenv->{branch})
+                         ? C4::Context->userenv->{branch}
+                         : "");  
     my $dbh   = C4::Context->dbh;
     my $query = "
-        SELECT borrowers.borrowernumber,max(timestamp)
+        SELECT borrowers.borrowernumber,max(timestamp) as latestissue
         FROM   borrowers
           LEFT JOIN issues ON borrowers.borrowernumber = issues.borrowernumber
         WHERE issues.borrowernumber IS NULL
    ";
+    my @query_params;
+    if ($filterbranch && $filterbranch ne ""){ 
+        $query.=" AND borrowers.branchcode= ?";
+        push @query_params,$filterbranch;
+    }
+    warn $query if $debug;
+  
     my $sth = $dbh->prepare($query);
-    $sth->execute;
+    if (scalar(@query_params)>0){  
+        $sth->execute(@query_params);
+    } 
+    else {
+        $sth->execute;
+    }      
+    
     my @results;
     while ( my $data = $sth->fetchrow_hashref ) {
         push @results, $data;
@@ -1864,17 +1970,30 @@ This hashref is containt the number of time this borrowers has borrowed before I
 
 sub GetBorrowersWithIssuesHistoryOlderThan {
     my $dbh  = C4::Context->dbh;
-    my $date = shift;
-    return unless $date;    # date is mandatory.
+    my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
+    my $filterbranch = shift || 
+                        ((C4::Context->preference('IndependantBranches') 
+                             && C4::Context->userenv 
+                             && C4::Context->userenv->{flags}!=1 
+                             && C4::Context->userenv->{branch})
+                         ? C4::Context->userenv->{branch}
+                         : "");  
     my $query = "
        SELECT count(borrowernumber) as n,borrowernumber
        FROM old_issues
        WHERE returndate < ?
          AND borrowernumber IS NOT NULL 
-       GROUP BY borrowernumber
-   ";
+    "; 
+    my @query_params;
+    push @query_params, $date;
+    if ($filterbranch){
+        $query.="   AND branchcode = ?";
+        push @query_params, $filterbranch;
+    }    
+    $query.=" GROUP BY borrowernumber ";
+    warn $query if $debug;
     my $sth = $dbh->prepare($query);
-    $sth->execute($date);
+    $sth->execute(@query_params);
     my @results;
 
     while ( my $data = $sth->fetchrow_hashref ) {
@@ -1883,14 +2002,65 @@ sub GetBorrowersWithIssuesHistoryOlderThan {
     return \@results;
 }
 
+=head2 GetBorrowersNamesAndLatestIssue
+
+$results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
+
+this function get borrowers Names and surnames and Issue information.
+
+I<@borrowernumbers> is an array which all elements are borrowernumbers.
+This hashref is containt the number of time this borrowers has borrowed before I<$date> and the borrowernumber.
+
+=cut
+
+sub GetBorrowersNamesAndLatestIssue {
+    my $dbh  = C4::Context->dbh;
+    my @borrowernumbers=@_;  
+    my $query = "
+       SELECT surname,lastname, phone, email,max(timestamp)
+       FROM borrowers 
+         LEFT JOIN issues ON borrowers.borrowernumber=issues.borrowernumber
+       GROUP BY borrowernumber
+   ";
+    my $sth = $dbh->prepare($query);
+    $sth->execute;
+    my $results = $sth->fetchall_arrayref({});
+    return $results;
+}
+
+=head2 DebarMember
+
+=over 4
+
+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 {
+    my $borrowernumber = shift;
+
+    return unless defined $borrowernumber;
+    return unless $borrowernumber =~ /^\d+$/;
+
+    return ModMember( borrowernumber => $borrowernumber,
+                      debarred       => 1 );
+    
+}
+
 END { }    # module clean-up code here (global destructor)
 
 1;
 
 __END__
 
-=back
-
 =head1 AUTHOR
 
 Koha Team