Bug 5549 : overdues display should be hours mins aware
[koha.git] / C4 / Suggestions.pm
index 9741a84..60d0e99 100644 (file)
@@ -1,6 +1,7 @@
 package C4::Suggestions;
 
 # Copyright 2000-2002 Katipo Communications
+# Parts Copyright Biblibre 2011
 #
 # This file is part of Koha.
 #
@@ -13,64 +14,40 @@ package C4::Suggestions;
 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License along with
-# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA  02111-1307 USA
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 
 use strict;
+#use warnings; FIXME - Bug 2505
 use CGI;
 
 use C4::Context;
 use C4::Output;
-use C4::Dates qw(format_date);
+use C4::Dates qw(format_date format_date_in_iso);
 use C4::SQLHelper qw(:all);
 use C4::Debug;
 use C4::Letters;
-use List::MoreUtils qw(any);
-use base 'Exporter';  # parent would be better there
+use List::MoreUtils qw<any>;
+use C4::Dates qw(format_date_in_iso);
+use base qw(Exporter);
 our $VERSION = 3.01;
 our @EXPORT  = qw<
-    &ConnectSuggestionAndBiblio
-    &CountSuggestion
-    &DelSuggestion
-    &GetSuggestion
-    &GetSuggestionByStatus
-    &GetSuggestionFromBiblionumber
-    &ModStatus
-    &ModSuggestion
-    &NewSuggestion
-    &SearchSuggestion
+    ConnectSuggestionAndBiblio
+    CountSuggestion
+    DelSuggestion
+    GetSuggestion
+    GetSuggestionByStatus
+    GetSuggestionFromBiblionumber
+    GetSuggestionInfoFromBiblionumber
+    GetSuggestionInfo
+    ModStatus
+    ModSuggestion
+    NewSuggestion
+    SearchSuggestion
+    DelSuggestionsOlderThan
 >;
-use C4::Dates qw(format_date_in_iso);
-use vars qw($VERSION @ISA @EXPORT);
-
-BEGIN {
-       # set the version for version checking
-       $VERSION = 3.01;
-       require Exporter;
-       @ISA = qw(Exporter);
-       @EXPORT = qw(
-               &NewSuggestion
-               &SearchSuggestion
-               &GetSuggestion
-               &GetSuggestionByStatus
-               &DelSuggestion
-               &CountSuggestion
-               &ModSuggestion
-               &ConnectSuggestionAndBiblio
-               &GetSuggestionFromBiblionumber
-    &ConnectSuggestionAndBiblio
-    &CountSuggestion
-    &DelSuggestion
-    &GetSuggestion
-    &GetSuggestionByStatus
-    &GetSuggestionFromBiblionumber
-    &ModStatus
-    &ModSuggestion
-    &NewSuggestion
-       );
-}
 
 =head1 NAME
 
