Bug 18789: (QA follow-up) Use is_child in circulation.pl
[koha.git] / circ / reserveratios.pl
index 5a86675..104928a 100755 (executable)
@@ -5,40 +5,42 @@
 #
 # This file is part of Koha.
 #
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
 #
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY 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.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
-use strict;
-use warnings;
+use Modern::Perl;
+
+use CGI qw ( -utf8 );
+use Date::Calc qw/Today Add_Delta_YM/;
 
 use C4::Context;
 use C4::Output;
-use CGI;
 use C4::Auth;
-use C4::Dates qw/format_date format_date_in_iso/;
 use C4::Debug;
-use Date::Calc qw/Today Add_Delta_YM/;
 use C4::Biblio qw/GetMarcBiblio GetRecordValue GetFrameworkCode/;
+use C4::Acquisition qw/GetOrdersByBiblionumber/;
+use Koha::DateUtils;
+use Koha::Acquisition::Baskets;
 
 my $input = new CGI;
-my $order     = $input->param('order') || '';
-my $startdate = $input->param('from');
-my $enddate   = $input->param('to');
-my $ratio     = $input->param('ratio');
+my $startdate       = $input->param('from');
+my $enddate         = $input->param('to');
+my $ratio           = $input->param('ratio');
+my $include_ordered = $input->param('include_ordered');
 
 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
     {
-        template_name   => "circ/reserveratios.tmpl",
+        template_name   => "circ/reserveratios.tt",
         query           => $input,
         type            => "intranet",
         authnotrequired => 0,
@@ -47,57 +49,61 @@ my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
     }
 );
 
