use Memoize because Memcache::Memoize is slow for me
[koha.git] / C4 / Suggestions.pm
index 1c90ff0..1a93f2e 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,44 +14,42 @@ 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 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
-       );
-}
+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
+    DelSuggestionsOlderThan
+>;
 
 =head1 NAME
 
-C4::Suggestions - Some useful functions for dealings with suggestions.
+C4::Suggestions - Some useful functions for dealings with aqorders.
 
 =head1 SYNOPSIS
 
@@ -58,7 +57,7 @@ use C4::Suggestions;
 
 =head1 DESCRIPTION
 
-The functions in this module deal with the suggestions in OPAC and in librarian interface
+The functions in this module deal with the aqorders in OPAC and in librarian interface
 
 A suggestion is done in the OPAC. It has the status "ASKED"
 
@@ -68,7 +67,7 @@ When the book is ordered, the suggestion status becomes "ORDERED"
 
 When a book is ordered and arrived in the library, the status becomes "AVAILABLE"
 
-All suggestions of a borrower can be seen by the borrower itself.
+All aqorders of a borrower can be seen by the borrower itself.
 Suggestions done by other borrowers can be seen when not "AVAILABLE"
 
 =head1 FUNCTIONS
@@ -80,7 +79,7 @@ Suggestions done by other borrowers can be seen when not "AVAILABLE"
 searches for a suggestion
 
 return :
-C<\@array> : the suggestions found. Array of hash.
+C<\@array> : the aqorders found. Array of hash.
 Note the status is stored twice :
 * in the status field
 * as parameter ( for example ASKED => 1, or REJECTED => 1) . This is for template & translation purposes.
@@ -90,72 +89,91 @@ 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 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;
     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
 
-\%sth = &GetSuggestion($suggestionid)
+\%sth = &GetSuggestion($ordernumber)
 
-this function get the detail of the suggestion $suggestionid (input arg)
+this function get the detail of the suggestion $ordernumber (input arg)
 
 return :
     the result of the SQL query as a hash : $sth->fetchrow_hashref.
@@ -163,7 +181,7 @@ return :
 =cut
 
 sub GetSuggestion {
-    my ($suggestionid) = @_;
+    my ($ordernumber) = @_;
     my $dbh = C4::Context->dbh;
     my $query = "
         SELECT *
@@ -171,13 +189,13 @@ sub GetSuggestion {
         WHERE  suggestionid=?
     ";
     my $sth = $dbh->prepare($query);
-    $sth->execute($suggestionid);
+    $sth->execute($ordernumber);
     return($sth->fetchrow_hashref);
 }
 
 =head2 GetSuggestionFromBiblionumber
 
-$suggestionid = &GetSuggestionFromBiblionumber($dbh,$biblionumber)
+$ordernumber = &GetSuggestionFromBiblionumber($biblionumber)
 
 Get a suggestion from it's biblionumber.
 
@@ -187,21 +205,22 @@ 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=?
-    |;
+    };
+    my $dbh=C4::Context->dbh;
     my $sth = $dbh->prepare($query);
     $sth->execute($biblionumber);
-    my ($suggestionid) = $sth->fetchrow;
-    return $suggestionid;
+    my ($ordernumber) = $sth->fetchrow;
+    return $ordernumber;
 }
 
 =head2 GetSuggestionByStatus
 
-$suggestions = &GetSuggestionByStatus($status,[$branchcode])
+$aqorders = &GetSuggestionByStatus($status,[$branchcode])
 
 Get a suggestion from it's status
 
@@ -220,8 +239,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,
@@ -258,7 +277,7 @@ sub GetSuggestionByStatus {
 
 &CountSuggestion($status)
 
-Count the number of suggestions with the status given on input argument.
+Count the number of aqorders with the status given on input argument.
 the arg status can be :
 
 =over 2
@@ -310,7 +329,7 @@ sub CountSuggestion {
             FROM suggestions
             WHERE STATUS=?
         |;
-         $sth = $dbh->prepare($query);
+        $sth = $dbh->prepare($query);
         $sth->execute($status);
     }
     my ($result) = $sth->fetchrow;
@@ -320,7 +339,7 @@ sub CountSuggestion {
 =head2 NewSuggestion
 
 
-&NewSuggestion($suggestion)
+&NewSuggestion($suggestion);
 
 Insert a new suggestion on database with value given on input arg.
 
@@ -328,8 +347,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
@@ -347,26 +366,33 @@ 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'
+    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});
+        my $letter = C4::Letters::getletter('suggestions', $full_suggestion->{STATUS});
+        if ($letter) {
+            C4::Letters::parseletter($letter, 'branches',    $full_suggestion->{branchcode});
+            C4::Letters::parseletter($letter, 'borrowers',   $full_suggestion->{suggestedby});
+            C4::Letters::parseletter($letter, 'suggestions', $full_suggestion->{suggestionid});
+            C4::Letters::parseletter($letter, 'biblio',      $full_suggestion->{biblionumber});
+            my $enqueued = C4::Letters::EnqueueLetter({
+                letter                  => $letter,
+                borrowernumber          => $full_suggestion->{suggestedby},
+                suggestionid            => $full_suggestion->{suggestionid},
+                LibraryName             => C4::Context->preference("LibraryName"),
+                message_transport_type  => 'email',
             });
-        if (!$enqueued){warn "can't enqueue letter $letter";}
+            if (!$enqueued){warn "can't enqueue letter $letter";}
         }
     }
-       return $status_update_table;
+    return $status_update_table;
 }
 
 =head2 ConnectSuggestionAndBiblio
 
-&ConnectSuggestionAndBiblio($suggestionid,$biblionumber)
+&ConnectSuggestionAndBiblio($ordernumber,$biblionumber)
 
 connect a suggestion to an existing biblio
 
@@ -386,7 +412,7 @@ sub ConnectSuggestionAndBiblio {
 
 =head2 DelSuggestion
 
-&DelSuggestion($borrowernumber,$suggestionid)
+&DelSuggestion($borrowernumber,$ordernumber)
 
 Delete a suggestion. A borrower can delete a suggestion only if he is its owner.
 
@@ -415,13 +441,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