@@ -114,65 +91,84 @@ Note the status is stored twice :
 sub SearchSuggestion  {
     my ($suggestion)=@_;
     my $dbh = C4::Context->dbh;
-       my @sql_params;
-    my @query =(q{ 
-    SELECT suggestions.*,
+    my @sql_params;
+    my @query = (
+    q{ SELECT suggestions.*,
         U1.branchcode   AS branchcodesuggestedby,
-        B1.branchname AS branchnamesuggestedby,
+        B1.branchname   AS branchnamesuggestedby,
         U1.surname   AS surnamesuggestedby,
         U1.firstname AS firstnamesuggestedby,
+        U1.email AS emailsuggestedby,
         U1.borrowernumber AS borrnumsuggestedby,
         U1.categorycode AS categorycodesuggestedby,
         C1.description AS categorydescriptionsuggestedby,
-        U2.branchcode AS branchcodemanagedby,
-        B2.branchname AS branchnamemanagedby,
         U2.surname   AS surnamemanagedby,
         U2.firstname AS firstnamemanagedby,
+        B2.branchname   AS branchnamesuggestedby,
+        U2.email AS emailmanagedby,
+        U2.branchcode AS branchcodemanagedby,
         U2.borrowernumber AS borrnummanagedby
     FROM suggestions
     LEFT JOIN borrowers AS U1 ON suggestedby=U1.borrowernumber
-    LEFT JOIN borrowers AS U2 ON managedby=U2.borrowernumber
+    LEFT JOIN branches AS B1 ON B1.branchcode=U1.branchcode
     LEFT JOIN categories AS C1 ON C1.categorycode = U1.categorycode
-    LEFT JOIN branches AS B1 ON B1.branchcode = U1.branchcode
-    LEFT JOIN branches AS B2 ON B2.branchcode = U2.branchcode
-       WHERE STATUS NOT IN ('CLAIMED')
-       } , map {
-           if ( my $s = $$suggestion{$_} ) {
-               push @sql_params,'%'.$s.'%'; 
-               " and suggestions.$_ like ? ";
-           } else { () }
-       } qw( title author isbn publishercode collectiontitle )
-       );
-
-       my $userenv = C4::Context->userenv;
+    LEFT JOIN borrowers AS U2 ON managedby=U2.borrowernumber
+    LEFT JOIN branches AS B2 ON B2.branchcode=U2.branchcode
+    LEFT JOIN categories AS C2 ON C2.categorycode = U2.categorycode
+    WHERE 1=1
+    } , map {
+        if ( my $s = $suggestion->{$_} ) {
+        push @sql_params,'%'.$s.'%'; 
+        " and suggestions.$_ like ? ";
+        } else { () }
+    } qw( title author isbn publishercode collectiontitle )
+    );
+
+    my $userenv = C4::Context->userenv;
     if (C4::Context->preference('IndependantBranches')) {
-                       if ($userenv) {
-                               if (($userenv->{flags} % 2) != 1 && !$$suggestion{branchcode}){
-                                  push @sql_params,$$userenv{branch};
-                                  push @query,q{ and (branchcode = ? or branchcode ='')};
-                               }
-                       }
+            if ($userenv) {
+                if (($userenv->{flags} % 2) != 1 && !$suggestion->{branchcode}){
+                push @sql_params,$$userenv{branch};
+                push @query,q{ and (suggestions.branchcode = ? or suggestions.branchcode ='')};
+                }
+            }
     }
 
     foreach my $field (grep { my $fieldname=$_;
-               any {$fieldname eq $_ } qw<
-       STATUS branchcode itemtype suggestedby managedby acceptedby
-       bookfundid biblionumber
-       >} keys %$suggestion
+        any {$fieldname eq $_ } qw<
+    STATUS branchcode itemtype suggestedby managedby acceptedby
+    bookfundid biblionumber
+    >} keys %$suggestion
     ) {
-               if ($$suggestion{$field}){
-                       push @sql_params,$$suggestion{$field};
-                       push @query, " and suggestions.$field=?";
-               } 
-               else {
-                       push @query, " and (suggestions.$field='' OR suggestions.$field IS NULL)";
-               }
+        if ($$suggestion{$field}){
+            push @sql_params,$suggestion->{$field};
+            push @query, " and suggestions.$field=?";
+        } 
+        else {
+            push @query, " and (suggestions.$field='' OR suggestions.$field IS NULL)";
+        }
+    }
+
+    my $today = C4::Dates->today('iso');
+
+    foreach ( qw( suggesteddate manageddate accepteddate ) ) {
+        my $from = $_ . "_from";
+        my $to = $_ . "_to";
+        if ($$suggestion{$from} || $$suggestion{$to}) {
+            push @query, " AND suggestions.suggesteddate BETWEEN '" 
+                . (format_date_in_iso($$suggestion{$from}) || 0000-00-00) . "' AND '" . (format_date_in_iso($$suggestion{$to}) || $today) . "'";
+        } 
     }
 
-       $debug && warn "@query";
+    $debug && warn "@query";
     my $sth=$dbh->prepare("@query");
     $sth->execute(@sql_params);
-       return ($sth->fetchall_arrayref({}));
+    my @results;
+    while ( my $data=$sth->fetchrow_hashref ){
+        $$data{$$data{STATUS}} = 1;
+        push(@results,$data);
+    }
+    return (\@results);
 }
 
 =head2 GetSuggestion
