Bug 17600: Standardize our EXPORT_OK
[srvgit] / circ / pendingreserves.pl
index 61bace9..0b2fea2 100755 (executable)
 #!/usr/bin/perl
 
-
 # Copyright 2000-2002 Katipo Communications
 #
 # 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>.
 
-# Modification by D.Ulm, actually works (as long as indep. branches not turned on)
-#              Someone let me know what indep. branches is supposed to do and I'll make that part work too
-#
-#              The reserve pull lists *works* as long as not for indepencdant branches, I can fix!
+use Modern::Perl;
+
+use constant PULL_INTERVAL => 2;
+use List::MoreUtils qw( uniq );
+use YAML::XS;
+use Encode;
 
-use strict;
-#use warnings; FIXME - Bug 2505
 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_YMD/;
-
-my $input = new CGI;
-my $startdate=$input->param('from');
-my $enddate=$input->param('to');
-my $run_report=$input->param('run_report');
+use C4::Output qw( output_html_with_http_headers );
+use CGI qw ( -utf8 );
+use C4::Auth qw( get_template_and_user );
+use C4::Items;
+use C4::Reserves qw( ModReserveCancelAll );
+use Koha::Biblios;
+use Koha::DateUtils qw( dt_from_string );
+use Koha::Holds;
+use DateTime::Duration;
 
+my $input = CGI->new;
+my $startdate = $input->param('from');
+my $enddate = $input->param('to');
 my $theme = $input->param('theme');    # only used if allowthemeoverride is set
+my $op         = $input->param('op') || '';
+my $borrowernumber = $input->param('borrowernumber');
+my $reserve_id = $input->param('reserve_id');
 
 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
     {
-        template_name   => "circ/pendingreserves.tmpl",
+        template_name   => "circ/pendingreserves.tt",
         query           => $input,
         type            => "intranet",
-        authnotrequired => 0,
         flagsrequired   => { circulate => "circulate_remaining_permissions" },
-        debug           => 1,
     }
 );
 