-my ( $year, $month, $day ) = Today();
-my $todaysdate     = sprintf("%-04.4d-%-02.2d-%02.2d", $year, $month, $day);
-# Find yesterday for the default shelf pull start and end dates
-#    A default of the prior years's holds is a reasonable way to pull holds 
-my $datelastyear = sprintf("%-04.4d-%-02.2d-%02.2d", Add_Delta_YM($year, $month, $day, -1, 0));
-
-#              Predefine the start and end dates if they are not already defined
-#              Check if null, should string match, if so set start and end date to yesterday
-if (!defined($startdate) or $startdate !~ s/^\s*(\S+)\s*$/$1/) {   # strip spaces, remove Taint
-       $startdate = format_date($datelastyear);
+my $booksellerid = $input->param('booksellerid') // '';
+my $basketno = $input->param('basketno') // '';
+if ($booksellerid && $basketno) {
+     $template->param( booksellerid => $booksellerid, basketno => $basketno );
 }
-if (!defined($enddate)   or $enddate   !~ s/^\s*(\S+)\s*$/$1/) {   # strip spaces, remove Taint
-       $enddate   = format_date($todaysdate);
+
+my $effective_create_items = q{};
+if ( $basketno ){
+    my $basket = Koha::Acquisition::Baskets->find( $basketno );
+    if ($basket){
+        $effective_create_items = $basket->effective_create_items;
+    } else {
+        $effective_create_items = C4::Context->preference('AcqCreateItem');
+    }
 }
-if (!defined($ratio)     or $ratio     !~ s/^\s*(0?\.?\d+)(\.0*)?\s*$/$1/) {   # strip spaces, remove Taint
-       $ratio = 3;
+
+$startdate = eval { dt_from_string( $startdate ) } if $startdate;
+$enddate = eval { dt_from_string( $enddate ) } if $enddate;
+
+my $todaysdate = dt_from_string;
+
+#    A default of the prior years's holds is a reasonable way to pull holds
+$enddate = $todaysdate unless $enddate;
+$startdate = $todaysdate->clone->subtract( years => 1 ) unless $startdate;
+
+if (!defined($ratio)) {
+    $ratio = 3;
 }
-if ($ratio == 0) {
+# Force to be a number
+$ratio += 0;
+if ($ratio <= 0) {
     $ratio = 1; # prevent division by zero
 }
 
 my $dbh    = C4::Context->dbh;
-my ($sqlorderby, $sqldatewhere) = ("","");
-$debug and warn format_date_in_iso($startdate) . "\n" . format_date_in_iso($enddate);
+my $sqldatewhere = "";
+$debug and warn output_pref({ dt => $startdate, dateformat => 'iso', dateonly => 1 }) . "\n" . output_pref({ dt => $enddate, dateformat => 'iso', dateonly => 1 });
 my @query_params = ();
-if ($startdate) {
-    $sqldatewhere .= " AND reservedate >= ?";
-    push @query_params, format_date_in_iso($startdate);
-}
-if ($enddate) {
-    $sqldatewhere .= " AND reservedate <= ?";
-    push @query_params, format_date_in_iso($enddate);
-}
 
-if ($order eq "biblio") {
-       $sqlorderby = " ORDER BY biblio.title, holdingbranch, listcall, l_location ";
-} elsif ($order eq "callnumber") {
-    $sqlorderby = " ORDER BY listcall, holdingbranch, l_location ";
-} elsif ($order eq "itemcount") {
-    $sqlorderby = " ORDER BY itemcount, reservecount ";
-} elsif ($order eq "itype") {
-    $sqlorderby = " ORDER BY l_itype, holdingbranch, listcall ";
-} elsif ($order eq "location") {
-    $sqlorderby = " ORDER BY l_location, holdingbranch, listcall ";
-} elsif ($order eq "reservecount") {
-    $sqlorderby = " ORDER BY reservecount DESC ";
-} elsif ($order eq "branch") {
-    $sqlorderby = " ORDER BY holdingbranch, l_location, listcall ";
-} else {
-       $sqlorderby = " ORDER BY reservecount DESC ";
-}
+$sqldatewhere .= " AND reservedate >= ?";
+push @query_params, output_pref({ dt => $startdate, dateformat => 'iso' }) ;
+$sqldatewhere .= " AND reservedate <= ?";
+push @query_params, output_pref({ dt => $enddate, dateformat => 'iso' });
+
+my $include_aqorders_qty =
+  $effective_create_items eq 'receiving'
+  ? '+ COALESCE(aqorders.quantity, 0) - COALESCE(aqorders.quantityreceived, 0)'
+  : q{};
+
+my $include_aqorders_qty_join =
+  $effective_create_items eq 'receiving'
+  ? 'LEFT JOIN aqorders ON reserves.biblionumber=aqorders.biblionumber'
+  : q{};
+
+my $nfl_comparison = $include_ordered ? '<=' : '=';
 my $strsth =
 "SELECT reservedate,
         reserves.borrowernumber as borrowernumber,
@@ -107,33 +113,36 @@ my $strsth =
         items.itemcallnumber,
         items.itemnumber,
         GROUP_CONCAT(DISTINCT items.itemcallnumber 
-                       ORDER BY items.itemnumber SEPARATOR '<br/>') as listcall,
+            ORDER BY items.itemnumber SEPARATOR '|') as listcall,
+        GROUP_CONCAT(DISTINCT homebranch
+            ORDER BY items.itemnumber SEPARATOR '|') as homebranch_list,
         GROUP_CONCAT(DISTINCT holdingbranch 
-                       ORDER BY items.itemnumber SEPARATOR '<br/>') as listbranch,
+            ORDER BY items.itemnumber SEPARATOR '|') as holdingbranch_list,
         GROUP_CONCAT(DISTINCT items.location 
-                       ORDER BY items.itemnumber SEPARATOR '<br/>') as l_location,
+            ORDER BY items.itemnumber SEPARATOR '|') as l_location,
         GROUP_CONCAT(DISTINCT items.itype 
-                       ORDER BY items.itemnumber SEPARATOR '<br/>') as l_itype,
-        notes,
+            ORDER BY items.itemnumber SEPARATOR '|') as l_itype,
+
         reserves.found,
         biblio.title,
         biblio.author,
         count(DISTINCT reserves.borrowernumber) as reservecount, 
-        count(DISTINCT items.itemnumber) as itemcount 
+        count(DISTINCT items.itemnumber) $include_aqorders_qty as itemcount
  FROM  reserves
  LEFT JOIN items ON items.biblionumber=reserves.biblionumber 
  LEFT JOIN biblio ON reserves.biblionumber=biblio.biblionumber
- WHERE 
-notforloan = 0 AND damaged = 0 AND itemlost = 0 AND wthdrawn = 0
+ $include_aqorders_qty_join
+ WHERE
+ notforloan $nfl_comparison 0 AND damaged = 0 AND itemlost = 0 AND withdrawn = 0
  $sqldatewhere
 ";
 