@@ -201,7 +197,7 @@ sub GetSuggestion {
 
 =head2 GetSuggestionFromBiblionumber
 
-$ordernumber = &GetSuggestionFromBiblionumber($dbh,$biblionumber)
+$ordernumber = &GetSuggestionFromBiblionumber($biblionumber)
 
 Get a suggestion from it's biblionumber.
 
@@ -211,16 +207,69 @@ the id of the suggestion which is related to the biblionumber given on input arg
 =cut
 
 sub GetSuggestionFromBiblionumber {
-    my ($dbh,$biblionumber) = @_;
-    my $query = qq|
+    my ($biblionumber) = @_;
+    my $query = q{
         SELECT suggestionid
         FROM   suggestions
-        WHERE  biblionumber=?
-    |;
+        WHERE  biblionumber=? LIMIT 1
+    };
+    my $dbh=C4::Context->dbh;
+    my $sth = $dbh->prepare($query);
+    $sth->execute($biblionumber);
+    my ($suggestionid) = $sth->fetchrow;
+    return $suggestionid;
+}
+
+=head2 GetSuggestionInfoFromBiblionumber
+
+Get a suggestion and borrower's informations from it's biblionumber.
+
+return :
+all informations (suggestion and borrower) of the suggestion which is related to the biblionumber given.
+
+=cut
+
+sub GetSuggestionInfoFromBiblionumber {
+    my ($biblionumber) = @_;
+    my $query = qq{
+        SELECT suggestions.*,
+        U1.surname   AS surnamesuggestedby,
+        U1.firstname AS firstnamesuggestedby,
+        U1.borrowernumber AS borrnumsuggestedby
+        FROM suggestions
+        LEFT JOIN borrowers AS U1 ON suggestedby=U1.borrowernumber
+        WHERE biblionumber = ? LIMIT 1
+    };
+    my $dbh = C4::Context->dbh;
     my $sth = $dbh->prepare($query);
     $sth->execute($biblionumber);
-    my ($ordernumber) = $sth->fetchrow;
-    return $ordernumber;
+    return $sth->fetchrow_hashref;
+}
+
+=head2 GetSuggestionInfo
+
+Get a suggestion and borrower's informations from it's suggestionid
+
+return :
+all informations (suggestion and borrower) of the suggestion which is related to the suggestionid given.
+
+=cut
+
+sub GetSuggestionInfo {
+    my ($suggestionid) = @_;
+    my $query = qq{
+        SELECT suggestions.*,
+        U1.surname   AS surnamesuggestedby,
+        U1.firstname AS firstnamesuggestedby,
+        U1.borrowernumber AS borrnumsuggestedby
+        FROM suggestions
+        LEFT JOIN borrowers AS U1 ON suggestedby=U1.borrowernumber
+        WHERE suggestionid = ? LIMIT 1
+    };
+    my $dbh = C4::Context->dbh;
+    my $sth = $dbh->prepare($query);
+    $sth->execute($suggestionid);
+    return $sth->fetchrow_hashref;
 }
 
 =head2 GetSuggestionByStatus
@@ -244,8 +293,8 @@ sub GetSuggestionByStatus {
                         U1.firstname AS firstnamesuggestedby,
                         U1.branchcode AS branchcodesuggestedby,
                         B1.branchname AS branchnamesuggestedby,
-                                               U1.borrowernumber AS borrnumsuggestedby,
-                                               U1.categorycode AS categorycodesuggestedby,
+                        U1.borrowernumber AS borrnumsuggestedby,
+                        U1.categorycode AS categorycodesuggestedby,
                         C1.description AS categorydescriptionsuggestedby,
                         U2.surname   AS surnamemanagedby,
                         U2.firstname AS firstnamemanagedby,
@@ -334,7 +383,7 @@ sub CountSuggestion {
             FROM suggestions
             WHERE STATUS=?
         |;
-         $sth = $dbh->prepare($query);
+        $sth = $dbh->prepare($query);
         $sth->execute($status);
     }
     my ($result) = $sth->fetchrow;
@@ -344,7 +393,7 @@ sub CountSuggestion {
 =head2 NewSuggestion
 
 
-&NewSuggestion($suggestion)
+&NewSuggestion($suggestion);
 
 Insert a new suggestion on database with value given on input arg.
 
@@ -352,8 +401,8 @@ Insert a new suggestion on database with value given on input arg.
 
 sub NewSuggestion {
     my ($suggestion) = @_;
-       $suggestion->{STATUS}="ASKED" unless $suggestion->{STATUS};
-       return InsertInTable("suggestions",$suggestion); 
+    $suggestion->{STATUS}="ASKED" unless $suggestion->{STATUS};
+    return InsertInTable("suggestions",$suggestion); 
 }
 
 =head2 ModSuggestion
@@ -371,21 +420,32 @@ Note that there is no function to modify a suggestion.
 
 sub ModSuggestion {
     my ($suggestion)=@_;
-       my $status_update_table=UpdateInTable("suggestions", $suggestion);
-    # check mail sending.
-    if ($$suggestion{STATUS}){
-        my $letter=C4::Letters::getletter('suggestions',$$suggestion{STATUS});
-        if ($letter){
-        my $enqueued = C4::Letters::EnqueueLetter({
-            letter=>$letter,
-            borrowernumber=>$$suggestion{suggestedby},
-            suggestionid=>$$suggestion{suggestionid},
-            msg_transport_type=>'email'
-            });
-        if (!$enqueued){warn "can't enqueue letter $letter";}
+    my $status_update_table=UpdateInTable("suggestions", $suggestion);
+
+    if ($suggestion->{STATUS}) {
+        # fetch the entire updated suggestion so that we can populate the letter
+        my $full_suggestion = GetSuggestion($suggestion->{suggestionid});
+        if ( my $letter =  C4::Letters::GetPreparedLetter (
+            module => 'suggestions',
+            letter_code => $full_suggestion->{STATUS},
+            branchcode => $full_suggestion->{branchcode},
+            tables => {
+                'branches'    => $full_suggestion->{branchcode},
+                'borrowers'   => $full_suggestion->{suggestedby},
+                'suggestions' => $full_suggestion,
+                'biblio'      => $full_suggestion->{biblionumber},
+            },
+        ) ) {
+            C4::Letters::EnqueueLetter({
+                letter                  => $letter,
+                borrowernumber          => $full_suggestion->{suggestedby},
+                suggestionid            => $full_suggestion->{suggestionid},
+                LibraryName             => C4::Context->preference("LibraryName"),
+                message_transport_type  => 'email',
+            }) or warn "can't enqueue letter $letter";
         }
     }
-       return $status_update_table;
+    return $status_update_table;
 }
 
 =head2 ConnectSuggestionAndBiblio
@@ -397,7 +457,7 @@ connect a suggestion to an existing biblio
 =cut
 
 sub ConnectSuggestionAndBiblio {
-    my ($ordernumber,$biblionumber) = @_;
+    my ($suggestionid,$biblionumber) = @_;
     my $dbh=C4::Context->dbh;
     my $query = "
         UPDATE suggestions
@@ -417,7 +477,7 @@ Delete a suggestion. A borrower can delete a suggestion only if he is its owner.
 =cut
 
 sub DelSuggestion {
-    my ($borrowernumber,$ordernumber,$type) = @_;
+    my ($borrowernumber,$suggestionid,$type) = @_;
     my $dbh = C4::Context->dbh;
     # check that the suggestion comes from the suggestor
     my $query = "
@@ -426,7 +486,7 @@ sub DelSuggestion {
         WHERE  suggestionid=?
     ";
     my $sth = $dbh->prepare($query);
-    $sth->execute($ordernumber);
+    $sth->execute($suggestionid);
     my ($suggestedby) = $sth->fetchrow;
     if ($type eq "intranet" || $suggestedby eq $borrowernumber ) {
         my $queryDelete = "
@@ -439,13 +499,30 @@ sub DelSuggestion {
     }
 }
 
+=head2 DelSuggestionsOlderThan
+    &DelSuggestionsOlderThan($days)
+    
+    Delete all suggestions older than TODAY-$days , that have be accepted or rejected.
+    
+=cut
+sub DelSuggestionsOlderThan {
+    my ($days) = @_;
+    return if not $days;
+    my $dbh = C4::Context->dbh;
+    
+    my $sth = $dbh->prepare("
+        DELETE FROM suggestions WHERE STATUS <> 'ASKED' AND date < ADDDATE(NOW(), ?);
+    ");
+    $sth->execute("-$days");
+}
+
 1;
 __END__
 
 
 =head1 AUTHOR
 
-Koha Developement team <info@koha.org>
+Koha Development Team <http://koha-community.org/>
 
 =cut