-my $duedate;
-my $borrowernumber;
-my $itemnum;
-my $data1;
-my $data2;
-my $data3;
-my $name;
-my $phone;
-my $email;
-my $biblionumber;
-my $title;
-my $author;
-
-my ( $year, $month, $day ) = Today();
-my $todaysdate     = sprintf("%-04.4d-%-02.2d-%02.2d", $year, $month, $day);
-my $yesterdaysdate = sprintf("%-04.4d-%-02.2d-%02.2d", Add_Delta_YMD($year, $month, $day,   0, 0, -1));
-# changed from delivered range of 10 years-yesterday to 2 days ago-today
-# Find two days ago for the default shelf pull start and end dates
-my $pastdate       = sprintf("%-04.4d-%-02.2d-%02.2d", Add_Delta_YMD($year, $month, $day, 0, 0, -2));
-
-# Predefine the start and end dates if they are not already defined
-$startdate =~ s/^\s+//;
-$startdate =~ s/\s+$//;
-$enddate =~ s/^\s+//;
-$enddate =~ s/\s+$//;
-# Check if null, should string match, if so set start and end date to yesterday
-if (!defined($startdate) or $startdate eq "") {
-    $startdate = format_date($pastdate);
+my @messages;
+if ( $op eq 'cancel_reserve' and $reserve_id ) {
+    my $hold = Koha::Holds->find( $reserve_id );
+    if ( $hold ) {
+        my $cancellation_reason = $input->param('cancellation-reason');
+        $hold->cancel({ cancellation_reason => $cancellation_reason });
+        push @messages, { type => 'message', code => 'hold_cancelled' };
+    }
+} elsif ( $op =~ m|^mark_as_lost| ) {
+    my $hold = Koha::Holds->find( $reserve_id );
+    die "wrong reserve_id" unless $hold; # This is a bit rude, but we are not supposed to get a wrong reserve_id
+    my $item = $hold->item;
+    if ( $item and C4::Context->preference('CanMarkHoldsToPullAsLost') =~ m|^allow| ) {
+        my $patron = $hold->borrower;
+        C4::Circulation::LostItem( $item->itemnumber, "pendingreserves" );
+        if ( $op eq 'mark_as_lost_and_notify' and C4::Context->preference('CanMarkHoldsToPullAsLost') eq 'allow_and_notify' ) {
+            my $library = $hold->branch;
+            my $letter = C4::Letters::GetPreparedLetter(
+                module => 'reserves',
+                letter_code => 'CANCEL_HOLD_ON_LOST',
+                branchcode => $patron->branchcode,
+                lang => $patron->lang,
+                tables => {
+                    branches    => $library->branchcode,
+                    borrowers   => $patron->borrowernumber,
+                    items       => $item->itemnumber,
+                    biblio      => $hold->biblionumber,
+                    biblioitems => $hold->biblionumber,
+                    reserves    => $hold->unblessed,
+                },
+            );
+            if ( $letter ) {
+                my $from_address = $library->from_email_address;
+
+                C4::Letters::EnqueueLetter(
+                    {   letter                 => $letter,
+                        borrowernumber         => $patron->borrowernumber,
+                        message_transport_type => 'email',
+                        from_address           => $from_address,
+                    }
+                );
+                unless ( $patron->notice_email_address ) {
+                    push @messages, {type => 'alert', code => 'no_email_address', };
+                }
+                push @messages, { type => 'message', code => 'letter_enqueued' };
+            } else {
+                push @messages, { type => 'error', code => 'no_template_notice' };
+            }
+        }
+        $hold->cancel;
+        if ( $item->homebranch ne $item->holdingbranch ) {
+            C4::Items::ModItemTransfer( $item->itemnumber, $item->holdingbranch, $item->homebranch, 'LostReserve' );
+        }
+
+        if ( my $yaml = C4::Context->preference('UpdateItemWhenLostFromHoldList') ) {
+            $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
+            my $assignments;
+            eval { $assignments = YAML::XS::Load(Encode::encode_utf8($yaml)); };
+            if ($@) {
+                warn "Unable to parse UpdateItemWhenLostFromHoldList syspref : $@" if $@;
+            }
+            else {
+                eval {
+                    while ( my ( $f, $v ) = each( %$assignments ) ) {
+                        $item->$f($v);
+                    }
+                    $item->store;
+                };
+                warn "Unable to modify item itemnumber=" . $item->itemnumber . ": $@" if $@;
+            }
+        }
+
+    } elsif ( not $item ) {
+        push @messages, { type => 'alert', code => 'hold_placed_at_biblio_level'};
+    } # else the url parameters have been modified and the user is not allowed to continue
+}
+
+
+my $today = dt_from_string;
+
+if ( $startdate ) {
+    $startdate =~ s/^\s+//;
+    $startdate =~ s/\s+$//;
+    $startdate = eval{dt_from_string( $startdate )};
+}
+unless ( $startdate ){
+    # changed from delivered range of 10 years-yesterday to 2 days ago-today
+    # Find two days ago for the default shelf pull start date, unless HoldsToPullStartDate sys pref is set.
+    $startdate = $today - DateTime::Duration->new( days => C4::Context->preference('HoldsToPullStartDate') || PULL_INTERVAL );
+}
+
+if ( $enddate ) {
+    $enddate =~ s/^\s+//;
+    $enddate =~ s/\s+$//;
+    $enddate = eval{dt_from_string( $enddate )};
+}
+unless ( $enddate ) {
+    #similarly: calculate end date with ConfirmFutureHolds (days)
+    $enddate = $today + DateTime::Duration->new( days => C4::Context->preference('ConfirmFutureHolds') || 0 );
+}
+
+# building query parameters
+my %where = (
+    'reserve.found' => undef,
+    'reserve.priority' => 1,
+    'reserve.suspend' => 0,
+    'itembib.itemlost' => 0,
+    'itembib.withdrawn' => 0,
+    'itembib.notforloan' => 0,
+    'itembib.itemnumber' => { -not_in => \'SELECT itemnumber FROM branchtransfers WHERE datearrived IS NULL' }
+);
+
+# date boundaries
+my $dtf = Koha::Database->new->schema->storage->datetime_parser;
+my $startdate_iso = $dtf->format_date($startdate);
+my $enddate_iso   = $dtf->format_date($enddate);
+if ( $startdate_iso && $enddate_iso ){
+    $where{'reserve.reservedate'} = [ -and => { '>=', $startdate_iso }, { '<=', $enddate_iso } ];
+} elsif ( $startdate_iso ){
+    $where{'reserve.reservedate'} = { '>=', $startdate_iso };
+} elsif ( $enddate_iso ){
+    $where{'reserve.reservedate'} = { '<=', $enddate_iso };
+}
+
+# Bug 21320
+if ( !C4::Context->preference('AllowHoldsOnDamagedItems') ){
+    $where{'itembib.damaged'} = 0;
 }
-if (!defined($enddate) or $enddate eq "") {
-    $enddate = format_date($todaysdate);
+
+if ( C4::Context->preference('IndependentBranches') ){
+    $where{'itembib.holdingbranch'} = C4::Context->userenv->{'branch'};
 }
 
+# get all distinct unfulfilled reserves
+my $holds = Koha::Holds->search(
+    { %where },
+    { join => 'itembib', alias => 'reserve', distinct  => 1, columns => qw[me.biblionumber] }
+);
+my @biblionumbers = $holds->get_column('biblionumber');
+
+my $all_items;
+foreach my $item ( $holds->get_items_that_can_fill ) {
+    push @{$all_items->{$item->biblionumber}}, $item;
+}
 
-my @reservedata;
-if ( $run_report ) {
-    my $dbh    = C4::Context->dbh;
-    my $sqldatewhere = "";
-    $debug and warn format_date_in_iso($startdate) . "\n" . format_date_in_iso($enddate);
-    my @query_params = ();
-    if ($startdate) {
-        $sqldatewhere .= " AND reservedate >= ?";
-        push @query_params, format_date_in_iso($startdate);
+# patrons count per biblio
+my $patrons_count = {
+    map { $_->{biblionumber} => $_->{patrons_count} } @{ Koha::Holds->search(
+            {},
+            {
+                select   => [ 'biblionumber', { count => { distinct => 'borrowernumber' } } ],
+                as       => [qw( biblionumber patrons_count )],
+                group_by => [qw( biblionumber )]
+            },
+        )->unblessed
     }
-    if ($enddate) {
-        $sqldatewhere .= " AND reservedate <= ?";
-        push @query_params, format_date_in_iso($enddate);
+};
+
+my $holds_biblios_map = {
+    map { $_->{biblionumber} => $_->{reserve_id} } @{ Koha::Holds->search(
+            {%where},
+            {
+                join    => ['itembib', 'biblio'],
+                alias   => 'reserve',
+                select  => ['reserve.biblionumber', 'reserve.reserve_id'],
+            }
+        )->unblessed
     }
+};
 
-    my $strsth =
-    "SELECT min(reservedate) as l_reservedate,
-            reserves.borrowernumber as borrowernumber,
-            GROUP_CONCAT(DISTINCT items.holdingbranch 
-                    ORDER BY items.itemnumber SEPARATOR '<br/>') l_holdingbranch,
-            reserves.biblionumber,
-            reserves.branchcode,
-            GROUP_CONCAT(DISTINCT reserves.branchcode 
-                    ORDER BY items.itemnumber SEPARATOR ', ') l_branch,
-            items.holdingbranch as branch,
-            GROUP_CONCAT(DISTINCT items.itype 
-                    ORDER BY items.itemnumber SEPARATOR '<br/>') l_itype,
-            GROUP_CONCAT(DISTINCT items.location 
-                    ORDER BY items.itemnumber SEPARATOR '<br/>') l_location,
-            GROUP_CONCAT(DISTINCT items.itemcallnumber 
-                    ORDER BY items.itemnumber SEPARATOR '<br/>') l_itemcallnumber,
-            GROUP_CONCAT(DISTINCT items.enumchron
-                    ORDER BY items.itemnumber SEPARATOR '<br/>') l_enumchron,
-            GROUP_CONCAT(DISTINCT items.copynumber
-                    ORDER BY items.itemnumber SEPARATOR '<br/>') l_copynumber,
-            items.itemnumber,
-            notes,
-            notificationdate,
-            reminderdate,
-            max(priority) as priority,
-            reserves.found,
-            biblio.title,
-            biblio.author,
-            count(DISTINCT items.itemnumber) as icount,
-            count(DISTINCT reserves.borrowernumber) as rcount
-    FROM  reserves
-        LEFT JOIN items ON items.biblionumber=reserves.biblionumber 
-        LEFT JOIN biblio ON reserves.biblionumber=biblio.biblionumber
-        LEFT JOIN branchtransfers ON items.itemnumber=branchtransfers.itemnumber
-        LEFT JOIN issues ON items.itemnumber=issues.itemnumber
-    WHERE
-    reserves.found IS NULL
-    $sqldatewhere
-    AND (reserves.itemnumber IS NULL OR reserves.itemnumber = items.itemnumber)
-    AND items.itemnumber NOT IN (SELECT itemnumber FROM branchtransfers where datearrived IS NULL)
-    AND issues.itemnumber IS NULL
-    AND reserves.priority <> 0 
-    AND reserves.suspend = 0
-    AND notforloan = 0 AND damaged = 0 AND itemlost = 0 AND wthdrawn = 0
-    ";
-    # GROUP BY reserves.biblionumber allows only items that are not checked out, else multiples occur when 
-    #    multiple patrons have a hold on an item
-
-
-    if (C4::Context->preference('IndependantBranches')){
-        $strsth .= " AND items.holdingbranch=? ";
-        push @query_params, C4::Context->userenv->{'branch'};
+my $all_holds = {
+    map { $_->biblionumber => $_ } @{ Koha::Holds->search(
+            { reserve_id => [ values %$holds_biblios_map ]},
+            {
+                prefetch => [ 'borrowernumber', 'itembib', 'biblio' ],
+                alias    => 'reserve',
+            }
+        )->as_list
     }
-    $strsth .= " GROUP BY reserves.biblionumber ORDER BY biblio.title ";
+};
 
-    my $sth = $dbh->prepare($strsth);
-    $sth->execute(@query_params);
+# make final holds_info array and fill with info
+my @holds_info;
+foreach my $bibnum ( @biblionumbers ){
 
-    while ( my $data = $sth->fetchrow_hashref ) {
-        push(
-            @reservedata,
-            {
-                reservedate            => format_date( $data->{l_reservedate} ),
-                priority               => $data->{priority},
-                name                   => $data->{l_patron},
-                title                  => $data->{title},
-                author                 => $data->{author},
-                borrowernumber         => $data->{borrowernumber},
-                itemnum                => $data->{itemnumber},
-                phone                  => $data->{phone},
-                email                  => $data->{email},
-                biblionumber           => $data->{biblionumber},
-                statusw                => ( $data->{found} eq "W" ),
-                statusf                => ( $data->{found} eq "F" ),
-                holdingbranch          => $data->{l_holdingbranch},
-                branch                 => $data->{l_branch},
-                itemcallnumber         => $data->{l_itemcallnumber},
-                enumchron              => $data->{l_enumchron},
-               copyno                  => $data->{l_copynumber},
-                notes                  => $data->{notes},
-                notificationdate       => $data->{notificationdate},
-                reminderdate           => $data->{reminderdate},
-                count                  => $data->{icount},
-                rcount                 => $data->{rcount},
-                pullcount              => $data->{icount} <= $data->{rcount} ? $data->{icount} : $data->{rcount},
-                itype                  => $data->{l_itype},
-                location               => $data->{l_location}
+    my $hold_info;
+    my $items = $all_items->{$bibnum};
+    my $items_count = defined $items ? scalar @$items : 0;
+    my $pull_count = $items_count <= $patrons_count->{$bibnum} ? $items_count : $patrons_count->{$bibnum};
+    if ( $pull_count == 0 ) {
+        next;
+    }
+
+    # get available item types for each biblio
+    my @res_itemtypes;
+    if ( C4::Context->preference('item-level_itypes') ){
+        @res_itemtypes = uniq map { defined $_->itype ? $_->itype : () } @$items;
+    } else {
+        @res_itemtypes = Koha::Biblioitems->search(
+            { biblionumber => $bibnum, itemtype => { '!=', undef }  },
+            { columns => 'itemtype',
+              distinct => 1,
             }
-        );
+        )->get_column('itemtype');
+    }
+    $hold_info->{itemtypes} = \@res_itemtypes;
+
+    # get available values for each biblio
+    my $fields = {
+        locations       => 'location',
+        callnumbers     => 'itemcallnumber',
+        enumchrons      => 'enumchron',
+        copynumbers     => 'copynumber',
+        barcodes        => 'barcode',
+        holdingbranches => 'holdingbranch'
+    };
+
+    while (
+        my ( $key, $field ) = each %$fields )
+    {
+        $hold_info->{$key} =
+          [ uniq map { defined $_->$field ? $_->$field : () } @$items ];
     }
-    $sth->finish;
+
+    # items available
+    $hold_info->{items_count} = $items_count;
+
+    # patrons with holds
+    $hold_info->{patrons_count} = $patrons_count->{$bibnum};
+
+    # number of items to pull
+    $hold_info->{pull_count} = $pull_count;
+
+    # get other relevant information
+    my $res_info = $all_holds->{$bibnum};
+    $hold_info->{patron} = $res_info->patron;
+    $hold_info->{item}   = $res_info->item;
+    $hold_info->{biblio} = $res_info->biblio;
+    $hold_info->{hold}   = $res_info;
+
+    push @holds_info, $hold_info;
 }
 
 $template->param(
-    todaysdate         => format_date($todaysdate),
+    todaysdate          => $today,
     from                => $startdate,
-    to                 => $enddate,
-    run_report          => $run_report,
-    reserveloop        => \@reservedata,
+    to                  => $enddate,
+    holds_info          => \@holds_info,
     "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
-    DHTMLcalendar_dateformat =>  C4::Dates->DHTMLcalendar(),
-    dateformat    => C4::Context->preference("dateformat"),
+    HoldsToPullStartDate => C4::Context->preference('HoldsToPullStartDate') || PULL_INTERVAL,
+    HoldsToPullEndDate  => C4::Context->preference('ConfirmFutureHolds') || 0,
+    messages            => \@messages,
 );
 
 output_html_with_http_headers $input, $cookie, $template->output;