-if (C4::Context->preference('IndependantBranches')){
-       $strsth .= " AND items.holdingbranch=? ";
+if (C4::Context->preference('IndependentBranches')){
+    $strsth .= " AND items.holdingbranch=? ";
     push @query_params, C4::Context->userenv->{'branch'};
 }
 
-$strsth .= " GROUP BY reserves.biblionumber " . $sqlorderby;
+$strsth .= " GROUP BY reserves.biblionumber ORDER BY reservecount DESC";
 
 $template->param(sql => $strsth);
 my $sth = $dbh->prepare($strsth);
@@ -145,44 +154,65 @@ while ( my $data = $sth->fetchrow_hashref ) {
     my $thisratio = $data->{reservecount} / $data->{itemcount};
     my $ratiocalc = ($thisratio / $ratio);
     ($thisratio / $ratio) >= 1 or next;  # TODO: tighter targeting -- get ratio limit into SQL using HAVING clause
-    my $record = GetMarcBiblio($data->{biblionumber});
+    my $record = GetMarcBiblio({ biblionumber => $data->{biblionumber} });
     $data->{subtitle} = GetRecordValue('subtitle', $record, GetFrameworkCode($data->{biblionumber}));
     push(
         @reservedata,
         {
-            reservedate      => format_date( $data->{reservedate} ),
-            priority         => $data->{priority},
-            name             => $data->{borrower},
-            title            => $data->{title},
-            subtitle            => $data->{subtitle},
-            author           => $data->{author},
-            notes            => $data->{notes},
-            itemnum          => $data->{itemnumber},
-            biblionumber     => $data->{biblionumber},
-            holdingbranch    => $data->{holdingbranch},
-            listbranch       => $data->{listbranch},
-            branch           => $data->{branch},
-            itemcallnumber   => $data->{itemcallnumber},
-            location         => $data->{l_location},
-            itype            => $data->{l_itype},
-            reservecount     => $data->{reservecount},
-            itemcount        => $data->{itemcount},
-            ratiocalc        => sprintf("%.0d", $ratio_atleast1 ? ($thisratio / $ratio) : $thisratio),
-            thisratio        => sprintf("%.2f", $thisratio),
-            thisratio_atleast1 => ($thisratio >= 1) ? 1 : 0,
-            listcall         => $data->{listcall}    
+            reservedate        => $data->{reservedate},
+            priority           => $data->{priority},
+            name               => $data->{borrower},
+            title              => $data->{title},
+            subtitle           => $data->{subtitle},
+            author             => $data->{author},
+            itemnum            => $data->{itemnumber},
+            biblionumber       => $data->{biblionumber},
+            holdingbranch      => $data->{holdingbranch},
+            homebranch_list    => [split('\|', $data->{homebranch_list})],
+            holdingbranch_list => [split('\|', $data->{holdingbranch_list})],
+            branch             => $data->{branch},
+            itemcallnumber     => $data->{itemcallnumber},
+            location           => [split('\|', $data->{l_location})],
+            itype              => [split('\|', $data->{l_itype})],
+            reservecount       => $data->{reservecount},
+            itemcount          => $data->{itemcount},
+            ratiocalc          => sprintf( "%.0d", $ratio_atleast1 ? ( $thisratio / $ratio ) : $thisratio ),
+            thisratio => sprintf( "%.2f", $thisratio ),
+            thisratio_atleast1 => ( $thisratio >= 1 ) ? 1 : 0,
+            listcall           => [split('\|', $data->{listcall})]
         }
     );
 }
 
+for my $rd ( @reservedata ) {
+    next unless $rd->{biblionumber};
+    $rd->{pendingorders} = CountPendingOrdersByBiblionumber( $rd->{biblionumber} );
+}
+
 $template->param(
     ratio_atleast1  => $ratio_atleast1,
-    todaysdate      => format_date($todaysdate),
+    todaysdate      => $todaysdate,
     from            => $startdate,
     to              => $enddate,
     ratio           => $ratio,
+    include_ordered => $include_ordered,
     reserveloop     => \@reservedata,
-    DHTMLcalendar_dateformat =>  C4::Dates->DHTMLcalendar(),
 );
 
 output_html_with_http_headers $input, $cookie, $template->output;
+
+sub CountPendingOrdersByBiblionumber {
+    my $biblionumber = shift;
+    my @orders = GetOrdersByBiblionumber( $biblionumber );
+    my $cnt = 0;
+    if (scalar(@orders)) {
+        for my $order ( @orders ) {
+            next if $order->{datecancellationprinted};
+            my $onum = $order->{quantity} // 0;
+            my $rnum = $order->{quantityreceived} // 0;
+            next if $rnum >= $onum;
+            $cnt += ($onum - $rnum);
+        }
+    }
+    return $cnt;
+}